gtk2_ardour/processor_box.cc

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