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
  32 #include <glibmm/miscutils.h>
  33
  34 #include <gtkmm/messagedialog.h>
  35
  36 #include <gtkmm2ext/gtk_ui.h>
  37 #include <gtkmm2ext/utils.h>
  38 #include <gtkmm2ext/choice.h>
  39 #include <gtkmm2ext/utils.h>
  40 #include <gtkmm2ext/doi.h>
  41 #include <gtkmm2ext/rgb_macros.h>
  42
  43 #include "ardour/amp.h"
  44 #include "ardour/audio_track.h"
  45 #include "ardour/audioengine.h"
  46 #include "ardour/internal_return.h"
  47 #include "ardour/internal_send.h"
  48 #include "ardour/meter.h"
  49 #include "ardour/panner_shell.h"
  50 #include "ardour/plugin_insert.h"
  51 #include "ardour/pannable.h"
  52 #include "ardour/port_insert.h"
  53 #include "ardour/profile.h"
  54 #include "ardour/return.h"
  55 #include "ardour/route.h"
  56 #include "ardour/send.h"
  57 #include "ardour/session.h"
  58 #include "ardour/types.h"
  59
  60 #include "actions.h"
  61 #include "ardour_dialog.h"
  62 #include "ardour_ui.h"
  63 #include "gui_thread.h"
  64 #include "io_selector.h"
  65 #include "keyboard.h"
  66 #include "mixer_ui.h"
  67 #include "mixer_strip.h"
  68 #include "plugin_selector.h"
  69 #include "plugin_ui.h"
  70 #include "port_insert_ui.h"
  71 #include "processor_box.h"
  72 #include "public_editor.h"
  73 #include "return_ui.h"
  74 #include "route_processor_selection.h"
  75 #include "send_ui.h"
  76 #include "timers.h"
  77 #include "tooltips.h"
  78 #include "new_plugin_preset_dialog.h"
  79
  80 #include "i18n.h"
  81
  82 #ifdef AUDIOUNIT_SUPPORT
  83 class AUPluginUI;
  84 #endif
  85
  86 #ifndef NDEBUG
  87 bool ProcessorBox::show_all_processors = false;
  88 #endif
  89
  90 using namespace std;
  91 using namespace ARDOUR;
  92 using namespace PBD;
  93 using namespace Gtk;
  94 using namespace Glib;
  95 using namespace Gtkmm2ext;
  96
  97 ProcessorBox* ProcessorBox::_current_processor_box = 0;
  98 RefPtr<Action> ProcessorBox::paste_action;
  99 RefPtr<Action> ProcessorBox::cut_action;
 100 RefPtr<Action> ProcessorBox::copy_action;
 101 RefPtr<Action> ProcessorBox::rename_action;
 102 RefPtr<Action> ProcessorBox::delete_action;
 103 RefPtr<Action> ProcessorBox::edit_action;
 104 RefPtr<Action> ProcessorBox::edit_generic_action;
 105
 106 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
 107 static const uint32_t midi_port_color = 0x960909FF; //Red
 108
 109 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
 110         : _button (ArdourButton::led_default_elements)
 111         , _position (PreFader)
 112         , _position_num(0)
 113         , _selectable(true)
 114         , _unknown_processor(false)
 115         , _parent (parent)
 116         , _processor (p)
 117         , _width (w)
 118         , _input_icon(true)
 119         , _output_icon(false)
 120 {
 121         _vbox.show ();
 122
 123         _button.set_distinct_led_click (true);
 124         _button.set_fallthrough_to_parent(true);
 125         _button.set_led_left (true);
 126         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
 127         _button.set_text (name (_width));
 128
 129         if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
 130                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
 131         }
 132         if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
 133                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
 134                 _unknown_processor = true;
 135         }
 136         {
 137                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 138                 if (pi && pi->plugin()) {
 139                         _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
 140                 }
 141         }
 142         if (_processor) {
 143
 144                 _vbox.pack_start (_routing_icon);
 145                 _vbox.pack_start (_input_icon);
 146                 _vbox.pack_start (_button, true, true);
 147                 _vbox.pack_end (_output_icon);
 148
 149                 _button.set_active (_processor->active());
 150
 151                 _routing_icon.set_no_show_all(true);
 152                 _input_icon.set_no_show_all(true);
 153
 154                 _button.show ();
 155                 _routing_icon.set_visible(false);
 156                 _input_icon.hide();
 157                 _output_icon.show();
 158
 159                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
 160                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
 161                 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
 162
 163                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
 164                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
 165
 166                         std::string label = _processor->describe_parameter (*i);
 167
 168                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
 169                                 label = _("Send");
 170                         } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
 171                                 label = _("Return");
 172                         }
 173
 174                         Control* c = new Control (_processor->automation_control (*i), label);
 175
 176                         _controls.push_back (c);
 177
 178                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
 179                                 /* Add non-Amp (Fader & Trim) controls to the processor box */
 180                                 _vbox.pack_start (c->box);
 181                         }
 182                 }
 183
 184                 _input_icon.set_ports(_processor->input_streams());
 185                 _output_icon.set_ports(_processor->output_streams());
 186
 187                 _routing_icon.set_sources(_processor->input_streams());
 188                 _routing_icon.set_sinks(_processor->output_streams());
 189
 190                 setup_tooltip ();
 191                 setup_visuals ();
 192         } else {
 193                 _vbox.set_size_request (-1, _button.size_request().height);
 194         }
 195 }
 196
 197 ProcessorEntry::~ProcessorEntry ()
 198 {
 199         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 200                 delete *i;
 201         }
 202 }
 203
 204 EventBox&
 205 ProcessorEntry::action_widget ()
 206 {
 207         return _button;
 208 }
 209
 210 Gtk::Widget&
 211 ProcessorEntry::widget ()
 212 {
 213         return _vbox;
 214 }
 215
 216 string
 217 ProcessorEntry::drag_text () const
 218 {
 219         return name (Wide);
 220 }
 221 bool
 222 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
 223 {
 224         if (data.get_target() == "PluginPresetPtr" && _plugin_preset_pointer) {
 225                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 226                 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
 227                 assert (plugin);
 228                 NewPluginPresetDialog d (plugin);
 229
 230                 _plugin_preset_pointer->_preset.valid = false;
 231
 232                 switch (d.run ()) {
 233                         case Gtk::RESPONSE_ACCEPT:
 234                                 if (d.name().empty()) {
 235                                         break;
 236                                 }
 237
 238                                 if (d.replace ()) {
 239                                         plugin->remove_preset (d.name ());
 240                                 }
 241
 242                                 Plugin::PresetRecord const r = plugin->save_preset (d.name());
 243
 244                                 if (!r.uri.empty ()) {
 245                                         _plugin_preset_pointer->_preset.uri   = r.uri;
 246                                         _plugin_preset_pointer->_preset.label = r.label;
 247                                         _plugin_preset_pointer->_preset.user  = r.user;
 248                                         _plugin_preset_pointer->_preset.valid = r.valid;
 249                                 }
 250                 }
 251                 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
 252                 return true;
 253         }
 254         return false;
 255 }
 256
 257 void
 258 ProcessorEntry::set_position (Position p, uint32_t num)
 259 {
 260         _position = p;
 261         _position_num = num;
 262
 263         if (_position_num == 0 || _routing_icon.get_visible()) {
 264                 _input_icon.show();
 265         } else {
 266                 _input_icon.hide();
 267         }
 268
 269         setup_visuals ();
 270 }
 271
 272 void
 273 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
 274 {
 275         if (yn) {
 276                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
 277         } else {
 278                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
 279         }
 280 }
 281
 282 void
 283 ProcessorEntry::setup_visuals ()
 284 {
 285         if (_unknown_processor) {
 286                 _button.set_name ("processor stub");
 287                 return;
 288         }
 289
 290         switch (_position) {
 291         case PreFader:
 292                 _button.set_name ("processor prefader");
 293                 break;
 294
 295         case Fader:
 296                 _button.set_name ("processor fader");
 297                 break;
 298
 299         case PostFader:
 300                 _button.set_name ("processor postfader");
 301                 break;
 302         }
 303 }
 304
 305
 306 boost::shared_ptr<Processor>
 307 ProcessorEntry::processor () const
 308 {
 309         return _processor;
 310 }
 311
 312 void
 313 ProcessorEntry::set_enum_width (Width w)
 314 {
 315         _width = w;
 316         _button.set_text (name (_width));
 317 }
 318
 319 void
 320 ProcessorEntry::led_clicked(GdkEventButton *ev)
 321 {
 322         bool ctrl_shift_pressed = false;
 323         Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
 324
 325         if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
 326                 ctrl_shift_pressed = true;
 327         }
 328
 329         if (_processor) {
 330                 if (_button.get_active ()) {
 331                         if (ctrl_shift_pressed) {
 332                                 _parent->all_visible_processors_active(false);
 333
 334                                 if (_position == Fader) {
 335                                         _processor->deactivate ();
 336                                 }
 337                         }
 338                         else {
 339                                 _processor->deactivate ();
 340                         }
 341
 342                 } else {
 343                         if (ctrl_shift_pressed) {
 344                                 _parent->all_visible_processors_active(true);
 345
 346                                 if (_position == Fader) {
 347                                         _processor->activate ();
 348                                 }
 349                         }
 350                         else {
 351                                 _processor->activate ();
 352                         }
 353                 }
 354         }
 355 }
 356
 357 void
 358 ProcessorEntry::processor_active_changed ()
 359 {
 360         if (_processor) {
 361                 _button.set_active (_processor->active());
 362         }
 363 }
 364
 365 void
 366 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
 367 {
 368         if (what_changed.contains (ARDOUR::Properties::name)) {
 369                 _button.set_text (name (_width));
 370                 setup_tooltip ();
 371         }
 372 }
 373
 374 void
 375 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
 376 {
 377         _input_icon.set_ports(in);
 378         _output_icon.set_ports(out);
 379         _routing_icon.set_sources(in);
 380         _routing_icon.set_sinks(out);
 381         _input_icon.queue_draw();
 382         _output_icon.queue_draw();
 383         _routing_icon.queue_draw();
 384 }
 385
 386 void
 387 ProcessorEntry::setup_tooltip ()
 388 {
 389         if (_processor) {
 390                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 391                 if (pi) {
 392                         std::string postfix = "";
 393                         uint32_t replicated;
 394                         if ((replicated = pi->get_count()) > 1) {
 395                                 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
 396                         }
 397                         if (pi->plugin()->has_editor()) {
 398                                 ARDOUR_UI_UTILS::set_tooltip (_button,
 399                                                 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));
 400                         } else {
 401                                 ARDOUR_UI_UTILS::set_tooltip (_button,
 402                                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
 403                         }
 404                         return;
 405                 }
 406                 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
 407                         ARDOUR_UI::instance()->set_tip (_button,
 408                                         string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
 409                         return;
 410                 }
 411         }
 412         ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
 413 }
 414
 415 string
 416 ProcessorEntry::name (Width w) const
 417 {
 418         boost::shared_ptr<Send> send;
 419         string name_display;
 420
 421         if (!_processor) {
 422                 return string();
 423         }
 424
 425         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
 426             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
 427
 428                 name_display += '>';
 429
 430                 /* grab the send name out of its overall name */
 431
 432                 string::size_type lbracket, rbracket;
 433                 lbracket = send->name().find ('[');
 434                 rbracket = send->name().find (']');
 435
 436                 switch (w) {
 437                 case Wide:
 438                         name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
 439                         break;
 440                 case Narrow:
 441                         name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
 442                         break;
 443                 }
 444
 445         } else {
 446                 boost::shared_ptr<ARDOUR::PluginInsert> pi;
 447                 uint32_t replicated;
 448                 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
 449                                 && (replicated = pi->get_count()) > 1)
 450                 {
 451                         name_display += string_compose(_("(%1x1) "), replicated);
 452                 }
 453
 454                 switch (w) {
 455                 case Wide:
 456                         name_display += _processor->display_name();
 457                         break;
 458                 case Narrow:
 459                         name_display += PBD::short_version (_processor->display_name(), 5);
 460                         break;
 461                 }
 462
 463         }
 464
 465         return name_display;
 466 }
 467
 468 void
 469 ProcessorEntry::show_all_controls ()
 470 {
 471         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 472                 (*i)->set_visible (true);
 473         }
 474
 475         _parent->update_gui_object_state (this);
 476 }
 477
 478 void
 479 ProcessorEntry::hide_all_controls ()
 480 {
 481         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 482                 (*i)->set_visible (false);
 483         }
 484
 485         _parent->update_gui_object_state (this);
 486 }
 487
 488 void
 489 ProcessorEntry::add_control_state (XMLNode* node) const
 490 {
 491         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 492                 (*i)->add_state (node);
 493         }
 494 }
 495
 496 void
 497 ProcessorEntry::set_control_state (XMLNode const * node)
 498 {
 499         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 500                 (*i)->set_state (node);
 501         }
 502 }
 503
 504 string
 505 ProcessorEntry::state_id () const
 506 {
 507         return string_compose ("processor %1", _processor->id().to_s());
 508 }
 509
 510 void
 511 ProcessorEntry::hide_things ()
 512 {
 513         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 514                 (*i)->hide_things ();
 515         }
 516 }
 517
 518
 519 Menu *
 520 ProcessorEntry::build_controls_menu ()
 521 {
 522         using namespace Menu_Helpers;
 523         Menu* menu = manage (new Menu);
 524         MenuList& items = menu->items ();
 525
 526         items.push_back (
 527                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
 528                 );
 529
 530         items.push_back (
 531                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
 532                 );
 533
 534         if (!_controls.empty ()) {
 535                 items.push_back (SeparatorElem ());
 536         }
 537
 538         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 539                 items.push_back (CheckMenuElem ((*i)->name ()));
 540                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 541                 c->set_active ((*i)->visible ());
 542                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
 543         }
 544
 545         return menu;
 546 }
 547
 548 void
 549 ProcessorEntry::toggle_control_visibility (Control* c)
 550 {
 551         c->set_visible (!c->visible ());
 552         _parent->update_gui_object_state (this);
 553 }
 554
 555 Menu *
 556 ProcessorEntry::build_send_options_menu ()
 557 {
 558         using namespace Menu_Helpers;
 559         Menu* menu = manage (new Menu);
 560         MenuList& items = menu->items ();
 561
 562         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
 563         if (send) {
 564
 565                 items.push_back (CheckMenuElem (_("Link panner controls")));
 566                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 567                 c->set_active (send->panner_shell()->is_linked_to_route());
 568                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
 569
 570         }
 571         return menu;
 572 }
 573
 574 void
 575 ProcessorEntry::toggle_panner_link ()
 576 {
 577         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
 578         if (send) {
 579                 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
 580         }
 581 }
 582
 583 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
 584         : _control (c)
 585         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
 586         , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
 587         , _slider_persistant_tooltip (&_slider)
 588         , _button (ArdourButton::led_default_elements)
 589         , _ignore_ui_adjustment (false)
 590         , _visible (false)
 591         , _name (n)
 592 {
 593         _slider.set_controllable (c);
 594         box.set_padding(0, 0, 4, 4);
 595
 596         if (c->toggled()) {
 597                 _button.set_text (_name);
 598                 _button.set_led_left (true);
 599                 _button.set_name ("processor control button");
 600                 box.add (_button);
 601                 _button.show ();
 602
 603                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
 604                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
 605                 // dup. currently timers are used :(
 606                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 607
 608         } else {
 609
 610                 _slider.set_name ("ProcessorControlSlider");
 611                 _slider.set_text (_name);
 612
 613                 box.add (_slider);
 614                 _slider.show ();
 615
 616                 const ARDOUR::ParameterDescriptor& desc = c->desc();
 617                 double const lo = c->internal_to_interface(desc.lower);
 618                 double const up = c->internal_to_interface(desc.upper);
 619                 double const normal = c->internal_to_interface(desc.normal);
 620                 double smallstep = desc.smallstep;
 621                 double largestep = desc.largestep;
 622
 623                 if (smallstep == 0.0) {
 624                         smallstep = up / 1000.;
 625                 } else {
 626                         smallstep = c->internal_to_interface(desc.lower + smallstep);
 627                 }
 628
 629                 if (largestep == 0.0) {
 630                         largestep = up / 40.;
 631                 } else {
 632                         largestep = c->internal_to_interface(desc.lower + largestep);
 633                 }
 634
 635                 _adjustment.set_lower (lo);
 636                 _adjustment.set_upper (up);
 637                 _adjustment.set_step_increment (smallstep);
 638                 _adjustment.set_page_increment (largestep);
 639                 _slider.set_default_value (normal);
 640
 641                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
 642                 // dup. currently timers are used :(
 643                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 644         }
 645
 646         // yuck, do we really need to do this?
 647         // according to c404374 this is only needed for send automation
 648         timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
 649
 650         control_changed ();
 651         set_tooltip ();
 652
 653         /* We're providing our own PersistentTooltip */
 654         set_no_tooltip_whatsoever (_slider);
 655 }
 656
 657 ProcessorEntry::Control::~Control ()
 658 {
 659         timer_connection.disconnect ();
 660 }
 661
 662 void
 663 ProcessorEntry::Control::set_tooltip ()
 664 {
 665         boost::shared_ptr<AutomationControl> c = _control.lock ();
 666
 667         if (!c) {
 668                 return;
 669         }
 670         char tmp[256];
 671         if (c->toggled ()) {
 672                 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
 673         } else {
 674                 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
 675         }
 676
 677         string sm = Gtkmm2ext::markup_escape_text (tmp);
 678         _slider_persistant_tooltip.set_tip (sm);
 679         ARDOUR_UI_UTILS::set_tooltip (_button, sm);
 680 }
 681
 682 void
 683 ProcessorEntry::Control::slider_adjusted ()
 684 {
 685         if (_ignore_ui_adjustment) {
 686                 return;
 687         }
 688
 689         boost::shared_ptr<AutomationControl> c = _control.lock ();
 690
 691         if (!c) {
 692                 return;
 693         }
 694
 695         c->set_value ( c->interface_to_internal(_adjustment.get_value ()) );
 696         set_tooltip ();
 697 }
 698
 699 void
 700 ProcessorEntry::Control::button_clicked ()
 701 {
 702         boost::shared_ptr<AutomationControl> c = _control.lock ();
 703
 704         if (!c) {
 705                 return;
 706         }
 707
 708         bool const n = _button.get_active ();
 709
 710         c->set_value (n ? 0 : 1);
 711         _button.set_active (!n);
 712         set_tooltip ();
 713 }
 714
 715 void
 716 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
 717 {
 718         (void) ev;
 719
 720         button_clicked ();
 721 }
 722
 723 void
 724 ProcessorEntry::Control::control_changed ()
 725 {
 726         boost::shared_ptr<AutomationControl> c = _control.lock ();
 727         if (!c) {
 728                 return;
 729         }
 730
 731         _ignore_ui_adjustment = true;
 732
 733         if (c->toggled ()) {
 734
 735                 _button.set_active (c->get_value() > 0.5);
 736
 737         } else {
 738                 // as long as rapid timers are used, only update the tooltip
 739                 // if the value has changed.
 740                 const double nval = c->internal_to_interface (c->get_value ());
 741                 if (_adjustment.get_value() != nval) {
 742                         _adjustment.set_value (nval);
 743                         set_tooltip ();
 744                 }
 745         }
 746
 747         _ignore_ui_adjustment = false;
 748 }
 749
 750 void
 751 ProcessorEntry::Control::add_state (XMLNode* node) const
 752 {
 753         XMLNode* c = new XMLNode (X_("Object"));
 754         c->add_property (X_("id"), state_id ());
 755         c->add_property (X_("visible"), _visible);
 756         node->add_child_nocopy (*c);
 757 }
 758
 759 void
 760 ProcessorEntry::Control::set_state (XMLNode const * node)
 761 {
 762         XMLNode* n = GUIObjectState::get_node (node, state_id ());
 763         if (n) {
 764                 XMLProperty* p = n->property (X_("visible"));
 765                 set_visible (p && string_is_affirmative (p->value ()));
 766         } else {
 767                 set_visible (false);
 768         }
 769 }
 770
 771 void
 772 ProcessorEntry::Control::set_visible (bool v)
 773 {
 774         if (v) {
 775                 box.show ();
 776         } else {
 777                 box.hide ();
 778         }
 779
 780         _visible = v;
 781 }
 782
 783 /** Called when the Editor might have re-shown things that
 784     we want hidden.
 785 */
 786 void
 787 ProcessorEntry::Control::hide_things ()
 788 {
 789         if (!_visible) {
 790                 box.hide ();
 791         }
 792 }
 793
 794 string
 795 ProcessorEntry::Control::state_id () const
 796 {
 797         boost::shared_ptr<AutomationControl> c = _control.lock ();
 798         assert (c);
 799
 800         return string_compose (X_("control %1"), c->id().to_s ());
 801 }
 802
 803 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
 804         : ProcessorEntry (b, p, w)
 805         , _plugin_insert (p)
 806 {
 807         p->PluginIoReConfigure.connect (
 808                 _splitting_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::plugin_insert_splitting_changed, this), gui_context()
 809                 );
 810
 811         plugin_insert_splitting_changed ();
 812 }
 813
 814 void
 815 PluginInsertProcessorEntry::plugin_insert_splitting_changed ()
 816 {
 817         ChanCount in, out; // actual configured i/o
 818         _plugin_insert->configured_io (in, out);
 819
 820         /* get number of input ports */
 821         ChanCount sinks = _plugin_insert->natural_input_streams();
 822         if (!_plugin_insert->splitting () && _plugin_insert->get_count() > 1) {
 823                 /* replicated instances */
 824                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 825                         sinks.set(*t, sinks.get(*t) * _plugin_insert->get_count());
 826                 }
 827         }
 828         /* MIDI bypass */
 829         if (_plugin_insert->natural_output_streams().n_midi() == 0 &&
 830                         _plugin_insert->output_streams().n_midi() == 1) {
 831                 in.set(DataType::MIDI, 1);
 832                 out.set(DataType::MIDI, 1);
 833                 sinks.set(DataType::MIDI, 1);
 834         }
 835
 836         /* the Input streams available (*valid* outputs from prev. plugin)
 837          * this will be <= sinks. Some input-ports of this processor
 838          * may be unconnected.
 839          */
 840         _routing_icon.set_sources(in);
 841
 842         /* the actual input ports of this processor */
 843         _input_icon.set_ports(sinks);
 844         _routing_icon.set_sinks(sinks);
 845
 846         /* set/override plugin-output ports to actual outputs-streams.
 847          *
 848          * This plugin may have unconnected output-ports (currently only in Mixbus,
 849          * e.g channelstrip-EQ at the top of a MIDI-channel before the synth).
 850          *
 851          * The *next* processor below this one will only see the
 852          * actual available streams (it cannot know the real outputs
 853          * of this plugin).
 854          *
 855          * There is currently no API to query the ports of the previous (or next)
 856          * processor.
 857          *
 858          * (normally - iff configuration succeeds - this is set during
 859          * ProcessorEntry::processor_configuration_changed() and should
 860          * equal _plugin_insert->output_streams())
 861          */
 862         _output_icon.set_ports(out);
 863 #ifndef NDEBUG
 864         if (out != _plugin_insert->output_streams()) {
 865                 std::cerr << "Processor Wiring: " <<  processor()->name()
 866                         << " out-ports: " << _plugin_insert->output_streams() // NB. does not include midi-bypass
 867                         << " out-connections: " << out
 868                         << endmsg;
 869         }
 870 #endif
 871
 872         _routing_icon.set_splitting(_plugin_insert->splitting ());
 873
 874         if (_plugin_insert->splitting () ||  in != sinks)
 875         {
 876                 _routing_icon.set_size_request (-1, std::max (7.f, rintf(7.f * UIConfiguration::instance().get_ui_scale())));
 877                 _routing_icon.set_visible(true);
 878                 _input_icon.show();
 879         } else {
 880                 _routing_icon.set_visible(false);
 881                 if (_position_num != 0) {
 882                         _input_icon.hide();
 883                 }
 884         }
 885
 886         _input_icon.queue_draw();
 887         _output_icon.queue_draw();
 888         _routing_icon.queue_draw();
 889 }
 890
 891 void
 892 PluginInsertProcessorEntry::hide_things ()
 893 {
 894         ProcessorEntry::hide_things ();
 895         plugin_insert_splitting_changed ();
 896 }
 897
 898 ProcessorEntry::PortIcon::PortIcon(bool input) {
 899         _input = input;
 900         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 901         set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
 902 }
 903
 904 bool
 905 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
 906 {
 907         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
 908
 909         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
 910         cairo_clip (cr);
 911
 912         Gtk::Allocation a = get_allocation();
 913         double const width = a.get_width();
 914         double const height = a.get_height();
 915
 916         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
 917         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
 918
 919         cairo_rectangle (cr, 0, 0, width, height);
 920         cairo_fill (cr);
 921
 922         const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
 923         if (_ports.n_total() > 1) {
 924                 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
 925                         if (i < _ports.n_midi()) {
 926                                 cairo_set_source_rgb (cr,
 927                                                 UINT_RGBA_R_FLT(midi_port_color),
 928                                                 UINT_RGBA_G_FLT(midi_port_color),
 929                                                 UINT_RGBA_B_FLT(midi_port_color));
 930                         } else {
 931                                 cairo_set_source_rgb (cr,
 932                                                 UINT_RGBA_R_FLT(audio_port_color),
 933                                                 UINT_RGBA_G_FLT(audio_port_color),
 934                                                 UINT_RGBA_B_FLT(audio_port_color));
 935                         }
 936                         const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
 937                         cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
 938                         cairo_fill(cr);
 939                 }
 940         } else if (_ports.n_total() == 1) {
 941                 if (_ports.n_midi() == 1) {
 942                         cairo_set_source_rgb (cr,
 943                                         UINT_RGBA_R_FLT(midi_port_color),
 944                                         UINT_RGBA_G_FLT(midi_port_color),
 945                                         UINT_RGBA_B_FLT(midi_port_color));
 946                 } else {
 947                         cairo_set_source_rgb (cr,
 948                                         UINT_RGBA_R_FLT(audio_port_color),
 949                                         UINT_RGBA_G_FLT(audio_port_color),
 950                                         UINT_RGBA_B_FLT(audio_port_color));
 951                 }
 952                 const float x = rintf(width * .5);
 953                 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
 954                 cairo_fill(cr);
 955                 cairo_stroke(cr);
 956         }
 957
 958         cairo_destroy(cr);
 959         return true;
 960 }
 961
 962 bool
 963 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
 964 {
 965         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
 966
 967         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
 968         cairo_clip (cr);
 969
 970         cairo_set_line_width (cr, max (1.f, UIConfiguration::instance().get_ui_scale()));
 971         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
 972
 973         Gtk::Allocation a = get_allocation();
 974         double const width = a.get_width();
 975         double const height = a.get_height();
 976
 977         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
 978         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
 979
 980         cairo_rectangle (cr, 0, 0, width, height);
 981         cairo_fill (cr);
 982
 983         Gdk::Color const fg = get_style()->get_fg (STATE_NORMAL);
 984         cairo_set_source_rgb (cr, fg.get_red_p (), fg.get_green_p (), fg.get_blue_p ());
 985
 986         const uint32_t sources = _sources.n_total();
 987         const uint32_t sinks = _sinks.n_total();
 988
 989         const uint32_t midi_sources = _sources.n_midi();
 990         const uint32_t midi_sinks = _sinks.n_midi();
 991         const uint32_t audio_sources = _sources.n_audio();
 992         const uint32_t audio_sinks = _sinks.n_audio();
 993
 994         /* MIDI */
 995         cairo_set_source_rgb (cr,
 996                         UINT_RGBA_R_FLT(midi_port_color),
 997                         UINT_RGBA_G_FLT(midi_port_color),
 998                         UINT_RGBA_B_FLT(midi_port_color));
 999         if (midi_sources > 0 && midi_sinks > 0 && sinks > 1 && sources > 1) {
1000                 for (uint32_t i = 0 ; i < midi_sources; ++i) {
1001                         const float si_x  = rintf(width * (.2f + .6f * i  / (sinks - 1.f))) + .5f;
1002                         const float si_x0 = rintf(width * (.2f + .6f * i / (sources - 1.f))) + .5f;
1003                         cairo_move_to (cr, si_x, height);
1004                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1005                         cairo_stroke (cr);
1006                 }
1007         } else if (midi_sources == 1 && midi_sinks == 1 && sinks == 1 && sources == 1) {
1008                 const float si_x = rintf(width * .5f) + .5f;
1009                 cairo_move_to (cr, si_x, height);
1010                 cairo_line_to (cr, si_x, 0);
1011                 cairo_stroke (cr);
1012         } else if (midi_sources == 1 && midi_sinks == 1) {
1013                 /* unusual cases -- removed synth, midi-track w/audio plugins */
1014                 const float si_x  = rintf(width * (sinks   > 1 ? .2f : .5f)) + .5f;
1015                 const float si_x0 = rintf(width * (sources > 1 ? .2f : .5f)) + .5f;
1016                 cairo_move_to (cr, si_x, height);
1017                 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1018                 cairo_stroke (cr);
1019         } else if (midi_sources == 0 && midi_sinks == 1) {
1020                 const double dx = 1 + rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1021                 // draw "T"
1022                 //  TODO connect back to track-input of last midi-out if any, otherwise draw "X"
1023                 const float si_x  = rintf(width * .2f) + .5f;
1024                 cairo_move_to (cr, si_x, height);
1025                 cairo_line_to (cr, si_x, height * .66);
1026                 cairo_move_to (cr, si_x - dx, height * .66);
1027                 cairo_line_to (cr, si_x + dx, height * .66);
1028                 cairo_stroke (cr);
1029 #ifndef NDEBUG
1030         } else if (midi_sources != 0 && midi_sinks != 0) {
1031                 PBD::warning << string_compose("Programming error: midi routing display: A %1 -> %2 | M %3 -> %4 | T %5 -> %6",
1032                                 audio_sources, audio_sinks, midi_sources, midi_sinks, sources, sinks) << endmsg;
1033 #endif
1034         }
1035
1036         /* AUDIO */
1037         cairo_set_source_rgb (cr,
1038                         UINT_RGBA_R_FLT(audio_port_color),
1039                         UINT_RGBA_G_FLT(audio_port_color),
1040                         UINT_RGBA_B_FLT(audio_port_color));
1041
1042         if (_splitting) {
1043                 assert(audio_sources < 2);
1044                 assert(audio_sinks > 1);
1045                 /* assume there is only ever one MIDI port */
1046                 const float si_x0 = rintf(width * (midi_sources > 0 ? .8f : .5f)) + .5f;
1047                 for (uint32_t i = midi_sinks; i < sinks; ++i) {
1048                         const float si_x = rintf(width * (.2f + .6f * i / (sinks - 1.f))) + .5f;
1049                         cairo_move_to (cr, si_x, height);
1050                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1051                         cairo_stroke (cr);
1052                 }
1053         } else if (audio_sources > 1 && sinks > 1) {
1054                 for (uint32_t i = 0 ; i < audio_sources; ++i) {
1055                         const float si_x = rintf(width * (.2f + .6f * (i + midi_sinks) / (sinks - 1.f))) + .5f;
1056                         const float si_x0 = rintf(width * (.2f + .6f * (i + midi_sources) / (sources - 1.f))) + .5f;
1057                         cairo_move_to (cr, si_x, height);
1058                         cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1059                         cairo_stroke (cr);
1060                 }
1061         } else if (audio_sources == 1 && audio_sinks > 0) {
1062                 float si_x, si_x0;
1063                 if (sinks == 1) {
1064                         si_x = rintf(width * .5f) + .5f;
1065                 } else {
1066                         si_x = rintf(width * (.2f + .6f * midi_sinks / (sinks - 1.f))) + .5f;
1067                 }
1068                 if (sources == 1) {
1069                         si_x0 = rintf(width * .5f) + .5f;
1070                 } else {
1071                         si_x0 = rintf(width * (.2f + .6f * midi_sources / (sources - 1.f))) + .5f;
1072                 }
1073                 cairo_move_to (cr, si_x, height);
1074                 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1075                 cairo_stroke (cr);
1076 #ifndef NDEBUG
1077         } else if (audio_sources != 0 && audio_sinks != 0) {
1078                 PBD::warning << string_compose("Programming error: audio routing display: A %1 -> %2 | M %3 -> %4 | T %5 -> %6",
1079                                 audio_sources, audio_sinks, midi_sources, midi_sinks, sources, sinks) << endmsg;
1080 #endif
1081         }
1082         cairo_destroy(cr);
1083         return true;
1084 }
1085
1086 static std::list<Gtk::TargetEntry> drop_targets()
1087 {
1088         std::list<Gtk::TargetEntry> tmp;
1089         tmp.push_back (Gtk::TargetEntry ("processor"));
1090         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr"));
1091         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr"));
1092         return tmp;
1093 }
1094
1095 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1096                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1097         : _parent_strip (parent)
1098         , _owner_is_mixer (owner_is_mixer)
1099         , ab_direction (true)
1100         , _get_plugin_selector (get_plugin_selector)
1101         , _placement (-1)
1102         , _visible_prefader_processors (0)
1103         , _rr_selection(rsel)
1104         , processor_display (drop_targets())
1105         , _redisplay_pending (false)
1106
1107 {
1108         set_session (sess);
1109
1110         _width = Wide;
1111         processor_menu = 0;
1112         no_processor_redisplay = false;
1113
1114         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1115         processor_scroller.add (processor_display);
1116         pack_start (processor_scroller, true, true);
1117
1118         processor_display.set_flags (CAN_FOCUS);
1119         processor_display.set_name ("ProcessorList");
1120         processor_display.set_data ("processorbox", this);
1121         processor_display.set_size_request (48, -1);
1122         processor_display.set_spacing (0);
1123
1124         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1125         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1126
1127         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1128         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1129
1130         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1131         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1132         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1133
1134         processor_scroller.show ();
1135         processor_display.show ();
1136
1137         if (parent) {
1138                 parent->DeliveryChanged.connect (
1139                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1140                         );
1141         }
1142
1143         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1144 }
1145
1146 ProcessorBox::~ProcessorBox ()
1147 {
1148         /* it may appear as if we should delete processor_menu but that is a
1149          * pointer to a widget owned by the UI Manager, and has potentially
1150          * be returned to many other ProcessorBoxes. GTK doesn't really make
1151          * clear the ownership of this widget, which is a menu and thus is
1152          * never packed into any container other than an implict GtkWindow.
1153          *
1154          * For now, until or if we ever get clarification over the ownership
1155          * story just let it continue to exist. At worst, its a small memory leak.
1156          */
1157 }
1158
1159 void
1160 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1161 {
1162         if (_route == r) {
1163                 return;
1164         }
1165
1166         _route_connections.drop_connections();
1167
1168         /* new route: any existing block on processor redisplay must be meaningless */
1169         no_processor_redisplay = false;
1170         _route = r;
1171
1172         _route->processors_changed.connect (
1173                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1174                 );
1175
1176         _route->DropReferences.connect (
1177                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1178                 );
1179
1180         _route->PropertyChanged.connect (
1181                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1182                 );
1183
1184         redisplay_processors ();
1185 }
1186
1187 void
1188 ProcessorBox::route_going_away ()
1189 {
1190         /* don't keep updating display as processors are deleted */
1191         no_processor_redisplay = true;
1192         _route.reset ();
1193 }
1194
1195 boost::shared_ptr<Processor>
1196 ProcessorBox::find_drop_position (ProcessorEntry* position)
1197 {
1198         boost::shared_ptr<Processor> p;
1199         if (position) {
1200                 p = position->processor ();
1201                 if (!p) {
1202                         /* dropped on the blank entry (which will be before the
1203                                  fader), so use the first non-blank child as our
1204                                  `dropped on' processor */
1205                         list<ProcessorEntry*> c = processor_display.children ();
1206                         list<ProcessorEntry*>::iterator i = c.begin ();
1207
1208                         assert (i != c.end ());
1209                         p = (*i)->processor ();
1210                         assert (p);
1211                 }
1212         }
1213         return p;
1214 }
1215
1216 void
1217 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1218 {
1219                 const void * d = data.get_data();
1220                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1221
1222                 PluginPresetList nfos;
1223                 TreeView* source;
1224                 tv->get_object_drag_data (nfos, &source);
1225
1226                 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1227                         PluginPresetPtr ppp = (*i);
1228                         PluginInfoPtr pip = ppp->_pip;
1229                         PluginPtr p = pip->load (*_session);
1230                         if (!p) {
1231                                 continue;
1232                         }
1233
1234                         if (ppp->_preset.valid) {
1235                                 p->load_preset (ppp->_preset);
1236                         }
1237
1238                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1239                         if (Config->get_new_plugins_active ()) {
1240                                 processor->activate ();
1241                         }
1242                         pl.push_back (processor);
1243                 }
1244 }
1245
1246 void
1247 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1248 {
1249                 const void * d = data.get_data();
1250                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1251                 PluginInfoList nfos;
1252
1253                 TreeView* source;
1254                 tv->get_object_drag_data (nfos, &source);
1255
1256                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1257                         PluginPtr p = (*i)->load (*_session);
1258                         if (!p) {
1259                                 continue;
1260                         }
1261                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1262                         if (Config->get_new_plugins_active ()) {
1263                                 processor->activate ();
1264                         }
1265                         pl.push_back (processor);
1266                 }
1267 }
1268
1269 void
1270 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1271 {
1272         if (!_session) {
1273                 return;
1274         }
1275
1276         boost::shared_ptr<Processor> p = find_drop_position (position);
1277         Route::ProcessorList pl;
1278
1279         if (data.get_target() == "PluginInfoPtr") {
1280                 _drop_plugin (data, pl);
1281         }
1282         else if (data.get_target() == "PluginPresetPtr") {
1283                 _drop_plugin_preset (data, pl);
1284         }
1285         else {
1286                 return;
1287         }
1288
1289         Route::ProcessorStreams err;
1290         if (_route->add_processors (pl, p, &err)) {
1291                 string msg = _(
1292                                 "Processor Drag/Drop failed. Probably because\n\
1293 the I/O configuration of the plugins could\n\
1294 not match the configuration of this track.");
1295                 MessageDialog am (msg);
1296                 am.run ();
1297         }
1298 }
1299
1300 void
1301 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1302 {
1303         boost::shared_ptr<Processor> p = find_drop_position (position);
1304
1305         list<ProcessorEntry*> children = source->selection ();
1306         list<boost::shared_ptr<Processor> > procs;
1307         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1308                 if ((*i)->processor ()) {
1309                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1310                                 continue;
1311                         }
1312                         procs.push_back ((*i)->processor ());
1313                 }
1314         }
1315
1316         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1317                 XMLNode& state = (*i)->get_state ();
1318                 XMLNodeList nlist;
1319                 nlist.push_back (&state);
1320                 paste_processor_state (nlist, p);
1321                 delete &state;
1322         }
1323
1324         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1325            ourselves.
1326         */
1327
1328         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1329                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1330                 if (other) {
1331                         other->delete_dragged_processors (procs);
1332                 }
1333         }
1334 }
1335
1336 void
1337 ProcessorBox::set_width (Width w)
1338 {
1339         if (_width == w) {
1340                 return;
1341         }
1342
1343         _width = w;
1344
1345         list<ProcessorEntry*> children = processor_display.children ();
1346         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1347                 (*i)->set_enum_width (w);
1348         }
1349
1350         queue_resize ();
1351 }
1352
1353 Gtk::Menu*
1354 ProcessorBox::build_possible_aux_menu ()
1355 {
1356         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1357
1358         if (rl->empty()) {
1359                 /* No aux sends if there are no busses */
1360                 return 0;
1361         }
1362
1363         if (_route->is_monitor ()) {
1364                 return 0;
1365         }
1366
1367         using namespace Menu_Helpers;
1368         Menu* menu = manage (new Menu);
1369         MenuList& items = menu->items();
1370
1371         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1372                 if (!_route->internal_send_for (*r) && *r != _route) {
1373                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
1374                 }
1375         }
1376
1377         return menu;
1378 }
1379
1380 void
1381 ProcessorBox::show_processor_menu (int arg)
1382 {
1383         if (processor_menu == 0) {
1384                 processor_menu = build_processor_menu ();
1385                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
1386         }
1387
1388         /* Sort out the plugin submenu */
1389
1390         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
1391
1392         if (plugin_menu_item) {
1393                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
1394         }
1395
1396         /* And the aux submenu */
1397
1398         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
1399
1400         if (aux_menu_item) {
1401                 Menu* m = build_possible_aux_menu();
1402                 if (m && !m->items().empty()) {
1403                         aux_menu_item->set_submenu (*m);
1404                         aux_menu_item->set_sensitive (true);
1405                 } else {
1406                         /* stupid gtkmm: we need to pass a null reference here */
1407                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
1408                         aux_menu_item->set_sensitive (false);
1409                 }
1410         }
1411
1412         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
1413         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
1414
1415         ProcessorEntry* single_selection = 0;
1416         if (processor_display.selection().size() == 1) {
1417                 single_selection = processor_display.selection().front();
1418         }
1419
1420         /* And the controls submenu */
1421
1422         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
1423
1424         if (controls_menu_item) {
1425                 if (single_selection) {
1426                         Menu* m = single_selection->build_controls_menu ();
1427                         if (m && !m->items().empty()) {
1428                                 controls_menu_item->set_submenu (*m);
1429                                 controls_menu_item->set_sensitive (true);
1430                         } else {
1431                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
1432                                 controls_menu_item->set_sensitive (false);
1433                         }
1434                 } else {
1435                         controls_menu_item->set_sensitive (false);
1436                 }
1437         }
1438
1439         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
1440         if (send_menu_item) {
1441                 if (single_selection && !_route->is_monitor()) {
1442                         Menu* m = single_selection->build_send_options_menu ();
1443                         if (m && !m->items().empty()) {
1444                                 send_menu_item->set_submenu (*m);
1445                                 send_menu_item->set_sensitive (true);
1446                         } else {
1447                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
1448                                 send_menu_item->set_sensitive (false);
1449                         }
1450                 } else {
1451                         send_menu_item->set_sensitive (false);
1452                 }
1453         }
1454
1455         /* Sensitise actions as approprioate */
1456
1457
1458         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
1459
1460         paste_action->set_sensitive (!_rr_selection.processors.empty());
1461         cut_action->set_sensitive (sensitive && can_cut ());
1462         copy_action->set_sensitive (sensitive);
1463         delete_action->set_sensitive (sensitive || stub_processor_selected ());
1464
1465         edit_action->set_sensitive (one_processor_can_be_edited ());
1466         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
1467
1468         boost::shared_ptr<PluginInsert> pi;
1469         if (single_selection) {
1470                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
1471         }
1472
1473         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
1474         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
1475
1476         /* disallow rename for multiple selections, for plugin inserts and for the fader */
1477         rename_action->set_sensitive (single_selection
1478                         && !pi
1479                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
1480                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
1481
1482         processor_menu->popup (1, arg);
1483
1484         /* Add a placeholder gap to the processor list to indicate where a processor would be
1485            inserted were one chosen from the menu.
1486         */
1487         int x, y;
1488         processor_display.get_pointer (x, y);
1489         _placement = processor_display.add_placeholder (y);
1490
1491         if (_visible_prefader_processors == 0 && _placement > 0) {
1492                 --_placement;
1493         }
1494 }
1495
1496 bool
1497 ProcessorBox::enter_notify (GdkEventCrossing*)
1498 {
1499         _current_processor_box = this;
1500         return false;
1501 }
1502
1503 bool
1504 ProcessorBox::leave_notify (GdkEventCrossing*)
1505 {
1506         return false;
1507 }
1508
1509 bool
1510 ProcessorBox::processor_operation (ProcessorOperation op)
1511 {
1512         ProcSelection targets;
1513
1514         get_selected_processors (targets);
1515
1516 /*      if (targets.empty()) {
1517
1518                 int x, y;
1519                 processor_display.get_pointer (x, y);
1520
1521                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
1522
1523                 if (pointer.first && pointer.first->processor()) {
1524                         targets.push_back (pointer.first->processor ());
1525                 }
1526         }
1527 */
1528
1529         if ( (op == ProcessorsDelete) && targets.empty() )
1530                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
1531
1532         switch (op) {
1533         case ProcessorsSelectAll:
1534                 processor_display.select_all ();
1535                 break;
1536
1537         case ProcessorsSelectNone:
1538                 processor_display.select_none ();
1539                 break;
1540
1541         case ProcessorsCopy:
1542                 copy_processors (targets);
1543                 break;
1544
1545         case ProcessorsCut:
1546                 cut_processors (targets);
1547                 break;
1548
1549         case ProcessorsPaste:
1550                 // some processors are not selectable (e.g fader, meter), target is empty.
1551                 if (targets.empty() && _placement >= 0) {
1552                         assert (_route);
1553                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
1554                         if (proc) {
1555                                 targets.push_back (proc);
1556                         }
1557                 }
1558                 if (targets.empty()) {
1559                         paste_processors ();
1560                 } else {
1561                         paste_processors (targets.front());
1562                 }
1563                 break;
1564
1565         case ProcessorsDelete:
1566                 delete_processors (targets);
1567                 break;
1568
1569         case ProcessorsToggleActive:
1570                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
1571                         if ((*i)->active()) {
1572                                 (*i)->deactivate ();
1573                         } else {
1574                                 (*i)->activate ();
1575                         }
1576                 }
1577                 break;
1578
1579         case ProcessorsAB:
1580                 ab_plugins ();
1581                 break;
1582
1583         default:
1584                 break;
1585         }
1586
1587         return true;
1588 }
1589
1590 ProcessorWindowProxy*
1591 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
1592 {
1593         return  processor->window_proxy();
1594 }
1595
1596
1597 bool
1598 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
1599 {
1600         boost::shared_ptr<Processor> processor;
1601         if (child) {
1602                 processor = child->processor ();
1603         }
1604
1605         int ret = false;
1606         bool selected = processor_display.selected (child);
1607
1608         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
1609
1610                 if (_session->engine().connected()) {
1611                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
1612
1613                         if (!one_processor_can_be_edited ()) {
1614                                 return true;
1615                         }
1616
1617                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1618                                 generic_edit_processor (processor);
1619                         } else {
1620                                 edit_processor (processor);
1621                         }
1622                 }
1623
1624                 ret = true;
1625
1626         } else if (Keyboard::is_context_menu_event (ev)) {
1627
1628                 show_processor_menu (ev->time);
1629
1630                 ret = true;
1631
1632         } else if (processor && ev->button == 1 && selected) {
1633
1634                 // this is purely informational but necessary for route params UI
1635                 ProcessorSelected (processor); // emit
1636
1637         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
1638
1639                 choose_plugin ();
1640                 _get_plugin_selector()->show_manager ();
1641         }
1642
1643         return ret;
1644 }
1645
1646 bool
1647 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
1648 {
1649         boost::shared_ptr<Processor> processor;
1650         if (child) {
1651                 processor = child->processor ();
1652         }
1653
1654         if (processor && Keyboard::is_delete_event (ev)) {
1655
1656                 Glib::signal_idle().connect (sigc::bind (
1657                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
1658                                 boost::weak_ptr<Processor>(processor)));
1659
1660         } else if (processor && Keyboard::is_button2_event (ev)
1661 #ifndef GTKOSX
1662                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
1663 #endif
1664                 ) {
1665
1666                 /* button2-click with no/appropriate modifiers */
1667
1668                 if (processor->active()) {
1669                         processor->deactivate ();
1670                 } else {
1671                         processor->activate ();
1672                 }
1673         }
1674
1675         return false;
1676 }
1677
1678 Menu *
1679 ProcessorBox::build_processor_menu ()
1680 {
1681         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
1682         processor_menu->set_name ("ArdourContextMenu");
1683         return processor_menu;
1684 }
1685
1686 void
1687 ProcessorBox::select_all_processors ()
1688 {
1689         processor_display.select_all ();
1690 }
1691
1692 void
1693 ProcessorBox::deselect_all_processors ()
1694 {
1695         processor_display.select_none ();
1696 }
1697
1698 void
1699 ProcessorBox::choose_plugin ()
1700 {
1701         _get_plugin_selector()->set_interested_object (*this);
1702 }
1703
1704 /** @return true if an error occurred, otherwise false */
1705 bool
1706 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
1707 {
1708         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
1709
1710                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
1711
1712                 Route::ProcessorStreams err_streams;
1713
1714                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1715                         weird_plugin_dialog (**p, err_streams);
1716                         return true;
1717                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
1718                 } else if (plugins.size() == 1 && Config->get_open_gui_after_adding_plugin()) {
1719                         if (_session->engine().connected () && processor_can_be_edited (processor)) {
1720                                 if ((*p)->has_editor ()) {
1721                                         edit_processor (processor);
1722                                 } else {
1723                                         generic_edit_processor (processor);
1724                                 }
1725                         }
1726                 }
1727         }
1728
1729         return false;
1730 }
1731
1732 void
1733 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
1734 {
1735         ArdourDialog dialog (_("Plugin Incompatibility"));
1736         Label label;
1737
1738         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
1739                         p.name(), streams.index);
1740
1741         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
1742         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
1743
1744         text += _("\nThis plugin has:\n");
1745         if (has_midi) {
1746                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
1747                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
1748         }
1749         if (has_audio) {
1750                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
1751                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
1752         }
1753
1754         text += _("\nbut at the insertion point, there are:\n");
1755         if (has_midi) {
1756                 uint32_t const n = streams.count.n_midi ();
1757                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
1758         }
1759         if (has_audio) {
1760                 uint32_t const n = streams.count.n_audio ();
1761                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
1762         }
1763
1764         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
1765         label.set_text(text);
1766
1767         dialog.get_vbox()->pack_start (label);
1768         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1769
1770         dialog.set_name (X_("PluginIODialog"));
1771         dialog.set_modal (true);
1772         dialog.show_all ();
1773
1774         dialog.run ();
1775 }
1776
1777 void
1778 ProcessorBox::choose_insert ()
1779 {
1780         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
1781         _route->add_processor_by_index (processor, _placement);
1782 }
1783
1784 /* Caller must not hold process lock */
1785 void
1786 ProcessorBox::choose_send ()
1787 {
1788         boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
1789         boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
1790
1791         /* make an educated guess at the initial number of outputs for the send */
1792         ChanCount outs = (_session->master_out())
1793                         ? _session->master_out()->n_outputs()
1794                         : _route->n_outputs();
1795
1796         /* XXX need processor lock on route */
1797         try {
1798                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1799                 send->output()->ensure_io (outs, false, this);
1800         } catch (AudioEngine::PortRegistrationFailure& err) {
1801                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
1802                 return;
1803         }
1804
1805         /* let the user adjust the IO setup before creation.
1806
1807            Note: this dialog is NOT modal - we just leave it to run and it will
1808            return when its Finished signal is emitted - typically when the window
1809            is closed.
1810          */
1811
1812         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
1813         ios->show ();
1814
1815         /* keep a reference to the send so it doesn't get deleted while
1816            the IOSelectorWindow is doing its stuff
1817         */
1818         _processor_being_created = send;
1819
1820         ios->selector().Finished.connect (sigc::bind (
1821                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
1822                         boost::weak_ptr<Processor>(send), ios));
1823
1824 }
1825
1826 void
1827 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1828 {
1829         boost::shared_ptr<Processor> processor (weak_processor.lock());
1830
1831         /* drop our temporary reference to the new send */
1832         _processor_being_created.reset ();
1833
1834         if (!processor) {
1835                 return;
1836         }
1837
1838         switch (r) {
1839         case IOSelector::Cancelled:
1840                 // processor will go away when all shared_ptrs to it vanish
1841                 break;
1842
1843         case IOSelector::Accepted:
1844                 _route->add_processor_by_index (processor, _placement);
1845                 if (Profile->get_sae()) {
1846                         processor->activate ();
1847                 }
1848                 break;
1849         }
1850
1851         delete_when_idle (ios);
1852 }
1853
1854 void
1855 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1856 {
1857         boost::shared_ptr<Processor> processor (weak_processor.lock());
1858
1859         /* drop our temporary reference to the new return */
1860         _processor_being_created.reset ();
1861
1862         if (!processor) {
1863                 return;
1864         }
1865
1866         switch (r) {
1867         case IOSelector::Cancelled:
1868                 // processor will go away when all shared_ptrs to it vanish
1869                 break;
1870
1871         case IOSelector::Accepted:
1872                 _route->add_processor_by_index (processor, _placement);
1873                 if (Profile->get_sae()) {
1874                         processor->activate ();
1875                 }
1876                 break;
1877         }
1878
1879         delete_when_idle (ios);
1880 }
1881
1882 void
1883 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
1884 {
1885         if (!_route) {
1886                 return;
1887         }
1888
1889         boost::shared_ptr<Route> target = wr.lock();
1890
1891         if (!target) {
1892                 return;
1893         }
1894
1895         _session->add_internal_send (target, _placement, _route);
1896 }
1897
1898 void
1899 ProcessorBox::route_processors_changed (RouteProcessorChange c)
1900 {
1901         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
1902                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
1903                 return;
1904         }
1905
1906         redisplay_processors ();
1907 }
1908
1909 void
1910 ProcessorBox::redisplay_processors ()
1911 {
1912         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
1913         bool     fader_seen;
1914
1915         if (no_processor_redisplay) {
1916                 return;
1917         }
1918
1919         processor_display.clear ();
1920
1921         _visible_prefader_processors = 0;
1922         fader_seen = false;
1923
1924         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
1925                                                &_visible_prefader_processors, &fader_seen));
1926
1927         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
1928         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
1929         setup_entry_positions ();
1930 }
1931
1932 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
1933  *  not already have one.
1934  */
1935 void
1936 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
1937 {
1938         boost::shared_ptr<Processor> p = w.lock ();
1939         if (!p) {
1940                 return;
1941         }
1942         if (p->window_proxy()) {
1943                 return;
1944         }
1945
1946         /* not on the list; add it */
1947
1948         string loc;
1949 #if 0 // is this still needed? Why?
1950         if (_parent_strip) {
1951                 if (_parent_strip->mixer_owned()) {
1952                         loc = X_("M");
1953                 } else {
1954                         loc = X_("R");
1955                 }
1956         } else {
1957                 loc = X_("P");
1958         }
1959 #else
1960         loc = X_("P");
1961 #endif
1962
1963         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
1964                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
1965                 this,
1966                 w);
1967
1968         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
1969
1970         if (ui_xml) {
1971                 wp->set_state (*ui_xml);
1972         }
1973
1974         void* existing_ui = p->get_ui ();
1975
1976         if (existing_ui) {
1977                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
1978         }
1979
1980         p->set_window_proxy (wp);
1981         WM::Manager::instance().register_window (wp);
1982 }
1983
1984 void
1985 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
1986 {
1987         boost::shared_ptr<Processor> processor (p.lock ());
1988
1989         if (processor && ( processor->display_to_user()
1990 #ifndef NDEBUG
1991                             || show_all_processors
1992 #endif
1993                          )
1994            ) {
1995
1996                 if (boost::dynamic_pointer_cast<Amp>(processor) && boost::dynamic_pointer_cast<Amp>(processor)->type() == X_("amp")) {
1997                         *amp_seen = true;
1998                 } else {
1999                         if (!*amp_seen) {
2000                                 (*cnt)++;
2001                         }
2002                 }
2003         }
2004 }
2005
2006 void
2007 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2008 {
2009         boost::shared_ptr<Processor> processor (p.lock ());
2010
2011         if (!processor || ( !processor->display_to_user()
2012 #ifndef NDEBUG
2013                             && !show_all_processors
2014 #endif
2015                           )
2016            ) {
2017                 return;
2018         }
2019
2020         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2021
2022         ProcessorEntry* e = 0;
2023         if (plugin_insert) {
2024                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2025         } else {
2026                 e = new ProcessorEntry (this, processor, _width);
2027         }
2028
2029         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2030         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2031         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2032
2033         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2034         if (!send && !plugin_insert && !ext && !stub)
2035                 e->set_selectable(false);
2036
2037         bool mark_send_visible = false;
2038         if (send && _parent_strip) {
2039                 /* show controls of new sends by default */
2040                 GUIObjectState& st = _parent_strip->gui_object_state ();
2041                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2042                 assert (strip);
2043                 /* check if state exists, if not it must be a new send */
2044                 if (!st.get_node(strip, e->state_id())) {
2045                         mark_send_visible = true;
2046                 }
2047         }
2048
2049         /* Set up this entry's state from the GUIObjectState */
2050         XMLNode* proc = entry_gui_object_state (e);
2051         if (proc) {
2052                 e->set_control_state (proc);
2053         }
2054
2055         if (mark_send_visible) {
2056                 e->show_all_controls ();
2057         }
2058
2059         processor_display.add_child (e);
2060 }
2061
2062 void
2063 ProcessorBox::reordered ()
2064 {
2065         compute_processor_sort_keys ();
2066         setup_entry_positions ();
2067 }
2068
2069 void
2070 ProcessorBox::setup_entry_positions ()
2071 {
2072         list<ProcessorEntry*> children = processor_display.children ();
2073         bool pre_fader = true;
2074
2075         uint32_t num = 0;
2076         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2077                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) && boost::dynamic_pointer_cast<Amp>((*i)->processor())->type() == X_("amp")) {
2078                         pre_fader = false;
2079                         (*i)->set_position (ProcessorEntry::Fader, num++);
2080                 } else {
2081                         if (pre_fader) {
2082                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
2083                         } else {
2084                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
2085                         }
2086                 }
2087         }
2088 }
2089
2090 void
2091 ProcessorBox::compute_processor_sort_keys ()
2092 {
2093         list<ProcessorEntry*> children = processor_display.children ();
2094         Route::ProcessorList our_processors;
2095
2096         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2097                 if ((*i)->processor()) {
2098                         our_processors.push_back ((*i)->processor ());
2099                 }
2100         }
2101
2102         if (_route->reorder_processors (our_processors)) {
2103                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
2104                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
2105                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
2106                    when the drag is torn down after this handler function is finished.
2107                 */
2108                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2109         }
2110 }
2111
2112 void
2113 ProcessorBox::report_failed_reorder ()
2114 {
2115         /* reorder failed, so redisplay */
2116
2117         redisplay_processors ();
2118
2119         /* now tell them about the problem */
2120
2121         ArdourDialog dialog (_("Plugin Incompatibility"));
2122         Label label;
2123
2124         label.set_text (_("\
2125 You cannot reorder these plugins/sends/inserts\n\
2126 in that way because the inputs and\n\
2127 outputs will not work correctly."));
2128
2129         dialog.get_vbox()->set_border_width (12);
2130         dialog.get_vbox()->pack_start (label);
2131         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2132
2133         dialog.set_name (X_("PluginIODialog"));
2134         dialog.set_modal (true);
2135         dialog.show_all ();
2136
2137         dialog.run ();
2138 }
2139
2140 void
2141 ProcessorBox::rename_processors ()
2142 {
2143         ProcSelection to_be_renamed;
2144
2145         get_selected_processors (to_be_renamed);
2146
2147         if (to_be_renamed.empty()) {
2148                 return;
2149         }
2150
2151         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2152                 rename_processor (*i);
2153         }
2154 }
2155
2156 bool
2157 ProcessorBox::can_cut () const
2158 {
2159         vector<boost::shared_ptr<Processor> > sel;
2160
2161         get_selected_processors (sel);
2162
2163         /* cut_processors () does not cut inserts */
2164
2165         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2166
2167                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2168                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2169                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2170                         return true;
2171                 }
2172         }
2173
2174         return false;
2175 }
2176
2177 bool
2178 ProcessorBox::stub_processor_selected () const
2179 {
2180         vector<boost::shared_ptr<Processor> > sel;
2181
2182         get_selected_processors (sel);
2183
2184         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2185                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
2186                         return true;
2187                 }
2188         }
2189
2190         return false;
2191 }
2192
2193 void
2194 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
2195 {
2196         if (to_be_removed.empty()) {
2197                 return;
2198         }
2199
2200         XMLNode* node = new XMLNode (X_("cut"));
2201         Route::ProcessorList to_cut;
2202
2203         no_processor_redisplay = true;
2204         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
2205                 // Cut only plugins, sends and returns
2206                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2207                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2208                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2209
2210                         Window* w = get_processor_ui (*i);
2211
2212                         if (w) {
2213                                 w->hide ();
2214                         }
2215
2216                         XMLNode& child ((*i)->get_state());
2217                         node->add_child_nocopy (child);
2218                         to_cut.push_back (*i);
2219                 }
2220         }
2221
2222         if (_route->remove_processors (to_cut) != 0) {
2223                 delete node;
2224                 no_processor_redisplay = false;
2225                 return;
2226         }
2227
2228         _rr_selection.set (node);
2229
2230         no_processor_redisplay = false;
2231         redisplay_processors ();
2232 }
2233
2234 void
2235 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
2236 {
2237         if (to_be_copied.empty()) {
2238                 return;
2239         }
2240
2241         XMLNode* node = new XMLNode (X_("copy"));
2242
2243         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
2244                 // Copy only plugins, sends, returns
2245                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2246                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2247                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2248                         node->add_child_nocopy ((*i)->get_state());
2249                 }
2250         }
2251
2252         _rr_selection.set (node);
2253 }
2254
2255 void
2256 ProcessorBox::delete_processors (const ProcSelection& targets)
2257 {
2258         if (targets.empty()) {
2259                 return;
2260         }
2261
2262         no_processor_redisplay = true;
2263
2264         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
2265
2266                 Window* w = get_processor_ui (*i);
2267
2268                 if (w) {
2269                         w->hide ();
2270                 }
2271
2272                 _route->remove_processor(*i);
2273         }
2274
2275         no_processor_redisplay = false;
2276         redisplay_processors ();
2277 }
2278
2279 void
2280 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
2281 {
2282         list<boost::shared_ptr<Processor> >::const_iterator x;
2283
2284         no_processor_redisplay = true;
2285         for (x = procs.begin(); x != procs.end(); ++x) {
2286
2287                 Window* w = get_processor_ui (*x);
2288
2289                 if (w) {
2290                         w->hide ();
2291                 }
2292
2293                 _route->remove_processor(*x);
2294         }
2295
2296         no_processor_redisplay = false;
2297         redisplay_processors ();
2298 }
2299
2300 gint
2301 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
2302 {
2303         boost::shared_ptr<Processor> processor (weak_processor.lock());
2304
2305         if (!processor) {
2306                 return false;
2307         }
2308
2309         /* NOT copied to _mixer.selection() */
2310
2311         no_processor_redisplay = true;
2312         _route->remove_processor (processor);
2313         no_processor_redisplay = false;
2314         redisplay_processors ();
2315
2316         return false;
2317 }
2318
2319 void
2320 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
2321 {
2322         ArdourPrompter name_prompter (true);
2323         string result;
2324         name_prompter.set_title (_("Rename Processor"));
2325         name_prompter.set_prompt (_("New name:"));
2326         name_prompter.set_initial_text (processor->name());
2327         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
2328         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
2329         name_prompter.show_all ();
2330
2331         switch (name_prompter.run ()) {
2332
2333         case Gtk::RESPONSE_ACCEPT:
2334                 name_prompter.get_result (result);
2335                 if (result.length()) {
2336
2337                        int tries = 0;
2338                        string test = result;
2339
2340                        while (tries < 100) {
2341                                if (_session->io_name_is_legal (test)) {
2342                                        result = test;
2343                                        break;
2344                                }
2345                                tries++;
2346
2347                                test = string_compose ("%1-%2", result, tries);
2348                        }
2349
2350                        if (tries < 100) {
2351                                processor->set_name (result);
2352                        } else {
2353                                /* unlikely! */
2354                                ARDOUR_UI::instance()->popup_error
2355                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
2356                        }
2357                 }
2358                 break;
2359         }
2360
2361         return;
2362 }
2363
2364 void
2365 ProcessorBox::paste_processors ()
2366 {
2367         if (_rr_selection.processors.empty()) {
2368                 return;
2369         }
2370
2371         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
2372 }
2373
2374 void
2375 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
2376 {
2377
2378         if (_rr_selection.processors.empty()) {
2379                 return;
2380         }
2381
2382         paste_processor_state (_rr_selection.processors.get_node().children(), before);
2383 }
2384
2385 void
2386 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
2387 {
2388         XMLNodeConstIterator niter;
2389         list<boost::shared_ptr<Processor> > copies;
2390
2391         if (nlist.empty()) {
2392                 return;
2393         }
2394
2395         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2396
2397                 XMLProperty const * type = (*niter)->property ("type");
2398                 XMLProperty const * role = (*niter)->property ("role");
2399                 assert (type);
2400
2401                 boost::shared_ptr<Processor> p;
2402                 try {
2403                         if (type->value() == "meter" ||
2404                             type->value() == "main-outs" ||
2405                             type->value() == "amp" ||
2406                             type->value() == "intreturn") {
2407                                 /* do not paste meter, main outs, amp or internal returns */
2408                                 continue;
2409
2410                         } else if (type->value() == "intsend") {
2411
2412                                 /* aux sends are OK, but those used for
2413                                  * other purposes, are not.
2414                                  */
2415
2416                                 assert (role);
2417
2418                                 if (role->value() != "Aux") {
2419                                         continue;
2420                                 }
2421
2422                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2423                                 XMLNode n (**niter);
2424                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
2425                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
2426
2427                                 IOProcessor::prepare_for_reset (n, s->name());
2428
2429                                 if (s->set_state (n, Stateful::loading_state_version)) {
2430                                         delete s;
2431                                         return;
2432                                 }
2433
2434                                 p.reset (s);
2435
2436                         } else if (type->value() == "send") {
2437
2438                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2439                                 XMLNode n (**niter);
2440
2441                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
2442
2443                                 IOProcessor::prepare_for_reset (n, s->name());
2444
2445                                 if (s->set_state (n, Stateful::loading_state_version)) {
2446                                         delete s;
2447                                         return;
2448                                 }
2449
2450                                 p.reset (s);
2451
2452                         } else if (type->value() == "return") {
2453
2454                                 XMLNode n (**niter);
2455                                 Return* r = new Return (*_session);
2456
2457                                 IOProcessor::prepare_for_reset (n, r->name());
2458
2459                                 if (r->set_state (n, Stateful::loading_state_version)) {
2460                                         delete r;
2461                                         return;
2462                                 }
2463
2464                                 p.reset (r);
2465
2466                         } else if (type->value() == "port") {
2467
2468                                 XMLNode n (**niter);
2469                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
2470
2471                                 IOProcessor::prepare_for_reset (n, pi->name());
2472
2473                                 if (pi->set_state (n, Stateful::loading_state_version)) {
2474                                         return;
2475                                 }
2476
2477                                 p.reset (pi);
2478
2479                         } else {
2480                                 /* XXX its a bit limiting to assume that everything else
2481                                    is a plugin.
2482                                 */
2483                                 p.reset (new PluginInsert (*_session));
2484                                 PBD::ID id = p->id();
2485                                 p->set_state (**niter, Stateful::current_state_version);
2486                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
2487                         }
2488
2489                         copies.push_back (p);
2490                 }
2491
2492                 catch (...) {
2493                         error << _("plugin insert constructor failed") << endmsg;
2494                 }
2495         }
2496
2497         if (copies.empty()) {
2498                 return;
2499         }
2500
2501         if (_route->add_processors (copies, p)) {
2502
2503                 string msg = _(
2504                         "Copying the set of processors on the clipboard failed,\n\
2505 probably because the I/O configuration of the plugins\n\
2506 could not match the configuration of this track.");
2507                 MessageDialog am (msg);
2508                 am.run ();
2509         }
2510 }
2511
2512 void
2513 ProcessorBox::get_selected_processors (ProcSelection& processors) const
2514 {
2515         const list<ProcessorEntry*> selection = processor_display.selection ();
2516         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
2517                 processors.push_back ((*i)->processor ());
2518         }
2519 }
2520
2521 void
2522 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
2523 {
2524         list<ProcessorEntry*> selection = processor_display.selection ();
2525         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
2526                 (this->*method) ((*i)->processor ());
2527         }
2528 }
2529
2530 void
2531 ProcessorBox::all_visible_processors_active (bool state)
2532 {
2533         _route->all_visible_processors_active (state);
2534 }
2535
2536 void
2537 ProcessorBox::ab_plugins ()
2538 {
2539         _route->ab_plugins (ab_direction);
2540         ab_direction = !ab_direction;
2541 }
2542
2543
2544 void
2545 ProcessorBox::clear_processors ()
2546 {
2547         string prompt;
2548         vector<string> choices;
2549
2550         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
2551                                    "(this cannot be undone)"), _route->name());
2552
2553         choices.push_back (_("Cancel"));
2554         choices.push_back (_("Yes, remove them all"));
2555
2556         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2557
2558         if (prompter.run () == 1) {
2559                 _route->clear_processors (PreFader);
2560                 _route->clear_processors (PostFader);
2561         }
2562 }
2563
2564 void
2565 ProcessorBox::clear_processors (Placement p)
2566 {
2567         string prompt;
2568         vector<string> choices;
2569
2570         if (p == PreFader) {
2571                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
2572                                            "(this cannot be undone)"), _route->name());
2573         } else {
2574                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
2575                                            "(this cannot be undone)"), _route->name());
2576         }
2577
2578         choices.push_back (_("Cancel"));
2579         choices.push_back (_("Yes, remove them all"));
2580
2581         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2582
2583         if (prompter.run () == 1) {
2584                 _route->clear_processors (p);
2585         }
2586 }
2587
2588 bool
2589 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2590 {
2591         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2592         if (at && at->freeze_state() == AudioTrack::Frozen) {
2593                 return false;
2594         }
2595
2596         if (
2597                 boost::dynamic_pointer_cast<Send> (processor) ||
2598                 boost::dynamic_pointer_cast<Return> (processor) ||
2599                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2600                 boost::dynamic_pointer_cast<PortInsert> (processor)
2601                 ) {
2602                 return true;
2603         }
2604
2605         return false;
2606 }
2607
2608 bool
2609 ProcessorBox::one_processor_can_be_edited ()
2610 {
2611         list<ProcessorEntry*> selection = processor_display.selection ();
2612         list<ProcessorEntry*>::iterator i = selection.begin();
2613         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2614                 ++i;
2615         }
2616
2617         return (i != selection.end());
2618 }
2619
2620 Gtk::Window*
2621 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
2622 {
2623         boost::shared_ptr<Send> send;
2624         boost::shared_ptr<InternalSend> internal_send;
2625         boost::shared_ptr<Return> retrn;
2626         boost::shared_ptr<PluginInsert> plugin_insert;
2627         boost::shared_ptr<PortInsert> port_insert;
2628         Window* gidget = 0;
2629
2630         /* This method may or may not return a Window, but if it does not it
2631          * will modify the parent mixer strip appearance layout to allow
2632          * "editing" the @param processor that was passed in.
2633          *
2634          * So for example, if the processor is an Amp (gain), the parent strip
2635          * will be forced back into a model where the fader controls the main gain.
2636          * If the processor is a send, then we map the send controls onto the
2637          * strip.
2638          *
2639          * Plugins and others will return a window for control.
2640          */
2641
2642         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2643
2644                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2645                         return 0;
2646                 }
2647         }
2648
2649         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->type() == X_("amp")) {
2650
2651                 if (_parent_strip) {
2652                         _parent_strip->revert_to_default_display ();
2653                 }
2654
2655         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2656
2657                 if (!_session->engine().connected()) {
2658                         return 0;
2659                 }
2660
2661                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2662
2663                         gidget = new SendUIWindow (send, _session);
2664                 }
2665
2666         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2667
2668                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2669                         /* no GUI for these */
2670                         return 0;
2671                 }
2672
2673                 if (!_session->engine().connected()) {
2674                         return 0;
2675                 }
2676
2677                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2678
2679                 ReturnUIWindow *return_ui;
2680                 Window* w = get_processor_ui (retrn);
2681
2682                 if (w == 0) {
2683
2684                         return_ui = new ReturnUIWindow (retrn, _session);
2685                         return_ui->set_title (retrn->name ());
2686                         set_processor_ui (send, return_ui);
2687
2688                 } else {
2689                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
2690                 }
2691
2692                 gidget = return_ui;
2693
2694         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2695
2696                 PluginUIWindow *plugin_ui;
2697
2698                 /* these are both allowed to be null */
2699
2700                 Window* w = get_processor_ui (plugin_insert);
2701
2702                 if (w == 0) {
2703                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
2704                         plugin_ui->set_title (generate_processor_title (plugin_insert));
2705                         set_processor_ui (plugin_insert, plugin_ui);
2706
2707                 } else {
2708                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2709                 }
2710
2711                 gidget = plugin_ui;
2712
2713         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2714
2715                 if (!_session->engine().connected()) {
2716                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
2717                         msg.run ();
2718                         return 0;
2719                 }
2720
2721                 PortInsertWindow *io_selector;
2722
2723                 Window* w = get_processor_ui (port_insert);
2724
2725                 if (w == 0) {
2726                         io_selector = new PortInsertWindow (_session, port_insert);
2727                         set_processor_ui (port_insert, io_selector);
2728
2729                 } else {
2730                         io_selector = dynamic_cast<PortInsertWindow *> (w);
2731                 }
2732
2733                 gidget = io_selector;
2734         }
2735
2736         return gidget;
2737 }
2738
2739 Gtk::Window*
2740 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
2741 {
2742         boost::shared_ptr<PluginInsert> plugin_insert
2743                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2744
2745         if (!plugin_insert) {
2746                 return 0;
2747         }
2748
2749         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
2750         win->set_title (generate_processor_title (plugin_insert));
2751
2752         return win;
2753 }
2754
2755 void
2756 ProcessorBox::register_actions ()
2757 {
2758         Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = Gtk::ActionGroup::create(X_("ProcessorMenu"));
2759         Glib::RefPtr<Action> act;
2760
2761         /* new stuff */
2762         ActionManager::register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2763                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2764
2765         act = ActionManager::register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2766                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2767         ActionManager::engine_sensitive_actions.push_back (act);
2768         act = ActionManager::register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2769                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
2770         ActionManager::engine_sensitive_actions.push_back (act);
2771
2772         ActionManager::register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2773
2774         ActionManager::register_action (popup_act_grp, X_("controls"), _("Controls"));
2775         ActionManager::register_action (popup_act_grp, X_("send_options"), _("Send Options"));
2776
2777         ActionManager::register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2778                         sigc::ptr_fun (ProcessorBox::rb_clear));
2779         ActionManager::register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2780                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2781         ActionManager::register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2782                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
2783
2784         /* standard editing stuff */
2785         cut_action = ActionManager::register_action (popup_act_grp, X_("cut"), _("Cut"),
2786                                                      sigc::ptr_fun (ProcessorBox::rb_cut));
2787         copy_action = ActionManager::register_action (popup_act_grp, X_("copy"), _("Copy"),
2788                         sigc::ptr_fun (ProcessorBox::rb_copy));
2789         delete_action = ActionManager::register_action (popup_act_grp, X_("delete"), _("Delete"),
2790                         sigc::ptr_fun (ProcessorBox::rb_delete));
2791
2792         paste_action = ActionManager::register_action (popup_act_grp, X_("paste"), _("Paste"),
2793                         sigc::ptr_fun (ProcessorBox::rb_paste));
2794         rename_action = ActionManager::register_action (popup_act_grp, X_("rename"), _("Rename"),
2795                         sigc::ptr_fun (ProcessorBox::rb_rename));
2796         ActionManager::register_action (popup_act_grp, X_("selectall"), _("Select All"),
2797                         sigc::ptr_fun (ProcessorBox::rb_select_all));
2798         ActionManager::register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2799                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2800
2801         /* activation etc. */
2802
2803         ActionManager::register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2804                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
2805         ActionManager::register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2806                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2807         ActionManager::register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2808                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2809
2810         /* show editors */
2811         edit_action = ActionManager::register_action (
2812                 popup_act_grp, X_("edit"), _("Edit..."),
2813                 sigc::ptr_fun (ProcessorBox::rb_edit));
2814
2815         edit_generic_action = ActionManager::register_action (
2816                 popup_act_grp, X_("edit-generic"), _("Edit with generic controls..."),
2817                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2818
2819         ActionManager::add_action_group (popup_act_grp);
2820 }
2821
2822 void
2823 ProcessorBox::rb_edit_generic ()
2824 {
2825         if (_current_processor_box == 0) {
2826                 return;
2827         }
2828
2829         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
2830 }
2831
2832 void
2833 ProcessorBox::rb_ab_plugins ()
2834 {
2835         if (_current_processor_box == 0) {
2836                 return;
2837         }
2838
2839         _current_processor_box->ab_plugins ();
2840 }
2841
2842 void
2843 ProcessorBox::rb_choose_plugin ()
2844 {
2845         if (_current_processor_box == 0) {
2846                 return;
2847         }
2848         _current_processor_box->choose_plugin ();
2849 }
2850
2851 void
2852 ProcessorBox::rb_choose_insert ()
2853 {
2854         if (_current_processor_box == 0) {
2855                 return;
2856         }
2857         _current_processor_box->choose_insert ();
2858 }
2859
2860 void
2861 ProcessorBox::rb_choose_send ()
2862 {
2863         if (_current_processor_box == 0) {
2864                 return;
2865         }
2866         _current_processor_box->choose_send ();
2867 }
2868
2869 void
2870 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
2871 {
2872         if (_current_processor_box == 0) {
2873                 return;
2874         }
2875
2876         _current_processor_box->choose_aux (wr);
2877 }
2878
2879 void
2880 ProcessorBox::rb_clear ()
2881 {
2882         if (_current_processor_box == 0) {
2883                 return;
2884         }
2885
2886         _current_processor_box->clear_processors ();
2887 }
2888
2889
2890 void
2891 ProcessorBox::rb_clear_pre ()
2892 {
2893         if (_current_processor_box == 0) {
2894                 return;
2895         }
2896
2897         _current_processor_box->clear_processors (PreFader);
2898 }
2899
2900
2901 void
2902 ProcessorBox::rb_clear_post ()
2903 {
2904         if (_current_processor_box == 0) {
2905                 return;
2906         }
2907
2908         _current_processor_box->clear_processors (PostFader);
2909 }
2910
2911 void
2912 ProcessorBox::rb_cut ()
2913 {
2914         if (_current_processor_box == 0) {
2915                 return;
2916         }
2917
2918         _current_processor_box->processor_operation (ProcessorsCut);
2919 }
2920
2921 void
2922 ProcessorBox::rb_delete ()
2923 {
2924         if (_current_processor_box == 0) {
2925                 return;
2926         }
2927
2928         _current_processor_box->processor_operation (ProcessorsDelete);
2929 }
2930
2931 void
2932 ProcessorBox::rb_copy ()
2933 {
2934         if (_current_processor_box == 0) {
2935                 return;
2936         }
2937         _current_processor_box->processor_operation (ProcessorsCopy);
2938 }
2939
2940 void
2941 ProcessorBox::rb_paste ()
2942 {
2943         if (_current_processor_box == 0) {
2944                 return;
2945         }
2946
2947         _current_processor_box->processor_operation (ProcessorsPaste);
2948 }
2949
2950 void
2951 ProcessorBox::rb_rename ()
2952 {
2953         if (_current_processor_box == 0) {
2954                 return;
2955         }
2956         _current_processor_box->rename_processors ();
2957 }
2958
2959 void
2960 ProcessorBox::rb_select_all ()
2961 {
2962         if (_current_processor_box == 0) {
2963                 return;
2964         }
2965
2966         _current_processor_box->processor_operation (ProcessorsSelectAll);
2967 }
2968
2969 void
2970 ProcessorBox::rb_deselect_all ()
2971 {
2972         if (_current_processor_box == 0) {
2973                 return;
2974         }
2975
2976         _current_processor_box->deselect_all_processors ();
2977 }
2978
2979 void
2980 ProcessorBox::rb_activate_all ()
2981 {
2982         if (_current_processor_box == 0) {
2983                 return;
2984         }
2985
2986         _current_processor_box->all_visible_processors_active (true);
2987 }
2988
2989 void
2990 ProcessorBox::rb_deactivate_all ()
2991 {
2992         if (_current_processor_box == 0) {
2993                 return;
2994         }
2995         _current_processor_box->all_visible_processors_active (false);
2996 }
2997
2998 void
2999 ProcessorBox::rb_edit ()
3000 {
3001         if (_current_processor_box == 0) {
3002                 return;
3003         }
3004
3005         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3006 }
3007
3008 bool
3009 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3010 {
3011         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3012                 return false;
3013         }
3014
3015         if (_parent_strip) {
3016                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3017                 if (_parent_strip->current_delivery() == send) {
3018                         _parent_strip->revert_to_default_display ();
3019                 } else {
3020                         _parent_strip->show_send(send);
3021                 }
3022         }
3023         return true;
3024 }
3025
3026 void
3027 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3028 {
3029         if (!processor) {
3030                 return;
3031         }
3032         if (edit_aux_send (processor)) {
3033                 return;
3034         }
3035
3036         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3037
3038         if (proxy) {
3039                 proxy->set_custom_ui_mode (true);
3040                 proxy->toggle ();
3041         }
3042 }
3043
3044 void
3045 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3046 {
3047         if (!processor) {
3048                 return;
3049         }
3050         if (edit_aux_send (processor)) {
3051                 return;
3052         }
3053
3054         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3055
3056         if (proxy) {
3057                 proxy->set_custom_ui_mode (false);
3058                 proxy->toggle ();
3059         }
3060 }
3061
3062 void
3063 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3064 {
3065         if (!what_changed.contains (ARDOUR::Properties::name)) {
3066                 return;
3067         }
3068
3069         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3070
3071         boost::shared_ptr<Processor> processor;
3072         boost::shared_ptr<PluginInsert> plugin_insert;
3073         boost::shared_ptr<Send> send;
3074
3075         list<ProcessorEntry*> children = processor_display.children();
3076
3077         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3078
3079                 processor = (*iter)->processor ();
3080
3081                 if (!processor) {
3082                         continue;
3083                 }
3084
3085                 Window* w = get_processor_ui (processor);
3086
3087                 if (!w) {
3088                         continue;
3089                 }
3090
3091                 /* rename editor windows for sends and plugins */
3092
3093                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3094                         w->set_title (send->name ());
3095                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3096                         w->set_title (generate_processor_title (plugin_insert));
3097                 }
3098         }
3099 }
3100
3101 string
3102 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3103 {
3104         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3105         string::size_type email_pos;
3106
3107         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3108                 maker = maker.substr (0, email_pos - 1);
3109         }
3110
3111         if (maker.length() > 32) {
3112                 maker = maker.substr (0, 32);
3113                 maker += " ...";
3114         }
3115
3116         SessionObject* owner = pi->owner();
3117
3118         if (owner) {
3119                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
3120         } else {
3121                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
3122         }
3123 }
3124
3125 /** @param p Processor.
3126  *  @return the UI window for \a p.
3127  */
3128 Window *
3129 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
3130 {
3131         ProcessorWindowProxy* wp = p->window_proxy();
3132         if (wp) {
3133                 return wp->get ();
3134         }
3135         return 0;
3136 }
3137
3138 /** Make a note of the UI window that a processor is using.
3139  *  @param p Processor.
3140  *  @param w UI window.
3141  */
3142 void
3143 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
3144 {
3145         assert (p->window_proxy());
3146         p->set_ui (w);
3147         p->window_proxy()->use_window (*w);
3148 }
3149
3150 void
3151 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
3152 {
3153         boost::shared_ptr<Delivery> d = w.lock ();
3154         if (!d) {
3155                 return;
3156         }
3157
3158         list<ProcessorEntry*> children = processor_display.children ();
3159         list<ProcessorEntry*>::const_iterator i = children.begin();
3160         while (i != children.end() && (*i)->processor() != d) {
3161                 ++i;
3162         }
3163
3164         if (i == children.end()) {
3165                 processor_display.set_active (0);
3166         } else {
3167                 processor_display.set_active (*i);
3168         }
3169 }
3170
3171 /** Called to repair the damage of Editor::show_window doing a show_all() */
3172 void
3173 ProcessorBox::hide_things ()
3174 {
3175         list<ProcessorEntry*> c = processor_display.children ();
3176         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
3177                 (*i)->hide_things ();
3178         }
3179 }
3180
3181 void
3182 ProcessorBox::processor_menu_unmapped ()
3183 {
3184         processor_display.remove_placeholder ();
3185 }
3186
3187 XMLNode *
3188 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
3189 {
3190         if (!_parent_strip) {
3191                 return 0;
3192         }
3193
3194         GUIObjectState& st = _parent_strip->gui_object_state ();
3195
3196         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
3197         assert (strip);
3198         return st.get_or_add_node (strip, entry->state_id());
3199 }
3200
3201 void
3202 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
3203 {
3204         XMLNode* proc = entry_gui_object_state (entry);
3205         if (!proc) {
3206                 return;
3207         }
3208
3209         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
3210         proc->remove_nodes_and_delete (X_("Object"));
3211         entry->add_control_state (proc);
3212 }
3213
3214 bool
3215 ProcessorBox::is_editor_mixer_strip() const
3216 {
3217         return _parent_strip && !_parent_strip->mixer_owned();
3218 }
3219
3220 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
3221         : WM::ProxyBase (name, string())
3222         , _processor_box (box)
3223         , _processor (processor)
3224         , is_custom (false)
3225         , want_custom (false)
3226 {
3227         boost::shared_ptr<Processor> p = _processor.lock ();
3228         if (!p) {
3229                 return;
3230         }
3231         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
3232 }
3233
3234 ProcessorWindowProxy::~ProcessorWindowProxy()
3235 {
3236         /* processor window proxies do not own the windows they create with
3237          * ::get(), so set _window to null before the normal WindowProxy method
3238          * deletes it.
3239          */
3240         _window = 0;
3241 }
3242
3243 void
3244 ProcessorWindowProxy::processor_going_away ()
3245 {
3246         delete _window;
3247         _window = 0;
3248         WM::Manager::instance().remove (this);
3249         /* should be no real reason to do this, since the object that would
3250            send DropReferences is about to be deleted, but lets do it anyway.
3251         */
3252         going_away_connection.disconnect();
3253 }
3254
3255 ARDOUR::SessionHandlePtr*
3256 ProcessorWindowProxy::session_handle()
3257 {
3258         /* we don't care */
3259         return 0;
3260 }
3261
3262 XMLNode&
3263 ProcessorWindowProxy::get_state () const
3264 {
3265         XMLNode *node;
3266         node = &ProxyBase::get_state();
3267         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
3268         return *node;
3269 }
3270
3271 void
3272 ProcessorWindowProxy::set_state (const XMLNode& node)
3273 {
3274         XMLNodeList children = node.children ();
3275         XMLNodeList::const_iterator i = children.begin ();
3276         while (i != children.end()) {
3277                 XMLProperty* prop = (*i)->property (X_("name"));
3278                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
3279                         break;
3280                 }
3281                 ++i;
3282         }
3283
3284         if (i != children.end()) {
3285                 XMLProperty* prop;
3286                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
3287                         want_custom = PBD::string_is_affirmative (prop->value ());
3288                 }
3289         }
3290
3291         ProxyBase::set_state(node);
3292 }
3293
3294 Gtk::Window*
3295 ProcessorWindowProxy::get (bool create)
3296 {
3297         boost::shared_ptr<Processor> p = _processor.lock ();
3298
3299         if (!p) {
3300                 return 0;
3301         }
3302         if (_window && (is_custom != want_custom)) {
3303                 /* drop existing window - wrong type */
3304                 drop_window ();
3305         }
3306
3307         if (!_window) {
3308                 if (!create) {
3309                         return 0;
3310                 }
3311
3312                 is_custom = want_custom;
3313                 _window = _processor_box->get_editor_window (p, is_custom);
3314
3315                 if (_window) {
3316                         setup ();
3317                 }
3318         }
3319
3320         return _window;
3321 }
3322
3323 void
3324 ProcessorWindowProxy::toggle ()
3325 {
3326         if (_window && (is_custom != want_custom)) {
3327                 /* drop existing window - wrong type */
3328                 drop_window ();
3329         }
3330         is_custom = want_custom;
3331
3332         WM::ProxyBase::toggle ();
3333 }