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