gtk2_ardour/processor_box.cc

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