gtk2_ardour/processor_box.cc

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