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