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