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