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