gtk2_ardour/processor_box.cc

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