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