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