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