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