gtk2_ardour/processor_box.cc

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