gtk2_ardour/processor_box.cc

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