gtk2_ardour/processor_box.cc

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