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