gtk2_ardour/processor_box.cc

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