move VCA assignment up to Route level
[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()) {
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 const * 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 const * 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 (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1128                 return false;
1129         }
1130         if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1131                 return true;
1132         }
1133         return false;
1134 }
1135
1136 void
1137 ProcessorEntry::RoutingIcon::set_fed_by (
1138                                 const ARDOUR::ChanCount& out,
1139                                 const ARDOUR::ChanCount& sources,
1140                                 const ARDOUR::ChanMapping& out_map,
1141                                 const ARDOUR::ChanMapping& thru_map)
1142 {
1143         _f_out      = out;
1144         _f_sources  = sources;
1145         _f_out_map  = out_map;
1146         _f_thru_map = thru_map;
1147         _fed_by     = true;
1148 }
1149
1150 void
1151 ProcessorEntry::RoutingIcon::set_feeding (
1152                                 const ARDOUR::ChanCount& in,
1153                                 const ARDOUR::ChanCount& sinks,
1154                                 const ARDOUR::ChanMapping& in_map,
1155                                 const ARDOUR::ChanMapping& thru_map)
1156 {
1157         _i_in       = in;
1158         _i_sinks    = sinks;
1159         _i_in_map   = in_map;
1160         _i_thru_map = thru_map;
1161         _feeding    = true;
1162 }
1163
1164 double
1165 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1166 {
1167         if (!midi) { i += n_midi; }
1168         if (n_total == 1) {
1169                 assert (i == 0);
1170                 return rint (width * .5) +.5;
1171         }
1172         return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1173 }
1174
1175 void
1176 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1177 {
1178         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1179         const double y1 = rint (height * .66) + .5;
1180
1181         cairo_save (cr);
1182         cairo_translate (cr, x0, y0);
1183         cairo_move_to (cr, 0, height);
1184         cairo_line_to (cr, 0, y1);
1185         cairo_move_to (cr, 0 - dx, y1);
1186         cairo_line_to (cr, 0 + dx, y1);
1187
1188         set_routing_color (cr, midi);
1189         cairo_set_line_width (cr, 1.0);
1190         cairo_stroke (cr);
1191         cairo_restore (cr);
1192 }
1193
1194 void
1195 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1196 {
1197         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1198         const double y1 = rint (height * .5) - .5;
1199
1200         cairo_save (cr);
1201         cairo_translate (cr, x0, y0);
1202         cairo_move_to (cr, 0 - dx, height);
1203         cairo_line_to (cr, 0, y1);
1204         cairo_line_to (cr, 0 + dx, height);
1205         cairo_close_path (cr);
1206
1207         set_routing_color (cr, midi);
1208         cairo_fill (cr);
1209         cairo_restore (cr);
1210 }
1211
1212 void
1213 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1214 {
1215         const double rad = 1;
1216         const double y1 = height - rad - 1.5;
1217
1218         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1219         cairo_move_to (cr, x0, y0 + height - 1.5);
1220         cairo_line_to (cr, x0, y0 + height);
1221         set_routing_color (cr, midi);
1222         cairo_set_line_width  (cr, 1.0);
1223         cairo_stroke (cr);
1224 }
1225
1226 void
1227 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1228 {
1229         const double rad = 1;
1230         const double y1 = rad + 1;
1231
1232         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1233         cairo_move_to (cr, x0, y0);
1234         cairo_line_to (cr, x0, y0 + 1);
1235         set_routing_color (cr, midi);
1236         cairo_set_line_width  (cr, 1.0);
1237         cairo_stroke (cr);
1238 }
1239
1240 void
1241 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1242 {
1243         double bz = abs (y1 - y0);
1244
1245         cairo_move_to (cr, x0, y0);
1246         cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1247         cairo_set_line_width  (cr, 1.0);
1248         cairo_set_line_cap  (cr,  CAIRO_LINE_CAP_ROUND);
1249         cairo_set_source_rgb (cr, 1, 0, 0);
1250         if (dashed) {
1251                 const double dashes[] = { 2, 3 };
1252                 cairo_set_dash (cr, dashes, 2, 0);
1253         }
1254         set_routing_color (cr, midi);
1255         cairo_stroke (cr);
1256         if (dashed) {
1257                 cairo_set_dash (cr, 0, 0, 0);
1258         }
1259 }
1260
1261 bool
1262 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1263 {
1264         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1265
1266         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1267         cairo_clip (cr);
1268
1269         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1270
1271         Gtk::Allocation a = get_allocation();
1272         double const width = a.get_width();
1273         double const height = a.get_height();
1274
1275         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1276         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1277
1278         cairo_rectangle (cr, 0, 0, width, height);
1279         cairo_fill (cr);
1280
1281         if (_input) {
1282                 if (can_coalesce ()) {
1283                         expose_coalesced_input_map (cr, width, height);
1284                 } else {
1285                         expose_input_map (cr, width, height);
1286                 }
1287         } else {
1288                 expose_output_map (cr, width, height);
1289         }
1290
1291         cairo_destroy(cr);
1292         return true;
1293 }
1294
1295 void
1296 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1297 {
1298         const uint32_t pc_in = _sinks.n_total();
1299         const uint32_t pc_in_midi = _sinks.n_midi();
1300
1301         for (uint32_t i = 0; i < pc_in; ++i) {
1302                 const bool is_midi = i < pc_in_midi;
1303                 bool valid_in;
1304                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1305                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1306                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1307                 if (!valid_in) {
1308                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1309                         draw_gnd (cr, x, 0, height, is_midi);
1310                         continue;
1311                 }
1312                 if (idx >= _in.get (dt)) {
1313                         // side-chain, probably
1314                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1315                         draw_sidechain (cr, x, 0, height, is_midi);
1316                         continue;
1317                 }
1318                 double c_x0;
1319                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1320
1321                 if (_fed_by) {
1322                         bool valid_src;
1323                         uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1324                         if (!valid_src) {
1325                                 double x = pin_x_pos (i, width, pc_in, 0, false);
1326                                 bool valid_thru;
1327                                 _f_thru_map.get (dt, idx, &valid_thru);
1328                                 if (valid_thru) {
1329                                         draw_thru_src (cr, x, 0, height, is_midi);
1330                                 } else {
1331                                         draw_gnd (cr, x, 0, height, is_midi);
1332                                 }
1333                                 continue;
1334                         }
1335                         c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1336                 } else {
1337                         c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1338                 }
1339                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1340         }
1341 }
1342
1343 void
1344 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1345 {
1346         const uint32_t n_in = _in.n_total();
1347         const uint32_t n_in_midi = _in.n_midi();
1348         const uint32_t pc_in = _sinks.n_total();
1349         const uint32_t pc_in_midi = _sinks.n_midi();
1350
1351         // draw inputs to this
1352         for (uint32_t i = 0; i < pc_in; ++i) {
1353                 const bool is_midi = i < pc_in_midi;
1354                 bool valid_in;
1355                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1356                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1357                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1358                 // check if it's fed
1359                 bool valid_src = true;
1360                 if (valid_in && idx < _in.get (dt) && _fed_by) {
1361                         bool valid_out;
1362                         bool valid_thru;
1363                         _f_out_map.get_src (dt, idx, &valid_out);
1364                         _f_thru_map.get (dt, idx, &valid_thru);
1365                         if (!valid_out && !valid_thru) {
1366                                 valid_src = false;
1367                         }
1368                 }
1369                 if (!valid_in || !valid_src) {
1370                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1371                         draw_gnd (cr, x, 0, height, is_midi);
1372                         continue;
1373                 }
1374                 if (idx >= _in.get (dt)) {
1375                         // side-chain, probably
1376                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1377                         draw_sidechain (cr, x, 0, height, is_midi);
1378                         continue;
1379                 }
1380                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1381                 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1382                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1383         }
1384
1385         // draw reverse thru
1386         for (uint32_t i = 0; i < n_in; ++i) {
1387                 const bool is_midi = i < n_in_midi;
1388                 bool valid_thru;
1389                 uint32_t pn = is_midi ? i : i - n_in_midi;
1390                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1391                 _thru_map.get_src (dt, pn, &valid_thru);
1392                 if (!valid_thru) {
1393                         continue;
1394                 }
1395                 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1396                 draw_thru_sink (cr, x, 0, height, is_midi);
1397         }
1398 }
1399
1400 void
1401 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1402 {
1403         int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1404         double ht = _terminal ? height - dh : height;
1405
1406         // draw outputs of this
1407         const uint32_t pc_out = _sources.n_total();
1408         const uint32_t pc_out_midi = _sources.n_midi();
1409         const uint32_t n_out = _out.n_total();
1410         const uint32_t n_out_midi = _out.n_midi();
1411
1412         for (uint32_t i = 0; i < pc_out; ++i) {
1413                 const bool is_midi = i < pc_out_midi;
1414                 bool valid_out;
1415                 uint32_t pn = is_midi ? i : i - pc_out_midi;
1416                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1417                 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1418                 if (!valid_out) {
1419                         continue;
1420                 }
1421                 // skip connections that are not used in the next's input
1422                 if (_feeding) {
1423                         bool valid_thru, valid_sink;
1424                         _i_in_map.get_src (dt, idx, &valid_sink);
1425                         _i_thru_map.get_src (dt, idx, &valid_thru);
1426                         if (!valid_thru && !valid_sink) {
1427                                 if (!is_midi || i != 0) { // special case midi-bypass
1428                                         continue;
1429                                 }
1430                         }
1431                 }
1432                 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1433                 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1434                 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1435         }
1436
1437         for (uint32_t i = 0; i < n_out; ++i) {
1438                 const bool is_midi = i < n_out_midi;
1439                 uint32_t pn = is_midi ? i : i - n_out_midi;
1440                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1441                 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1442
1443                 if (!_terminal) {
1444                         bool valid_thru_f = false;
1445                         // skip connections that are not used in the next's input
1446                         if (_feeding) {
1447                                 bool valid_sink;
1448                                 _i_in_map.get_src (dt, pn, &valid_sink);
1449                                 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1450                                 if (!valid_thru_f && !valid_sink) {
1451                                         if (!is_midi || i != 0) { // special case midi-bypass
1452                                                 continue;
1453                                         }
1454                                 }
1455                         }
1456
1457                         bool valid_src;
1458                         _out_map.get_src (dt, pn, &valid_src);
1459                         if (!valid_src) {
1460                                 bool valid_thru;
1461                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1462                                 if (valid_thru) {
1463                                         if (idx >= _in.get (dt)) {
1464                                                 draw_sidechain (cr, x, 0, height, is_midi);
1465                                         } else {
1466                                                 draw_thru_src (cr, x, 0, height, is_midi);
1467                                         }
1468                                 } else if (valid_thru_f){
1469                                         // gnd is part of input, unless it's a thru input
1470                                         // (also only true if !coalesced into one small display)
1471                                         draw_gnd (cr, x, 0, height, is_midi);
1472                                 }
1473                         }
1474                 } else {
1475                         // terminal node, add arrows
1476                         bool valid_src;
1477                         _out_map.get_src (dt, pn, &valid_src);
1478                         if (!valid_src) {
1479                                 bool valid_thru;
1480                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1481                                 if (valid_thru) {
1482                                         if (idx >= _in.get (dt)) {
1483                                                 draw_sidechain (cr, x, 0, height - dh, is_midi);
1484                                         } else {
1485                                                 draw_thru_src (cr, x, 0, height - dh, is_midi);
1486                                         }
1487                                 } else {
1488                                         draw_gnd (cr, x, 0, height - dh, is_midi);
1489                                 }
1490                         }
1491
1492                         set_routing_color (cr, is_midi);
1493                         cairo_set_line_width (cr, 1.0);
1494                         cairo_move_to (cr, x, height - dh);
1495                         cairo_line_to (cr, x, height - 2);
1496                         cairo_stroke (cr);
1497
1498                         const double ar = dh - 1;
1499                         cairo_move_to (cr, x - ar, height - ar);
1500                         cairo_line_to (cr, x     , height - .5);
1501                         cairo_line_to (cr, x + ar, height - ar);
1502                         cairo_line_to (cr, x     , height - ar * .5);
1503                         cairo_close_path (cr);
1504                         cairo_fill_preserve (cr);
1505                         cairo_stroke (cr);
1506                 }
1507         }
1508 }
1509
1510 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1511         : _plug (p)
1512         , _surf (0)
1513         , _max_height (max_height)
1514         , _cur_height (1)
1515         , _scroll (false)
1516 {
1517         set_name ("processor prefader");
1518         _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1519                         boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1520 }
1521
1522 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1523 {
1524         if (_surf) {
1525                 cairo_surface_destroy (_surf);
1526         }
1527 }
1528
1529 void
1530 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1531 {
1532         req->width = 56;
1533         req->height = _cur_height;
1534 }
1535
1536
1537 void
1538 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1539 {
1540         /* work-around scroll-bar + aspect ratio
1541          * show inline-view -> height changes -> scrollbar gets added
1542          * -> width changes -> inline-view, fixed aspect ratio -> height changes
1543          * -> scroll bar is removed [-> width changes ; repeat ]
1544          */
1545         uint32_t shm = std::min (_max_height, inline_height);
1546         bool sc = false;
1547         Gtk::Container* pr = get_parent();
1548         for (uint32_t i = 0; i < 4 && pr; ++i) {
1549                 // VBox, EventBox, ViewPort, ScrolledWindow
1550                 pr = pr->get_parent();
1551         }
1552         Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1553         if (sw) {
1554                 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1555                 sc = vsb && vsb->is_visible();
1556         }
1557
1558         if (shm != _cur_height) {
1559                 if (_scroll == sc || _cur_height < shm) {
1560                         queue_resize ();
1561                 }
1562                 _cur_height = shm;
1563         }
1564         _scroll = sc;
1565 }
1566
1567 uint32_t
1568 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1569 {
1570         Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1571         if (!dis) {
1572                 return 0;
1573         }
1574
1575         /* allocate a local image-surface,
1576          * We cannot re-use the data via cairo_image_surface_create_for_data(),
1577          * since pixman keeps a reference to it.
1578          * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1579          * it might be possible to work around via cairo_surface_set_user_data().
1580          */
1581         if (!_surf
1582                         || dis->width !=  cairo_image_surface_get_width (_surf)
1583                         || dis->height !=  cairo_image_surface_get_height (_surf)
1584                  ) {
1585                 if (_surf) {
1586                         cairo_surface_destroy (_surf);
1587                 }
1588                 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1589         }
1590
1591         if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1592                 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1593         } else {
1594                 unsigned char *src = dis->data;
1595                 unsigned char *dst = cairo_image_surface_get_data (_surf);
1596                 const int dst_stride =  cairo_image_surface_get_stride (_surf);
1597                 for (int y = 0; y < dis->height; ++y) {
1598                         memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1599                         src += dis->stride;
1600                         dst += dst_stride;
1601                 }
1602         }
1603
1604         cairo_surface_mark_dirty(_surf);
1605         const double xc = floor ((width - dis->width) * .5);
1606         cairo_set_source_surface(cr, _surf, xc, 0);
1607         cairo_paint (cr);
1608
1609         return dis->height;
1610 }
1611
1612 bool
1613 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1614 {
1615         Gtk::Allocation a = get_allocation();
1616         double const width = a.get_width();
1617         double const height = a.get_height();
1618
1619         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1620         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1621         cairo_clip (cr);
1622
1623         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1624         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1625         cairo_rectangle (cr, 0, 0, width, height);
1626         cairo_fill (cr);
1627
1628         cairo_save (cr);
1629         cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1630         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1631         cairo_clip (cr);
1632         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1633
1634         uint32_t ht = render_inline (cr, width);
1635         cairo_restore (cr);
1636
1637         if (ht == 0) {
1638                 hide ();
1639                 if (_cur_height != 1) {
1640                         _cur_height = 1;
1641                         queue_resize ();
1642                 }
1643                 cairo_destroy (cr);
1644                 return true;
1645         } else {
1646                 update_height_alloc (ht);
1647         }
1648
1649         bool failed = false;
1650         std::string name = get_name();
1651         ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1652
1653         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1654         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1655         cairo_set_line_width(cr, 1.0);
1656         ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1657         cairo_stroke (cr);
1658
1659         cairo_destroy(cr);
1660         return true;
1661 }
1662
1663 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1664         : PluginDisplay (p, max_height)
1665         , _luaproc (p)
1666         , _lua_render_inline (0)
1667 {
1668         p->setup_lua_inline_gui (&lua_gui);
1669
1670         lua_State* LG = lua_gui.getState ();
1671         LuaInstance::bind_cairo (LG);
1672         luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1673         assert (lua_render.isFunction ());
1674         _lua_render_inline = new luabridge::LuaRef (lua_render);
1675 }
1676
1677 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1678 {
1679         delete (_lua_render_inline);
1680 }
1681
1682 uint32_t
1683 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1684 {
1685         Cairo::Context ctx (cr);
1686         try {
1687                 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1688                 if (rv.isTable ()) {
1689                         uint32_t h = rv[2];
1690                         return h;
1691                 }
1692         } catch (luabridge::LuaException const& e) {
1693 #ifndef NDEBUG
1694                 cerr << "LuaException:" << e.what () << endl;
1695 #endif
1696         }
1697         return 0;
1698 }
1699
1700
1701 static std::list<Gtk::TargetEntry> drop_targets()
1702 {
1703         std::list<Gtk::TargetEntry> tmp;
1704         tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1705         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1706         tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1707         return tmp;
1708 }
1709
1710 static std::list<Gtk::TargetEntry> drag_targets()
1711 {
1712         std::list<Gtk::TargetEntry> tmp;
1713         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1714         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1715         return tmp;
1716 }
1717
1718 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1719 {
1720         std::list<Gtk::TargetEntry> tmp;
1721         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1722         return tmp;
1723 }
1724
1725 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1726                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1727         : _parent_strip (parent)
1728         , _owner_is_mixer (owner_is_mixer)
1729         , ab_direction (true)
1730         , _get_plugin_selector (get_plugin_selector)
1731         , _placement (-1)
1732         , _visible_prefader_processors (0)
1733         , _rr_selection(rsel)
1734         , processor_display (drop_targets())
1735         , _redisplay_pending (false)
1736 {
1737         set_session (sess);
1738
1739         /* ProcessorBox actions and bindings created statically by call to
1740          * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1741          * are available for context menus.
1742          */
1743
1744         processor_display.set_data ("ardour-bindings", bindings);
1745
1746         _width = Wide;
1747         processor_menu = 0;
1748         no_processor_redisplay = false;
1749
1750         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1751         processor_scroller.add (processor_display);
1752         pack_start (processor_scroller, true, true);
1753
1754         processor_display.set_flags (CAN_FOCUS);
1755         processor_display.set_name ("ProcessorList");
1756         processor_display.set_data ("processorbox", this);
1757         processor_display.set_size_request (48, -1);
1758         processor_display.set_spacing (0);
1759
1760         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1761         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1762
1763         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1764         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1765
1766         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1767         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1768         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1769
1770         processor_scroller.show ();
1771         processor_display.show ();
1772
1773         if (parent) {
1774                 parent->DeliveryChanged.connect (
1775                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1776                         );
1777         }
1778
1779         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1780 }
1781
1782 ProcessorBox::~ProcessorBox ()
1783 {
1784         /* it may appear as if we should delete processor_menu but that is a
1785          * pointer to a widget owned by the UI Manager, and has potentially
1786          * be returned to many other ProcessorBoxes. GTK doesn't really make
1787          * clear the ownership of this widget, which is a menu and thus is
1788          * never packed into any container other than an implict GtkWindow.
1789          *
1790          * For now, until or if we ever get clarification over the ownership
1791          * story just let it continue to exist. At worst, its a small memory leak.
1792          */
1793 }
1794
1795 void
1796 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1797 {
1798         if (_route == r) {
1799                 return;
1800         }
1801
1802         _route_connections.drop_connections();
1803
1804         /* new route: any existing block on processor redisplay must be meaningless */
1805         no_processor_redisplay = false;
1806         _route = r;
1807
1808         _route->processors_changed.connect (
1809                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1810                 );
1811
1812         _route->DropReferences.connect (
1813                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1814                 );
1815
1816         _route->PropertyChanged.connect (
1817                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1818                 );
1819
1820         redisplay_processors ();
1821 }
1822
1823 void
1824 ProcessorBox::route_going_away ()
1825 {
1826         /* don't keep updating display as processors are deleted */
1827         no_processor_redisplay = true;
1828         _route.reset ();
1829 }
1830
1831 boost::shared_ptr<Processor>
1832 ProcessorBox::find_drop_position (ProcessorEntry* position)
1833 {
1834         boost::shared_ptr<Processor> p;
1835         if (position) {
1836                 p = position->processor ();
1837                 if (!p) {
1838                         /* dropped on the blank entry (which will be before the
1839                                  fader), so use the first non-blank child as our
1840                                  `dropped on' processor */
1841                         list<ProcessorEntry*> c = processor_display.children ();
1842                         list<ProcessorEntry*>::iterator i = c.begin ();
1843
1844                         assert (i != c.end ());
1845                         p = (*i)->processor ();
1846                         assert (p);
1847                 }
1848         }
1849         return p;
1850 }
1851
1852 void
1853 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1854 {
1855                 const void * d = data.get_data();
1856                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1857
1858                 PluginPresetList nfos;
1859                 TreeView* source;
1860                 tv->get_object_drag_data (nfos, &source);
1861
1862                 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1863                         PluginPresetPtr ppp = (*i);
1864                         PluginInfoPtr pip = ppp->_pip;
1865                         PluginPtr p = pip->load (*_session);
1866                         if (!p) {
1867                                 continue;
1868                         }
1869
1870                         if (ppp->_preset.valid) {
1871                                 p->load_preset (ppp->_preset);
1872                         }
1873
1874                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1875                         if (Config->get_new_plugins_active ()) {
1876                                 processor->activate ();
1877                         }
1878                         pl.push_back (processor);
1879                 }
1880 }
1881
1882 void
1883 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1884 {
1885                 const void * d = data.get_data();
1886                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1887                 PluginInfoList nfos;
1888
1889                 TreeView* source;
1890                 tv->get_object_drag_data (nfos, &source);
1891
1892                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1893                         PluginPtr p = (*i)->load (*_session);
1894                         if (!p) {
1895                                 continue;
1896                         }
1897                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1898                         if (Config->get_new_plugins_active ()) {
1899                                 processor->activate ();
1900                         }
1901                         pl.push_back (processor);
1902                 }
1903 }
1904
1905 void
1906 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1907 {
1908         if (!_session) {
1909                 return;
1910         }
1911
1912         boost::shared_ptr<Processor> p = find_drop_position (position);
1913         Route::ProcessorList pl;
1914
1915         if (data.get_target() == "PluginInfoPtr") {
1916                 _drop_plugin (data, pl);
1917         }
1918         else if (data.get_target() == "PluginFavoritePtr") {
1919                 _drop_plugin_preset (data, pl);
1920         }
1921         else {
1922                 return;
1923         }
1924
1925         Route::ProcessorStreams err;
1926         if (_route->add_processors (pl, p, &err)) {
1927                 string msg = _(
1928                                 "Processor Drag/Drop failed. Probably because\n\
1929 the I/O configuration of the plugins could\n\
1930 not match the configuration of this track.");
1931                 MessageDialog am (msg);
1932                 am.run ();
1933         }
1934 }
1935
1936 void
1937 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1938 {
1939         if (Gdk::ACTION_LINK == context->get_selected_action()) {
1940                 list<ProcessorEntry*> children = source->selection ();
1941                 assert (children.size() == 1);
1942                 ProcessorEntry* other = *children.begin();
1943                 assert (other->can_copy_state (position));
1944                 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1945                 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1946                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1947                 assert (otherproc && proc && pi);
1948
1949                 PBD::ID id = pi->id();
1950                 XMLNode& state = otherproc->get_state ();
1951                 /* strip side-chain state (processor inside processor must be a side-chain)
1952                  * otherwise we'll end up with duplicate ports-names.
1953                  * (this needs a better solution which retains connections)
1954                  */
1955                 state.remove_nodes ("Processor");
1956                 proc->set_state (state, Stateful::loading_state_version);
1957                 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1958                 return;
1959         }
1960
1961         boost::shared_ptr<Processor> p = find_drop_position (position);
1962
1963         list<ProcessorEntry*> children = source->selection ();
1964         list<boost::shared_ptr<Processor> > procs;
1965         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1966                 if ((*i)->processor ()) {
1967                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1968                                 continue;
1969                         }
1970                         procs.push_back ((*i)->processor ());
1971                 }
1972         }
1973
1974         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1975                 XMLNode& state = (*i)->get_state ();
1976                 XMLNodeList nlist;
1977                 nlist.push_back (&state);
1978                 paste_processor_state (nlist, p);
1979                 delete &state;
1980         }
1981
1982         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1983            ourselves.
1984         */
1985
1986         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1987                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1988                 if (other) {
1989                         other->delete_dragged_processors (procs);
1990                 }
1991         }
1992 }
1993
1994 void
1995 ProcessorBox::set_width (Width w)
1996 {
1997         if (_width == w) {
1998                 return;
1999         }
2000
2001         _width = w;
2002
2003         list<ProcessorEntry*> children = processor_display.children ();
2004         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2005                 (*i)->set_enum_width (w);
2006         }
2007
2008         queue_resize ();
2009 }
2010
2011 Gtk::Menu*
2012 ProcessorBox::build_possible_aux_menu ()
2013 {
2014         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2015
2016         if (rl->empty()) {
2017                 /* No aux sends if there are no busses */
2018                 return 0;
2019         }
2020
2021         if (_route->is_monitor ()) {
2022                 return 0;
2023         }
2024
2025         using namespace Menu_Helpers;
2026         Menu* menu = manage (new Menu);
2027         MenuList& items = menu->items();
2028
2029         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2030                 if (!_route->internal_send_for (*r) && *r != _route) {
2031                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2032                 }
2033         }
2034
2035         return menu;
2036 }
2037
2038 void
2039 ProcessorBox::show_processor_menu (int arg)
2040 {
2041         if (processor_menu == 0) {
2042                 processor_menu = build_processor_menu ();
2043                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2044         }
2045
2046         /* Sort out the plugin submenu */
2047
2048         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2049
2050         if (plugin_menu_item) {
2051                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2052         }
2053
2054         /* And the aux submenu */
2055
2056         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2057
2058         if (aux_menu_item) {
2059                 Menu* m = build_possible_aux_menu();
2060                 if (m && !m->items().empty()) {
2061                         aux_menu_item->set_submenu (*m);
2062                         aux_menu_item->set_sensitive (true);
2063                 } else {
2064                         /* stupid gtkmm: we need to pass a null reference here */
2065                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2066                         aux_menu_item->set_sensitive (false);
2067                 }
2068         }
2069
2070         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2071         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2072
2073         ProcessorEntry* single_selection = 0;
2074         if (processor_display.selection().size() == 1) {
2075                 single_selection = processor_display.selection().front();
2076         }
2077
2078         /* And the controls submenu */
2079
2080         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2081
2082         if (controls_menu_item) {
2083                 if (single_selection) {
2084                         Menu* m = single_selection->build_controls_menu ();
2085                         if (m && !m->items().empty()) {
2086                                 controls_menu_item->set_submenu (*m);
2087                                 controls_menu_item->set_sensitive (true);
2088                         } else {
2089                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2090                                 controls_menu_item->set_sensitive (false);
2091                         }
2092                 } else {
2093                         controls_menu_item->set_sensitive (false);
2094                 }
2095         }
2096
2097
2098         if (!ARDOUR::Profile->get_mixbus()) {
2099                 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2100                 if (send_menu_item) {
2101                         if (single_selection && !_route->is_monitor()) {
2102                                 Menu* m = single_selection->build_send_options_menu ();
2103                                 if (m && !m->items().empty()) {
2104                                         send_menu_item->set_submenu (*m);
2105                                         send_menu_item->set_sensitive (true);
2106                                 } else {
2107                                         gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2108                                         send_menu_item->set_sensitive (false);
2109                                 }
2110                         } else {
2111                                 send_menu_item->set_sensitive (false);
2112                         }
2113                 }
2114         }
2115
2116         /* Sensitise actions as approprioate */
2117
2118
2119         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2120
2121         paste_action->set_sensitive (!_rr_selection.processors.empty());
2122         cut_action->set_sensitive (sensitive && can_cut ());
2123         copy_action->set_sensitive (sensitive);
2124         delete_action->set_sensitive (sensitive || stub_processor_selected ());
2125
2126         edit_action->set_sensitive (one_processor_can_be_edited ());
2127         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2128
2129         boost::shared_ptr<PluginInsert> pi;
2130         if (single_selection) {
2131                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2132         }
2133
2134         manage_pins_action->set_sensitive (pi != 0);
2135
2136         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2137         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2138
2139         /* disallow rename for multiple selections, for plugin inserts and for the fader */
2140         rename_action->set_sensitive (single_selection
2141                         && !pi
2142                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2143                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2144
2145         processor_menu->popup (1, arg);
2146
2147         /* Add a placeholder gap to the processor list to indicate where a processor would be
2148            inserted were one chosen from the menu.
2149         */
2150         int x, y;
2151         processor_display.get_pointer (x, y);
2152         _placement = processor_display.add_placeholder (y);
2153
2154         if (_visible_prefader_processors == 0 && _placement > 0) {
2155                 --_placement;
2156         }
2157 }
2158
2159 bool
2160 ProcessorBox::enter_notify (GdkEventCrossing*)
2161 {
2162         processor_display.grab_focus ();
2163         _current_processor_box = this;
2164         return false;
2165 }
2166
2167 bool
2168 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2169 {
2170         if (ev->detail == GDK_NOTIFY_INFERIOR) {
2171                 return false;
2172         }
2173
2174         Widget* top = get_toplevel();
2175
2176         if (top->is_toplevel()) {
2177                 Window* win = dynamic_cast<Window*> (top);
2178                 gtk_window_set_focus (win->gobj(), 0);
2179         }
2180
2181         return false;
2182 }
2183
2184 bool
2185 ProcessorBox::processor_operation (ProcessorOperation op)
2186 {
2187         ProcSelection targets;
2188
2189         get_selected_processors (targets);
2190
2191 /*      if (targets.empty()) {
2192
2193                 int x, y;
2194                 processor_display.get_pointer (x, y);
2195
2196                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2197
2198                 if (pointer.first && pointer.first->processor()) {
2199                         targets.push_back (pointer.first->processor ());
2200                 }
2201         }
2202 */
2203
2204         if ((op == ProcessorsDelete) && targets.empty()) {
2205                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
2206         }
2207
2208         switch (op) {
2209         case ProcessorsSelectAll:
2210                 processor_display.select_all ();
2211                 break;
2212
2213         case ProcessorsSelectNone:
2214                 processor_display.select_none ();
2215                 break;
2216
2217         case ProcessorsCopy:
2218                 copy_processors (targets);
2219                 break;
2220
2221         case ProcessorsCut:
2222                 cut_processors (targets);
2223                 break;
2224
2225         case ProcessorsPaste:
2226                 // some processors are not selectable (e.g fader, meter), target is empty.
2227                 if (targets.empty() && _placement >= 0) {
2228                         assert (_route);
2229                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2230                         if (proc) {
2231                                 targets.push_back (proc);
2232                         }
2233                 }
2234                 if (targets.empty()) {
2235                         paste_processors ();
2236                 } else {
2237                         paste_processors (targets.front());
2238                 }
2239                 break;
2240
2241         case ProcessorsDelete:
2242                 delete_processors (targets);
2243                 break;
2244
2245         case ProcessorsToggleActive:
2246                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2247                         if ((*i)->active()) {
2248                                 (*i)->deactivate ();
2249                         } else {
2250                                 (*i)->activate ();
2251                         }
2252                 }
2253                 break;
2254
2255         case ProcessorsAB:
2256                 ab_plugins ();
2257                 break;
2258
2259         default:
2260                 break;
2261         }
2262
2263         return true;
2264 }
2265
2266 ProcessorWindowProxy*
2267 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2268 {
2269         return  processor->window_proxy();
2270 }
2271
2272
2273 bool
2274 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2275 {
2276         boost::shared_ptr<Processor> processor;
2277         if (child) {
2278                 processor = child->processor ();
2279         }
2280
2281         int ret = false;
2282         bool selected = processor_display.selected (child);
2283
2284         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2285
2286                 if (_session->engine().connected()) {
2287                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2288
2289                         if (!one_processor_can_be_edited ()) {
2290                                 return true;
2291                         }
2292
2293                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2294                                 generic_edit_processor (processor);
2295                         } else {
2296                                 edit_processor (processor);
2297                         }
2298                 }
2299
2300                 ret = true;
2301
2302         } else if (Keyboard::is_context_menu_event (ev)) {
2303
2304                 show_processor_menu (ev->time);
2305
2306                 ret = true;
2307
2308         } else if (processor && ev->button == 1 && selected) {
2309
2310                 // this is purely informational but necessary for route params UI
2311                 ProcessorSelected (processor); // emit
2312
2313         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2314
2315                 choose_plugin ();
2316                 _get_plugin_selector()->show_manager ();
2317         }
2318
2319         return ret;
2320 }
2321
2322 bool
2323 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2324 {
2325         boost::shared_ptr<Processor> processor;
2326         if (child) {
2327                 processor = child->processor ();
2328         }
2329
2330         if (processor && Keyboard::is_delete_event (ev)) {
2331
2332                 Glib::signal_idle().connect (sigc::bind (
2333                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2334                                 boost::weak_ptr<Processor>(processor)));
2335
2336         } else if (processor && Keyboard::is_button2_event (ev)
2337 #ifndef __APPLE__
2338                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2339 #endif
2340                 ) {
2341
2342                 /* button2-click with no/appropriate modifiers */
2343
2344                 if (processor->active()) {
2345                         processor->deactivate ();
2346                 } else {
2347                         processor->activate ();
2348                 }
2349         }
2350
2351         return false;
2352 }
2353
2354 Menu *
2355 ProcessorBox::build_processor_menu ()
2356 {
2357         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2358         processor_menu->set_name ("ArdourContextMenu");
2359         return processor_menu;
2360 }
2361
2362 void
2363 ProcessorBox::select_all_processors ()
2364 {
2365         processor_display.select_all ();
2366 }
2367
2368 void
2369 ProcessorBox::deselect_all_processors ()
2370 {
2371         processor_display.select_none ();
2372 }
2373
2374 void
2375 ProcessorBox::choose_plugin ()
2376 {
2377         _get_plugin_selector()->set_interested_object (*this);
2378 }
2379
2380 /** @return true if an error occurred, otherwise false */
2381 bool
2382 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2383 {
2384         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2385
2386                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2387
2388                 Route::ProcessorStreams err_streams;
2389
2390                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2391                         weird_plugin_dialog (**p, err_streams);
2392                         return true;
2393                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
2394                 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2395                         if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2396                                 ;
2397                         } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2398                                 if ((*p)->has_editor ()) {
2399                                         edit_processor (processor);
2400                                 } else {
2401                                         generic_edit_processor (processor);
2402                                 }
2403                         }
2404                 }
2405         }
2406
2407         return false;
2408 }
2409
2410 void
2411 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2412 {
2413         ArdourDialog dialog (_("Plugin Incompatibility"));
2414         Label label;
2415
2416         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2417                         p.name(), streams.index);
2418
2419         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2420         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2421
2422         text += _("\nThis plugin has:\n");
2423         if (has_midi) {
2424                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2425                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2426         }
2427         if (has_audio) {
2428                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2429                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2430         }
2431
2432         text += _("\nbut at the insertion point, there are:\n");
2433         if (has_midi) {
2434                 uint32_t const n = streams.count.n_midi ();
2435                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2436         }
2437         if (has_audio) {
2438                 uint32_t const n = streams.count.n_audio ();
2439                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2440         }
2441
2442         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2443         label.set_text(text);
2444
2445         dialog.get_vbox()->pack_start (label);
2446         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2447
2448         dialog.set_name (X_("PluginIODialog"));
2449         dialog.set_modal (true);
2450         dialog.show_all ();
2451
2452         dialog.run ();
2453 }
2454
2455 void
2456 ProcessorBox::choose_insert ()
2457 {
2458         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2459         _route->add_processor_by_index (processor, _placement);
2460 }
2461
2462 /* Caller must not hold process lock */
2463 void
2464 ProcessorBox::choose_send ()
2465 {
2466         boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2467
2468         /* make an educated guess at the initial number of outputs for the send */
2469         ChanCount outs = (_session->master_out())
2470                         ? _session->master_out()->n_outputs()
2471                         : _route->n_outputs();
2472
2473         /* XXX need processor lock on route */
2474         try {
2475                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2476                 send->output()->ensure_io (outs, false, this);
2477         } catch (AudioEngine::PortRegistrationFailure& err) {
2478                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2479                 return;
2480         }
2481
2482         /* let the user adjust the IO setup before creation.
2483
2484            Note: this dialog is NOT modal - we just leave it to run and it will
2485            return when its Finished signal is emitted - typically when the window
2486            is closed.
2487          */
2488
2489         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2490         ios->show ();
2491
2492         /* keep a reference to the send so it doesn't get deleted while
2493            the IOSelectorWindow is doing its stuff
2494         */
2495         _processor_being_created = send;
2496
2497         ios->selector().Finished.connect (sigc::bind (
2498                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2499                         boost::weak_ptr<Processor>(send), ios));
2500
2501 }
2502
2503 void
2504 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2505 {
2506         boost::shared_ptr<Processor> processor (weak_processor.lock());
2507
2508         /* drop our temporary reference to the new send */
2509         _processor_being_created.reset ();
2510
2511         if (!processor) {
2512                 return;
2513         }
2514
2515         switch (r) {
2516         case IOSelector::Cancelled:
2517                 // processor will go away when all shared_ptrs to it vanish
2518                 break;
2519
2520         case IOSelector::Accepted:
2521                 _route->add_processor_by_index (processor, _placement);
2522                 break;
2523         }
2524
2525         delete_when_idle (ios);
2526 }
2527
2528 void
2529 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2530 {
2531         boost::shared_ptr<Processor> processor (weak_processor.lock());
2532
2533         /* drop our temporary reference to the new return */
2534         _processor_being_created.reset ();
2535
2536         if (!processor) {
2537                 return;
2538         }
2539
2540         switch (r) {
2541         case IOSelector::Cancelled:
2542                 // processor will go away when all shared_ptrs to it vanish
2543                 break;
2544
2545         case IOSelector::Accepted:
2546                 _route->add_processor_by_index (processor, _placement);
2547                 break;
2548         }
2549
2550         delete_when_idle (ios);
2551 }
2552
2553 void
2554 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2555 {
2556         if (!_route) {
2557                 return;
2558         }
2559
2560         boost::shared_ptr<Route> target = wr.lock();
2561
2562         if (!target) {
2563                 return;
2564         }
2565
2566         _session->add_internal_send (target, _placement, _route);
2567 }
2568
2569 void
2570 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2571 {
2572         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2573                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2574                 return;
2575         }
2576
2577         redisplay_processors ();
2578 }
2579
2580 void
2581 ProcessorBox::redisplay_processors ()
2582 {
2583         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2584         bool     fader_seen;
2585
2586         if (no_processor_redisplay) {
2587                 return;
2588         }
2589
2590         processor_display.clear ();
2591
2592         _visible_prefader_processors = 0;
2593         fader_seen = false;
2594
2595         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2596                                                &_visible_prefader_processors, &fader_seen));
2597
2598         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2599         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2600         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2601
2602         setup_entry_positions ();
2603 }
2604
2605 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2606  *  not already have one.
2607  */
2608 void
2609 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2610 {
2611         boost::shared_ptr<Processor> p = w.lock ();
2612         if (!p) {
2613                 return;
2614         }
2615         if (p->window_proxy()) {
2616                 return;
2617         }
2618
2619         /* not on the list; add it */
2620
2621         string loc;
2622 #if 0 // is this still needed? Why?
2623         if (_parent_strip) {
2624                 if (_parent_strip->mixer_owned()) {
2625                         loc = X_("M");
2626                 } else {
2627                         loc = X_("R");
2628                 }
2629         } else {
2630                 loc = X_("P");
2631         }
2632 #else
2633         loc = X_("P");
2634 #endif
2635
2636         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2637                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2638                 this,
2639                 w);
2640
2641         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2642
2643         if (ui_xml) {
2644                 wp->set_state (*ui_xml, 0);
2645         }
2646
2647         void* existing_ui = p->get_ui ();
2648
2649         if (existing_ui) {
2650                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2651         }
2652
2653         p->set_window_proxy (wp);
2654         WM::Manager::instance().register_window (wp);
2655 }
2656
2657 void
2658 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2659 {
2660         boost::shared_ptr<Processor> p = w.lock ();
2661         if (!p || p->pinmgr_proxy ()) {
2662                 return;
2663         }
2664
2665         PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2666                         string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2667         wp->set_session (_session);
2668
2669         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2670         if (ui_xml) {
2671                 wp->set_state (*ui_xml, 0);
2672         }
2673
2674         p->set_pingmgr_proxy (wp);
2675         WM::Manager::instance().register_window (wp);
2676 }
2677 void
2678 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2679 {
2680         boost::shared_ptr<Processor> processor (p.lock ());
2681
2682         if (processor && ( processor->display_to_user()
2683 #ifndef NDEBUG
2684                             || show_all_processors
2685 #endif
2686                          )
2687            ) {
2688
2689                 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2690                     boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2691                         *amp_seen = true;
2692                 } else {
2693                         if (!*amp_seen) {
2694                                 (*cnt)++;
2695                         }
2696                 }
2697         }
2698 }
2699
2700 void
2701 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2702 {
2703         boost::shared_ptr<Processor> processor (p.lock ());
2704
2705         if (!processor || ( !processor->display_to_user()
2706 #ifndef NDEBUG
2707                             && !show_all_processors
2708 #endif
2709                           )
2710            ) {
2711                 return;
2712         }
2713
2714         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2715
2716         ProcessorEntry* e = 0;
2717         if (plugin_insert) {
2718                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2719         } else {
2720                 e = new ProcessorEntry (this, processor, _width);
2721         }
2722
2723         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2724         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2725         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2726
2727         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2728         if (!send && !plugin_insert && !ext && !stub)
2729                 e->set_selectable(false);
2730
2731         bool mark_send_visible = false;
2732         if (send && _parent_strip) {
2733                 /* show controls of new sends by default */
2734                 GUIObjectState& st = _parent_strip->gui_object_state ();
2735                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2736                 assert (strip);
2737                 /* check if state exists, if not it must be a new send */
2738                 if (!st.get_node(strip, e->state_id())) {
2739                         mark_send_visible = true;
2740                 }
2741         }
2742
2743         /* Set up this entry's state from the GUIObjectState */
2744         XMLNode* proc = entry_gui_object_state (e);
2745         if (proc) {
2746                 e->set_control_state (proc);
2747         }
2748
2749         if (mark_send_visible) {
2750                 e->show_all_controls ();
2751         }
2752
2753         if (plugin_insert
2754 #ifdef MIXBUS
2755                         && !plugin_insert->plugin(0)->is_channelstrip()
2756 #endif
2757                  )
2758         {
2759                 processor_display.add_child (e, drag_targets());
2760         } else {
2761                 processor_display.add_child (e, drag_targets_noplugin());
2762         }
2763 }
2764
2765 void
2766 ProcessorBox::reordered ()
2767 {
2768         compute_processor_sort_keys ();
2769         setup_entry_positions ();
2770 }
2771
2772 void
2773 ProcessorBox::setup_routing_feeds ()
2774 {
2775         list<ProcessorEntry*> children = processor_display.children ();
2776         /* first set the i/o maps for every processor */
2777         list<ProcessorEntry*>::iterator prev = children.begin();
2778
2779         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2780                 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2781                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2782
2783                 list<ProcessorEntry*>::iterator next = i;
2784                 next++;
2785
2786                 if (pi) {
2787                         ChanCount sinks = pi->natural_input_streams ();
2788                         ChanCount sources = pi->natural_output_streams ();
2789                         uint32_t count = pi->get_count ();
2790                         ChanCount in, out;
2791                         pi->configured_io (in, out);
2792
2793                         ChanCount midi_thru;
2794                         ChanCount midi_bypass;
2795                         ChanMapping input_map (pi->input_map ());
2796                         if (pi->has_midi_thru ()) {
2797                                  midi_thru.set(DataType::MIDI, 1);
2798                                  input_map.set (DataType::MIDI, 0, 0);
2799                         }
2800                         if (pi->has_midi_bypass ()) {
2801                                  midi_bypass.set(DataType::MIDI, 1);
2802                         }
2803
2804                         (*i)->input_icon.set_ports (sinks * count + midi_thru);
2805                         (*i)->output_icon.set_ports (sources * count + midi_bypass);
2806
2807                         (*i)->routing_icon.set (
2808                                         in, out,
2809                                         sinks * count + midi_thru,
2810                                         sources * count + midi_bypass,
2811                                         input_map,
2812                                         pi->output_map (),
2813                                         pi->thru_map ());
2814
2815                         if (next != children.end()) {
2816                                 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2817                                                 pi->output_map (), pi->thru_map ());
2818                         }
2819
2820                         if (prev != i) {
2821                                 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2822                                                 pi->input_map (), pi->thru_map ());
2823                         }
2824
2825                 } else {
2826                         (*i)->input_icon.set_ports (p->input_streams());
2827                         (*i)->output_icon.set_ports (p->output_streams());
2828                         ChanMapping inmap (p->input_streams ());
2829                         ChanMapping outmap (p->input_streams ());
2830                         ChanMapping thrumap;
2831                         (*i)->routing_icon.set (
2832                                         p->input_streams(),
2833                                         p->output_streams(),
2834                                         p->input_streams(),
2835                                         p->output_streams(),
2836                                         inmap, outmap, thrumap);
2837
2838                         if (next != children.end()) {
2839                                 (*next)->routing_icon.set_fed_by (
2840                                                 p->output_streams(),
2841                                                 p->output_streams(),
2842                                                 outmap, thrumap);
2843                         }
2844                         if (prev != i) {
2845                                 (*prev)->routing_icon.set_feeding (
2846                                                 p->input_streams(),
2847                                                 p->output_streams(),
2848                                                 inmap, thrumap);
2849                         }
2850                 }
2851
2852                 if (i == children.begin()) {
2853                         (*i)->routing_icon.unset_fed_by ();
2854                 }
2855                 prev = i;
2856                 (*i)->input_icon.hide();
2857         }
2858
2859         /* now set which icons need to be displayed */
2860         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2861                 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2862
2863                 if ((*i)->routing_icon.in_identity ()) {
2864                         (*i)->routing_icon.hide();
2865                         if (i == children.begin()) {
2866                                 (*i)->input_icon.show();
2867                         }
2868                 } else {
2869                         (*i)->routing_icon.show();
2870                         (*i)->routing_icon.queue_draw();
2871                         (*i)->input_icon.show();
2872                 }
2873
2874                 list<ProcessorEntry*>::iterator next = i;
2875                 if (++next == children.end()) {
2876                         // last processor in the chain
2877                         (*i)->output_routing_icon.set_terminal(true);
2878                         (*i)->output_routing_icon.unset_feeding ();
2879                         if ((*i)->routing_icon.out_identity ()) {
2880                                 (*i)->output_routing_icon.hide();
2881                         } else {
2882                                 (*i)->output_routing_icon.show();
2883                                 (*i)->output_routing_icon.queue_draw();
2884                         }
2885                 } else {
2886                         (*i)->output_routing_icon.set_terminal(false);
2887                         if (   !(*i)->routing_icon.out_identity ()
2888                                         && !(*next)->routing_icon.in_identity ()
2889                                         &&  (*next)->routing_icon.can_coalesce ()) {
2890                                 (*i)->output_routing_icon.hide();
2891                         } else if (!(*i)->routing_icon.out_identity ()) {
2892                                 (*i)->output_routing_icon.show();
2893                                 (*i)->output_routing_icon.queue_draw();
2894                                 (*next)->input_icon.show();
2895                         } else {
2896                                 (*i)->output_routing_icon.hide();
2897                         }
2898                 }
2899         }
2900 }
2901
2902 void
2903 ProcessorBox::setup_entry_positions ()
2904 {
2905         list<ProcessorEntry*> children = processor_display.children ();
2906         bool pre_fader = true;
2907
2908         uint32_t num = 0;
2909         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2910                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2911                     boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2912                         pre_fader = false;
2913                         (*i)->set_position (ProcessorEntry::Fader, num++);
2914                 } else {
2915                         if (pre_fader) {
2916                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
2917                         } else {
2918                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
2919                         }
2920                 }
2921         }
2922         setup_routing_feeds ();
2923 }
2924
2925 void
2926 ProcessorBox::compute_processor_sort_keys ()
2927 {
2928         list<ProcessorEntry*> children = processor_display.children ();
2929         Route::ProcessorList our_processors;
2930
2931         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2932                 if ((*i)->processor()) {
2933                         our_processors.push_back ((*i)->processor ());
2934                 }
2935         }
2936
2937         if (_route->reorder_processors (our_processors)) {
2938                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
2939                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
2940                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
2941                    when the drag is torn down after this handler function is finished.
2942                 */
2943                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2944         }
2945 }
2946
2947 void
2948 ProcessorBox::report_failed_reorder ()
2949 {
2950         /* reorder failed, so redisplay */
2951
2952         redisplay_processors ();
2953
2954         /* now tell them about the problem */
2955
2956         ArdourDialog dialog (_("Plugin Incompatibility"));
2957         Label label;
2958
2959         label.set_text (_("\
2960 You cannot reorder these plugins/sends/inserts\n\
2961 in that way because the inputs and\n\
2962 outputs will not work correctly."));
2963
2964         dialog.get_vbox()->set_border_width (12);
2965         dialog.get_vbox()->pack_start (label);
2966         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2967
2968         dialog.set_name (X_("PluginIODialog"));
2969         dialog.set_modal (true);
2970         dialog.show_all ();
2971
2972         dialog.run ();
2973 }
2974
2975 void
2976 ProcessorBox::rename_processors ()
2977 {
2978         ProcSelection to_be_renamed;
2979
2980         get_selected_processors (to_be_renamed);
2981
2982         if (to_be_renamed.empty()) {
2983                 return;
2984         }
2985
2986         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2987                 rename_processor (*i);
2988         }
2989 }
2990
2991 bool
2992 ProcessorBox::can_cut () const
2993 {
2994         vector<boost::shared_ptr<Processor> > sel;
2995
2996         get_selected_processors (sel);
2997
2998         /* cut_processors () does not cut inserts */
2999
3000         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3001
3002                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3003                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3004                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3005                         return true;
3006                 }
3007         }
3008
3009         return false;
3010 }
3011
3012 bool
3013 ProcessorBox::stub_processor_selected () const
3014 {
3015         vector<boost::shared_ptr<Processor> > sel;
3016
3017         get_selected_processors (sel);
3018
3019         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3020                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3021                         return true;
3022                 }
3023         }
3024
3025         return false;
3026 }
3027
3028 void
3029 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3030 {
3031         if (to_be_removed.empty()) {
3032                 return;
3033         }
3034
3035         XMLNode* node = new XMLNode (X_("cut"));
3036         Route::ProcessorList to_cut;
3037
3038         no_processor_redisplay = true;
3039         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3040                 // Cut only plugins, sends and returns
3041                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3042                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3043                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3044
3045                         Window* w = get_processor_ui (*i);
3046
3047                         if (w) {
3048                                 w->hide ();
3049                         }
3050
3051                         XMLNode& child ((*i)->get_state());
3052                         node->add_child_nocopy (child);
3053                         to_cut.push_back (*i);
3054                 }
3055         }
3056
3057         if (_route->remove_processors (to_cut) != 0) {
3058                 delete node;
3059                 no_processor_redisplay = false;
3060                 return;
3061         }
3062
3063         _rr_selection.set (node);
3064
3065         no_processor_redisplay = false;
3066         redisplay_processors ();
3067 }
3068
3069 void
3070 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3071 {
3072         if (to_be_copied.empty()) {
3073                 return;
3074         }
3075
3076         XMLNode* node = new XMLNode (X_("copy"));
3077
3078         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3079                 // Copy only plugins, sends, returns
3080                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3081                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3082                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3083                         node->add_child_nocopy ((*i)->get_state());
3084                 }
3085         }
3086
3087         _rr_selection.set (node);
3088 }
3089
3090 void
3091 ProcessorBox::delete_processors (const ProcSelection& targets)
3092 {
3093         if (targets.empty()) {
3094                 return;
3095         }
3096
3097         no_processor_redisplay = true;
3098
3099         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3100
3101                 Window* w = get_processor_ui (*i);
3102
3103                 if (w) {
3104                         w->hide ();
3105                 }
3106
3107                 _route->remove_processor(*i);
3108         }
3109
3110         no_processor_redisplay = false;
3111         redisplay_processors ();
3112 }
3113
3114 void
3115 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3116 {
3117         list<boost::shared_ptr<Processor> >::const_iterator x;
3118
3119         no_processor_redisplay = true;
3120         for (x = procs.begin(); x != procs.end(); ++x) {
3121
3122                 Window* w = get_processor_ui (*x);
3123
3124                 if (w) {
3125                         w->hide ();
3126                 }
3127
3128                 _route->remove_processor(*x);
3129         }
3130
3131         no_processor_redisplay = false;
3132         redisplay_processors ();
3133 }
3134
3135 gint
3136 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3137 {
3138         boost::shared_ptr<Processor> processor (weak_processor.lock());
3139
3140         if (!processor) {
3141                 return false;
3142         }
3143
3144         /* NOT copied to _mixer.selection() */
3145
3146         no_processor_redisplay = true;
3147         _route->remove_processor (processor);
3148         no_processor_redisplay = false;
3149         redisplay_processors ();
3150
3151         return false;
3152 }
3153
3154 void
3155 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3156 {
3157         ArdourPrompter name_prompter (true);
3158         string result;
3159         name_prompter.set_title (_("Rename Processor"));
3160         name_prompter.set_prompt (_("New name:"));
3161         name_prompter.set_initial_text (processor->name());
3162         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3163         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3164         name_prompter.show_all ();
3165
3166         switch (name_prompter.run ()) {
3167
3168         case Gtk::RESPONSE_ACCEPT:
3169                 name_prompter.get_result (result);
3170                 if (result.length()) {
3171
3172                        int tries = 0;
3173                        string test = result;
3174
3175                        while (tries < 100) {
3176                                if (_session->io_name_is_legal (test)) {
3177                                        result = test;
3178                                        break;
3179                                }
3180                                tries++;
3181
3182                                test = string_compose ("%1-%2", result, tries);
3183                        }
3184
3185                        if (tries < 100) {
3186                                processor->set_name (result);
3187                        } else {
3188                                /* unlikely! */
3189                                ARDOUR_UI::instance()->popup_error
3190                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3191                        }
3192                 }
3193                 break;
3194         }
3195
3196         return;
3197 }
3198
3199 void
3200 ProcessorBox::paste_processors ()
3201 {
3202         if (_rr_selection.processors.empty()) {
3203                 return;
3204         }
3205
3206         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3207 }
3208
3209 void
3210 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3211 {
3212
3213         if (_rr_selection.processors.empty()) {
3214                 return;
3215         }
3216
3217         paste_processor_state (_rr_selection.processors.get_node().children(), before);
3218 }
3219
3220 void
3221 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3222 {
3223         XMLNodeConstIterator niter;
3224         list<boost::shared_ptr<Processor> > copies;
3225
3226         if (nlist.empty()) {
3227                 return;
3228         }
3229
3230         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3231
3232                 XMLProperty const * type = (*niter)->property ("type");
3233                 XMLProperty const * role = (*niter)->property ("role");
3234                 assert (type);
3235
3236                 boost::shared_ptr<Processor> p;
3237                 try {
3238                         if (type->value() == "meter" ||
3239                             type->value() == "main-outs" ||
3240                             type->value() == "amp" ||
3241                             type->value() == "intreturn") {
3242                                 /* do not paste meter, main outs, amp or internal returns */
3243                                 continue;
3244
3245                         } else if (type->value() == "intsend") {
3246
3247                                 /* aux sends are OK, but those used for
3248                                  * other purposes, are not.
3249                                  */
3250
3251                                 assert (role);
3252
3253                                 if (role->value() != "Aux") {
3254                                         continue;
3255                                 }
3256
3257                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3258                                 XMLNode n (**niter);
3259                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3260                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3261
3262                                 IOProcessor::prepare_for_reset (n, s->name());
3263
3264                                 if (s->set_state (n, Stateful::loading_state_version)) {
3265                                         delete s;
3266                                         return;
3267                                 }
3268
3269                                 p.reset (s);
3270
3271                         } else if (type->value() == "send") {
3272
3273                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3274                                 XMLNode n (**niter);
3275
3276                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3277
3278                                 IOProcessor::prepare_for_reset (n, s->name());
3279
3280                                 if (s->set_state (n, Stateful::loading_state_version)) {
3281                                         delete s;
3282                                         return;
3283                                 }
3284
3285                                 p.reset (s);
3286
3287                         } else if (type->value() == "return") {
3288
3289                                 XMLNode n (**niter);
3290                                 Return* r = new Return (*_session);
3291
3292                                 IOProcessor::prepare_for_reset (n, r->name());
3293
3294                                 if (r->set_state (n, Stateful::loading_state_version)) {
3295                                         delete r;
3296                                         return;
3297                                 }
3298
3299                                 p.reset (r);
3300
3301                         } else if (type->value() == "port") {
3302
3303                                 XMLNode n (**niter);
3304                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3305
3306                                 IOProcessor::prepare_for_reset (n, pi->name());
3307
3308                                 if (pi->set_state (n, Stateful::loading_state_version)) {
3309                                         return;
3310                                 }
3311
3312                                 p.reset (pi);
3313                         } else {
3314                                 /* XXX its a bit limiting to assume that everything else
3315                                    is a plugin.
3316                                 */
3317                                 p.reset (new PluginInsert (*_session));
3318                                 /* we can't use RAII Stateful::ForceIDRegeneration
3319                                  * because that'd void copying the state and wrongly bump
3320                                  * the state-version counter.
3321                                  * we need to load the state (incl external files) first and
3322                                  * only then update the ID)
3323                                  */
3324                                 PBD::ID id = p->id();
3325                                 /* strip side-chain state (processor inside processor must be a side-chain)
3326                                  * otherwise we'll end up with duplicate ports-names.
3327                                  * (this needs a better solution which retains connections)
3328                                  * We really would want Stateful::ForceIDRegeneration here :(
3329                                  */
3330                                 XMLNode state (**niter);
3331                                 state.remove_nodes ("Processor");
3332
3333                                 p->set_state (state, Stateful::current_state_version);
3334                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3335                         }
3336
3337                         copies.push_back (p);
3338                 }
3339
3340                 catch (...) {
3341                         error << _("plugin insert constructor failed") << endmsg;
3342                 }
3343         }
3344
3345         if (copies.empty()) {
3346                 return;
3347         }
3348
3349         if (_route->add_processors (copies, p)) {
3350
3351                 string msg = _(
3352                         "Copying the set of processors on the clipboard failed,\n\
3353 probably because the I/O configuration of the plugins\n\
3354 could not match the configuration of this track.");
3355                 MessageDialog am (msg);
3356                 am.run ();
3357         }
3358 }
3359
3360 void
3361 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3362 {
3363         const list<ProcessorEntry*> selection = processor_display.selection ();
3364         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3365                 processors.push_back ((*i)->processor ());
3366         }
3367 }
3368
3369 void
3370 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3371 {
3372         list<ProcessorEntry*> selection = processor_display.selection ();
3373         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3374                 (this->*method) ((*i)->processor ());
3375         }
3376 }
3377
3378 void
3379 ProcessorBox::all_visible_processors_active (bool state)
3380 {
3381         _route->all_visible_processors_active (state);
3382 }
3383
3384 void
3385 ProcessorBox::ab_plugins ()
3386 {
3387         _route->ab_plugins (ab_direction);
3388         ab_direction = !ab_direction;
3389 }
3390
3391
3392 void
3393 ProcessorBox::clear_processors ()
3394 {
3395         string prompt;
3396         vector<string> choices;
3397
3398         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3399                                    "(this cannot be undone)"), _route->name());
3400
3401         choices.push_back (_("Cancel"));
3402         choices.push_back (_("Yes, remove them all"));
3403
3404         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3405
3406         if (prompter.run () == 1) {
3407                 _route->clear_processors (PreFader);
3408                 _route->clear_processors (PostFader);
3409         }
3410 }
3411
3412 void
3413 ProcessorBox::clear_processors (Placement p)
3414 {
3415         string prompt;
3416         vector<string> choices;
3417
3418         if (p == PreFader) {
3419                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3420                                            "(this cannot be undone)"), _route->name());
3421         } else {
3422                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3423                                            "(this cannot be undone)"), _route->name());
3424         }
3425
3426         choices.push_back (_("Cancel"));
3427         choices.push_back (_("Yes, remove them all"));
3428
3429         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3430
3431         if (prompter.run () == 1) {
3432                 _route->clear_processors (p);
3433         }
3434 }
3435
3436 bool
3437 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3438 {
3439         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3440         if (at && at->freeze_state() == AudioTrack::Frozen) {
3441                 return false;
3442         }
3443
3444         if (
3445                 boost::dynamic_pointer_cast<Send> (processor) ||
3446                 boost::dynamic_pointer_cast<Return> (processor) ||
3447                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3448                 boost::dynamic_pointer_cast<PortInsert> (processor)
3449                 ) {
3450                 return true;
3451         }
3452
3453         return false;
3454 }
3455
3456 bool
3457 ProcessorBox::one_processor_can_be_edited ()
3458 {
3459         list<ProcessorEntry*> selection = processor_display.selection ();
3460         list<ProcessorEntry*>::iterator i = selection.begin();
3461         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3462                 ++i;
3463         }
3464
3465         return (i != selection.end());
3466 }
3467
3468 Gtk::Window*
3469 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3470 {
3471         boost::shared_ptr<Send> send;
3472         boost::shared_ptr<InternalSend> internal_send;
3473         boost::shared_ptr<Return> retrn;
3474         boost::shared_ptr<PluginInsert> plugin_insert;
3475         boost::shared_ptr<PortInsert> port_insert;
3476         Window* gidget = 0;
3477
3478         /* This method may or may not return a Window, but if it does not it
3479          * will modify the parent mixer strip appearance layout to allow
3480          * "editing" the @param processor that was passed in.
3481          *
3482          * So for example, if the processor is an Amp (gain), the parent strip
3483          * will be forced back into a model where the fader controls the main gain.
3484          * If the processor is a send, then we map the send controls onto the
3485          * strip.
3486          *
3487          * Plugins and others will return a window for control.
3488          */
3489
3490         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3491
3492                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3493                         return 0;
3494                 }
3495         }
3496
3497         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3498
3499                 if (_parent_strip) {
3500                         _parent_strip->revert_to_default_display ();
3501                 }
3502
3503         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3504
3505                 if (!_session->engine().connected()) {
3506                         return 0;
3507                 }
3508
3509                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3510
3511                         gidget = new SendUIWindow (send, _session);
3512                 }
3513
3514         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3515
3516                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3517                         /* no GUI for these */
3518                         return 0;
3519                 }
3520
3521                 if (!_session->engine().connected()) {
3522                         return 0;
3523                 }
3524
3525                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3526
3527                 ReturnUIWindow *return_ui;
3528                 Window* w = get_processor_ui (retrn);
3529
3530                 if (w == 0) {
3531
3532                         return_ui = new ReturnUIWindow (retrn, _session);
3533                         return_ui->set_title (retrn->name ());
3534                         set_processor_ui (send, return_ui);
3535
3536                 } else {
3537                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
3538                 }
3539
3540                 gidget = return_ui;
3541
3542         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3543
3544                 PluginUIWindow *plugin_ui;
3545
3546                 /* these are both allowed to be null */
3547
3548                 Window* w = get_processor_ui (plugin_insert);
3549
3550                 if (w == 0) {
3551                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3552                         plugin_ui->set_title (generate_processor_title (plugin_insert));
3553                         set_processor_ui (plugin_insert, plugin_ui);
3554
3555                 } else {
3556                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3557                 }
3558
3559                 gidget = plugin_ui;
3560
3561         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3562
3563                 if (!_session->engine().connected()) {
3564                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3565                         msg.run ();
3566                         return 0;
3567                 }
3568
3569                 PortInsertWindow *io_selector;
3570
3571                 Window* w = get_processor_ui (port_insert);
3572
3573                 if (w == 0) {
3574                         io_selector = new PortInsertWindow (_session, port_insert);
3575                         set_processor_ui (port_insert, io_selector);
3576
3577                 } else {
3578                         io_selector = dynamic_cast<PortInsertWindow *> (w);
3579                 }
3580
3581                 gidget = io_selector;
3582         }
3583
3584         return gidget;
3585 }
3586
3587 Gtk::Window*
3588 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3589 {
3590         boost::shared_ptr<PluginInsert> plugin_insert
3591                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3592
3593         if (!plugin_insert) {
3594                 return 0;
3595         }
3596
3597         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3598         win->set_title (generate_processor_title (plugin_insert));
3599
3600         return win;
3601 }
3602
3603 void
3604 ProcessorBox::register_actions ()
3605 {
3606         processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3607
3608         Glib::RefPtr<Action> act;
3609
3610         /* new stuff */
3611         myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3612                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3613
3614         act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3615                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3616         ActionManager::engine_sensitive_actions.push_back (act);
3617         act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3618                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
3619         ActionManager::engine_sensitive_actions.push_back (act);
3620
3621         myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3622
3623         myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3624         myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3625
3626         myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3627                         sigc::ptr_fun (ProcessorBox::rb_clear));
3628         myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3629                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3630         myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3631                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
3632
3633         /* standard editing stuff */
3634
3635         cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3636                                                             sigc::ptr_fun (ProcessorBox::rb_cut));
3637         copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3638                                                              sigc::ptr_fun (ProcessorBox::rb_copy));
3639         delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3640                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3641
3642         ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3643         ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3644         ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3645
3646         paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3647                         sigc::ptr_fun (ProcessorBox::rb_paste));
3648         rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3649                         sigc::ptr_fun (ProcessorBox::rb_rename));
3650         myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3651                         sigc::ptr_fun (ProcessorBox::rb_select_all));
3652         myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3653                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3654
3655         /* activation etc. */
3656
3657         myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3658                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
3659         myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3660                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3661         myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3662                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3663
3664         manage_pins_action = myactions.register_action (
3665                 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3666                 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3667
3668         /* show editors */
3669         edit_action = myactions.register_action (
3670                 processor_box_actions, X_("edit"), _("Edit..."),
3671                 sigc::ptr_fun (ProcessorBox::rb_edit));
3672
3673         edit_generic_action = myactions.register_action (
3674                 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3675                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3676
3677         load_bindings ();
3678 }
3679
3680 void
3681 ProcessorBox::rb_edit_generic ()
3682 {
3683         if (_current_processor_box == 0) {
3684                 return;
3685         }
3686
3687         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3688 }
3689
3690 void
3691 ProcessorBox::rb_ab_plugins ()
3692 {
3693         if (_current_processor_box == 0) {
3694                 return;
3695         }
3696
3697         _current_processor_box->ab_plugins ();
3698 }
3699
3700 void
3701 ProcessorBox::rb_manage_pins ()
3702 {
3703         if (_current_processor_box == 0) {
3704                 return;
3705         }
3706
3707         _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3708 }
3709 void
3710 ProcessorBox::rb_choose_plugin ()
3711 {
3712         if (_current_processor_box == 0) {
3713                 return;
3714         }
3715         _current_processor_box->choose_plugin ();
3716 }
3717
3718 void
3719 ProcessorBox::rb_choose_insert ()
3720 {
3721         if (_current_processor_box == 0) {
3722                 return;
3723         }
3724         _current_processor_box->choose_insert ();
3725 }
3726
3727 void
3728 ProcessorBox::rb_choose_send ()
3729 {
3730         if (_current_processor_box == 0) {
3731                 return;
3732         }
3733         _current_processor_box->choose_send ();
3734 }
3735
3736 void
3737 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3738 {
3739         if (_current_processor_box == 0) {
3740                 return;
3741         }
3742
3743         _current_processor_box->choose_aux (wr);
3744 }
3745
3746 void
3747 ProcessorBox::rb_clear ()
3748 {
3749         if (_current_processor_box == 0) {
3750                 return;
3751         }
3752
3753         _current_processor_box->clear_processors ();
3754 }
3755
3756
3757 void
3758 ProcessorBox::rb_clear_pre ()
3759 {
3760         if (_current_processor_box == 0) {
3761                 return;
3762         }
3763
3764         _current_processor_box->clear_processors (PreFader);
3765 }
3766
3767
3768 void
3769 ProcessorBox::rb_clear_post ()
3770 {
3771         if (_current_processor_box == 0) {
3772                 return;
3773         }
3774
3775         _current_processor_box->clear_processors (PostFader);
3776 }
3777
3778 void
3779 ProcessorBox::rb_cut ()
3780 {
3781         if (_current_processor_box == 0) {
3782                 return;
3783         }
3784
3785         _current_processor_box->processor_operation (ProcessorsCut);
3786 }
3787
3788 void
3789 ProcessorBox::rb_delete ()
3790 {
3791         if (_current_processor_box == 0) {
3792                 return;
3793         }
3794
3795         _current_processor_box->processor_operation (ProcessorsDelete);
3796 }
3797
3798 void
3799 ProcessorBox::rb_copy ()
3800 {
3801         if (_current_processor_box == 0) {
3802                 return;
3803         }
3804         _current_processor_box->processor_operation (ProcessorsCopy);
3805 }
3806
3807 void
3808 ProcessorBox::rb_paste ()
3809 {
3810         if (_current_processor_box == 0) {
3811                 return;
3812         }
3813
3814         _current_processor_box->processor_operation (ProcessorsPaste);
3815 }
3816
3817 void
3818 ProcessorBox::rb_rename ()
3819 {
3820         if (_current_processor_box == 0) {
3821                 return;
3822         }
3823         _current_processor_box->rename_processors ();
3824 }
3825
3826 void
3827 ProcessorBox::rb_select_all ()
3828 {
3829         if (_current_processor_box == 0) {
3830                 return;
3831         }
3832
3833         _current_processor_box->processor_operation (ProcessorsSelectAll);
3834 }
3835
3836 void
3837 ProcessorBox::rb_deselect_all ()
3838 {
3839         if (_current_processor_box == 0) {
3840                 return;
3841         }
3842
3843         _current_processor_box->deselect_all_processors ();
3844 }
3845
3846 void
3847 ProcessorBox::rb_activate_all ()
3848 {
3849         if (_current_processor_box == 0) {
3850                 return;
3851         }
3852
3853         _current_processor_box->all_visible_processors_active (true);
3854 }
3855
3856 void
3857 ProcessorBox::rb_deactivate_all ()
3858 {
3859         if (_current_processor_box == 0) {
3860                 return;
3861         }
3862         _current_processor_box->all_visible_processors_active (false);
3863 }
3864
3865 void
3866 ProcessorBox::rb_edit ()
3867 {
3868         if (_current_processor_box == 0) {
3869                 return;
3870         }
3871
3872         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3873 }
3874
3875 bool
3876 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3877 {
3878         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3879                 return false;
3880         }
3881
3882         if (_parent_strip) {
3883                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3884                 if (_parent_strip->current_delivery() == send) {
3885                         _parent_strip->revert_to_default_display ();
3886                 } else {
3887                         _parent_strip->show_send(send);
3888                 }
3889         }
3890         return true;
3891 }
3892
3893 void
3894 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3895 {
3896         if (!processor) {
3897                 return;
3898         }
3899         if (edit_aux_send (processor)) {
3900                 return;
3901         }
3902
3903         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3904
3905         if (proxy) {
3906                 proxy->set_custom_ui_mode (true);
3907                 proxy->show_the_right_window ();
3908         }
3909 }
3910
3911 void
3912 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3913 {
3914         if (!processor) {
3915                 return;
3916         }
3917         if (edit_aux_send (processor)) {
3918                 return;
3919         }
3920
3921         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3922
3923         if (proxy) {
3924                 proxy->set_custom_ui_mode (false);
3925                 proxy->show_the_right_window ();
3926         }
3927 }
3928
3929 void
3930 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3931 {
3932         if (!processor) {
3933                 return;
3934         }
3935         PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3936         if (proxy) {
3937                 proxy->get (true);
3938                 proxy->present();
3939         }
3940 }
3941
3942
3943 void
3944 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3945 {
3946         if (!what_changed.contains (ARDOUR::Properties::name)) {
3947                 return;
3948         }
3949
3950         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3951
3952         boost::shared_ptr<Processor> processor;
3953         boost::shared_ptr<PluginInsert> plugin_insert;
3954         boost::shared_ptr<Send> send;
3955
3956         list<ProcessorEntry*> children = processor_display.children();
3957
3958         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3959
3960                 processor = (*iter)->processor ();
3961
3962                 if (!processor) {
3963                         continue;
3964                 }
3965
3966                 Window* w = get_processor_ui (processor);
3967
3968                 if (!w) {
3969                         continue;
3970                 }
3971
3972                 /* rename editor windows for sends and plugins */
3973
3974                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3975                         w->set_title (send->name ());
3976                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3977                         w->set_title (generate_processor_title (plugin_insert));
3978                 }
3979         }
3980 }
3981
3982 string
3983 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3984 {
3985         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3986         string::size_type email_pos;
3987
3988         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3989                 maker = maker.substr (0, email_pos - 1);
3990         }
3991
3992         if (maker.length() > 32) {
3993                 maker = maker.substr (0, 32);
3994                 maker += " ...";
3995         }
3996
3997         SessionObject* owner = pi->owner();
3998
3999         if (owner) {
4000                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4001         } else {
4002                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4003         }
4004 }
4005
4006 /** @param p Processor.
4007  *  @return the UI window for \a p.
4008  */
4009 Window *
4010 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4011 {
4012         ProcessorWindowProxy* wp = p->window_proxy();
4013         if (wp) {
4014                 return wp->get ();
4015         }
4016         return 0;
4017 }
4018
4019 /** Make a note of the UI window that a processor is using.
4020  *  @param p Processor.
4021  *  @param w UI window.
4022  */
4023 void
4024 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4025 {
4026         assert (p->window_proxy());
4027         p->set_ui (w);
4028         p->window_proxy()->use_window (*w);
4029 }
4030
4031 void
4032 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4033 {
4034         boost::shared_ptr<Delivery> d = w.lock ();
4035         if (!d) {
4036                 return;
4037         }
4038
4039         list<ProcessorEntry*> children = processor_display.children ();
4040         list<ProcessorEntry*>::const_iterator i = children.begin();
4041         while (i != children.end() && (*i)->processor() != d) {
4042                 ++i;
4043         }
4044
4045         if (i == children.end()) {
4046                 processor_display.set_active (0);
4047         } else {
4048                 processor_display.set_active (*i);
4049         }
4050 }
4051
4052 /** Called to repair the damage of Editor::show_window doing a show_all() */
4053 void
4054 ProcessorBox::hide_things ()
4055 {
4056         list<ProcessorEntry*> c = processor_display.children ();
4057         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4058                 (*i)->hide_things ();
4059         }
4060 }
4061
4062 void
4063 ProcessorBox::processor_menu_unmapped ()
4064 {
4065         processor_display.remove_placeholder ();
4066         /* make all possibly-desensitized actions sensitive again so that
4067            they be activated by other means (e.g. bindings)
4068         */
4069         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4070 }
4071
4072 XMLNode *
4073 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4074 {
4075         if (!_parent_strip) {
4076                 return 0;
4077         }
4078
4079         GUIObjectState& st = _parent_strip->gui_object_state ();
4080
4081         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4082         assert (strip);
4083         return st.get_or_add_node (strip, entry->state_id());
4084 }
4085
4086 void
4087 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4088 {
4089         XMLNode* proc = entry_gui_object_state (entry);
4090         if (!proc) {
4091                 return;
4092         }
4093
4094         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4095         proc->remove_nodes_and_delete (X_("Object"));
4096         entry->add_control_state (proc);
4097 }
4098
4099 bool
4100 ProcessorBox::is_editor_mixer_strip() const
4101 {
4102         return _parent_strip && !_parent_strip->mixer_owned();
4103 }
4104
4105 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4106         : WM::ProxyBase (name, string())
4107         , _processor_box (box)
4108         , _processor (processor)
4109         , is_custom (false)
4110         , want_custom (false)
4111 {
4112         boost::shared_ptr<Processor> p = _processor.lock ();
4113         if (!p) {
4114                 return;
4115         }
4116         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4117 }
4118
4119 ProcessorWindowProxy::~ProcessorWindowProxy()
4120 {
4121         /* processor window proxies do not own the windows they create with
4122          * ::get(), so set _window to null before the normal WindowProxy method
4123          * deletes it.
4124          */
4125         _window = 0;
4126 }
4127
4128 void
4129 ProcessorWindowProxy::processor_going_away ()
4130 {
4131         delete _window;
4132         _window = 0;
4133         WM::Manager::instance().remove (this);
4134         /* should be no real reason to do this, since the object that would
4135            send DropReferences is about to be deleted, but lets do it anyway.
4136         */
4137         going_away_connection.disconnect();
4138 }
4139
4140 ARDOUR::SessionHandlePtr*
4141 ProcessorWindowProxy::session_handle()
4142 {
4143         /* we don't care */
4144         return 0;
4145 }
4146
4147 XMLNode&
4148 ProcessorWindowProxy::get_state ()
4149 {
4150         XMLNode *node;
4151         node = &ProxyBase::get_state();
4152         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4153         return *node;
4154 }
4155
4156 int
4157 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4158 {
4159         XMLNodeList children = node.children ();
4160         XMLNodeList::const_iterator i = children.begin ();
4161         while (i != children.end()) {
4162                 XMLProperty const * prop = (*i)->property (X_("name"));
4163                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4164                         break;
4165                 }
4166                 ++i;
4167         }
4168
4169         if (i != children.end()) {
4170                 XMLProperty const * prop;
4171                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4172                         want_custom = PBD::string_is_affirmative (prop->value ());
4173                 }
4174         }
4175
4176         return ProxyBase::set_state (node, 0);
4177 }
4178
4179 Gtk::Window*
4180 ProcessorWindowProxy::get (bool create)
4181 {
4182         boost::shared_ptr<Processor> p = _processor.lock ();
4183
4184         if (!p) {
4185                 return 0;
4186         }
4187         if (_window && (is_custom != want_custom)) {
4188                 /* drop existing window - wrong type */
4189                 drop_window ();
4190         }
4191
4192         if (!_window) {
4193                 if (!create) {
4194                         return 0;
4195                 }
4196
4197                 is_custom = want_custom;
4198                 _window = _processor_box->get_editor_window (p, is_custom);
4199
4200                 if (_window) {
4201                         setup ();
4202                 }
4203                 _window->show_all ();
4204         }
4205         return _window;
4206 }
4207
4208 void
4209 ProcessorWindowProxy::show_the_right_window ()
4210 {
4211         if (_window && (is_custom != want_custom)) {
4212                 /* drop existing window - wrong type */
4213                 drop_window ();
4214                 get (true);
4215                 setup ();
4216                 assert (_window);
4217                 is_custom = want_custom;
4218         }
4219
4220         toggle ();
4221 }
4222
4223
4224 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4225         : WM::ProxyBase (name, string())
4226         , _processor (processor)
4227 {
4228         boost::shared_ptr<Processor> p = _processor.lock ();
4229         if (!p) {
4230                 return;
4231         }
4232         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4233 }
4234
4235 PluginPinWindowProxy::~PluginPinWindowProxy()
4236 {
4237         _window = 0;
4238 }
4239
4240 ARDOUR::SessionHandlePtr*
4241 PluginPinWindowProxy::session_handle ()
4242 {
4243         ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4244         if (aw) { return aw; }
4245         return 0;
4246 }
4247
4248 Gtk::Window*
4249 PluginPinWindowProxy::get (bool create)
4250 {
4251         boost::shared_ptr<Processor> p = _processor.lock ();
4252         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4253         if (!p || !pi) {
4254                 return 0;
4255         }
4256
4257         if (!_window) {
4258                 if (!create) {
4259                         return 0;
4260                 }
4261                 _window = new PluginPinDialog (pi);
4262                 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4263                 if (aw) {
4264                         aw->set_session (_session);
4265                 }
4266                 _window->show_all ();
4267         }
4268         return _window;
4269 }
4270
4271 void
4272 PluginPinWindowProxy::processor_going_away ()
4273 {
4274         delete _window;
4275         _window = 0;
4276         WM::Manager::instance().remove (this);
4277         going_away_connection.disconnect();
4278 }
4279
4280 void
4281 ProcessorBox::load_bindings ()
4282 {
4283         bindings = Bindings::get_bindings (X_("Processor Box"), myactions);
4284 }