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