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