gtk2_ardour/processor_box.cc

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