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