gtk2_ardour/processor_box.cc

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