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