Initial Gain Coefficient tweaks
[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 #ifdef COMPILER_MSVC
25 #define rintf(x) round((x) + 0.5)
26 #endif
27
28 #include <cmath>
29 #include <iostream>
30 #include <set>
31
32 #include <sigc++/bind.h>
33
34 #include "pbd/convert.h"
35
36 #include <glibmm/miscutils.h>
37
38 #include <gtkmm/messagedialog.h>
39
40 #include <gtkmm2ext/gtk_ui.h>
41 #include <gtkmm2ext/utils.h>
42 #include <gtkmm2ext/choice.h>
43 #include <gtkmm2ext/utils.h>
44 #include <gtkmm2ext/doi.h>
45 #include <gtkmm2ext/rgb_macros.h>
46
47 #include "ardour/amp.h"
48 #include "ardour/audio_track.h"
49 #include "ardour/audioengine.h"
50 #include "ardour/internal_return.h"
51 #include "ardour/internal_send.h"
52 #include "ardour/panner_shell.h"
53 #include "ardour/plugin_insert.h"
54 #include "ardour/pannable.h"
55 #include "ardour/port_insert.h"
56 #include "ardour/profile.h"
57 #include "ardour/return.h"
58 #include "ardour/route.h"
59 #include "ardour/send.h"
60 #include "ardour/session.h"
61 #include "ardour/types.h"
62
63 #include "actions.h"
64 #include "ardour_dialog.h"
65 #include "ardour_ui.h"
66 #include "gui_thread.h"
67 #include "io_selector.h"
68 #include "keyboard.h"
69 #include "mixer_ui.h"
70 #include "mixer_strip.h"
71 #include "plugin_selector.h"
72 #include "plugin_ui.h"
73 #include "port_insert_ui.h"
74 #include "processor_box.h"
75 #include "public_editor.h"
76 #include "return_ui.h"
77 #include "route_processor_selection.h"
78 #include "send_ui.h"
79 #include "timers.h"
80
81 #include "i18n.h"
82
83 #ifdef AUDIOUNIT_SUPPORT
84 class AUPluginUI;
85 #endif
86
87 using namespace std;
88 using namespace ARDOUR;
89 using namespace PBD;
90 using namespace Gtk;
91 using namespace Glib;
92 using namespace Gtkmm2ext;
93
94 ProcessorBox* ProcessorBox::_current_processor_box = 0;
95 RefPtr<Action> ProcessorBox::paste_action;
96 RefPtr<Action> ProcessorBox::cut_action;
97 RefPtr<Action> ProcessorBox::rename_action;
98 RefPtr<Action> ProcessorBox::edit_action;
99 RefPtr<Action> ProcessorBox::edit_generic_action;
100
101 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
102 static const uint32_t midi_port_color = 0x960909FF; //Red
103
104 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
105         : _button (ArdourButton::led_default_elements)
106         , _position (PreFader)
107         , _position_num(0)
108         , _selectable(true)
109         , _parent (parent)
110         , _processor (p)
111         , _width (w)
112         , _input_icon(true)
113         , _output_icon(false)
114 {
115         _vbox.show ();
116         
117         _button.set_distinct_led_click (true);
118         _button.set_fallthrough_to_parent(true);
119         _button.set_led_left (true);
120         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
121         _button.set_text (name (_width));
122
123         if (_processor) {
124
125                 _vbox.pack_start (_routing_icon);
126                 _vbox.pack_start (_input_icon);
127                 _vbox.pack_start (_button, true, true);
128                 _vbox.pack_end (_output_icon);
129
130                 _button.set_active (_processor->active());
131
132                 _routing_icon.set_no_show_all(true);
133                 _input_icon.set_no_show_all(true);
134
135                 _button.show ();
136                 _routing_icon.set_visible(false);
137                 _input_icon.hide();
138                 _output_icon.show();
139
140                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
141                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
142                 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
143
144                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
145                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
146                         
147                         std::string label = _processor->describe_parameter (*i);
148
149                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
150                                 label = _("Send");
151                         } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
152                                 label = _("Return");
153                         }
154
155                         Control* c = new Control (_processor->automation_control (*i), label);
156                         
157                         _controls.push_back (c);
158
159                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
160                                 /* Add non-Amp controls to the processor box */
161                                 _vbox.pack_start (c->box);
162                         }
163                 }
164
165                 _input_icon.set_ports(_processor->input_streams());
166                 _output_icon.set_ports(_processor->output_streams());
167
168                 _routing_icon.set_sources(_processor->input_streams());
169                 _routing_icon.set_sinks(_processor->output_streams());
170
171                 setup_tooltip ();
172                 setup_visuals ();
173         } else {
174                 _vbox.set_size_request (-1, _button.size_request().height);
175         }
176 }
177
178 ProcessorEntry::~ProcessorEntry ()
179 {
180         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
181                 delete *i;
182         }
183 }
184
185 EventBox&
186 ProcessorEntry::action_widget ()
187 {
188         return _button;
189 }
190
191 Gtk::Widget&
192 ProcessorEntry::widget ()
193 {
194         return _vbox;
195 }
196
197 string
198 ProcessorEntry::drag_text () const
199 {
200         return name (Wide);
201 }
202
203 void
204 ProcessorEntry::set_position (Position p, uint32_t num)
205 {
206         _position = p;
207         _position_num = num;
208
209         if (_position_num == 0 || _routing_icon.get_visible()) {
210                 _input_icon.show();
211         } else {
212                 _input_icon.hide();
213         }
214
215         setup_visuals ();
216 }
217
218 void
219 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
220 {
221         if (yn) {
222                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
223         } else {
224                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
225         }
226 }
227
228 void
229 ProcessorEntry::setup_visuals ()
230 {
231         switch (_position) {
232         case PreFader:
233                 _button.set_name ("processor prefader");
234                 break;
235
236         case Fader:
237                 _button.set_name ("processor fader");
238                 break;
239
240         case PostFader:
241                 _button.set_name ("processor postfader");
242                 break;
243         }
244 }
245
246
247 boost::shared_ptr<Processor>
248 ProcessorEntry::processor () const
249 {
250         return _processor;
251 }
252
253 void
254 ProcessorEntry::set_enum_width (Width w)
255 {
256         _width = w;
257         _button.set_text (name (_width));
258 }
259
260 void
261 ProcessorEntry::led_clicked()
262 {
263         if (_processor) {
264                 if (_button.get_active ()) {
265                         _processor->deactivate ();
266                 } else {
267                         _processor->activate ();
268                 }
269         }
270 }
271
272 void
273 ProcessorEntry::processor_active_changed ()
274 {
275         if (_processor) {
276                 _button.set_active (_processor->active());
277         }
278 }
279
280 void
281 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
282 {
283         if (what_changed.contains (ARDOUR::Properties::name)) {
284                 _button.set_text (name (_width));
285                 setup_tooltip ();
286         }
287 }
288
289 void
290 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
291 {
292         _input_icon.set_ports(in);
293         _output_icon.set_ports(out);
294         _routing_icon.set_sources(in);
295         _routing_icon.set_sinks(out);
296         _input_icon.queue_draw();
297         _output_icon.queue_draw();
298         _routing_icon.queue_draw();
299 }
300
301 void
302 ProcessorEntry::setup_tooltip ()
303 {
304         if (_processor) {
305                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
306                 if (pi) {
307                         std::string postfix = "";
308                         uint32_t replicated;
309                         if ((replicated = pi->get_count()) > 1) {
310                                 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
311                         }
312                         if (pi->plugin()->has_editor()) {
313                                 ARDOUR_UI::instance()->set_tip (_button,
314                                                 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\nAlt+double-click to show generic GUI.%2"), name (Wide), postfix));
315                         } else {
316                                 ARDOUR_UI::instance()->set_tip (_button,
317                                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
318                         }
319                         return;
320                 }
321         }
322         ARDOUR_UI::instance()->set_tip (_button, string_compose ("<b>%1</b>", name (Wide)));
323 }
324
325 string
326 ProcessorEntry::name (Width w) const
327 {
328         boost::shared_ptr<Send> send;
329         string name_display;
330
331         if (!_processor) {
332                 return string();
333         }
334
335         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
336             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
337
338                 name_display += '>';
339
340                 /* grab the send name out of its overall name */
341
342                 string::size_type lbracket, rbracket;
343                 lbracket = send->name().find ('[');
344                 rbracket = send->name().find (']');
345
346                 switch (w) {
347                 case Wide:
348                         name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
349                         break;
350                 case Narrow:
351                         name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
352                         break;
353                 }
354
355         } else {
356                 boost::shared_ptr<ARDOUR::PluginInsert> pi;
357                 uint32_t replicated;
358                 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
359                                 && (replicated = pi->get_count()) > 1)
360                 {
361                         name_display += string_compose(_("(%1x1) "), replicated);
362                 }
363
364                 switch (w) {
365                 case Wide:
366                         name_display += _processor->display_name();
367                         break;
368                 case Narrow:
369                         name_display += PBD::short_version (_processor->display_name(), 5);
370                         break;
371                 }
372
373         }
374
375         return name_display;
376 }
377
378 void
379 ProcessorEntry::show_all_controls ()
380 {
381         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
382                 (*i)->set_visible (true);
383         }
384
385         _parent->update_gui_object_state (this);
386 }
387
388 void
389 ProcessorEntry::hide_all_controls ()
390 {
391         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
392                 (*i)->set_visible (false);
393         }
394
395         _parent->update_gui_object_state (this);
396 }
397
398 void
399 ProcessorEntry::add_control_state (XMLNode* node) const
400 {
401         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
402                 (*i)->add_state (node);
403         }
404 }
405
406 void
407 ProcessorEntry::set_control_state (XMLNode const * node)
408 {
409         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
410                 (*i)->set_state (node);
411         }
412 }
413
414 string
415 ProcessorEntry::state_id () const
416 {
417         return string_compose ("processor %1", _processor->id().to_s());
418 }
419
420 void
421 ProcessorEntry::hide_things ()
422 {
423         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
424                 (*i)->hide_things ();
425         }
426 }
427
428
429 Menu *
430 ProcessorEntry::build_controls_menu ()
431 {
432         using namespace Menu_Helpers;
433         Menu* menu = manage (new Menu);
434         MenuList& items = menu->items ();
435
436         items.push_back (
437                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
438                 );
439                 
440         items.push_back (
441                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
442                 );
443
444         if (!_controls.empty ()) {
445                 items.push_back (SeparatorElem ());
446         }
447         
448         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
449                 items.push_back (CheckMenuElem ((*i)->name ()));
450                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
451                 c->set_active ((*i)->visible ());
452                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
453         }
454
455         return menu;
456 }
457
458 void
459 ProcessorEntry::toggle_control_visibility (Control* c)
460 {
461         c->set_visible (!c->visible ());
462         _parent->update_gui_object_state (this);
463 }
464
465 Menu *
466 ProcessorEntry::build_send_options_menu ()
467 {
468         using namespace Menu_Helpers;
469         Menu* menu = manage (new Menu);
470         MenuList& items = menu->items ();
471
472         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
473         if (send) {
474
475                 items.push_back (CheckMenuElem (_("Link panner controls")));
476                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
477                 c->set_active (send->panner_shell()->is_linked_to_route());
478                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
479
480         }
481         return menu;
482 }
483
484 void
485 ProcessorEntry::toggle_panner_link ()
486 {
487         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
488         if (send) {
489                 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
490         }
491 }
492
493 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
494         : _control (c)
495         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
496         , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, 13)
497         , _slider_persistant_tooltip (&_slider)
498         , _button (ArdourButton::led_default_elements)
499         , _ignore_ui_adjustment (false)
500         , _visible (false)
501         , _name (n)
502 {
503         _slider.set_controllable (c);
504         box.set_padding(0, 0, 4, 4);
505
506         if (c->toggled()) {
507                 _button.set_text (_name);
508                 _button.set_led_left (true);
509                 _button.set_name ("processor control button");
510                 box.add (_button);
511                 _button.show ();
512
513                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
514                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
515                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
516
517         } else {
518                 
519                 _slider.set_name ("ProcessorControlSlider");
520                 _slider.set_text (_name);
521
522                 box.add (_slider);
523                 _slider.show ();
524
525                 const ARDOUR::ParameterDescriptor& desc = c->desc();
526                 double const lo = c->internal_to_interface(desc.lower);
527                 double const up = c->internal_to_interface(desc.upper);
528                 double const normal = c->internal_to_interface(desc.normal);
529                 double smallstep = desc.smallstep;
530                 double largestep = desc.largestep;
531
532                 if (smallstep == 0.0) {
533                         smallstep = up / 1000.;
534                 } else {
535                         smallstep = c->internal_to_interface(desc.lower + smallstep);
536                 }
537
538                 if (largestep == 0.0) {
539                         largestep = up / 40.;
540                 } else {
541                         largestep = c->internal_to_interface(desc.lower + largestep);
542                 }
543
544                 _adjustment.set_lower (lo);
545                 _adjustment.set_upper (up);
546                 _adjustment.set_step_increment (smallstep);
547                 _adjustment.set_page_increment (largestep);
548                 _slider.set_default_value (normal);
549                 
550                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
551                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
552         }
553
554         Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
555         
556         control_changed ();
557         set_tooltip ();
558
559         /* We're providing our own PersistentTooltip */
560         set_no_tooltip_whatsoever (_slider);
561 }
562
563 void
564 ProcessorEntry::Control::set_tooltip ()
565 {
566         boost::shared_ptr<AutomationControl> c = _control.lock ();
567
568         if (!c) {
569                 return;
570         }
571         
572         stringstream s;
573         s << _name << ": ";
574         if (c->toggled ()) {
575                 s << (c->get_value() > 0.5 ? _("on") : _("off"));
576         } else {
577                 s << setprecision(2) << fixed;
578                 s << c->internal_to_user (c->get_value ());
579         }
580
581         string sm = Glib::Markup::escape_text (s.str());
582         
583         _slider_persistant_tooltip.set_tip (sm);
584         ARDOUR_UI::instance()->set_tip (_button, sm);
585 }
586
587 void
588 ProcessorEntry::Control::slider_adjusted ()
589 {
590         if (_ignore_ui_adjustment) {
591                 return;
592         }
593         
594         boost::shared_ptr<AutomationControl> c = _control.lock ();
595
596         if (!c) {
597                 return;
598         }
599
600         c->set_value ( c->interface_to_internal(_adjustment.get_value ()) );
601         set_tooltip ();
602 }
603
604 void
605 ProcessorEntry::Control::button_clicked ()
606 {
607         boost::shared_ptr<AutomationControl> c = _control.lock ();
608
609         if (!c) {
610                 return;
611         }
612
613         bool const n = _button.get_active ();
614
615         c->set_value (n ? 0 : 1);
616         _button.set_active (!n);
617         set_tooltip ();
618 }
619
620 void
621 ProcessorEntry::Control::control_changed ()
622 {
623         boost::shared_ptr<AutomationControl> c = _control.lock ();
624         if (!c) {
625                 return;
626         }
627
628         _ignore_ui_adjustment = true;
629
630         if (c->toggled ()) {
631
632                 _button.set_active (c->get_value() > 0.5);
633                 
634         } else {
635
636                 _adjustment.set_value (c->internal_to_interface(c->get_value ()));
637                 set_tooltip ();
638         }
639         
640         _ignore_ui_adjustment = false;
641 }
642
643 void
644 ProcessorEntry::Control::add_state (XMLNode* node) const
645 {
646         XMLNode* c = new XMLNode (X_("Object"));
647         c->add_property (X_("id"), state_id ());
648         c->add_property (X_("visible"), _visible);
649         node->add_child_nocopy (*c);
650 }
651
652 void
653 ProcessorEntry::Control::set_state (XMLNode const * node)
654 {
655         XMLNode* n = GUIObjectState::get_node (node, state_id ());
656         if (n) {
657                 XMLProperty* p = n->property (X_("visible"));
658                 set_visible (p && string_is_affirmative (p->value ()));
659         } else {
660                 set_visible (false);
661         }
662 }
663
664 void
665 ProcessorEntry::Control::set_visible (bool v)
666 {
667         if (v) {
668                 box.show ();
669         } else {
670                 box.hide ();
671         }
672         
673         _visible = v;
674 }
675
676 /** Called when the Editor might have re-shown things that
677     we want hidden.
678 */
679 void
680 ProcessorEntry::Control::hide_things ()
681 {
682         if (!_visible) {
683                 box.hide ();
684         }
685 }
686
687 string
688 ProcessorEntry::Control::state_id () const
689 {
690         boost::shared_ptr<AutomationControl> c = _control.lock ();
691         assert (c);
692
693         return string_compose (X_("control %1"), c->id().to_s ());
694 }
695
696 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
697         : ProcessorEntry (b, p, w)
698         , _plugin_insert (p)
699 {
700         p->PluginIoReConfigure.connect (
701                 _splitting_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::plugin_insert_splitting_changed, this), gui_context()
702                 );
703
704         plugin_insert_splitting_changed ();
705 }
706
707 void
708 PluginInsertProcessorEntry::plugin_insert_splitting_changed ()
709 {
710         _output_icon.set_ports(_plugin_insert->output_streams());
711         _routing_icon.set_splitting(_plugin_insert->splitting ());
712
713         ChanCount sources = _plugin_insert->input_streams();
714         ChanCount sinks = _plugin_insert->natural_input_streams();
715
716         /* replicated instances */
717         if (!_plugin_insert->splitting () && _plugin_insert->get_count() > 1) {
718                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
719                         sinks.set(*t, sinks.get(*t) * _plugin_insert->get_count());
720                 }
721         }
722         /* MIDI bypass */
723         if (_plugin_insert->natural_output_streams().n_midi() == 0 &&
724                         _plugin_insert->output_streams().n_midi() == 1) {
725                 sinks.set(DataType::MIDI, 1);
726                 sources.set(DataType::MIDI, 1);
727         }
728
729         _input_icon.set_ports(sinks);
730         _routing_icon.set_sinks(sinks);
731         _routing_icon.set_sources(sources);
732
733         if (_plugin_insert->splitting () ||
734                         _plugin_insert->input_streams().n_audio() < _plugin_insert->natural_input_streams().n_audio()
735                  )
736         {
737                 _routing_icon.set_size_request (-1, 7);
738                 _routing_icon.set_visible(true);
739                 _input_icon.show();
740         } else {
741                 _routing_icon.set_visible(false);
742                 if (_position_num != 0) {
743                         _input_icon.hide();
744                 }
745         }
746
747         _input_icon.queue_draw();
748         _output_icon.queue_draw();
749         _routing_icon.queue_draw();
750 }
751
752 void
753 PluginInsertProcessorEntry::hide_things ()
754 {
755         ProcessorEntry::hide_things ();
756         plugin_insert_splitting_changed ();
757 }
758
759
760 bool
761 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
762 {
763         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
764
765         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
766         cairo_clip (cr);
767
768         Gtk::Allocation a = get_allocation();
769         double const width = a.get_width();
770         double const height = a.get_height();
771
772         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
773         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
774
775         cairo_rectangle (cr, 0, 0, width, height);
776         cairo_fill (cr);
777
778         if (_ports.n_total() > 1) {
779                 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
780                         if (i < _ports.n_midi()) {
781                                 cairo_set_source_rgb (cr,
782                                                 UINT_RGBA_R_FLT(midi_port_color),
783                                                 UINT_RGBA_G_FLT(midi_port_color),
784                                                 UINT_RGBA_B_FLT(midi_port_color));
785                         } else {
786                                 cairo_set_source_rgb (cr,
787                                                 UINT_RGBA_R_FLT(audio_port_color),
788                                                 UINT_RGBA_G_FLT(audio_port_color),
789                                                 UINT_RGBA_B_FLT(audio_port_color));
790                         }
791                         const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
792                         cairo_rectangle (cr, x-1, 0, 3, height);
793                         cairo_fill(cr);
794                 }
795         } else if (_ports.n_total() == 1) {
796                 if (_ports.n_midi() == 1) {
797                         cairo_set_source_rgb (cr,
798                                         UINT_RGBA_R_FLT(midi_port_color),
799                                         UINT_RGBA_G_FLT(midi_port_color),
800                                         UINT_RGBA_B_FLT(midi_port_color));
801                 } else {
802                         cairo_set_source_rgb (cr,
803                                         UINT_RGBA_R_FLT(audio_port_color),
804                                         UINT_RGBA_G_FLT(audio_port_color),
805                                         UINT_RGBA_B_FLT(audio_port_color));
806                 }
807                 const float x = rintf(width * .5);
808                 cairo_rectangle (cr, x-1, 0, 3, height);
809                 cairo_fill(cr);
810                 cairo_stroke(cr);
811         }
812
813         cairo_destroy(cr);
814         return true;
815 }
816
817 bool
818 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
819 {
820         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
821
822         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
823         cairo_clip (cr);
824
825         cairo_set_line_width (cr, 1.0);
826         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
827
828         Gtk::Allocation a = get_allocation();
829         double const width = a.get_width();
830         double const height = a.get_height();
831
832         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
833         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
834
835         cairo_rectangle (cr, 0, 0, width, height);
836         cairo_fill (cr);
837
838         Gdk::Color const fg = get_style()->get_fg (STATE_NORMAL);
839         cairo_set_source_rgb (cr, fg.get_red_p (), fg.get_green_p (), fg.get_blue_p ());
840
841         const uint32_t sources = _sources.n_total();
842         const uint32_t sinks = _sinks.n_total();
843
844         /* MIDI */
845         const uint32_t midi_sources = _sources.n_midi();
846         const uint32_t midi_sinks = _sinks.n_midi();
847
848         cairo_set_source_rgb (cr,
849                         UINT_RGBA_R_FLT(midi_port_color),
850                         UINT_RGBA_G_FLT(midi_port_color),
851                         UINT_RGBA_B_FLT(midi_port_color));
852         if (midi_sources > 0 && midi_sinks > 0 && sinks > 1 && sources > 1) {
853                 for (uint32_t i = 0 ; i < midi_sources; ++i) {
854                         const float si_x  = rintf(width * (.2f + .6f * i  / (sinks - 1.f))) + .5f;
855                         const float si_x0 = rintf(width * (.2f + .6f * i / (sources - 1.f))) + .5f;
856                         cairo_move_to (cr, si_x, height);
857                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
858                         cairo_stroke (cr);
859                 }
860         } else if (midi_sources == 1 && midi_sinks == 1 && sinks == 1 && sources == 1) {
861                 const float si_x = rintf(width * .5f) + .5f;
862                 cairo_move_to (cr, si_x, height);
863                 cairo_line_to (cr, si_x, 0);
864                 cairo_stroke (cr);
865         } else if (midi_sources == 1 && midi_sinks == 1) {
866                 /* unusual cases -- removed synth, midi-track w/audio plugins */
867                 const float si_x  = rintf(width * (sinks   > 1 ? .2f : .5f)) + .5f;
868                 const float si_x0 = rintf(width * (sources > 1 ? .2f : .5f)) + .5f;
869                 cairo_move_to (cr, si_x, height);
870                 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
871                 cairo_stroke (cr);
872         }
873
874         /* AUDIO */
875         const uint32_t audio_sources = _sources.n_audio();
876         const uint32_t audio_sinks = _sinks.n_audio();
877         cairo_set_source_rgb (cr,
878                         UINT_RGBA_R_FLT(audio_port_color),
879                         UINT_RGBA_G_FLT(audio_port_color),
880                         UINT_RGBA_B_FLT(audio_port_color));
881
882         if (_splitting) {
883                 assert(audio_sources < 2);
884                 assert(audio_sinks > 1);
885                 /* assume there is only ever one MIDI port */
886                 const float si_x0 = rintf(width * (midi_sources > 0 ? .8f : .5f)) + .5f;
887                 for (uint32_t i = midi_sinks; i < sinks; ++i) {
888                         const float si_x = rintf(width * (.2f + .6f * i / (sinks - 1.f))) + .5f;
889                         cairo_move_to (cr, si_x, height);
890                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
891                         cairo_stroke (cr);
892                 }
893         } else if (audio_sources > 1) {
894                 for (uint32_t i = 0 ; i < audio_sources; ++i) {
895                         const float si_x = rintf(width * (.2f + .6f * (i + midi_sinks) / (sinks - 1.f))) + .5f;
896                         const float si_x0 = rintf(width * (.2f + .6f * (i + midi_sources) / (sources - 1.f))) + .5f;
897                         cairo_move_to (cr, si_x, height);
898                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
899                         cairo_stroke (cr);
900                 }
901         } else if (audio_sources == 1 && audio_sinks == 1) {
902                 const float si_x = rintf(width * .5f) + .5f;
903                 cairo_move_to (cr, si_x, height);
904                 cairo_line_to (cr, si_x, 0);
905                 cairo_stroke (cr);
906         }
907         cairo_destroy(cr);
908         return true;
909 }
910
911 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
912                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
913         : _parent_strip (parent)
914         , _owner_is_mixer (owner_is_mixer)
915         , ab_direction (true)
916         , _get_plugin_selector (get_plugin_selector)
917         , _placement (-1)
918         , _visible_prefader_processors (0)
919         , _rr_selection(rsel)
920         , _redisplay_pending (false)
921
922 {
923         set_session (sess);
924
925         _width = Wide;
926         processor_menu = 0;
927         no_processor_redisplay = false;
928
929         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
930         processor_scroller.add (processor_display);
931         pack_start (processor_scroller, true, true);
932
933         processor_display.set_flags (CAN_FOCUS);
934         processor_display.set_name ("ProcessorList");
935         processor_display.set_data ("processorbox", this);
936         processor_display.set_size_request (48, -1);
937         processor_display.set_spacing (0);
938
939         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
940         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
941
942         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
943         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
944
945         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
946         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
947
948         processor_scroller.show ();
949         processor_display.show ();
950
951         if (parent) {
952                 parent->DeliveryChanged.connect (
953                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
954                         );
955         }
956
957         ARDOUR_UI::instance()->set_tip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
958 }
959
960 ProcessorBox::~ProcessorBox ()
961 {
962         /* it may appear as if we should delete processor_menu but that is a
963          * pointer to a widget owned by the UI Manager, and has potentially
964          * be returned to many other ProcessorBoxes. GTK doesn't really make
965          * clear the ownership of this widget, which is a menu and thus is
966          * never packed into any container other than an implict GtkWindow.
967          *
968          * For now, until or if we ever get clarification over the ownership
969          * story just let it continue to exist. At worst, its a small memory leak.
970          */
971 }
972
973 void
974 ProcessorBox::set_route (boost::shared_ptr<Route> r)
975 {
976         if (_route == r) {
977                 return;
978         }
979
980         _route_connections.drop_connections();
981
982         /* new route: any existing block on processor redisplay must be meaningless */
983         no_processor_redisplay = false;
984         _route = r;
985
986         _route->processors_changed.connect (
987                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
988                 );
989
990         _route->DropReferences.connect (
991                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
992                 );
993
994         _route->PropertyChanged.connect (
995                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
996                 );
997
998         redisplay_processors ();
999 }
1000
1001 void
1002 ProcessorBox::route_going_away ()
1003 {
1004         /* don't keep updating display as processors are deleted */
1005         no_processor_redisplay = true;
1006         _route.reset ();
1007 }
1008
1009 void
1010 ProcessorBox::object_drop(DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1011 {
1012         boost::shared_ptr<Processor> p;
1013         if (position) {
1014                 p = position->processor ();
1015                 if (!p) {
1016                         /* dropped on the blank entry (which will be before the
1017                            fader), so use the first non-blank child as our
1018                            `dropped on' processor */
1019                         list<ProcessorEntry*> c = processor_display.children ();
1020                         list<ProcessorEntry*>::iterator i = c.begin ();
1021
1022                         assert (i != c.end ());
1023                         p = (*i)->processor ();
1024                         assert (p);
1025                 }
1026         }
1027
1028         list<ProcessorEntry*> children = source->selection ();
1029         list<boost::shared_ptr<Processor> > procs;
1030         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1031                 if ((*i)->processor ()) {
1032                         procs.push_back ((*i)->processor ());
1033                 }
1034         }
1035
1036         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1037                 XMLNode& state = (*i)->get_state ();
1038                 XMLNodeList nlist;
1039                 nlist.push_back (&state);
1040                 paste_processor_state (nlist, p);
1041                 delete &state;
1042         }
1043
1044         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1045            ourselves.
1046         */
1047
1048         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1049                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1050                 if (other) {
1051                         other->delete_dragged_processors (procs);
1052                 }
1053         }
1054 }
1055
1056 void
1057 ProcessorBox::set_width (Width w)
1058 {
1059         if (_width == w) {
1060                 return;
1061         }
1062
1063         _width = w;
1064
1065         list<ProcessorEntry*> children = processor_display.children ();
1066         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1067                 (*i)->set_enum_width (w);
1068         }
1069
1070         queue_resize ();
1071 }
1072
1073 Gtk::Menu*
1074 ProcessorBox::build_possible_aux_menu ()
1075 {
1076         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1077
1078         if (rl->empty()) {
1079                 /* No aux sends if there are no busses */
1080                 return 0;
1081         }
1082
1083         using namespace Menu_Helpers;
1084         Menu* menu = manage (new Menu);
1085         MenuList& items = menu->items();
1086
1087         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1088                 if (!_route->internal_send_for (*r) && *r != _route) {
1089                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
1090                 }
1091         }
1092
1093         return menu;
1094 }
1095
1096 void
1097 ProcessorBox::show_processor_menu (int arg)
1098 {
1099         if (processor_menu == 0) {
1100                 processor_menu = build_processor_menu ();
1101                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
1102         }
1103
1104         /* Sort out the plugin submenu */
1105
1106         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
1107
1108         if (plugin_menu_item) {
1109                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
1110         }
1111
1112         /* And the aux submenu */
1113
1114         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
1115
1116         if (aux_menu_item) {
1117                 Menu* m = build_possible_aux_menu();
1118                 if (m && !m->items().empty()) {
1119                         aux_menu_item->set_submenu (*m);
1120                         aux_menu_item->set_sensitive (true);
1121                 } else {
1122                         /* stupid gtkmm: we need to pass a null reference here */
1123                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
1124                         aux_menu_item->set_sensitive (false);
1125                 }
1126         }
1127
1128         ProcessorEntry* single_selection = 0;
1129         if (processor_display.selection().size() == 1) {
1130                 single_selection = processor_display.selection().front();
1131         }
1132
1133         /* And the controls submenu */
1134
1135         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
1136
1137         if (controls_menu_item) {
1138                 if (single_selection) {
1139                         Menu* m = single_selection->build_controls_menu ();
1140                         if (m && !m->items().empty()) {
1141                                 controls_menu_item->set_submenu (*m);
1142                                 controls_menu_item->set_sensitive (true);
1143                         } else {
1144                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
1145                                 controls_menu_item->set_sensitive (false);
1146                         }
1147                 } else {
1148                         controls_menu_item->set_sensitive (false);
1149                 }
1150         }
1151
1152         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
1153         if (send_menu_item) {
1154                 if (single_selection) {
1155                         Menu* m = single_selection->build_send_options_menu ();
1156                         if (m && !m->items().empty()) {
1157                                 send_menu_item->set_submenu (*m);
1158                                 send_menu_item->set_sensitive (true);
1159                         } else {
1160                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
1161                                 send_menu_item->set_sensitive (false);
1162                         }
1163                 } else {
1164                         send_menu_item->set_sensitive (false);
1165                 }
1166         }
1167
1168         /* Sensitise actions as approprioate */
1169
1170         cut_action->set_sensitive (can_cut());
1171         paste_action->set_sensitive (!_rr_selection.processors.empty());
1172
1173         const bool sensitive = !processor_display.selection().empty();
1174         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, sensitive);
1175         edit_action->set_sensitive (one_processor_can_be_edited ());
1176         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
1177
1178         boost::shared_ptr<PluginInsert> pi;
1179         if (single_selection) {
1180                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
1181         }
1182
1183         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
1184         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
1185
1186         /* disallow rename for multiple selections, for plugin inserts and for the fader */
1187         rename_action->set_sensitive (single_selection && !pi && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ()));
1188
1189         processor_menu->popup (1, arg);
1190
1191         /* Add a placeholder gap to the processor list to indicate where a processor would be
1192            inserted were one chosen from the menu.
1193         */
1194         int x, y;
1195         processor_display.get_pointer (x, y);
1196         _placement = processor_display.add_placeholder (y);
1197
1198         if (_visible_prefader_processors == 0 && _placement > 0) {
1199                 --_placement;
1200         }
1201 }
1202
1203 bool
1204 ProcessorBox::enter_notify (GdkEventCrossing*)
1205 {
1206         _current_processor_box = this;
1207         return false;
1208 }
1209
1210 bool
1211 ProcessorBox::leave_notify (GdkEventCrossing*)
1212 {
1213         return false;
1214 }
1215
1216 bool
1217 ProcessorBox::processor_operation (ProcessorOperation op) 
1218 {
1219         ProcSelection targets;
1220
1221         get_selected_processors (targets);
1222
1223 /*      if (targets.empty()) {
1224
1225                 int x, y;
1226                 processor_display.get_pointer (x, y);
1227
1228                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
1229
1230                 if (pointer.first && pointer.first->processor()) {
1231                         targets.push_back (pointer.first->processor ());
1232                 }
1233         }
1234 */
1235
1236         if ( (op == ProcessorsDelete) && targets.empty() )
1237                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
1238         
1239         switch (op) {
1240         case ProcessorsSelectAll:
1241                 processor_display.select_all ();
1242                 break;
1243
1244         case ProcessorsSelectNone:
1245                 processor_display.select_none ();
1246                 break;
1247
1248         case ProcessorsCopy:
1249                 copy_processors (targets);
1250                 break;
1251
1252         case ProcessorsCut:
1253                 cut_processors (targets);
1254                 break;
1255
1256         case ProcessorsPaste:
1257                 if (targets.empty()) {
1258                         paste_processors ();
1259                 } else {
1260                         paste_processors (targets.front());
1261                 }
1262                 break;
1263
1264         case ProcessorsDelete:
1265                 delete_processors (targets);
1266                 break;
1267
1268         case ProcessorsToggleActive:
1269                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
1270                         if ((*i)->active()) {
1271                                 (*i)->deactivate ();
1272                         } else {
1273                                 (*i)->activate ();
1274                         }
1275                 }
1276                 break;
1277
1278         case ProcessorsAB:
1279                 ab_plugins ();
1280                 break;
1281
1282         default:
1283                 break;
1284         }
1285         
1286         return true;
1287 }
1288
1289 ProcessorWindowProxy* 
1290 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
1291 {
1292         return  processor->window_proxy();
1293 }
1294
1295
1296 bool
1297 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
1298 {
1299         boost::shared_ptr<Processor> processor;
1300         if (child) {
1301                 processor = child->processor ();
1302         }
1303
1304         int ret = false;
1305         bool selected = processor_display.selected (child);
1306
1307         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
1308
1309                 if (_session->engine().connected()) {
1310                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
1311
1312                         if (!one_processor_can_be_edited ()) {
1313                                 return true;
1314                         }
1315
1316                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1317                                 generic_edit_processor (processor);
1318                         } else {
1319                                 edit_processor (processor);
1320                         }
1321                 }
1322
1323                 ret = true;
1324
1325         } else if (Keyboard::is_context_menu_event (ev)) {
1326
1327                 show_processor_menu (ev->time);
1328                 
1329                 ret = true;
1330
1331         } else if (processor && ev->button == 1 && selected) {
1332
1333                 // this is purely informational but necessary for route params UI
1334                 ProcessorSelected (processor); // emit
1335
1336         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
1337
1338                 choose_plugin ();
1339                 _get_plugin_selector()->show_manager ();
1340         }
1341
1342         return ret;
1343 }
1344
1345 bool
1346 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
1347 {
1348         boost::shared_ptr<Processor> processor;
1349         if (child) {
1350                 processor = child->processor ();
1351         }
1352
1353         if (processor && Keyboard::is_delete_event (ev)) {
1354
1355                 Glib::signal_idle().connect (sigc::bind (
1356                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
1357                                 boost::weak_ptr<Processor>(processor)));
1358
1359         } else if (processor && Keyboard::is_button2_event (ev)
1360 #ifndef GTKOSX
1361                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
1362 #endif
1363                 ) {
1364
1365                 /* button2-click with no/appropriate modifiers */
1366
1367                 if (processor->active()) {
1368                         processor->deactivate ();
1369                 } else {
1370                         processor->activate ();
1371                 }
1372         }
1373
1374         return false;
1375 }
1376
1377 Menu *
1378 ProcessorBox::build_processor_menu ()
1379 {
1380         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
1381         processor_menu->set_name ("ArdourContextMenu");
1382         return processor_menu;
1383 }
1384
1385 void
1386 ProcessorBox::select_all_processors ()
1387 {
1388         processor_display.select_all ();
1389 }
1390
1391 void
1392 ProcessorBox::deselect_all_processors ()
1393 {
1394         processor_display.select_none ();
1395 }
1396
1397 void
1398 ProcessorBox::choose_plugin ()
1399 {
1400         _get_plugin_selector()->set_interested_object (*this);
1401 }
1402
1403 /** @return true if an error occurred, otherwise false */
1404 bool
1405 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
1406 {
1407         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
1408
1409                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
1410
1411                 Route::ProcessorStreams err_streams;
1412
1413                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1414                         weird_plugin_dialog (**p, err_streams);
1415                         return true;
1416                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
1417                 } else {
1418
1419                         if (Profile->get_sae()) {
1420                                 processor->activate ();
1421                         }
1422                 }
1423         }
1424
1425         return false;
1426 }
1427
1428 void
1429 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
1430 {
1431         ArdourDialog dialog (_("Plugin Incompatibility"));
1432         Label label;
1433
1434         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
1435                         p.name(), streams.index);
1436
1437         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
1438         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
1439
1440         text += _("\nThis plugin has:\n");
1441         if (has_midi) {
1442                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
1443                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
1444         }
1445         if (has_audio) {
1446                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
1447                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
1448         }
1449
1450         text += _("\nbut at the insertion point, there are:\n");
1451         if (has_midi) {
1452                 uint32_t const n = streams.count.n_midi ();
1453                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
1454         }
1455         if (has_audio) {
1456                 uint32_t const n = streams.count.n_audio ();
1457                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
1458         }
1459
1460         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
1461         label.set_text(text);
1462
1463         dialog.get_vbox()->pack_start (label);
1464         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1465
1466         dialog.set_name (X_("PluginIODialog"));
1467         dialog.set_modal (true);
1468         dialog.show_all ();
1469
1470         dialog.run ();
1471 }
1472
1473 void
1474 ProcessorBox::choose_insert ()
1475 {
1476         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
1477         _route->add_processor_by_index (processor, _placement);
1478 }
1479
1480 /* Caller must not hold process lock */
1481 void
1482 ProcessorBox::choose_send ()
1483 {
1484         boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
1485         boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
1486
1487         /* make an educated guess at the initial number of outputs for the send */
1488         ChanCount outs = (_session->master_out())
1489                         ? _session->master_out()->n_outputs()
1490                         : _route->n_outputs();
1491
1492         /* XXX need processor lock on route */
1493         try {
1494                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1495                 send->output()->ensure_io (outs, false, this);
1496         } catch (AudioEngine::PortRegistrationFailure& err) {
1497                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
1498                 return;
1499         }
1500
1501         /* let the user adjust the IO setup before creation.
1502
1503            Note: this dialog is NOT modal - we just leave it to run and it will
1504            return when its Finished signal is emitted - typically when the window
1505            is closed.
1506          */
1507
1508         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
1509         ios->show ();
1510
1511         /* keep a reference to the send so it doesn't get deleted while
1512            the IOSelectorWindow is doing its stuff
1513         */
1514         _processor_being_created = send;
1515
1516         ios->selector().Finished.connect (sigc::bind (
1517                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
1518                         boost::weak_ptr<Processor>(send), ios));
1519
1520 }
1521
1522 void
1523 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1524 {
1525         boost::shared_ptr<Processor> processor (weak_processor.lock());
1526
1527         /* drop our temporary reference to the new send */
1528         _processor_being_created.reset ();
1529
1530         if (!processor) {
1531                 return;
1532         }
1533
1534         switch (r) {
1535         case IOSelector::Cancelled:
1536                 // processor will go away when all shared_ptrs to it vanish
1537                 break;
1538
1539         case IOSelector::Accepted:
1540                 _route->add_processor_by_index (processor, _placement);
1541                 if (Profile->get_sae()) {
1542                         processor->activate ();
1543                 }
1544                 break;
1545         }
1546
1547         delete_when_idle (ios);
1548 }
1549
1550 void
1551 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1552 {
1553         boost::shared_ptr<Processor> processor (weak_processor.lock());
1554
1555         /* drop our temporary reference to the new return */
1556         _processor_being_created.reset ();
1557
1558         if (!processor) {
1559                 return;
1560         }
1561
1562         switch (r) {
1563         case IOSelector::Cancelled:
1564                 // processor will go away when all shared_ptrs to it vanish
1565                 break;
1566
1567         case IOSelector::Accepted:
1568                 _route->add_processor_by_index (processor, _placement);
1569                 if (Profile->get_sae()) {
1570                         processor->activate ();
1571                 }
1572                 break;
1573         }
1574
1575         delete_when_idle (ios);
1576 }
1577
1578 void
1579 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
1580 {
1581         if (!_route) {
1582                 return;
1583         }
1584
1585         boost::shared_ptr<Route> target = wr.lock();
1586
1587         if (!target) {
1588                 return;
1589         }
1590
1591         _session->add_internal_send (target, _placement, _route);
1592 }
1593
1594 void
1595 ProcessorBox::route_processors_changed (RouteProcessorChange c)
1596 {
1597         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
1598                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
1599                 return;
1600         }
1601
1602         redisplay_processors ();
1603 }
1604
1605 void
1606 ProcessorBox::redisplay_processors ()
1607 {
1608         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
1609         bool     fader_seen;
1610
1611         if (no_processor_redisplay) {
1612                 return;
1613         }
1614
1615         processor_display.clear ();
1616
1617         _visible_prefader_processors = 0;
1618         fader_seen = false;
1619
1620         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors), 
1621                                                &_visible_prefader_processors, &fader_seen));
1622
1623         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
1624         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
1625         setup_entry_positions ();
1626 }
1627
1628 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
1629  *  not already have one.
1630  */
1631 void
1632 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
1633 {
1634         boost::shared_ptr<Processor> p = w.lock ();
1635         if (!p) {
1636                 return;
1637         }
1638         if (p->window_proxy()) {
1639                 return;
1640         }
1641
1642         /* not on the list; add it */
1643
1644         string loc;
1645 #if 0 // is this still needed? Why?
1646         if (_parent_strip) {
1647                 if (_parent_strip->mixer_owned()) {
1648                         loc = X_("M");
1649                 } else {
1650                         loc = X_("R");
1651                 }
1652         } else {
1653                 loc = X_("P");
1654         }
1655 #else
1656         loc = X_("P");
1657 #endif
1658
1659         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
1660                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
1661                 this,
1662                 w);
1663
1664         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
1665
1666         if (ui_xml) {
1667                 wp->set_state (*ui_xml);
1668         }
1669         
1670         void* existing_ui = p->get_ui ();
1671
1672         if (existing_ui) {
1673                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
1674         }
1675
1676         p->set_window_proxy (wp);
1677         WM::Manager::instance().register_window (wp);
1678 }
1679
1680 void
1681 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
1682 {
1683         boost::shared_ptr<Processor> processor (p.lock ());
1684
1685         if (processor && processor->display_to_user()) {
1686
1687                 if (boost::dynamic_pointer_cast<Amp>(processor)) {
1688                         *amp_seen = true;
1689                 } else {
1690                         if (!*amp_seen) {
1691                                 (*cnt)++;
1692                         }
1693                 }
1694         }
1695 }
1696
1697 void
1698 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
1699 {
1700         boost::shared_ptr<Processor> processor (p.lock ());
1701
1702         if (!processor || !processor->display_to_user()) {
1703                 return;
1704         }
1705
1706         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
1707         
1708         ProcessorEntry* e = 0;
1709         if (plugin_insert) {
1710                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
1711         } else {
1712                 e = new ProcessorEntry (this, processor, _width);
1713         }
1714
1715         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
1716         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
1717         
1718         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
1719         if (!send && !plugin_insert && !ext)
1720                 e->set_selectable(false);
1721
1722         bool mark_send_visible = false;
1723         if (send && _parent_strip) {
1724                 /* show controls of new sends by default */
1725                 GUIObjectState& st = _parent_strip->gui_object_state ();
1726                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
1727                 assert (strip);
1728                 /* check if state exists, if not it must be a new send */
1729                 if (!st.get_node(strip, e->state_id())) {
1730                         mark_send_visible = true;
1731                 }
1732         }
1733
1734         /* Set up this entry's state from the GUIObjectState */
1735         XMLNode* proc = entry_gui_object_state (e);
1736         if (proc) {
1737                 e->set_control_state (proc);
1738         }
1739
1740         if (mark_send_visible) {
1741                 e->show_all_controls ();
1742         }
1743
1744         processor_display.add_child (e);
1745 }
1746
1747 void
1748 ProcessorBox::reordered ()
1749 {
1750         compute_processor_sort_keys ();
1751         setup_entry_positions ();
1752 }
1753
1754 void
1755 ProcessorBox::setup_entry_positions ()
1756 {
1757         list<ProcessorEntry*> children = processor_display.children ();
1758         bool pre_fader = true;
1759
1760         uint32_t num = 0;
1761         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1762                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor())) {
1763                         pre_fader = false;
1764                         (*i)->set_position (ProcessorEntry::Fader, num++);
1765                 } else {
1766                         if (pre_fader) {
1767                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
1768                         } else {
1769                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
1770                         }
1771                 }
1772         }
1773 }
1774
1775 void
1776 ProcessorBox::compute_processor_sort_keys ()
1777 {
1778         list<ProcessorEntry*> children = processor_display.children ();
1779         Route::ProcessorList our_processors;
1780
1781         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1782                 if ((*i)->processor()) {
1783                         our_processors.push_back ((*i)->processor ());
1784                 }
1785         }
1786
1787         if (_route->reorder_processors (our_processors)) {
1788                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
1789                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
1790                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
1791                    when the drag is torn down after this handler function is finished.
1792                 */
1793                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
1794         }
1795 }
1796
1797 void
1798 ProcessorBox::report_failed_reorder ()
1799 {
1800         /* reorder failed, so redisplay */
1801
1802         redisplay_processors ();
1803
1804         /* now tell them about the problem */
1805
1806         ArdourDialog dialog (_("Plugin Incompatibility"));
1807         Label label;
1808
1809         label.set_text (_("\
1810 You cannot reorder these plugins/sends/inserts\n\
1811 in that way because the inputs and\n\
1812 outputs will not work correctly."));
1813
1814         dialog.get_vbox()->set_border_width (12);
1815         dialog.get_vbox()->pack_start (label);
1816         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1817
1818         dialog.set_name (X_("PluginIODialog"));
1819         dialog.set_modal (true);
1820         dialog.show_all ();
1821
1822         dialog.run ();
1823 }
1824
1825 void
1826 ProcessorBox::rename_processors ()
1827 {
1828         ProcSelection to_be_renamed;
1829
1830         get_selected_processors (to_be_renamed);
1831
1832         if (to_be_renamed.empty()) {
1833                 return;
1834         }
1835
1836         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
1837                 rename_processor (*i);
1838         }
1839 }
1840
1841 bool
1842 ProcessorBox::can_cut () const
1843 {
1844         vector<boost::shared_ptr<Processor> > sel;
1845
1846         get_selected_processors (sel);
1847
1848         /* cut_processors () does not cut inserts */
1849
1850         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
1851
1852                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1853                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1854                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1855                         return true;
1856                 }
1857         }
1858
1859         return false;
1860 }
1861
1862 void
1863 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
1864 {
1865         if (to_be_removed.empty()) {
1866                 return;
1867         }
1868
1869         XMLNode* node = new XMLNode (X_("cut"));
1870         Route::ProcessorList to_cut;
1871
1872         no_processor_redisplay = true;
1873         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
1874                 // Cut only plugins, sends and returns
1875                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1876                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1877                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1878
1879                         Window* w = get_processor_ui (*i);
1880
1881                         if (w) {
1882                                 w->hide ();
1883                         }
1884
1885                         XMLNode& child ((*i)->get_state());
1886                         node->add_child_nocopy (child);
1887                         to_cut.push_back (*i);
1888                 }
1889         }
1890
1891         if (_route->remove_processors (to_cut) != 0) {
1892                 delete node;
1893                 no_processor_redisplay = false;
1894                 return;
1895         }
1896
1897         _rr_selection.set (node);
1898
1899         no_processor_redisplay = false;
1900         redisplay_processors ();
1901 }
1902
1903 void
1904 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
1905 {
1906         if (to_be_copied.empty()) {
1907                 return;
1908         }
1909
1910         XMLNode* node = new XMLNode (X_("copy"));
1911
1912         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
1913                 // Copy only plugins, sends, returns
1914                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
1915                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
1916                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
1917                         node->add_child_nocopy ((*i)->get_state());
1918                 }
1919         }
1920
1921         _rr_selection.set (node);
1922 }
1923
1924 void
1925 ProcessorBox::delete_processors (const ProcSelection& targets)
1926 {
1927         if (targets.empty()) {
1928                 return;
1929         }
1930
1931         no_processor_redisplay = true;
1932
1933         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
1934
1935                 Window* w = get_processor_ui (*i);
1936
1937                 if (w) {
1938                         w->hide ();
1939                 }
1940
1941                 _route->remove_processor(*i);
1942         }
1943
1944         no_processor_redisplay = false;
1945         redisplay_processors ();
1946 }
1947
1948 void
1949 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
1950 {
1951         list<boost::shared_ptr<Processor> >::const_iterator x;
1952
1953         no_processor_redisplay = true;
1954         for (x = procs.begin(); x != procs.end(); ++x) {
1955
1956                 Window* w = get_processor_ui (*x);
1957
1958                 if (w) {
1959                         w->hide ();
1960                 }
1961
1962                 _route->remove_processor(*x);
1963         }
1964
1965         no_processor_redisplay = false;
1966         redisplay_processors ();
1967 }
1968
1969 gint
1970 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
1971 {
1972         boost::shared_ptr<Processor> processor (weak_processor.lock());
1973
1974         if (!processor) {
1975                 return false;
1976         }
1977
1978         /* NOT copied to _mixer.selection() */
1979
1980         no_processor_redisplay = true;
1981         _route->remove_processor (processor);
1982         no_processor_redisplay = false;
1983         redisplay_processors ();
1984
1985         return false;
1986 }
1987
1988 void
1989 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
1990 {
1991         ArdourPrompter name_prompter (true);
1992         string result;
1993         name_prompter.set_title (_("Rename Processor"));
1994         name_prompter.set_prompt (_("New name:"));
1995         name_prompter.set_initial_text (processor->name());
1996         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
1997         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
1998         name_prompter.show_all ();
1999
2000         switch (name_prompter.run ()) {
2001
2002         case Gtk::RESPONSE_ACCEPT:
2003                 name_prompter.get_result (result);
2004                 if (result.length()) {
2005
2006                        int tries = 0;
2007                        string test = result;
2008
2009                        while (tries < 100) {
2010                                if (_session->io_name_is_legal (test)) {
2011                                        result = test;
2012                                        break;
2013                                }
2014                                tries++;
2015
2016                                test = string_compose ("%1-%2", result, tries);
2017                        }
2018
2019                        if (tries < 100) {
2020                                processor->set_name (result);
2021                        } else {
2022                                /* unlikely! */
2023                                ARDOUR_UI::instance()->popup_error
2024                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
2025                        }
2026                 }
2027                 break;
2028         }
2029
2030         return;
2031 }
2032
2033 void
2034 ProcessorBox::paste_processors ()
2035 {
2036         if (_rr_selection.processors.empty()) {
2037                 return;
2038         }
2039
2040         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
2041 }
2042
2043 void
2044 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
2045 {
2046
2047         if (_rr_selection.processors.empty()) {
2048                 return;
2049         }
2050
2051         paste_processor_state (_rr_selection.processors.get_node().children(), before);
2052 }
2053
2054 void
2055 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
2056 {
2057         XMLNodeConstIterator niter;
2058         list<boost::shared_ptr<Processor> > copies;
2059
2060         if (nlist.empty()) {
2061                 return;
2062         }
2063
2064         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2065
2066                 XMLProperty const * type = (*niter)->property ("type");
2067                 XMLProperty const * role = (*niter)->property ("role");
2068                 assert (type);
2069
2070                 boost::shared_ptr<Processor> p;
2071                 try {
2072                         if (type->value() == "meter" ||
2073                             type->value() == "main-outs" ||
2074                             type->value() == "amp" ||
2075                             type->value() == "intreturn") {
2076                                 /* do not paste meter, main outs, amp or internal returns */
2077                                 continue;
2078
2079                         } else if (type->value() == "intsend") {
2080                                 
2081                                 /* aux sends are OK, but those used for
2082                                  * other purposes, are not.
2083                                  */
2084                                 
2085                                 assert (role);
2086
2087                                 if (role->value() != "Aux") {
2088                                         continue;
2089                                 }
2090
2091                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2092                                 XMLNode n (**niter);
2093                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
2094                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
2095
2096                                 IOProcessor::prepare_for_reset (n, s->name());
2097
2098                                 if (s->set_state (n, Stateful::loading_state_version)) {
2099                                         delete s;
2100                                         return;
2101                                 }
2102
2103                                 p.reset (s);
2104
2105                         } else if (type->value() == "send") {
2106
2107                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2108                                 XMLNode n (**niter);
2109
2110                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
2111
2112                                 IOProcessor::prepare_for_reset (n, s->name());
2113                                 
2114                                 if (s->set_state (n, Stateful::loading_state_version)) {
2115                                         delete s;
2116                                         return;
2117                                 }
2118
2119                                 p.reset (s);
2120
2121                         } else if (type->value() == "return") {
2122
2123                                 XMLNode n (**niter);
2124                                 Return* r = new Return (*_session);
2125
2126                                 IOProcessor::prepare_for_reset (n, r->name());
2127
2128                                 if (r->set_state (n, Stateful::loading_state_version)) {
2129                                         delete r;
2130                                         return;
2131                                 }
2132
2133                                 p.reset (r);
2134
2135                         } else if (type->value() == "port") {
2136
2137                                 XMLNode n (**niter);
2138                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
2139                                 
2140                                 IOProcessor::prepare_for_reset (n, pi->name());
2141                                 
2142                                 if (pi->set_state (n, Stateful::loading_state_version)) {
2143                                         return;
2144                                 }
2145                                 
2146                                 p.reset (pi);
2147
2148                         } else {
2149                                 /* XXX its a bit limiting to assume that everything else
2150                                    is a plugin.
2151                                 */
2152
2153                                 p.reset (new PluginInsert (*_session));
2154                                 p->set_state (**niter, Stateful::current_state_version);
2155                         }
2156
2157                         copies.push_back (p);
2158                 }
2159
2160                 catch (...) {
2161                         error << _("plugin insert constructor failed") << endmsg;
2162                 }
2163         }
2164
2165         if (copies.empty()) {
2166                 return;
2167         }
2168
2169         if (_route->add_processors (copies, p)) {
2170
2171                 string msg = _(
2172                         "Copying the set of processors on the clipboard failed,\n\
2173 probably because the I/O configuration of the plugins\n\
2174 could not match the configuration of this track.");
2175                 MessageDialog am (msg);
2176                 am.run ();
2177         }
2178 }
2179
2180 void
2181 ProcessorBox::get_selected_processors (ProcSelection& processors) const
2182 {
2183         const list<ProcessorEntry*> selection = processor_display.selection ();
2184         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
2185                 processors.push_back ((*i)->processor ());
2186         }
2187 }
2188
2189 void
2190 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
2191 {
2192         list<ProcessorEntry*> selection = processor_display.selection ();
2193         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
2194                 (this->*method) ((*i)->processor ());
2195         }
2196 }
2197
2198 void
2199 ProcessorBox::all_visible_processors_active (bool state)
2200 {
2201         _route->all_visible_processors_active (state);
2202 }
2203
2204 void
2205 ProcessorBox::ab_plugins ()
2206 {
2207         _route->ab_plugins (ab_direction);
2208         ab_direction = !ab_direction;
2209 }
2210
2211
2212 void
2213 ProcessorBox::clear_processors ()
2214 {
2215         string prompt;
2216         vector<string> choices;
2217
2218         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
2219                                    "(this cannot be undone)"), _route->name());
2220
2221         choices.push_back (_("Cancel"));
2222         choices.push_back (_("Yes, remove them all"));
2223
2224         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2225
2226         if (prompter.run () == 1) {
2227                 _route->clear_processors (PreFader);
2228                 _route->clear_processors (PostFader);
2229         }
2230 }
2231
2232 void
2233 ProcessorBox::clear_processors (Placement p)
2234 {
2235         string prompt;
2236         vector<string> choices;
2237
2238         if (p == PreFader) {
2239                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
2240                                            "(this cannot be undone)"), _route->name());
2241         } else {
2242                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
2243                                            "(this cannot be undone)"), _route->name());
2244         }
2245
2246         choices.push_back (_("Cancel"));
2247         choices.push_back (_("Yes, remove them all"));
2248
2249         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2250
2251         if (prompter.run () == 1) {
2252                 _route->clear_processors (p);
2253         }
2254 }
2255
2256 bool
2257 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2258 {
2259         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2260         if (at && at->freeze_state() == AudioTrack::Frozen) {
2261                 return false;
2262         }
2263
2264         if (
2265                 boost::dynamic_pointer_cast<Send> (processor) ||
2266                 boost::dynamic_pointer_cast<Return> (processor) ||
2267                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2268                 boost::dynamic_pointer_cast<PortInsert> (processor)
2269                 ) {
2270                 return true;
2271         }
2272
2273         return false;
2274 }
2275
2276 bool
2277 ProcessorBox::one_processor_can_be_edited ()
2278 {
2279         list<ProcessorEntry*> selection = processor_display.selection ();
2280         list<ProcessorEntry*>::iterator i = selection.begin();
2281         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2282                 ++i;
2283         }
2284
2285         return (i != selection.end());
2286 }
2287
2288 Gtk::Window*
2289 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
2290 {
2291         boost::shared_ptr<Send> send;
2292         boost::shared_ptr<InternalSend> internal_send;
2293         boost::shared_ptr<Return> retrn;
2294         boost::shared_ptr<PluginInsert> plugin_insert;
2295         boost::shared_ptr<PortInsert> port_insert;
2296         Window* gidget = 0;
2297
2298         /* This method may or may not return a Window, but if it does not it
2299          * will modify the parent mixer strip appearance layout to allow
2300          * "editing" the @param processor that was passed in.
2301          *
2302          * So for example, if the processor is an Amp (gain), the parent strip
2303          * will be forced back into a model where the fader controls the main gain.
2304          * If the processor is a send, then we map the send controls onto the
2305          * strip.
2306          * 
2307          * Plugins and others will return a window for control.
2308          */
2309
2310         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2311
2312                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2313                         return 0;
2314                 }
2315         }
2316
2317         if (boost::dynamic_pointer_cast<Amp> (processor)) {
2318
2319                 if (_parent_strip) {
2320                         _parent_strip->revert_to_default_display ();
2321                 }
2322
2323         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2324
2325                 if (!_session->engine().connected()) {
2326                         return 0;
2327                 }
2328
2329                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2330
2331                         gidget = new SendUIWindow (send, _session);
2332                 }
2333
2334         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2335
2336                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2337                         /* no GUI for these */
2338                         return 0;
2339                 }
2340
2341                 if (!_session->engine().connected()) {
2342                         return 0;
2343                 }
2344
2345                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2346
2347                 ReturnUIWindow *return_ui;
2348                 Window* w = get_processor_ui (retrn);
2349
2350                 if (w == 0) {
2351
2352                         return_ui = new ReturnUIWindow (retrn, _session);
2353                         return_ui->set_title (retrn->name ());
2354                         set_processor_ui (send, return_ui);
2355
2356                 } else {
2357                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
2358                 }
2359
2360                 gidget = return_ui;
2361
2362         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2363
2364                 PluginUIWindow *plugin_ui;
2365
2366                 /* these are both allowed to be null */
2367
2368                 Window* w = get_processor_ui (plugin_insert);
2369
2370                 if (w == 0) {
2371                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
2372                         plugin_ui->set_title (generate_processor_title (plugin_insert));
2373                         set_processor_ui (plugin_insert, plugin_ui);
2374
2375                 } else {
2376                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2377                 }
2378
2379                 gidget = plugin_ui;
2380
2381         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2382
2383                 if (!_session->engine().connected()) {
2384                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
2385                         msg.run ();
2386                         return 0;
2387                 }
2388
2389                 PortInsertWindow *io_selector;
2390
2391                 Window* w = get_processor_ui (port_insert);
2392
2393                 if (w == 0) {
2394                         io_selector = new PortInsertWindow (_session, port_insert);
2395                         set_processor_ui (port_insert, io_selector);
2396
2397                 } else {
2398                         io_selector = dynamic_cast<PortInsertWindow *> (w);
2399                 }
2400
2401                 gidget = io_selector;
2402         }
2403
2404         return gidget;
2405 }
2406
2407 Gtk::Window*
2408 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
2409 {
2410         boost::shared_ptr<PluginInsert> plugin_insert
2411                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2412
2413         if (!plugin_insert) {
2414                 return 0;
2415         }
2416
2417         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
2418         win->set_title (generate_processor_title (plugin_insert));
2419
2420         return win;
2421 }
2422
2423 void
2424 ProcessorBox::register_actions ()
2425 {
2426         Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = Gtk::ActionGroup::create(X_("ProcessorMenu"));
2427         Glib::RefPtr<Action> act;
2428
2429         /* new stuff */
2430         ActionManager::register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2431                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2432
2433         act = ActionManager::register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2434                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2435         ActionManager::engine_sensitive_actions.push_back (act);
2436         act = ActionManager::register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2437                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
2438         ActionManager::engine_sensitive_actions.push_back (act);
2439
2440         ActionManager::register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2441
2442         ActionManager::register_action (popup_act_grp, X_("controls"), _("Controls"));
2443         ActionManager::register_action (popup_act_grp, X_("send_options"), _("Send Options"));
2444
2445         ActionManager::register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2446                         sigc::ptr_fun (ProcessorBox::rb_clear));
2447         ActionManager::register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2448                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2449         ActionManager::register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2450                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
2451
2452         /* standard editing stuff */
2453         cut_action = ActionManager::register_action (popup_act_grp, X_("cut"), _("Cut"),
2454                                                      sigc::ptr_fun (ProcessorBox::rb_cut));
2455         ActionManager::plugin_selection_sensitive_actions.push_back(cut_action);
2456         act = ActionManager::register_action (popup_act_grp, X_("copy"), _("Copy"),
2457                         sigc::ptr_fun (ProcessorBox::rb_copy));
2458         ActionManager::plugin_selection_sensitive_actions.push_back(act);
2459
2460         act = ActionManager::register_action (popup_act_grp, X_("delete"), _("Delete"),
2461                         sigc::ptr_fun (ProcessorBox::rb_delete));
2462         ActionManager::plugin_selection_sensitive_actions.push_back(act); // ??
2463
2464         paste_action = ActionManager::register_action (popup_act_grp, X_("paste"), _("Paste"),
2465                         sigc::ptr_fun (ProcessorBox::rb_paste));
2466         rename_action = ActionManager::register_action (popup_act_grp, X_("rename"), _("Rename"),
2467                         sigc::ptr_fun (ProcessorBox::rb_rename));
2468         ActionManager::register_action (popup_act_grp, X_("selectall"), _("Select All"),
2469                         sigc::ptr_fun (ProcessorBox::rb_select_all));
2470         ActionManager::register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2471                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2472
2473         /* activation etc. */
2474
2475         ActionManager::register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2476                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
2477         ActionManager::register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2478                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2479         ActionManager::register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2480                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2481
2482         /* show editors */
2483         edit_action = ActionManager::register_action (
2484                 popup_act_grp, X_("edit"), _("Edit..."),
2485                 sigc::ptr_fun (ProcessorBox::rb_edit));
2486
2487         edit_generic_action = ActionManager::register_action (
2488                 popup_act_grp, X_("edit-generic"), _("Edit with generic controls..."),
2489                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2490
2491         ActionManager::add_action_group (popup_act_grp);
2492 }
2493
2494 void
2495 ProcessorBox::rb_edit_generic ()
2496 {
2497         if (_current_processor_box == 0) {
2498                 return;
2499         }
2500
2501         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
2502 }
2503
2504 void
2505 ProcessorBox::rb_ab_plugins ()
2506 {
2507         if (_current_processor_box == 0) {
2508                 return;
2509         }
2510
2511         _current_processor_box->ab_plugins ();
2512 }
2513
2514 void
2515 ProcessorBox::rb_choose_plugin ()
2516 {
2517         if (_current_processor_box == 0) {
2518                 return;
2519         }
2520         _current_processor_box->choose_plugin ();
2521 }
2522
2523 void
2524 ProcessorBox::rb_choose_insert ()
2525 {
2526         if (_current_processor_box == 0) {
2527                 return;
2528         }
2529         _current_processor_box->choose_insert ();
2530 }
2531
2532 void
2533 ProcessorBox::rb_choose_send ()
2534 {
2535         if (_current_processor_box == 0) {
2536                 return;
2537         }
2538         _current_processor_box->choose_send ();
2539 }
2540
2541 void
2542 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
2543 {
2544         if (_current_processor_box == 0) {
2545                 return;
2546         }
2547
2548         _current_processor_box->choose_aux (wr);
2549 }
2550
2551 void
2552 ProcessorBox::rb_clear ()
2553 {
2554         if (_current_processor_box == 0) {
2555                 return;
2556         }
2557
2558         _current_processor_box->clear_processors ();
2559 }
2560
2561
2562 void
2563 ProcessorBox::rb_clear_pre ()
2564 {
2565         if (_current_processor_box == 0) {
2566                 return;
2567         }
2568
2569         _current_processor_box->clear_processors (PreFader);
2570 }
2571
2572
2573 void
2574 ProcessorBox::rb_clear_post ()
2575 {
2576         if (_current_processor_box == 0) {
2577                 return;
2578         }
2579
2580         _current_processor_box->clear_processors (PostFader);
2581 }
2582
2583 void
2584 ProcessorBox::rb_cut ()
2585 {
2586         if (_current_processor_box == 0) {
2587                 return;
2588         }
2589
2590         _current_processor_box->processor_operation (ProcessorsCut);
2591 }
2592
2593 void
2594 ProcessorBox::rb_delete ()
2595 {
2596         if (_current_processor_box == 0) {
2597                 return;
2598         }
2599
2600         _current_processor_box->processor_operation (ProcessorsDelete);
2601 }
2602
2603 void
2604 ProcessorBox::rb_copy ()
2605 {
2606         if (_current_processor_box == 0) {
2607                 return;
2608         }
2609         _current_processor_box->processor_operation (ProcessorsCopy);
2610 }
2611
2612 void
2613 ProcessorBox::rb_paste ()
2614 {
2615         if (_current_processor_box == 0) {
2616                 return;
2617         }
2618
2619         _current_processor_box->processor_operation (ProcessorsPaste);
2620 }
2621
2622 void
2623 ProcessorBox::rb_rename ()
2624 {
2625         if (_current_processor_box == 0) {
2626                 return;
2627         }
2628         _current_processor_box->rename_processors ();
2629 }
2630
2631 void
2632 ProcessorBox::rb_select_all ()
2633 {
2634         if (_current_processor_box == 0) {
2635                 return;
2636         }
2637
2638         _current_processor_box->processor_operation (ProcessorsSelectAll);
2639 }
2640
2641 void
2642 ProcessorBox::rb_deselect_all ()
2643 {
2644         if (_current_processor_box == 0) {
2645                 return;
2646         }
2647
2648         _current_processor_box->deselect_all_processors ();
2649 }
2650
2651 void
2652 ProcessorBox::rb_activate_all ()
2653 {
2654         if (_current_processor_box == 0) {
2655                 return;
2656         }
2657
2658         _current_processor_box->all_visible_processors_active (true);
2659 }
2660
2661 void
2662 ProcessorBox::rb_deactivate_all ()
2663 {
2664         if (_current_processor_box == 0) {
2665                 return;
2666         }
2667         _current_processor_box->all_visible_processors_active (false);
2668 }
2669
2670 void
2671 ProcessorBox::rb_edit ()
2672 {
2673         if (_current_processor_box == 0) {
2674                 return;
2675         }
2676
2677         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
2678 }
2679
2680 bool
2681 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
2682 {
2683         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2684                 return false;
2685         }
2686
2687         if (_parent_strip) {
2688                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2689                 if (_parent_strip->current_delivery() == send) {
2690                         _parent_strip->revert_to_default_display ();
2691                 } else {
2692                         _parent_strip->show_send(send);
2693                 }
2694         }
2695         return true;
2696 }
2697
2698 void
2699 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
2700 {
2701         if (!processor) {
2702                 return;
2703         }
2704         if (edit_aux_send (processor)) {
2705                 return;
2706         }
2707
2708         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2709
2710         if (proxy) {
2711                 proxy->set_custom_ui_mode (true);
2712                 proxy->toggle ();
2713         }
2714 }
2715
2716 void
2717 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
2718 {
2719         if (!processor) {
2720                 return;
2721         }
2722         if (edit_aux_send (processor)) {
2723                 return;
2724         }
2725
2726         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2727
2728         if (proxy) {
2729                 proxy->set_custom_ui_mode (false);
2730                 proxy->toggle ();
2731         }
2732 }
2733
2734 void
2735 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
2736 {
2737         if (!what_changed.contains (ARDOUR::Properties::name)) {
2738                 return;
2739         }
2740
2741         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
2742
2743         boost::shared_ptr<Processor> processor;
2744         boost::shared_ptr<PluginInsert> plugin_insert;
2745         boost::shared_ptr<Send> send;
2746
2747         list<ProcessorEntry*> children = processor_display.children();
2748
2749         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
2750
2751                 processor = (*iter)->processor ();
2752
2753                 if (!processor) {
2754                         continue;
2755                 }
2756
2757                 Window* w = get_processor_ui (processor);
2758
2759                 if (!w) {
2760                         continue;
2761                 }
2762
2763                 /* rename editor windows for sends and plugins */
2764
2765                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2766                         w->set_title (send->name ());
2767                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2768                         w->set_title (generate_processor_title (plugin_insert));
2769                 }
2770         }
2771 }
2772
2773 string
2774 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
2775 {
2776         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
2777         string::size_type email_pos;
2778
2779         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
2780                 maker = maker.substr (0, email_pos - 1);
2781         }
2782
2783         if (maker.length() > 32) {
2784                 maker = maker.substr (0, 32);
2785                 maker += " ...";
2786         }
2787
2788         SessionObject* owner = pi->owner();
2789
2790         if (owner) {
2791                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
2792         } else {
2793                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
2794         }
2795 }
2796
2797 /** @param p Processor.
2798  *  @return the UI window for \a p.
2799  */
2800 Window *
2801 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
2802 {
2803         ProcessorWindowProxy* wp = p->window_proxy();
2804         if (wp) {
2805                 return wp->get ();
2806         }
2807         return 0;
2808 }
2809
2810 /** Make a note of the UI window that a processor is using.
2811  *  @param p Processor.
2812  *  @param w UI window.
2813  */
2814 void
2815 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
2816 {
2817         assert (p->window_proxy());
2818         p->set_ui (w);
2819         p->window_proxy()->use_window (*w);
2820 }
2821
2822 void
2823 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
2824 {
2825         boost::shared_ptr<Delivery> d = w.lock ();
2826         if (!d) {
2827                 return;
2828         }
2829
2830         list<ProcessorEntry*> children = processor_display.children ();
2831         list<ProcessorEntry*>::const_iterator i = children.begin();
2832         while (i != children.end() && (*i)->processor() != d) {
2833                 ++i;
2834         }
2835
2836         if (i == children.end()) {
2837                 processor_display.set_active (0);
2838         } else {
2839                 processor_display.set_active (*i);
2840         }
2841 }
2842
2843 /** Called to repair the damage of Editor::show_window doing a show_all() */
2844 void
2845 ProcessorBox::hide_things ()
2846 {
2847         list<ProcessorEntry*> c = processor_display.children ();
2848         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
2849                 (*i)->hide_things ();
2850         }
2851 }
2852
2853 void
2854 ProcessorBox::processor_menu_unmapped ()
2855 {
2856         processor_display.remove_placeholder ();
2857 }
2858
2859 XMLNode *
2860 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
2861 {
2862         if (!_parent_strip) {
2863                 return 0;
2864         }
2865
2866         GUIObjectState& st = _parent_strip->gui_object_state ();
2867         
2868         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2869         assert (strip);
2870         return st.get_or_add_node (strip, entry->state_id());
2871 }
2872
2873 void
2874 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
2875 {
2876         XMLNode* proc = entry_gui_object_state (entry);
2877         if (!proc) {
2878                 return;
2879         }
2880
2881         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
2882         proc->remove_nodes_and_delete (X_("Object"));
2883         entry->add_control_state (proc);
2884 }
2885
2886 bool
2887 ProcessorBox::is_editor_mixer_strip() const
2888 {
2889         return _parent_strip && !_parent_strip->mixer_owned();
2890 }
2891
2892 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
2893         : WM::ProxyBase (name, string())
2894         , _processor_box (box)
2895         , _processor (processor)
2896         , is_custom (false)
2897         , want_custom (false)
2898 {
2899         boost::shared_ptr<Processor> p = _processor.lock ();
2900         if (!p) {
2901                 return;
2902         }
2903         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
2904 }
2905
2906 ProcessorWindowProxy::~ProcessorWindowProxy()
2907 {
2908         /* processor window proxies do not own the windows they create with
2909          * ::get(), so set _window to null before the normal WindowProxy method
2910          * deletes it.
2911          */
2912         _window = 0;
2913 }
2914
2915 void
2916 ProcessorWindowProxy::processor_going_away ()
2917 {
2918         delete _window;
2919         _window = 0;
2920         WM::Manager::instance().remove (this);
2921         /* should be no real reason to do this, since the object that would
2922            send DropReferences is about to be deleted, but lets do it anyway.
2923         */
2924         going_away_connection.disconnect();
2925 }
2926
2927 ARDOUR::SessionHandlePtr*
2928 ProcessorWindowProxy::session_handle() 
2929 {
2930         /* we don't care */
2931         return 0;
2932 }
2933
2934 XMLNode&
2935 ProcessorWindowProxy::get_state () const
2936 {
2937         XMLNode *node;
2938         node = &ProxyBase::get_state();
2939         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
2940         return *node;
2941 }
2942
2943 void
2944 ProcessorWindowProxy::set_state (const XMLNode& node)
2945 {
2946         XMLNodeList children = node.children ();
2947         XMLNodeList::const_iterator i = children.begin ();
2948         while (i != children.end()) {
2949                 XMLProperty* prop = (*i)->property (X_("name"));
2950                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
2951                         break;
2952                 }
2953                 ++i;
2954         }
2955
2956         if (i != children.end()) {
2957                 XMLProperty* prop;
2958                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
2959                         want_custom = PBD::string_is_affirmative (prop->value ());
2960                 }
2961         }
2962
2963         ProxyBase::set_state(node);
2964 }
2965
2966 Gtk::Window*
2967 ProcessorWindowProxy::get (bool create)
2968 {
2969         boost::shared_ptr<Processor> p = _processor.lock ();
2970
2971         if (!p) {
2972                 return 0;
2973         }
2974         if (_window && (is_custom != want_custom)) {
2975                 /* drop existing window - wrong type */
2976                 drop_window ();
2977         }
2978
2979         if (!_window) {
2980                 if (!create) {
2981                         return 0;
2982                 }
2983                 
2984                 is_custom = want_custom;
2985                 _window = _processor_box->get_editor_window (p, is_custom);
2986
2987                 if (_window) {
2988                         setup ();
2989                 }
2990         }
2991
2992         return _window;
2993 }
2994
2995 void
2996 ProcessorWindowProxy::toggle ()
2997 {
2998         if (_window && (is_custom != want_custom)) {
2999                 /* drop existing window - wrong type */
3000                 drop_window ();
3001         }
3002         is_custom = want_custom;
3003
3004         WM::ProxyBase::toggle ();
3005 }