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