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