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