gtk2_ardour/processor_box.cc

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