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