gtk2_ardour/processor_box.cc

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