gtk2_ardour/processor_box.cc

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