gtk2_ardour/processor_box.cc

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