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