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 "LuaBridge/LuaBridge.h"
  65
  66 #include "actions.h"
  67 #include "ardour_dialog.h"
  68 #include "ardour_ui.h"
  69 #include "gui_thread.h"
  70 #include "io_selector.h"
  71 #include "keyboard.h"
  72 #include "luainstance.h"
  73 #include "mixer_ui.h"
  74 #include "mixer_strip.h"
  75 #include "plugin_pin_dialog.h"
  76 #include "plugin_selector.h"
  77 #include "plugin_ui.h"
  78 #include "port_insert_ui.h"
  79 #include "processor_box.h"
  80 #include "public_editor.h"
  81 #include "return_ui.h"
  82 #include "route_processor_selection.h"
  83 #include "script_selector.h"
  84 #include "send_ui.h"
  85 #include "timers.h"
  86 #include "tooltips.h"
  87 #include "new_plugin_preset_dialog.h"
  88
  89 #include "pbd/i18n.h"
  90
  91 #ifdef AUDIOUNIT_SUPPORT
  92 class AUPluginUI;
  93 #endif
  94
  95 #ifndef NDEBUG
  96 bool ProcessorBox::show_all_processors = false;
  97 #endif
  98
  99 using namespace std;
 100 using namespace ARDOUR;
 101 using namespace PBD;
 102 using namespace Gtk;
 103 using namespace Glib;
 104 using namespace Gtkmm2ext;
 105
 106 ProcessorBox*  ProcessorBox::_current_processor_box = 0;
 107 RefPtr<Action> ProcessorBox::paste_action;
 108 RefPtr<Action> ProcessorBox::cut_action;
 109 RefPtr<Action> ProcessorBox::copy_action;
 110 RefPtr<Action> ProcessorBox::rename_action;
 111 RefPtr<Action> ProcessorBox::delete_action;
 112 RefPtr<Action> ProcessorBox::backspace_action;
 113 RefPtr<Action> ProcessorBox::manage_pins_action;
 114 RefPtr<Action> ProcessorBox::edit_action;
 115 RefPtr<Action> ProcessorBox::edit_generic_action;
 116 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
 117 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
 118 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
 119
 120
 121 // TODO consolidate with PluginPinDialog::set_color
 122 static void set_routing_color (cairo_t* cr, bool midi)
 123 {
 124         static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
 125         static const uint32_t midi_port_color = 0x960909FF; //Red
 126
 127         if (midi) {
 128                 cairo_set_source_rgb (cr,
 129                                 UINT_RGBA_R_FLT(midi_port_color),
 130                                 UINT_RGBA_G_FLT(midi_port_color),
 131                                 UINT_RGBA_B_FLT(midi_port_color));
 132         } else {
 133                 cairo_set_source_rgb (cr,
 134                                 UINT_RGBA_R_FLT(audio_port_color),
 135                                 UINT_RGBA_G_FLT(audio_port_color),
 136                                 UINT_RGBA_B_FLT(audio_port_color));
 137         }
 138 }
 139
 140 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
 141         : _button (ArdourButton::led_default_elements)
 142         , _position (PreFader)
 143         , _position_num(0)
 144         , _parent (parent)
 145         , _selectable(true)
 146         , _unknown_processor(false)
 147         , _processor (p)
 148         , _width (w)
 149         , input_icon(true)
 150         , output_icon(false)
 151         , routing_icon(true)
 152         , output_routing_icon(false)
 153         , _plugin_display(0)
 154 {
 155         _vbox.show ();
 156
 157         _button.set_distinct_led_click (true);
 158         _button.set_fallthrough_to_parent(true);
 159         _button.set_led_left (true);
 160         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
 161         _button.set_text (name (_width));
 162
 163         if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
 164                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
 165         }
 166         if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
 167                 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
 168                 _unknown_processor = true;
 169         }
 170         {
 171                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 172                 if (pi && pi->plugin()) {
 173                         _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
 174                 }
 175         }
 176         if (_processor) {
 177
 178                 _vbox.pack_start (routing_icon);
 179                 _vbox.pack_start (input_icon);
 180                 _vbox.pack_start (_button, true, true);
 181
 182                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 183                 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
 184                         if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
 185                                 _plugin_display = new PluginDisplay (*this, pi->plugin(),
 186                                                 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
 187                         } else {
 188                                 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
 189                                 _plugin_display = new LuaPluginDisplay (*this, boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
 190                                                 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
 191                         }
 192                         _vbox.pack_start (*_plugin_display);
 193                         _plugin_display->set_no_show_all (true);
 194                         if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
 195                                 _plugin_display->show ();
 196                         }
 197                 }
 198                 _vbox.pack_end (output_routing_icon);
 199                 _vbox.pack_end (output_icon);
 200
 201                 _button.set_active (_processor->enabled ());
 202
 203                 input_icon.set_no_show_all(true);
 204                 routing_icon.set_no_show_all(true);
 205                 output_icon.set_no_show_all(true);
 206                 output_routing_icon.set_no_show_all(true);
 207
 208                 _button.show ();
 209                 input_icon.hide();
 210                 output_icon.show();
 211                 routing_icon.hide();
 212                 output_routing_icon.hide();
 213
 214                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
 215                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
 216                 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
 217
 218                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
 219                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
 220
 221                         std::string label = _processor->describe_parameter (*i);
 222
 223                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
 224                                 label = _("Send");
 225                         } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
 226                                 label = _("Return");
 227                         }
 228
 229                         Control* c = new Control (_processor->automation_control (*i), label);
 230
 231                         _controls.push_back (c);
 232
 233                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
 234                                 /* Add non-Amp (Fader & Trim) controls to the processor box */
 235                                 _vbox.pack_start (c->box);
 236                         }
 237                 }
 238
 239                 setup_tooltip ();
 240                 setup_visuals ();
 241         } else {
 242                 _vbox.set_size_request (-1, _button.size_request().height);
 243         }
 244 }
 245
 246 ProcessorEntry::~ProcessorEntry ()
 247 {
 248         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 249                 delete *i;
 250         }
 251         delete _plugin_display;
 252 }
 253
 254 EventBox&
 255 ProcessorEntry::action_widget ()
 256 {
 257         return _button;
 258 }
 259
 260 Gtk::Widget&
 261 ProcessorEntry::widget ()
 262 {
 263         return _vbox;
 264 }
 265
 266 string
 267 ProcessorEntry::drag_text () const
 268 {
 269         return name (Wide);
 270 }
 271
 272 bool
 273 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
 274 {
 275         ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
 276         if (!other) {
 277                 return false;
 278         }
 279         boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
 280         boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 281         boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
 282         if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
 283                 return false;
 284         }
 285         if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
 286                 return false;
 287         }
 288         if (!my_pi || !ot_pi) {
 289                 return false;
 290         }
 291         if (my_pi->type() != ot_pi->type()) {
 292                 return false;
 293         }
 294         boost::shared_ptr<Plugin> my_p = my_pi->plugin();
 295         boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
 296         if (!my_p || !ot_p) {
 297                 return false;
 298         }
 299         if (my_p->unique_id() != ot_p->unique_id()) {
 300                 return false;
 301         }
 302         return true;
 303 }
 304
 305 bool
 306 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
 307 {
 308         if (data.get_target() == "PluginPresetPtr") {
 309                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 310
 311                 if (!_plugin_preset_pointer || !pi) {
 312                         data.set (data.get_target(), 8, NULL, 0);
 313                         return true;
 314                 }
 315
 316                 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
 317                 assert (plugin);
 318
 319                 PluginManager& manager (PluginManager::instance());
 320                 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
 321
 322                 NewPluginPresetDialog d (plugin,
 323                                 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
 324
 325                 _plugin_preset_pointer->_preset.valid = false;
 326
 327                 switch (d.run ()) {
 328                         case Gtk::RESPONSE_CANCEL:
 329                                 data.set (data.get_target(), 8, NULL, 0);
 330                                 return true;
 331                                 break;
 332
 333                         case Gtk::RESPONSE_NO:
 334                                 break;
 335
 336                         case Gtk::RESPONSE_ACCEPT:
 337                                 if (d.name().empty()) {
 338                                         break;
 339                                 }
 340
 341                                 if (d.replace ()) {
 342                                         plugin->remove_preset (d.name ());
 343                                 }
 344
 345                                 Plugin::PresetRecord const r = plugin->save_preset (d.name());
 346
 347                                 if (!r.uri.empty ()) {
 348                                         _plugin_preset_pointer->_preset.uri   = r.uri;
 349                                         _plugin_preset_pointer->_preset.label = r.label;
 350                                         _plugin_preset_pointer->_preset.user  = r.user;
 351                                         _plugin_preset_pointer->_preset.valid = r.valid;
 352                                 }
 353                 }
 354                 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
 355                 return true;
 356         }
 357         return false;
 358 }
 359
 360 void
 361 ProcessorEntry::set_position (Position p, uint32_t num)
 362 {
 363         _position = p;
 364         _position_num = num;
 365         setup_visuals ();
 366 }
 367
 368 void
 369 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
 370 {
 371         if (yn) {
 372                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
 373         } else {
 374                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
 375         }
 376 }
 377
 378 void
 379 ProcessorEntry::setup_visuals ()
 380 {
 381         if (_unknown_processor) {
 382                 _button.set_name ("processor stub");
 383                 return;
 384         }
 385         boost::shared_ptr<Send> send;
 386         if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
 387                 if (send->remove_on_disconnect ()) {
 388                         _button.set_name ("processor sidechain");
 389                         return;
 390                 }
 391         }
 392
 393         boost::shared_ptr<InternalSend> aux;
 394         if ((aux = boost::dynamic_pointer_cast<InternalSend> (_processor))) {
 395                 if (aux->allow_feedback ()) {
 396                         _button.set_name ("processor auxfeedback");
 397                         return;
 398                 }
 399         }
 400
 401         switch (_position) {
 402         case PreFader:
 403                 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
 404                 _button.set_name ("processor prefader");
 405                 break;
 406
 407         case Fader:
 408                 _button.set_name ("processor fader");
 409                 break;
 410
 411         case PostFader:
 412                 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
 413                 _button.set_name ("processor postfader");
 414                 break;
 415         }
 416 }
 417
 418
 419 boost::shared_ptr<Processor>
 420 ProcessorEntry::processor () const
 421 {
 422         if (!_processor) {
 423                 return boost::shared_ptr<Processor>();
 424         }
 425         return _processor;
 426 }
 427
 428 void
 429 ProcessorEntry::set_enum_width (Width w)
 430 {
 431         _width = w;
 432         _button.set_text (name (_width));
 433 }
 434
 435 void
 436 ProcessorEntry::led_clicked(GdkEventButton *ev)
 437 {
 438         bool ctrl_shift_pressed = false;
 439         Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
 440
 441         if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
 442                 ctrl_shift_pressed = true;
 443         }
 444
 445         if (_processor) {
 446                 if (_button.get_active ()) {
 447                         if (ctrl_shift_pressed) {
 448                                 _parent->all_visible_processors_active(false);
 449
 450                                 if (_position == Fader) {
 451                                         _processor->enable (false);
 452                                 }
 453                         }
 454                         else {
 455                                 _processor->enable (false);
 456                         }
 457
 458                 } else {
 459                         if (ctrl_shift_pressed) {
 460                                 _parent->all_visible_processors_active(true);
 461
 462                                 if (_position == Fader) {
 463                                         _processor->enable (true);
 464                                 }
 465                         }
 466                         else {
 467                                 _processor->enable (true);
 468                         }
 469                 }
 470         }
 471 }
 472
 473 void
 474 ProcessorEntry::processor_active_changed ()
 475 {
 476         if (_processor) {
 477                 _button.set_active (_processor->enabled ());
 478         }
 479 }
 480
 481 void
 482 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
 483 {
 484         if (what_changed.contains (ARDOUR::Properties::name)) {
 485                 _button.set_text (name (_width));
 486                 setup_tooltip ();
 487         }
 488 }
 489
 490 void
 491 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
 492 {
 493         _parent->setup_routing_feeds ();
 494         input_icon.queue_draw();
 495         output_icon.queue_draw();
 496         routing_icon.queue_draw();
 497         output_routing_icon.queue_draw();
 498 }
 499
 500 void
 501 ProcessorEntry::setup_tooltip ()
 502 {
 503         if (_processor) {
 504                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
 505                 if (pi) {
 506                         std::string postfix = "";
 507                         uint32_t replicated;
 508                         if ((replicated = pi->get_count()) > 1) {
 509                                 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
 510                         }
 511                         if (pi->plugin()->has_editor()) {
 512                                 ARDOUR_UI_UTILS::set_tooltip (_button,
 513                                                 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::secondary_modifier_name (), postfix));
 514                         } else {
 515                                 ARDOUR_UI_UTILS::set_tooltip (_button,
 516                                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
 517                         }
 518                         return;
 519                 }
 520                 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
 521                         ARDOUR_UI::instance()->set_tip (_button,
 522                                         string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
 523                         return;
 524                 }
 525                 boost::shared_ptr<Send> send;
 526                 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
 527                                 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
 528                         if (send->remove_on_disconnect ()) {
 529                                 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>&gt; %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
 530                         } else {
 531                                 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>&gt; %1</b>", _processor->name()));
 532                         }
 533                         return;
 534                 }
 535         }
 536         ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
 537 }
 538
 539 string
 540 ProcessorEntry::name (Width w) const
 541 {
 542         boost::shared_ptr<Send> send;
 543         string name_display;
 544
 545         if (!_processor) {
 546                 return string();
 547         }
 548
 549         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
 550             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
 551
 552                 name_display += '>';
 553                 std::string send_name;
 554                 bool pretty_ok = true;
 555
 556                 if (send->remove_on_disconnect ()) {
 557                         // assume it's a sidechain, find pretty name of connected port(s)
 558                         PortSet& ps (send->output ()->ports ());
 559                         for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
 560                                 vector<string> connections;
 561                                 if (i->get_connections (connections)) {
 562                                         vector<string>::const_iterator ci;
 563                                         for (ci = connections.begin(); ci != connections.end(); ++ci) {
 564                                                 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
 565                                                 if (pn.empty ()) {
 566                                                         continue;
 567                                                 }
 568                                                 if (send_name.empty ()) {
 569                                                         send_name = pn;
 570                                                 } else if (send_name != pn) {
 571                                                         // pretty names don't match
 572                                                         pretty_ok = false;
 573                                                         break;
 574                                                 }
 575                                         }
 576                                 }
 577                         }
 578                 }
 579
 580                 if (!pretty_ok) {
 581                         send_name = "";
 582                 }
 583
 584                 /* grab the send name out of its overall name */
 585                 if (send_name.empty()) {
 586                         send_name = send->name();
 587                         string::size_type lbracket, rbracket;
 588                         lbracket = send_name.find ('[');
 589                         rbracket = send_name.find (']');
 590                         send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
 591                 }
 592
 593                 switch (w) {
 594                 case Wide:
 595                         name_display += send_name;
 596                         break;
 597                 case Narrow:
 598                         name_display += PBD::short_version (send_name, 5);
 599                         break;
 600                 }
 601
 602         } else {
 603                 boost::shared_ptr<ARDOUR::PluginInsert> pi;
 604                 uint32_t replicated;
 605                 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
 606                                 && (replicated = pi->get_count()) > 1)
 607                 {
 608                         name_display += string_compose(_("(%1x1) "), replicated);
 609                 }
 610
 611                 switch (w) {
 612                 case Wide:
 613                         name_display += _processor->display_name();
 614                         break;
 615                 case Narrow:
 616                         name_display += PBD::short_version (_processor->display_name(), 5);
 617                         break;
 618                 }
 619
 620         }
 621
 622         return name_display;
 623 }
 624
 625 void
 626 ProcessorEntry::show_all_controls ()
 627 {
 628         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 629                 (*i)->set_visible (true);
 630         }
 631
 632         _parent->update_gui_object_state (this);
 633 }
 634
 635 void
 636 ProcessorEntry::hide_all_controls ()
 637 {
 638         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 639                 (*i)->set_visible (false);
 640         }
 641
 642         _parent->update_gui_object_state (this);
 643 }
 644
 645 void
 646 ProcessorEntry::add_control_state (XMLNode* node) const
 647 {
 648         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 649                 (*i)->add_state (node);
 650         }
 651
 652         if (_plugin_display) {
 653                 XMLNode* c = new XMLNode (X_("Object"));
 654                 c->add_property (X_("id"), X_("InlineDisplay"));
 655                 c->add_property (X_("visible"), _plugin_display->is_visible ());
 656                 node->add_child_nocopy (*c);
 657         }
 658 }
 659
 660 void
 661 ProcessorEntry::set_control_state (XMLNode const * node)
 662 {
 663         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 664                 (*i)->set_state (node);
 665         }
 666
 667         if (_plugin_display) {
 668                 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
 669                 XMLProperty const * p = n ? n->property (X_("visible")) : NULL;
 670                 if (p) {
 671                         if (string_is_affirmative (p->value ())) {
 672                                 _plugin_display->show();
 673                         } else {
 674                                 _plugin_display->hide();
 675                         }
 676                 }
 677         }
 678 }
 679
 680 string
 681 ProcessorEntry::state_id () const
 682 {
 683         return string_compose ("processor %1", _processor->id().to_s());
 684 }
 685
 686 void
 687 ProcessorEntry::hide_things ()
 688 {
 689         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 690                 (*i)->hide_things ();
 691         }
 692 }
 693
 694
 695 Menu *
 696 ProcessorEntry::build_controls_menu ()
 697 {
 698         using namespace Menu_Helpers;
 699         Menu* menu = manage (new Menu);
 700         MenuList& items = menu->items ();
 701
 702         if (_plugin_display) {
 703                 items.push_back (CheckMenuElem (_("Inline Display")));
 704                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 705                 c->set_active (_plugin_display->is_visible ());
 706                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
 707                 items.push_back (SeparatorElem ());
 708         }
 709
 710         items.push_back (
 711                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
 712                 );
 713
 714         items.push_back (
 715                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
 716                 );
 717
 718         if (!_controls.empty ()) {
 719                 items.push_back (SeparatorElem ());
 720         }
 721
 722         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 723                 items.push_back (CheckMenuElem ((*i)->name ()));
 724                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 725                 c->set_active ((*i)->visible ());
 726                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
 727         }
 728
 729         return menu;
 730 }
 731
 732 void
 733 ProcessorEntry::toggle_inline_display_visibility ()
 734 {
 735         if (_plugin_display->is_visible ()) {
 736                 _plugin_display->hide();
 737         } else {
 738                 _plugin_display->show();
 739         }
 740         _parent->update_gui_object_state (this);
 741 }
 742
 743 void
 744 ProcessorEntry::toggle_control_visibility (Control* c)
 745 {
 746         c->set_visible (!c->visible ());
 747         _parent->update_gui_object_state (this);
 748 }
 749
 750 Menu *
 751 ProcessorEntry::build_send_options_menu ()
 752 {
 753         using namespace Menu_Helpers;
 754         Menu* menu = manage (new Menu);
 755         MenuList& items = menu->items ();
 756
 757         if (!ARDOUR::Profile->get_mixbus()) {
 758                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
 759                 if (send) {
 760                         items.push_back (CheckMenuElem (_("Link panner controls")));
 761                         Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 762                         c->set_active (send->panner_shell()->is_linked_to_route());
 763                         c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
 764                 }
 765         }
 766
 767         boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
 768         if (aux) {
 769                 items.push_back (CheckMenuElem (_("Allow Feedback Loop")));
 770                 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
 771                 c->set_active (aux->allow_feedback());
 772                 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_allow_feedback));
 773         }
 774         return menu;
 775 }
 776
 777 void
 778 ProcessorEntry::toggle_panner_link ()
 779 {
 780         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
 781         if (send) {
 782                 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
 783         }
 784 }
 785
 786 void
 787 ProcessorEntry::toggle_allow_feedback ()
 788 {
 789         boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
 790         if (aux) {
 791                 aux->set_allow_feedback (!aux->allow_feedback ());
 792         }
 793 }
 794
 795 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
 796         : _control (c)
 797         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
 798         , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
 799         , _slider_persistant_tooltip (&_slider)
 800         , _button (ArdourButton::led_default_elements)
 801         , _ignore_ui_adjustment (false)
 802         , _visible (false)
 803         , _name (n)
 804 {
 805         _slider.set_controllable (c);
 806         box.set_padding(0, 0, 4, 4);
 807
 808         if (c->toggled()) {
 809                 _button.set_text (_name);
 810                 _button.set_led_left (true);
 811                 _button.set_name ("processor control button");
 812                 box.add (_button);
 813                 _button.show ();
 814
 815                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
 816                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
 817                 // dup. currently timers are used :(
 818                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 819
 820         } else {
 821
 822                 _slider.set_name ("ProcessorControlSlider");
 823                 _slider.set_text (_name);
 824
 825                 box.add (_slider);
 826                 _slider.show ();
 827
 828                 const ARDOUR::ParameterDescriptor& desc = c->desc();
 829                 double const lo = c->internal_to_interface(desc.lower);
 830                 double const up = c->internal_to_interface(desc.upper);
 831                 double const normal = c->internal_to_interface(desc.normal);
 832                 double smallstep = desc.smallstep;
 833                 double largestep = desc.largestep;
 834
 835                 if (smallstep == 0.0) {
 836                         smallstep = up / 1000.;
 837                 } else {
 838                         smallstep = c->internal_to_interface(desc.lower + smallstep);
 839                 }
 840
 841                 if (largestep == 0.0) {
 842                         largestep = up / 40.;
 843                 } else {
 844                         largestep = c->internal_to_interface(desc.lower + largestep);
 845                 }
 846
 847                 _adjustment.set_lower (lo);
 848                 _adjustment.set_upper (up);
 849                 _adjustment.set_step_increment (smallstep);
 850                 _adjustment.set_page_increment (largestep);
 851                 _slider.set_default_value (normal);
 852
 853                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
 854                 // dup. currently timers are used :(
 855                 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 856         }
 857
 858         // yuck, do we really need to do this?
 859         // according to c404374 this is only needed for send automation
 860         timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
 861
 862         control_changed ();
 863         set_tooltip ();
 864
 865         /* We're providing our own PersistentTooltip */
 866         set_no_tooltip_whatsoever (_slider);
 867 }
 868
 869 ProcessorEntry::Control::~Control ()
 870 {
 871         timer_connection.disconnect ();
 872 }
 873
 874 void
 875 ProcessorEntry::Control::set_tooltip ()
 876 {
 877         boost::shared_ptr<AutomationControl> c = _control.lock ();
 878
 879         if (!c) {
 880                 return;
 881         }
 882         char tmp[256];
 883         if (c->toggled ()) {
 884                 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
 885         } else {
 886                 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
 887         }
 888
 889         string sm = Gtkmm2ext::markup_escape_text (tmp);
 890         _slider_persistant_tooltip.set_tip (sm);
 891         ARDOUR_UI_UTILS::set_tooltip (_button, sm);
 892 }
 893
 894 void
 895 ProcessorEntry::Control::slider_adjusted ()
 896 {
 897         if (_ignore_ui_adjustment) {
 898                 return;
 899         }
 900
 901         boost::shared_ptr<AutomationControl> c = _control.lock ();
 902
 903         if (!c) {
 904                 return;
 905         }
 906
 907         c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
 908         set_tooltip ();
 909 }
 910
 911 void
 912 ProcessorEntry::Control::button_clicked ()
 913 {
 914         boost::shared_ptr<AutomationControl> c = _control.lock ();
 915
 916         if (!c) {
 917                 return;
 918         }
 919
 920         bool const n = _button.get_active ();
 921
 922         c->set_value (n ? 0 : 1, Controllable::NoGroup);
 923         _button.set_active (!n);
 924         set_tooltip ();
 925 }
 926
 927 void
 928 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
 929 {
 930         (void) ev;
 931
 932         button_clicked ();
 933 }
 934
 935 void
 936 ProcessorEntry::Control::control_changed ()
 937 {
 938         boost::shared_ptr<AutomationControl> c = _control.lock ();
 939         if (!c) {
 940                 return;
 941         }
 942
 943         _ignore_ui_adjustment = true;
 944
 945         if (c->toggled ()) {
 946
 947                 _button.set_active (c->get_value() > 0.5);
 948
 949         } else {
 950                 // as long as rapid timers are used, only update the tooltip
 951                 // if the value has changed.
 952                 const double nval = c->internal_to_interface (c->get_value ());
 953                 if (_adjustment.get_value() != nval) {
 954                         _adjustment.set_value (nval);
 955                         set_tooltip ();
 956                 }
 957         }
 958
 959         _ignore_ui_adjustment = false;
 960 }
 961
 962 void
 963 ProcessorEntry::Control::add_state (XMLNode* node) const
 964 {
 965         XMLNode* c = new XMLNode (X_("Object"));
 966         c->add_property (X_("id"), state_id ());
 967         c->add_property (X_("visible"), _visible);
 968         node->add_child_nocopy (*c);
 969 }
 970
 971 void
 972 ProcessorEntry::Control::set_state (XMLNode const * node)
 973 {
 974         XMLNode* n = GUIObjectState::get_node (node, state_id ());
 975         if (n) {
 976                 XMLProperty const * p = n->property (X_("visible"));
 977                 set_visible (p && string_is_affirmative (p->value ()));
 978         } else {
 979                 set_visible (false);
 980         }
 981 }
 982
 983 void
 984 ProcessorEntry::Control::set_visible (bool v)
 985 {
 986         if (v) {
 987                 box.show ();
 988         } else {
 989                 box.hide ();
 990         }
 991
 992         _visible = v;
 993 }
 994
 995 /** Called when the Editor might have re-shown things that
 996     we want hidden.
 997 */
 998 void
 999 ProcessorEntry::Control::hide_things ()
