60aee0ff62c125c985026559350b222e7b3c3072
[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 #include "canvas/utils.h"
32
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
35
36 #include <gtkmm/messagedialog.h>
37
38 #include <gtkmm2ext/gtk_ui.h>
39 #include <gtkmm2ext/utils.h>
40 #include <gtkmm2ext/choice.h>
41 #include <gtkmm2ext/utils.h>
42 #include <gtkmm2ext/doi.h>
43 #include <gtkmm2ext/rgb_macros.h>
44
45 #include "ardour/amp.h"
46 #include "ardour/audio_track.h"
47 #include "ardour/audioengine.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/internal_send.h"
50 #include "ardour/luaproc.h"
51 #include "ardour/luascripting.h"
52 #include "ardour/meter.h"
53 #include "ardour/panner_shell.h"
54 #include "ardour/plugin_insert.h"
55 #include "ardour/pannable.h"
56 #include "ardour/port_insert.h"
57 #include "ardour/profile.h"
58 #include "ardour/return.h"
59 #include "ardour/route.h"
60 #include "ardour/send.h"
61 #include "ardour/session.h"
62 #include "ardour/types.h"
63
64 #include "LuaBridge/LuaBridge.h"
65
66 #include "actions.h"
67 #include "ardour_dialog.h"
68 #include "ardour_ui.h"
69 #include "gui_thread.h"
70 #include "io_selector.h"
71 #include "keyboard.h"
72 #include "luainstance.h"
73 #include "mixer_ui.h"
74 #include "mixer_strip.h"
75 #include "plugin_pin_dialog.h"
76 #include "plugin_selector.h"
77 #include "plugin_ui.h"
78 #include "port_insert_ui.h"
79 #include "processor_box.h"
80 #include "public_editor.h"
81 #include "return_ui.h"
82 #include "route_processor_selection.h"
83 #include "script_selector.h"
84 #include "send_ui.h"
85 #include "timers.h"
86 #include "tooltips.h"
87 #include "new_plugin_preset_dialog.h"
88
89 #include "i18n.h"
90
91 #ifdef AUDIOUNIT_SUPPORT
92 class AUPluginUI;
93 #endif
94
95 #ifndef NDEBUG
96 bool ProcessorBox::show_all_processors = false;
97 #endif
98
99 using namespace std;
100 using namespace ARDOUR;
101 using namespace PBD;
102 using namespace Gtk;
103 using namespace Glib;
104 using namespace Gtkmm2ext;
105
106 ProcessorBox*  ProcessorBox::_current_processor_box = 0;
107 RefPtr<Action> ProcessorBox::paste_action;
108 RefPtr<Action> ProcessorBox::cut_action;
109 RefPtr<Action> ProcessorBox::copy_action;
110 RefPtr<Action> ProcessorBox::rename_action;
111 RefPtr<Action> ProcessorBox::delete_action;
112 RefPtr<Action> ProcessorBox::manage_pins_action;
113 RefPtr<Action> ProcessorBox::edit_action;
114 RefPtr<Action> ProcessorBox::edit_generic_action;
115 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
116 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
117 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
118
119
120 // TODO consolidate with PluginPinDialog::set_color
121 static void set_routing_color (cairo_t* cr, bool midi)
122 {
123         static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
124         static const uint32_t midi_port_color = 0x960909FF; //Red
125
126         if (midi) {
127                 cairo_set_source_rgb (cr,
128                                 UINT_RGBA_R_FLT(midi_port_color),
129                                 UINT_RGBA_G_FLT(midi_port_color),
130                                 UINT_RGBA_B_FLT(midi_port_color));
131         } else {
132                 cairo_set_source_rgb (cr,
133                                 UINT_RGBA_R_FLT(audio_port_color),
134                                 UINT_RGBA_G_FLT(audio_port_color),
135                                 UINT_RGBA_B_FLT(audio_port_color));
136         }
137 }
138
139 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
140         : _button (ArdourButton::led_default_elements)
141         , _position (PreFader)
142         , _position_num(0)
143         , _parent (parent)
144         , _selectable(true)
145         , _unknown_processor(false)
146         , _processor (p)
147         , _width (w)
148         , input_icon(true)
149         , output_icon(false)
150         , routing_icon(true)
151         , output_routing_icon(false)
152         , _plugin_display(0)
153 {
154         _vbox.show ();
155
156         _button.set_distinct_led_click (true);
157         _button.set_fallthrough_to_parent(true);
158         _button.set_led_left (true);
159         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
160         _button.set_text (name (_width));
161
162         if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
163                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
164         }
165         if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
166                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
167                 _unknown_processor = true;
168         }
169         {
170                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
171                 if (pi && pi->plugin() && pi->plugin()->get_info()->type != ARDOUR::Lua) {
172                         _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
173                 }
174         }
175         if (_processor) {
176
177                 _vbox.pack_start (routing_icon);
178                 _vbox.pack_start (input_icon);
179                 _vbox.pack_start (_button, true, true);
180
181                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
182                 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
183                         if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
184                                 _plugin_display = new PluginDisplay (pi->plugin(),
185                                                 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
186                         } else {
187                                 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
188                                 _plugin_display = new LuaPluginDisplay (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
189                                                 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
190                         }
191                         _vbox.pack_start (*_plugin_display);
192                         _plugin_display->set_no_show_all (true);
193                         if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
194                                 _plugin_display->show ();
195                         }
196                 }
197                 _vbox.pack_end (output_routing_icon);
198                 _vbox.pack_end (output_icon);
199
200                 _button.set_active (_processor->active());
201
202                 input_icon.set_no_show_all(true);
203                 routing_icon.set_no_show_all(true);
204                 output_icon.set_no_show_all(true);
205                 output_routing_icon.set_no_show_all(true);
206
207                 _button.show ();
208                 input_icon.hide();
209                 output_icon.show();
210                 routing_icon.hide();
211                 output_routing_icon.hide();
212
213                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
214                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
215                 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
216
217                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
218                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
219
220                         std::string label = _processor->describe_parameter (*i);
221
222                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
223                                 label = _("Send");
224                         } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
225                                 label = _("Return");
226                         }
227
228                         Control* c = new Control (_processor->automation_control (*i), label);
229
230                         _controls.push_back (c);
231
232                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
233                                 /* Add non-Amp (Fader & Trim) controls to the processor box */
234                                 _vbox.pack_start (c->box);
235                         }
236                 }
237
238                 setup_tooltip ();
239                 setup_visuals ();
240         } else {
241                 _vbox.set_size_request (-1, _button.size_request().height);
242         }
243 }
244
245 ProcessorEntry::~ProcessorEntry ()
246 {
247         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
248                 delete *i;
249         }
250         delete _plugin_display;
251 }
252
253 EventBox&
254 ProcessorEntry::action_widget ()
255 {
256         return _button;
257 }
258
259 Gtk::Widget&
260 ProcessorEntry::widget ()
261 {
262         return _vbox;
263 }
264
265 string
266 ProcessorEntry::drag_text () const
267 {
268         return name (Wide);
269 }
270
271 bool
272 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
273 {
274         ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
275         if (!other) {
276                 return false;
277         }
278         boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
279         boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
280         boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
281         if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
282                 return false;
283         }
284         if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
285                 return false;
286         }
287         if (!my_pi || !ot_pi) {
288                 return false;
289         }
290         if (my_pi->type() != ot_pi->type()) {
291                 return false;
292         }
293         boost::shared_ptr<Plugin> my_p = my_pi->plugin();
294         boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
295         if (!my_p || !ot_p) {
296                 return false;
297         }
298         if (my_p->unique_id() != ot_p->unique_id()) {
299                 return false;
300         }
301         return true;
302 }
303
304 bool
305 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
306 {
307         if (data.get_target() == "PluginPresetPtr") {
308                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
309
310                 if (!_plugin_preset_pointer || !pi) {
311                         data.set (data.get_target(), 8, NULL, 0);
312                         return true;
313                 }
314
315                 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
316                 assert (plugin);
317
318                 PluginManager& manager (PluginManager::instance());
319                 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
320
321                 NewPluginPresetDialog d (plugin,
322                                 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
323
324                 _plugin_preset_pointer->_preset.valid = false;
325
326                 switch (d.run ()) {
327                         case Gtk::RESPONSE_CANCEL:
328                                 data.set (data.get_target(), 8, NULL, 0);
329                                 return true;
330                                 break;
331
332                         case Gtk::RESPONSE_NO:
333                                 break;
334
335                         case Gtk::RESPONSE_ACCEPT:
336                                 if (d.name().empty()) {
337                                         break;
338                                 }
339
340                                 if (d.replace ()) {
341                                         plugin->remove_preset (d.name ());
342                                 }
343
344                                 Plugin::PresetRecord const r = plugin->save_preset (d.name());
345
346                                 if (!r.uri.empty ()) {
347                                         _plugin_preset_pointer->_preset.uri   = r.uri;
348                                         _plugin_preset_pointer->_preset.label = r.label;
349                                         _plugin_preset_pointer->_preset.user  = r.user;
350                                         _plugin_preset_pointer->_preset.valid = r.valid;
351                                 }
352                 }
353                 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
354                 return true;
355         }
356         return false;
357 }
358
359 void
360 ProcessorEntry::set_position (Position p, uint32_t num)
361 {
362         _position = p;
363         _position_num = num;
364         setup_visuals ();
365 }
366
367 void
368 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
369 {
370         if (yn) {
371                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
372         } else {
373                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
374         }
375 }
376
377 void
378 ProcessorEntry::setup_visuals ()
379 {
380         if (_unknown_processor) {
381                 _button.set_name ("processor stub");
382                 return;
383         }
384         boost::shared_ptr<Send> send;
385         if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
386                 if (send->remove_on_disconnect ()) {
387                         _button.set_name ("processor sidechain");
388                         return;
389                 }
390         }
391
392         switch (_position) {
393         case PreFader:
394                 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
395                 _button.set_name ("processor prefader");
396                 break;
397
398         case Fader:
399                 _button.set_name ("processor fader");
400                 break;
401
402         case PostFader:
403                 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
404                 _button.set_name ("processor postfader");
405                 break;
406         }
407 }
408
409
410 boost::shared_ptr<Processor>
411 ProcessorEntry::processor () const
412 {
413         if (!_processor) {
414                 return boost::shared_ptr<Processor>();
415         }
416         return _processor;
417 }
418
419 void
420 ProcessorEntry::set_enum_width (Width w)
421 {
422         _width = w;
423         _button.set_text (name (_width));
424 }
425
426 void
427 ProcessorEntry::led_clicked(GdkEventButton *ev)
428 {
429         bool ctrl_shift_pressed = false;
430         Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
431
432         if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
433                 ctrl_shift_pressed = true;
434         }
435
436         if (_processor) {
437                 if (_button.get_active ()) {
438                         if (ctrl_shift_pressed) {
439                                 _parent->all_visible_processors_active(false);
440
441                                 if (_position == Fader) {
442                                         _processor->deactivate ();
443                                 }
444                         }
445                         else {
446                                 _processor->deactivate ();
447                         }
448
449                 } else {
450                         if (ctrl_shift_pressed) {
451                                 _parent->all_visible_processors_active(true);
452
453                                 if (_position == Fader) {
454                                         _processor->activate ();
455                                 }
456                         }
457                         else {
458                                 _processor->activate ();
459                         }
460                 }
461         }
462 }
463
464 void
465 ProcessorEntry::processor_active_changed ()
466 {
467         if (_processor) {
468                 _button.set_active (_processor->active());
469         }
470 }
471
472 void
473 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
474 {
475         if (what_changed.contains (ARDOUR::Properties::name)) {
476                 _button.set_text (name (_width));
477                 setup_tooltip ();
478         }
479 }
480
481 void
482 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
483 {
484         _parent->setup_routing_feeds ();
485         input_icon.queue_draw();
486         output_icon.queue_draw();
487         routing_icon.queue_draw();
488         output_routing_icon.queue_draw();
489 }
490
491 void
492 ProcessorEntry::setup_tooltip ()
493 {
494         if (_processor) {
495                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
496                 if (pi) {
497                         std::string postfix = "";
498                         uint32_t replicated;
499                         if ((replicated = pi->get_count()) > 1) {
500                                 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
501                         }
502                         if (pi->plugin()->has_editor()) {
503                                 ARDOUR_UI_UTILS::set_tooltip (_button,
504                                                 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));
505                         } else {
506                                 ARDOUR_UI_UTILS::set_tooltip (_button,
507                                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
508                         }
509                         return;
510                 }
511                 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
512                         ARDOUR_UI::instance()->set_tip (_button,
513                                         string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
514                         return;
515                 }
516                 boost::shared_ptr<Send> send;
517                 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
518                                 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
519                         if (send->remove_on_disconnect ()) {
520                                 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>&gt; %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
521                         } else {
522                                 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>&gt; %1</b>", _processor->name()));
523                         }
524                         return;
525                 }
526         }
527         ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
528 }
529
530 string
531 ProcessorEntry::name (Width w) const
532 {
533         boost::shared_ptr<Send> send;
534         string name_display;
535
536         if (!_processor) {
537                 return string();
538         }
539
540         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
541             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
542
543                 name_display += '>';
544                 std::string send_name;
545                 bool pretty_ok = true;
546
547                 if (send->remove_on_disconnect ()) {
548                         // assume it's a sidechain, find pretty name of connected port(s)
549                         PortSet& ps (send->output ()->ports ());
550                         for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
551                                 vector<string> connections;
552                                 if (i->get_connections (connections)) {
553                                         vector<string>::const_iterator ci;
554                                         for (ci = connections.begin(); ci != connections.end(); ++ci) {
555                                                 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
556                                                 if (pn.empty ()) {
557                                                         continue;
558                                                 }
559                                                 if (send_name.empty ()) {
560                                                         send_name = pn;
561                                                 } else if (send_name != pn) {
562                                                         // pretty names don't match
563                                                         pretty_ok = false;
564                                                         break;
565                                                 }
566                                         }
567                                 }
568                         }
569                 }
570
571                 if (!pretty_ok) {
572                         send_name = "";
573                 }
574
575                 /* grab the send name out of its overall name */
576                 if (send_name.empty()) {
577                         send_name = send->name();
578                         string::size_type lbracket, rbracket;
579                         lbracket = send_name.find ('[');
580                         rbracket = send_name.find (']');
581                         send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
582                 }
583
584                 switch (w) {
585                 case Wide:
586                         name_display += send_name;
587                         break;
588                 case Narrow:
589                         name_display += PBD::short_version (send_name, 5);
590                         break;
591                 }
592
593         } else {
594                 boost::shared_ptr<ARDOUR::PluginInsert> pi;
595                 uint32_t replicated;
596                 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
597                                 && (replicated = pi->get_count()) > 1)
598                 {
599                         name_display += string_compose(_("(%1x1) "), replicated);
600                 }
601
602                 switch (w) {
603                 case Wide:
604                         name_display += _processor->display_name();
605                         break;
606                 case Narrow:
607                         name_display += PBD::short_version (_processor->display_name(), 5);
608                         break;
609                 }
610
611         }
612
613         return name_display;
614 }
615
616 void
617 ProcessorEntry::show_all_controls ()
618 {
619         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
620                 (*i)->set_visible (true);
621         }
622
623         _parent->update_gui_object_state (this);
624 }
625
626 void
627 ProcessorEntry::hide_all_controls ()
628 {
629         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
630                 (*i)->set_visible (false);
631         }
632
633         _parent->update_gui_object_state (this);
634 }
635
636 void
637 ProcessorEntry::add_control_state (XMLNode* node) const
638 {
639         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
640                 (*i)->add_state (node);
641         }
642
643         if (_plugin_display) {
644                 XMLNode* c = new XMLNode (X_("Object"));
645                 c->add_property (X_("id"), X_("InlineDisplay"));
646                 c->add_property (X_("visible"), _plugin_display->is_visible ());
647                 node->add_child_nocopy (*c);
648         }
649 }
650
651 void
652 ProcessorEntry::set_control_state (XMLNode const * node)
653 {
654         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
655                 (*i)->set_state (node);
656         }
657
658         if (_plugin_display) {
659                 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
660                 XMLProperty* p = n ? n->property (X_("visible")) : NULL;
661                 if (p) {
662                         if (string_is_affirmative (p->value ())) {
663                                 _plugin_display->show();
664                         } else {
665                                 _plugin_display->hide();
666                         }
667                 }
668         }
669 }
670
671 string
672 ProcessorEntry::state_id () const
673 {
674         return string_compose ("processor %1", _processor->id().to_s());
675 }
676
677 void
678 ProcessorEntry::hide_things ()
679 {
680         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
681                 (*i)->hide_things ();
682         }
683 }
684
685
686 Menu *
687 ProcessorEntry::build_controls_menu ()
688 {
689         using namespace Menu_Helpers;
690         Menu* menu = manage (new Menu);
691         MenuList& items = menu->items ();
692
693         if (_plugin_display) {
694                 items.push_back (CheckMenuElem (_("Inline Display")));
695                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
696                 c->set_active (_plugin_display->is_visible ());
697                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
698                 items.push_back (SeparatorElem ());
699         }
700
701         items.push_back (
702                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
703                 );
704
705         items.push_back (
706                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
707                 );
708
709         if (!_controls.empty ()) {
710                 items.push_back (SeparatorElem ());
711         }
712
713         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
714                 items.push_back (CheckMenuElem ((*i)->name ()));
715                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
716                 c->set_active ((*i)->visible ());
717                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
718         }
719
720         return menu;
721 }
722
723 void
724 ProcessorEntry::toggle_inline_display_visibility ()
725 {
726         if (_plugin_display->is_visible ()) {
727                 _plugin_display->hide();
728         } else {
729                 _plugin_display->show();
730         }
731         _parent->update_gui_object_state (this);
732 }
733
734 void
735 ProcessorEntry::toggle_control_visibility (Control* c)
736 {
737         c->set_visible (!c->visible ());
738         _parent->update_gui_object_state (this);
739 }
740
741 Menu *
742 ProcessorEntry::build_send_options_menu ()
743 {
744         using namespace Menu_Helpers;
745         Menu* menu = manage (new Menu);
746         MenuList& items = menu->items ();
747
748         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
749         if (send) {
750
751                 items.push_back (CheckMenuElem (_("Link panner controls")));
752                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
753                 c->set_active (send->panner_shell()->is_linked_to_route());
754                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
755
756         }
757         return menu;
758 }
759
760 void
761 ProcessorEntry::toggle_panner_link ()
762 {
763         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
764         if (send) {
765                 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
766         }
767 }
768
769 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
770         : _control (c)
771         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
772         , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
773         , _slider_persistant_tooltip (&_slider)
774         , _button (ArdourButton::led_default_elements)
775         , _ignore_ui_adjustment (false)
776         , _visible (false)
777         , _name (n)
778 {
779         _slider.set_controllable (c);
780         box.set_padding(0, 0, 4, 4);
781
782         if (c->toggled()) {
783                 _button.set_text (_name);
784                 _button.set_led_left (true);
785                 _button.set_name ("processor control button");
786                 box.add (_button);
787                 _button.show ();
788
789                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
790                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
791                 // dup. currently timers are used :(
792                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
793
794         } else {
795
796                 _slider.set_name ("ProcessorControlSlider");
797                 _slider.set_text (_name);
798
799                 box.add (_slider);
800                 _slider.show ();
801
802                 const ARDOUR::ParameterDescriptor& desc = c->desc();
803                 double const lo = c->internal_to_interface(desc.lower);
804                 double const up = c->internal_to_interface(desc.upper);
805                 double const normal = c->internal_to_interface(desc.normal);
806                 double smallstep = desc.smallstep;
807                 double largestep = desc.largestep;
808
809                 if (smallstep == 0.0) {
810                         smallstep = up / 1000.;
811                 } else {
812                         smallstep = c->internal_to_interface(desc.lower + smallstep);
813                 }
814
815                 if (largestep == 0.0) {
816                         largestep = up / 40.;
817                 } else {
818                         largestep = c->internal_to_interface(desc.lower + largestep);
819                 }
820
821                 _adjustment.set_lower (lo);
822                 _adjustment.set_upper (up);
823                 _adjustment.set_step_increment (smallstep);
824                 _adjustment.set_page_increment (largestep);
825                 _slider.set_default_value (normal);
826
827                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
828                 // dup. currently timers are used :(
829                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
830         }
831
832         // yuck, do we really need to do this?
833         // according to c404374 this is only needed for send automation
834         timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
835
836         control_changed ();
837         set_tooltip ();
838
839         /* We're providing our own PersistentTooltip */
840         set_no_tooltip_whatsoever (_slider);
841 }
842
843 ProcessorEntry::Control::~Control ()
844 {
845         timer_connection.disconnect ();
846 }
847
848 void
849 ProcessorEntry::Control::set_tooltip ()
850 {
851         boost::shared_ptr<AutomationControl> c = _control.lock ();
852
853         if (!c) {
854                 return;
855         }
856         char tmp[256];
857         if (c->toggled ()) {
858                 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
859         } else {
860                 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
861         }
862
863         string sm = Gtkmm2ext::markup_escape_text (tmp);
864         _slider_persistant_tooltip.set_tip (sm);
865         ARDOUR_UI_UTILS::set_tooltip (_button, sm);
866 }
867
868 void
869 ProcessorEntry::Control::slider_adjusted ()
870 {
871         if (_ignore_ui_adjustment) {
872                 return;
873         }
874
875         boost::shared_ptr<AutomationControl> c = _control.lock ();
876
877         if (!c) {
878                 return;
879         }
880
881         c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
882         set_tooltip ();
883 }
884
885 void
886 ProcessorEntry::Control::button_clicked ()
887 {
888         boost::shared_ptr<AutomationControl> c = _control.lock ();
889
890         if (!c) {
891                 return;
892         }
893
894         bool const n = _button.get_active ();
895
896         c->set_value (n ? 0 : 1, Controllable::NoGroup);
897         _button.set_active (!n);
898         set_tooltip ();
899 }
900
901 void
902 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
903 {
904         (void) ev;
905
906         button_clicked ();
907 }
908
909 void
910 ProcessorEntry::Control::control_changed ()
911 {
912         boost::shared_ptr<AutomationControl> c = _control.lock ();
913         if (!c) {
914                 return;
915         }
916
917         _ignore_ui_adjustment = true;
918
919         if (c->toggled ()) {
920
921                 _button.set_active (c->get_value() > 0.5);
922
923         } else {
924                 // as long as rapid timers are used, only update the tooltip
925                 // if the value has changed.
926                 const double nval = c->internal_to_interface (c->get_value ());
927                 if (_adjustment.get_value() != nval) {
928                         _adjustment.set_value (nval);
929                         set_tooltip ();
930                 }
931         }
932
933         _ignore_ui_adjustment = false;
934 }
935
936 void
937 ProcessorEntry::Control::add_state (XMLNode* node) const
938 {
939         XMLNode* c = new XMLNode (X_("Object"));
940         c->add_property (X_("id"), state_id ());
941         c->add_property (X_("visible"), _visible);
942         node->add_child_nocopy (*c);
943 }
944
945 void
946 ProcessorEntry::Control::set_state (XMLNode const * node)
947 {
948         XMLNode* n = GUIObjectState::get_node (node, state_id ());
949         if (n) {
950                 XMLProperty* p = n->property (X_("visible"));
951                 set_visible (p && string_is_affirmative (p->value ()));
952         } else {
953                 set_visible (false);
954         }
955 }
956
957 void
958 ProcessorEntry::Control::set_visible (bool v)
959 {
960         if (v) {
961                 box.show ();
962         } else {
963                 box.hide ();
964         }
965
966         _visible = v;
967 }
968
969 /** Called when the Editor might have re-shown things that
970     we want hidden.
971 */
972 void
973 ProcessorEntry::Control::hide_things ()
974 {
975         if (!_visible) {
976                 box.hide ();
977         }
978 }
979
980 string
981 ProcessorEntry::Control::state_id () const
982 {
983         boost::shared_ptr<AutomationControl> c = _control.lock ();
984         assert (c);
985
986         return string_compose (X_("control %1"), c->id().to_s ());
987 }
988
989 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
990         : ProcessorEntry (b, p, w)
991         , _plugin_insert (p)
992 {
993         p->PluginIoReConfigure.connect (
994                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
995                 );
996         p->PluginMapChanged.connect (
997                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
998                 );
999         p->PluginConfigChanged.connect (
1000                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1001                 );
1002 }
1003
1004 void
1005 PluginInsertProcessorEntry::iomap_changed ()
1006 {
1007         _parent->setup_routing_feeds ();
1008         routing_icon.queue_draw();
1009         output_routing_icon.queue_draw();
1010 }
1011
1012 void
1013 PluginInsertProcessorEntry::hide_things ()
1014 {
1015         ProcessorEntry::hide_things ();
1016 }
1017
1018 ProcessorEntry::PortIcon::PortIcon(bool input) {
1019         _input = input;
1020         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1021         set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1022 }
1023
1024 bool
1025 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1026 {
1027         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1028
1029         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1030         cairo_clip (cr);
1031
1032         Gtk::Allocation a = get_allocation();
1033         double const width = a.get_width();
1034         double const height = a.get_height();
1035
1036         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1037         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1038
1039         cairo_rectangle (cr, 0, 0, width, height);
1040         cairo_fill (cr);
1041
1042         const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1043         for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1044                 set_routing_color (cr, i < _ports.n_midi());
1045                 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1046                 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1047                 cairo_fill(cr);
1048         }
1049
1050         cairo_destroy(cr);
1051         return true;
1052 }
1053
1054 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1055         : _fed_by (false)
1056         , _input (input)
1057 {
1058         set_terminal (false);
1059 }
1060
1061 void
1062 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1063         _terminal = b;
1064         int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1065         if (_terminal) {
1066                 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1067         }
1068         set_size_request (-1, h);
1069 }
1070
1071 void
1072 ProcessorEntry::RoutingIcon::set (
1073                 const ARDOUR::ChanCount& in,
1074                 const ARDOUR::ChanCount& out,
1075                 const ARDOUR::ChanCount& sinks,
1076                 const ARDOUR::ChanCount& sources,
1077                 const ARDOUR::ChanMapping& in_map,
1078                 const ARDOUR::ChanMapping& out_map,
1079                 const ARDOUR::ChanMapping& thru_map)
1080 {
1081         _in       = in;
1082         _out      = out;
1083         _sources  = sources;
1084         _sinks    = sinks;
1085         _in_map   = in_map;
1086         _out_map  = out_map;
1087         _thru_map = thru_map;
1088 }
1089
1090 bool
1091 ProcessorEntry::RoutingIcon::in_identity () const {
1092         if (_thru_map.n_total () > 0) {
1093                 return false;
1094         }
1095         if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1096                 return false;
1097         }
1098         if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1099                 return false;
1100         }
1101         return true;
1102 }
1103
1104 bool
1105 ProcessorEntry::RoutingIcon::out_identity () const {
1106         if (_thru_map.n_total () > 0) {
1107                 // TODO skip if trhu is not connected to any of next's inputs
1108                 return false;
1109         }
1110         if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1111                 return false;
1112         }
1113         if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1114                 return false;
1115         }
1116         return true;
1117 }
1118
1119 bool
1120 ProcessorEntry::RoutingIcon::can_coalesce () const {
1121         if (_thru_map.n_total () > 0) {
1122                 return false;
1123         }
1124         if (_fed_by && _f_out != _f_sources) {
1125                 return false;
1126         }
1127         if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1128                 return true;
1129         }
1130         return false;
1131 }
1132
1133 void
1134 ProcessorEntry::RoutingIcon::set_fed_by (
1135                                 const ARDOUR::ChanCount& out,
1136                                 const ARDOUR::ChanCount& sources,
1137                                 const ARDOUR::ChanMapping& out_map,
1138                                 const ARDOUR::ChanMapping& thru_map)
1139 {
1140         _f_out      = out;
1141         _f_sources  = sources;
1142         _f_out_map  = out_map;
1143         _f_thru_map = thru_map;
1144         _fed_by     = true;
1145 }
1146
1147 void
1148 ProcessorEntry::RoutingIcon::set_feeding (
1149                                 const ARDOUR::ChanCount& in,
1150                                 const ARDOUR::ChanCount& sinks,
1151                                 const ARDOUR::ChanMapping& in_map,
1152                                 const ARDOUR::ChanMapping& thru_map)
1153 {
1154         _i_in       = in;
1155         _i_sinks    = sinks;
1156         _i_in_map   = in_map;
1157         _i_thru_map = thru_map;
1158         _feeding    = true;
1159 }
1160
1161 double
1162 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1163 {
1164         if (!midi) { i += n_midi; }
1165         if (n_total == 1) {
1166                 assert (i == 0);
1167                 return rint (width * .5) +.5;
1168         }
1169         return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1170 }
1171
1172 void
1173 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1174 {
1175         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1176         const double y1 = rint (height * .66) + .5;
1177
1178         cairo_save (cr);
1179         cairo_translate (cr, x0, y0);
1180         cairo_move_to (cr, 0, height);
1181         cairo_line_to (cr, 0, y1);
1182         cairo_move_to (cr, 0 - dx, y1);
1183         cairo_line_to (cr, 0 + dx, y1);
1184
1185         set_routing_color (cr, midi);
1186         cairo_set_line_width (cr, 1.0);
1187         cairo_stroke (cr);
1188         cairo_restore (cr);
1189 }
1190
1191 void
1192 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1193 {
1194         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1195         const double y1 = rint (height * .5) - .5;
1196
1197         cairo_save (cr);
1198         cairo_translate (cr, x0, y0);
1199         cairo_move_to (cr, 0 - dx, height);
1200         cairo_line_to (cr, 0, y1);
1201         cairo_line_to (cr, 0 + dx, height);
1202         cairo_close_path (cr);
1203
1204         set_routing_color (cr, midi);
1205         cairo_fill (cr);
1206         cairo_restore (cr);
1207 }
1208
1209 void
1210 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1211 {
1212         const double rad = 1;
1213         const double y1 = height - rad - 1.5;
1214
1215         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1216         cairo_move_to (cr, x0, y0 + height - 1.5);
1217         cairo_line_to (cr, x0, y0 + height);
1218         set_routing_color (cr, midi);
1219         cairo_set_line_width  (cr, 1.0);
1220         cairo_stroke (cr);
1221 }
1222
1223 void
1224 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1225 {
1226         const double rad = 1;
1227         const double y1 = rad + 1;
1228
1229         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1230         cairo_move_to (cr, x0, y0);
1231         cairo_line_to (cr, x0, y0 + 1);
1232         set_routing_color (cr, midi);
1233         cairo_set_line_width  (cr, 1.0);
1234         cairo_stroke (cr);
1235 }
1236
1237 void
1238 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1239 {
1240         double bz = abs (y1 - y0);
1241
1242         cairo_move_to (cr, x0, y0);
1243         cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1244         cairo_set_line_width  (cr, 1.0);
1245         cairo_set_line_cap  (cr,  CAIRO_LINE_CAP_ROUND);
1246         cairo_set_source_rgb (cr, 1, 0, 0);
1247         if (dashed) {
1248                 const double dashes[] = { 2, 3 };
1249                 cairo_set_dash (cr, dashes, 2, 0);
1250         }
1251         set_routing_color (cr, midi);
1252         cairo_stroke (cr);
1253         if (dashed) {
1254                 cairo_set_dash (cr, 0, 0, 0);
1255         }
1256 }
1257
1258 bool
1259 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1260 {
1261         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1262
1263         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1264         cairo_clip (cr);
1265
1266         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1267
1268         Gtk::Allocation a = get_allocation();
1269         double const width = a.get_width();
1270         double const height = a.get_height();
1271
1272         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1273         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1274
1275         cairo_rectangle (cr, 0, 0, width, height);
1276         cairo_fill (cr);
1277
1278         if (_input) {
1279                 if (can_coalesce ()) {
1280                         expose_coalesced_input_map (cr, width, height);
1281                 } else {
1282                         expose_input_map (cr, width, height);
1283                 }
1284         } else {
1285                 expose_output_map (cr, width, height);
1286         }
1287
1288         cairo_destroy(cr);
1289         return true;
1290 }
1291
1292 void
1293 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1294 {
1295         const uint32_t pc_in = _sinks.n_total();
1296         const uint32_t pc_in_midi = _sinks.n_midi();
1297
1298         for (uint32_t i = 0; i < pc_in; ++i) {
1299                 const bool is_midi = i < pc_in_midi;
1300                 bool valid_in;
1301                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1302                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1303                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1304                 if (!valid_in) {
1305                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1306                         draw_gnd (cr, x, 0, height, is_midi);
1307                         continue;
1308                 }
1309                 if (idx >= _in.get (dt)) {
1310                         // side-chain, probably
1311                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1312                         draw_sidechain (cr, x, 0, height, is_midi);
1313                         continue;
1314                 }
1315                 double c_x0;
1316                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1317
1318                 if (_fed_by) {
1319                         bool valid_src;
1320                         uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1321                         if (!valid_src) {
1322                                 double x = pin_x_pos (i, width, pc_in, 0, false);
1323                                 bool valid_thru;
1324                                 _f_thru_map.get (dt, idx, &valid_thru);
1325                                 if (valid_thru) {
1326                                         draw_thru_src (cr, x, 0, height, is_midi);
1327                                 } else {
1328                                         draw_gnd (cr, x, 0, height, is_midi);
1329                                 }
1330                                 continue;
1331                         }
1332                         c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1333                 } else {
1334                         c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1335                 }
1336                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1337         }
1338 }
1339
1340 void
1341 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1342 {
1343         const uint32_t n_in = _in.n_total();
1344         const uint32_t n_in_midi = _in.n_midi();
1345         const uint32_t pc_in = _sinks.n_total();
1346         const uint32_t pc_in_midi = _sinks.n_midi();
1347
1348         // draw inputs to this
1349         for (uint32_t i = 0; i < pc_in; ++i) {
1350                 const bool is_midi = i < pc_in_midi;
1351                 bool valid_in;
1352                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1353                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1354                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1355                 // check if it's fed
1356                 bool valid_src = true;
1357                 if (valid_in && idx < _in.get (dt) && _fed_by) {
1358                         bool valid_out;
1359                         bool valid_thru;
1360                         _f_out_map.get_src (dt, idx, &valid_out);
1361                         _f_thru_map.get (dt, idx, &valid_thru);
1362                         if (!valid_out && !valid_thru) {
1363                                 valid_src = false;
1364                         }
1365                 }
1366                 if (!valid_in || !valid_src) {
1367                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1368                         draw_gnd (cr, x, 0, height, is_midi);
1369                         continue;
1370                 }
1371                 if (idx >= _in.get (dt)) {
1372                         // side-chain, probably
1373                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1374                         draw_sidechain (cr, x, 0, height, is_midi);
1375                         continue;
1376                 }
1377                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1378                 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1379                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1380         }
1381
1382         // draw reverse thru
1383         for (uint32_t i = 0; i < n_in; ++i) {
1384                 const bool is_midi = i < n_in_midi;
1385                 bool valid_thru;
1386                 uint32_t pn = is_midi ? i : i - n_in_midi;
1387                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1388                 _thru_map.get_src (dt, pn, &valid_thru);
1389                 if (!valid_thru) {
1390                         continue;
1391                 }
1392                 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1393                 draw_thru_sink (cr, x, 0, height, is_midi);
1394         }
1395 }
1396
1397 void
1398 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1399 {
1400         int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1401         double ht = _terminal ? height - dh : height;
1402
1403         // draw outputs of this
1404         const uint32_t pc_out = _sources.n_total();
1405         const uint32_t pc_out_midi = _sources.n_midi();
1406         const uint32_t n_out = _out.n_total();
1407         const uint32_t n_out_midi = _out.n_midi();
1408
1409         for (uint32_t i = 0; i < pc_out; ++i) {
1410                 const bool is_midi = i < pc_out_midi;
1411                 bool valid_out;
1412                 uint32_t pn = is_midi ? i : i - pc_out_midi;
1413                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1414                 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1415                 if (!valid_out) {
1416                         continue;
1417                 }
1418                 // skip connections that are not used in the next's input
1419                 if (_feeding) {
1420                         bool valid_thru, valid_sink;
1421                         _i_in_map.get_src (dt, idx, &valid_sink);
1422                         _i_thru_map.get_src (dt, idx, &valid_thru);
1423                         if (!valid_thru && !valid_sink) {
1424                                 if (!is_midi || i != 0) { // special case midi-bypass
1425                                         continue;
1426                                 }
1427                         }
1428                 }
1429                 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1430                 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1431                 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1432         }
1433
1434         for (uint32_t i = 0; i < n_out; ++i) {
1435                 const bool is_midi = i < n_out_midi;
1436                 uint32_t pn = is_midi ? i : i - n_out_midi;
1437                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1438                 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1439
1440                 if (!_terminal) {
1441                         bool valid_thru_f = false;
1442                         // skip connections that are not used in the next's input
1443                         if (_feeding) {
1444                                 bool valid_sink;
1445                                 _i_in_map.get_src (dt, pn, &valid_sink);
1446                                 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1447                                 if (!valid_thru_f && !valid_sink) {
1448                                         if (!is_midi || i != 0) { // special case midi-bypass
1449                                                 continue;
1450                                         }
1451                                 }
1452                         }
1453
1454                         bool valid_src;
1455                         _out_map.get_src (dt, pn, &valid_src);
1456                         if (!valid_src) {
1457                                 bool valid_thru;
1458                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1459                                 if (valid_thru) {
1460                                         if (idx >= _in.get (dt)) {
1461                                                 draw_sidechain (cr, x, 0, height, is_midi);
1462                                         } else {
1463                                                 draw_thru_src (cr, x, 0, height, is_midi);
1464                                         }
1465                                 } else if (valid_thru_f){
1466                                         // gnd is part of input, unless it's a thru input
1467                                         // (also only true if !coalesced into one small display)
1468                                         draw_gnd (cr, x, 0, height, is_midi);
1469                                 }
1470                         }
1471                 } else {
1472                         // terminal node, add arrows
1473                         bool valid_src;
1474                         _out_map.get_src (dt, pn, &valid_src);
1475                         if (!valid_src) {
1476                                 bool valid_thru;
1477                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1478                                 if (valid_thru) {
1479                                         if (idx >= _in.get (dt)) {
1480                                                 draw_sidechain (cr, x, 0, height - dh, is_midi);
1481                                         } else {
1482                                                 draw_thru_src (cr, x, 0, height - dh, is_midi);
1483                                         }
1484                                 } else {
1485                                         draw_gnd (cr, x, 0, height - dh, is_midi);
1486                                 }
1487                         }
1488
1489                         set_routing_color (cr, is_midi);
1490                         cairo_set_line_width (cr, 1.0);
1491                         cairo_move_to (cr, x, height - dh);
1492                         cairo_line_to (cr, x, height - 2);
1493                         cairo_stroke (cr);
1494
1495                         const double ar = dh - 1;
1496                         cairo_move_to (cr, x - ar, height - ar);
1497                         cairo_line_to (cr, x     , height - .5);
1498                         cairo_line_to (cr, x + ar, height - ar);
1499                         cairo_line_to (cr, x     , height - ar * .5);
1500                         cairo_close_path (cr);
1501                         cairo_fill_preserve (cr);
1502                         cairo_stroke (cr);
1503                 }
1504         }
1505 }
1506
1507 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1508         : _plug (p)
1509         , _surf (0)
1510         , _max_height (max_height)
1511         , _cur_height (1)
1512         , _scroll (false)
1513 {
1514         set_name ("processor prefader");
1515         _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1516                         boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1517 }
1518
1519 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1520 {
1521         if (_surf) {
1522                 cairo_surface_destroy (_surf);
1523         }
1524 }
1525
1526 void
1527 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1528 {
1529         req->width = 56;
1530         req->height = _cur_height;
1531 }
1532
1533
1534 void
1535 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1536 {
1537         /* work-around scroll-bar + aspect ratio
1538          * show inline-view -> height changes -> scrollbar gets added
1539          * -> width changes -> inline-view, fixed aspect ratio -> height changes
1540          * -> scroll bar is removed [-> width changes ; repeat ]
1541          */
1542         uint32_t shm = std::min (_max_height, inline_height);
1543         bool sc = false;
1544         Gtk::Container* pr = get_parent();
1545         for (uint32_t i = 0; i < 4 && pr; ++i) {
1546                 // VBox, EventBox, ViewPort, ScrolledWindow
1547                 pr = pr->get_parent();
1548         }
1549         Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1550         if (sw) {
1551                 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1552                 sc = vsb && vsb->is_visible();
1553         }
1554
1555         if (shm != _cur_height) {
1556                 if (_scroll == sc || _cur_height < shm) {
1557                         queue_resize ();
1558                 }
1559                 _cur_height = shm;
1560         }
1561         _scroll = sc;
1562 }
1563
1564 uint32_t
1565 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1566 {
1567         Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1568         if (!dis) {
1569                 return 0;
1570         }
1571
1572         /* allocate a local image-surface,
1573          * We cannot re-use the data via cairo_image_surface_create_for_data(),
1574          * since pixman keeps a reference to it.
1575          * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1576          * it might be possible to work around via cairo_surface_set_user_data().
1577          */
1578         if (!_surf
1579                         || dis->width !=  cairo_image_surface_get_width (_surf)
1580                         || dis->height !=  cairo_image_surface_get_height (_surf)
1581                  ) {
1582                 if (_surf) {
1583                         cairo_surface_destroy (_surf);
1584                 }
1585                 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1586         }
1587
1588         if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1589                 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1590         } else {
1591                 unsigned char *src = dis->data;
1592                 unsigned char *dst = cairo_image_surface_get_data (_surf);
1593                 const int dst_stride =  cairo_image_surface_get_stride (_surf);
1594                 for (int y = 0; y < dis->height; ++y) {
1595                         memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1596                         src += dis->stride;
1597                         dst += dst_stride;
1598                 }
1599         }
1600
1601         cairo_surface_mark_dirty(_surf);
1602         const double xc = floor ((width - dis->width) * .5);
1603         cairo_set_source_surface(cr, _surf, xc, 0);
1604         cairo_paint (cr);
1605
1606         return dis->height;
1607 }
1608
1609 bool
1610 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1611 {
1612         Gtk::Allocation a = get_allocation();
1613         double const width = a.get_width();
1614         double const height = a.get_height();
1615
1616         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1617         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1618         cairo_clip (cr);
1619
1620         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1621         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1622         cairo_rectangle (cr, 0, 0, width, height);
1623         cairo_fill (cr);
1624
1625         cairo_save (cr);
1626         cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1627         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1628         cairo_clip (cr);
1629         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1630
1631         uint32_t ht = render_inline (cr, width);
1632         cairo_restore (cr);
1633
1634         if (ht == 0) {
1635                 hide ();
1636                 if (_cur_height != 1) {
1637                         _cur_height = 1;
1638                         queue_resize ();
1639                 }
1640                 cairo_destroy (cr);
1641                 return true;
1642         } else {
1643                 update_height_alloc (ht);
1644         }
1645
1646         bool failed = false;
1647         std::string name = get_name();
1648         ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1649
1650         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1651         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1652         cairo_set_line_width(cr, 1.0);
1653         ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1654         cairo_stroke (cr);
1655
1656         cairo_destroy(cr);
1657         return true;
1658 }
1659
1660 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1661         : PluginDisplay (p, max_height)
1662         , _luaproc (p)
1663         , _lua_render_inline (0)
1664 {
1665         p->setup_lua_inline_gui (&lua_gui);
1666
1667         lua_State* LG = lua_gui.getState ();
1668         LuaInstance::bind_cairo (LG);
1669         luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1670         assert (lua_render.isFunction ());
1671         _lua_render_inline = new luabridge::LuaRef (lua_render);
1672 }
1673
1674 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1675 {
1676         delete (_lua_render_inline);
1677 }
1678
1679 uint32_t
1680 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1681 {
1682         Cairo::Context ctx (cr);
1683         try {
1684                 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1685                 if (rv.isTable ()) {
1686                         uint32_t h = rv[2];
1687                         return h;
1688                 }
1689         } catch (luabridge::LuaException const& e) {
1690                 ;
1691         }
1692         return 0;
1693 }
1694
1695
1696 static std::list<Gtk::TargetEntry> drop_targets()
1697 {
1698         std::list<Gtk::TargetEntry> tmp;
1699         tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1700         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1701         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // from sidebar
1702         return tmp;
1703 }
1704
1705 static std::list<Gtk::TargetEntry> drag_targets()
1706 {
1707         std::list<Gtk::TargetEntry> tmp;
1708         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1709         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1710         return tmp;
1711 }
1712
1713 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1714 {
1715         std::list<Gtk::TargetEntry> tmp;
1716         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1717         return tmp;
1718 }
1719
1720 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1721                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1722         : _parent_strip (parent)
1723         , _owner_is_mixer (owner_is_mixer)
1724         , ab_direction (true)
1725         , _get_plugin_selector (get_plugin_selector)
1726         , _placement (-1)
1727         , _visible_prefader_processors (0)
1728         , _rr_selection(rsel)
1729         , processor_display (drop_targets())
1730         , _redisplay_pending (false)
1731 {
1732         set_session (sess);
1733
1734         /* ProcessorBox actions and bindings created statically by call to
1735          * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1736          * are available for context menus.
1737          */
1738
1739         processor_display.set_data ("ardour-bindings", bindings);
1740
1741         _width = Wide;
1742         processor_menu = 0;
1743         no_processor_redisplay = false;
1744
1745         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1746         processor_scroller.add (processor_display);
1747         pack_start (processor_scroller, true, true);
1748
1749         processor_display.set_flags (CAN_FOCUS);
1750         processor_display.set_name ("ProcessorList");
1751         processor_display.set_data ("processorbox", this);
1752         processor_display.set_size_request (48, -1);
1753         processor_display.set_spacing (0);
1754
1755         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1756         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1757
1758         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1759         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1760
1761         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1762         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1763         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1764
1765         processor_scroller.show ();
1766         processor_display.show ();
1767
1768         if (parent) {
1769                 parent->DeliveryChanged.connect (
1770                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1771                         );
1772         }
1773
1774         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1775 }
1776
1777 ProcessorBox::~ProcessorBox ()
1778 {
1779         /* it may appear as if we should delete processor_menu but that is a
1780          * pointer to a widget owned by the UI Manager, and has potentially
1781          * be returned to many other ProcessorBoxes. GTK doesn't really make
1782          * clear the ownership of this widget, which is a menu and thus is
1783          * never packed into any container other than an implict GtkWindow.
1784          *
1785          * For now, until or if we ever get clarification over the ownership
1786          * story just let it continue to exist. At worst, its a small memory leak.
1787          */
1788 }
1789
1790 void
1791 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1792 {
1793         if (_route == r) {
1794                 return;
1795         }
1796
1797         _route_connections.drop_connections();
1798
1799         /* new route: any existing block on processor redisplay must be meaningless */
1800         no_processor_redisplay = false;
1801         _route = r;
1802
1803         _route->processors_changed.connect (
1804                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1805                 );
1806
1807         _route->DropReferences.connect (
1808                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1809                 );
1810
1811         _route->PropertyChanged.connect (
1812                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1813                 );
1814
1815         redisplay_processors ();
1816 }
1817
1818 void
1819 ProcessorBox::route_going_away ()
1820 {
1821         /* don't keep updating display as processors are deleted */
1822         no_processor_redisplay = true;
1823         _route.reset ();
1824 }
1825
1826 boost::shared_ptr<Processor>
1827 ProcessorBox::find_drop_position (ProcessorEntry* position)
1828 {
1829         boost::shared_ptr<Processor> p;
1830         if (position) {
1831                 p = position->processor ();
1832                 if (!p) {
1833                         /* dropped on the blank entry (which will be before the
1834                                  fader), so use the first non-blank child as our
1835                                  `dropped on' processor */
1836                         list<ProcessorEntry*> c = processor_display.children ();
1837                         list<ProcessorEntry*>::iterator i = c.begin ();
1838
1839                         assert (i != c.end ());
1840                         p = (*i)->processor ();
1841                         assert (p);
1842                 }
1843         }
1844         return p;
1845 }
1846
1847 void
1848 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1849 {
1850                 const void * d = data.get_data();
1851                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1852
1853                 PluginPresetList nfos;
1854                 TreeView* source;
1855                 tv->get_object_drag_data (nfos, &source);
1856
1857                 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1858                         PluginPresetPtr ppp = (*i);
1859                         PluginInfoPtr pip = ppp->_pip;
1860                         PluginPtr p = pip->load (*_session);
1861                         if (!p) {
1862                                 continue;
1863                         }
1864
1865                         if (ppp->_preset.valid) {
1866                                 p->load_preset (ppp->_preset);
1867                         }
1868
1869                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1870                         if (Config->get_new_plugins_active ()) {
1871                                 processor->activate ();
1872                         }
1873                         pl.push_back (processor);
1874                 }
1875 }
1876
1877 void
1878 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1879 {
1880                 const void * d = data.get_data();
1881                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1882                 PluginInfoList nfos;
1883
1884                 TreeView* source;
1885                 tv->get_object_drag_data (nfos, &source);
1886
1887                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1888                         PluginPtr p = (*i)->load (*_session);
1889                         if (!p) {
1890                                 continue;
1891                         }
1892                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1893                         if (Config->get_new_plugins_active ()) {
1894                                 processor->activate ();
1895                         }
1896                         pl.push_back (processor);
1897                 }
1898 }
1899
1900 void
1901 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1902 {
1903         if (!_session) {
1904                 return;
1905         }
1906
1907         boost::shared_ptr<Processor> p = find_drop_position (position);
1908         Route::ProcessorList pl;
1909
1910         if (data.get_target() == "PluginInfoPtr") {
1911                 _drop_plugin (data, pl);
1912         }
1913         else if (data.get_target() == "PluginPresetPtr") {
1914                 _drop_plugin_preset (data, pl);
1915         }
1916         else {
1917                 return;
1918         }
1919
1920         Route::ProcessorStreams err;
1921         if (_route->add_processors (pl, p, &err)) {
1922                 string msg = _(
1923                                 "Processor Drag/Drop failed. Probably because\n\
1924 the I/O configuration of the plugins could\n\
1925 not match the configuration of this track.");
1926                 MessageDialog am (msg);
1927                 am.run ();
1928         }
1929 }
1930
1931 void
1932 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1933 {
1934         if (Gdk::ACTION_LINK == context->get_selected_action()) {
1935                 list<ProcessorEntry*> children = source->selection ();
1936                 assert (children.size() == 1);
1937                 ProcessorEntry* other = *children.begin();
1938                 assert (other->can_copy_state (position));
1939                 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1940                 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1941                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1942                 assert (otherproc && proc && pi);
1943
1944                 PBD::ID id = pi->id();
1945                 XMLNode& state = otherproc->get_state ();
1946                 /* strip side-chain state (processor inside processor must be a side-chain)
1947                  * otherwise we'll end up with duplicate ports-names.
1948                  * (this needs a better solution which retains connections)
1949                  */
1950                 state.remove_nodes ("Processor");
1951                 proc->set_state (state, Stateful::loading_state_version);
1952                 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1953                 return;
1954         }
1955
1956         boost::shared_ptr<Processor> p = find_drop_position (position);
1957
1958         list<ProcessorEntry*> children = source->selection ();
1959         list<boost::shared_ptr<Processor> > procs;
1960         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1961                 if ((*i)->processor ()) {
1962                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1963                                 continue;
1964                         }
1965                         procs.push_back ((*i)->processor ());
1966                 }
1967         }
1968
1969         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1970                 XMLNode& state = (*i)->get_state ();
1971                 XMLNodeList nlist;
1972                 nlist.push_back (&state);
1973                 paste_processor_state (nlist, p);
1974                 delete &state;
1975         }
1976
1977         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1978            ourselves.
1979         */
1980
1981         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1982                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1983                 if (other) {
1984                         other->delete_dragged_processors (procs);
1985                 }
1986         }
1987 }
1988
1989 void
1990 ProcessorBox::set_width (Width w)
1991 {
1992         if (_width == w) {
1993                 return;
1994         }
1995
1996         _width = w;
1997
1998         list<ProcessorEntry*> children = processor_display.children ();
1999         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2000                 (*i)->set_enum_width (w);
2001         }
2002
2003         queue_resize ();
2004 }
2005
2006 Gtk::Menu*
2007 ProcessorBox::build_possible_aux_menu ()
2008 {
2009         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2010
2011         if (rl->empty()) {
2012                 /* No aux sends if there are no busses */
2013                 return 0;
2014         }
2015
2016         if (_route->is_monitor ()) {
2017                 return 0;
2018         }
2019
2020         using namespace Menu_Helpers;
2021         Menu* menu = manage (new Menu);
2022         MenuList& items = menu->items();
2023
2024         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2025                 if (!_route->internal_send_for (*r) && *r != _route) {
2026                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2027                 }
2028         }
2029
2030         return menu;
2031 }
2032
2033 void
2034 ProcessorBox::show_processor_menu (int arg)
2035 {
2036         if (processor_menu == 0) {
2037                 processor_menu = build_processor_menu ();
2038                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2039         }
2040
2041         /* Sort out the plugin submenu */
2042
2043         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2044
2045         if (plugin_menu_item) {
2046                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2047         }
2048
2049         /* And the aux submenu */
2050
2051         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2052
2053         if (aux_menu_item) {
2054                 Menu* m = build_possible_aux_menu();
2055                 if (m && !m->items().empty()) {
2056                         aux_menu_item->set_submenu (*m);
2057                         aux_menu_item->set_sensitive (true);
2058                 } else {
2059                         /* stupid gtkmm: we need to pass a null reference here */
2060                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2061                         aux_menu_item->set_sensitive (false);
2062                 }
2063         }
2064
2065         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2066         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2067
2068         ProcessorEntry* single_selection = 0;
2069         if (processor_display.selection().size() == 1) {
2070                 single_selection = processor_display.selection().front();
2071         }
2072
2073         /* And the controls submenu */
2074
2075         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2076
2077         if (controls_menu_item) {
2078                 if (single_selection) {
2079                         Menu* m = single_selection->build_controls_menu ();
2080                         if (m && !m->items().empty()) {
2081                                 controls_menu_item->set_submenu (*m);
2082                                 controls_menu_item->set_sensitive (true);
2083                         } else {
2084                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2085                                 controls_menu_item->set_sensitive (false);
2086                         }
2087                 } else {
2088                         controls_menu_item->set_sensitive (false);
2089                 }
2090         }
2091
2092         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2093         if (send_menu_item) {
2094                 if (single_selection && !_route->is_monitor()) {
2095                         Menu* m = single_selection->build_send_options_menu ();
2096                         if (m && !m->items().empty()) {
2097                                 send_menu_item->set_submenu (*m);
2098                                 send_menu_item->set_sensitive (true);
2099                         } else {
2100                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2101                                 send_menu_item->set_sensitive (false);
2102                         }
2103                 } else {
2104                         send_menu_item->set_sensitive (false);
2105                 }
2106         }
2107
2108         /* Sensitise actions as approprioate */
2109
2110
2111         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2112
2113         paste_action->set_sensitive (!_rr_selection.processors.empty());
2114         cut_action->set_sensitive (sensitive && can_cut ());
2115         copy_action->set_sensitive (sensitive);
2116         delete_action->set_sensitive (sensitive || stub_processor_selected ());
2117
2118         edit_action->set_sensitive (one_processor_can_be_edited ());
2119         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2120
2121         boost::shared_ptr<PluginInsert> pi;
2122         if (single_selection) {
2123                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2124         }
2125
2126         manage_pins_action->set_sensitive (pi != 0);
2127
2128         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2129         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2130
2131         /* disallow rename for multiple selections, for plugin inserts and for the fader */
2132         rename_action->set_sensitive (single_selection
2133                         && !pi
2134                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2135                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2136
2137         processor_menu->popup (1, arg);
2138
2139         /* Add a placeholder gap to the processor list to indicate where a processor would be
2140            inserted were one chosen from the menu.
2141         */
2142         int x, y;
2143         processor_display.get_pointer (x, y);
2144         _placement = processor_display.add_placeholder (y);
2145
2146         if (_visible_prefader_processors == 0 && _placement > 0) {
2147                 --_placement;
2148         }
2149 }
2150
2151 bool
2152 ProcessorBox::enter_notify (GdkEventCrossing*)
2153 {
2154         processor_display.grab_focus ();
2155         _current_processor_box = this;
2156         return false;
2157 }
2158
2159 bool
2160 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2161 {
2162         if (ev->detail == GDK_NOTIFY_INFERIOR) {
2163                 return false;
2164         }
2165
2166         Widget* top = get_toplevel();
2167
2168         if (top->is_toplevel()) {
2169                 Window* win = dynamic_cast<Window*> (top);
2170                 gtk_window_set_focus (win->gobj(), 0);
2171         }
2172
2173         return false;
2174 }
2175
2176 bool
2177 ProcessorBox::processor_operation (ProcessorOperation op)
2178 {
2179         ProcSelection targets;
2180
2181         get_selected_processors (targets);
2182
2183 /*      if (targets.empty()) {
2184
2185                 int x, y;
2186                 processor_display.get_pointer (x, y);
2187
2188                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2189
2190                 if (pointer.first && pointer.first->processor()) {
2191                         targets.push_back (pointer.first->processor ());
2192                 }
2193         }
2194 */
2195
2196         if ((op == ProcessorsDelete) && targets.empty()) {
2197                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
2198         }
2199
2200         switch (op) {
2201         case ProcessorsSelectAll:
2202                 processor_display.select_all ();
2203                 break;
2204
2205         case ProcessorsSelectNone:
2206                 processor_display.select_none ();
2207                 break;
2208
2209         case ProcessorsCopy:
2210                 copy_processors (targets);
2211                 break;
2212
2213         case ProcessorsCut:
2214                 cut_processors (targets);
2215                 break;
2216
2217         case ProcessorsPaste:
2218                 // some processors are not selectable (e.g fader, meter), target is empty.
2219                 if (targets.empty() && _placement >= 0) {
2220                         assert (_route);
2221                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2222                         if (proc) {
2223                                 targets.push_back (proc);
2224                         }
2225                 }
2226                 if (targets.empty()) {
2227                         paste_processors ();
2228                 } else {
2229                         paste_processors (targets.front());
2230                 }
2231                 break;
2232
2233         case ProcessorsDelete:
2234                 delete_processors (targets);
2235                 break;
2236
2237         case ProcessorsToggleActive:
2238                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2239                         if ((*i)->active()) {
2240                                 (*i)->deactivate ();
2241                         } else {
2242                                 (*i)->activate ();
2243                         }
2244                 }
2245                 break;
2246
2247         case ProcessorsAB:
2248                 ab_plugins ();
2249                 break;
2250
2251         default:
2252                 break;
2253         }
2254
2255         return true;
2256 }
2257
2258 ProcessorWindowProxy*
2259 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2260 {
2261         return  processor->window_proxy();
2262 }
2263
2264
2265 bool
2266 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2267 {
2268         boost::shared_ptr<Processor> processor;
2269         if (child) {
2270                 processor = child->processor ();
2271         }
2272
2273         int ret = false;
2274         bool selected = processor_display.selected (child);
2275
2276         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2277
2278                 if (_session->engine().connected()) {
2279                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2280
2281                         if (!one_processor_can_be_edited ()) {
2282                                 return true;
2283                         }
2284
2285                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2286                                 generic_edit_processor (processor);
2287                         } else {
2288                                 edit_processor (processor);
2289                         }
2290                 }
2291
2292                 ret = true;
2293
2294         } else if (Keyboard::is_context_menu_event (ev)) {
2295
2296                 show_processor_menu (ev->time);
2297
2298                 ret = true;
2299
2300         } else if (processor && ev->button == 1 && selected) {
2301
2302                 // this is purely informational but necessary for route params UI
2303                 ProcessorSelected (processor); // emit
2304
2305         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2306
2307                 choose_plugin ();
2308                 _get_plugin_selector()->show_manager ();
2309         }
2310
2311         return ret;
2312 }
2313
2314 bool
2315 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2316 {
2317         boost::shared_ptr<Processor> processor;
2318         if (child) {
2319                 processor = child->processor ();
2320         }
2321
2322         if (processor && Keyboard::is_delete_event (ev)) {
2323
2324                 Glib::signal_idle().connect (sigc::bind (
2325                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2326                                 boost::weak_ptr<Processor>(processor)));
2327
2328         } else if (processor && Keyboard::is_button2_event (ev)
2329 #ifndef __APPLE__
2330                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2331 #endif
2332                 ) {
2333
2334                 /* button2-click with no/appropriate modifiers */
2335
2336                 if (processor->active()) {
2337                         processor->deactivate ();
2338                 } else {
2339                         processor->activate ();
2340                 }
2341         }
2342
2343         return false;
2344 }
2345
2346 Menu *
2347 ProcessorBox::build_processor_menu ()
2348 {
2349         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2350         processor_menu->set_name ("ArdourContextMenu");
2351         return processor_menu;
2352 }
2353
2354 void
2355 ProcessorBox::select_all_processors ()
2356 {
2357         processor_display.select_all ();
2358 }
2359
2360 void
2361 ProcessorBox::deselect_all_processors ()
2362 {
2363         processor_display.select_none ();
2364 }
2365
2366 void
2367 ProcessorBox::choose_plugin ()
2368 {
2369         _get_plugin_selector()->set_interested_object (*this);
2370 }
2371
2372 /** @return true if an error occurred, otherwise false */
2373 bool
2374 ProcessorBox::choose_lua ()
2375 {
2376         LuaScriptInfoPtr spi;
2377
2378         ScriptSelector ss (_("Add Lua DSP Processor"), LuaScriptInfo::DSP);
2379         switch (ss.run ()) {
2380                 case Gtk::RESPONSE_ACCEPT:
2381                         spi = ss.script();
2382                         break;
2383                 default:
2384                         return true;
2385         }
2386         ss.hide ();
2387
2388         PluginPtr p;
2389         try {
2390                 LuaPluginInfoPtr lpi (new LuaPluginInfo(spi));
2391                 p = (lpi->load (*_session));
2392         } catch (...) {
2393                 string msg = _(
2394                                 "Failed to instantiate Lua DSP Processor,\n"
2395                                 "probably because the script is invalid (no dsp function).");
2396                 MessageDialog am (msg);
2397                 am.run ();
2398                 return true;
2399         }
2400
2401         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
2402
2403         Route::ProcessorStreams err_streams;
2404         if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2405                 string msg = _(
2406                                 "Failed to add Lua DSP Processor at the given position,\n"
2407                                 "probably because the I/O configuration of the plugins\n"
2408                                 "could not match the configuration of this track.");
2409                 MessageDialog am (msg);
2410                 am.run ();
2411         }
2412         return false;
2413 }
2414
2415 /** @return true if an error occurred, otherwise false */
2416 bool
2417 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2418 {
2419         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2420
2421                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2422
2423                 Route::ProcessorStreams err_streams;
2424
2425                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2426                         weird_plugin_dialog (**p, err_streams);
2427                         return true;
2428                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
2429                 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2430                         if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2431                                 ;
2432                         } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2433                                 if ((*p)->has_editor ()) {
2434                                         edit_processor (processor);
2435                                 } else {
2436                                         generic_edit_processor (processor);
2437                                 }
2438                         }
2439                 }
2440         }
2441
2442         return false;
2443 }
2444
2445 void
2446 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2447 {
2448         ArdourDialog dialog (_("Plugin Incompatibility"));
2449         Label label;
2450
2451         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2452                         p.name(), streams.index);
2453
2454         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2455         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2456
2457         text += _("\nThis plugin has:\n");
2458         if (has_midi) {
2459                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2460                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2461         }
2462         if (has_audio) {
2463                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2464                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2465         }
2466
2467         text += _("\nbut at the insertion point, there are:\n");
2468         if (has_midi) {
2469                 uint32_t const n = streams.count.n_midi ();
2470                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2471         }
2472         if (has_audio) {
2473                 uint32_t const n = streams.count.n_audio ();
2474                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2475         }
2476
2477         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2478         label.set_text(text);
2479
2480         dialog.get_vbox()->pack_start (label);
2481         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2482
2483         dialog.set_name (X_("PluginIODialog"));
2484         dialog.set_modal (true);
2485         dialog.show_all ();
2486
2487         dialog.run ();
2488 }
2489
2490 void
2491 ProcessorBox::choose_insert ()
2492 {
2493         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2494         _route->add_processor_by_index (processor, _placement);
2495 }
2496
2497 /* Caller must not hold process lock */
2498 void
2499 ProcessorBox::choose_send ()
2500 {
2501         boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2502
2503         /* make an educated guess at the initial number of outputs for the send */
2504         ChanCount outs = (_session->master_out())
2505                         ? _session->master_out()->n_outputs()
2506                         : _route->n_outputs();
2507
2508         /* XXX need processor lock on route */
2509         try {
2510                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2511                 send->output()->ensure_io (outs, false, this);
2512         } catch (AudioEngine::PortRegistrationFailure& err) {
2513                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2514                 return;
2515         }
2516
2517         /* let the user adjust the IO setup before creation.
2518
2519            Note: this dialog is NOT modal - we just leave it to run and it will
2520            return when its Finished signal is emitted - typically when the window
2521            is closed.
2522          */
2523
2524         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2525         ios->show ();
2526
2527         /* keep a reference to the send so it doesn't get deleted while
2528            the IOSelectorWindow is doing its stuff
2529         */
2530         _processor_being_created = send;
2531
2532         ios->selector().Finished.connect (sigc::bind (
2533                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2534                         boost::weak_ptr<Processor>(send), ios));
2535
2536 }
2537
2538 void
2539 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2540 {
2541         boost::shared_ptr<Processor> processor (weak_processor.lock());
2542
2543         /* drop our temporary reference to the new send */
2544         _processor_being_created.reset ();
2545
2546         if (!processor) {
2547                 return;
2548         }
2549
2550         switch (r) {
2551         case IOSelector::Cancelled:
2552                 // processor will go away when all shared_ptrs to it vanish
2553                 break;
2554
2555         case IOSelector::Accepted:
2556                 _route->add_processor_by_index (processor, _placement);
2557                 break;
2558         }
2559
2560         delete_when_idle (ios);
2561 }
2562
2563 void
2564 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2565 {
2566         boost::shared_ptr<Processor> processor (weak_processor.lock());
2567
2568         /* drop our temporary reference to the new return */
2569         _processor_being_created.reset ();
2570
2571         if (!processor) {
2572                 return;
2573         }
2574
2575         switch (r) {
2576         case IOSelector::Cancelled:
2577                 // processor will go away when all shared_ptrs to it vanish
2578                 break;
2579
2580         case IOSelector::Accepted:
2581                 _route->add_processor_by_index (processor, _placement);
2582                 break;
2583         }
2584
2585         delete_when_idle (ios);
2586 }
2587
2588 void
2589 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2590 {
2591         if (!_route) {
2592                 return;
2593         }
2594
2595         boost::shared_ptr<Route> target = wr.lock();
2596
2597         if (!target) {
2598                 return;
2599         }
2600
2601         _session->add_internal_send (target, _placement, _route);
2602 }
2603
2604 void
2605 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2606 {
2607         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2608                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2609                 return;
2610         }
2611
2612         redisplay_processors ();
2613 }
2614
2615 void
2616 ProcessorBox::redisplay_processors ()
2617 {
2618         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2619         bool     fader_seen;
2620
2621         if (no_processor_redisplay) {
2622                 return;
2623         }
2624
2625         processor_display.clear ();
2626
2627         _visible_prefader_processors = 0;
2628         fader_seen = false;
2629
2630         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2631                                                &_visible_prefader_processors, &fader_seen));
2632
2633         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2634         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2635         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2636
2637         setup_entry_positions ();
2638 }
2639
2640 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2641  *  not already have one.
2642  */
2643 void
2644 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2645 {
2646         boost::shared_ptr<Processor> p = w.lock ();
2647         if (!p) {
2648                 return;
2649         }
2650         if (p->window_proxy()) {
2651                 return;
2652         }
2653
2654         /* not on the list; add it */
2655
2656         string loc;
2657 #if 0 // is this still needed? Why?
2658         if (_parent_strip) {
2659                 if (_parent_strip->mixer_owned()) {
2660                         loc = X_("M");
2661                 } else {
2662                         loc = X_("R");
2663                 }
2664         } else {
2665                 loc = X_("P");
2666         }
2667 #else
2668         loc = X_("P");
2669 #endif
2670
2671         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2672                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2673                 this,
2674                 w);
2675
2676         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2677
2678         if (ui_xml) {
2679                 wp->set_state (*ui_xml, 0);
2680         }
2681
2682         void* existing_ui = p->get_ui ();
2683
2684         if (existing_ui) {
2685                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2686         }
2687
2688         p->set_window_proxy (wp);
2689         WM::Manager::instance().register_window (wp);
2690 }
2691
2692 void
2693 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2694 {
2695         boost::shared_ptr<Processor> p = w.lock ();
2696         if (!p || p->pinmgr_proxy ()) {
2697                 return;
2698         }
2699
2700         PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2701                         string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2702         wp->set_session (_session);
2703
2704         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2705         if (ui_xml) {
2706                 wp->set_state (*ui_xml, 0);
2707         }
2708
2709         void* existing_ui = p->get_ui ();
2710
2711         if (existing_ui) {
2712                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2713         }
2714
2715         p->set_pingmgr_proxy (wp);
2716         WM::Manager::instance().register_window (wp);
2717 }
2718 void
2719 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2720 {
2721         boost::shared_ptr<Processor> processor (p.lock ());
2722
2723         if (processor && ( processor->display_to_user()
2724 #ifndef NDEBUG
2725                             || show_all_processors
2726 #endif
2727                          )
2728            ) {
2729
2730                 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2731                     boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2732                         *amp_seen = true;
2733                 } else {
2734                         if (!*amp_seen) {
2735                                 (*cnt)++;
2736                         }
2737                 }
2738         }
2739 }
2740
2741 void
2742 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2743 {
2744         boost::shared_ptr<Processor> processor (p.lock ());
2745
2746         if (!processor || ( !processor->display_to_user()
2747 #ifndef NDEBUG
2748                             && !show_all_processors
2749 #endif
2750                           )
2751            ) {
2752                 return;
2753         }
2754
2755         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2756
2757         ProcessorEntry* e = 0;
2758         if (plugin_insert) {
2759                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2760         } else {
2761                 e = new ProcessorEntry (this, processor, _width);
2762         }
2763
2764         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2765         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2766         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2767
2768         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2769         if (!send && !plugin_insert && !ext && !stub)
2770                 e->set_selectable(false);
2771
2772         bool mark_send_visible = false;
2773         if (send && _parent_strip) {
2774                 /* show controls of new sends by default */
2775                 GUIObjectState& st = _parent_strip->gui_object_state ();
2776                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2777                 assert (strip);
2778                 /* check if state exists, if not it must be a new send */
2779                 if (!st.get_node(strip, e->state_id())) {
2780                         mark_send_visible = true;
2781                 }
2782         }
2783
2784         /* Set up this entry's state from the GUIObjectState */
2785         XMLNode* proc = entry_gui_object_state (e);
2786         if (proc) {
2787                 e->set_control_state (proc);
2788         }
2789
2790         if (mark_send_visible) {
2791                 e->show_all_controls ();
2792         }
2793
2794         if (plugin_insert
2795 #ifdef MIXBUS
2796                         && !plugin_insert->plugin(0)->is_channelstrip()
2797 #endif
2798                  )
2799         {
2800                 processor_display.add_child (e, drag_targets());
2801         } else {
2802                 processor_display.add_child (e, drag_targets_noplugin());
2803         }
2804 }
2805
2806 void
2807 ProcessorBox::reordered ()
2808 {
2809         compute_processor_sort_keys ();
2810         setup_entry_positions ();
2811 }
2812
2813 void
2814 ProcessorBox::setup_routing_feeds ()
2815 {
2816         list<ProcessorEntry*> children = processor_display.children ();
2817         /* first set the i/o maps for every processor */
2818         list<ProcessorEntry*>::iterator prev = children.begin();
2819
2820         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2821                 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2822                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2823
2824                 list<ProcessorEntry*>::iterator next = i;
2825                 next++;
2826
2827                 if (pi) {
2828                         ChanCount sinks = pi->natural_input_streams ();
2829                         ChanCount sources = pi->natural_output_streams ();
2830                         uint32_t count = pi->get_count ();
2831                         ChanCount in, out;
2832                         pi->configured_io (in, out);
2833
2834                         ChanCount midi_thru;
2835                         ChanCount midi_bypass;
2836                         ChanMapping input_map (pi->input_map ());
2837                         if (pi->has_midi_thru ()) {
2838                                  midi_thru.set(DataType::MIDI, 1);
2839                                  input_map.set (DataType::MIDI, 0, 0);
2840                         }
2841                         if (pi->has_midi_bypass ()) {
2842                                  midi_bypass.set(DataType::MIDI, 1);
2843                         }
2844
2845                         (*i)->input_icon.set_ports (sinks * count + midi_thru);
2846                         (*i)->output_icon.set_ports (sources * count + midi_bypass);
2847
2848                         (*i)->routing_icon.set (
2849                                         in, out,
2850                                         sinks * count + midi_thru,
2851                                         sources * count + midi_bypass,
2852                                         input_map,
2853                                         pi->output_map (),
2854                                         pi->thru_map ());
2855
2856                         if (next != children.end()) {
2857                                 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2858                                                 pi->output_map (), pi->thru_map ());
2859                         }
2860
2861                         if (prev != i) {
2862                                 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2863                                                 pi->input_map (), pi->thru_map ());
2864                         }
2865
2866                 } else {
2867                         (*i)->input_icon.set_ports (p->input_streams());
2868                         (*i)->output_icon.set_ports (p->output_streams());
2869                         ChanMapping inmap (p->input_streams ());
2870                         ChanMapping outmap (p->input_streams ());
2871                         ChanMapping thrumap;
2872                         (*i)->routing_icon.set (
2873                                         p->input_streams(),
2874                                         p->output_streams(),
2875                                         p->input_streams(),
2876                                         p->output_streams(),
2877                                         inmap, outmap, thrumap);
2878
2879                         if (next != children.end()) {
2880                                 (*next)->routing_icon.set_fed_by (
2881                                                 p->output_streams(),
2882                                                 p->output_streams(),
2883                                                 outmap, thrumap);
2884                         }
2885                         if (prev != i) {
2886                                 (*prev)->routing_icon.set_feeding (
2887                                                 p->input_streams(),
2888                                                 p->output_streams(),
2889                                                 inmap, thrumap);
2890                         }
2891                 }
2892
2893                 if (i == children.begin()) {
2894                         (*i)->routing_icon.unset_fed_by ();
2895                 }
2896                 prev = i;
2897                 (*i)->input_icon.hide();
2898         }
2899
2900         /* now set which icons need to be displayed */
2901         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2902                 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2903
2904                 if ((*i)->routing_icon.in_identity ()) {
2905                         (*i)->routing_icon.hide();
2906                         if (i == children.begin()) {
2907                                 (*i)->input_icon.show();
2908                         }
2909                 } else {
2910                         (*i)->routing_icon.show();
2911                         (*i)->routing_icon.queue_draw();
2912                         (*i)->input_icon.show();
2913                 }
2914
2915                 list<ProcessorEntry*>::iterator next = i;
2916                 if (++next == children.end()) {
2917                         // last processor in the chain
2918                         (*i)->output_routing_icon.set_terminal(true);
2919                         (*i)->output_routing_icon.unset_feeding ();
2920                         if ((*i)->routing_icon.out_identity ()) {
2921                                 (*i)->output_routing_icon.hide();
2922                         } else {
2923                                 (*i)->output_routing_icon.show();
2924                                 (*i)->output_routing_icon.queue_draw();
2925                         }
2926                 } else {
2927                         (*i)->output_routing_icon.set_terminal(false);
2928                         if (!(*i)->routing_icon.out_identity ()
2929                                         && !(*i)->routing_icon.in_identity ()
2930                                         && (*i)->routing_icon.can_coalesce ()) {
2931                                 (*i)->output_routing_icon.hide();
2932                         } else if (!(*i)->routing_icon.out_identity ()) {
2933                                 (*i)->output_routing_icon.show();
2934                                 (*i)->output_routing_icon.queue_draw();
2935                                 (*next)->input_icon.show();
2936                         } else {
2937                                 (*i)->output_routing_icon.hide();
2938                         }
2939                 }
2940         }
2941 }
2942
2943 void
2944 ProcessorBox::setup_entry_positions ()
2945 {
2946         list<ProcessorEntry*> children = processor_display.children ();
2947         bool pre_fader = true;
2948
2949         uint32_t num = 0;
2950         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2951                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2952                     boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2953                         pre_fader = false;
2954                         (*i)->set_position (ProcessorEntry::Fader, num++);
2955                 } else {
2956                         if (pre_fader) {
2957                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
2958                         } else {
2959                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
2960                         }
2961                 }
2962         }
2963         setup_routing_feeds ();
2964 }
2965
2966 void
2967 ProcessorBox::compute_processor_sort_keys ()
2968 {
2969         list<ProcessorEntry*> children = processor_display.children ();
2970         Route::ProcessorList our_processors;
2971
2972         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2973                 if ((*i)->processor()) {
2974                         our_processors.push_back ((*i)->processor ());
2975                 }
2976         }
2977
2978         if (_route->reorder_processors (our_processors)) {
2979                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
2980                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
2981                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
2982                    when the drag is torn down after this handler function is finished.
2983                 */
2984                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2985         }
2986 }
2987
2988 void
2989 ProcessorBox::report_failed_reorder ()
2990 {
2991         /* reorder failed, so redisplay */
2992
2993         redisplay_processors ();
2994
2995         /* now tell them about the problem */
2996
2997         ArdourDialog dialog (_("Plugin Incompatibility"));
2998         Label label;
2999
3000         label.set_text (_("\
3001 You cannot reorder these plugins/sends/inserts\n\
3002 in that way because the inputs and\n\
3003 outputs will not work correctly."));
3004
3005         dialog.get_vbox()->set_border_width (12);
3006         dialog.get_vbox()->pack_start (label);
3007         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
3008
3009         dialog.set_name (X_("PluginIODialog"));
3010         dialog.set_modal (true);
3011         dialog.show_all ();
3012
3013         dialog.run ();
3014 }
3015
3016 void
3017 ProcessorBox::rename_processors ()
3018 {
3019         ProcSelection to_be_renamed;
3020
3021         get_selected_processors (to_be_renamed);
3022
3023         if (to_be_renamed.empty()) {
3024                 return;
3025         }
3026
3027         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3028                 rename_processor (*i);
3029         }
3030 }
3031
3032 bool
3033 ProcessorBox::can_cut () const
3034 {
3035         vector<boost::shared_ptr<Processor> > sel;
3036
3037         get_selected_processors (sel);
3038
3039         /* cut_processors () does not cut inserts */
3040
3041         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3042
3043                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3044                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3045                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3046                         return true;
3047                 }
3048         }
3049
3050         return false;
3051 }
3052
3053 bool
3054 ProcessorBox::stub_processor_selected () const
3055 {
3056         vector<boost::shared_ptr<Processor> > sel;
3057
3058         get_selected_processors (sel);
3059
3060         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3061                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3062                         return true;
3063                 }
3064         }
3065
3066         return false;
3067 }
3068
3069 void
3070 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3071 {
3072         if (to_be_removed.empty()) {
3073                 return;
3074         }
3075
3076         XMLNode* node = new XMLNode (X_("cut"));
3077         Route::ProcessorList to_cut;
3078
3079         no_processor_redisplay = true;
3080         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3081                 // Cut only plugins, sends and returns
3082                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3083                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3084                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3085
3086                         Window* w = get_processor_ui (*i);
3087
3088                         if (w) {
3089                                 w->hide ();
3090                         }
3091
3092                         XMLNode& child ((*i)->get_state());
3093                         node->add_child_nocopy (child);
3094                         to_cut.push_back (*i);
3095                 }
3096         }
3097
3098         if (_route->remove_processors (to_cut) != 0) {
3099                 delete node;
3100                 no_processor_redisplay = false;
3101                 return;
3102         }
3103
3104         _rr_selection.set (node);
3105
3106         no_processor_redisplay = false;
3107         redisplay_processors ();
3108 }
3109
3110 void
3111 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3112 {
3113         if (to_be_copied.empty()) {
3114                 return;
3115         }
3116
3117         XMLNode* node = new XMLNode (X_("copy"));
3118
3119         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3120                 // Copy only plugins, sends, returns
3121                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3122                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3123                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3124                         node->add_child_nocopy ((*i)->get_state());
3125                 }
3126         }
3127
3128         _rr_selection.set (node);
3129 }
3130
3131 void
3132 ProcessorBox::delete_processors (const ProcSelection& targets)
3133 {
3134         if (targets.empty()) {
3135                 return;
3136         }
3137
3138         no_processor_redisplay = true;
3139
3140         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3141
3142                 Window* w = get_processor_ui (*i);
3143
3144                 if (w) {
3145                         w->hide ();
3146                 }
3147
3148                 _route->remove_processor(*i);
3149         }
3150
3151         no_processor_redisplay = false;
3152         redisplay_processors ();
3153 }
3154
3155 void
3156 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3157 {
3158         list<boost::shared_ptr<Processor> >::const_iterator x;
3159
3160         no_processor_redisplay = true;
3161         for (x = procs.begin(); x != procs.end(); ++x) {
3162
3163                 Window* w = get_processor_ui (*x);
3164
3165                 if (w) {
3166                         w->hide ();
3167                 }
3168
3169                 _route->remove_processor(*x);
3170         }
3171
3172         no_processor_redisplay = false;
3173         redisplay_processors ();
3174 }
3175
3176 gint
3177 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3178 {
3179         boost::shared_ptr<Processor> processor (weak_processor.lock());
3180
3181         if (!processor) {
3182                 return false;
3183         }
3184
3185         /* NOT copied to _mixer.selection() */
3186
3187         no_processor_redisplay = true;
3188         _route->remove_processor (processor);
3189         no_processor_redisplay = false;
3190         redisplay_processors ();
3191
3192         return false;
3193 }
3194
3195 void
3196 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3197 {
3198         ArdourPrompter name_prompter (true);
3199         string result;
3200         name_prompter.set_title (_("Rename Processor"));
3201         name_prompter.set_prompt (_("New name:"));
3202         name_prompter.set_initial_text (processor->name());
3203         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3204         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3205         name_prompter.show_all ();
3206
3207         switch (name_prompter.run ()) {
3208
3209         case Gtk::RESPONSE_ACCEPT:
3210                 name_prompter.get_result (result);
3211                 if (result.length()) {
3212
3213                        int tries = 0;
3214                        string test = result;
3215
3216                        while (tries < 100) {
3217                                if (_session->io_name_is_legal (test)) {
3218                                        result = test;
3219                                        break;
3220                                }
3221                                tries++;
3222
3223                                test = string_compose ("%1-%2", result, tries);
3224                        }
3225
3226                        if (tries < 100) {
3227                                processor->set_name (result);
3228                        } else {
3229                                /* unlikely! */
3230                                ARDOUR_UI::instance()->popup_error
3231                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3232                        }
3233                 }
3234                 break;
3235         }
3236
3237         return;
3238 }
3239
3240 void
3241 ProcessorBox::paste_processors ()
3242 {
3243         if (_rr_selection.processors.empty()) {
3244                 return;
3245         }
3246
3247         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3248 }
3249
3250 void
3251 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3252 {
3253
3254         if (_rr_selection.processors.empty()) {
3255                 return;
3256         }
3257
3258         paste_processor_state (_rr_selection.processors.get_node().children(), before);
3259 }
3260
3261 void
3262 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3263 {
3264         XMLNodeConstIterator niter;
3265         list<boost::shared_ptr<Processor> > copies;
3266
3267         if (nlist.empty()) {
3268                 return;
3269         }
3270
3271         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3272
3273                 XMLProperty const * type = (*niter)->property ("type");
3274                 XMLProperty const * role = (*niter)->property ("role");
3275                 assert (type);
3276
3277                 boost::shared_ptr<Processor> p;
3278                 try {
3279                         if (type->value() == "meter" ||
3280                             type->value() == "main-outs" ||
3281                             type->value() == "amp" ||
3282                             type->value() == "intreturn") {
3283                                 /* do not paste meter, main outs, amp or internal returns */
3284                                 continue;
3285
3286                         } else if (type->value() == "intsend") {
3287
3288                                 /* aux sends are OK, but those used for
3289                                  * other purposes, are not.
3290                                  */
3291
3292                                 assert (role);
3293
3294                                 if (role->value() != "Aux") {
3295                                         continue;
3296                                 }
3297
3298                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3299                                 XMLNode n (**niter);
3300                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3301                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3302
3303                                 IOProcessor::prepare_for_reset (n, s->name());
3304
3305                                 if (s->set_state (n, Stateful::loading_state_version)) {
3306                                         delete s;
3307                                         return;
3308                                 }
3309
3310                                 p.reset (s);
3311
3312                         } else if (type->value() == "send") {
3313
3314                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3315                                 XMLNode n (**niter);
3316
3317                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3318
3319                                 IOProcessor::prepare_for_reset (n, s->name());
3320
3321                                 if (s->set_state (n, Stateful::loading_state_version)) {
3322                                         delete s;
3323                                         return;
3324                                 }
3325
3326                                 p.reset (s);
3327
3328                         } else if (type->value() == "return") {
3329
3330                                 XMLNode n (**niter);
3331                                 Return* r = new Return (*_session);
3332
3333                                 IOProcessor::prepare_for_reset (n, r->name());
3334
3335                                 if (r->set_state (n, Stateful::loading_state_version)) {
3336                                         delete r;
3337                                         return;
3338                                 }
3339
3340                                 p.reset (r);
3341
3342                         } else if (type->value() == "port") {
3343
3344                                 XMLNode n (**niter);
3345                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3346
3347                                 IOProcessor::prepare_for_reset (n, pi->name());
3348
3349                                 if (pi->set_state (n, Stateful::loading_state_version)) {
3350                                         return;
3351                                 }
3352
3353                                 p.reset (pi);
3354                         } else {
3355                                 /* XXX its a bit limiting to assume that everything else
3356                                    is a plugin.
3357                                 */
3358                                 p.reset (new PluginInsert (*_session));
3359                                 /* we can't use RAII Stateful::ForceIDRegeneration
3360                                  * because that'd void copying the state and wrongly bump
3361                                  * the state-version counter.
3362                                  * we need to load the state (incl external files) first and
3363                                  * only then update the ID)
3364                                  */
3365                                 PBD::ID id = p->id();
3366                                 /* strip side-chain state (processor inside processor must be a side-chain)
3367                                  * otherwise we'll end up with duplicate ports-names.
3368                                  * (this needs a better solution which retains connections)
3369                                  * We really would want Stateful::ForceIDRegeneration here :(
3370                                  */
3371                                 XMLNode state (**niter);
3372                                 state.remove_nodes ("Processor");
3373
3374                                 p->set_state (state, Stateful::current_state_version);
3375                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3376                         }
3377
3378                         copies.push_back (p);
3379                 }
3380
3381                 catch (...) {
3382                         error << _("plugin insert constructor failed") << endmsg;
3383                 }
3384         }
3385
3386         if (copies.empty()) {
3387                 return;
3388         }
3389
3390         if (_route->add_processors (copies, p)) {
3391
3392                 string msg = _(
3393                         "Copying the set of processors on the clipboard failed,\n\
3394 probably because the I/O configuration of the plugins\n\
3395 could not match the configuration of this track.");
3396                 MessageDialog am (msg);
3397                 am.run ();
3398         }
3399 }
3400
3401 void
3402 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3403 {
3404         const list<ProcessorEntry*> selection = processor_display.selection ();
3405         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3406                 processors.push_back ((*i)->processor ());
3407         }
3408 }
3409
3410 void
3411 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3412 {
3413         list<ProcessorEntry*> selection = processor_display.selection ();
3414         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3415                 (this->*method) ((*i)->processor ());
3416         }
3417 }
3418
3419 void
3420 ProcessorBox::all_visible_processors_active (bool state)
3421 {
3422         _route->all_visible_processors_active (state);
3423 }
3424
3425 void
3426 ProcessorBox::ab_plugins ()
3427 {
3428         _route->ab_plugins (ab_direction);
3429         ab_direction = !ab_direction;
3430 }
3431
3432
3433 void
3434 ProcessorBox::clear_processors ()
3435 {
3436         string prompt;
3437         vector<string> choices;
3438
3439         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3440                                    "(this cannot be undone)"), _route->name());
3441
3442         choices.push_back (_("Cancel"));
3443         choices.push_back (_("Yes, remove them all"));
3444
3445         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3446
3447         if (prompter.run () == 1) {
3448                 _route->clear_processors (PreFader);
3449                 _route->clear_processors (PostFader);
3450         }
3451 }
3452
3453 void
3454 ProcessorBox::clear_processors (Placement p)
3455 {
3456         string prompt;
3457         vector<string> choices;
3458
3459         if (p == PreFader) {
3460                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3461                                            "(this cannot be undone)"), _route->name());
3462         } else {
3463                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3464                                            "(this cannot be undone)"), _route->name());
3465         }
3466
3467         choices.push_back (_("Cancel"));
3468         choices.push_back (_("Yes, remove them all"));
3469
3470         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3471
3472         if (prompter.run () == 1) {
3473                 _route->clear_processors (p);
3474         }
3475 }
3476
3477 bool
3478 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3479 {
3480         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3481         if (at && at->freeze_state() == AudioTrack::Frozen) {
3482                 return false;
3483         }
3484
3485         if (
3486                 boost::dynamic_pointer_cast<Send> (processor) ||
3487                 boost::dynamic_pointer_cast<Return> (processor) ||
3488                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3489                 boost::dynamic_pointer_cast<PortInsert> (processor)
3490                 ) {
3491                 return true;
3492         }
3493
3494         return false;
3495 }
3496
3497 bool
3498 ProcessorBox::one_processor_can_be_edited ()
3499 {
3500         list<ProcessorEntry*> selection = processor_display.selection ();
3501         list<ProcessorEntry*>::iterator i = selection.begin();
3502         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3503                 ++i;
3504         }
3505
3506         return (i != selection.end());
3507 }
3508
3509 Gtk::Window*
3510 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3511 {
3512         boost::shared_ptr<Send> send;
3513         boost::shared_ptr<InternalSend> internal_send;
3514         boost::shared_ptr<Return> retrn;
3515         boost::shared_ptr<PluginInsert> plugin_insert;
3516         boost::shared_ptr<PortInsert> port_insert;
3517         Window* gidget = 0;
3518
3519         /* This method may or may not return a Window, but if it does not it
3520          * will modify the parent mixer strip appearance layout to allow
3521          * "editing" the @param processor that was passed in.
3522          *
3523          * So for example, if the processor is an Amp (gain), the parent strip
3524          * will be forced back into a model where the fader controls the main gain.
3525          * If the processor is a send, then we map the send controls onto the
3526          * strip.
3527          *
3528          * Plugins and others will return a window for control.
3529          */
3530
3531         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3532
3533                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3534                         return 0;
3535                 }
3536         }
3537
3538         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3539
3540                 if (_parent_strip) {
3541                         _parent_strip->revert_to_default_display ();
3542                 }
3543
3544         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3545
3546                 if (!_session->engine().connected()) {
3547                         return 0;
3548                 }
3549
3550                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3551
3552                         gidget = new SendUIWindow (send, _session);
3553                 }
3554
3555         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3556
3557                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3558                         /* no GUI for these */
3559                         return 0;
3560                 }
3561
3562                 if (!_session->engine().connected()) {
3563                         return 0;
3564                 }
3565
3566                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3567
3568                 ReturnUIWindow *return_ui;
3569                 Window* w = get_processor_ui (retrn);
3570
3571                 if (w == 0) {
3572
3573                         return_ui = new ReturnUIWindow (retrn, _session);
3574                         return_ui->set_title (retrn->name ());
3575                         set_processor_ui (send, return_ui);
3576
3577                 } else {
3578                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
3579                 }
3580
3581                 gidget = return_ui;
3582
3583         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3584
3585                 PluginUIWindow *plugin_ui;
3586
3587                 /* these are both allowed to be null */
3588
3589                 Window* w = get_processor_ui (plugin_insert);
3590
3591                 if (w == 0) {
3592                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3593                         plugin_ui->set_title (generate_processor_title (plugin_insert));
3594                         set_processor_ui (plugin_insert, plugin_ui);
3595
3596                 } else {
3597                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3598                 }
3599
3600                 gidget = plugin_ui;
3601
3602         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3603
3604                 if (!_session->engine().connected()) {
3605                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3606                         msg.run ();
3607                         return 0;
3608                 }
3609
3610                 PortInsertWindow *io_selector;
3611
3612                 Window* w = get_processor_ui (port_insert);
3613
3614                 if (w == 0) {
3615                         io_selector = new PortInsertWindow (_session, port_insert);
3616                         set_processor_ui (port_insert, io_selector);
3617
3618                 } else {
3619                         io_selector = dynamic_cast<PortInsertWindow *> (w);
3620                 }
3621
3622                 gidget = io_selector;
3623         }
3624
3625         return gidget;
3626 }
3627
3628 Gtk::Window*
3629 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3630 {
3631         boost::shared_ptr<PluginInsert> plugin_insert
3632                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3633
3634         if (!plugin_insert) {
3635                 return 0;
3636         }
3637
3638         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3639         win->set_title (generate_processor_title (plugin_insert));
3640
3641         return win;
3642 }
3643
3644 void
3645 ProcessorBox::register_actions ()
3646 {
3647         processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3648
3649         Glib::RefPtr<Action> act;
3650
3651         /* new stuff */
3652         myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3653                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3654
3655         act = myactions.register_action (processor_box_actions, X_("newlua"), _("New Lua DSP"),
3656                         sigc::ptr_fun (ProcessorBox::rb_choose_lua));
3657         act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3658                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3659         ActionManager::engine_sensitive_actions.push_back (act);
3660         act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3661                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
3662         ActionManager::engine_sensitive_actions.push_back (act);
3663
3664         myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3665
3666         myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3667         myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3668
3669         myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3670                         sigc::ptr_fun (ProcessorBox::rb_clear));
3671         myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3672                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3673         myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3674                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
3675
3676         /* standard editing stuff */
3677
3678         cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3679                                                             sigc::ptr_fun (ProcessorBox::rb_cut));
3680         copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3681                                                              sigc::ptr_fun (ProcessorBox::rb_copy));
3682         delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3683                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3684
3685         ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3686         ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3687         ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3688
3689         paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3690                         sigc::ptr_fun (ProcessorBox::rb_paste));
3691         rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3692                         sigc::ptr_fun (ProcessorBox::rb_rename));
3693         myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3694                         sigc::ptr_fun (ProcessorBox::rb_select_all));
3695         myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3696                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3697
3698         /* activation etc. */
3699
3700         myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3701                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
3702         myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3703                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3704         myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3705                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3706
3707         manage_pins_action = myactions.register_action (
3708                 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3709                 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3710
3711         /* show editors */
3712         edit_action = myactions.register_action (
3713                 processor_box_actions, X_("edit"), _("Edit..."),
3714                 sigc::ptr_fun (ProcessorBox::rb_edit));
3715
3716         edit_generic_action = myactions.register_action (
3717                 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3718                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3719
3720         load_bindings ();
3721 }
3722
3723 void
3724 ProcessorBox::rb_edit_generic ()
3725 {
3726         if (_current_processor_box == 0) {
3727                 return;
3728         }
3729
3730         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3731 }
3732
3733 void
3734 ProcessorBox::rb_ab_plugins ()
3735 {
3736         if (_current_processor_box == 0) {
3737                 return;
3738         }
3739
3740         _current_processor_box->ab_plugins ();
3741 }
3742
3743 void
3744 ProcessorBox::rb_manage_pins ()
3745 {
3746         if (_current_processor_box == 0) {
3747                 return;
3748         }
3749
3750         _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3751 }
3752 void
3753 ProcessorBox::rb_choose_plugin ()
3754 {
3755         if (_current_processor_box == 0) {
3756                 return;
3757         }
3758         _current_processor_box->choose_plugin ();
3759 }
3760
3761 void
3762 ProcessorBox::rb_choose_lua ()
3763 {
3764         if (_current_processor_box == 0) {
3765                 return;
3766         }
3767         _current_processor_box->choose_lua ();
3768 }
3769
3770 void
3771 ProcessorBox::rb_choose_insert ()
3772 {
3773         if (_current_processor_box == 0) {
3774                 return;
3775         }
3776         _current_processor_box->choose_insert ();
3777 }
3778
3779 void
3780 ProcessorBox::rb_choose_send ()
3781 {
3782         if (_current_processor_box == 0) {
3783                 return;
3784         }
3785         _current_processor_box->choose_send ();
3786 }
3787
3788 void
3789 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3790 {
3791         if (_current_processor_box == 0) {
3792                 return;
3793         }
3794
3795         _current_processor_box->choose_aux (wr);
3796 }
3797
3798 void
3799 ProcessorBox::rb_clear ()
3800 {
3801         if (_current_processor_box == 0) {
3802                 return;
3803         }
3804
3805         _current_processor_box->clear_processors ();
3806 }
3807
3808
3809 void
3810 ProcessorBox::rb_clear_pre ()
3811 {
3812         if (_current_processor_box == 0) {
3813                 return;
3814         }
3815
3816         _current_processor_box->clear_processors (PreFader);
3817 }
3818
3819
3820 void
3821 ProcessorBox::rb_clear_post ()
3822 {
3823         if (_current_processor_box == 0) {
3824                 return;
3825         }
3826
3827         _current_processor_box->clear_processors (PostFader);
3828 }
3829
3830 void
3831 ProcessorBox::rb_cut ()
3832 {
3833         if (_current_processor_box == 0) {
3834                 return;
3835         }
3836
3837         _current_processor_box->processor_operation (ProcessorsCut);
3838 }
3839
3840 void
3841 ProcessorBox::rb_delete ()
3842 {
3843         if (_current_processor_box == 0) {
3844                 return;
3845         }
3846
3847         _current_processor_box->processor_operation (ProcessorsDelete);
3848 }
3849
3850 void
3851 ProcessorBox::rb_copy ()
3852 {
3853         if (_current_processor_box == 0) {
3854                 return;
3855         }
3856         _current_processor_box->processor_operation (ProcessorsCopy);
3857 }
3858
3859 void
3860 ProcessorBox::rb_paste ()
3861 {
3862         if (_current_processor_box == 0) {
3863                 return;
3864         }
3865
3866         _current_processor_box->processor_operation (ProcessorsPaste);
3867 }
3868
3869 void
3870 ProcessorBox::rb_rename ()
3871 {
3872         if (_current_processor_box == 0) {
3873                 return;
3874         }
3875         _current_processor_box->rename_processors ();
3876 }
3877
3878 void
3879 ProcessorBox::rb_select_all ()
3880 {
3881         if (_current_processor_box == 0) {
3882                 return;
3883         }
3884
3885         _current_processor_box->processor_operation (ProcessorsSelectAll);
3886 }
3887
3888 void
3889 ProcessorBox::rb_deselect_all ()
3890 {
3891         if (_current_processor_box == 0) {
3892                 return;
3893         }
3894
3895         _current_processor_box->deselect_all_processors ();
3896 }
3897
3898 void
3899 ProcessorBox::rb_activate_all ()
3900 {
3901         if (_current_processor_box == 0) {
3902                 return;
3903         }
3904
3905         _current_processor_box->all_visible_processors_active (true);
3906 }
3907
3908 void
3909 ProcessorBox::rb_deactivate_all ()
3910 {
3911         if (_current_processor_box == 0) {
3912                 return;
3913         }
3914         _current_processor_box->all_visible_processors_active (false);
3915 }
3916
3917 void
3918 ProcessorBox::rb_edit ()
3919 {
3920         if (_current_processor_box == 0) {
3921                 return;
3922         }
3923
3924         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3925 }
3926
3927 bool
3928 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3929 {
3930         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3931                 return false;
3932         }
3933
3934         if (_parent_strip) {
3935                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3936                 if (_parent_strip->current_delivery() == send) {
3937                         _parent_strip->revert_to_default_display ();
3938                 } else {
3939                         _parent_strip->show_send(send);
3940                 }
3941         }
3942         return true;
3943 }
3944
3945 void
3946 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3947 {
3948         if (!processor) {
3949                 return;
3950         }
3951         if (edit_aux_send (processor)) {
3952                 return;
3953         }
3954
3955         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3956
3957         if (proxy) {
3958                 proxy->set_custom_ui_mode (true);
3959                 proxy->show_the_right_window ();
3960         }
3961 }
3962
3963 void
3964 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3965 {
3966         if (!processor) {
3967                 return;
3968         }
3969         if (edit_aux_send (processor)) {
3970                 return;
3971         }
3972
3973         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3974
3975         if (proxy) {
3976                 proxy->set_custom_ui_mode (false);
3977                 proxy->show_the_right_window ();
3978         }
3979 }
3980
3981 void
3982 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3983 {
3984         if (!processor) {
3985                 return;
3986         }
3987         PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3988         if (proxy) {
3989                 proxy->get (true);
3990                 proxy->present();
3991         }
3992 }
3993
3994
3995 void
3996 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3997 {
3998         if (!what_changed.contains (ARDOUR::Properties::name)) {
3999                 return;
4000         }
4001
4002         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
4003
4004         boost::shared_ptr<Processor> processor;
4005         boost::shared_ptr<PluginInsert> plugin_insert;
4006         boost::shared_ptr<Send> send;
4007
4008         list<ProcessorEntry*> children = processor_display.children();
4009
4010         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
4011
4012                 processor = (*iter)->processor ();
4013
4014                 if (!processor) {
4015                         continue;
4016                 }
4017
4018                 Window* w = get_processor_ui (processor);
4019
4020                 if (!w) {
4021                         continue;
4022                 }
4023
4024                 /* rename editor windows for sends and plugins */
4025
4026                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4027                         w->set_title (send->name ());
4028                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4029                         w->set_title (generate_processor_title (plugin_insert));
4030                 }
4031         }
4032 }
4033
4034 string
4035 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4036 {
4037         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4038         string::size_type email_pos;
4039
4040         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4041                 maker = maker.substr (0, email_pos - 1);
4042         }
4043
4044         if (maker.length() > 32) {
4045                 maker = maker.substr (0, 32);
4046                 maker += " ...";
4047         }
4048
4049         SessionObject* owner = pi->owner();
4050
4051         if (owner) {
4052                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4053         } else {
4054                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4055         }
4056 }
4057
4058 /** @param p Processor.
4059  *  @return the UI window for \a p.
4060  */
4061 Window *
4062 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4063 {
4064         ProcessorWindowProxy* wp = p->window_proxy();
4065         if (wp) {
4066                 return wp->get ();
4067         }
4068         return 0;
4069 }
4070
4071 /** Make a note of the UI window that a processor is using.
4072  *  @param p Processor.
4073  *  @param w UI window.
4074  */
4075 void
4076 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4077 {
4078         assert (p->window_proxy());
4079         p->set_ui (w);
4080         p->window_proxy()->use_window (*w);
4081 }
4082
4083 void
4084 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4085 {
4086         boost::shared_ptr<Delivery> d = w.lock ();
4087         if (!d) {
4088                 return;
4089         }
4090
4091         list<ProcessorEntry*> children = processor_display.children ();
4092         list<ProcessorEntry*>::const_iterator i = children.begin();
4093         while (i != children.end() && (*i)->processor() != d) {
4094                 ++i;
4095         }
4096
4097         if (i == children.end()) {
4098                 processor_display.set_active (0);
4099         } else {
4100                 processor_display.set_active (*i);
4101         }
4102 }
4103
4104 /** Called to repair the damage of Editor::show_window doing a show_all() */
4105 void
4106 ProcessorBox::hide_things ()
4107 {
4108         list<ProcessorEntry*> c = processor_display.children ();
4109         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4110                 (*i)->hide_things ();
4111         }
4112 }
4113
4114 void
4115 ProcessorBox::processor_menu_unmapped ()
4116 {
4117         processor_display.remove_placeholder ();
4118         /* make all possibly-desensitized actions sensitive again so that
4119            they be activated by other means (e.g. bindings)
4120         */
4121         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4122 }
4123
4124 XMLNode *
4125 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4126 {
4127         if (!_parent_strip) {
4128                 return 0;
4129         }
4130
4131         GUIObjectState& st = _parent_strip->gui_object_state ();
4132
4133         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4134         assert (strip);
4135         return st.get_or_add_node (strip, entry->state_id());
4136 }
4137
4138 void
4139 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4140 {
4141         XMLNode* proc = entry_gui_object_state (entry);
4142         if (!proc) {
4143                 return;
4144         }
4145
4146         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4147         proc->remove_nodes_and_delete (X_("Object"));
4148         entry->add_control_state (proc);
4149 }
4150
4151 bool
4152 ProcessorBox::is_editor_mixer_strip() const
4153 {
4154         return _parent_strip && !_parent_strip->mixer_owned();
4155 }
4156
4157 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4158         : WM::ProxyBase (name, string())
4159         , _processor_box (box)
4160         , _processor (processor)
4161         , is_custom (false)
4162         , want_custom (false)
4163 {
4164         boost::shared_ptr<Processor> p = _processor.lock ();
4165         if (!p) {
4166                 return;
4167         }
4168         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4169 }
4170
4171 ProcessorWindowProxy::~ProcessorWindowProxy()
4172 {
4173         /* processor window proxies do not own the windows they create with
4174          * ::get(), so set _window to null before the normal WindowProxy method
4175          * deletes it.
4176          */
4177         _window = 0;
4178 }
4179
4180 void
4181 ProcessorWindowProxy::processor_going_away ()
4182 {
4183         delete _window;
4184         _window = 0;
4185         WM::Manager::instance().remove (this);
4186         /* should be no real reason to do this, since the object that would
4187            send DropReferences is about to be deleted, but lets do it anyway.
4188         */
4189         going_away_connection.disconnect();
4190 }
4191
4192 ARDOUR::SessionHandlePtr*
4193 ProcessorWindowProxy::session_handle()
4194 {
4195         /* we don't care */
4196         return 0;
4197 }
4198
4199 XMLNode&
4200 ProcessorWindowProxy::get_state ()
4201 {
4202         XMLNode *node;
4203         node = &ProxyBase::get_state();
4204         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4205         return *node;
4206 }
4207
4208 int
4209 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4210 {
4211         XMLNodeList children = node.children ();
4212         XMLNodeList::const_iterator i = children.begin ();
4213         while (i != children.end()) {
4214                 XMLProperty* prop = (*i)->property (X_("name"));
4215                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4216                         break;
4217                 }
4218                 ++i;
4219         }
4220
4221         if (i != children.end()) {
4222                 XMLProperty* prop;
4223                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4224                         want_custom = PBD::string_is_affirmative (prop->value ());
4225                 }
4226         }
4227
4228         return ProxyBase::set_state (node, 0);
4229 }
4230
4231 Gtk::Window*
4232 ProcessorWindowProxy::get (bool create)
4233 {
4234         boost::shared_ptr<Processor> p = _processor.lock ();
4235
4236         if (!p) {
4237                 return 0;
4238         }
4239         if (_window && (is_custom != want_custom)) {
4240                 /* drop existing window - wrong type */
4241                 drop_window ();
4242         }
4243
4244         if (!_window) {
4245                 if (!create) {
4246                         return 0;
4247                 }
4248
4249                 is_custom = want_custom;
4250                 _window = _processor_box->get_editor_window (p, is_custom);
4251
4252                 if (_window) {
4253                         setup ();
4254                 }
4255                 _window->show_all ();
4256         }
4257         return _window;
4258 }
4259
4260 void
4261 ProcessorWindowProxy::show_the_right_window ()
4262 {
4263         if (_window && (is_custom != want_custom)) {
4264                 /* drop existing window - wrong type */
4265                 drop_window ();
4266                 get (true);
4267                 setup ();
4268                 assert (_window);
4269                 is_custom = want_custom;
4270         }
4271
4272         toggle ();
4273 }
4274
4275
4276 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4277         : WM::ProxyBase (name, string())
4278         , _processor (processor)
4279 {
4280         boost::shared_ptr<Processor> p = _processor.lock ();
4281         if (!p) {
4282                 return;
4283         }
4284         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4285 }
4286
4287 PluginPinWindowProxy::~PluginPinWindowProxy()
4288 {
4289         _window = 0;
4290 }
4291
4292 ARDOUR::SessionHandlePtr*
4293 PluginPinWindowProxy::session_handle ()
4294 {
4295         ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4296         if (aw) { return aw; }
4297         return 0;
4298 }
4299
4300 Gtk::Window*
4301 PluginPinWindowProxy::get (bool create)
4302 {
4303         boost::shared_ptr<Processor> p = _processor.lock ();
4304         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4305         if (!p || !pi) {
4306                 return 0;
4307         }
4308
4309         if (!_window) {
4310                 if (!create) {
4311                         return 0;
4312                 }
4313                 _window = new PluginPinDialog (pi);
4314                 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4315                 if (aw) {
4316                         aw->set_session (_session);
4317                 }
4318                 _window->show_all ();
4319         }
4320         return _window;
4321 }
4322
4323 void
4324 PluginPinWindowProxy::processor_going_away ()
4325 {
4326         delete _window;
4327         _window = 0;
4328         WM::Manager::instance().remove (this);
4329         going_away_connection.disconnect();
4330 }
4331
4332 void
4333 ProcessorBox::load_bindings ()
4334 {
4335         bindings = Bindings::get_bindings (X_("Processor Box"), myactions);
4336 }