gtk2_ardour/processor_box.cc

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