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