gtk2_ardour/processor_box.cc

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