gtk2_ardour/processor_box.cc

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