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