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 "pbd/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 (*this, 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 (*this, 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->enabled ());
 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->enable (false);
 444                                 }
 445                         }
 446                         else {
 447                                 _processor->enable (false);
 448                         }
 449
 450                 } else {
 451                         if (ctrl_shift_pressed) {
 452                                 _parent->all_visible_processors_active(true);
 453
 454                                 if (_position == Fader) {
 455                                         _processor->enable (true);
 456                                 }
 457                         }
 458                         else {
 459                                 _processor->enable (true);
 460                         }
 461                 }
 462         }
 463 }
 464
 465 void
 466 ProcessorEntry::processor_active_changed ()
 467 {
 468         if (_processor) {
 469                 _button.set_active (_processor->enabled ());
 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 (ProcessorEntry& e, boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1512         : _entry (e)
1513         , _plug (p)
1514         , _surf (0)
1515         , _max_height (max_height)
1516         , _cur_height (1)
1517         , _scroll (false)
1518 {
1519         set_name ("processor prefader");
1520         add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
1521         _plug->DropReferences.connect (_death_connection, invalidator (*this), boost::bind (&PluginDisplay::plugin_going_away, this), gui_context());
1522         _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1523                         boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1524
1525         std::string postfix = "";
1526         if (_plug->has_editor()) {
1527                 ARDOUR_UI_UTILS::set_tooltip (*this,
1528                                 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), e.name (Wide), Keyboard::primary_modifier_name (), postfix));
1529         } else {
1530                 ARDOUR_UI_UTILS::set_tooltip (*this,
1531                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), e.name (Wide), postfix));
1532         }
1533 }
1534
1535 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1536 {
1537         if (_surf) {
1538                 cairo_surface_destroy (_surf);
1539         }
1540 }
1541
1542 bool
1543 ProcessorEntry::PluginDisplay::on_button_press_event (GdkEventButton *ev)
1544 {
1545         assert (_entry.processor ());
1546
1547         // consider some tweaks to pass this up to the DnDVBox somehow:
1548         // select processor, then call (private)
1549         //_entry._parent->processor_button_press_event (ev, &_entry);
1550         if (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS)) {
1551                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1552                         _entry._parent->generic_edit_processor (_entry.processor ());
1553                 } else {
1554                         _entry._parent->edit_processor (_entry.processor ());
1555                 }
1556                 return true;
1557         }
1558         return false;
1559 }
1560
1561 bool
1562 ProcessorEntry::PluginDisplay::on_button_release_event (GdkEventButton *ev)
1563 {
1564         return false;
1565 }
1566
1567 void
1568 ProcessorEntry::PluginDisplay::on_size_request (Requisition* req)
1569 {
1570         req->width = 56;
1571         req->height = _cur_height;
1572 }
1573
1574
1575 void
1576 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1577 {
1578         /* work-around scroll-bar + aspect ratio
1579          * show inline-view -> height changes -> scrollbar gets added
1580          * -> width changes -> inline-view, fixed aspect ratio -> height changes
1581          * -> scroll bar is removed [-> width changes ; repeat ]
1582          */
1583         uint32_t shm = std::min (_max_height, inline_height);
1584         bool sc = false;
1585         Gtk::Container* pr = get_parent();
1586         for (uint32_t i = 0; i < 4 && pr; ++i) {
1587                 // VBox, EventBox, ViewPort, ScrolledWindow
1588                 pr = pr->get_parent();
1589         }
1590         Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1591         if (sw) {
1592                 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1593                 sc = vsb && vsb->is_visible();
1594         }
1595
1596         if (shm != _cur_height) {
1597                 if (_scroll == sc || _cur_height < shm) {
1598                         queue_resize ();
1599                 }
1600                 _cur_height = shm;
1601         }
1602         _scroll = sc;
1603 }
1604
1605 uint32_t
1606 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1607 {
1608         Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1609         if (!dis) {
1610                 return 0;
1611         }
1612
1613         /* allocate a local image-surface,
1614          * We cannot re-use the data via cairo_image_surface_create_for_data(),
1615          * since pixman keeps a reference to it.
1616          * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1617          * it might be possible to work around via cairo_surface_set_user_data().
1618          */
1619         if (!_surf
1620                         || dis->width !=  cairo_image_surface_get_width (_surf)
1621                         || dis->height !=  cairo_image_surface_get_height (_surf)
1622                  ) {
1623                 if (_surf) {
1624                         cairo_surface_destroy (_surf);
1625                 }
1626                 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1627         }
1628
1629         if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1630                 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1631         } else {
1632                 unsigned char *src = dis->data;
1633                 unsigned char *dst = cairo_image_surface_get_data (_surf);
1634                 const int dst_stride =  cairo_image_surface_get_stride (_surf);
1635                 for (int y = 0; y < dis->height; ++y) {
1636                         memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1637                         src += dis->stride;
1638                         dst += dst_stride;
1639                 }
1640         }
1641
1642         cairo_surface_flush(_surf);
1643         cairo_surface_mark_dirty(_surf);
1644         const double xc = floor ((width - dis->width) * .5);
1645         cairo_set_source_surface(cr, _surf, xc, 0);
1646         cairo_paint (cr);
1647
1648         return dis->height;
1649 }
1650
1651 bool
1652 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1653 {
1654         Gtk::Allocation a = get_allocation();
1655         double const width = a.get_width();
1656         double const height = a.get_height();
1657
1658         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1659         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1660         cairo_clip (cr);
1661
1662         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1663         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1664         cairo_rectangle (cr, 0, 0, width, height);
1665         cairo_fill (cr);
1666
1667         cairo_save (cr);
1668         cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1669         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1670         cairo_clip (cr);
1671         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1672
1673         uint32_t ht = render_inline (cr, width);
1674         cairo_restore (cr);
1675
1676         if (ht == 0) {
1677                 hide ();
1678                 if (_cur_height != 1) {
1679                         _cur_height = 1;
1680                         queue_resize ();
1681                 }
1682                 cairo_destroy (cr);
1683                 return true;
1684         } else {
1685                 update_height_alloc (ht);
1686         }
1687
1688         bool failed = false;
1689         std::string name = get_name();
1690         ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1691
1692         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1693         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1694         cairo_set_line_width(cr, 1.0);
1695         ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1696         cairo_stroke (cr);
1697
1698         cairo_destroy(cr);
1699         return true;
1700 }
1701
1702 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1703         : PluginDisplay (e, p, max_height)
1704         , _luaproc (p)
1705         , _lua_render_inline (0)
1706 {
1707         p->setup_lua_inline_gui (&lua_gui);
1708
1709         lua_State* LG = lua_gui.getState ();
1710         LuaInstance::bind_cairo (LG);
1711         luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1712         assert (lua_render.isFunction ());
1713         _lua_render_inline = new luabridge::LuaRef (lua_render);
1714 }
1715
1716 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1717 {
1718         delete (_lua_render_inline);
1719 }
1720
1721 uint32_t
1722 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1723 {
1724         Cairo::Context ctx (cr);
1725         try {
1726                 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1727                 lua_gui.collect_garbage_step ();
1728                 if (rv.isTable ()) {
1729                         uint32_t h = rv[2];
1730                         return h;
1731                 }
1732         } catch (luabridge::LuaException const& e) {
1733 #ifndef NDEBUG
1734                 cerr << "LuaException:" << e.what () << endl;
1735 #endif
1736         }
1737         return 0;
1738 }
1739
1740
1741 static std::list<Gtk::TargetEntry> drop_targets()
1742 {
1743         std::list<Gtk::TargetEntry> tmp;
1744         tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1745         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1746         tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1747         return tmp;
1748 }
1749
1750 static std::list<Gtk::TargetEntry> drag_targets()
1751 {
1752         std::list<Gtk::TargetEntry> tmp;
1753         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1754         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1755         return tmp;
1756 }
1757
1758 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1759 {
1760         std::list<Gtk::TargetEntry> tmp;
1761         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1762         return tmp;
1763 }
1764
1765 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1766                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1767         : _parent_strip (parent)
1768         , _owner_is_mixer (owner_is_mixer)
1769         , ab_direction (true)
1770         , _get_plugin_selector (get_plugin_selector)
1771         , _placement (-1)
1772         , _visible_prefader_processors (0)
1773         , _rr_selection(rsel)
1774         , processor_display (drop_targets())
1775         , _redisplay_pending (false)
1776 {
1777         set_session (sess);
1778
1779         /* ProcessorBox actions and bindings created statically by call to
1780          * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1781          * are available for context menus.
1782          */
1783
1784         processor_display.set_data ("ardour-bindings", bindings);
1785
1786         _width = Wide;
1787         processor_menu = 0;
1788         no_processor_redisplay = false;
1789
1790         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1791         processor_scroller.add (processor_display);
1792         pack_start (processor_scroller, true, true);
1793
1794         processor_display.set_flags (CAN_FOCUS);
1795         processor_display.set_name ("ProcessorList");
1796         processor_display.set_data ("processorbox", this);
1797         processor_display.set_size_request (48, -1);
1798         processor_display.set_spacing (0);
1799
1800         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1801         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1802
1803         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1804         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1805
1806         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1807         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1808         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1809
1810         processor_scroller.show ();
1811         processor_display.show ();
1812
1813         if (parent) {
1814                 parent->DeliveryChanged.connect (
1815                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1816                         );
1817         }
1818
1819         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1820 }
1821
1822 ProcessorBox::~ProcessorBox ()
1823 {
1824         /* it may appear as if we should delete processor_menu but that is a
1825          * pointer to a widget owned by the UI Manager, and has potentially
1826          * be returned to many other ProcessorBoxes. GTK doesn't really make
1827          * clear the ownership of this widget, which is a menu and thus is
1828          * never packed into any container other than an implict GtkWindow.
1829          *
1830          * For now, until or if we ever get clarification over the ownership
1831          * story just let it continue to exist. At worst, its a small memory leak.
1832          */
1833 }
1834
1835 void
1836 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1837 {
1838         if (_route == r) {
1839                 return;
1840         }
1841
1842         _route_connections.drop_connections();
1843
1844         /* new route: any existing block on processor redisplay must be meaningless */
1845         no_processor_redisplay = false;
1846         _route = r;
1847
1848         _route->processors_changed.connect (
1849                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1850                 );
1851
1852         _route->DropReferences.connect (
1853                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1854                 );
1855
1856         _route->PropertyChanged.connect (
1857                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1858                 );
1859
1860         redisplay_processors ();
1861 }
1862
1863 void
1864 ProcessorBox::route_going_away ()
1865 {
1866         /* don't keep updating display as processors are deleted */
1867         no_processor_redisplay = true;
1868         _route.reset ();
1869 }
1870
1871 boost::shared_ptr<Processor>
1872 ProcessorBox::find_drop_position (ProcessorEntry* position)
1873 {
1874         boost::shared_ptr<Processor> p;
1875         if (position) {
1876                 p = position->processor ();
1877                 if (!p) {
1878                         /* dropped on the blank entry (which will be before the
1879                                  fader), so use the first non-blank child as our
1880                                  `dropped on' processor */
1881                         list<ProcessorEntry*> c = processor_display.children ();
1882                         list<ProcessorEntry*>::iterator i = c.begin ();
1883
1884                         assert (i != c.end ());
1885                         p = (*i)->processor ();
1886                         assert (p);
1887                 }
1888         }
1889         return p;
1890 }
1891
1892 void
1893 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1894 {
1895                 const void * d = data.get_data();
1896                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1897
1898                 PluginPresetList nfos;
1899                 TreeView* source;
1900                 tv->get_object_drag_data (nfos, &source);
1901
1902                 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1903                         PluginPresetPtr ppp = (*i);
1904                         PluginInfoPtr pip = ppp->_pip;
1905                         PluginPtr p = pip->load (*_session);
1906                         if (!p) {
1907                                 continue;
1908                         }
1909
1910                         if (ppp->_preset.valid) {
1911                                 p->load_preset (ppp->_preset);
1912                         }
1913
1914                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1915                         if (Config->get_new_plugins_active ()) {
1916                                 processor->enable (true);
1917                         }
1918                         pl.push_back (processor);
1919                 }
1920 }
1921
1922 void
1923 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1924 {
1925                 const void * d = data.get_data();
1926                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1927                 PluginInfoList nfos;
1928
1929                 TreeView* source;
1930                 tv->get_object_drag_data (nfos, &source);
1931
1932                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1933                         PluginPtr p = (*i)->load (*_session);
1934                         if (!p) {
1935                                 continue;
1936                         }
1937                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1938                         if (Config->get_new_plugins_active ()) {
1939                                 processor->enable (true);
1940                         }
1941                         pl.push_back (processor);
1942                 }
1943 }
1944
1945 void
1946 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1947 {
1948         if (!_session) {
1949                 return;
1950         }
1951
1952         boost::shared_ptr<Processor> p = find_drop_position (position);
1953         Route::ProcessorList pl;
1954
1955         if (data.get_target() == "PluginInfoPtr") {
1956                 _drop_plugin (data, pl);
1957         }
1958         else if (data.get_target() == "PluginFavoritePtr") {
1959                 _drop_plugin_preset (data, pl);
1960         }
1961         else {
1962                 return;
1963         }
1964
1965         Route::ProcessorStreams err;
1966         if (_route->add_processors (pl, p, &err)) {
1967                 string msg = _(
1968                                 "Processor Drag/Drop failed. Probably because\n\
1969 the I/O configuration of the plugins could\n\
1970 not match the configuration of this track.");
1971                 MessageDialog am (msg);
1972                 am.run ();
1973         }
1974 }
1975
1976 void
1977 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1978 {
1979         if (Gdk::ACTION_LINK == context->get_selected_action()) {
1980                 list<ProcessorEntry*> children = source->selection ();
1981                 assert (children.size() == 1);
1982                 ProcessorEntry* other = *children.begin();
1983                 assert (other->can_copy_state (position));
1984                 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1985                 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1986                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1987                 assert (otherproc && proc && pi);
1988
1989                 PBD::ID id = pi->id();
1990                 XMLNode& state = otherproc->get_state ();
1991                 /* strip side-chain state (processor inside processor must be a side-chain)
1992                  * otherwise we'll end up with duplicate ports-names.
1993                  * (this needs a better solution which retains connections)
1994                  */
1995                 state.remove_nodes ("Processor");
1996                 proc->set_state (state, Stateful::loading_state_version);
1997                 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1998                 return;
1999         }
2000
2001         boost::shared_ptr<Processor> p = find_drop_position (position);
2002
2003         list<ProcessorEntry*> children = source->selection ();
2004         list<boost::shared_ptr<Processor> > procs;
2005         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
2006                 if ((*i)->processor ()) {
2007                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
2008                                 continue;
2009                         }
2010                         procs.push_back ((*i)->processor ());
2011                 }
2012         }
2013
2014         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
2015                 XMLNode& state = (*i)->get_state ();
2016                 XMLNodeList nlist;
2017                 nlist.push_back (&state);
2018                 paste_processor_state (nlist, p);
2019                 delete &state;
2020         }
2021
2022         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
2023            ourselves.
2024         */
2025
2026         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
2027                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
2028                 if (other) {
2029                         other->delete_dragged_processors (procs);
2030                 }
2031         }
2032 }
2033
2034 void
2035 ProcessorBox::set_width (Width w)
2036 {
2037         if (_width == w) {
2038                 return;
2039         }
2040
2041         _width = w;
2042
2043         list<ProcessorEntry*> children = processor_display.children ();
2044         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2045                 (*i)->set_enum_width (w);
2046         }
2047
2048         queue_resize ();
2049 }
2050
2051 Gtk::Menu*
2052 ProcessorBox::build_possible_aux_menu ()
2053 {
2054         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2055
2056         if (rl->empty()) {
2057                 /* No aux sends if there are no busses */
2058                 return 0;
2059         }
2060
2061         if (_route->is_monitor ()) {
2062                 return 0;
2063         }
2064
2065         using namespace Menu_Helpers;
2066         Menu* menu = manage (new Menu);
2067         MenuList& items = menu->items();
2068
2069         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2070                 if (!_route->internal_send_for (*r) && *r != _route) {
2071                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2072                 }
2073         }
2074
2075         return menu;
2076 }
2077
2078 void
2079 ProcessorBox::show_processor_menu (int arg)
2080 {
2081         if (processor_menu == 0) {
2082                 processor_menu = build_processor_menu ();
2083                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2084         }
2085
2086         /* Sort out the plugin submenu */
2087
2088         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2089
2090         if (plugin_menu_item) {
2091                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2092         }
2093
2094         /* And the aux submenu */
2095
2096         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2097
2098         if (aux_menu_item) {
2099                 Menu* m = build_possible_aux_menu();
2100                 if (m && !m->items().empty()) {
2101                         aux_menu_item->set_submenu (*m);
2102                         aux_menu_item->set_sensitive (true);
2103                 } else {
2104                         /* stupid gtkmm: we need to pass a null reference here */
2105                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2106                         aux_menu_item->set_sensitive (false);
2107                 }
2108         }
2109
2110         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2111         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2112
2113         ProcessorEntry* single_selection = 0;
2114         if (processor_display.selection().size() == 1) {
2115                 single_selection = processor_display.selection().front();
2116         }
2117
2118         /* And the controls submenu */
2119
2120         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2121
2122         if (controls_menu_item) {
2123                 if (single_selection) {
2124                         Menu* m = single_selection->build_controls_menu ();
2125                         if (m && !m->items().empty()) {
2126                                 controls_menu_item->set_submenu (*m);
2127                                 controls_menu_item->set_sensitive (true);
2128                         } else {
2129                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2130                                 controls_menu_item->set_sensitive (false);
2131                         }
2132                 } else {
2133                         controls_menu_item->set_sensitive (false);
2134                 }
2135         }
2136
2137
2138         if (!ARDOUR::Profile->get_mixbus()) {
2139                 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2140                 if (send_menu_item) {
2141                         if (single_selection && !_route->is_monitor()) {
2142                                 Menu* m = single_selection->build_send_options_menu ();
2143                                 if (m && !m->items().empty()) {
2144                                         send_menu_item->set_submenu (*m);
2145                                         send_menu_item->set_sensitive (true);
2146                                 } else {
2147                                         gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2148                                         send_menu_item->set_sensitive (false);
2149                                 }
2150                         } else {
2151                                 send_menu_item->set_sensitive (false);
2152                         }
2153                 }
2154         }
2155
2156         /* Sensitise actions as approprioate */
2157
2158
2159         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2160
2161         paste_action->set_sensitive (!_rr_selection.processors.empty());
2162         cut_action->set_sensitive (sensitive && can_cut ());
2163         copy_action->set_sensitive (sensitive);
2164         delete_action->set_sensitive (sensitive || stub_processor_selected ());
2165         backspace_action->set_sensitive (sensitive || stub_processor_selected ());
2166
2167         edit_action->set_sensitive (one_processor_can_be_edited ());
2168         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2169
2170         boost::shared_ptr<PluginInsert> pi;
2171         if (single_selection) {
2172                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2173         }
2174
2175         manage_pins_action->set_sensitive (pi != 0);
2176
2177         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2178         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2179
2180         /* disallow rename for multiple selections, for plugin inserts and for the fader */
2181         rename_action->set_sensitive (single_selection
2182                         && !pi
2183                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2184                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2185
2186         processor_menu->popup (1, arg);
2187
2188         /* Add a placeholder gap to the processor list to indicate where a processor would be
2189            inserted were one chosen from the menu.
2190         */
2191         int x, y;
2192         processor_display.get_pointer (x, y);
2193         _placement = processor_display.add_placeholder (y);
2194
2195         if (_visible_prefader_processors == 0 && _placement > 0) {
2196                 --_placement;
2197         }
2198 }
2199
2200 bool
2201 ProcessorBox::enter_notify (GdkEventCrossing*)
2202 {
2203         processor_display.grab_focus ();
2204         _current_processor_box = this;
2205         return false;
2206 }
2207
2208 bool
2209 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2210 {
2211         if (ev->detail == GDK_NOTIFY_INFERIOR) {
2212                 return false;
2213         }
2214
2215         Widget* top = get_toplevel();
2216
2217         if (top->is_toplevel()) {
2218                 Window* win = dynamic_cast<Window*> (top);
2219                 gtk_window_set_focus (win->gobj(), 0);
2220         }
2221
2222         return false;
2223 }
2224
2225 bool
2226 ProcessorBox::processor_operation (ProcessorOperation op)
2227 {
2228         ProcSelection targets;
2229
2230         get_selected_processors (targets);
2231
2232 /*      if (targets.empty()) {
2233
2234                 int x, y;
2235                 processor_display.get_pointer (x, y);
2236
2237                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2238
2239                 if (pointer.first && pointer.first->processor()) {
2240                         targets.push_back (pointer.first->processor ());
2241                 }
2242         }
2243 */
2244
2245         if ((op == ProcessorsDelete) && targets.empty()) {
2246                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
2247         }
2248
2249         switch (op) {
2250         case ProcessorsSelectAll:
2251                 processor_display.select_all ();
2252                 break;
2253
2254         case ProcessorsSelectNone:
2255                 processor_display.select_none ();
2256                 break;
2257
2258         case ProcessorsCopy:
2259                 copy_processors (targets);
2260                 break;
2261
2262         case ProcessorsCut:
2263                 cut_processors (targets);
2264                 break;
2265
2266         case ProcessorsPaste:
2267                 // some processors are not selectable (e.g fader, meter), target is empty.
2268                 if (targets.empty() && _placement >= 0) {
2269                         assert (_route);
2270                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2271                         if (proc) {
2272                                 targets.push_back (proc);
2273                         }
2274                 }
2275                 if (targets.empty()) {
2276                         paste_processors ();
2277                 } else {
2278                         paste_processors (targets.front());
2279                 }
2280                 break;
2281
2282         case ProcessorsDelete:
2283                 delete_processors (targets);
2284                 break;
2285
2286         case ProcessorsToggleActive:
2287                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2288                         (*i)->enable (!(*i)->enabled ());
2289                 }
2290                 break;
2291
2292         case ProcessorsAB:
2293                 ab_plugins ();
2294                 break;
2295
2296         default:
2297                 break;
2298         }
2299
2300         return true;
2301 }
2302
2303 ProcessorWindowProxy*
2304 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2305 {
2306         return  processor->window_proxy();
2307 }
2308
2309
2310 bool
2311 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2312 {
2313         boost::shared_ptr<Processor> processor;
2314         if (child) {
2315                 processor = child->processor ();
2316         }
2317
2318         int ret = false;
2319         bool selected = processor_display.selected (child);
2320
2321         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2322
2323                 if (_session->engine().connected()) {
2324                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2325
2326                         if (!one_processor_can_be_edited ()) {
2327                                 return true;
2328                         }
2329
2330                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2331                                 generic_edit_processor (processor);
2332                         } else {
2333                                 edit_processor (processor);
2334                         }
2335                 }
2336
2337                 ret = true;
2338
2339         } else if (Keyboard::is_context_menu_event (ev)) {
2340
2341                 show_processor_menu (ev->time);
2342
2343                 ret = true;
2344
2345         } else if (processor && ev->button == 1 && selected) {
2346
2347                 // this is purely informational but necessary for route params UI
2348                 ProcessorSelected (processor); // emit
2349
2350         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2351
2352                 choose_plugin ();
2353                 _get_plugin_selector()->show_manager ();
2354         }
2355
2356         return ret;
2357 }
2358
2359 bool
2360 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2361 {
2362         boost::shared_ptr<Processor> processor;
2363         if (child) {
2364                 processor = child->processor ();
2365         }
2366
2367         if (processor && Keyboard::is_delete_event (ev)) {
2368
2369                 Glib::signal_idle().connect (sigc::bind (
2370                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2371                                 boost::weak_ptr<Processor>(processor)));
2372
2373         } else if (processor && Keyboard::is_button2_event (ev)
2374 #ifndef __APPLE__
2375                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2376 #endif
2377                 ) {
2378
2379                 /* button2-click with no/appropriate modifiers */
2380                 processor->enable (!processor->enabled ());
2381         }
2382
2383         return false;
2384 }
2385
2386 Menu *
2387 ProcessorBox::build_processor_menu ()
2388 {
2389         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2390         processor_menu->set_name ("ArdourContextMenu");
2391         return processor_menu;
2392 }
2393
2394 void
2395 ProcessorBox::select_all_processors ()
2396 {
2397         processor_display.select_all ();
2398 }
2399
2400 void
2401 ProcessorBox::deselect_all_processors ()
2402 {
2403         processor_display.select_none ();
2404 }
2405
2406 void
2407 ProcessorBox::choose_plugin ()
2408 {
2409         _get_plugin_selector()->set_interested_object (*this);
2410 }
2411
2412 /** @return true if an error occurred, otherwise false */
2413 bool
2414 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2415 {
2416         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2417
2418                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2419
2420                 Route::ProcessorStreams err_streams;
2421
2422                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2423                         weird_plugin_dialog (**p, err_streams);
2424                         return true;
2425                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
2426                 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2427                         if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2428                                 ;
2429                         } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2430                                 if ((*p)->has_editor ()) {
2431                                         edit_processor (processor);
2432                                 } else {
2433                                         generic_edit_processor (processor);
2434                                 }
2435                         }
2436                 }
2437         }
2438
2439         return false;
2440 }
2441
2442 void
2443 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2444 {
2445         /* XXX this needs to be re-worked!
2446          *
2447          * With new pin-management "streams" is no longer correct.
2448          * p.get_info () is also incorrect for variable i/o plugins (always -1,-1).
2449          *
2450          * Since pin-management was added, this dialog will only show in a very rare
2451          * condition (non-replicated variable i/o configuration failed).
2452          *
2453          * TODO: simplify the message after the string-freeze is lifted.
2454          */
2455         ArdourDialog dialog (_("Plugin Incompatibility"));
2456         Label label;
2457
2458         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2459                         p.name(), streams.index);
2460
2461         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2462         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2463
2464         text += _("\nThis plugin has:\n");
2465         if (has_midi) {
2466                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2467                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2468         }
2469         if (has_audio) {
2470                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2471                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2472         }
2473
2474         text += _("\nbut at the insertion point, there are:\n");
2475         if (has_midi) {
2476                 uint32_t const n = streams.count.n_midi ();
2477                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2478         }
2479         if (has_audio) {
2480                 uint32_t const n = streams.count.n_audio ();
2481                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2482         }
2483
2484         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2485         label.set_text(text);
2486
2487         dialog.get_vbox()->pack_start (label);
2488         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2489
2490         dialog.set_name (X_("PluginIODialog"));
2491         dialog.set_modal (true);
2492         dialog.show_all ();
2493
2494         dialog.run ();
2495 }
2496
2497 void
2498 ProcessorBox::choose_insert ()
2499 {
2500         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2501         _route->add_processor_by_index (processor, _placement);
2502 }
2503
2504 /* Caller must not hold process lock */
2505 void
2506 ProcessorBox::choose_send ()
2507 {
2508         boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2509
2510         /* make an educated guess at the initial number of outputs for the send */
2511         ChanCount outs = (_route->n_outputs().n_audio() && _session->master_out())
2512                         ? _session->master_out()->n_outputs()
2513                         : _route->n_outputs();
2514
2515         /* XXX need processor lock on route */
2516         try {
2517                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2518                 send->output()->ensure_io (outs, false, this);
2519         } catch (AudioEngine::PortRegistrationFailure& err) {
2520                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2521                 return;
2522         }
2523
2524         /* let the user adjust the IO setup before creation.
2525
2526            Note: this dialog is NOT modal - we just leave it to run and it will
2527            return when its Finished signal is emitted - typically when the window
2528            is closed.
2529          */
2530
2531         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2532         ios->show ();
2533
2534         /* keep a reference to the send so it doesn't get deleted while
2535            the IOSelectorWindow is doing its stuff
2536         */
2537         _processor_being_created = send;
2538
2539         ios->selector().Finished.connect (sigc::bind (
2540                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2541                         boost::weak_ptr<Processor>(send), ios));
2542
2543 }
2544
2545 void
2546 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2547 {
2548         boost::shared_ptr<Processor> processor (weak_processor.lock());
2549
2550         /* drop our temporary reference to the new send */
2551         _processor_being_created.reset ();
2552
2553         if (!processor) {
2554                 return;
2555         }
2556
2557         switch (r) {
2558         case IOSelector::Cancelled:
2559                 // processor will go away when all shared_ptrs to it vanish
2560                 break;
2561
2562         case IOSelector::Accepted:
2563                 _route->add_processor_by_index (processor, _placement);
2564                 break;
2565         }
2566
2567         delete_when_idle (ios);
2568 }
2569
2570 void
2571 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2572 {
2573         boost::shared_ptr<Processor> processor (weak_processor.lock());
2574
2575         /* drop our temporary reference to the new return */
2576         _processor_being_created.reset ();
2577
2578         if (!processor) {
2579                 return;
2580         }
2581
2582         switch (r) {
2583         case IOSelector::Cancelled:
2584                 // processor will go away when all shared_ptrs to it vanish
2585                 break;
2586
2587         case IOSelector::Accepted:
2588                 _route->add_processor_by_index (processor, _placement);
2589                 break;
2590         }
2591
2592         delete_when_idle (ios);
2593 }
2594
2595 void
2596 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2597 {
2598         if (!_route) {
2599                 return;
2600         }
2601
2602         boost::shared_ptr<Route> target = wr.lock();
2603
2604         if (!target) {
2605                 return;
2606         }
2607
2608         _session->add_internal_send (target, _placement, _route);
2609 }
2610
2611 void
2612 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2613 {
2614         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2615                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2616                 return;
2617         }
2618
2619         redisplay_processors ();
2620 }
2621
2622 void
2623 ProcessorBox::redisplay_processors ()
2624 {
2625         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2626         bool     fader_seen;
2627
2628         if (no_processor_redisplay) {
2629                 return;
2630         }
2631
2632         processor_display.clear ();
2633
2634         _visible_prefader_processors = 0;
2635         fader_seen = false;
2636
2637         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2638                                                &_visible_prefader_processors, &fader_seen));
2639
2640         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2641         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2642         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2643
2644         setup_entry_positions ();
2645 }
2646
2647 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2648  *  not already have one.
2649  */
2650 void
2651 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2652 {
2653         boost::shared_ptr<Processor> p = w.lock ();
2654         if (!p) {
2655                 return;
2656         }
2657         if (p->window_proxy()) {
2658                 return;
2659         }
2660
2661         /* not on the list; add it */
2662
2663         string loc;
2664 #if 0 // is this still needed? Why?
2665         if (_parent_strip) {
2666                 if (_parent_strip->mixer_owned()) {
2667                         loc = X_("M");
2668                 } else {
2669                         loc = X_("R");
2670                 }
2671         } else {
2672                 loc = X_("P");
2673         }
2674 #else
2675         loc = X_("P");
2676 #endif
2677
2678         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2679                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2680                 this,
2681                 w);
2682
2683         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2684
2685         if (ui_xml) {
2686                 wp->set_state (*ui_xml, 0);
2687         }
2688
2689         void* existing_ui = p->get_ui ();
2690
2691         if (existing_ui) {
2692                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2693         }
2694
2695         p->set_window_proxy (wp);
2696         WM::Manager::instance().register_window (wp);
2697 }
2698
2699 void
2700 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2701 {
2702         boost::shared_ptr<Processor> p = w.lock ();
2703         if (!p || p->pinmgr_proxy ()) {
2704                 return;
2705         }
2706
2707         PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2708                         string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2709         wp->set_session (_session);
2710
2711         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2712         if (ui_xml) {
2713                 wp->set_state (*ui_xml, 0);
2714         }
2715
2716         p->set_pingmgr_proxy (wp);
2717         WM::Manager::instance().register_window (wp);
2718 }
2719 void
2720 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2721 {
2722         boost::shared_ptr<Processor> processor (p.lock ());
2723
2724         if (processor && ( processor->display_to_user()
2725 #ifndef NDEBUG
2726                             || show_all_processors
2727 #endif
2728                          )
2729            ) {
2730
2731                 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2732                     boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2733                         *amp_seen = true;
2734                 } else {
2735                         if (!*amp_seen) {
2736                                 (*cnt)++;
2737                         }
2738                 }
2739         }
2740 }
2741
2742 void
2743 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2744 {
2745         boost::shared_ptr<Processor> processor (p.lock ());
2746
2747         if (!processor || ( !processor->display_to_user()
2748 #ifndef NDEBUG
2749                             && !show_all_processors
2750 #endif
2751                           )
2752            ) {
2753                 return;
2754         }
2755
2756         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2757
2758         ProcessorEntry* e = 0;
2759         if (plugin_insert) {
2760                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2761         } else {
2762                 e = new ProcessorEntry (this, processor, _width);
2763         }
2764
2765         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2766         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2767         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2768
2769         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2770         if (!send && !plugin_insert && !ext && !stub)
2771                 e->set_selectable(false);
2772
2773         bool mark_send_visible = false;
2774         if (send && _parent_strip) {
2775                 /* show controls of new sends by default */
2776                 GUIObjectState& st = _parent_strip->gui_object_state ();
2777                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2778                 assert (strip);
2779                 /* check if state exists, if not it must be a new send */
2780                 if (!st.get_node(strip, e->state_id())) {
2781                         mark_send_visible = true;
2782                 }
2783         }
2784
2785         /* Set up this entry's state from the GUIObjectState */
2786         XMLNode* proc = entry_gui_object_state (e);
2787         if (proc) {
2788                 e->set_control_state (proc);
2789         }
2790
2791         if (mark_send_visible) {
2792                 e->show_all_controls ();
2793         }
2794
2795         if (plugin_insert
2796 #ifdef MIXBUS
2797                         && !plugin_insert->plugin(0)->is_channelstrip()
2798 #endif
2799                  )
2800         {
2801                 processor_display.add_child (e, drag_targets());
2802         } else {
2803                 processor_display.add_child (e, drag_targets_noplugin());
2804         }
2805 }
2806
2807 void
2808 ProcessorBox::reordered ()
2809 {
2810         compute_processor_sort_keys ();
2811         setup_entry_positions ();
2812 }
2813
2814 void
2815 ProcessorBox::setup_routing_feeds ()
2816 {
2817         list<ProcessorEntry*> children = processor_display.children ();
2818         /* first set the i/o maps for every processor */
2819         list<ProcessorEntry*>::iterator prev = children.begin();
2820
2821         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2822                 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2823                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2824
2825                 list<ProcessorEntry*>::iterator next = i;
2826                 next++;
2827
2828                 if (pi) {
2829                         ChanCount sinks = pi->natural_input_streams ();
2830                         ChanCount sources = pi->natural_output_streams ();
2831                         uint32_t count = pi->get_count ();
2832                         ChanCount in, out;
2833                         pi->configured_io (in, out);
2834
2835                         ChanCount midi_thru;
2836                         ChanCount midi_bypass;
2837                         ChanMapping input_map (pi->input_map ());
2838                         if (pi->has_midi_thru ()) {
2839                                  midi_thru.set(DataType::MIDI, 1);
2840                                  input_map.set (DataType::MIDI, 0, 0);
2841                         }
2842                         if (pi->has_midi_bypass ()) {
2843                                  midi_bypass.set(DataType::MIDI, 1);
2844                         }
2845
2846                         (*i)->input_icon.set_ports (sinks * count + midi_thru);
2847                         (*i)->output_icon.set_ports (sources * count + midi_bypass);
2848
2849                         (*i)->routing_icon.set (
2850                                         in, out,
2851                                         sinks * count + midi_thru,
2852                                         sources * count + midi_bypass,
2853                                         input_map,
2854                                         pi->output_map (),
2855                                         pi->thru_map ());
2856
2857                         if (next != children.end()) {
2858                                 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2859                                                 pi->output_map (), pi->thru_map ());
2860                         }
2861
2862                         if (prev != i) {
2863                                 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2864                                                 pi->input_map (), pi->thru_map ());
2865                         }
2866
2867                 } else {
2868                         (*i)->input_icon.set_ports (p->input_streams());
2869                         (*i)->output_icon.set_ports (p->output_streams());
2870                         ChanMapping inmap (p->input_streams ());
2871                         ChanMapping outmap (p->input_streams ());
2872                         ChanMapping thrumap;
2873                         (*i)->routing_icon.set (
2874                                         p->input_streams(),
2875                                         p->output_streams(),
2876                                         p->input_streams(),
2877                                         p->output_streams(),
2878                                         inmap, outmap, thrumap);
2879
2880                         if (next != children.end()) {
2881                                 (*next)->routing_icon.set_fed_by (
2882                                                 p->output_streams(),
2883                                                 p->output_streams(),
2884                                                 outmap, thrumap);
2885                         }
2886                         if (prev != i) {
2887                                 (*prev)->routing_icon.set_feeding (
2888                                                 p->input_streams(),
2889                                                 p->output_streams(),
2890                                                 inmap, thrumap);
2891                         }
2892                 }
2893
2894                 if (i == children.begin()) {
2895                         (*i)->routing_icon.unset_fed_by ();
2896                 }
2897                 prev = i;
2898                 (*i)->input_icon.hide();
2899         }
2900
2901         /* now set which icons need to be displayed */
2902         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2903                 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2904
2905                 if ((*i)->routing_icon.in_identity ()) {
2906                         (*i)->routing_icon.hide();
2907                         if (i == children.begin()) {
2908                                 (*i)->input_icon.show();
2909                         }
2910                 } else {
2911                         (*i)->routing_icon.show();
2912                         (*i)->routing_icon.queue_draw();
2913                         (*i)->input_icon.show();
2914                 }
2915
2916                 list<ProcessorEntry*>::iterator next = i;
2917                 if (++next == children.end()) {
2918                         // last processor in the chain
2919                         (*i)->output_routing_icon.set_terminal(true);
2920                         (*i)->output_routing_icon.unset_feeding ();
2921                         if ((*i)->routing_icon.out_identity ()) {
2922                                 (*i)->output_routing_icon.hide();
2923                         } else {
2924                                 (*i)->output_routing_icon.show();
2925                                 (*i)->output_routing_icon.queue_draw();
2926                         }
2927                 } else {
2928                         (*i)->output_routing_icon.set_terminal(false);
2929                         if (   !(*i)->routing_icon.out_identity ()
2930                                         && !(*next)->routing_icon.in_identity ()
2931                                         &&  (*next)->routing_icon.can_coalesce ()) {
2932                                 (*i)->output_routing_icon.hide();
2933                         } else if (!(*i)->routing_icon.out_identity ()) {
2934                                 (*i)->output_routing_icon.show();
2935                                 (*i)->output_routing_icon.queue_draw();
2936                                 (*next)->input_icon.show();
2937                         } else {
2938                                 (*i)->output_routing_icon.hide();
2939                         }
2940                 }
2941         }
2942 }
2943
2944 void
2945 ProcessorBox::setup_entry_positions ()
2946 {
2947         list<ProcessorEntry*> children = processor_display.children ();
2948         bool pre_fader = true;
2949
2950         uint32_t num = 0;
2951         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2952                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2953                     boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2954                         pre_fader = false;
2955                         (*i)->set_position (ProcessorEntry::Fader, num++);
2956                 } else {
2957                         if (pre_fader) {
2958                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
2959                         } else {
2960                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
2961                         }
2962                 }
2963         }
2964         setup_routing_feeds ();
2965 }
2966
2967 void
2968 ProcessorBox::compute_processor_sort_keys ()
2969 {
2970         list<ProcessorEntry*> children = processor_display.children ();
2971         Route::ProcessorList our_processors;
2972
2973         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2974                 if ((*i)->processor()) {
2975                         our_processors.push_back ((*i)->processor ());
2976                 }
2977         }
2978
2979         if (_route->reorder_processors (our_processors)) {
2980                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
2981                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
2982                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
2983                    when the drag is torn down after this handler function is finished.
2984                 */
2985                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2986         }
2987 }
2988
2989 void
2990 ProcessorBox::report_failed_reorder ()
2991 {
2992         /* reorder failed, so redisplay */
2993
2994         redisplay_processors ();
2995
2996         /* now tell them about the problem */
2997
2998         ArdourDialog dialog (_("Plugin Incompatibility"));
2999         Label label;
3000
3001         label.set_text (_("\
3002 You cannot reorder these plugins/sends/inserts\n\
3003 in that way because the inputs and\n\
3004 outputs will not work correctly."));
3005
3006         dialog.get_vbox()->set_border_width (12);
3007         dialog.get_vbox()->pack_start (label);
3008         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
3009
3010         dialog.set_name (X_("PluginIODialog"));
3011         dialog.set_modal (true);
3012         dialog.show_all ();
3013
3014         dialog.run ();
3015 }
3016
3017 void
3018 ProcessorBox::rename_processors ()
3019 {
3020         ProcSelection to_be_renamed;
3021
3022         get_selected_processors (to_be_renamed);
3023
3024         if (to_be_renamed.empty()) {
3025                 return;
3026         }
3027
3028         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3029                 rename_processor (*i);
3030         }
3031 }
3032
3033 bool
3034 ProcessorBox::can_cut () const
3035 {
3036         vector<boost::shared_ptr<Processor> > sel;
3037
3038         get_selected_processors (sel);
3039
3040         /* cut_processors () does not cut inserts */
3041
3042         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3043
3044                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3045                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3046                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3047                         return true;
3048                 }
3049         }
3050
3051         return false;
3052 }
3053
3054 bool
3055 ProcessorBox::stub_processor_selected () const
3056 {
3057         vector<boost::shared_ptr<Processor> > sel;
3058
3059         get_selected_processors (sel);
3060
3061         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3062                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3063                         return true;
3064                 }
3065         }
3066
3067         return false;
3068 }
3069
3070 void
3071 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3072 {
3073         if (to_be_removed.empty()) {
3074                 return;
3075         }
3076
3077         XMLNode* node = new XMLNode (X_("cut"));
3078         Route::ProcessorList to_cut;
3079
3080         no_processor_redisplay = true;
3081         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3082                 // Cut only plugins, sends and returns
3083                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3084                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3085                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3086
3087                         Window* w = get_processor_ui (*i);
3088
3089                         if (w) {
3090                                 w->hide ();
3091                         }
3092
3093                         XMLNode& child ((*i)->get_state());
3094                         node->add_child_nocopy (child);
3095                         to_cut.push_back (*i);
3096                 }
3097         }
3098
3099         if (_route->remove_processors (to_cut) != 0) {
3100                 delete node;
3101                 no_processor_redisplay = false;
3102                 return;
3103         }
3104
3105         _rr_selection.set (node);
3106
3107         no_processor_redisplay = false;
3108         redisplay_processors ();
3109 }
3110
3111 void
3112 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3113 {
3114         if (to_be_copied.empty()) {
3115                 return;
3116         }
3117
3118         XMLNode* node = new XMLNode (X_("copy"));
3119
3120         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3121                 // Copy only plugins, sends, returns
3122                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3123                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3124                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3125                         node->add_child_nocopy ((*i)->get_state());
3126                 }
3127         }
3128
3129         _rr_selection.set (node);
3130 }
3131
3132 void
3133 ProcessorBox::delete_processors (const ProcSelection& targets)
3134 {
3135         if (targets.empty()) {
3136                 return;
3137         }
3138
3139         no_processor_redisplay = true;
3140
3141         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3142
3143                 Window* w = get_processor_ui (*i);
3144
3145                 if (w) {
3146                         w->hide ();
3147                 }
3148
3149                 _route->remove_processor(*i);
3150         }
3151
3152         no_processor_redisplay = false;
3153         redisplay_processors ();
3154 }
3155
3156 void
3157 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3158 {
3159         list<boost::shared_ptr<Processor> >::const_iterator x;
3160
3161         no_processor_redisplay = true;
3162         for (x = procs.begin(); x != procs.end(); ++x) {
3163
3164                 Window* w = get_processor_ui (*x);
3165
3166                 if (w) {
3167                         w->hide ();
3168                 }
3169
3170                 _route->remove_processor(*x);
3171         }
3172
3173         no_processor_redisplay = false;
3174         redisplay_processors ();
3175 }
3176
3177 gint
3178 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3179 {
3180         boost::shared_ptr<Processor> processor (weak_processor.lock());
3181
3182         if (!processor) {
3183                 return false;
3184         }
3185
3186         /* NOT copied to _mixer.selection() */
3187
3188         no_processor_redisplay = true;
3189         _route->remove_processor (processor);
3190         no_processor_redisplay = false;
3191         redisplay_processors ();
3192
3193         return false;
3194 }
3195
3196 void
3197 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3198 {
3199         ArdourPrompter name_prompter (true);
3200         string result;
3201         name_prompter.set_title (_("Rename Processor"));
3202         name_prompter.set_prompt (_("New name:"));
3203         name_prompter.set_initial_text (processor->name());
3204         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3205         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3206         name_prompter.show_all ();
3207
3208         switch (name_prompter.run ()) {
3209
3210         case Gtk::RESPONSE_ACCEPT:
3211                 name_prompter.get_result (result);
3212                 if (result.length()) {
3213
3214                        int tries = 0;
3215                        string test = result;
3216
3217                        while (tries < 100) {
3218                                if (_session->io_name_is_legal (test)) {
3219                                        result = test;
3220                                        break;
3221                                }
3222                                tries++;
3223
3224                                test = string_compose ("%1-%2", result, tries);
3225                        }
3226
3227                        if (tries < 100) {
3228                                processor->set_name (result);
3229                        } else {
3230                                /* unlikely! */
3231                                ARDOUR_UI::instance()->popup_error
3232                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3233                        }
3234                 }
3235                 break;
3236         }
3237
3238         return;
3239 }
3240
3241 void
3242 ProcessorBox::paste_processors ()
3243 {
3244         if (_rr_selection.processors.empty()) {
3245                 return;
3246         }
3247
3248         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3249 }
3250
3251 void
3252 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3253 {
3254
3255         if (_rr_selection.processors.empty()) {
3256                 return;
3257         }
3258
3259         paste_processor_state (_rr_selection.processors.get_node().children(), before);
3260 }
3261
3262 void
3263 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3264 {
3265         XMLNodeConstIterator niter;
3266         list<boost::shared_ptr<Processor> > copies;
3267
3268         if (nlist.empty()) {
3269                 return;
3270         }
3271
3272         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3273
3274                 XMLProperty const * type = (*niter)->property ("type");
3275                 XMLProperty const * role = (*niter)->property ("role");
3276                 assert (type);
3277
3278                 boost::shared_ptr<Processor> p;
3279                 try {
3280                         if (type->value() == "meter" ||
3281                             type->value() == "main-outs" ||
3282                             type->value() == "amp" ||
3283                             type->value() == "intreturn") {
3284                                 /* do not paste meter, main outs, amp or internal returns */
3285                                 continue;
3286
3287                         } else if (type->value() == "intsend") {
3288
3289                                 /* aux sends are OK, but those used for
3290                                  * other purposes, are not.
3291                                  */
3292
3293                                 assert (role);
3294
3295                                 if (role->value() != "Aux") {
3296                                         continue;
3297                                 }
3298
3299                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3300                                 XMLNode n (**niter);
3301                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3302                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3303
3304                                 IOProcessor::prepare_for_reset (n, s->name());
3305
3306                                 if (s->set_state (n, Stateful::loading_state_version)) {
3307                                         delete s;
3308                                         return;
3309                                 }
3310
3311                                 p.reset (s);
3312
3313                         } else if (type->value() == "send") {
3314
3315                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3316                                 XMLNode n (**niter);
3317
3318                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3319
3320                                 IOProcessor::prepare_for_reset (n, s->name());
3321
3322                                 if (s->set_state (n, Stateful::loading_state_version)) {
3323                                         delete s;
3324                                         return;
3325                                 }
3326
3327                                 p.reset (s);
3328
3329                         } else if (type->value() == "return") {
3330
3331                                 XMLNode n (**niter);
3332                                 Return* r = new Return (*_session);
3333
3334                                 IOProcessor::prepare_for_reset (n, r->name());
3335
3336                                 if (r->set_state (n, Stateful::loading_state_version)) {
3337                                         delete r;
3338                                         return;
3339                                 }
3340
3341                                 p.reset (r);
3342
3343                         } else if (type->value() == "port") {
3344
3345                                 XMLNode n (**niter);
3346                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3347
3348                                 IOProcessor::prepare_for_reset (n, pi->name());
3349
3350                                 if (pi->set_state (n, Stateful::loading_state_version)) {
3351                                         return;
3352                                 }
3353
3354                                 p.reset (pi);
3355                         } else {
3356                                 /* XXX its a bit limiting to assume that everything else
3357                                    is a plugin.
3358                                 */
3359                                 p.reset (new PluginInsert (*_session));
3360                                 /* we can't use RAII Stateful::ForceIDRegeneration
3361                                  * because that'd void copying the state and wrongly bump
3362                                  * the state-version counter.
3363                                  * we need to load the state (incl external files) first and
3364                                  * only then update the ID)
3365                                  */
3366                                 PBD::ID id = p->id();
3367                                 /* strip side-chain state (processor inside processor must be a side-chain)
3368                                  * otherwise we'll end up with duplicate ports-names.
3369                                  * (this needs a better solution which retains connections)
3370                                  * We really would want Stateful::ForceIDRegeneration here :(
3371                                  */
3372                                 XMLNode state (**niter);
3373                                 state.remove_nodes ("Processor");
3374
3375                                 p->set_state (state, Stateful::current_state_version);
3376                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3377                         }
3378
3379                         copies.push_back (p);
3380                 }
3381
3382                 catch (...) {
3383                         error << _("plugin insert constructor failed") << endmsg;
3384                 }
3385         }
3386
3387         if (copies.empty()) {
3388                 return;
3389         }
3390
3391         if (_route->add_processors (copies, p)) {
3392
3393                 string msg = _(
3394                         "Copying the set of processors on the clipboard failed,\n\
3395 probably because the I/O configuration of the plugins\n\
3396 could not match the configuration of this track.");
3397                 MessageDialog am (msg);
3398                 am.run ();
3399         }
3400 }
3401
3402 void
3403 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3404 {
3405         const list<ProcessorEntry*> selection = processor_display.selection ();
3406         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3407                 processors.push_back ((*i)->processor ());
3408         }
3409 }
3410
3411 void
3412 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3413 {
3414         list<ProcessorEntry*> selection = processor_display.selection ();
3415         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3416                 (this->*method) ((*i)->processor ());
3417         }
3418 }
3419
3420 void
3421 ProcessorBox::all_visible_processors_active (bool state)
3422 {
3423         _route->all_visible_processors_active (state);
3424 }
3425
3426 void
3427 ProcessorBox::ab_plugins ()
3428 {
3429         _route->ab_plugins (ab_direction);
3430         ab_direction = !ab_direction;
3431 }
3432
3433
3434 void
3435 ProcessorBox::clear_processors ()
3436 {
3437         string prompt;
3438         vector<string> choices;
3439
3440         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3441                                    "(this cannot be undone)"), _route->name());
3442
3443         choices.push_back (_("Cancel"));
3444         choices.push_back (_("Yes, remove them all"));
3445
3446         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3447
3448         if (prompter.run () == 1) {
3449                 _route->clear_processors (PreFader);
3450                 _route->clear_processors (PostFader);
3451         }
3452 }
3453
3454 void
3455 ProcessorBox::clear_processors (Placement p)
3456 {
3457         string prompt;
3458         vector<string> choices;
3459
3460         if (p == PreFader) {
3461                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3462                                            "(this cannot be undone)"), _route->name());
3463         } else {
3464                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3465                                            "(this cannot be undone)"), _route->name());
3466         }
3467
3468         choices.push_back (_("Cancel"));
3469         choices.push_back (_("Yes, remove them all"));
3470
3471         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3472
3473         if (prompter.run () == 1) {
3474                 _route->clear_processors (p);
3475         }
3476 }
3477
3478 bool
3479 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3480 {
3481         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3482         if (at && at->freeze_state() == AudioTrack::Frozen) {
3483                 return false;
3484         }
3485
3486         if (
3487                 boost::dynamic_pointer_cast<Send> (processor) ||
3488                 boost::dynamic_pointer_cast<Return> (processor) ||
3489                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3490                 boost::dynamic_pointer_cast<PortInsert> (processor)
3491                 ) {
3492                 return true;
3493         }
3494
3495         return false;
3496 }
3497
3498 bool
3499 ProcessorBox::one_processor_can_be_edited ()
3500 {
3501         list<ProcessorEntry*> selection = processor_display.selection ();
3502         list<ProcessorEntry*>::iterator i = selection.begin();
3503         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3504                 ++i;
3505         }
3506
3507         return (i != selection.end());
3508 }
3509
3510 Gtk::Window*
3511 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3512 {
3513         boost::shared_ptr<Send> send;
3514         boost::shared_ptr<InternalSend> internal_send;
3515         boost::shared_ptr<Return> retrn;
3516         boost::shared_ptr<PluginInsert> plugin_insert;
3517         boost::shared_ptr<PortInsert> port_insert;
3518         Window* gidget = 0;
3519
3520         /* This method may or may not return a Window, but if it does not it
3521          * will modify the parent mixer strip appearance layout to allow
3522          * "editing" the @param processor that was passed in.
3523          *
3524          * So for example, if the processor is an Amp (gain), the parent strip
3525          * will be forced back into a model where the fader controls the main gain.
3526          * If the processor is a send, then we map the send controls onto the
3527          * strip.
3528          *
3529          * Plugins and others will return a window for control.
3530          */
3531
3532         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3533
3534                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3535                         return 0;
3536                 }
3537         }
3538
3539         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3540
3541                 if (_parent_strip) {
3542                         _parent_strip->revert_to_default_display ();
3543                 }
3544
3545         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3546
3547                 if (!_session->engine().connected()) {
3548                         return 0;
3549                 }
3550
3551                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3552
3553                         gidget = new SendUIWindow (send, _session);
3554                 }
3555
3556         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3557
3558                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3559                         /* no GUI for these */
3560                         return 0;
3561                 }
3562
3563                 if (!_session->engine().connected()) {
3564                         return 0;
3565                 }
3566
3567                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3568
3569                 ReturnUIWindow *return_ui;
3570                 Window* w = get_processor_ui (retrn);
3571
3572                 if (w == 0) {
3573
3574                         return_ui = new ReturnUIWindow (retrn, _session);
3575                         return_ui->set_title (retrn->name ());
3576                         set_processor_ui (send, return_ui);
3577
3578                 } else {
3579                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
3580                 }
3581
3582                 gidget = return_ui;
3583
3584         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3585
3586                 PluginUIWindow *plugin_ui;
3587
3588                 /* these are both allowed to be null */
3589
3590                 Window* w = get_processor_ui (plugin_insert);
3591
3592                 if (w == 0) {
3593                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3594                         plugin_ui->set_title (generate_processor_title (plugin_insert));
3595                         set_processor_ui (plugin_insert, plugin_ui);
3596
3597                 } else {
3598                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3599                 }
3600
3601                 gidget = plugin_ui;
3602
3603         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3604
3605                 if (!_session->engine().connected()) {
3606                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3607                         msg.run ();
3608                         return 0;
3609                 }
3610
3611                 PortInsertWindow *io_selector;
3612
3613                 Window* w = get_processor_ui (port_insert);
3614
3615                 if (w == 0) {
3616                         io_selector = new PortInsertWindow (_session, port_insert);
3617                         set_processor_ui (port_insert, io_selector);
3618
3619                 } else {
3620                         io_selector = dynamic_cast<PortInsertWindow *> (w);
3621                 }
3622
3623                 gidget = io_selector;
3624         }
3625
3626         return gidget;
3627 }
3628
3629 Gtk::Window*
3630 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3631 {
3632         boost::shared_ptr<PluginInsert> plugin_insert
3633                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3634
3635         if (!plugin_insert) {
3636                 return 0;
3637         }
3638
3639         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3640         win->set_title (generate_processor_title (plugin_insert));
3641
3642         return win;
3643 }
3644
3645 void
3646 ProcessorBox::register_actions ()
3647 {
3648         processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3649
3650         Glib::RefPtr<Action> act;
3651
3652         /* new stuff */
3653         myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3654                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3655
3656         act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3657                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3658         ActionManager::engine_sensitive_actions.push_back (act);
3659         act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3660                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
3661         ActionManager::engine_sensitive_actions.push_back (act);
3662
3663         myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3664
3665         myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3666         myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3667
3668         myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3669                         sigc::ptr_fun (ProcessorBox::rb_clear));
3670         myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3671                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3672         myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3673                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
3674
3675         /* standard editing stuff */
3676
3677         cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3678                                                             sigc::ptr_fun (ProcessorBox::rb_cut));
3679         copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3680                                                              sigc::ptr_fun (ProcessorBox::rb_copy));
3681         delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3682                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3683         backspace_action = myactions.register_action (processor_box_actions, X_("backspace"), _("Delete"),
3684                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3685
3686         ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3687         ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3688         ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3689         ActionManager::plugin_selection_sensitive_actions.push_back (backspace_action);
3690
3691         paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3692                         sigc::ptr_fun (ProcessorBox::rb_paste));
3693         rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3694                         sigc::ptr_fun (ProcessorBox::rb_rename));
3695         myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3696                         sigc::ptr_fun (ProcessorBox::rb_select_all));
3697         myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3698                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3699
3700         /* activation etc. */
3701
3702         myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3703                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
3704         myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3705                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3706         myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3707                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3708
3709         manage_pins_action = myactions.register_action (
3710                 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3711                 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3712
3713         /* show editors */
3714         edit_action = myactions.register_action (
3715                 processor_box_actions, X_("edit"), _("Edit..."),
3716                 sigc::ptr_fun (ProcessorBox::rb_edit));
3717
3718         edit_generic_action = myactions.register_action (
3719                 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3720                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3721
3722         load_bindings ();
3723 }
3724
3725 void
3726 ProcessorBox::rb_edit_generic ()
3727 {
3728         if (_current_processor_box == 0) {
3729                 return;
3730         }
3731
3732         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3733 }
3734
3735 void
3736 ProcessorBox::rb_ab_plugins ()
3737 {
3738         if (_current_processor_box == 0) {
3739                 return;
3740         }
3741
3742         _current_processor_box->ab_plugins ();
3743 }
3744
3745 void
3746 ProcessorBox::rb_manage_pins ()
3747 {
3748         if (_current_processor_box == 0) {
3749                 return;
3750         }
3751
3752         _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3753 }
3754 void
3755 ProcessorBox::rb_choose_plugin ()
3756 {
3757         if (_current_processor_box == 0) {
3758                 return;
3759         }
3760         _current_processor_box->choose_plugin ();
3761 }
3762
3763 void
3764 ProcessorBox::rb_choose_insert ()
3765 {
3766         if (_current_processor_box == 0) {
3767                 return;
3768         }
3769         _current_processor_box->choose_insert ();
3770 }
3771
3772 void
3773 ProcessorBox::rb_choose_send ()
3774 {
3775         if (_current_processor_box == 0) {
3776                 return;
3777         }
3778         _current_processor_box->choose_send ();
3779 }
3780
3781 void
3782 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3783 {
3784         if (_current_processor_box == 0) {
3785                 return;
3786         }
3787
3788         _current_processor_box->choose_aux (wr);
3789 }
3790
3791 void
3792 ProcessorBox::rb_clear ()
3793 {
3794         if (_current_processor_box == 0) {
3795                 return;
3796         }
3797
3798         _current_processor_box->clear_processors ();
3799 }
3800
3801
3802 void
3803 ProcessorBox::rb_clear_pre ()
3804 {
3805         if (_current_processor_box == 0) {
3806                 return;
3807         }
3808
3809         _current_processor_box->clear_processors (PreFader);
3810 }
3811
3812
3813 void
3814 ProcessorBox::rb_clear_post ()
3815 {
3816         if (_current_processor_box == 0) {
3817                 return;
3818         }
3819
3820         _current_processor_box->clear_processors (PostFader);
3821 }
3822
3823 void
3824 ProcessorBox::rb_cut ()
3825 {
3826         if (_current_processor_box == 0) {
3827                 return;
3828         }
3829
3830         _current_processor_box->processor_operation (ProcessorsCut);
3831 }
3832
3833 void
3834 ProcessorBox::rb_delete ()
3835 {
3836         if (_current_processor_box == 0) {
3837                 return;
3838         }
3839
3840         _current_processor_box->processor_operation (ProcessorsDelete);
3841 }
3842
3843 void
3844 ProcessorBox::rb_copy ()
3845 {
3846         if (_current_processor_box == 0) {
3847                 return;
3848         }
3849         _current_processor_box->processor_operation (ProcessorsCopy);
3850 }
3851
3852 void
3853 ProcessorBox::rb_paste ()
3854 {
3855         if (_current_processor_box == 0) {
3856                 return;
3857         }
3858
3859         _current_processor_box->processor_operation (ProcessorsPaste);
3860 }
3861
3862 void
3863 ProcessorBox::rb_rename ()
3864 {
3865         if (_current_processor_box == 0) {
3866                 return;
3867         }
3868         _current_processor_box->rename_processors ();
3869 }
3870
3871 void
3872 ProcessorBox::rb_select_all ()
3873 {
3874         if (_current_processor_box == 0) {
3875                 return;
3876         }
3877
3878         _current_processor_box->processor_operation (ProcessorsSelectAll);
3879 }
3880
3881 void
3882 ProcessorBox::rb_deselect_all ()
3883 {
3884         if (_current_processor_box == 0) {
3885                 return;
3886         }
3887
3888         _current_processor_box->deselect_all_processors ();
3889 }
3890
3891 void
3892 ProcessorBox::rb_activate_all ()
3893 {
3894         if (_current_processor_box == 0) {
3895                 return;
3896         }
3897
3898         _current_processor_box->all_visible_processors_active (true);
3899 }
3900
3901 void
3902 ProcessorBox::rb_deactivate_all ()
3903 {
3904         if (_current_processor_box == 0) {
3905                 return;
3906         }
3907         _current_processor_box->all_visible_processors_active (false);
3908 }
3909
3910 void
3911 ProcessorBox::rb_edit ()
3912 {
3913         if (_current_processor_box == 0) {
3914                 return;
3915         }
3916
3917         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3918 }
3919
3920 bool
3921 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3922 {
3923         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3924                 return false;
3925         }
3926
3927         if (_parent_strip) {
3928                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3929                 if (_parent_strip->current_delivery() == send) {
3930                         _parent_strip->revert_to_default_display ();
3931                 } else {
3932                         _parent_strip->show_send(send);
3933                 }
3934         }
3935         return true;
3936 }
3937
3938 void
3939 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3940 {
3941         if (!processor) {
3942                 return;
3943         }
3944         if (edit_aux_send (processor)) {
3945                 return;
3946         }
3947         if (!_session->engine().connected()) {
3948                 return;
3949         }
3950
3951         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3952
3953         if (proxy) {
3954                 proxy->set_custom_ui_mode (true);
3955                 proxy->show_the_right_window ();
3956         }
3957 }
3958
3959 void
3960 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3961 {
3962         if (!processor) {
3963                 return;
3964         }
3965         if (edit_aux_send (processor)) {
3966                 return;
3967         }
3968         if (!_session->engine().connected()) {
3969                 return;
3970         }
3971
3972         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3973
3974         if (proxy) {
3975                 proxy->set_custom_ui_mode (false);
3976                 proxy->show_the_right_window ();
3977         }
3978 }
3979
3980 void
3981 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3982 {
3983         if (!processor) {
3984                 return;
3985         }
3986         PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3987         if (proxy) {
3988                 proxy->get (true);
3989                 proxy->present();
3990         }
3991 }
3992
3993
3994 void
3995 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3996 {
3997         if (!what_changed.contains (ARDOUR::Properties::name)) {
3998                 return;
3999         }
4000
4001         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
4002
4003         boost::shared_ptr<Processor> processor;
4004         boost::shared_ptr<PluginInsert> plugin_insert;
4005         boost::shared_ptr<Send> send;
4006
4007         list<ProcessorEntry*> children = processor_display.children();
4008
4009         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
4010
4011                 processor = (*iter)->processor ();
4012
4013                 if (!processor) {
4014                         continue;
4015                 }
4016
4017                 Window* w = get_processor_ui (processor);
4018
4019                 if (!w) {
4020                         continue;
4021                 }
4022
4023                 /* rename editor windows for sends and plugins */
4024
4025                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4026                         w->set_title (send->name ());
4027                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4028                         w->set_title (generate_processor_title (plugin_insert));
4029                 }
4030         }
4031 }
4032
4033 string
4034 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4035 {
4036         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4037         string::size_type email_pos;
4038
4039         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4040                 maker = maker.substr (0, email_pos - 1);
4041         }
4042
4043         if (maker.length() > 32) {
4044                 maker = maker.substr (0, 32);
4045                 maker += " ...";
4046         }
4047
4048         SessionObject* owner = pi->owner();
4049
4050         if (owner) {
4051                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4052         } else {
4053                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4054         }
4055 }
4056
4057 /** @param p Processor.
4058  *  @return the UI window for \a p.
4059  */
4060 Window *
4061 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4062 {
4063         ProcessorWindowProxy* wp = p->window_proxy();
4064         if (wp) {
4065                 return wp->get ();
4066         }
4067         return 0;
4068 }
4069
4070 /** Make a note of the UI window that a processor is using.
4071  *  @param p Processor.
4072  *  @param w UI window.
4073  */
4074 void
4075 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4076 {
4077         assert (p->window_proxy());
4078         p->set_ui (w);
4079         p->window_proxy()->use_window (*w);
4080 }
4081
4082 void
4083 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4084 {
4085         boost::shared_ptr<Delivery> d = w.lock ();
4086         if (!d) {
4087                 return;
4088         }
4089
4090         list<ProcessorEntry*> children = processor_display.children ();
4091         list<ProcessorEntry*>::const_iterator i = children.begin();
4092         while (i != children.end() && (*i)->processor() != d) {
4093                 ++i;
4094         }
4095
4096         if (i == children.end()) {
4097                 processor_display.set_active (0);
4098         } else {
4099                 processor_display.set_active (*i);
4100         }
4101 }
4102
4103 /** Called to repair the damage of Editor::show_window doing a show_all() */
4104 void
4105 ProcessorBox::hide_things ()
4106 {
4107         list<ProcessorEntry*> c = processor_display.children ();
4108         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4109                 (*i)->hide_things ();
4110         }
4111 }
4112
4113 void
4114 ProcessorBox::processor_menu_unmapped ()
4115 {
4116         processor_display.remove_placeholder ();
4117         /* make all possibly-desensitized actions sensitive again so that
4118            they be activated by other means (e.g. bindings)
4119         */
4120         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4121 }
4122
4123 XMLNode *
4124 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4125 {
4126         if (!_parent_strip) {
4127                 return 0;
4128         }
4129
4130         GUIObjectState& st = _parent_strip->gui_object_state ();
4131
4132         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4133         assert (strip);
4134         return st.get_or_add_node (strip, entry->state_id());
4135 }
4136
4137 void
4138 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4139 {
4140         XMLNode* proc = entry_gui_object_state (entry);
4141         if (!proc) {
4142                 return;
4143         }
4144
4145         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4146         proc->remove_nodes_and_delete (X_("Object"));
4147         entry->add_control_state (proc);
4148 }
4149
4150 bool
4151 ProcessorBox::is_editor_mixer_strip() const
4152 {
4153         return _parent_strip && !_parent_strip->mixer_owned();
4154 }
4155
4156 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4157         : WM::ProxyBase (name, string())
4158         , _processor_box (box)
4159         , _processor (processor)
4160         , is_custom (false)
4161         , want_custom (false)
4162 {
4163         boost::shared_ptr<Processor> p = _processor.lock ();
4164         if (!p) {
4165                 return;
4166         }
4167         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4168 }
4169
4170 ProcessorWindowProxy::~ProcessorWindowProxy()
4171 {
4172         /* processor window proxies do not own the windows they create with
4173          * ::get(), so set _window to null before the normal WindowProxy method
4174          * deletes it.
4175          */
4176         _window = 0;
4177 }
4178
4179 void
4180 ProcessorWindowProxy::processor_going_away ()
4181 {
4182         delete _window;
4183         _window = 0;
4184         WM::Manager::instance().remove (this);
4185         /* should be no real reason to do this, since the object that would
4186            send DropReferences is about to be deleted, but lets do it anyway.
4187         */
4188         going_away_connection.disconnect();
4189 }
4190
4191 ARDOUR::SessionHandlePtr*
4192 ProcessorWindowProxy::session_handle()
4193 {
4194         /* we don't care */
4195         return 0;
4196 }
4197
4198 XMLNode&
4199 ProcessorWindowProxy::get_state ()
4200 {
4201         XMLNode *node;
4202         node = &ProxyBase::get_state();
4203         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4204         return *node;
4205 }
4206
4207 int
4208 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4209 {
4210         XMLNodeList children = node.children ();
4211         XMLNodeList::const_iterator i = children.begin ();
4212         while (i != children.end()) {
4213                 XMLProperty const * prop = (*i)->property (X_("name"));
4214                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4215                         break;
4216                 }
4217                 ++i;
4218         }
4219
4220         if (i != children.end()) {
4221                 XMLProperty const * prop;
4222                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4223                         want_custom = PBD::string_is_affirmative (prop->value ());
4224                 }
4225         }
4226
4227         return ProxyBase::set_state (node, 0);
4228 }
4229
4230 Gtk::Window*
4231 ProcessorWindowProxy::get (bool create)
4232 {
4233         boost::shared_ptr<Processor> p = _processor.lock ();
4234
4235         if (!p) {
4236                 return 0;
4237         }
4238         if (_window && (is_custom != want_custom)) {
4239                 /* drop existing window - wrong type */
4240                 drop_window ();
4241         }
4242
4243         if (!_window) {
4244                 if (!create) {
4245                         return 0;
4246                 }
4247
4248                 is_custom = want_custom;
4249                 _window = _processor_box->get_editor_window (p, is_custom);
4250
4251                 if (_window) {
4252                         setup ();
4253                 }
4254                 _window->show_all ();
4255         }
4256         return _window;
4257 }
4258
4259 void
4260 ProcessorWindowProxy::show_the_right_window ()
4261 {
4262         if (_window && (is_custom != want_custom)) {
4263                 /* drop existing window - wrong type */
4264                 drop_window ();
4265         }
4266         toggle ();
4267 }
4268
4269
4270 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4271         : WM::ProxyBase (name, string())
4272         , _processor (processor)
4273 {
4274         boost::shared_ptr<Processor> p = _processor.lock ();
4275         if (!p) {
4276                 return;
4277         }
4278         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4279 }
4280
4281 PluginPinWindowProxy::~PluginPinWindowProxy()
4282 {
4283         _window = 0;
4284 }
4285
4286 ARDOUR::SessionHandlePtr*
4287 PluginPinWindowProxy::session_handle ()
4288 {
4289         ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4290         if (aw) { return aw; }
4291         return 0;
4292 }
4293
4294 Gtk::Window*
4295 PluginPinWindowProxy::get (bool create)
4296 {
4297         boost::shared_ptr<Processor> p = _processor.lock ();
4298         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4299         if (!p || !pi) {
4300                 return 0;
4301         }
4302
4303         if (!_window) {
4304                 if (!create) {
4305                         return 0;
4306                 }
4307                 _window = new PluginPinDialog (pi);
4308                 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4309                 if (aw) {
4310                         aw->set_session (_session);
4311                 }
4312                 _window->show_all ();
4313         }
4314         return _window;
4315 }
4316
4317 void
4318 PluginPinWindowProxy::processor_going_away ()
4319 {
4320         delete _window;
4321         _window = 0;
4322         WM::Manager::instance().remove (this);
4323         going_away_connection.disconnect();
4324 }
4325
4326 void
4327 ProcessorBox::load_bindings ()
4328 {
4329         bindings = Bindings::get_bindings (X_("Processor Box"), myactions);
4330 }