gtk2_ardour/processor_box.cc

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