gtk2_ardour/processor_box.cc

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