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