gtk2_ardour/processor_box.cc

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