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