gtk2_ardour/processor_box.cc

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