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