oops.
[ardour.git] / gtk2_ardour / processor_box.cc
1 /*
2     Copyright (C) 2000-2004 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
23
24 #include <cmath>
25 #include <iostream>
26 #include <set>
27
28 #include <sigc++/bind.h>
29
30 #include "pbd/convert.h"
31
32 #include <glibmm/miscutils.h>
33
34 #include <gtkmm/messagedialog.h>
35
36 #include <gtkmm2ext/gtk_ui.h>
37 #include <gtkmm2ext/utils.h>
38 #include <gtkmm2ext/choice.h>
39 #include <gtkmm2ext/utils.h>
40 #include <gtkmm2ext/doi.h>
41 #include <gtkmm2ext/rgb_macros.h>
42
43 #include "ardour/amp.h"
44 #include "ardour/audio_track.h"
45 #include "ardour/audioengine.h"
46 #include "ardour/internal_return.h"
47 #include "ardour/internal_send.h"
48 #include "ardour/meter.h"
49 #include "ardour/panner_shell.h"
50 #include "ardour/plugin_insert.h"
51 #include "ardour/pannable.h"
52 #include "ardour/port_insert.h"
53 #include "ardour/profile.h"
54 #include "ardour/return.h"
55 #include "ardour/route.h"
56 #include "ardour/send.h"
57 #include "ardour/session.h"
58 #include "ardour/types.h"
59
60 #include "actions.h"
61 #include "ardour_dialog.h"
62 #include "ardour_ui.h"
63 #include "gui_thread.h"
64 #include "io_selector.h"
65 #include "keyboard.h"
66 #include "mixer_ui.h"
67 #include "mixer_strip.h"
68 #include "plugin_selector.h"
69 #include "plugin_ui.h"
70 #include "port_insert_ui.h"
71 #include "processor_box.h"
72 #include "public_editor.h"
73 #include "return_ui.h"
74 #include "route_processor_selection.h"
75 #include "send_ui.h"
76 #include "timers.h"
77
78 #include "i18n.h"
79
80 #ifdef AUDIOUNIT_SUPPORT
81 class AUPluginUI;
82 #endif
83
84 using namespace std;
85 using namespace ARDOUR;
86 using namespace PBD;
87 using namespace Gtk;
88 using namespace Glib;
89 using namespace Gtkmm2ext;
90
91 ProcessorBox* ProcessorBox::_current_processor_box = 0;
92 RefPtr<Action> ProcessorBox::paste_action;
93 RefPtr<Action> ProcessorBox::cut_action;
94 RefPtr<Action> ProcessorBox::rename_action;
95 RefPtr<Action> ProcessorBox::edit_action;
96 RefPtr<Action> ProcessorBox::edit_generic_action;
97
98 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
99 static const uint32_t midi_port_color = 0x960909FF; //Red
100
101 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
102         : _button (ArdourButton::led_default_elements)
103         , _position (PreFader)
104         , _position_num(0)
105         , _selectable(true)
106         , _parent (parent)
107         , _processor (p)
108         , _width (w)
109         , _input_icon(true)
110         , _output_icon(false)
111 {
112         _vbox.show ();
113         
114         _button.set_distinct_led_click (true);
115         _button.set_fallthrough_to_parent(true);
116         _button.set_led_left (true);
117         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
118         _button.set_text (name (_width));
119
120         if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
121                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
122         }
123         if (_processor) {
124
125                 _vbox.pack_start (_routing_icon);
126                 _vbox.pack_start (_input_icon);
127                 _vbox.pack_start (_button, true, true);
128                 _vbox.pack_end (_output_icon);
129
130                 _button.set_active (_processor->active());
131
132                 _routing_icon.set_no_show_all(true);
133                 _input_icon.set_no_show_all(true);
134
135                 _button.show ();
136                 _routing_icon.set_visible(false);
137                 _input_icon.hide();
138                 _output_icon.show();
139
140                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
141                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
142                 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
143
144                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
145                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
146                         
147                         std::string label = _processor->describe_parameter (*i);
148
149                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
150                                 label = _("Send");
151                         } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
152                                 label = _("Return");
153                         }
154
155                         Control* c = new Control (_processor->automation_control (*i), label);
156                         
157                         _controls.push_back (c);
158
159                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
160                                 /* Add non-Amp controls to the processor box */
161                                 _vbox.pack_start (c->box);
162                         }
163                 }
164
165                 _input_icon.set_ports(_processor->input_streams());
166                 _output_icon.set_ports(_processor->output_streams());
167
168                 _routing_icon.set_sources(_processor->input_streams());
169                 _routing_icon.set_sinks(_processor->output_streams());
170
171                 setup_tooltip ();
172                 setup_visuals ();
173         } else {
174                 _vbox.set_size_request (-1, _button.size_request().height);
175         }
176 }
177
178 ProcessorEntry::~ProcessorEntry ()
179 {
180         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
181                 delete *i;
182         }
183 }
184
185 EventBox&
186 ProcessorEntry::action_widget ()
187 {
188         return _button;
189 }
190
191 Gtk::Widget&
192 ProcessorEntry::widget ()
193 {
194         return _vbox;
195 }
196
197 string
198 ProcessorEntry::drag_text () const
199 {
200         return name (Wide);
201 }
202
203 void
204 ProcessorEntry::set_position (Position p, uint32_t num)
205 {
206         _position = p;
207         _position_num = num;
208
209         if (_position_num == 0 || _routing_icon.get_visible()) {
210                 _input_icon.show();
211         } else {
212                 _input_icon.hide();
213         }
214
215         setup_visuals ();
216 }
217
218 void
219 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
220 {
221         if (yn) {
222                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
223         } else {
224                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
225         }
226 }
227
228 void
229 ProcessorEntry::setup_visuals ()
230 {
231         switch (_position) {
232         case PreFader:
233                 _button.set_name ("processor prefader");
234                 break;
235
236         case Fader:
237                 _button.set_name ("processor fader");
238                 break;
239
240         case PostFader:
241                 _button.set_name ("processor postfader");
242                 break;
243         }
244 }
245
246
247 boost::shared_ptr<Processor>
248 ProcessorEntry::processor () const
249 {
250         return _processor;
251 }
252
253 void
254 ProcessorEntry::set_enum_width (Width w)
255 {
256         _width = w;
257         _button.set_text (name (_width));
258 }
259
260 void
261 ProcessorEntry::led_clicked()
262 {
263         if (_processor) {
264                 if (_button.get_active ()) {
265                         _processor->deactivate ();
266                 } else {
267                         _processor->activate ();
268                 }
269         }
270 }
271
272 void
273 ProcessorEntry::processor_active_changed ()
274 {
275         if (_processor) {
276                 _button.set_active (_processor->active());
277         }
278 }
279
280 void
281 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
282 {
283         if (what_changed.contains (ARDOUR::Properties::name)) {
284                 _button.set_text (name (_width));
285                 setup_tooltip ();
286         }
287 }
288
289 void
290 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
291 {
292         _input_icon.set_ports(in);
293         _output_icon.set_ports(out);
294         _routing_icon.set_sources(in);
295         _routing_icon.set_sinks(out);
296         _input_icon.queue_draw();
297         _output_icon.queue_draw();
298         _routing_icon.queue_draw();
299 }
300
301 void
302 ProcessorEntry::setup_tooltip ()
303 {
304         if (_processor) {
305                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
306                 if (pi) {
307                         std::string postfix = "";
308                         uint32_t replicated;
309                         if ((replicated = pi->get_count()) > 1) {
310                                 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
311                         }
312                         if (pi->plugin()->has_editor()) {
313                                 ARDOUR_UI::instance()->set_tip (_button,
314                                                 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\nAlt+double-click to show generic GUI.%2"), name (Wide), postfix));
315                         } else {
316                                 ARDOUR_UI::instance()->set_tip (_button,
317                                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
318                         }
319                         return;
320                 }
321         }
322         ARDOUR_UI::instance()->set_tip (_button, string_compose ("<b>%1</b>", name (Wide)));
323 }
324
325 string
326 ProcessorEntry::name (Width w) const
327 {
328         boost::shared_ptr<Send> send;
329         string name_display;
330
331         if (!_processor) {
332                 return string();
333         }
334
335         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
336             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
337
338                 name_display += '>';
339
340                 /* grab the send name out of its overall name */
341
342                 string::size_type lbracket, rbracket;
343                 lbracket = send->name().find ('[');
344                 rbracket = send->name().find (']');
345
346                 switch (w) {
347                 case Wide:
348                         name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
349                         break;
350                 case Narrow:
351                         name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
352                         break;
353                 }
354
355         } else {
356                 boost::shared_ptr<ARDOUR::PluginInsert> pi;
357                 uint32_t replicated;
358                 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
359                                 && (replicated = pi->get_count()) > 1)
360                 {
361                         name_display += string_compose(_("(%1x1) "), replicated);
362                 }
363
364                 switch (w) {
365                 case Wide:
366                         name_display += _processor->display_name();
367                         break;
368                 case Narrow:
369                         name_display += PBD::short_version (_processor->display_name(), 5);
370                         break;
371                 }
372
373         }
374
375         return name_display;
376 }
377
378 void
379 ProcessorEntry::show_all_controls ()
380 {
381         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
382                 (*i)->set_visible (true);
383         }
384
385         _parent->update_gui_object_state (this);
386 }
387
388 void
389 ProcessorEntry::hide_all_controls ()
390 {
391         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
392                 (*i)->set_visible (false);
393         }
394
395         _parent->update_gui_object_state (this);
396 }
397
398 void
399 ProcessorEntry::add_control_state (XMLNode* node) const
400 {
401         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
402                 (*i)->add_state (node);
403         }
404 }
405
406 void
407 ProcessorEntry::set_control_state (XMLNode const * node)
408 {
409         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
410                 (*i)->set_state (node);
411         }
412 }
413
414 string
415 ProcessorEntry::state_id () const
416 {
417         return string_compose ("processor %1", _processor->id().to_s());
418 }
419
420 void
421 ProcessorEntry::hide_things ()
422 {
423         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
424                 (*i)->hide_things ();
425         }
426 }
427
428
429 Menu *
430 ProcessorEntry::build_controls_menu ()
431 {
432         using namespace Menu_Helpers;
433         Menu* menu = manage (new Menu);
434         MenuList& items = menu->items ();
435
436         items.push_back (
437                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
438                 );
439                 
440         items.push_back (
441                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
442                 );
443
444         if (!_controls.empty ()) {
445                 items.push_back (SeparatorElem ());
446         }
447         
448         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
449                 items.push_back (CheckMenuElem ((*i)->name ()));
450                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
451                 c->set_active ((*i)->visible ());
452                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
453         }
454
455         return menu;
456 }
457
458 void
459 ProcessorEntry::toggle_control_visibility (Control* c)
460 {
461         c->set_visible (!c->visible ());
462         _parent->update_gui_object_state (this);
463 }
464
465 Menu *
466 ProcessorEntry::build_send_options_menu ()
467 {
468         using namespace Menu_Helpers;
469         Menu* menu = manage (new Menu);
470         MenuList& items = menu->items ();
471
472         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
473         if (send) {
474
475                 items.push_back (CheckMenuElem (_("Link panner controls")));
476                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
477                 c->set_active (send->panner_shell()->is_linked_to_route());
478                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
479
480         }
481         return menu;
482 }
483
484 void
485 ProcessorEntry::toggle_panner_link ()
486 {
487         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
488         if (send) {
489                 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
490         }
491 }
492
493 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
494         : _control (c)
495         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
496         , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * ARDOUR_UI::ui_scale)))
497         , _slider_persistant_tooltip (&_slider)
498         , _button (ArdourButton::led_default_elements)
499         , _ignore_ui_adjustment (false)
500         , _visible (false)
501         , _name (n)
502 {
503         _slider.set_controllable (c);
504         box.set_padding(0, 0, 4, 4);
505
506         if (c->toggled()) {
507                 _button.set_text (_name);
508                 _button.set_led_left (true);
509                 _button.set_name ("processor control button");
510                 box.add (_button);
511                 _button.show ();
512
513                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
514                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
515                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
516
517         } else {
518                 
519                 _slider.set_name ("ProcessorControlSlider");
520                 _slider.set_text (_name);
521
522                 box.add (_slider);
523                 _slider.show ();
524
525                 const ARDOUR::ParameterDescriptor& desc = c->desc();
526                 double const lo = c->internal_to_interface(desc.lower);
527                 double const up = c->internal_to_interface(desc.upper);
528                 double const normal = c->internal_to_interface(desc.normal);
529                 double smallstep = desc.smallstep;
530                 double largestep = desc.largestep;
531
532                 if (smallstep == 0.0) {
533                         smallstep = up / 1000.;
534                 } else {
535                         smallstep = c->internal_to_interface(desc.lower + smallstep);
536                 }
537
538                 if (largestep == 0.0) {
539                         largestep = up / 40.;
540                 } else {
541                         largestep = c->internal_to_interface(desc.lower + largestep);
542                 }
543
544                 _adjustment.set_lower (lo);
545                 _adjustment.set_upper (up);
546                 _adjustment.set_step_increment (smallstep);
547                 _adjustment.set_page_increment (largestep);
548                 _slider.set_default_value (normal);
549                 
550                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
551                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
552         }
553
554         Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
555         
556         control_changed ();
557         set_tooltip ();
558
559         /* We're providing our own PersistentTooltip */
560         set_no_tooltip_whatsoever (_slider);
561 }
562
563 void
564 ProcessorEntry::Control::set_tooltip ()
565 {
566         boost::shared_ptr<AutomationControl> c = _control.lock ();
567
568         if (!c) {
569                 return;
570         }
571         char tmp[256];
572         if (c->toggled ()) {
573                 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
574         } else {
575                 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
576         }
577
578         string sm = Glib::Markup::escape_text (tmp);
579         _slider_persistant_tooltip.set_tip (sm);
580         ARDOUR_UI::instance()->set_tip (_button, sm);
581 }
582
583 void
584 ProcessorEntry::Control::slider_adjusted ()
585 {
586         if (_ignore_ui_adjustment) {
587                 return;
588         }
589         
590         boost::shared_ptr<AutomationControl> c = _control.lock ();
591
592         if (!c) {
593                 return;
594         }
595
596         c->set_value ( c->interface_to_internal(_adjustment.get_value ()) );
597         set_tooltip ();
598 }
599
600 void
601 ProcessorEntry::Control::button_clicked ()
602 {
603         boost::shared_ptr<AutomationControl> c = _control.lock ();
604
605         if (!c) {
606                 return;
607         }
608
609         bool const n = _button.get_active ();
610
611         c->set_value (n ? 0 : 1);
612         _button.set_active (!n);
613         set_tooltip ();
614 }
615
616 void
617 ProcessorEntry::Control::control_changed ()
618 {
619         boost::shared_ptr<AutomationControl> c = _control.lock ();
620         if (!c) {
621                 return;
622         }
623
624         _ignore_ui_adjustment = true;
625
626         if (c->toggled ()) {
627
628                 _button.set_active (c->get_value() > 0.5);
629                 
630         } else {
631
632                 _adjustment.set_value (c->internal_to_interface(c->get_value ()));
633                 set_tooltip ();
634         }
635         
636         _ignore_ui_adjustment = false;
637 }
638
639 void
640 ProcessorEntry::Control::add_state (XMLNode* node) const
641 {
642         XMLNode* c = new XMLNode (X_("Object"));
643         c->add_property (X_("id"), state_id ());
644         c->add_property (X_("visible"), _visible);
645         node->add_child_nocopy (*c);
646 }
647
648 void
649 ProcessorEntry::Control::set_state (XMLNode const * node)
650 {
651         XMLNode* n = GUIObjectState::get_node (node, state_id ());
652         if (n) {
653                 XMLProperty* p = n->property (X_("visible"));
654                 set_visible (p && string_is_affirmative (p->value ()));
655         } else {
656                 set_visible (false);
657         }
658 }
659
660 void
661 ProcessorEntry::Control::set_visible (bool v)
662 {
663         if (v) {
664                 box.show ();
665         } else {
666                 box.hide ();
667         }
668         
669         _visible = v;
670 }
671
672 /** Called when the Editor might have re-shown things that
673     we want hidden.
674 */
675 void
676 ProcessorEntry::Control::hide_things ()
677 {
678         if (!_visible) {
679                 box.hide ();
680         }
681 }
682
683 string
684 ProcessorEntry::Control::state_id () const
685 {
686         boost::shared_ptr<AutomationControl> c = _control.lock ();
687         assert (c);
688
689         return string_compose (X_("control %1"), c->id().to_s ());
690 }
691
692 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
693         : ProcessorEntry (b, p, w)
694         , _plugin_insert (p)
695 {
696         p->PluginIoReConfigure.connect (
697                 _splitting_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::plugin_insert_splitting_changed, this), gui_context()
698                 );
699
700         plugin_insert_splitting_changed ();
701 }
702
703 void
704 PluginInsertProcessorEntry::plugin_insert_splitting_changed ()
705 {
706         _output_icon.set_ports(_plugin_insert->output_streams());
707         _routing_icon.set_splitting(_plugin_insert->splitting ());
708
709         ChanCount sources = _plugin_insert->input_streams();
710         ChanCount sinks = _plugin_insert->natural_input_streams();
711
712         /* replicated instances */
713         if (!_plugin_insert->splitting () && _plugin_insert->get_count() > 1) {
714                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
715                         sinks.set(*t, sinks.get(*t) * _plugin_insert->get_count());
716                 }
717         }
718         /* MIDI bypass */
719         if (_plugin_insert->natural_output_streams().n_midi() == 0 &&
720                         _plugin_insert->output_streams().n_midi() == 1) {
721                 sinks.set(DataType::MIDI, 1);
722                 sources.set(DataType::MIDI, 1);
723         }
724
725         _input_icon.set_ports(sinks);
726         _routing_icon.set_sinks(sinks);
727         _routing_icon.set_sources(sources);
728
729         if (_plugin_insert->splitting () ||
730                         _plugin_insert->input_streams().n_audio() < _plugin_insert->natural_input_streams().n_audio()
731                  )
732         {
733                 _routing_icon.set_size_request (-1, std::max (7.f, rintf(7.f * ARDOUR_UI::ui_scale)));
734                 _routing_icon.set_visible(true);
735                 _input_icon.show();
736         } else {
737                 _routing_icon.set_visible(false);
738                 if (_position_num != 0) {
739                         _input_icon.hide();
740                 }
741         }
742
743         _input_icon.queue_draw();
744         _output_icon.queue_draw();
745         _routing_icon.queue_draw();
746 }
747
748 void
749 PluginInsertProcessorEntry::hide_things ()
750 {
751         ProcessorEntry::hide_things ();
752         plugin_insert_splitting_changed ();
753 }
754
755 ProcessorEntry::PortIcon::PortIcon(bool input) {
756         _input = input;
757         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
758         set_size_request (-1, std::max (2.f, rintf(2.f * ARDOUR_UI::ui_scale)));
759 }
760
761 bool
762 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
763 {
764         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
765
766         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
767         cairo_clip (cr);
768
769         Gtk::Allocation a = get_allocation();
770         double const width = a.get_width();
771         double const height = a.get_height();
772
773         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
774         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
775
776         cairo_rectangle (cr, 0, 0, width, height);
777         cairo_fill (cr);
778
779         const double dx = rint(max(2., 2. * ARDOUR_UI::ui_scale));
780         if (_ports.n_total() > 1) {
781                 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
782                         if (i < _ports.n_midi()) {
783                                 cairo_set_source_rgb (cr,
784                                                 UINT_RGBA_R_FLT(midi_port_color),
785                                                 UINT_RGBA_G_FLT(midi_port_color),
786                                                 UINT_RGBA_B_FLT(midi_port_color));
787                         } else {
788                                 cairo_set_source_rgb (cr,
789                                                 UINT_RGBA_R_FLT(audio_port_color),
790                                                 UINT_RGBA_G_FLT(audio_port_color),
791                                                 UINT_RGBA_B_FLT(audio_port_color));
792                         }
793                         const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
794                         cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
795                         cairo_fill(cr);
796                 }
797         } else if (_ports.n_total() == 1) {
798                 if (_ports.n_midi() == 1) {
799                         cairo_set_source_rgb (cr,
800                                         UINT_RGBA_R_FLT(midi_port_color),
801                                         UINT_RGBA_G_FLT(midi_port_color),
802                                         UINT_RGBA_B_FLT(midi_port_color));
803                 } else {
804                         cairo_set_source_rgb (cr,
805                                         UINT_RGBA_R_FLT(audio_port_color),
806                                         UINT_RGBA_G_FLT(audio_port_color),
807                                         UINT_RGBA_B_FLT(audio_port_color));
808                 }
809                 const float x = rintf(width * .5);
810                 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
811                 cairo_fill(cr);
812                 cairo_stroke(cr);
813         }
814
815         cairo_destroy(cr);
816         return true;
817 }
818
819 bool
820 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
821 {
822         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
823
824         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
825         cairo_clip (cr);
826
827         cairo_set_line_width (cr, max (1.f, ARDOUR_UI::ui_scale));
828         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
829
830         Gtk::Allocation a = get_allocation();
831         double const width = a.get_width();
832         double const height = a.get_height();
833
834         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
835         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
836
837         cairo_rectangle (cr, 0, 0, width, height);
838         cairo_fill (cr);
839
840         Gdk::Color const fg = get_style()->get_fg (STATE_NORMAL);
841         cairo_set_source_rgb (cr, fg.get_red_p (), fg.get_green_p (), fg.get_blue_p ());
842
843         const uint32_t sources = _sources.n_total();
844         const uint32_t sinks = _sinks.n_total();
845
846         /* MIDI */
847         const uint32_t midi_sources = _sources.n_midi();
848         const uint32_t midi_sinks = _sinks.n_midi();
849
850         cairo_set_source_rgb (cr,
851                         UINT_RGBA_R_FLT(midi_port_color),
852                         UINT_RGBA_G_FLT(midi_port_color),
853                         UINT_RGBA_B_FLT(midi_port_color));
854         if (midi_sources > 0 && midi_sinks > 0 && sinks > 1 && sources > 1) {
855                 for (uint32_t i = 0 ; i < midi_sources; ++i) {
856                         const float si_x  = rintf(width * (.2f + .6f * i  / (sinks - 1.f))) + .5f;
857                         const float si_x0 = rintf(width * (.2f + .6f * i / (sources - 1.f))) + .5f;
858                         cairo_move_to (cr, si_x, height);
859                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
860                         cairo_stroke (cr);
861                 }
862         } else if (midi_sources == 1 && midi_sinks == 1 && sinks == 1 && sources == 1) {
863                 const float si_x = rintf(width * .5f) + .5f;
864                 cairo_move_to (cr, si_x, height);
865                 cairo_line_to (cr, si_x, 0);
866                 cairo_stroke (cr);
867         } else if (midi_sources == 1 && midi_sinks == 1) {
868                 /* unusual cases -- removed synth, midi-track w/audio plugins */
869                 const float si_x  = rintf(width * (sinks   > 1 ? .2f : .5f)) + .5f;
870                 const float si_x0 = rintf(width * (sources > 1 ? .2f : .5f)) + .5f;
871                 cairo_move_to (cr, si_x, height);
872                 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
873                 cairo_stroke (cr);
874         }
875
876         /* AUDIO */
877         const uint32_t audio_sources = _sources.n_audio();
878         const uint32_t audio_sinks = _sinks.n_audio();
879         cairo_set_source_rgb (cr,
880                         UINT_RGBA_R_FLT(audio_port_color),
881                         UINT_RGBA_G_FLT(audio_port_color),
882                         UINT_RGBA_B_FLT(audio_port_color));
883
884         if (_splitting) {
885                 assert(audio_sources < 2);
886                 assert(audio_sinks > 1);
887                 /* assume there is only ever one MIDI port */
888                 const float si_x0 = rintf(width * (midi_sources > 0 ? .8f : .5f)) + .5f;
889                 for (uint32_t i = midi_sinks; i < sinks; ++i) {
890                         const float si_x = rintf(width * (.2f + .6f * i / (sinks - 1.f))) + .5f;
891                         cairo_move_to (cr, si_x, height);
892                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
893                         cairo_stroke (cr);
894                 }
895         } else if (audio_sources > 1) {
896                 for (uint32_t i = 0 ; i < audio_sources; ++i) {
897                         const float si_x = rintf(width * (.2f + .6f * (i + midi_sinks) / (sinks - 1.f))) + .5f;
898                         const float si_x0 = rintf(width * (.2f + .6f * (i + midi_sources) / (sources - 1.f))) + .5f;
899                         cairo_move_to (cr, si_x, height);
900                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
901                         cairo_stroke (cr);
902                 }
903         } else if (audio_sources == 1 && audio_sinks == 1) {
904                 const float si_x = rintf(width * .5f) + .5f;
905                 cairo_move_to (cr, si_x, height);
906                 cairo_line_to (cr, si_x, 0);
907                 cairo_stroke (cr);
908         }
909         cairo_destroy(cr);
910         return true;
911 }
912
913 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
914                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
915         : _parent_strip (parent)
916         , _owner_is_mixer (owner_is_mixer)
917         , ab_direction (true)
918         , _get_plugin_selector (get_plugin_selector)
919         , _placement (-1)
920         , _visible_prefader_processors (0)
921         , _rr_selection(rsel)
922         , _redisplay_pending (false)
923
924 {
925         set_session (sess);
926
927         _width = Wide;
928         processor_menu = 0;
929         no_processor_redisplay = false;
930
931         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
932         processor_scroller.add (processor_display);
933         pack_start (processor_scroller, true, true);
934
935         processor_display.set_flags (CAN_FOCUS);
936         processor_display.set_name ("ProcessorList");
937         processor_display.set_data ("processorbox", this);
938         processor_display.set_size_request (48, -1);
939         processor_display.set_spacing (0);
940
941         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
942         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
943
944         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
945         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
946
947         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
948         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
949
950         processor_scroller.show ();
951         processor_display.show ();
952
953         if (parent) {
954                 parent->DeliveryChanged.connect (
955                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
956                         );
957         }
958
959         ARDOUR_UI::instance()->set_tip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
960 }
961
962 ProcessorBox::~ProcessorBox ()
963 {
964         /* it may appear as if we should delete processor_menu but that is a
965          * pointer to a widget owned by the UI Manager, and has potentially
966          * be returned to many other ProcessorBoxes. GTK doesn't really make
967          * clear the ownership of this widget, which is a menu and thus is
968          * never packed into any container other than an implict GtkWindow.
969          *
970          * For now, until or if we ever get clarification over the ownership
971          * story just let it continue to exist. At worst, its a small memory leak.
972          */
973 }
974
975 void
976 ProcessorBox::set_route (boost::shared_ptr<Route> r)
977 {
978         if (_route == r) {
979                 return;
980         }
981
982         _route_connections.drop_connections();
983
984         /* new route: any existing block on processor redisplay must be meaningless */
985         no_processor_redisplay = false;
986         _route = r;
987
988         _route->processors_changed.connect (
989                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
990                 );
991
992         _route->DropReferences.connect (
993                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
994                 );
995
996         _route->PropertyChanged.connect (
997                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
998                 );
999
1000         redisplay_processors ();
1001 }
1002
1003 void
1004 ProcessorBox::route_going_away ()
1005 {
1006         /* don't keep updating display as processors are deleted */
1007         no_processor_redisplay = true;
1008         _route.reset ();
1009 }
1010
1011 void
1012 ProcessorBox::object_drop(DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1013 {
1014         boost::shared_ptr<Processor> p;
1015         if (position) {
1016                 p = position->processor ();
1017                 if (!p) {
1018                         /* dropped on the blank entry (which will be before the
1019                            fader), so use the first non-blank child as our
1020                            `dropped on' processor */
1021                         list<ProcessorEntry*> c = processor_display.children ();
1022                         list<ProcessorEntry*>::iterator i = c.begin ();
1023
1024                         assert (i != c.end ());
1025                         p = (*i)->processor ();
1026                         assert (p);
1027                 }
1028         }
1029
1030         list<ProcessorEntry*> children = source->selection ();
1031         list<boost::shared_ptr<Processor> > procs;
1032         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1033                 if ((*i)->processor ()) {
1034                         procs.push_back ((*i)->processor ());
1035                 }
1036         }
1037
1038         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1039                 XMLNode& state = (*i)->get_state ();
1040                 XMLNodeList nlist;
1041                 nlist.push_back (&state);
1042                 paste_processor_state (nlist, p);
1043                 delete &state;
1044         }
1045
1046         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1047            ourselves.
1048         */
1049
1050         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1051                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1052                 if (other) {
1053                         other->delete_dragged_processors (procs);
1054                 }
1055         }
1056 }
1057
1058 void
1059 ProcessorBox::set_width (Width w)
1060 {
1061         if (_width == w) {
1062                 return;
1063         }
1064
1065         _width = w;
1066
1067         list<ProcessorEntry*> children = processor_display.children ();
1068         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1069                 (*i)->set_enum_width (w);
1070         }
1071
1072         queue_resize ();
1073 }
1074
1075 Gtk::Menu*
1076 ProcessorBox::build_possible_aux_menu ()
1077 {
1078         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1079
1080         if (rl->empty()) {
1081                 /* No aux sends if there are no busses */
1082                 return 0;
1083         }
1084
1085         using namespace Menu_Helpers;
1086         Menu* menu = manage (new Menu);
1087         MenuList& items = menu->items();
1088
1089         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1090                 if (!_route->internal_send_for (*r) && *r != _route) {
1091                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
1092                 }
1093         }
1094
1095         return menu;
1096 }
1097
1098 void
1099 ProcessorBox::show_processor_menu (int arg)
1100 {
1101         if (processor_menu == 0) {
1102                 processor_menu = build_processor_menu ();
1103                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
1104         }
1105
1106         /* Sort out the plugin submenu */
1107
1108         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
1109
1110         if (plugin_menu_item) {
1111                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
1112         }
1113
1114         /* And the aux submenu */
1115
1116         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
1117
1118         if (aux_menu_item) {
1119                 Menu* m = build_possible_aux_menu();
1120                 if (m && !m->items().empty()) {
1121                         aux_menu_item->set_submenu (*m);
1122                         aux_menu_item->set_sensitive (true);
1123                 } else {
1124                         /* stupid gtkmm: we need to pass a null reference here */
1125                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
1126                         aux_menu_item->set_sensitive (false);
1127                 }
1128         }
1129
1130         ProcessorEntry* single_selection = 0;
1131         if (processor_display.selection().size() == 1) {
1132                 single_selection = processor_display.selection().front();
1133         }
1134
1135         /* And the controls submenu */
1136
1137         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
1138
1139         if (controls_menu_item) {
1140                 if (single_selection) {
1141                         Menu* m = single_selection->build_controls_menu ();
1142                         if (m && !m->items().empty()) {
1143                                 controls_menu_item->set_submenu (*m);
1144                                 controls_menu_item->set_sensitive (true);
1145                         } else {
1146                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
1147                                 controls_menu_item->set_sensitive (false);
1148                         }
1149                 } else {
1150                         controls_menu_item->set_sensitive (false);
1151                 }
1152         }
1153
1154         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
1155         if (send_menu_item) {
1156                 if (single_selection) {
1157                         Menu* m = single_selection->build_send_options_menu ();
1158                         if (m && !m->items().empty()) {
1159                                 send_menu_item->set_submenu (*m);
1160                                 send_menu_item->set_sensitive (true);
1161                         } else {
1162                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
1163                                 send_menu_item->set_sensitive (false);
1164                         }
1165                 } else {
1166                         send_menu_item->set_sensitive (false);
1167                 }
1168         }
1169
1170         /* Sensitise actions as approprioate */
1171
1172         cut_action->set_sensitive (can_cut());
1173         paste_action->set_sensitive (!_rr_selection.processors.empty());
1174
1175         const bool sensitive = !processor_display.selection().empty();
1176         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, sensitive);
1177         edit_action->set_sensitive (one_processor_can_be_edited ());
1178         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
1179
1180         boost::shared_ptr<PluginInsert> pi;
1181         if (single_selection) {
1182                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
1183         }
1184
1185         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
1186         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
1187
1188         /* disallow rename for multiple selections, for plugin inserts and for the fader */
1189         rename_action->set_sensitive (single_selection && !pi && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ()));
1190
1191         processor_menu->popup (1, arg);
1192
1193         /* Add a placeholder gap to the processor list to indicate where a processor would be
1194            inserted were one chosen from the menu.
1195         */
1196         int x, y;
1197         processor_display.get_pointer (x, y);
1198         _placement = processor_display.add_placeholder (y);
1199
1200         if (_visible_prefader_processors == 0 && _placement > 0) {
1201                 --_placement;
1202         }
1203 }
1204
1205 bool
1206 ProcessorBox::enter_notify (GdkEventCrossing*)
1207 {
1208         _current_processor_box = this;
1209         return false;
1210 }
1211
1212 bool
1213 ProcessorBox::leave_notify (GdkEventCrossing*)
1214 {
1215         return false;
1216 }
1217
1218 bool
1219 ProcessorBox::processor_operation (ProcessorOperation op) 
1220 {
1221         ProcSelection targets;
1222
1223         get_selected_processors (targets);
1224
1225 /*      if (targets.empty()) {
1226
1227                 int x, y;
1228                 processor_display.get_pointer (x, y);
1229
1230                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
1231
1232                 if (pointer.first && pointer.first->processor()) {
1233                         targets.push_back (pointer.first->processor ());
1234                 }
1235         }
1236 */
1237
1238         if ( (op == ProcessorsDelete) && targets.empty() )
1239                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
1240         
1241         switch (op) {
1242         case ProcessorsSelectAll:
1243                 processor_display.select_all ();
1244                 break;
1245
1246         case ProcessorsSelectNone:
1247                 processor_display.select_none ();
1248                 break;
1249
1250         case ProcessorsCopy:
1251                 copy_processors (targets);
1252                 break;
1253
1254         case ProcessorsCut:
1255                 cut_processors (targets);
1256                 break;
1257
1258         case ProcessorsPaste:
1259                 if (targets.empty()) {
1260                         paste_processors ();
1261                 } else {
1262                         paste_processors (targets.front());
1263                 }
1264                 break;
1265
1266         case ProcessorsDelete:
1267                 delete_processors (targets);
1268                 break;
1269
1270         case ProcessorsToggleActive:
1271                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
1272                         if ((*i)->active()) {
1273                                 (*i)->deactivate ();
1274                         } else {
1275                                 (*i)->activate ();
1276                         }
1277                 }
1278                 break;
1279
1280         case ProcessorsAB:
1281                 ab_plugins ();
1282                 break;
1283
1284         default:
1285                 break;
1286         }
1287         
1288         return true;
1289 }
1290
1291 ProcessorWindowProxy* 
1292 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
1293 {
1294         return  processor->window_proxy();
1295 }
1296
1297
1298 bool
1299 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
1300 {
1301         boost::shared_ptr<Processor> processor;
1302         if (child) {
1303                 processor = child->processor ();
1304         }
1305
1306         int ret = false;
1307         bool selected = processor_display.selected (child);
1308
1309         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
1310
1311                 if (_session->engine().connected()) {
1312                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
1313
1314                         if (!one_processor_can_be_edited ()) {
1315                                 return true;
1316                         }
1317
1318                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1319                                 generic_edit_processor (processor);
1320                         } else {
1321                                 edit_processor (processor);
1322                         }
1323                 }
1324
1325                 ret = true;
1326
1327         } else if (Keyboard::is_context_menu_event (ev)) {
1328
1329                 show_processor_menu (ev->time);
1330                 
1331                 ret = true;
1332
1333         } else if (processor && ev->button == 1 && selected) {
1334
1335                 // this is purely informational but necessary for route params UI
1336                 ProcessorSelected (processor); // emit
1337
1338         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
1339
1340                 choose_plugin ();
1341                 _get_plugin_selector()->show_manager ();
1342         }
1343
1344         return ret;
1345 }
1346
1347 bool
1348 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
1349 {
1350         boost::shared_ptr<Processor> processor;
1351         if (child) {
1352                 processor = child->processor ();
1353         }
1354
1355         if (processor && Keyboard::is_delete_event (ev)) {
1356
1357                 Glib::signal_idle().connect (sigc::bind (
1358                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
1359                                 boost::weak_ptr<Processor>(processor)));
1360
1361         } else if (processor && Keyboard::is_button2_event (ev)
1362 #ifndef GTKOSX
1363                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
1364 #endif
1365                 ) {
1366
1367                 /* button2-click with no/appropriate modifiers */
1368
1369                 if (processor->active()) {
1370                         processor->deactivate ();
1371                 } else {
1372                         processor->activate ();
1373                 }
1374         }
1375
1376         return false;
1377 }
1378
1379 Menu *
1380 ProcessorBox::build_processor_menu ()
1381 {
1382         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
1383         processor_menu->set_name ("ArdourContextMenu");
1384         return processor_menu;
1385 }
1386
1387 void
1388 ProcessorBox::select_all_processors ()
1389 {
1390         processor_display.select_all ();
1391 }
1392
1393 void
1394 ProcessorBox::deselect_all_processors ()
1395 {
1396         processor_display.select_none ();
1397 }
1398
1399 void
1400 ProcessorBox::choose_plugin ()
1401 {
1402         _get_plugin_selector()->set_interested_object (*this);
1403 }
1404
1405 /** @return true if an error occurred, otherwise false */
1406 bool
1407 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
1408 {
1409         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
1410
1411                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
1412
1413                 Route::ProcessorStreams err_streams;
1414
1415                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1416                         weird_plugin_dialog (**p, err_streams);
1417                         return true;
1418                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
1419                 } else {
1420
1421                         if (Profile->get_sae()) {
1422                                 processor->activate ();
1423                         }
1424                 }
1425         }
1426
1427         return false;
1428 }
1429
1430 void
1431 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
1432 {
1433         ArdourDialog dialog (_("Plugin Incompatibility"));
1434         Label label;
1435
1436         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
1437                         p.name(), streams.index);
1438
1439         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
1440         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
1441
1442         text += _("\nThis plugin has:\n");
1443         if (has_midi) {
1444                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
1445                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
1446         }
1447         if (has_audio) {
1448                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
1449                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
1450         }
1451
1452         text += _("\nbut at the insertion point, there are:\n");
1453         if (has_midi) {
1454                 uint32_t const n = streams.count.n_midi ();
1455                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
1456         }
1457         if (has_audio) {
1458                 uint32_t const n = streams.count.n_audio ();
1459                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
1460         }
1461
1462         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
1463         label.set_text(text);
1464
1465         dialog.get_vbox()->pack_start (label);
1466         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1467
1468         dialog.set_name (X_("PluginIODialog"));
1469         dialog.set_modal (true);
1470         dialog.show_all ();
1471
1472         dialog.run ();
1473 }
1474
1475 void
1476 ProcessorBox::choose_insert ()
1477 {
1478         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
1479         _route->add_processor_by_index (processor, _placement);
1480 }
1481
1482 /* Caller must not hold process lock */
1483 void
1484 ProcessorBox::choose_send ()
1485 {
1486         boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
1487         boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
1488
1489         /* make an educated guess at the initial number of outputs for the send */
1490         ChanCount outs = (_session->master_out())
1491                         ? _session->master_out()->n_outputs()
1492                         : _route->n_outputs();
1493
1494         /* XXX need processor lock on route */
1495         try {
1496                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1497                 send->output()->ensure_io (outs, false, this);
1498         } catch (AudioEngine::PortRegistrationFailure& err) {
1499                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
1500                 return;
1501         }
1502
1503         /* let the user adjust the IO setup before creation.
1504
1505            Note: this dialog is NOT modal - we just leave it to run and it will
1506            return when its Finished signal is emitted - typically when the window
1507            is closed.
1508          */
1509
1510         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
1511         ios->show ();
1512
1513         /* keep a reference to the send so it doesn't get deleted while
1514            the IOSelectorWindow is doing its stuff
1515         */
1516         _processor_being_created = send;
1517
1518         ios->selector().Finished.connect (sigc::bind (
1519                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
1520                         boost::weak_ptr<Processor>(send), ios));
1521
1522 }
1523
1524 void
1525 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1526 {
1527         boost::shared_ptr<Processor> processor (weak_processor.lock());
1528
1529         /* drop our temporary reference to the new send */
1530         _processor_being_created.reset ();
1531
1532         if (!processor) {
1533                 return;
1534         }
1535
1536         switch (r) {
1537         case IOSelector::Cancelled:
1538                 // processor will go away when all shared_ptrs to it vanish
1539                 break;
1540
1541         case IOSelector::Accepted:
1542                 _route->add_processor_by_index (processor, _placement);
1543                 if (Profile->get_sae()) {
1544                         processor->activate ();
1545                 }
1546                 break;
1547         }
1548
1549         delete_when_idle (ios);
1550 }
1551
1552 void
1553 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1554 {
1555         boost::shared_ptr<Processor> processor (weak_processor.lock());
1556
1557         /* drop our temporary reference to the new return */
1558         _processor_being_created.reset ();
1559
1560         if (!processor) {
1561                 return;
1562         }
1563
1564         switch (r) {
1565         case IOSelector::Cancelled:
1566                 // processor will go away when all shared_ptrs to it vanish
1567                 break;
1568
1569         case IOSelector::Accepted:
1570                 _route->add_processor_by_index (processor, _placement);
1571                 if (Profile->get_sae()) {
1572                         processor->activate ();
1573                 }
1574                 break;
1575         }
1576
1577         delete_when_idle (ios);
1578 }
1579
1580 void
1581 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
1582 {
1583         if (!_route) {
1584                 return;
1585         }
1586
1587         boost::shared_ptr<Route> target = wr.lock();
1588
1589         if (!target) {
1590                 return;
1591         }
1592
1593         _session->add_internal_send (target, _placement, _route);
1594 }
1595
1596 void
1597 ProcessorBox::route_processors_changed (RouteProcessorChange c)
1598 {
1599         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
1600                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
1601                 return;
1602         }
1603
1604         redisplay_processors ();
1605 }
1606
1607 void
1608 ProcessorBox::redisplay_processors ()
1609 {
1610         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
1611         bool     fader_seen;
1612
1613         if (no_processor_redisplay) {
1614                 return;
1615         }
1616
1617         processor_display.clear ();
1618
1619         _visible_prefader_processors = 0;
1620         fader_seen = false;
1621
1622         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors), 
1623                                                &_visible_prefader_processors, &fader_seen));
1624
1625         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
1626         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
1627         setup_entry_positions ();
1628 }
1629
1630 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
1631  *  not already have one.
1632  */
1633 void
1634 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
1635 {
1636         boost::shared_ptr<Processor> p = w.lock ();
1637         if (!p) {
1638                 return;
1639         }
1640         if (p->window_proxy()) {
1641                 return;
1642         }
1643
1644         /* not on the list; add it */
1645
1646         string loc;
1647 #if 0 // is this still needed? Why?
1648         if (_parent_strip) {
1649                 if (_parent_strip->mixer_owned()) {
1650                         loc = X_("M");
1651                 } else {
1652                         loc = X_("R");
1653                 }
1654         } else {
1655                 loc = X_("P");
1656         }
1657 #else
1658         loc = X_("P");
1659 #endif
1660
1661         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
1662                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
1663                 this,
1664                 w);
1665
1666         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
1667
1668         if (ui_xml) {
1669                 wp->set_state (*ui_xml);
1670         }
1671         
1672         void* existing_ui = p->get_ui ();
1673
1674         if (existing_ui) {
1675                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
1676         }
1677
1678         p->set_window_proxy (wp);
1679         WM::Manager::instance().register_window (wp);
1680 }
1681
1682 void
1683 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
1684 {
1685         boost::shared_ptr<Processor> processor (p.lock ());
1686
1687         if (processor && processor->display_to_user()) {
1688
1689                 if (boost::dynamic_pointer_cast<Amp>(processor)) {
1690                         *amp_seen = true;
1691                 } else {
1692                         if (!*amp_seen) {
1693                                 (*cnt)++;
1694                         }
1695                 }
1696         }
1697 }
1698
1699 void
1700 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
1701 {
1702         boost::shared_ptr<Processor> processor (p.lock ());
1703
1704         if (!processor || !processor->display_to_user()) {
1705                 return;
1706         }
1707
1708         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
1709         
1710         ProcessorEntry* e = 0;
1711         if (plugin_insert) {
1712                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
1713         } else {
1714                 e = new ProcessorEntry (this, processor, _width);
1715         }
1716
1717         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
1718         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
1719         
1720         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
1721         if (!send && !plugin_insert && !ext)
1722                 e->set_selectable(false);
1723
1724         bool mark_send_visible = false;
1725         if (send && _parent_strip) {
1726                 /* show controls of new sends by default */
1727                 GUIObjectState& st = _parent_strip->gui_object_state ();
1728                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
1729                 assert (strip);
1730                 /* check if state exists, if not it must be a new send */
1731                 if (!st.get_node(strip, e->state_id())) {
1732                         mark_send_visible = true;
1733                 }
1734         }
1735
1736         /* Set up this entry's state from the GUIObjectState */
1737         XMLNode* proc = entry_gui_object_state (e);
1738         if (proc) {
1739                 e->set_control_state (proc);
1740         }
1741
1742         if (mark_send_visible) {
1743                 e->show_all_controls ();
1744         }
1745
1746         processor_display.add_child (e);
1747 }
1748
1749 void
1750 ProcessorBox::reordered ()
1751 {
1752         compute_processor_sort_keys ();
1753         setup_entry_positions ();
1754 }
1755
1756 void
1757 ProcessorBox::setup_entry_positions ()
1758 {
1759         list<ProcessorEntry*> children = processor_display.children ();
1760         bool pre_fader = true;
1761
1762         uint32_t num = 0;
1763         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1764                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor())) {
1765                         pre_fader = false;
1766                         (*i)->set_position (ProcessorEntry::Fader, num++);
1767                 } else {
1768                         if (pre_fader) {
1769                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
1770                         } else {
1771                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
1772                         }
1773                 }
1774         }
1775 }
1776
1777 void
1778 ProcessorBox::compute_processor_sort_keys ()
1779 {
1780         list<ProcessorEntry*> children = processor_display.children ();
1781         Route::ProcessorList our_processors;
1782
1783         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1784                 if ((*i)->processor()) {
1785                         our_processors.push_back ((*i)->processor ());
1786                 }
1787         }
1788
1789         if (_route->reorder_processors (our_processors)) {
1790                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
1791                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
1792                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
1793                    when the drag is torn down after this handler function is finished.
1794                 */
1795                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
1796         }
1797 }
1798
1799 void
1800 ProcessorBox::report_failed_reorder ()
1801 {
1802         /* reorder failed, so redisplay */
1803
1804         redisplay_processors ();
1805
1806         /* now tell them about the problem */
1807
1808         ArdourDialog dialog (_("Plugin Incompatibility"));
1809         Label label;
1810
1811         label.set_text (_("\
1812 You cannot reorder these plugins/sends/inserts\n\
1813 in that way because the inputs and\n\
1814 outputs will not work correctly."));
1815
1816         dialog.get_vbox()->set_border_width (12);
1817         dialog.get_vbox()->pack_start (label);
1818         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1819
1820         dialog.set_name (X_("PluginIODialog"));
1821         dialog.set_modal (true);
1822         dialog.show_all ();
1823
1824         dialog.run ();
1825 }
1826
1827 void
1828 ProcessorBox::rename_processors ()
1829 {
1830         ProcSelection to_be_renamed;
1831
1832         get_selected_processors (to_be_renamed);
1833
1834         if (to_be_renamed.empty()) {
1835                 return;
1836         }
1837
1838         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
1839                 rename_processor (*i);
1840         }
1841 }
1842
1843 bool
1844 ProcessorBox::can_cut () const
1845 {
1846         vector<boost::shared_ptr<Processor> > sel;
1847
1848         get_selected_processors (sel);
1849
1850         /* cut_processors () does not cut inserts */
1851
1852         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
1853
1854                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1855                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1856                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1857                         return true;
1858                 }
1859         }
1860
1861         return false;
1862 }
1863
1864 void
1865 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
1866 {
1867         if (to_be_removed.empty()) {
1868                 return;
1869         }
1870
1871         XMLNode* node = new XMLNode (X_("cut"));
1872         Route::ProcessorList to_cut;
1873
1874         no_processor_redisplay = true;
1875         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
1876                 // Cut only plugins, sends and returns
1877                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1878                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1879                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1880
1881                         Window* w = get_processor_ui (*i);
1882
1883                         if (w) {
1884                                 w->hide ();
1885                         }
1886
1887                         XMLNode& child ((*i)->get_state());
1888                         node->add_child_nocopy (child);
1889                         to_cut.push_back (*i);
1890                 }
1891         }
1892
1893         if (_route->remove_processors (to_cut) != 0) {
1894                 delete node;
1895                 no_processor_redisplay = false;
1896                 return;
1897         }
1898
1899         _rr_selection.set (node);
1900
1901         no_processor_redisplay = false;
1902         redisplay_processors ();
1903 }
1904
1905 void
1906 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
1907 {
1908         if (to_be_copied.empty()) {
1909                 return;
1910         }
1911
1912         XMLNode* node = new XMLNode (X_("copy"));
1913
1914         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
1915                 // Copy only plugins, sends, returns
1916                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1917                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1918                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1919                         node->add_child_nocopy ((*i)->get_state());
1920                 }
1921         }
1922
1923         _rr_selection.set (node);
1924 }
1925
1926 void
1927 ProcessorBox::delete_processors (const ProcSelection& targets)
1928 {
1929         if (targets.empty()) {
1930                 return;
1931         }
1932
1933         no_processor_redisplay = true;
1934
1935         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
1936
1937                 Window* w = get_processor_ui (*i);
1938
1939                 if (w) {
1940                         w->hide ();
1941                 }
1942
1943                 _route->remove_processor(*i);
1944         }
1945
1946         no_processor_redisplay = false;
1947         redisplay_processors ();
1948 }
1949
1950 void
1951 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
1952 {
1953         list<boost::shared_ptr<Processor> >::const_iterator x;
1954
1955         no_processor_redisplay = true;
1956         for (x = procs.begin(); x != procs.end(); ++x) {
1957
1958                 Window* w = get_processor_ui (*x);
1959
1960                 if (w) {
1961                         w->hide ();
1962                 }
1963
1964                 _route->remove_processor(*x);
1965         }
1966
1967         no_processor_redisplay = false;
1968         redisplay_processors ();
1969 }
1970
1971 gint
1972 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
1973 {
1974         boost::shared_ptr<Processor> processor (weak_processor.lock());
1975
1976         if (!processor) {
1977                 return false;
1978         }
1979
1980         /* NOT copied to _mixer.selection() */
1981
1982         no_processor_redisplay = true;
1983         _route->remove_processor (processor);
1984         no_processor_redisplay = false;
1985         redisplay_processors ();
1986
1987         return false;
1988 }
1989
1990 void
1991 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
1992 {
1993         ArdourPrompter name_prompter (true);
1994         string result;
1995         name_prompter.set_title (_("Rename Processor"));
1996         name_prompter.set_prompt (_("New name:"));
1997         name_prompter.set_initial_text (processor->name());
1998         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
1999         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
2000         name_prompter.show_all ();
2001
2002         switch (name_prompter.run ()) {
2003
2004         case Gtk::RESPONSE_ACCEPT:
2005                 name_prompter.get_result (result);
2006                 if (result.length()) {
2007
2008                        int tries = 0;
2009                        string test = result;
2010
2011                        while (tries < 100) {
2012                                if (_session->io_name_is_legal (test)) {
2013                                        result = test;
2014                                        break;
2015                                }
2016                                tries++;
2017
2018                                test = string_compose ("%1-%2", result, tries);
2019                        }
2020
2021                        if (tries < 100) {
2022                                processor->set_name (result);
2023                        } else {
2024                                /* unlikely! */
2025                                ARDOUR_UI::instance()->popup_error
2026                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
2027                        }
2028                 }
2029                 break;
2030         }
2031
2032         return;
2033 }
2034
2035 void
2036 ProcessorBox::paste_processors ()
2037 {
2038         if (_rr_selection.processors.empty()) {
2039                 return;
2040         }
2041
2042         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
2043 }
2044
2045 void
2046 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
2047 {
2048
2049         if (_rr_selection.processors.empty()) {
2050                 return;
2051         }
2052
2053         paste_processor_state (_rr_selection.processors.get_node().children(), before);
2054 }
2055
2056 void
2057 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
2058 {
2059         XMLNodeConstIterator niter;
2060         list<boost::shared_ptr<Processor> > copies;
2061
2062         if (nlist.empty()) {
2063                 return;
2064         }
2065
2066         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2067
2068                 XMLProperty const * type = (*niter)->property ("type");
2069                 XMLProperty const * role = (*niter)->property ("role");
2070                 assert (type);
2071
2072                 boost::shared_ptr<Processor> p;
2073                 try {
2074                         if (type->value() == "meter" ||
2075                             type->value() == "main-outs" ||
2076                             type->value() == "amp" ||
2077                             type->value() == "intreturn") {
2078                                 /* do not paste meter, main outs, amp or internal returns */
2079                                 continue;
2080
2081                         } else if (type->value() == "intsend") {
2082                                 
2083                                 /* aux sends are OK, but those used for
2084                                  * other purposes, are not.
2085                                  */
2086                                 
2087                                 assert (role);
2088
2089                                 if (role->value() != "Aux") {
2090                                         continue;
2091                                 }
2092
2093                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2094                                 XMLNode n (**niter);
2095                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
2096                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
2097
2098                                 IOProcessor::prepare_for_reset (n, s->name());
2099
2100                                 if (s->set_state (n, Stateful::loading_state_version)) {
2101                                         delete s;
2102                                         return;
2103                                 }
2104
2105                                 p.reset (s);
2106
2107                         } else if (type->value() == "send") {
2108
2109                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2110                                 XMLNode n (**niter);
2111
2112                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
2113
2114                                 IOProcessor::prepare_for_reset (n, s->name());
2115                                 
2116                                 if (s->set_state (n, Stateful::loading_state_version)) {
2117                                         delete s;
2118                                         return;
2119                                 }
2120
2121                                 p.reset (s);
2122
2123                         } else if (type->value() == "return") {
2124
2125                                 XMLNode n (**niter);
2126                                 Return* r = new Return (*_session);
2127
2128                                 IOProcessor::prepare_for_reset (n, r->name());
2129
2130                                 if (r->set_state (n, Stateful::loading_state_version)) {
2131                                         delete r;
2132                                         return;
2133                                 }
2134
2135                                 p.reset (r);
2136
2137                         } else if (type->value() == "port") {
2138
2139                                 XMLNode n (**niter);
2140                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
2141                                 
2142                                 IOProcessor::prepare_for_reset (n, pi->name());
2143                                 
2144                                 if (pi->set_state (n, Stateful::loading_state_version)) {
2145                                         return;
2146                                 }
2147                                 
2148                                 p.reset (pi);
2149
2150                         } else {
2151                                 /* XXX its a bit limiting to assume that everything else
2152                                    is a plugin.
2153                                 */
2154                                 p.reset (new PluginInsert (*_session));
2155                                 PBD::ID id = p->id();
2156                                 p->set_state (**niter, Stateful::current_state_version);
2157                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
2158                         }
2159
2160                         copies.push_back (p);
2161                 }
2162
2163                 catch (...) {
2164                         error << _("plugin insert constructor failed") << endmsg;
2165                 }
2166         }
2167
2168         if (copies.empty()) {
2169                 return;
2170         }
2171
2172         if (_route->add_processors (copies, p)) {
2173
2174                 string msg = _(
2175                         "Copying the set of processors on the clipboard failed,\n\
2176 probably because the I/O configuration of the plugins\n\
2177 could not match the configuration of this track.");
2178                 MessageDialog am (msg);
2179                 am.run ();
2180         }
2181 }
2182
2183 void
2184 ProcessorBox::get_selected_processors (ProcSelection& processors) const
2185 {
2186         const list<ProcessorEntry*> selection = processor_display.selection ();
2187         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
2188                 processors.push_back ((*i)->processor ());
2189         }
2190 }
2191
2192 void
2193 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
2194 {
2195         list<ProcessorEntry*> selection = processor_display.selection ();
2196         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
2197                 (this->*method) ((*i)->processor ());
2198         }
2199 }
2200
2201 void
2202 ProcessorBox::all_visible_processors_active (bool state)
2203 {
2204         _route->all_visible_processors_active (state);
2205 }
2206
2207 void
2208 ProcessorBox::ab_plugins ()
2209 {
2210         _route->ab_plugins (ab_direction);
2211         ab_direction = !ab_direction;
2212 }
2213
2214
2215 void
2216 ProcessorBox::clear_processors ()
2217 {
2218         string prompt;
2219         vector<string> choices;
2220
2221         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
2222                                    "(this cannot be undone)"), _route->name());
2223
2224         choices.push_back (_("Cancel"));
2225         choices.push_back (_("Yes, remove them all"));
2226
2227         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2228
2229         if (prompter.run () == 1) {
2230                 _route->clear_processors (PreFader);
2231                 _route->clear_processors (PostFader);
2232         }
2233 }
2234
2235 void
2236 ProcessorBox::clear_processors (Placement p)
2237 {
2238         string prompt;
2239         vector<string> choices;
2240
2241         if (p == PreFader) {
2242                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
2243                                            "(this cannot be undone)"), _route->name());
2244         } else {
2245                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
2246                                            "(this cannot be undone)"), _route->name());
2247         }
2248
2249         choices.push_back (_("Cancel"));
2250         choices.push_back (_("Yes, remove them all"));
2251
2252         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2253
2254         if (prompter.run () == 1) {
2255                 _route->clear_processors (p);
2256         }
2257 }
2258
2259 bool
2260 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2261 {
2262         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2263         if (at && at->freeze_state() == AudioTrack::Frozen) {
2264                 return false;
2265         }
2266
2267         if (
2268                 boost::dynamic_pointer_cast<Send> (processor) ||
2269                 boost::dynamic_pointer_cast<Return> (processor) ||
2270                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2271                 boost::dynamic_pointer_cast<PortInsert> (processor)
2272                 ) {
2273                 return true;
2274         }
2275
2276         return false;
2277 }
2278
2279 bool
2280 ProcessorBox::one_processor_can_be_edited ()
2281 {
2282         list<ProcessorEntry*> selection = processor_display.selection ();
2283         list<ProcessorEntry*>::iterator i = selection.begin();
2284         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2285                 ++i;
2286         }
2287
2288         return (i != selection.end());
2289 }
2290
2291 Gtk::Window*
2292 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
2293 {
2294         boost::shared_ptr<Send> send;
2295         boost::shared_ptr<InternalSend> internal_send;
2296         boost::shared_ptr<Return> retrn;
2297         boost::shared_ptr<PluginInsert> plugin_insert;
2298         boost::shared_ptr<PortInsert> port_insert;
2299         Window* gidget = 0;
2300
2301         /* This method may or may not return a Window, but if it does not it
2302          * will modify the parent mixer strip appearance layout to allow
2303          * "editing" the @param processor that was passed in.
2304          *
2305          * So for example, if the processor is an Amp (gain), the parent strip
2306          * will be forced back into a model where the fader controls the main gain.
2307          * If the processor is a send, then we map the send controls onto the
2308          * strip.
2309          * 
2310          * Plugins and others will return a window for control.
2311          */
2312
2313         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2314
2315                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2316                         return 0;
2317                 }
2318         }
2319
2320         if (boost::dynamic_pointer_cast<Amp> (processor)) {
2321
2322                 if (_parent_strip) {
2323                         _parent_strip->revert_to_default_display ();
2324                 }
2325
2326         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2327
2328                 if (!_session->engine().connected()) {
2329                         return 0;
2330                 }
2331
2332                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2333
2334                         gidget = new SendUIWindow (send, _session);
2335                 }
2336
2337         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2338
2339                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2340                         /* no GUI for these */
2341                         return 0;
2342                 }
2343
2344                 if (!_session->engine().connected()) {
2345                         return 0;
2346                 }
2347
2348                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2349
2350                 ReturnUIWindow *return_ui;
2351                 Window* w = get_processor_ui (retrn);
2352
2353                 if (w == 0) {
2354
2355                         return_ui = new ReturnUIWindow (retrn, _session);
2356                         return_ui->set_title (retrn->name ());
2357                         set_processor_ui (send, return_ui);
2358
2359                 } else {
2360                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
2361                 }
2362
2363                 gidget = return_ui;
2364
2365         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2366
2367                 PluginUIWindow *plugin_ui;
2368
2369                 /* these are both allowed to be null */
2370
2371                 Window* w = get_processor_ui (plugin_insert);
2372
2373                 if (w == 0) {
2374                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
2375                         plugin_ui->set_title (generate_processor_title (plugin_insert));
2376                         set_processor_ui (plugin_insert, plugin_ui);
2377
2378                 } else {
2379                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2380                 }
2381
2382                 gidget = plugin_ui;
2383
2384         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2385
2386                 if (!_session->engine().connected()) {
2387                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
2388                         msg.run ();
2389                         return 0;
2390                 }
2391
2392                 PortInsertWindow *io_selector;
2393
2394                 Window* w = get_processor_ui (port_insert);
2395
2396                 if (w == 0) {
2397                         io_selector = new PortInsertWindow (_session, port_insert);
2398                         set_processor_ui (port_insert, io_selector);
2399
2400                 } else {
2401                         io_selector = dynamic_cast<PortInsertWindow *> (w);
2402                 }
2403
2404                 gidget = io_selector;
2405         }
2406
2407         return gidget;
2408 }
2409
2410 Gtk::Window*
2411 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
2412 {
2413         boost::shared_ptr<PluginInsert> plugin_insert
2414                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2415
2416         if (!plugin_insert) {
2417                 return 0;
2418         }
2419
2420         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
2421         win->set_title (generate_processor_title (plugin_insert));
2422
2423         return win;
2424 }
2425
2426 void
2427 ProcessorBox::register_actions ()
2428 {
2429         Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = Gtk::ActionGroup::create(X_("ProcessorMenu"));
2430         Glib::RefPtr<Action> act;
2431
2432         /* new stuff */
2433         ActionManager::register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2434                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2435
2436         act = ActionManager::register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2437                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2438         ActionManager::engine_sensitive_actions.push_back (act);
2439         act = ActionManager::register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2440                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
2441         ActionManager::engine_sensitive_actions.push_back (act);
2442
2443         ActionManager::register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2444
2445         ActionManager::register_action (popup_act_grp, X_("controls"), _("Controls"));
2446         ActionManager::register_action (popup_act_grp, X_("send_options"), _("Send Options"));
2447
2448         ActionManager::register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2449                         sigc::ptr_fun (ProcessorBox::rb_clear));
2450         ActionManager::register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2451                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2452         ActionManager::register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2453                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
2454
2455         /* standard editing stuff */
2456         cut_action = ActionManager::register_action (popup_act_grp, X_("cut"), _("Cut"),
2457                                                      sigc::ptr_fun (ProcessorBox::rb_cut));
2458         ActionManager::plugin_selection_sensitive_actions.push_back(cut_action);
2459         act = ActionManager::register_action (popup_act_grp, X_("copy"), _("Copy"),
2460                         sigc::ptr_fun (ProcessorBox::rb_copy));
2461         ActionManager::plugin_selection_sensitive_actions.push_back(act);
2462
2463         act = ActionManager::register_action (popup_act_grp, X_("delete"), _("Delete"),
2464                         sigc::ptr_fun (ProcessorBox::rb_delete));
2465         ActionManager::plugin_selection_sensitive_actions.push_back(act); // ??
2466
2467         paste_action = ActionManager::register_action (popup_act_grp, X_("paste"), _("Paste"),
2468                         sigc::ptr_fun (ProcessorBox::rb_paste));
2469         rename_action = ActionManager::register_action (popup_act_grp, X_("rename"), _("Rename"),
2470                         sigc::ptr_fun (ProcessorBox::rb_rename));
2471         ActionManager::register_action (popup_act_grp, X_("selectall"), _("Select All"),
2472                         sigc::ptr_fun (ProcessorBox::rb_select_all));
2473         ActionManager::register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2474                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2475
2476         /* activation etc. */
2477
2478         ActionManager::register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2479                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
2480         ActionManager::register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2481                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2482         ActionManager::register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2483                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2484
2485         /* show editors */
2486         edit_action = ActionManager::register_action (
2487                 popup_act_grp, X_("edit"), _("Edit..."),
2488                 sigc::ptr_fun (ProcessorBox::rb_edit));
2489
2490         edit_generic_action = ActionManager::register_action (
2491                 popup_act_grp, X_("edit-generic"), _("Edit with generic controls..."),
2492                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2493
2494         ActionManager::add_action_group (popup_act_grp);
2495 }
2496
2497 void
2498 ProcessorBox::rb_edit_generic ()
2499 {
2500         if (_current_processor_box == 0) {
2501                 return;
2502         }
2503
2504         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
2505 }
2506
2507 void
2508 ProcessorBox::rb_ab_plugins ()
2509 {
2510         if (_current_processor_box == 0) {
2511                 return;
2512         }
2513
2514         _current_processor_box->ab_plugins ();
2515 }
2516
2517 void
2518 ProcessorBox::rb_choose_plugin ()
2519 {
2520         if (_current_processor_box == 0) {
2521                 return;
2522         }
2523         _current_processor_box->choose_plugin ();
2524 }
2525
2526 void
2527 ProcessorBox::rb_choose_insert ()
2528 {
2529         if (_current_processor_box == 0) {
2530                 return;
2531         }
2532         _current_processor_box->choose_insert ();
2533 }
2534
2535 void
2536 ProcessorBox::rb_choose_send ()
2537 {
2538         if (_current_processor_box == 0) {
2539                 return;
2540         }
2541         _current_processor_box->choose_send ();
2542 }
2543
2544 void
2545 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
2546 {
2547         if (_current_processor_box == 0) {
2548                 return;
2549         }
2550
2551         _current_processor_box->choose_aux (wr);
2552 }
2553
2554 void
2555 ProcessorBox::rb_clear ()
2556 {
2557         if (_current_processor_box == 0) {
2558                 return;
2559         }
2560
2561         _current_processor_box->clear_processors ();
2562 }
2563
2564
2565 void
2566 ProcessorBox::rb_clear_pre ()
2567 {
2568         if (_current_processor_box == 0) {
2569                 return;
2570         }
2571
2572         _current_processor_box->clear_processors (PreFader);
2573 }
2574
2575
2576 void
2577 ProcessorBox::rb_clear_post ()
2578 {
2579         if (_current_processor_box == 0) {
2580                 return;
2581         }
2582
2583         _current_processor_box->clear_processors (PostFader);
2584 }
2585
2586 void
2587 ProcessorBox::rb_cut ()
2588 {
2589         if (_current_processor_box == 0) {
2590                 return;
2591         }
2592
2593         _current_processor_box->processor_operation (ProcessorsCut);
2594 }
2595
2596 void
2597 ProcessorBox::rb_delete ()
2598 {
2599         if (_current_processor_box == 0) {
2600                 return;
2601         }
2602
2603         _current_processor_box->processor_operation (ProcessorsDelete);
2604 }
2605
2606 void
2607 ProcessorBox::rb_copy ()
2608 {
2609         if (_current_processor_box == 0) {
2610                 return;
2611         }
2612         _current_processor_box->processor_operation (ProcessorsCopy);
2613 }
2614
2615 void
2616 ProcessorBox::rb_paste ()
2617 {
2618         if (_current_processor_box == 0) {
2619                 return;
2620         }
2621
2622         _current_processor_box->processor_operation (ProcessorsPaste);
2623 }
2624
2625 void
2626 ProcessorBox::rb_rename ()
2627 {
2628         if (_current_processor_box == 0) {
2629                 return;
2630         }
2631         _current_processor_box->rename_processors ();
2632 }
2633
2634 void
2635 ProcessorBox::rb_select_all ()
2636 {
2637         if (_current_processor_box == 0) {
2638                 return;
2639         }
2640
2641         _current_processor_box->processor_operation (ProcessorsSelectAll);
2642 }
2643
2644 void
2645 ProcessorBox::rb_deselect_all ()
2646 {
2647         if (_current_processor_box == 0) {
2648                 return;
2649         }
2650
2651         _current_processor_box->deselect_all_processors ();
2652 }
2653
2654 void
2655 ProcessorBox::rb_activate_all ()
2656 {
2657         if (_current_processor_box == 0) {
2658                 return;
2659         }
2660
2661         _current_processor_box->all_visible_processors_active (true);
2662 }
2663
2664 void
2665 ProcessorBox::rb_deactivate_all ()
2666 {
2667         if (_current_processor_box == 0) {
2668                 return;
2669         }
2670         _current_processor_box->all_visible_processors_active (false);
2671 }
2672
2673 void
2674 ProcessorBox::rb_edit ()
2675 {
2676         if (_current_processor_box == 0) {
2677                 return;
2678         }
2679
2680         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
2681 }
2682
2683 bool
2684 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
2685 {
2686         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2687                 return false;
2688         }
2689
2690         if (_parent_strip) {
2691                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2692                 if (_parent_strip->current_delivery() == send) {
2693                         _parent_strip->revert_to_default_display ();
2694                 } else {
2695                         _parent_strip->show_send(send);
2696                 }
2697         }
2698         return true;
2699 }
2700
2701 void
2702 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
2703 {
2704         if (!processor) {
2705                 return;
2706         }
2707         if (edit_aux_send (processor)) {
2708                 return;
2709         }
2710
2711         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2712
2713         if (proxy) {
2714                 proxy->set_custom_ui_mode (true);
2715                 proxy->toggle ();
2716         }
2717 }
2718
2719 void
2720 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
2721 {
2722         if (!processor) {
2723                 return;
2724         }
2725         if (edit_aux_send (processor)) {
2726                 return;
2727         }
2728
2729         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2730
2731         if (proxy) {
2732                 proxy->set_custom_ui_mode (false);
2733                 proxy->toggle ();
2734         }
2735 }
2736
2737 void
2738 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
2739 {
2740         if (!what_changed.contains (ARDOUR::Properties::name)) {
2741                 return;
2742         }
2743
2744         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
2745
2746         boost::shared_ptr<Processor> processor;
2747         boost::shared_ptr<PluginInsert> plugin_insert;
2748         boost::shared_ptr<Send> send;
2749
2750         list<ProcessorEntry*> children = processor_display.children();
2751
2752         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
2753
2754                 processor = (*iter)->processor ();
2755
2756                 if (!processor) {
2757                         continue;
2758                 }
2759
2760                 Window* w = get_processor_ui (processor);
2761
2762                 if (!w) {
2763                         continue;
2764                 }
2765
2766                 /* rename editor windows for sends and plugins */
2767
2768                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2769                         w->set_title (send->name ());
2770                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2771                         w->set_title (generate_processor_title (plugin_insert));
2772                 }
2773         }
2774 }
2775
2776 string
2777 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
2778 {
2779         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
2780         string::size_type email_pos;
2781
2782         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
2783                 maker = maker.substr (0, email_pos - 1);
2784         }
2785
2786         if (maker.length() > 32) {
2787                 maker = maker.substr (0, 32);
2788                 maker += " ...";
2789         }
2790
2791         SessionObject* owner = pi->owner();
2792
2793         if (owner) {
2794                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
2795         } else {
2796                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
2797         }
2798 }
2799
2800 /** @param p Processor.
2801  *  @return the UI window for \a p.
2802  */
2803 Window *
2804 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
2805 {
2806         ProcessorWindowProxy* wp = p->window_proxy();
2807         if (wp) {
2808                 return wp->get ();
2809         }
2810         return 0;
2811 }
2812
2813 /** Make a note of the UI window that a processor is using.
2814  *  @param p Processor.
2815  *  @param w UI window.
2816  */
2817 void
2818 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
2819 {
2820         assert (p->window_proxy());
2821         p->set_ui (w);
2822         p->window_proxy()->use_window (*w);
2823 }
2824
2825 void
2826 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
2827 {
2828         boost::shared_ptr<Delivery> d = w.lock ();
2829         if (!d) {
2830                 return;
2831         }
2832
2833         list<ProcessorEntry*> children = processor_display.children ();
2834         list<ProcessorEntry*>::const_iterator i = children.begin();
2835         while (i != children.end() && (*i)->processor() != d) {
2836                 ++i;
2837         }
2838
2839         if (i == children.end()) {
2840                 processor_display.set_active (0);
2841         } else {
2842                 processor_display.set_active (*i);
2843         }
2844 }
2845
2846 /** Called to repair the damage of Editor::show_window doing a show_all() */
2847 void
2848 ProcessorBox::hide_things ()
2849 {
2850         list<ProcessorEntry*> c = processor_display.children ();
2851         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
2852                 (*i)->hide_things ();
2853         }
2854 }
2855
2856 void
2857 ProcessorBox::processor_menu_unmapped ()
2858 {
2859         processor_display.remove_placeholder ();
2860 }
2861
2862 XMLNode *
2863 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
2864 {
2865         if (!_parent_strip) {
2866                 return 0;
2867         }
2868
2869         GUIObjectState& st = _parent_strip->gui_object_state ();
2870         
2871         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2872         assert (strip);
2873         return st.get_or_add_node (strip, entry->state_id());
2874 }
2875
2876 void
2877 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
2878 {
2879         XMLNode* proc = entry_gui_object_state (entry);
2880         if (!proc) {
2881                 return;
2882         }
2883
2884         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
2885         proc->remove_nodes_and_delete (X_("Object"));
2886         entry->add_control_state (proc);
2887 }
2888
2889 bool
2890 ProcessorBox::is_editor_mixer_strip() const
2891 {
2892         return _parent_strip && !_parent_strip->mixer_owned();
2893 }
2894
2895 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
2896         : WM::ProxyBase (name, string())
2897         , _processor_box (box)
2898         , _processor (processor)
2899         , is_custom (false)
2900         , want_custom (false)
2901 {
2902         boost::shared_ptr<Processor> p = _processor.lock ();
2903         if (!p) {
2904                 return;
2905         }
2906         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
2907 }
2908
2909 ProcessorWindowProxy::~ProcessorWindowProxy()
2910 {
2911         /* processor window proxies do not own the windows they create with
2912          * ::get(), so set _window to null before the normal WindowProxy method
2913          * deletes it.
2914          */
2915         _window = 0;
2916 }
2917
2918 void
2919 ProcessorWindowProxy::processor_going_away ()
2920 {
2921         delete _window;
2922         _window = 0;
2923         WM::Manager::instance().remove (this);
2924         /* should be no real reason to do this, since the object that would
2925            send DropReferences is about to be deleted, but lets do it anyway.
2926         */
2927         going_away_connection.disconnect();
2928 }
2929
2930 ARDOUR::SessionHandlePtr*
2931 ProcessorWindowProxy::session_handle() 
2932 {
2933         /* we don't care */
2934         return 0;
2935 }
2936
2937 XMLNode&
2938 ProcessorWindowProxy::get_state () const
2939 {
2940         XMLNode *node;
2941         node = &ProxyBase::get_state();
2942         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
2943         return *node;
2944 }
2945
2946 void
2947 ProcessorWindowProxy::set_state (const XMLNode& node)
2948 {
2949         XMLNodeList children = node.children ();
2950         XMLNodeList::const_iterator i = children.begin ();
2951         while (i != children.end()) {
2952                 XMLProperty* prop = (*i)->property (X_("name"));
2953                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
2954                         break;
2955                 }
2956                 ++i;
2957         }
2958
2959         if (i != children.end()) {
2960                 XMLProperty* prop;
2961                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
2962                         want_custom = PBD::string_is_affirmative (prop->value ());
2963                 }
2964         }
2965
2966         ProxyBase::set_state(node);
2967 }
2968
2969 Gtk::Window*
2970 ProcessorWindowProxy::get (bool create)
2971 {
2972         boost::shared_ptr<Processor> p = _processor.lock ();
2973
2974         if (!p) {
2975                 return 0;
2976         }
2977         if (_window && (is_custom != want_custom)) {
2978                 /* drop existing window - wrong type */
2979                 drop_window ();
2980         }
2981
2982         if (!_window) {
2983                 if (!create) {
2984                         return 0;
2985                 }
2986                 
2987                 is_custom = want_custom;
2988                 _window = _processor_box->get_editor_window (p, is_custom);
2989
2990                 if (_window) {
2991                         setup ();
2992                 }
2993         }
2994
2995         return _window;
2996 }
2997
2998 void
2999 ProcessorWindowProxy::toggle ()
3000 {
3001         if (_window && (is_custom != want_custom)) {
3002                 /* drop existing window - wrong type */
3003                 drop_window ();
3004         }
3005         is_custom = want_custom;
3006
3007         WM::ProxyBase::toggle ();
3008 }