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