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