1000 {
1001         if (!_visible) {
1002                 box.hide ();
1003         }
1004 }
1005
1006 string
1007 ProcessorEntry::Control::state_id () const
1008 {
1009         boost::shared_ptr<AutomationControl> c = _control.lock ();
1010         assert (c);
1011
1012         return string_compose (X_("control %1"), c->id().to_s ());
1013 }
1014
1015 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
1016         : ProcessorEntry (b, p, w)
1017         , _plugin_insert (p)
1018 {
1019         p->PluginIoReConfigure.connect (
1020                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1021                 );
1022         p->PluginMapChanged.connect (
1023                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1024                 );
1025         p->PluginConfigChanged.connect (
1026                 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1027                 );
1028 }
1029
1030 void
1031 PluginInsertProcessorEntry::iomap_changed ()
1032 {
1033         _parent->setup_routing_feeds ();
1034         routing_icon.queue_draw();
1035         output_routing_icon.queue_draw();
1036 }
1037
1038 void
1039 PluginInsertProcessorEntry::hide_things ()
1040 {
1041         ProcessorEntry::hide_things ();
1042 }
1043
1044 ProcessorEntry::PortIcon::PortIcon(bool input) {
1045         _input = input;
1046         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1047         set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1048 }
1049
1050 bool
1051 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1052 {
1053         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1054
1055         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1056         cairo_clip (cr);
1057
1058         Gtk::Allocation a = get_allocation();
1059         double const width = a.get_width();
1060         double const height = a.get_height();
1061
1062         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1063         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1064
1065         cairo_rectangle (cr, 0, 0, width, height);
1066         cairo_fill (cr);
1067
1068         const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1069         for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1070                 set_routing_color (cr, i < _ports.n_midi());
1071                 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1072                 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1073                 cairo_fill(cr);
1074         }
1075
1076         cairo_destroy(cr);
1077         return true;
1078 }
1079
1080 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1081         : _fed_by (false)
1082         , _input (input)
1083 {
1084         set_terminal (false);
1085 }
1086
1087 void
1088 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1089         _terminal = b;
1090         int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1091         if (_terminal) {
1092                 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1093         }
1094         set_size_request (-1, h);
1095 }
1096
1097 void
1098 ProcessorEntry::RoutingIcon::set (
1099                 const ARDOUR::ChanCount& in,
1100                 const ARDOUR::ChanCount& out,
1101                 const ARDOUR::ChanCount& sinks,
1102                 const ARDOUR::ChanCount& sources,
1103                 const ARDOUR::ChanMapping& in_map,
1104                 const ARDOUR::ChanMapping& out_map,
1105                 const ARDOUR::ChanMapping& thru_map)
1106 {
1107         _in       = in;
1108         _out      = out;
1109         _sources  = sources;
1110         _sinks    = sinks;
1111         _in_map   = in_map;
1112         _out_map  = out_map;
1113         _thru_map = thru_map;
1114 }
1115
1116 bool
1117 ProcessorEntry::RoutingIcon::in_identity () const {
1118         if (_thru_map.n_total () > 0) {
1119                 return false;
1120         }
1121         if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1122                 return false;
1123         }
1124         if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1125                 return false;
1126         }
1127         return true;
1128 }
1129
1130 bool
1131 ProcessorEntry::RoutingIcon::out_identity () const {
1132         if (_thru_map.n_total () > 0) {
1133                 // TODO skip if trhu is not connected to any of next's inputs
1134                 return false;
1135         }
1136         if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1137                 return false;
1138         }
1139         if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1140                 return false;
1141         }
1142         return true;
1143 }
1144
1145 bool
1146 ProcessorEntry::RoutingIcon::can_coalesce () const {
1147         if (_thru_map.n_total () > 0) {
1148                 return false;
1149         }
1150         if (_fed_by && _f_out != _f_sources) {
1151                 return false;
1152         }
1153         if (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1154                 return false;
1155         }
1156         if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1157                 return true;
1158         }
1159         return false;
1160 }
1161
1162 void
1163 ProcessorEntry::RoutingIcon::set_fed_by (
1164                                 const ARDOUR::ChanCount& out,
1165                                 const ARDOUR::ChanCount& sources,
1166                                 const ARDOUR::ChanMapping& out_map,
1167                                 const ARDOUR::ChanMapping& thru_map)
1168 {
1169         _f_out      = out;
1170         _f_sources  = sources;
1171         _f_out_map  = out_map;
1172         _f_thru_map = thru_map;
1173         _fed_by     = true;
1174 }
1175
1176 void
1177 ProcessorEntry::RoutingIcon::set_feeding (
1178                                 const ARDOUR::ChanCount& in,
1179                                 const ARDOUR::ChanCount& sinks,
1180                                 const ARDOUR::ChanMapping& in_map,
1181                                 const ARDOUR::ChanMapping& thru_map)
1182 {
1183         _i_in       = in;
1184         _i_sinks    = sinks;
1185         _i_in_map   = in_map;
1186         _i_thru_map = thru_map;
1187         _feeding    = true;
1188 }
1189
1190 double
1191 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1192 {
1193         if (!midi) { i += n_midi; }
1194         if (n_total == 1) {
1195                 assert (i == 0);
1196                 return rint (width * .5) +.5;
1197         }
1198         return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1199 }
1200
1201 void
1202 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1203 {
1204         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1205         const double y1 = rint (height * .66) + .5;
1206
1207         cairo_save (cr);
1208         cairo_translate (cr, x0, y0);
1209         cairo_move_to (cr, 0, height);
1210         cairo_line_to (cr, 0, y1);
1211         cairo_move_to (cr, 0 - dx, y1);
1212         cairo_line_to (cr, 0 + dx, y1);
1213
1214         set_routing_color (cr, midi);
1215         cairo_set_line_width (cr, 1.0);
1216         cairo_stroke (cr);
1217         cairo_restore (cr);
1218 }
1219
1220 void
1221 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1222 {
1223         const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1224         const double y1 = rint (height * .5) - .5;
1225
1226         cairo_save (cr);
1227         cairo_translate (cr, x0, y0);
1228         cairo_move_to (cr, 0 - dx, height);
1229         cairo_line_to (cr, 0, y1);
1230         cairo_line_to (cr, 0 + dx, height);
1231         cairo_close_path (cr);
1232
1233         set_routing_color (cr, midi);
1234         cairo_fill (cr);
1235         cairo_restore (cr);
1236 }
1237
1238 void
1239 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1240 {
1241         const double rad = 1;
1242         const double y1 = height - rad - 1.5;
1243
1244         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1245         cairo_move_to (cr, x0, y0 + height - 1.5);
1246         cairo_line_to (cr, x0, y0 + height);
1247         set_routing_color (cr, midi);
1248         cairo_set_line_width  (cr, 1.0);
1249         cairo_stroke (cr);
1250 }
1251
1252 void
1253 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1254 {
1255         const double rad = 1;
1256         const double y1 = rad + 1;
1257
1258         cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1259         cairo_move_to (cr, x0, y0);
1260         cairo_line_to (cr, x0, y0 + 1);
1261         set_routing_color (cr, midi);
1262         cairo_set_line_width  (cr, 1.0);
1263         cairo_stroke (cr);
1264 }
1265
1266 void
1267 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1268 {
1269         double bz = abs (y1 - y0);
1270
1271         cairo_move_to (cr, x0, y0);
1272         cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1273         cairo_set_line_width  (cr, 1.0);
1274         cairo_set_line_cap  (cr,  CAIRO_LINE_CAP_ROUND);
1275         cairo_set_source_rgb (cr, 1, 0, 0);
1276         if (dashed) {
1277                 const double dashes[] = { 2, 3 };
1278                 cairo_set_dash (cr, dashes, 2, 0);
1279         }
1280         set_routing_color (cr, midi);
1281         cairo_stroke (cr);
1282         if (dashed) {
1283                 cairo_set_dash (cr, 0, 0, 0);
1284         }
1285 }
1286
1287 bool
1288 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1289 {
1290         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1291
1292         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1293         cairo_clip (cr);
1294
1295         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1296
1297         Gtk::Allocation a = get_allocation();
1298         double const width = a.get_width();
1299         double const height = a.get_height();
1300
1301         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1302         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1303
1304         cairo_rectangle (cr, 0, 0, width, height);
1305         cairo_fill (cr);
1306
1307         if (_input) {
1308                 if (can_coalesce ()) {
1309                         expose_coalesced_input_map (cr, width, height);
1310                 } else {
1311                         expose_input_map (cr, width, height);
1312                 }
1313         } else {
1314                 expose_output_map (cr, width, height);
1315         }
1316
1317         cairo_destroy(cr);
1318         return true;
1319 }
1320
1321 void
1322 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1323 {
1324         const uint32_t pc_in = _sinks.n_total();
1325         const uint32_t pc_in_midi = _sinks.n_midi();
1326
1327         for (uint32_t i = 0; i < pc_in; ++i) {
1328                 const bool is_midi = i < pc_in_midi;
1329                 bool valid_in;
1330                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1331                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1332                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1333                 if (!valid_in) {
1334                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1335                         draw_gnd (cr, x, 0, height, is_midi);
1336                         continue;
1337                 }
1338                 if (idx >= _in.get (dt)) {
1339                         // side-chain, probably
1340                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1341                         draw_sidechain (cr, x, 0, height, is_midi);
1342                         continue;
1343                 }
1344                 double c_x0;
1345                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1346
1347                 if (_fed_by) {
1348                         bool valid_src;
1349                         uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1350                         if (!valid_src) {
1351                                 double x = pin_x_pos (i, width, pc_in, 0, false);
1352                                 bool valid_thru;
1353                                 _f_thru_map.get (dt, idx, &valid_thru);
1354                                 if (valid_thru) {
1355                                         draw_thru_src (cr, x, 0, height, is_midi);
1356                                 } else {
1357                                         draw_gnd (cr, x, 0, height, is_midi);
1358                                 }
1359                                 continue;
1360                         }
1361                         c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1362                 } else {
1363                         c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1364                 }
1365                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1366         }
1367 }
1368
1369 void
1370 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1371 {
1372         const uint32_t n_in = _in.n_total();
1373         const uint32_t n_in_midi = _in.n_midi();
1374         const uint32_t pc_in = _sinks.n_total();
1375         const uint32_t pc_in_midi = _sinks.n_midi();
1376
1377         // draw inputs to this
1378         for (uint32_t i = 0; i < pc_in; ++i) {
1379                 const bool is_midi = i < pc_in_midi;
1380                 bool valid_in;
1381                 uint32_t pn = is_midi ? i : i - pc_in_midi;
1382                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1383                 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1384                 // check if it's fed
1385                 bool valid_src = true;
1386                 if (valid_in && idx < _in.get (dt) && _fed_by) {
1387                         bool valid_out;
1388                         bool valid_thru;
1389                         _f_out_map.get_src (dt, idx, &valid_out);
1390                         _f_thru_map.get (dt, idx, &valid_thru);
1391                         if (!valid_out && !valid_thru) {
1392                                 valid_src = false;
1393                         }
1394                 }
1395                 if (!valid_in || !valid_src) {
1396                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1397                         draw_gnd (cr, x, 0, height, is_midi);
1398                         continue;
1399                 }
1400                 if (idx >= _in.get (dt)) {
1401                         // side-chain, probably
1402                         double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1403                         draw_sidechain (cr, x, 0, height, is_midi);
1404                         continue;
1405                 }
1406                 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1407                 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1408                 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1409         }
1410
1411         // draw reverse thru
1412         for (uint32_t i = 0; i < n_in; ++i) {
1413                 const bool is_midi = i < n_in_midi;
1414                 bool valid_thru;
1415                 uint32_t pn = is_midi ? i : i - n_in_midi;
1416                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1417                 _thru_map.get_src (dt, pn, &valid_thru);
1418                 if (!valid_thru) {
1419                         continue;
1420                 }
1421                 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1422                 draw_thru_sink (cr, x, 0, height, is_midi);
1423         }
1424 }
1425
1426 void
1427 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1428 {
1429         int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1430         double ht = _terminal ? height - dh : height;
1431
1432         // draw outputs of this
1433         const uint32_t pc_out = _sources.n_total();
1434         const uint32_t pc_out_midi = _sources.n_midi();
1435         const uint32_t n_out = _out.n_total();
1436         const uint32_t n_out_midi = _out.n_midi();
1437
1438         for (uint32_t i = 0; i < pc_out; ++i) {
1439                 const bool is_midi = i < pc_out_midi;
1440                 bool valid_out;
1441                 uint32_t pn = is_midi ? i : i - pc_out_midi;
1442                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1443                 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1444                 if (!valid_out) {
1445                         continue;
1446                 }
1447                 // skip connections that are not used in the next's input
1448                 if (_feeding) {
1449                         bool valid_thru, valid_sink;
1450                         _i_in_map.get_src (dt, idx, &valid_sink);
1451                         _i_thru_map.get_src (dt, idx, &valid_thru);
1452                         if (!valid_thru && !valid_sink) {
1453                                 if (!is_midi || i != 0) { // special case midi-bypass
1454                                         continue;
1455                                 }
1456                         }
1457                 }
1458                 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1459                 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1460                 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1461         }
1462
1463         for (uint32_t i = 0; i < n_out; ++i) {
1464                 const bool is_midi = i < n_out_midi;
1465                 uint32_t pn = is_midi ? i : i - n_out_midi;
1466                 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1467                 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1468
1469                 if (!_terminal) {
1470                         bool valid_thru_f = false;
1471                         // skip connections that are not used in the next's input
1472                         if (_feeding) {
1473                                 bool valid_sink;
1474                                 _i_in_map.get_src (dt, pn, &valid_sink);
1475                                 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1476                                 if (!valid_thru_f && !valid_sink) {
1477                                         if (!is_midi || i != 0) { // special case midi-bypass
1478                                                 continue;
1479                                         }
1480                                 }
1481                         }
1482
1483                         bool valid_src;
1484                         _out_map.get_src (dt, pn, &valid_src);
1485                         if (!valid_src) {
1486                                 bool valid_thru;
1487                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1488                                 if (valid_thru) {
1489                                         if (idx >= _in.get (dt)) {
1490                                                 draw_sidechain (cr, x, 0, height, is_midi);
1491                                         } else {
1492                                                 draw_thru_src (cr, x, 0, height, is_midi);
1493                                         }
1494                                 } else if (valid_thru_f){
1495                                         // gnd is part of input, unless it's a thru input
1496                                         // (also only true if !coalesced into one small display)
1497                                         draw_gnd (cr, x, 0, height, is_midi);
1498                                 }
1499                         }
1500                 } else {
1501                         // terminal node, add arrows
1502                         bool valid_src;
1503                         _out_map.get_src (dt, pn, &valid_src);
1504                         if (!valid_src) {
1505                                 bool valid_thru;
1506                                 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1507                                 if (valid_thru) {
1508                                         if (idx >= _in.get (dt)) {
1509                                                 draw_sidechain (cr, x, 0, height - dh, is_midi);
1510                                         } else {
1511                                                 draw_thru_src (cr, x, 0, height - dh, is_midi);
1512                                         }
1513                                 } else {
1514                                         draw_gnd (cr, x, 0, height - dh, is_midi);
1515                                 }
1516                         }
1517
1518                         set_routing_color (cr, is_midi);
1519                         cairo_set_line_width (cr, 1.0);
1520                         cairo_move_to (cr, x, height - dh);
1521                         cairo_line_to (cr, x, height - 2);
1522                         cairo_stroke (cr);
1523
1524                         const double ar = dh - 1;
1525                         cairo_move_to (cr, x - ar, height - ar);
1526                         cairo_line_to (cr, x     , height - .5);
1527                         cairo_line_to (cr, x + ar, height - ar);
1528                         cairo_line_to (cr, x     , height - ar * .5);
1529                         cairo_close_path (cr);
1530                         cairo_fill_preserve (cr);
1531                         cairo_stroke (cr);
1532                 }
1533         }
1534 }
1535
1536 ProcessorEntry::PluginDisplay::PluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1537         : _entry (e)
1538         , _plug (p)
1539         , _surf (0)
1540         , _max_height (max_height)
1541         , _cur_height (1)
1542         , _scroll (false)
1543 {
1544         set_name ("processor prefader");
1545         add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
1546         _plug->DropReferences.connect (_death_connection, invalidator (*this), boost::bind (&PluginDisplay::plugin_going_away, this), gui_context());
1547         _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1548                         boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1549
1550         std::string postfix = "";
1551         if (_plug->has_editor()) {
1552                 ARDOUR_UI_UTILS::set_tooltip (*this,
1553                                 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), e.name (Wide), Keyboard::primary_modifier_name (), postfix));
1554         } else {
1555                 ARDOUR_UI_UTILS::set_tooltip (*this,
1556                                 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), e.name (Wide), postfix));
1557         }
1558 }
1559
1560 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1561 {
1562         if (_surf) {
1563                 cairo_surface_destroy (_surf);
1564         }
1565 }
1566
1567 bool
1568 ProcessorEntry::PluginDisplay::on_button_press_event (GdkEventButton *ev)
1569 {
1570         assert (_entry.processor ());
1571
1572         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_entry.processor());
1573         // duplicated code :(
1574         // consider some tweaks to pass this up to the DnDVBox somehow:
1575         // select processor, then call (private)
1576         //_entry._parent->processor_button_press_event (ev, &_entry);
1577         if (pi && pi->plugin() && pi->plugin()->has_inline_display()
1578                         && Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)
1579                         && ev->button == 1
1580                         && ev->type == GDK_2BUTTON_PRESS) {
1581                 _entry.toggle_inline_display_visibility ();
1582                 return true;
1583         }
1584         else if (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS)) {
1585                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1586                         _entry._parent->generic_edit_processor (_entry.processor ());
1587                 } else {
1588                         _entry._parent->edit_processor (_entry.processor ());
1589                 }
1590                 return true;
1591         }
1592         return false;
1593 }
1594
1595 bool
1596 ProcessorEntry::PluginDisplay::on_button_release_event (GdkEventButton *ev)
1597 {
1598         return false;
1599 }
1600
1601 void
1602 ProcessorEntry::PluginDisplay::on_size_request (Requisition* req)
1603 {
1604         req->width = 56;
1605         req->height = _cur_height;
1606 }
1607
1608
1609 void
1610 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1611 {
1612         /* work-around scroll-bar + aspect ratio
1613          * show inline-view -> height changes -> scrollbar gets added
1614          * -> width changes -> inline-view, fixed aspect ratio -> height changes
1615          * -> scroll bar is removed [-> width changes ; repeat ]
1616          */
1617         uint32_t shm = std::min (_max_height, inline_height);
1618         bool sc = false;
1619         Gtk::Container* pr = get_parent();
1620         for (uint32_t i = 0; i < 4 && pr; ++i) {
1621                 // VBox, EventBox, ViewPort, ScrolledWindow
1622                 pr = pr->get_parent();
1623         }
1624         Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1625         if (sw) {
1626                 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1627                 sc = vsb && vsb->is_visible();
1628         }
1629
1630         if (shm != _cur_height) {
1631                 if (_scroll == sc || _cur_height < shm) {
1632                         queue_resize ();
1633                 }
1634                 _cur_height = shm;
1635         }
1636         _scroll = sc;
1637 }
1638
1639 uint32_t
1640 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1641 {
1642         Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1643         if (!dis) {
1644                 return 0;
1645         }
1646
1647         /* allocate a local image-surface,
1648          * We cannot re-use the data via cairo_image_surface_create_for_data(),
1649          * since pixman keeps a reference to it.
1650          * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1651          * it might be possible to work around via cairo_surface_set_user_data().
1652          */
1653         if (!_surf
1654                         || dis->width !=  cairo_image_surface_get_width (_surf)
1655                         || dis->height !=  cairo_image_surface_get_height (_surf)
1656                  ) {
1657                 if (_surf) {
1658                         cairo_surface_destroy (_surf);
1659                 }
1660                 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1661         }
1662
1663         if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1664                 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1665         } else {
1666                 unsigned char *src = dis->data;
1667                 unsigned char *dst = cairo_image_surface_get_data (_surf);
1668                 const int dst_stride =  cairo_image_surface_get_stride (_surf);
1669                 for (int y = 0; y < dis->height; ++y) {
1670                         memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1671                         src += dis->stride;
1672                         dst += dst_stride;
1673                 }
1674         }
1675
1676         cairo_surface_flush(_surf);
1677         cairo_surface_mark_dirty(_surf);
1678         const double xc = floor ((width - dis->width) * .5);
1679         cairo_set_source_surface(cr, _surf, xc, 0);
1680         cairo_paint (cr);
1681
1682         return dis->height;
1683 }
1684
1685 bool
1686 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1687 {
1688         Gtk::Allocation a = get_allocation();
1689         double const width = a.get_width();
1690         double const height = a.get_height();
1691
1692         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1693         cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1694         cairo_clip (cr);
1695
1696         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1697         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1698         cairo_rectangle (cr, 0, 0, width, height);
1699         cairo_fill (cr);
1700
1701         cairo_save (cr);
1702         cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1703         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1704         cairo_clip (cr);
1705         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1706
1707         uint32_t ht = render_inline (cr, width);
1708         cairo_restore (cr);
1709
1710         if (ht == 0) {
1711                 hide ();
1712                 if (_cur_height != 1) {
1713                         _cur_height = 1;
1714                         queue_resize ();
1715                 }
1716                 cairo_destroy (cr);
1717                 return true;
1718         } else {
1719                 update_height_alloc (ht);
1720         }
1721
1722         bool failed = false;
1723         std::string name = get_name();
1724         ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1725
1726         Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1727         cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1728         cairo_set_line_width(cr, 1.0);
1729         ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1730         cairo_stroke (cr);
1731
1732         cairo_destroy(cr);
1733         return true;
1734 }
1735
1736 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1737         : PluginDisplay (e, p, max_height)
1738         , _luaproc (p)
1739         , _lua_render_inline (0)
1740 {
1741         p->setup_lua_inline_gui (&lua_gui);
1742
1743         lua_State* LG = lua_gui.getState ();
1744         LuaInstance::bind_cairo (LG);
1745         luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1746         assert (lua_render.isFunction ());
1747         _lua_render_inline = new luabridge::LuaRef (lua_render);
1748 }
1749
1750 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1751 {
1752         delete (_lua_render_inline);
1753 }
1754
1755 uint32_t
1756 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1757 {
1758         Cairo::Context ctx (cr);
1759         try {
1760                 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1761                 lua_gui.collect_garbage_step ();
1762                 if (rv.isTable ()) {
1763                         uint32_t h = rv[2];
1764                         return h;
1765                 }
1766         } catch (luabridge::LuaException const& e) {
1767 #ifndef NDEBUG
1768                 cerr << "LuaException:" << e.what () << endl;
1769 #endif
1770         }
1771         return 0;
1772 }
1773
1774
1775 static std::list<Gtk::TargetEntry> drop_targets()
1776 {
1777         std::list<Gtk::TargetEntry> tmp;
1778         tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1779         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1780         tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1781         return tmp;
1782 }
1783
1784 static std::list<Gtk::TargetEntry> drag_targets()
1785 {
1786         std::list<Gtk::TargetEntry> tmp;
1787         tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1788         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1789         return tmp;
1790 }
1791
1792 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1793 {
1794         std::list<Gtk::TargetEntry> tmp;
1795         tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1796         return tmp;
1797 }
1798
1799 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1800                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1801         : _parent_strip (parent)
1802         , _owner_is_mixer (owner_is_mixer)
1803         , ab_direction (true)
1804         , _get_plugin_selector (get_plugin_selector)
1805         , _placement (-1)
1806         , _visible_prefader_processors (0)
1807         , _rr_selection(rsel)
1808         , processor_display (drop_targets())
1809         , _redisplay_pending (false)
1810 {
1811         set_session (sess);
1812
1813         /* ProcessorBox actions and bindings created statically by call to
1814          * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1815          * are available for context menus.
1816          */
1817
1818         processor_display.set_data ("ardour-bindings", bindings);
1819
1820         _width = Wide;
1821         processor_menu = 0;
1822         no_processor_redisplay = false;
1823
1824         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1825         processor_scroller.add (processor_display);
1826         pack_start (processor_scroller, true, true);
1827
1828         processor_display.set_flags (CAN_FOCUS);
1829         processor_display.set_name ("ProcessorList");
1830         processor_display.set_data ("processorbox", this);
1831         processor_display.set_size_request (48, -1);
1832         processor_display.set_spacing (0);
1833
1834         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1835         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1836
1837         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1838         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1839
1840         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1841         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1842         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1843
1844         processor_scroller.show ();
1845         processor_display.show ();
1846
1847         if (parent) {
1848                 parent->DeliveryChanged.connect (
1849                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1850                         );
1851         }
1852
1853         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1854 }
1855
1856 ProcessorBox::~ProcessorBox ()
1857 {
1858         /* it may appear as if we should delete processor_menu but that is a
1859          * pointer to a widget owned by the UI Manager, and has potentially
1860          * be returned to many other ProcessorBoxes. GTK doesn't really make
1861          * clear the ownership of this widget, which is a menu and thus is
1862          * never packed into any container other than an implict GtkWindow.
1863          *
1864          * For now, until or if we ever get clarification over the ownership
1865          * story just let it continue to exist. At worst, its a small memory leak.
1866          */
1867 }
1868
1869 void
1870 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1871 {
1872         if (_route == r) {
1873                 return;
1874         }
1875
1876         _route_connections.drop_connections();
1877
1878         /* new route: any existing block on processor redisplay must be meaningless */
1879         no_processor_redisplay = false;
1880         _route = r;
1881
1882         _route->processors_changed.connect (
1883                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1884                 );
1885
1886         _route->DropReferences.connect (
1887                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1888                 );
1889
1890         _route->PropertyChanged.connect (
1891                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1892                 );
1893
1894         redisplay_processors ();
1895 }
1896
1897 void
1898 ProcessorBox::route_going_away ()
1899 {
1900         /* don't keep updating display as processors are deleted */
1901         no_processor_redisplay = true;
1902         _route.reset ();
1903 }
1904
1905 boost::shared_ptr<Processor>
1906 ProcessorBox::find_drop_position (ProcessorEntry* position)
1907 {
1908         boost::shared_ptr<Processor> p;
1909         if (position) {
1910                 p = position->processor ();
1911                 if (!p) {
1912                         /* dropped on the blank entry (which will be before the
1913                                  fader), so use the first non-blank child as our
1914                                  `dropped on' processor */
1915                         list<ProcessorEntry*> c = processor_display.children ();
1916                         list<ProcessorEntry*>::iterator i = c.begin ();
1917
1918                         assert (i != c.end ());
1919                         p = (*i)->processor ();
1920                         assert (p);
1921                 }
1922         }
1923         return p;
1924 }
1925
1926 void
1927 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1928 {
1929                 const void * d = data.get_data();
1930                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1931
1932                 PluginPresetList nfos;
1933                 TreeView* source;
1934                 tv->get_object_drag_data (nfos, &source);
1935
1936                 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1937                         PluginPresetPtr ppp = (*i);
1938                         PluginInfoPtr pip = ppp->_pip;
1939                         PluginPtr p = pip->load (*_session);
1940                         if (!p) {
1941                                 continue;
1942                         }
1943
1944                         if (ppp->_preset.valid) {
1945                                 p->load_preset (ppp->_preset);
1946                         }
1947
1948                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1949                         if (Config->get_new_plugins_active ()) {
1950                                 processor->enable (true);
1951                         }
1952                         pl.push_back (processor);
1953                 }
1954 }
1955
1956 void
1957 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1958 {
1959                 const void * d = data.get_data();
1960                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1961                 PluginInfoList nfos;
1962
1963                 TreeView* source;
1964                 tv->get_object_drag_data (nfos, &source);
1965
1966                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1967                         PluginPtr p = (*i)->load (*_session);
1968                         if (!p) {
1969                                 continue;
1970                         }
1971                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1972                         if (Config->get_new_plugins_active ()) {
1973                                 processor->enable (true);
1974                         }
1975                         pl.push_back (processor);
1976                 }
1977 }
1978
1979 void
1980 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1981 {
1982         if (!_session) {
1983                 return;
1984         }
1985
1986         boost::shared_ptr<Processor> p = find_drop_position (position);
1987         Route::ProcessorList pl;
1988
1989         if (data.get_target() == "PluginInfoPtr") {
1990                 _drop_plugin (data, pl);
1991         }
1992         else if (data.get_target() == "PluginFavoritePtr") {
1993                 _drop_plugin_preset (data, pl);
1994         }
1995         else {
1996                 return;
1997         }
1998
1999         Route::ProcessorStreams err;
2000         if (_route->add_processors (pl, p, &err)) {
2001                 string msg = _(
2002                                 "Processor Drag/Drop failed. Probably because\n\
2003 the I/O configuration of the plugins could\n\
2004 not match the configuration of this track.");
2005                 MessageDialog am (msg);
2006                 am.run ();
2007         }
2008 }
2009
2010 void
2011 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
2012 {
2013         if (Gdk::ACTION_LINK == context->get_selected_action()) {
2014                 list<ProcessorEntry*> children = source->selection ();
2015                 assert (children.size() == 1);
2016                 ProcessorEntry* other = *children.begin();
2017                 assert (other->can_copy_state (position));
2018                 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
2019                 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
2020                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
2021                 assert (otherproc && proc && pi);
2022
2023                 PBD::ID id = pi->id();
2024                 XMLNode& state = otherproc->get_state ();
2025                 /* strip side-chain state (processor inside processor must be a side-chain)
2026                  * otherwise we'll end up with duplicate ports-names.
2027                  * (this needs a better solution which retains connections)
2028                  */
2029                 state.remove_nodes ("Processor");
2030                 proc->set_state (state, Stateful::loading_state_version);
2031                 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
2032                 return;
2033         }
2034
2035         boost::shared_ptr<Processor> p = find_drop_position (position);
2036
2037         list<ProcessorEntry*> children = source->selection ();
2038         list<boost::shared_ptr<Processor> > procs;
2039         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
2040                 if ((*i)->processor ()) {
2041                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
2042                                 continue;
2043                         }
2044                         procs.push_back ((*i)->processor ());
2045                 }
2046         }
2047
2048         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
2049                 XMLNode& state = (*i)->get_state ();
2050                 XMLNodeList nlist;
2051                 nlist.push_back (&state);
2052                 paste_processor_state (nlist, p);
2053                 delete &state;
2054         }
2055
2056         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
2057            ourselves.
2058         */
2059
2060         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
2061                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
2062                 if (other) {
2063                         other->delete_dragged_processors (procs);
2064                 }
2065         }
2066 }
2067
2068 void
2069 ProcessorBox::set_width (Width w)
2070 {
2071         if (_width == w) {
2072                 return;
2073         }
2074
2075         _width = w;
2076
2077         list<ProcessorEntry*> children = processor_display.children ();
2078         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2079                 (*i)->set_enum_width (w);
2080         }
2081
2082         queue_resize ();
2083 }
2084
2085 Gtk::Menu*
2086 ProcessorBox::build_possible_aux_menu ()
2087 {
2088         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2089
2090         if (rl->empty()) {
2091                 /* No aux sends if there are no busses */
2092                 return 0;
2093         }
2094
2095         if (_route->is_monitor ()) {
2096                 return 0;
2097         }
2098
2099         using namespace Menu_Helpers;
2100         Menu* menu = manage (new Menu);
2101         MenuList& items = menu->items();
2102
2103         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2104                 if (!_route->internal_send_for (*r) && *r != _route) {
2105                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2106                 }
2107         }
2108
2109         return menu;
2110 }
2111
2112 void
2113 ProcessorBox::show_processor_menu (int arg)
2114 {
2115         if (processor_menu == 0) {
2116                 processor_menu = build_processor_menu ();
2117                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2118         }
2119
2120         /* Sort out the plugin submenu */
2121
2122         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2123
2124         if (plugin_menu_item) {
2125                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2126         }
2127
2128         /* And the aux submenu */
2129
2130         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2131
2132         if (aux_menu_item) {
2133                 Menu* m = build_possible_aux_menu();
2134                 if (m && !m->items().empty()) {
2135                         aux_menu_item->set_submenu (*m);
2136                         aux_menu_item->set_sensitive (true);
2137                 } else {
2138                         /* stupid gtkmm: we need to pass a null reference here */
2139                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2140                         aux_menu_item->set_sensitive (false);
2141                 }
2142         }
2143
2144         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2145         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2146
2147         ProcessorEntry* single_selection = 0;
2148         if (processor_display.selection().size() == 1) {
2149                 single_selection = processor_display.selection().front();
2150         }
2151
2152         /* And the controls submenu */
2153
2154         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2155
2156         if (controls_menu_item) {
2157                 if (single_selection) {
2158                         Menu* m = single_selection->build_controls_menu ();
2159                         if (m && !m->items().empty()) {
2160                                 controls_menu_item->set_submenu (*m);
2161                                 controls_menu_item->set_sensitive (true);
2162                         } else {
2163                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2164                                 controls_menu_item->set_sensitive (false);
2165                         }
2166                 } else {
2167                         controls_menu_item->set_sensitive (false);
2168                 }
2169         }
2170
2171
2172         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2173         if (send_menu_item) {
2174                 if (single_selection && !_route->is_monitor()) {
2175                         Menu* m = single_selection->build_send_options_menu ();
2176                         if (m && !m->items().empty()) {
2177                                 send_menu_item->set_submenu (*m);
2178                                 send_menu_item->set_sensitive (true);
2179                         } else {
2180                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2181                                 send_menu_item->set_sensitive (false);
2182                         }
2183                 } else {
2184                         send_menu_item->set_sensitive (false);
2185                 }
2186         }
2187
2188         /* Sensitise actions as approprioate */
2189
2190
2191         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2192
2193         paste_action->set_sensitive (!_rr_selection.processors.empty());
2194         cut_action->set_sensitive (sensitive && can_cut ());
2195         copy_action->set_sensitive (sensitive);
2196         delete_action->set_sensitive (sensitive || stub_processor_selected ());
2197         backspace_action->set_sensitive (sensitive || stub_processor_selected ());
2198
2199         edit_action->set_sensitive (one_processor_can_be_edited ());
2200         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2201
2202         boost::shared_ptr<PluginInsert> pi;
2203         if (single_selection) {
2204                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2205         }
2206
2207         manage_pins_action->set_sensitive (pi != 0);
2208
2209         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2210         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2211
2212         /* disallow rename for multiple selections, for plugin inserts and for the fader */
2213         rename_action->set_sensitive (single_selection
2214                         && !pi
2215                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2216                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2217
2218         processor_menu->popup (1, arg);
2219
2220         /* Add a placeholder gap to the processor list to indicate where a processor would be
2221            inserted were one chosen from the menu.
2222         */
2223         int x, y;
2224         processor_display.get_pointer (x, y);
2225         _placement = processor_display.add_placeholder (y);
2226
2227         if (_visible_prefader_processors == 0 && _placement > 0) {
2228                 --_placement;
2229         }
2230 }
2231
2232 bool
2233 ProcessorBox::enter_notify (GdkEventCrossing*)
2234 {
2235         processor_display.grab_focus ();
2236         _current_processor_box = this;
2237         return false;
2238 }
2239
2240 bool
2241 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2242 {
2243         if (ev->detail == GDK_NOTIFY_INFERIOR) {
2244                 return false;
2245         }
2246
2247         Widget* top = get_toplevel();
2248
2249         if (top->is_toplevel()) {
2250                 Window* win = dynamic_cast<Window*> (top);
2251                 gtk_window_set_focus (win->gobj(), 0);
2252         }
2253
2254         return false;
2255 }
2256
2257 bool
2258 ProcessorBox::processor_operation (ProcessorOperation op)
2259 {
2260         ProcSelection targets;
2261
2262         get_selected_processors (targets);
2263
2264 /*      if (targets.empty()) {
2265
2266                 int x, y;
2267                 processor_display.get_pointer (x, y);
2268
2269                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2270
2271                 if (pointer.first && pointer.first->processor()) {
2272                         targets.push_back (pointer.first->processor ());
2273                 }
2274         }
2275 */
2276
2277         if ((op == ProcessorsDelete) && targets.empty()) {
2278                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
2279         }
2280
2281         switch (op) {
2282         case ProcessorsSelectAll:
2283                 processor_display.select_all ();
2284                 break;
2285
2286         case ProcessorsSelectNone:
2287                 processor_display.select_none ();
2288                 break;
2289
2290         case ProcessorsCopy:
2291                 copy_processors (targets);
2292                 break;
2293
2294         case ProcessorsCut:
2295                 cut_processors (targets);
2296                 break;
2297
2298         case ProcessorsPaste:
2299                 // some processors are not selectable (e.g fader, meter), target is empty.
2300                 if (targets.empty() && _placement >= 0) {
2301                         assert (_route);
2302                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2303                         if (proc) {
2304                                 targets.push_back (proc);
2305                         }
2306                 }
2307                 if (targets.empty()) {
2308                         paste_processors ();
2309                 } else {
2310                         paste_processors (targets.front());
2311                 }
2312                 break;
2313
2314         case ProcessorsDelete:
2315                 delete_processors (targets);
2316                 break;
2317
2318         case ProcessorsToggleActive:
2319                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2320                         (*i)->enable (!(*i)->enabled ());
2321                 }
2322                 break;
2323
2324         case ProcessorsAB:
2325                 ab_plugins ();
2326                 break;
2327
2328         default:
2329                 break;
2330         }
2331
2332         return true;
2333 }
2334
2335 ProcessorWindowProxy*
2336 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2337 {
2338         return  processor->window_proxy();
2339 }
2340
2341
2342 bool
2343 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2344 {
2345         boost::shared_ptr<Processor> processor;
2346         if (child) {
2347                 processor = child->processor ();
2348         }
2349
2350         int ret = false;
2351         bool selected = processor_display.selected (child);
2352
2353         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2354         if (pi && pi->plugin() && pi->plugin()->has_inline_display()
2355                         && Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)
2356                         && ev->button == 1
2357                         && ev->type == GDK_2BUTTON_PRESS) {
2358                 child->toggle_inline_display_visibility ();
2359                 return true;
2360         }
2361
2362         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2363
2364                 if (_session->engine().connected()) {
2365                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2366
2367                         if (!one_processor_can_be_edited ()) {
2368                                 return true;
2369                         }
2370
2371                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2372                                 generic_edit_processor (processor);
2373                         } else {
2374                                 edit_processor (processor);
2375                         }
2376                 }
2377
2378                 ret = true;
2379
2380         } else if (Keyboard::is_context_menu_event (ev)) {
2381
2382                 show_processor_menu (ev->time);
2383
2384                 ret = true;
2385
2386         } else if (processor && ev->button == 1 && selected) {
2387
2388                 // this is purely informational but necessary for route params UI
2389                 ProcessorSelected (processor); // emit
2390
2391         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2392
2393                 choose_plugin ();
2394                 _get_plugin_selector()->show_manager ();
2395         }
2396
2397         return ret;
2398 }
2399
2400 bool
2401 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2402 {
2403         boost::shared_ptr<Processor> processor;
2404         if (child) {
2405                 processor = child->processor ();
2406         }
2407
2408         if (processor && Keyboard::is_delete_event (ev)) {
2409
2410                 Glib::signal_idle().connect (sigc::bind (
2411                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2412                                 boost::weak_ptr<Processor>(processor)));
2413
2414         } else if (processor && Keyboard::is_button2_event (ev)
2415 #ifndef __APPLE__
2416                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2417 #endif
2418                 ) {
2419
2420                 /* button2-click with no/appropriate modifiers */
2421                 processor->enable (!processor->enabled ());
2422         }
2423
2424         return false;
2425 }
2426
2427 Menu *
2428 ProcessorBox::build_processor_menu ()
2429 {
2430         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2431         processor_menu->set_name ("ArdourContextMenu");
2432         return processor_menu;
2433 }
2434
2435 void
2436 ProcessorBox::select_all_processors ()
2437 {
2438         processor_display.select_all ();
2439 }
2440
2441 void
2442 ProcessorBox::deselect_all_processors ()
2443 {
2444         processor_display.select_none ();
2445 }
2446
2447 void
2448 ProcessorBox::choose_plugin ()
2449 {
2450         _get_plugin_selector()->set_interested_object (*this);
2451 }
2452
2453 /** @return true if an error occurred, otherwise false */
2454 bool
2455 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2456 {
2457         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2458
2459                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2460
2461                 Route::ProcessorStreams err_streams;
2462
2463                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2464                         weird_plugin_dialog (**p, err_streams);
2465                         return true;
2466                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
2467                 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2468                         if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2469                                 ;
2470                         } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2471                                 if ((*p)->has_editor ()) {
2472                                         edit_processor (processor);
2473                                 } else {
2474                                         generic_edit_processor (processor);
2475                                 }
2476                         }
2477                 }
2478         }
2479
2480         return false;
2481 }
2482
2483 void
2484 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2485 {
2486         /* XXX this needs to be re-worked!
2487          *
2488          * With new pin-management "streams" is no longer correct.
2489          * p.get_info () is also incorrect for variable i/o plugins (always -1,-1).
2490          *
2491          * Since pin-management was added, this dialog will only show in a very rare
2492          * condition (non-replicated variable i/o configuration failed).
2493          *
2494          * TODO: simplify the message after the string-freeze is lifted.
2495          */
2496         ArdourDialog dialog (_("Plugin Incompatibility"));
2497         Label label;
2498
2499         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2500                         p.name(), streams.index);
2501
2502         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2503         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2504
2505         text += _("\nThis plugin has:\n");
2506         if (has_midi) {
2507                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2508                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2509         }
2510         if (has_audio) {
2511                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2512                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2513         }
2514
2515         text += _("\nbut at the insertion point, there are:\n");
2516         if (has_midi) {
2517                 uint32_t const n = streams.count.n_midi ();
2518                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2519         }
2520         if (has_audio) {
2521                 uint32_t const n = streams.count.n_audio ();
2522                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2523         }
2524
2525         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2526         label.set_text(text);
2527
2528         dialog.get_vbox()->pack_start (label);
2529         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2530
2531         dialog.set_name (X_("PluginIODialog"));
2532         dialog.set_modal (true);
2533         dialog.show_all ();
2534
2535         dialog.run ();
2536 }
2537
2538 void
2539 ProcessorBox::choose_insert ()
2540 {
2541         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2542         _route->add_processor_by_index (processor, _placement);
2543 }
2544
2545 /* Caller must not hold process lock */
2546 void
2547 ProcessorBox::choose_send ()
2548 {
2549         boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2550
2551         /* make an educated guess at the initial number of outputs for the send */
2552         ChanCount outs = (_route->n_outputs().n_audio() && _session->master_out())
2553                         ? _session->master_out()->n_outputs()
2554                         : _route->n_outputs();
2555
2556         /* XXX need processor lock on route */
2557         try {
2558                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2559                 send->output()->ensure_io (outs, false, this);
2560         } catch (AudioEngine::PortRegistrationFailure& err) {
2561                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2562                 return;
2563         }
2564
2565         /* let the user adjust the IO setup before creation.
2566
2567            Note: this dialog is NOT modal - we just leave it to run and it will
2568            return when its Finished signal is emitted - typically when the window
2569            is closed.
2570          */
2571
2572         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2573         ios->show ();
2574
2575         /* keep a reference to the send so it doesn't get deleted while
2576            the IOSelectorWindow is doing its stuff
2577         */
2578         _processor_being_created = send;
2579
2580         ios->selector().Finished.connect (sigc::bind (
2581                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2582                         boost::weak_ptr<Processor>(send), ios));
2583
2584 }
2585
2586 void
2587 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2588 {
2589         boost::shared_ptr<Processor> processor (weak_processor.lock());
2590
2591         /* drop our temporary reference to the new send */
2592         _processor_being_created.reset ();
2593
2594         if (!processor) {
2595                 return;
2596         }
2597
2598         switch (r) {
2599         case IOSelector::Cancelled:
2600                 // processor will go away when all shared_ptrs to it vanish
2601                 break;
2602
2603         case IOSelector::Accepted:
2604                 _route->add_processor_by_index (processor, _placement);
2605                 break;
2606         }
2607
2608         delete_when_idle (ios);
2609 }
2610
2611 void
2612 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2613 {
2614         boost::shared_ptr<Processor> processor (weak_processor.lock());
2615
2616         /* drop our temporary reference to the new return */
2617         _processor_being_created.reset ();
2618
2619         if (!processor) {
2620                 return;
2621         }
2622
2623         switch (r) {
2624         case IOSelector::Cancelled:
2625                 // processor will go away when all shared_ptrs to it vanish
2626                 break;
2627
2628         case IOSelector::Accepted:
2629                 _route->add_processor_by_index (processor, _placement);
2630                 break;
2631         }
2632
2633         delete_when_idle (ios);
2634 }
2635
2636 void
2637 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2638 {
2639         if (!_route) {
2640                 return;
2641         }
2642
2643         boost::shared_ptr<Route> target = wr.lock();
2644
2645         if (!target) {
2646                 return;
2647         }
2648
2649         _session->add_internal_send (target, _placement, _route);
2650 }
2651
2652 void
2653 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2654 {
2655         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2656                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2657                 return;
2658         }
2659
2660         redisplay_processors ();
2661 }
2662
2663 void
2664 ProcessorBox::redisplay_processors ()
2665 {
2666         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2667         bool     fader_seen;
2668
2669         if (no_processor_redisplay) {
2670                 return;
2671         }
2672
2673         processor_display.clear ();
2674
2675         _visible_prefader_processors = 0;
2676         fader_seen = false;
2677
2678         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2679                                                &_visible_prefader_processors, &fader_seen));
2680
2681         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2682         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2683         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2684
2685         setup_entry_positions ();
2686 }
2687
2688 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2689  *  not already have one.
2690  */
2691 void
2692 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2693 {
2694         boost::shared_ptr<Processor> p = w.lock ();
2695         if (!p) {
2696                 return;
2697         }
2698         if (p->window_proxy()) {
2699                 return;
2700         }
2701
2702         /* not on the list; add it */
2703
2704         string loc;
2705 #if 0 // is this still needed? Why?
2706         if (_parent_strip) {
2707                 if (_parent_strip->mixer_owned()) {
2708                         loc = X_("M");
2709                 } else {
2710                         loc = X_("R");
2711                 }
2712         } else {
2713                 loc = X_("P");
2714         }
2715 #else
2716         loc = X_("P");
2717 #endif
2718
2719         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2720                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2721                 this,
2722                 w);
2723
2724         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2725
2726         if (ui_xml) {
2727                 wp->set_state (*ui_xml, 0);
2728         }
2729
2730         void* existing_ui = p->get_ui ();
2731
2732         if (existing_ui) {
2733                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2734         }
2735
2736         p->set_window_proxy (wp);
2737         WM::Manager::instance().register_window (wp);
2738 }
2739
2740 void
2741 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2742 {
2743         boost::shared_ptr<Processor> p = w.lock ();
2744         if (!p || p->pinmgr_proxy ()) {
2745                 return;
2746         }
2747
2748         PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2749                         string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2750         wp->set_session (_session);
2751
2752         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2753         if (ui_xml) {
2754                 wp->set_state (*ui_xml, 0);
2755         }
2756
2757         p->set_pingmgr_proxy (wp);
2758         WM::Manager::instance().register_window (wp);
2759 }
2760 void
2761 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2762 {
2763         boost::shared_ptr<Processor> processor (p.lock ());
2764
2765         if (processor && ( processor->display_to_user()
2766 #ifndef NDEBUG
2767                             || show_all_processors
2768 #endif
2769                          )
2770            ) {
2771
2772                 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2773                     boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2774                         *amp_seen = true;
2775                 } else {
2776                         if (!*amp_seen) {
2777                                 (*cnt)++;
2778                         }
2779                 }
2780         }
2781 }
2782
2783 void
2784 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2785 {
2786         boost::shared_ptr<Processor> processor (p.lock ());
2787
2788         if (!processor || ( !processor->display_to_user()
2789 #ifndef NDEBUG
2790                             && !show_all_processors
2791 #endif
2792                           )
2793            ) {
2794                 return;
2795         }
2796
2797         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2798
2799         ProcessorEntry* e = 0;
2800         if (plugin_insert) {
2801                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2802         } else {
2803                 e = new ProcessorEntry (this, processor, _width);
2804         }
2805
2806         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2807         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2808         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2809
2810         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2811         if (!send && !plugin_insert && !ext && !stub)
2812                 e->set_selectable(false);
2813
2814         bool mark_send_visible = false;
2815         if (send && _parent_strip) {
2816                 /* show controls of new sends by default */
2817                 GUIObjectState& st = _parent_strip->gui_object_state ();
2818                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2819                 assert (strip);
2820                 /* check if state exists, if not it must be a new send */
2821                 if (!st.get_node(strip, e->state_id())) {
2822                         mark_send_visible = true;
2823                 }
2824         }
2825
2826         /* Set up this entry's state from the GUIObjectState */
2827         XMLNode* proc = entry_gui_object_state (e);
2828         if (proc) {
2829                 e->set_control_state (proc);
2830         }
2831
2832         if (mark_send_visible) {
2833                 e->show_all_controls ();
2834         }
2835
2836         if (plugin_insert
2837 #ifdef MIXBUS
2838                         && !plugin_insert->plugin(0)->is_channelstrip()
2839 #endif
2840                  )
2841         {
2842                 processor_display.add_child (e, drag_targets());
2843         } else {
2844                 processor_display.add_child (e, drag_targets_noplugin());
2845         }
2846 }
2847
2848 void
2849 ProcessorBox::reordered ()
2850 {
2851         compute_processor_sort_keys ();
2852         setup_entry_positions ();
2853 }
2854
2855 void
2856 ProcessorBox::setup_routing_feeds ()
2857 {
2858         list<ProcessorEntry*> children = processor_display.children ();
2859         /* first set the i/o maps for every processor */
2860         list<ProcessorEntry*>::iterator prev = children.begin();
2861
2862         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2863                 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2864                 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2865
2866                 list<ProcessorEntry*>::iterator next = i;
2867                 next++;
2868
2869                 if (pi) {
2870                         ChanCount sinks = pi->natural_input_streams ();
2871                         ChanCount sources = pi->natural_output_streams ();
2872                         uint32_t count = pi->get_count ();
2873                         ChanCount in, out;
2874                         pi->configured_io (in, out);
2875
2876                         ChanCount midi_thru;
2877                         ChanCount midi_bypass;
2878                         ChanMapping input_map (pi->input_map ());
2879                         if (pi->has_midi_thru ()) {
2880                                  midi_thru.set(DataType::MIDI, 1);
2881                                  input_map.set (DataType::MIDI, 0, 0);
2882                         }
2883                         if (pi->has_midi_bypass ()) {
2884                                  midi_bypass.set(DataType::MIDI, 1);
2885                         }
2886
2887                         (*i)->input_icon.set_ports (sinks * count + midi_thru);
2888                         (*i)->output_icon.set_ports (sources * count + midi_bypass);
2889
2890                         (*i)->routing_icon.set (
2891                                         in, out,
2892                                         sinks * count + midi_thru,
2893                                         sources * count + midi_bypass,
2894                                         input_map,
2895                                         pi->output_map (),
2896                                         pi->thru_map ());
2897
2898                         if (next != children.end()) {
2899                                 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2900                                                 pi->output_map (), pi->thru_map ());
2901                         }
2902
2903                         if (prev != i) {
2904                                 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2905                                                 pi->input_map (), pi->thru_map ());
2906                         }
2907
2908                 } else {
2909                         (*i)->input_icon.set_ports (p->input_streams());
2910                         (*i)->output_icon.set_ports (p->output_streams());
2911                         ChanMapping inmap (p->input_streams ());
2912                         ChanMapping outmap (p->input_streams ());
2913                         ChanMapping thrumap;
2914                         (*i)->routing_icon.set (
2915                                         p->input_streams(),
2916                                         p->output_streams(),
2917                                         p->input_streams(),
2918                                         p->output_streams(),
2919                                         inmap, outmap, thrumap);
2920
2921                         if (next != children.end()) {
2922                                 (*next)->routing_icon.set_fed_by (
2923                                                 p->output_streams(),
2924                                                 p->output_streams(),
2925                                                 outmap, thrumap);
2926                         }
2927                         if (prev != i) {
2928                                 (*prev)->routing_icon.set_feeding (
2929                                                 p->input_streams(),
2930                                                 p->output_streams(),
2931                                                 inmap, thrumap);
2932                         }
2933                 }
2934
2935                 if (i == children.begin()) {
2936                         (*i)->routing_icon.unset_fed_by ();
2937                 }
2938                 prev = i;
2939                 (*i)->input_icon.hide();
2940         }
2941
2942         /* now set which icons need to be displayed */
2943         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2944                 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2945
2946                 if ((*i)->routing_icon.in_identity ()) {
2947                         (*i)->routing_icon.hide();
2948                         if (i == children.begin()) {
2949                                 (*i)->input_icon.show();
2950                         }
2951                 } else {
2952                         (*i)->routing_icon.show();
2953                         (*i)->routing_icon.queue_draw();
2954                         (*i)->input_icon.show();
2955                 }
2956
2957                 list<ProcessorEntry*>::iterator next = i;
2958                 if (++next == children.end()) {
2959                         // last processor in the chain
2960                         (*i)->output_routing_icon.set_terminal(true);
2961                         (*i)->output_routing_icon.unset_feeding ();
2962                         if ((*i)->routing_icon.out_identity ()) {
2963                                 (*i)->output_routing_icon.hide();
2964                         } else {
2965                                 (*i)->output_routing_icon.show();
2966                                 (*i)->output_routing_icon.queue_draw();
2967                         }
2968                 } else {
2969                         (*i)->output_routing_icon.set_terminal(false);
2970                         if (   !(*i)->routing_icon.out_identity ()
2971                                         && !(*next)->routing_icon.in_identity ()
2972                                         &&  (*next)->routing_icon.can_coalesce ()) {
2973                                 (*i)->output_routing_icon.hide();
2974                         } else if (!(*i)->routing_icon.out_identity ()) {
2975                                 (*i)->output_routing_icon.show();
2976                                 (*i)->output_routing_icon.queue_draw();
2977                                 (*next)->input_icon.show();
2978                         } else {
2979                                 (*i)->output_routing_icon.hide();
2980                         }
2981                 }
2982         }
2983 }
2984
2985 void
2986 ProcessorBox::setup_entry_positions ()
2987 {
2988         list<ProcessorEntry*> children = processor_display.children ();
2989         bool pre_fader = true;
2990
2991         uint32_t num = 0;
2992         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2993                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2994                     boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2995                         pre_fader = false;
2996                         (*i)->set_position (ProcessorEntry::Fader, num++);
2997                 } else {
2998                         if (pre_fader) {
2999                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
3000                         } else {
3001                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
3002                         }
3003                 }
3004         }
3005         setup_routing_feeds ();
3006 }
3007
3008 void
3009 ProcessorBox::compute_processor_sort_keys ()
3010 {
3011         list<ProcessorEntry*> children = processor_display.children ();
3012         Route::ProcessorList our_processors;
3013
3014         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
3015                 if ((*i)->processor()) {
3016                         our_processors.push_back ((*i)->processor ());
3017                 }
3018         }
3019
3020         if (_route->reorder_processors (our_processors)) {
3021                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
3022                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
3023                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
3024                    when the drag is torn down after this handler function is finished.
3025                 */
3026                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
3027         }
3028 }
3029
3030 void
3031 ProcessorBox::report_failed_reorder ()
3032 {
3033         /* reorder failed, so redisplay */
3034
3035         redisplay_processors ();
3036
3037         /* now tell them about the problem */
3038
3039         ArdourDialog dialog (_("Plugin Incompatibility"));
3040         Label label;
3041
3042         label.set_text (_("\
3043 You cannot reorder these plugins/sends/inserts\n\
3044 in that way because the inputs and\n\
3045 outputs will not work correctly."));
3046
3047         dialog.get_vbox()->set_border_width (12);
3048         dialog.get_vbox()->pack_start (label);
3049         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
3050
3051         dialog.set_name (X_("PluginIODialog"));
3052         dialog.set_modal (true);
3053         dialog.show_all ();
3054
3055         dialog.run ();
3056 }
3057
3058 void
3059 ProcessorBox::rename_processors ()
3060 {
3061         ProcSelection to_be_renamed;
3062
3063         get_selected_processors (to_be_renamed);
3064
3065         if (to_be_renamed.empty()) {
3066                 return;
3067         }
3068
3069         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3070                 rename_processor (*i);
3071         }
3072 }
3073
3074 bool
3075 ProcessorBox::can_cut () const
3076 {
3077         vector<boost::shared_ptr<Processor> > sel;
3078
3079         get_selected_processors (sel);
3080
3081         /* cut_processors () does not cut inserts */
3082
3083         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3084
3085                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3086                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3087                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3088                         return true;
3089                 }
3090         }
3091
3092         return false;
3093 }
3094
3095 bool
3096 ProcessorBox::stub_processor_selected () const
3097 {
3098         vector<boost::shared_ptr<Processor> > sel;
3099
3100         get_selected_processors (sel);
3101
3102         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3103                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3104                         return true;
3105                 }
3106         }
3107
3108         return false;
3109 }
3110
3111 void
3112 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3113 {
3114         if (to_be_removed.empty()) {
3115                 return;
3116         }
3117
3118         XMLNode* node = new XMLNode (X_("cut"));
3119         Route::ProcessorList to_cut;
3120
3121         no_processor_redisplay = true;
3122         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3123                 // Cut only plugins, sends and returns
3124                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3125                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3126                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3127
3128                         Window* w = get_processor_ui (*i);
3129
3130                         if (w) {
3131                                 w->hide ();
3132                         }
3133
3134                         XMLNode& child ((*i)->get_state());
3135                         node->add_child_nocopy (child);
3136                         to_cut.push_back (*i);
3137                 }
3138         }
3139
3140         if (_route->remove_processors (to_cut) != 0) {
3141                 delete node;
3142                 no_processor_redisplay = false;
3143                 return;
3144         }
3145
3146         _rr_selection.set (node);
3147
3148         no_processor_redisplay = false;
3149         redisplay_processors ();
3150 }
3151
3152 void
3153 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3154 {
3155         if (to_be_copied.empty()) {
3156                 return;
3157         }
3158
3159         XMLNode* node = new XMLNode (X_("copy"));
3160
3161         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3162                 // Copy only plugins, sends, returns
3163                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3164                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3165                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3166                         node->add_child_nocopy ((*i)->get_state());
3167                 }
3168         }
3169
3170         _rr_selection.set (node);
3171 }
3172
3173 void
3174 ProcessorBox::delete_processors (const ProcSelection& targets)
3175 {
3176         if (targets.empty()) {
3177                 return;
3178         }
3179
3180         no_processor_redisplay = true;
3181
3182         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3183
3184                 Window* w = get_processor_ui (*i);
3185
3186                 if (w) {
3187                         w->hide ();
3188                 }
3189
3190                 _route->remove_processor(*i);
3191         }
3192
3193         no_processor_redisplay = false;
3194         redisplay_processors ();
3195 }
3196
3197 void
3198 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3199 {
3200         list<boost::shared_ptr<Processor> >::const_iterator x;
3201
3202         no_processor_redisplay = true;
3203         for (x = procs.begin(); x != procs.end(); ++x) {
3204
3205                 Window* w = get_processor_ui (*x);
3206
3207                 if (w) {
3208                         w->hide ();
3209                 }
3210
3211                 _route->remove_processor(*x);
3212         }
3213
3214         no_processor_redisplay = false;
3215         redisplay_processors ();
3216 }
3217
3218 gint
3219 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3220 {
3221         boost::shared_ptr<Processor> processor (weak_processor.lock());
3222
3223         if (!processor) {
3224                 return false;
3225         }
3226
3227         /* NOT copied to _mixer.selection() */
3228
3229         no_processor_redisplay = true;
3230         _route->remove_processor (processor);
3231         no_processor_redisplay = false;
3232         redisplay_processors ();
3233
3234         return false;
3235 }
3236
3237 void
3238 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3239 {
3240         ArdourPrompter name_prompter (true);
3241         string result;
3242         name_prompter.set_title (_("Rename Processor"));
3243         name_prompter.set_prompt (_("New name:"));
3244         name_prompter.set_initial_text (processor->name());
3245         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3246         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3247         name_prompter.show_all ();
3248
3249         switch (name_prompter.run ()) {
3250
3251         case Gtk::RESPONSE_ACCEPT:
3252                 name_prompter.get_result (result);
3253                 if (result.length()) {
3254
3255                        int tries = 0;
3256                        string test = result;
3257
3258                        while (tries < 100) {
3259                                if (_session->io_name_is_legal (test)) {
3260                                        result = test;
3261                                        break;
3262                                }
3263                                tries++;
3264
3265                                test = string_compose ("%1-%2", result, tries);
3266                        }
3267
3268                        if (tries < 100) {
3269                                processor->set_name (result);
3270                        } else {
3271                                /* unlikely! */
3272                                ARDOUR_UI::instance()->popup_error
3273                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3274                        }
3275                 }
3276                 break;
3277         }
3278
3279         return;
3280 }
3281
3282 void
3283 ProcessorBox::paste_processors ()
3284 {
3285         if (_rr_selection.processors.empty()) {
3286                 return;
3287         }
3288
3289         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3290 }
3291
3292 void
3293 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3294 {
3295
3296         if (_rr_selection.processors.empty()) {
3297                 return;
3298         }
3299
3300         paste_processor_state (_rr_selection.processors.get_node().children(), before);
3301 }
3302
3303 void
3304 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3305 {
3306         XMLNodeConstIterator niter;
3307         list<boost::shared_ptr<Processor> > copies;
3308
3309         if (nlist.empty()) {
3310                 return;
3311         }
3312
3313         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3314
3315                 XMLProperty const * type = (*niter)->property ("type");
3316                 XMLProperty const * role = (*niter)->property ("role");
3317                 assert (type);
3318
3319                 boost::shared_ptr<Processor> p;
3320                 try {
3321                         if (type->value() == "meter" ||
3322                             type->value() == "main-outs" ||
3323                             type->value() == "amp" ||
3324                             type->value() == "intreturn") {
3325                                 /* do not paste meter, main outs, amp or internal returns */
3326                                 continue;
3327
3328                         } else if (type->value() == "intsend") {
3329
3330                                 /* aux sends are OK, but those used for
3331                                  * other purposes, are not.
3332                                  */
3333
3334                                 assert (role);
3335
3336                                 if (role->value() != "Aux") {
3337                                         continue;
3338                                 }
3339
3340                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3341                                 XMLNode n (**niter);
3342                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3343                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3344
3345                                 IOProcessor::prepare_for_reset (n, s->name());
3346
3347                                 if (s->set_state (n, Stateful::loading_state_version)) {
3348                                         delete s;
3349                                         return;
3350                                 }
3351
3352                                 p.reset (s);
3353
3354                         } else if (type->value() == "send") {
3355
3356                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3357                                 XMLNode n (**niter);
3358
3359                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3360
3361                                 IOProcessor::prepare_for_reset (n, s->name());
3362
3363                                 if (s->set_state (n, Stateful::loading_state_version)) {
3364                                         delete s;
3365                                         return;
3366                                 }
3367
3368                                 p.reset (s);
3369
3370                         } else if (type->value() == "return") {
3371
3372                                 XMLNode n (**niter);
3373                                 Return* r = new Return (*_session);
3374
3375                                 IOProcessor::prepare_for_reset (n, r->name());
3376
3377                                 if (r->set_state (n, Stateful::loading_state_version)) {
3378                                         delete r;
3379                                         return;
3380                                 }
3381
3382                                 p.reset (r);
3383
3384                         } else if (type->value() == "port") {
3385
3386                                 XMLNode n (**niter);
3387                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3388
3389                                 IOProcessor::prepare_for_reset (n, pi->name());
3390
3391                                 if (pi->set_state (n, Stateful::loading_state_version)) {
3392                                         return;
3393                                 }
3394
3395                                 p.reset (pi);
3396                         } else {
3397                                 /* XXX its a bit limiting to assume that everything else
3398                                    is a plugin.
3399                                 */
3400                                 p.reset (new PluginInsert (*_session));
3401                                 /* we can't use RAII Stateful::ForceIDRegeneration
3402                                  * because that'd void copying the state and wrongly bump
3403                                  * the state-version counter.
3404                                  * we need to load the state (incl external files) first and
3405                                  * only then update the ID)
3406                                  */
3407                                 PBD::ID id = p->id();
3408                                 /* strip side-chain state (processor inside processor must be a side-chain)
3409                                  * otherwise we'll end up with duplicate ports-names.
3410                                  * (this needs a better solution which retains connections)
3411                                  * We really would want Stateful::ForceIDRegeneration here :(
3412                                  */
3413                                 XMLNode state (**niter);
3414                                 state.remove_nodes ("Processor");
3415
3416                                 p->set_state (state, Stateful::current_state_version);
3417                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3418                         }
3419
3420                         copies.push_back (p);
3421                 }
3422
3423                 catch (...) {
3424                         error << _("plugin insert constructor failed") << endmsg;
3425                 }
3426         }
3427
3428         if (copies.empty()) {
3429                 return;
3430         }
3431
3432         if (_route->add_processors (copies, p)) {
3433
3434                 string msg = _(
3435                         "Copying the set of processors on the clipboard failed,\n\
3436 probably because the I/O configuration of the plugins\n\
3437 could not match the configuration of this track.");
3438                 MessageDialog am (msg);
3439                 am.run ();
3440         }
3441 }
3442
3443 void
3444 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3445 {
3446         const list<ProcessorEntry*> selection = processor_display.selection ();
3447         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3448                 processors.push_back ((*i)->processor ());
3449         }
3450 }
3451
3452 void
3453 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3454 {
3455         list<ProcessorEntry*> selection = processor_display.selection ();
3456         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3457                 (this->*method) ((*i)->processor ());
3458         }
3459 }
3460
3461 void
3462 ProcessorBox::all_visible_processors_active (bool state)
3463 {
3464         _route->all_visible_processors_active (state);
3465 }
3466
3467 void
3468 ProcessorBox::ab_plugins ()
3469 {
3470         _route->ab_plugins (ab_direction);
3471         ab_direction = !ab_direction;
3472 }
3473
3474
3475 void
3476 ProcessorBox::clear_processors ()
3477 {
3478         string prompt;
3479         vector<string> choices;
3480
3481         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3482                                    "(this cannot be undone)"), _route->name());
3483
3484         choices.push_back (_("Cancel"));
3485         choices.push_back (_("Yes, remove them all"));
3486
3487         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3488
3489         if (prompter.run () == 1) {
3490                 _route->clear_processors (PreFader);
3491                 _route->clear_processors (PostFader);
3492         }
3493 }
3494
3495 void
3496 ProcessorBox::clear_processors (Placement p)
3497 {
3498         string prompt;
3499         vector<string> choices;
3500
3501         if (p == PreFader) {
3502                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3503                                            "(this cannot be undone)"), _route->name());
3504         } else {
3505                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3506                                            "(this cannot be undone)"), _route->name());
3507         }
3508
3509         choices.push_back (_("Cancel"));
3510         choices.push_back (_("Yes, remove them all"));
3511
3512         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3513
3514         if (prompter.run () == 1) {
3515                 _route->clear_processors (p);
3516         }
3517 }
3518
3519 bool
3520 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3521 {
3522         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3523         if (at && at->freeze_state() == AudioTrack::Frozen) {
3524                 return false;
3525         }
3526
3527         if (
3528                 boost::dynamic_pointer_cast<Send> (processor) ||
3529                 boost::dynamic_pointer_cast<Return> (processor) ||
3530                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3531                 boost::dynamic_pointer_cast<PortInsert> (processor)
3532                 ) {
3533                 return true;
3534         }
3535
3536         return false;
3537 }
3538
3539 bool
3540 ProcessorBox::one_processor_can_be_edited ()
3541 {
3542         list<ProcessorEntry*> selection = processor_display.selection ();
3543         list<ProcessorEntry*>::iterator i = selection.begin();
3544         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3545                 ++i;
3546         }
3547
3548         return (i != selection.end());
3549 }
3550
3551 Gtk::Window*
3552 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3553 {
3554         boost::shared_ptr<Send> send;
3555         boost::shared_ptr<InternalSend> internal_send;
3556         boost::shared_ptr<Return> retrn;
3557         boost::shared_ptr<PluginInsert> plugin_insert;
3558         boost::shared_ptr<PortInsert> port_insert;
3559         Window* gidget = 0;
3560
3561         /* This method may or may not return a Window, but if it does not it
3562          * will modify the parent mixer strip appearance layout to allow
3563          * "editing" the @param processor that was passed in.
3564          *
3565          * So for example, if the processor is an Amp (gain), the parent strip
3566          * will be forced back into a model where the fader controls the main gain.
3567          * If the processor is a send, then we map the send controls onto the
3568          * strip.
3569          *
3570          * Plugins and others will return a window for control.
3571          */
3572
3573         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3574
3575                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3576                         return 0;
3577                 }
3578         }
3579
3580         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3581
3582                 if (_parent_strip) {
3583                         _parent_strip->revert_to_default_display ();
3584                 }
3585
3586         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3587
3588                 if (!_session->engine().connected()) {
3589                         return 0;
3590                 }
3591
3592                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3593
3594                         gidget = new SendUIWindow (send, _session);
3595                 }
3596
3597         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3598
3599                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3600                         /* no GUI for these */
3601                         return 0;
3602                 }
3603
3604                 if (!_session->engine().connected()) {
3605                         return 0;
3606                 }
3607
3608                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3609
3610                 ReturnUIWindow *return_ui;
3611                 Window* w = get_processor_ui (retrn);
3612
3613                 if (w == 0) {
3614
3615                         return_ui = new ReturnUIWindow (retrn, _session);
3616                         return_ui->set_title (retrn->name ());
3617                         set_processor_ui (send, return_ui);
3618
3619                 } else {
3620                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
3621                 }
3622
3623                 gidget = return_ui;
3624
3625         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3626
3627                 PluginUIWindow *plugin_ui;
3628
3629                 /* these are both allowed to be null */
3630
3631                 Window* w = get_processor_ui (plugin_insert);
3632
3633                 if (w == 0) {
3634                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3635                         plugin_ui->set_title (generate_processor_title (plugin_insert));
3636                         set_processor_ui (plugin_insert, plugin_ui);
3637
3638                 } else {
3639                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3640                 }
3641
3642                 gidget = plugin_ui;
3643
3644         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3645
3646                 if (!_session->engine().connected()) {
3647                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3648                         msg.run ();
3649                         return 0;
3650                 }
3651
3652                 PortInsertWindow *io_selector;
3653
3654                 Window* w = get_processor_ui (port_insert);
3655
3656                 if (w == 0) {
3657                         io_selector = new PortInsertWindow (_session, port_insert);
3658                         set_processor_ui (port_insert, io_selector);
3659
3660                 } else {
3661                         io_selector = dynamic_cast<PortInsertWindow *> (w);
3662                 }
3663
3664                 gidget = io_selector;
3665         }
3666
3667         return gidget;
3668 }
3669
3670 Gtk::Window*
3671 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3672 {
3673         boost::shared_ptr<PluginInsert> plugin_insert
3674                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3675
3676         if (!plugin_insert) {
3677                 return 0;
3678         }
3679
3680         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3681         win->set_title (generate_processor_title (plugin_insert));
3682
3683         return win;
3684 }
3685
3686 void
3687 ProcessorBox::register_actions ()
3688 {
3689         processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3690
3691         Glib::RefPtr<Action> act;
3692
3693         /* new stuff */
3694         myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3695                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3696
3697         act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3698                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3699         ActionManager::engine_sensitive_actions.push_back (act);
3700         act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3701                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
3702         ActionManager::engine_sensitive_actions.push_back (act);
3703
3704         myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3705
3706         myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3707         myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3708
3709         myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3710                         sigc::ptr_fun (ProcessorBox::rb_clear));
3711         myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3712                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3713         myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3714                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
3715
3716         /* standard editing stuff */
3717
3718         cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3719                                                             sigc::ptr_fun (ProcessorBox::rb_cut));
3720         copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3721                                                              sigc::ptr_fun (ProcessorBox::rb_copy));
3722         delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3723                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3724         backspace_action = myactions.register_action (processor_box_actions, X_("backspace"), _("Delete"),
3725                                                                sigc::ptr_fun (ProcessorBox::rb_delete));
3726
3727         ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3728         ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3729         ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3730         ActionManager::plugin_selection_sensitive_actions.push_back (backspace_action);
3731
3732         paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3733                         sigc::ptr_fun (ProcessorBox::rb_paste));
3734         rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3735                         sigc::ptr_fun (ProcessorBox::rb_rename));
3736         myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3737                         sigc::ptr_fun (ProcessorBox::rb_select_all));
3738         myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3739                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3740
3741         /* activation etc. */
3742
3743         myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3744                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
3745         myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3746                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3747         myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3748                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3749
3750         manage_pins_action = myactions.register_action (
3751                 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3752                 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3753
3754         /* show editors */
3755         edit_action = myactions.register_action (
3756                 processor_box_actions, X_("edit"), _("Edit..."),
3757                 sigc::ptr_fun (ProcessorBox::rb_edit));
3758
3759         edit_generic_action = myactions.register_action (
3760                 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3761                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3762
3763         load_bindings ();
3764 }
3765
3766 void
3767 ProcessorBox::rb_edit_generic ()
3768 {
3769         if (_current_processor_box == 0) {
3770                 return;
3771         }
3772
3773         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3774 }
3775
3776 void
3777 ProcessorBox::rb_ab_plugins ()
3778 {
3779         if (_current_processor_box == 0) {
3780                 return;
3781         }
3782
3783         _current_processor_box->ab_plugins ();
3784 }
3785
3786 void
3787 ProcessorBox::rb_manage_pins ()
3788 {
3789         if (_current_processor_box == 0) {
3790                 return;
3791         }
3792
3793         _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3794 }
3795 void
3796 ProcessorBox::rb_choose_plugin ()
3797 {
3798         if (_current_processor_box == 0) {
3799                 return;
3800         }
3801         _current_processor_box->choose_plugin ();
3802 }
3803
3804 void
3805 ProcessorBox::rb_choose_insert ()
3806 {
3807         if (_current_processor_box == 0) {
3808                 return;
3809         }
3810         _current_processor_box->choose_insert ();
3811 }
3812
3813 void
3814 ProcessorBox::rb_choose_send ()
3815 {
3816         if (_current_processor_box == 0) {
3817                 return;
3818         }
3819         _current_processor_box->choose_send ();
3820 }
3821
3822 void
3823 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3824 {
3825         if (_current_processor_box == 0) {
3826                 return;
3827         }
3828
3829         _current_processor_box->choose_aux (wr);
3830 }
3831
3832 void
3833 ProcessorBox::rb_clear ()
3834 {
3835         if (_current_processor_box == 0) {
3836                 return;
3837         }
3838
3839         _current_processor_box->clear_processors ();
3840 }
3841
3842
3843 void
3844 ProcessorBox::rb_clear_pre ()
3845 {
3846         if (_current_processor_box == 0) {
3847                 return;
3848         }
3849
3850         _current_processor_box->clear_processors (PreFader);
3851 }
3852
3853
3854 void
3855 ProcessorBox::rb_clear_post ()
3856 {
3857         if (_current_processor_box == 0) {
3858                 return;
3859         }
3860
3861         _current_processor_box->clear_processors (PostFader);
3862 }
3863
3864 void
3865 ProcessorBox::rb_cut ()
3866 {
3867         if (_current_processor_box == 0) {
3868                 return;
3869         }
3870
3871         _current_processor_box->processor_operation (ProcessorsCut);
3872 }
3873
3874 void
3875 ProcessorBox::rb_delete ()
3876 {
3877         if (_current_processor_box == 0) {
3878                 return;
3879         }
3880
3881         _current_processor_box->processor_operation (ProcessorsDelete);
3882 }
3883
3884 void
3885 ProcessorBox::rb_copy ()
3886 {
3887         if (_current_processor_box == 0) {
3888                 return;
3889         }
3890         _current_processor_box->processor_operation (ProcessorsCopy);
3891 }
3892
3893 void
3894 ProcessorBox::rb_paste ()
3895 {
3896         if (_current_processor_box == 0) {
3897                 return;
3898         }
3899
3900         _current_processor_box->processor_operation (ProcessorsPaste);
3901 }
3902
3903 void
3904 ProcessorBox::rb_rename ()
3905 {
3906         if (_current_processor_box == 0) {
3907                 return;
3908         }
3909         _current_processor_box->rename_processors ();
3910 }
3911
3912 void
3913 ProcessorBox::rb_select_all ()
3914 {
3915         if (_current_processor_box == 0) {
3916                 return;
3917         }
3918
3919         _current_processor_box->processor_operation (ProcessorsSelectAll);
3920 }
3921
3922 void
3923 ProcessorBox::rb_deselect_all ()
3924 {
3925         if (_current_processor_box == 0) {
3926                 return;
3927         }
3928
3929         _current_processor_box->deselect_all_processors ();
3930 }
3931
3932 void
3933 ProcessorBox::rb_activate_all ()
3934 {
3935         if (_current_processor_box == 0) {
3936                 return;
3937         }
3938
3939         _current_processor_box->all_visible_processors_active (true);
3940 }
3941
3942 void
3943 ProcessorBox::rb_deactivate_all ()
3944 {
3945         if (_current_processor_box == 0) {
3946                 return;
3947         }
3948         _current_processor_box->all_visible_processors_active (false);
3949 }
3950
3951 void
3952 ProcessorBox::rb_edit ()
3953 {
3954         if (_current_processor_box == 0) {
3955                 return;
3956         }
3957
3958         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3959 }
3960
3961 bool
3962 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3963 {
3964         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3965                 return false;
3966         }
3967
3968         if (_parent_strip) {
3969                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3970                 if (_parent_strip->current_delivery() == send) {
3971                         _parent_strip->revert_to_default_display ();
3972                 } else {
3973                         _parent_strip->show_send(send);
3974                 }
3975         }
3976         return true;
3977 }
3978
3979 void
3980 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3981 {
3982         if (!processor) {
3983                 return;
3984         }
3985         if (edit_aux_send (processor)) {
3986                 return;
3987         }
3988         if (!_session->engine().connected()) {
3989                 return;
3990         }
3991
3992         ProcessorWindowProxy* proxy = find_window_proxy (processor);
3993
3994         if (proxy) {
3995                 proxy->set_custom_ui_mode (true);
3996                 proxy->show_the_right_window ();
3997         }
3998 }
3999
4000 void
4001 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
4002 {
4003         if (!processor) {
4004                 return;
4005         }
4006         if (edit_aux_send (processor)) {
4007                 return;
4008         }
4009         if (!_session->engine().connected()) {
4010                 return;
4011         }
4012
4013         ProcessorWindowProxy* proxy = find_window_proxy (processor);
4014
4015         if (proxy) {
4016                 proxy->set_custom_ui_mode (false);
4017                 proxy->show_the_right_window ();
4018         }
4019 }
4020
4021 void
4022 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
4023 {
4024         if (!processor) {
4025                 return;
4026         }
4027         PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
4028         if (proxy) {
4029                 proxy->get (true);
4030                 proxy->present();
4031         }
4032 }
4033
4034
4035 void
4036 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
4037 {
4038         if (!what_changed.contains (ARDOUR::Properties::name)) {
4039                 return;
4040         }
4041
4042         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
4043
4044         boost::shared_ptr<Processor> processor;
4045         boost::shared_ptr<PluginInsert> plugin_insert;
4046         boost::shared_ptr<Send> send;
4047
4048         list<ProcessorEntry*> children = processor_display.children();
4049
4050         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
4051
4052                 processor = (*iter)->processor ();
4053
4054                 if (!processor) {
4055                         continue;
4056                 }
4057
4058                 Window* w = get_processor_ui (processor);
4059
4060                 if (!w) {
4061                         continue;
4062                 }
4063
4064                 /* rename editor windows for sends and plugins */
4065
4066                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4067                         w->set_title (send->name ());
4068                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4069                         w->set_title (generate_processor_title (plugin_insert));
4070                 }
4071         }
4072 }
4073
4074 string
4075 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4076 {
4077         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4078         string::size_type email_pos;
4079
4080         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4081                 maker = maker.substr (0, email_pos - 1);
4082         }
4083
4084         if (maker.length() > 32) {
4085                 maker = maker.substr (0, 32);
4086                 maker += " ...";
4087         }
4088
4089         SessionObject* owner = pi->owner();
4090
4091         if (owner) {
4092                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4093         } else {
4094                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4095         }
4096 }
4097
4098 /** @param p Processor.
4099  *  @return the UI window for \a p.
4100  */
4101 Window *
4102 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4103 {
4104         ProcessorWindowProxy* wp = p->window_proxy();
4105         if (wp) {
4106                 return wp->get ();
4107         }
4108         return 0;
4109 }
4110
4111 /** Make a note of the UI window that a processor is using.
4112  *  @param p Processor.
4113  *  @param w UI window.
4114  */
4115 void
4116 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4117 {
4118         assert (p->window_proxy());
4119         p->set_ui (w);
4120         p->window_proxy()->use_window (*w);
4121 }
4122
4123 void
4124 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4125 {
4126         boost::shared_ptr<Delivery> d = w.lock ();
4127         if (!d) {
4128                 return;
4129         }
4130
4131         list<ProcessorEntry*> children = processor_display.children ();
4132         list<ProcessorEntry*>::const_iterator i = children.begin();
4133         while (i != children.end() && (*i)->processor() != d) {
4134                 ++i;
4135         }
4136
4137         if (i == children.end()) {
4138                 processor_display.set_active (0);
4139         } else {
4140                 processor_display.set_active (*i);
4141         }
4142 }
4143
4144 /** Called to repair the damage of Editor::show_window doing a show_all() */
4145 void
4146 ProcessorBox::hide_things ()
4147 {
4148         list<ProcessorEntry*> c = processor_display.children ();
4149         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4150                 (*i)->hide_things ();
4151         }
4152 }
4153
4154 void
4155 ProcessorBox::processor_menu_unmapped ()
4156 {
4157         processor_display.remove_placeholder ();
4158         /* make all possibly-desensitized actions sensitive again so that
4159            they be activated by other means (e.g. bindings)
4160         */
4161         ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4162 }
4163
4164 XMLNode *
4165 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4166 {
4167         if (!_parent_strip) {
4168                 return 0;
4169         }
4170
4171         GUIObjectState& st = _parent_strip->gui_object_state ();
4172
4173         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4174         assert (strip);
4175         return st.get_or_add_node (strip, entry->state_id());
4176 }
4177
4178 void
4179 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4180 {
4181         XMLNode* proc = entry_gui_object_state (entry);
4182         if (!proc) {
4183                 return;
4184         }
4185
4186         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4187         proc->remove_nodes_and_delete (X_("Object"));
4188         entry->add_control_state (proc);
4189 }
4190
4191 bool
4192 ProcessorBox::is_editor_mixer_strip() const
4193 {
4194         return _parent_strip && !_parent_strip->mixer_owned();
4195 }
4196
4197 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4198         : WM::ProxyBase (name, string())
4199         , _processor_box (box)
4200         , _processor (processor)
4201         , is_custom (false)
4202         , want_custom (false)
4203 {
4204         boost::shared_ptr<Processor> p = _processor.lock ();
4205         if (!p) {
4206                 return;
4207         }
4208         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4209 }
4210
4211 ProcessorWindowProxy::~ProcessorWindowProxy()
4212 {
4213         /* processor window proxies do not own the windows they create with
4214          * ::get(), so set _window to null before the normal WindowProxy method
4215          * deletes it.
4216          */
4217         _window = 0;
4218 }
4219
4220 void
4221 ProcessorWindowProxy::processor_going_away ()
4222 {
4223         delete _window;
4224         _window = 0;
4225         WM::Manager::instance().remove (this);
4226         /* should be no real reason to do this, since the object that would
4227            send DropReferences is about to be deleted, but lets do it anyway.
4228         */
4229         going_away_connection.disconnect();
4230 }
4231
4232 ARDOUR::SessionHandlePtr*
4233 ProcessorWindowProxy::session_handle()
4234 {
4235         /* we don't care */
4236         return 0;
4237 }
4238
4239 XMLNode&
4240 ProcessorWindowProxy::get_state ()
4241 {
4242         XMLNode *node;
4243         node = &ProxyBase::get_state();
4244         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4245         return *node;
4246 }
4247
4248 int
4249 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4250 {
4251         XMLNodeList children = node.children ();
4252         XMLNodeList::const_iterator i = children.begin ();
4253         while (i != children.end()) {
4254                 XMLProperty const * prop = (*i)->property (X_("name"));
4255                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4256                         break;
4257                 }
4258                 ++i;
4259         }
4260
4261         if (i != children.end()) {
4262                 XMLProperty const * prop;
4263                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4264                         want_custom = PBD::string_is_affirmative (prop->value ());
4265                 }
4266         }
4267
4268         return ProxyBase::set_state (node, 0);
4269 }
4270
4271 Gtk::Window*
4272 ProcessorWindowProxy::get (bool create)
4273 {
4274         boost::shared_ptr<Processor> p = _processor.lock ();
4275
4276         if (!p) {
4277                 return 0;
4278         }
4279         if (_window && (is_custom != want_custom)) {
4280                 /* drop existing window - wrong type */
4281                 drop_window ();
4282         }
4283
4284         if (!_window) {
4285                 if (!create) {
4286                         return 0;
4287                 }
4288
4289                 is_custom = want_custom;
4290                 _window = _processor_box->get_editor_window (p, is_custom);
4291
4292                 if (_window) {
4293                         setup ();
4294                 }
4295                 _window->show_all ();
4296         }
4297         return _window;
4298 }
4299
4300 void
4301 ProcessorWindowProxy::show_the_right_window ()
4302 {
4303         if (_window && (is_custom != want_custom)) {
4304                 /* drop existing window - wrong type */
4305                 drop_window ();
4306         }
4307         toggle ();
4308 }
4309
4310
4311 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4312         : WM::ProxyBase (name, string())
4313         , _processor (processor)
4314 {
4315         boost::shared_ptr<Processor> p = _processor.lock ();
4316         if (!p) {
4317                 return;
4318         }
4319         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4320 }
4321
4322 PluginPinWindowProxy::~PluginPinWindowProxy()
4323 {
4324         _window = 0;
4325 }
4326
4327 ARDOUR::SessionHandlePtr*
4328 PluginPinWindowProxy::session_handle ()
4329 {
4330         ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4331         if (aw) { return aw; }
4332         return 0;
4333 }
4334
4335 Gtk::Window*
4336 PluginPinWindowProxy::get (bool create)
4337 {
4338         boost::shared_ptr<Processor> p = _processor.lock ();
4339         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4340         if (!p || !pi) {
4341                 return 0;
4342         }
4343
4344         if (!_window) {
4345                 if (!create) {
4346                         return 0;
4347                 }
4348                 _window = new PluginPinDialog (pi);
4349                 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4350                 if (aw) {
4351                         aw->set_session (_session);
4352                 }
4353                 _window->show_all ();
4354         }
4355         return _window;
4356 }
4357
4358 void
4359 PluginPinWindowProxy::processor_going_away ()
4360 {
4361         delete _window;
4362         _window = 0;
4363         WM::Manager::instance().remove (this);
4364         going_away_connection.disconnect();
4365 }
4366
4367 void
4368 ProcessorBox::load_bindings ()
4369 {
4370         bindings = Bindings::get_bindings (X_("Processor Box"), myactions);
4371 }