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