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.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::primary_modifier_name (), 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 static std::list<Gtk::TargetEntry> drop_targets()
1045 {
1046         std::list<Gtk::TargetEntry> tmp;
1047         tmp.push_back (Gtk::TargetEntry ("processor"));
1048         tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr"));
1049         return tmp;
1050 }
1051
1052 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1053                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1054         : _parent_strip (parent)
1055         , _owner_is_mixer (owner_is_mixer)
1056         , ab_direction (true)
1057         , _get_plugin_selector (get_plugin_selector)
1058         , _placement (-1)
1059         , _visible_prefader_processors (0)
1060         , _rr_selection(rsel)
1061         , processor_display (drop_targets())
1062         , _redisplay_pending (false)
1063
1064 {
1065         set_session (sess);
1066
1067         _width = Wide;
1068         processor_menu = 0;
1069         no_processor_redisplay = false;
1070
1071         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1072         processor_scroller.add (processor_display);
1073         pack_start (processor_scroller, true, true);
1074
1075         processor_display.set_flags (CAN_FOCUS);
1076         processor_display.set_name ("ProcessorList");
1077         processor_display.set_data ("processorbox", this);
1078         processor_display.set_size_request (48, -1);
1079         processor_display.set_spacing (0);
1080
1081         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1082         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1083
1084         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1085         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1086
1087         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1088         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1089         processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1090
1091         processor_scroller.show ();
1092         processor_display.show ();
1093
1094         if (parent) {
1095                 parent->DeliveryChanged.connect (
1096                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1097                         );
1098         }
1099
1100         ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1101 }
1102
1103 ProcessorBox::~ProcessorBox ()
1104 {
1105         /* it may appear as if we should delete processor_menu but that is a
1106          * pointer to a widget owned by the UI Manager, and has potentially
1107          * be returned to many other ProcessorBoxes. GTK doesn't really make
1108          * clear the ownership of this widget, which is a menu and thus is
1109          * never packed into any container other than an implict GtkWindow.
1110          *
1111          * For now, until or if we ever get clarification over the ownership
1112          * story just let it continue to exist. At worst, its a small memory leak.
1113          */
1114 }
1115
1116 void
1117 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1118 {
1119         if (_route == r) {
1120                 return;
1121         }
1122
1123         _route_connections.drop_connections();
1124
1125         /* new route: any existing block on processor redisplay must be meaningless */
1126         no_processor_redisplay = false;
1127         _route = r;
1128
1129         _route->processors_changed.connect (
1130                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1131                 );
1132
1133         _route->DropReferences.connect (
1134                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1135                 );
1136
1137         _route->PropertyChanged.connect (
1138                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1139                 );
1140
1141         redisplay_processors ();
1142 }
1143
1144 void
1145 ProcessorBox::route_going_away ()
1146 {
1147         /* don't keep updating display as processors are deleted */
1148         no_processor_redisplay = true;
1149         _route.reset ();
1150 }
1151
1152 void
1153 ProcessorBox::plugin_drop(Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1154 {
1155                 if (data.get_target() != "PluginInfoPtr") {
1156                         return;
1157                 }
1158                 if (!_session) {
1159                         return;
1160                 }
1161
1162                 boost::shared_ptr<Processor> p;
1163                 if (position) {
1164                         p = position->processor ();
1165                         if (!p) {
1166                                 /* dropped on the blank entry (which will be before the
1167                                          fader), so use the first non-blank child as our
1168                                          `dropped on' processor */
1169                                 list<ProcessorEntry*> c = processor_display.children ();
1170                                 list<ProcessorEntry*>::iterator i = c.begin ();
1171
1172                                 assert (i != c.end ());
1173                                 p = (*i)->processor ();
1174                                 assert (p);
1175                         }
1176                 }
1177
1178                 const void * d = data.get_data();
1179                 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr> * tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1180
1181                 std::list<ARDOUR::PluginInfoPtr> nfos;
1182                 TreeView* source;
1183                 tv->get_object_drag_data (nfos, &source);
1184
1185                 Route::ProcessorStreams err;
1186                 Route::ProcessorList pl;
1187
1188                 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1189                         PluginPtr p = (*i)->load (*_session);
1190                         if (!p) {
1191                                 continue;
1192                         }
1193                         boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1194                         if (Config->get_new_plugins_active ()) {
1195                                 processor->activate ();
1196                         }
1197                         pl.push_back (processor);
1198                 }
1199
1200                 if (_route->add_processors (pl, p, &err)) {
1201                         string msg = _(
1202                                         "Adding the given processor(s) failed probably,\n\
1203 because the I/O configuration of the plugins could\n\
1204 not match the configuration of this track.");
1205                         MessageDialog am (msg);
1206                         am.run ();
1207                 }
1208 }
1209
1210 void
1211 ProcessorBox::object_drop(DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1212 {
1213         boost::shared_ptr<Processor> p;
1214         if (position) {
1215                 p = position->processor ();
1216                 if (!p) {
1217                         /* dropped on the blank entry (which will be before the
1218                            fader), so use the first non-blank child as our
1219                            `dropped on' processor */
1220                         list<ProcessorEntry*> c = processor_display.children ();
1221                         list<ProcessorEntry*>::iterator i = c.begin ();
1222
1223                         assert (i != c.end ());
1224                         p = (*i)->processor ();
1225                         assert (p);
1226                 }
1227         }
1228
1229         list<ProcessorEntry*> children = source->selection ();
1230         list<boost::shared_ptr<Processor> > procs;
1231         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1232                 if ((*i)->processor ()) {
1233                         if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1234                                 continue;
1235                         }
1236                         procs.push_back ((*i)->processor ());
1237                 }
1238         }
1239
1240         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1241                 XMLNode& state = (*i)->get_state ();
1242                 XMLNodeList nlist;
1243                 nlist.push_back (&state);
1244                 paste_processor_state (nlist, p);
1245                 delete &state;
1246         }
1247
1248         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1249            ourselves.
1250         */
1251
1252         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1253                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1254                 if (other) {
1255                         other->delete_dragged_processors (procs);
1256                 }
1257         }
1258 }
1259
1260 void
1261 ProcessorBox::set_width (Width w)
1262 {
1263         if (_width == w) {
1264                 return;
1265         }
1266
1267         _width = w;
1268
1269         list<ProcessorEntry*> children = processor_display.children ();
1270         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1271                 (*i)->set_enum_width (w);
1272         }
1273
1274         queue_resize ();
1275 }
1276
1277 Gtk::Menu*
1278 ProcessorBox::build_possible_aux_menu ()
1279 {
1280         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1281
1282         if (rl->empty()) {
1283                 /* No aux sends if there are no busses */
1284                 return 0;
1285         }
1286
1287         if (_route->is_monitor ()) {
1288                 return 0;
1289         }
1290
1291         using namespace Menu_Helpers;
1292         Menu* menu = manage (new Menu);
1293         MenuList& items = menu->items();
1294
1295         for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1296                 if (!_route->internal_send_for (*r) && *r != _route) {
1297                         items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
1298                 }
1299         }
1300
1301         return menu;
1302 }
1303
1304 void
1305 ProcessorBox::show_processor_menu (int arg)
1306 {
1307         if (processor_menu == 0) {
1308                 processor_menu = build_processor_menu ();
1309                 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
1310         }
1311
1312         /* Sort out the plugin submenu */
1313
1314         Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
1315
1316         if (plugin_menu_item) {
1317                 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
1318         }
1319
1320         /* And the aux submenu */
1321
1322         Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
1323
1324         if (aux_menu_item) {
1325                 Menu* m = build_possible_aux_menu();
1326                 if (m && !m->items().empty()) {
1327                         aux_menu_item->set_submenu (*m);
1328                         aux_menu_item->set_sensitive (true);
1329                 } else {
1330                         /* stupid gtkmm: we need to pass a null reference here */
1331                         gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
1332                         aux_menu_item->set_sensitive (false);
1333                 }
1334         }
1335
1336         ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
1337         ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
1338
1339         ProcessorEntry* single_selection = 0;
1340         if (processor_display.selection().size() == 1) {
1341                 single_selection = processor_display.selection().front();
1342         }
1343
1344         /* And the controls submenu */
1345
1346         Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
1347
1348         if (controls_menu_item) {
1349                 if (single_selection) {
1350                         Menu* m = single_selection->build_controls_menu ();
1351                         if (m && !m->items().empty()) {
1352                                 controls_menu_item->set_submenu (*m);
1353                                 controls_menu_item->set_sensitive (true);
1354                         } else {
1355                                 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
1356                                 controls_menu_item->set_sensitive (false);
1357                         }
1358                 } else {
1359                         controls_menu_item->set_sensitive (false);
1360                 }
1361         }
1362
1363         Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
1364         if (send_menu_item) {
1365                 if (single_selection && !_route->is_monitor()) {
1366                         Menu* m = single_selection->build_send_options_menu ();
1367                         if (m && !m->items().empty()) {
1368                                 send_menu_item->set_submenu (*m);
1369                                 send_menu_item->set_sensitive (true);
1370                         } else {
1371                                 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
1372                                 send_menu_item->set_sensitive (false);
1373                         }
1374                 } else {
1375                         send_menu_item->set_sensitive (false);
1376                 }
1377         }
1378
1379         /* Sensitise actions as approprioate */
1380
1381
1382         const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
1383
1384         paste_action->set_sensitive (!_rr_selection.processors.empty());
1385         cut_action->set_sensitive (sensitive && can_cut ());
1386         copy_action->set_sensitive (sensitive);
1387         delete_action->set_sensitive (sensitive || stub_processor_selected ());
1388
1389         edit_action->set_sensitive (one_processor_can_be_edited ());
1390         edit_generic_action->set_sensitive (one_processor_can_be_edited ());
1391
1392         boost::shared_ptr<PluginInsert> pi;
1393         if (single_selection) {
1394                 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
1395         }
1396
1397         /* allow editing with an Ardour-generated UI for plugin inserts with editors */
1398         edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
1399
1400         /* disallow rename for multiple selections, for plugin inserts and for the fader */
1401         rename_action->set_sensitive (single_selection
1402                         && !pi
1403                         && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
1404                         && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
1405
1406         processor_menu->popup (1, arg);
1407
1408         /* Add a placeholder gap to the processor list to indicate where a processor would be
1409            inserted were one chosen from the menu.
1410         */
1411         int x, y;
1412         processor_display.get_pointer (x, y);
1413         _placement = processor_display.add_placeholder (y);
1414
1415         if (_visible_prefader_processors == 0 && _placement > 0) {
1416                 --_placement;
1417         }
1418 }
1419
1420 bool
1421 ProcessorBox::enter_notify (GdkEventCrossing*)
1422 {
1423         _current_processor_box = this;
1424         return false;
1425 }
1426
1427 bool
1428 ProcessorBox::leave_notify (GdkEventCrossing*)
1429 {
1430         return false;
1431 }
1432
1433 bool
1434 ProcessorBox::processor_operation (ProcessorOperation op)
1435 {
1436         ProcSelection targets;
1437
1438         get_selected_processors (targets);
1439
1440 /*      if (targets.empty()) {
1441
1442                 int x, y;
1443                 processor_display.get_pointer (x, y);
1444
1445                 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
1446
1447                 if (pointer.first && pointer.first->processor()) {
1448                         targets.push_back (pointer.first->processor ());
1449                 }
1450         }
1451 */
1452
1453         if ( (op == ProcessorsDelete) && targets.empty() )
1454                 return false;  //nothing to delete.  return false so the editor-mixer, because the user was probably intending to delete something in the editor
1455
1456         switch (op) {
1457         case ProcessorsSelectAll:
1458                 processor_display.select_all ();
1459                 break;
1460
1461         case ProcessorsSelectNone:
1462                 processor_display.select_none ();
1463                 break;
1464
1465         case ProcessorsCopy:
1466                 copy_processors (targets);
1467                 break;
1468
1469         case ProcessorsCut:
1470                 cut_processors (targets);
1471                 break;
1472
1473         case ProcessorsPaste:
1474                 // some processors are not selectable (e.g fader, meter), target is empty.
1475                 if (targets.empty() && _placement >= 0) {
1476                         assert (_route);
1477                         boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
1478                         if (proc) {
1479                                 targets.push_back (proc);
1480                         }
1481                 }
1482                 if (targets.empty()) {
1483                         paste_processors ();
1484                 } else {
1485                         paste_processors (targets.front());
1486                 }
1487                 break;
1488
1489         case ProcessorsDelete:
1490                 delete_processors (targets);
1491                 break;
1492
1493         case ProcessorsToggleActive:
1494                 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
1495                         if ((*i)->active()) {
1496                                 (*i)->deactivate ();
1497                         } else {
1498                                 (*i)->activate ();
1499                         }
1500                 }
1501                 break;
1502
1503         case ProcessorsAB:
1504                 ab_plugins ();
1505                 break;
1506
1507         default:
1508                 break;
1509         }
1510
1511         return true;
1512 }
1513
1514 ProcessorWindowProxy*
1515 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
1516 {
1517         return  processor->window_proxy();
1518 }
1519
1520
1521 bool
1522 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
1523 {
1524         boost::shared_ptr<Processor> processor;
1525         if (child) {
1526                 processor = child->processor ();
1527         }
1528
1529         int ret = false;
1530         bool selected = processor_display.selected (child);
1531
1532         if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
1533
1534                 if (_session->engine().connected()) {
1535                         /* XXX giving an error message here is hard, because we may be in the midst of a button press */
1536
1537                         if (!one_processor_can_be_edited ()) {
1538                                 return true;
1539                         }
1540
1541                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1542                                 generic_edit_processor (processor);
1543                         } else {
1544                                 edit_processor (processor);
1545                         }
1546                 }
1547
1548                 ret = true;
1549
1550         } else if (Keyboard::is_context_menu_event (ev)) {
1551
1552                 show_processor_menu (ev->time);
1553
1554                 ret = true;
1555
1556         } else if (processor && ev->button == 1 && selected) {
1557
1558                 // this is purely informational but necessary for route params UI
1559                 ProcessorSelected (processor); // emit
1560
1561         } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
1562
1563                 choose_plugin ();
1564                 _get_plugin_selector()->show_manager ();
1565         }
1566
1567         return ret;
1568 }
1569
1570 bool
1571 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
1572 {
1573         boost::shared_ptr<Processor> processor;
1574         if (child) {
1575                 processor = child->processor ();
1576         }
1577
1578         if (processor && Keyboard::is_delete_event (ev)) {
1579
1580                 Glib::signal_idle().connect (sigc::bind (
1581                                 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
1582                                 boost::weak_ptr<Processor>(processor)));
1583
1584         } else if (processor && Keyboard::is_button2_event (ev)
1585 #ifndef GTKOSX
1586                    && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
1587 #endif
1588                 ) {
1589
1590                 /* button2-click with no/appropriate modifiers */
1591
1592                 if (processor->active()) {
1593                         processor->deactivate ();
1594                 } else {
1595                         processor->activate ();
1596                 }
1597         }
1598
1599         return false;
1600 }
1601
1602 Menu *
1603 ProcessorBox::build_processor_menu ()
1604 {
1605         processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
1606         processor_menu->set_name ("ArdourContextMenu");
1607         return processor_menu;
1608 }
1609
1610 void
1611 ProcessorBox::select_all_processors ()
1612 {
1613         processor_display.select_all ();
1614 }
1615
1616 void
1617 ProcessorBox::deselect_all_processors ()
1618 {
1619         processor_display.select_none ();
1620 }
1621
1622 void
1623 ProcessorBox::choose_plugin ()
1624 {
1625         _get_plugin_selector()->set_interested_object (*this);
1626 }
1627
1628 /** @return true if an error occurred, otherwise false */
1629 bool
1630 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
1631 {
1632         for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
1633
1634                 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
1635
1636                 Route::ProcessorStreams err_streams;
1637
1638                 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1639                         weird_plugin_dialog (**p, err_streams);
1640                         return true;
1641                         // XXX SHAREDPTR delete plugin here .. do we even need to care?
1642                 } else if (plugins.size() == 1 && Config->get_open_gui_after_adding_plugin()) {
1643                         if (_session->engine().connected () && processor_can_be_edited (processor)) {
1644                                 if ((*p)->has_editor ()) {
1645                                         edit_processor (processor);
1646                                 } else {
1647                                         generic_edit_processor (processor);
1648                                 }
1649                         }
1650                 }
1651         }
1652
1653         return false;
1654 }
1655
1656 void
1657 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
1658 {
1659         ArdourDialog dialog (_("Plugin Incompatibility"));
1660         Label label;
1661
1662         string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
1663                         p.name(), streams.index);
1664
1665         bool has_midi  = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
1666         bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
1667
1668         text += _("\nThis plugin has:\n");
1669         if (has_midi) {
1670                 uint32_t const n = p.get_info()->n_inputs.n_midi ();
1671                 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
1672         }
1673         if (has_audio) {
1674                 uint32_t const n = p.get_info()->n_inputs.n_audio ();
1675                 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
1676         }
1677
1678         text += _("\nbut at the insertion point, there are:\n");
1679         if (has_midi) {
1680                 uint32_t const n = streams.count.n_midi ();
1681                 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
1682         }
1683         if (has_audio) {
1684                 uint32_t const n = streams.count.n_audio ();
1685                 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
1686         }
1687
1688         text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
1689         label.set_text(text);
1690
1691         dialog.get_vbox()->pack_start (label);
1692         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1693
1694         dialog.set_name (X_("PluginIODialog"));
1695         dialog.set_modal (true);
1696         dialog.show_all ();
1697
1698         dialog.run ();
1699 }
1700
1701 void
1702 ProcessorBox::choose_insert ()
1703 {
1704         boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
1705         _route->add_processor_by_index (processor, _placement);
1706 }
1707
1708 /* Caller must not hold process lock */
1709 void
1710 ProcessorBox::choose_send ()
1711 {
1712         boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
1713         boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
1714
1715         /* make an educated guess at the initial number of outputs for the send */
1716         ChanCount outs = (_session->master_out())
1717                         ? _session->master_out()->n_outputs()
1718                         : _route->n_outputs();
1719
1720         /* XXX need processor lock on route */
1721         try {
1722                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1723                 send->output()->ensure_io (outs, false, this);
1724         } catch (AudioEngine::PortRegistrationFailure& err) {
1725                 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
1726                 return;
1727         }
1728
1729         /* let the user adjust the IO setup before creation.
1730
1731            Note: this dialog is NOT modal - we just leave it to run and it will
1732            return when its Finished signal is emitted - typically when the window
1733            is closed.
1734          */
1735
1736         IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
1737         ios->show ();
1738
1739         /* keep a reference to the send so it doesn't get deleted while
1740            the IOSelectorWindow is doing its stuff
1741         */
1742         _processor_being_created = send;
1743
1744         ios->selector().Finished.connect (sigc::bind (
1745                         sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
1746                         boost::weak_ptr<Processor>(send), ios));
1747
1748 }
1749
1750 void
1751 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1752 {
1753         boost::shared_ptr<Processor> processor (weak_processor.lock());
1754
1755         /* drop our temporary reference to the new send */
1756         _processor_being_created.reset ();
1757
1758         if (!processor) {
1759                 return;
1760         }
1761
1762         switch (r) {
1763         case IOSelector::Cancelled:
1764                 // processor will go away when all shared_ptrs to it vanish
1765                 break;
1766
1767         case IOSelector::Accepted:
1768                 _route->add_processor_by_index (processor, _placement);
1769                 if (Profile->get_sae()) {
1770                         processor->activate ();
1771                 }
1772                 break;
1773         }
1774
1775         delete_when_idle (ios);
1776 }
1777
1778 void
1779 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1780 {
1781         boost::shared_ptr<Processor> processor (weak_processor.lock());
1782
1783         /* drop our temporary reference to the new return */
1784         _processor_being_created.reset ();
1785
1786         if (!processor) {
1787                 return;
1788         }
1789
1790         switch (r) {
1791         case IOSelector::Cancelled:
1792                 // processor will go away when all shared_ptrs to it vanish
1793                 break;
1794
1795         case IOSelector::Accepted:
1796                 _route->add_processor_by_index (processor, _placement);
1797                 if (Profile->get_sae()) {
1798                         processor->activate ();
1799                 }
1800                 break;
1801         }
1802
1803         delete_when_idle (ios);
1804 }
1805
1806 void
1807 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
1808 {
1809         if (!_route) {
1810                 return;
1811         }
1812
1813         boost::shared_ptr<Route> target = wr.lock();
1814
1815         if (!target) {
1816                 return;
1817         }
1818
1819         _session->add_internal_send (target, _placement, _route);
1820 }
1821
1822 void
1823 ProcessorBox::route_processors_changed (RouteProcessorChange c)
1824 {
1825         if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
1826                 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
1827                 return;
1828         }
1829
1830         redisplay_processors ();
1831 }
1832
1833 void
1834 ProcessorBox::redisplay_processors ()
1835 {
1836         ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
1837         bool     fader_seen;
1838
1839         if (no_processor_redisplay) {
1840                 return;
1841         }
1842
1843         processor_display.clear ();
1844
1845         _visible_prefader_processors = 0;
1846         fader_seen = false;
1847
1848         _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
1849                                                &_visible_prefader_processors, &fader_seen));
1850
1851         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
1852         _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
1853         setup_entry_positions ();
1854 }
1855
1856 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
1857  *  not already have one.
1858  */
1859 void
1860 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
1861 {
1862         boost::shared_ptr<Processor> p = w.lock ();
1863         if (!p) {
1864                 return;
1865         }
1866         if (p->window_proxy()) {
1867                 return;
1868         }
1869
1870         /* not on the list; add it */
1871
1872         string loc;
1873 #if 0 // is this still needed? Why?
1874         if (_parent_strip) {
1875                 if (_parent_strip->mixer_owned()) {
1876                         loc = X_("M");
1877                 } else {
1878                         loc = X_("R");
1879                 }
1880         } else {
1881                 loc = X_("P");
1882         }
1883 #else
1884         loc = X_("P");
1885 #endif
1886
1887         ProcessorWindowProxy* wp = new ProcessorWindowProxy (
1888                 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
1889                 this,
1890                 w);
1891
1892         const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
1893
1894         if (ui_xml) {
1895                 wp->set_state (*ui_xml);
1896         }
1897
1898         void* existing_ui = p->get_ui ();
1899
1900         if (existing_ui) {
1901                 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
1902         }
1903
1904         p->set_window_proxy (wp);
1905         WM::Manager::instance().register_window (wp);
1906 }
1907
1908 void
1909 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
1910 {
1911         boost::shared_ptr<Processor> processor (p.lock ());
1912
1913         if (processor && ( processor->display_to_user()
1914 #ifndef NDEBUG
1915                             || show_all_processors
1916 #endif
1917                          )
1918            ) {
1919
1920                 if (boost::dynamic_pointer_cast<Amp>(processor) && boost::dynamic_pointer_cast<Amp>(processor)->type() == X_("amp")) {
1921                         *amp_seen = true;
1922                 } else {
1923                         if (!*amp_seen) {
1924                                 (*cnt)++;
1925                         }
1926                 }
1927         }
1928 }
1929
1930 void
1931 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
1932 {
1933         boost::shared_ptr<Processor> processor (p.lock ());
1934
1935         if (!processor || ( !processor->display_to_user()
1936 #ifndef NDEBUG
1937                             && !show_all_processors
1938 #endif
1939                           )
1940            ) {
1941                 return;
1942         }
1943
1944         boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
1945
1946         ProcessorEntry* e = 0;
1947         if (plugin_insert) {
1948                 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
1949         } else {
1950                 e = new ProcessorEntry (this, processor, _width);
1951         }
1952
1953         boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
1954         boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
1955         boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
1956
1957         //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
1958         if (!send && !plugin_insert && !ext && !stub)
1959                 e->set_selectable(false);
1960
1961         bool mark_send_visible = false;
1962         if (send && _parent_strip) {
1963                 /* show controls of new sends by default */
1964                 GUIObjectState& st = _parent_strip->gui_object_state ();
1965                 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
1966                 assert (strip);
1967                 /* check if state exists, if not it must be a new send */
1968                 if (!st.get_node(strip, e->state_id())) {
1969                         mark_send_visible = true;
1970                 }
1971         }
1972
1973         /* Set up this entry's state from the GUIObjectState */
1974         XMLNode* proc = entry_gui_object_state (e);
1975         if (proc) {
1976                 e->set_control_state (proc);
1977         }
1978
1979         if (mark_send_visible) {
1980                 e->show_all_controls ();
1981         }
1982
1983         processor_display.add_child (e);
1984 }
1985
1986 void
1987 ProcessorBox::reordered ()
1988 {
1989         compute_processor_sort_keys ();
1990         setup_entry_positions ();
1991 }
1992
1993 void
1994 ProcessorBox::setup_entry_positions ()
1995 {
1996         list<ProcessorEntry*> children = processor_display.children ();
1997         bool pre_fader = true;
1998
1999         uint32_t num = 0;
2000         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2001                 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) && boost::dynamic_pointer_cast<Amp>((*i)->processor())->type() == X_("amp")) {
2002                         pre_fader = false;
2003                         (*i)->set_position (ProcessorEntry::Fader, num++);
2004                 } else {
2005                         if (pre_fader) {
2006                                 (*i)->set_position (ProcessorEntry::PreFader, num++);
2007                         } else {
2008                                 (*i)->set_position (ProcessorEntry::PostFader, num++);
2009                         }
2010                 }
2011         }
2012 }
2013
2014 void
2015 ProcessorBox::compute_processor_sort_keys ()
2016 {
2017         list<ProcessorEntry*> children = processor_display.children ();
2018         Route::ProcessorList our_processors;
2019
2020         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2021                 if ((*i)->processor()) {
2022                         our_processors.push_back ((*i)->processor ());
2023                 }
2024         }
2025
2026         if (_route->reorder_processors (our_processors)) {
2027                 /* Reorder failed, so report this to the user.  As far as I can see this must be done
2028                    in an idle handler: it seems that the redisplay_processors() that happens below destroys
2029                    widgets that were involved in the drag-and-drop on the processor list, which causes problems
2030                    when the drag is torn down after this handler function is finished.
2031                 */
2032                 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2033         }
2034 }
2035
2036 void
2037 ProcessorBox::report_failed_reorder ()
2038 {
2039         /* reorder failed, so redisplay */
2040
2041         redisplay_processors ();
2042
2043         /* now tell them about the problem */
2044
2045         ArdourDialog dialog (_("Plugin Incompatibility"));
2046         Label label;
2047
2048         label.set_text (_("\
2049 You cannot reorder these plugins/sends/inserts\n\
2050 in that way because the inputs and\n\
2051 outputs will not work correctly."));
2052
2053         dialog.get_vbox()->set_border_width (12);
2054         dialog.get_vbox()->pack_start (label);
2055         dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2056
2057         dialog.set_name (X_("PluginIODialog"));
2058         dialog.set_modal (true);
2059         dialog.show_all ();
2060
2061         dialog.run ();
2062 }
2063
2064 void
2065 ProcessorBox::rename_processors ()
2066 {
2067         ProcSelection to_be_renamed;
2068
2069         get_selected_processors (to_be_renamed);
2070
2071         if (to_be_renamed.empty()) {
2072                 return;
2073         }
2074
2075         for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2076                 rename_processor (*i);
2077         }
2078 }
2079
2080 bool
2081 ProcessorBox::can_cut () const
2082 {
2083         vector<boost::shared_ptr<Processor> > sel;
2084
2085         get_selected_processors (sel);
2086
2087         /* cut_processors () does not cut inserts */
2088
2089         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2090
2091                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2092                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2093                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2094                         return true;
2095                 }
2096         }
2097
2098         return false;
2099 }
2100
2101 bool
2102 ProcessorBox::stub_processor_selected () const
2103 {
2104         vector<boost::shared_ptr<Processor> > sel;
2105
2106         get_selected_processors (sel);
2107
2108         for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2109                 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
2110                         return true;
2111                 }
2112         }
2113
2114         return false;
2115 }
2116
2117 void
2118 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
2119 {
2120         if (to_be_removed.empty()) {
2121                 return;
2122         }
2123
2124         XMLNode* node = new XMLNode (X_("cut"));
2125         Route::ProcessorList to_cut;
2126
2127         no_processor_redisplay = true;
2128         for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
2129                 // Cut only plugins, sends and returns
2130                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2131                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2132                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2133
2134                         Window* w = get_processor_ui (*i);
2135
2136                         if (w) {
2137                                 w->hide ();
2138                         }
2139
2140                         XMLNode& child ((*i)->get_state());
2141                         node->add_child_nocopy (child);
2142                         to_cut.push_back (*i);
2143                 }
2144         }
2145
2146         if (_route->remove_processors (to_cut) != 0) {
2147                 delete node;
2148                 no_processor_redisplay = false;
2149                 return;
2150         }
2151
2152         _rr_selection.set (node);
2153
2154         no_processor_redisplay = false;
2155         redisplay_processors ();
2156 }
2157
2158 void
2159 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
2160 {
2161         if (to_be_copied.empty()) {
2162                 return;
2163         }
2164
2165         XMLNode* node = new XMLNode (X_("copy"));
2166
2167         for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
2168                 // Copy only plugins, sends, returns
2169                 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2170                     (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2171                     (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2172                         node->add_child_nocopy ((*i)->get_state());
2173                 }
2174         }
2175
2176         _rr_selection.set (node);
2177 }
2178
2179 void
2180 ProcessorBox::delete_processors (const ProcSelection& targets)
2181 {
2182         if (targets.empty()) {
2183                 return;
2184         }
2185
2186         no_processor_redisplay = true;
2187
2188         for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
2189
2190                 Window* w = get_processor_ui (*i);
2191
2192                 if (w) {
2193                         w->hide ();
2194                 }
2195
2196                 _route->remove_processor(*i);
2197         }
2198
2199         no_processor_redisplay = false;
2200         redisplay_processors ();
2201 }
2202
2203 void
2204 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
2205 {
2206         list<boost::shared_ptr<Processor> >::const_iterator x;
2207
2208         no_processor_redisplay = true;
2209         for (x = procs.begin(); x != procs.end(); ++x) {
2210
2211                 Window* w = get_processor_ui (*x);
2212
2213                 if (w) {
2214                         w->hide ();
2215                 }
2216
2217                 _route->remove_processor(*x);
2218         }
2219
2220         no_processor_redisplay = false;
2221         redisplay_processors ();
2222 }
2223
2224 gint
2225 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
2226 {
2227         boost::shared_ptr<Processor> processor (weak_processor.lock());
2228
2229         if (!processor) {
2230                 return false;
2231         }
2232
2233         /* NOT copied to _mixer.selection() */
2234
2235         no_processor_redisplay = true;
2236         _route->remove_processor (processor);
2237         no_processor_redisplay = false;
2238         redisplay_processors ();
2239
2240         return false;
2241 }
2242
2243 void
2244 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
2245 {
2246         ArdourPrompter name_prompter (true);
2247         string result;
2248         name_prompter.set_title (_("Rename Processor"));
2249         name_prompter.set_prompt (_("New name:"));
2250         name_prompter.set_initial_text (processor->name());
2251         name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
2252         name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
2253         name_prompter.show_all ();
2254
2255         switch (name_prompter.run ()) {
2256
2257         case Gtk::RESPONSE_ACCEPT:
2258                 name_prompter.get_result (result);
2259                 if (result.length()) {
2260
2261                        int tries = 0;
2262                        string test = result;
2263
2264                        while (tries < 100) {
2265                                if (_session->io_name_is_legal (test)) {
2266                                        result = test;
2267                                        break;
2268                                }
2269                                tries++;
2270
2271                                test = string_compose ("%1-%2", result, tries);
2272                        }
2273
2274                        if (tries < 100) {
2275                                processor->set_name (result);
2276                        } else {
2277                                /* unlikely! */
2278                                ARDOUR_UI::instance()->popup_error
2279                                        (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
2280                        }
2281                 }
2282                 break;
2283         }
2284
2285         return;
2286 }
2287
2288 void
2289 ProcessorBox::paste_processors ()
2290 {
2291         if (_rr_selection.processors.empty()) {
2292                 return;
2293         }
2294
2295         paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
2296 }
2297
2298 void
2299 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
2300 {
2301
2302         if (_rr_selection.processors.empty()) {
2303                 return;
2304         }
2305
2306         paste_processor_state (_rr_selection.processors.get_node().children(), before);
2307 }
2308
2309 void
2310 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
2311 {
2312         XMLNodeConstIterator niter;
2313         list<boost::shared_ptr<Processor> > copies;
2314
2315         if (nlist.empty()) {
2316                 return;
2317         }
2318
2319         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2320
2321                 XMLProperty const * type = (*niter)->property ("type");
2322                 XMLProperty const * role = (*niter)->property ("role");
2323                 assert (type);
2324
2325                 boost::shared_ptr<Processor> p;
2326                 try {
2327                         if (type->value() == "meter" ||
2328                             type->value() == "main-outs" ||
2329                             type->value() == "amp" ||
2330                             type->value() == "intreturn") {
2331                                 /* do not paste meter, main outs, amp or internal returns */
2332                                 continue;
2333
2334                         } else if (type->value() == "intsend") {
2335
2336                                 /* aux sends are OK, but those used for
2337                                  * other purposes, are not.
2338                                  */
2339
2340                                 assert (role);
2341
2342                                 if (role->value() != "Aux") {
2343                                         continue;
2344                                 }
2345
2346                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2347                                 XMLNode n (**niter);
2348                                 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
2349                                                 _route, boost::shared_ptr<Route>(), Delivery::Aux);
2350
2351                                 IOProcessor::prepare_for_reset (n, s->name());
2352
2353                                 if (s->set_state (n, Stateful::loading_state_version)) {
2354                                         delete s;
2355                                         return;
2356                                 }
2357
2358                                 p.reset (s);
2359
2360                         } else if (type->value() == "send") {
2361
2362                                 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2363                                 XMLNode n (**niter);
2364
2365                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
2366
2367                                 IOProcessor::prepare_for_reset (n, s->name());
2368
2369                                 if (s->set_state (n, Stateful::loading_state_version)) {
2370                                         delete s;
2371                                         return;
2372                                 }
2373
2374                                 p.reset (s);
2375
2376                         } else if (type->value() == "return") {
2377
2378                                 XMLNode n (**niter);
2379                                 Return* r = new Return (*_session);
2380
2381                                 IOProcessor::prepare_for_reset (n, r->name());
2382
2383                                 if (r->set_state (n, Stateful::loading_state_version)) {
2384                                         delete r;
2385                                         return;
2386                                 }
2387
2388                                 p.reset (r);
2389
2390                         } else if (type->value() == "port") {
2391
2392                                 XMLNode n (**niter);
2393                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
2394
2395                                 IOProcessor::prepare_for_reset (n, pi->name());
2396
2397                                 if (pi->set_state (n, Stateful::loading_state_version)) {
2398                                         return;
2399                                 }
2400
2401                                 p.reset (pi);
2402
2403                         } else {
2404                                 /* XXX its a bit limiting to assume that everything else
2405                                    is a plugin.
2406                                 */
2407                                 p.reset (new PluginInsert (*_session));
2408                                 PBD::ID id = p->id();
2409                                 p->set_state (**niter, Stateful::current_state_version);
2410                                 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
2411                         }
2412
2413                         copies.push_back (p);
2414                 }
2415
2416                 catch (...) {
2417                         error << _("plugin insert constructor failed") << endmsg;
2418                 }
2419         }
2420
2421         if (copies.empty()) {
2422                 return;
2423         }
2424
2425         if (_route->add_processors (copies, p)) {
2426
2427                 string msg = _(
2428                         "Copying the set of processors on the clipboard failed,\n\
2429 probably because the I/O configuration of the plugins\n\
2430 could not match the configuration of this track.");
2431                 MessageDialog am (msg);
2432                 am.run ();
2433         }
2434 }
2435
2436 void
2437 ProcessorBox::get_selected_processors (ProcSelection& processors) const
2438 {
2439         const list<ProcessorEntry*> selection = processor_display.selection ();
2440         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
2441                 processors.push_back ((*i)->processor ());
2442         }
2443 }
2444
2445 void
2446 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
2447 {
2448         list<ProcessorEntry*> selection = processor_display.selection ();
2449         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
2450                 (this->*method) ((*i)->processor ());
2451         }
2452 }
2453
2454 void
2455 ProcessorBox::all_visible_processors_active (bool state)
2456 {
2457         _route->all_visible_processors_active (state);
2458 }
2459
2460 void
2461 ProcessorBox::ab_plugins ()
2462 {
2463         _route->ab_plugins (ab_direction);
2464         ab_direction = !ab_direction;
2465 }
2466
2467
2468 void
2469 ProcessorBox::clear_processors ()
2470 {
2471         string prompt;
2472         vector<string> choices;
2473
2474         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
2475                                    "(this cannot be undone)"), _route->name());
2476
2477         choices.push_back (_("Cancel"));
2478         choices.push_back (_("Yes, remove them all"));
2479
2480         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2481
2482         if (prompter.run () == 1) {
2483                 _route->clear_processors (PreFader);
2484                 _route->clear_processors (PostFader);
2485         }
2486 }
2487
2488 void
2489 ProcessorBox::clear_processors (Placement p)
2490 {
2491         string prompt;
2492         vector<string> choices;
2493
2494         if (p == PreFader) {
2495                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
2496                                            "(this cannot be undone)"), _route->name());
2497         } else {
2498                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
2499                                            "(this cannot be undone)"), _route->name());
2500         }
2501
2502         choices.push_back (_("Cancel"));
2503         choices.push_back (_("Yes, remove them all"));
2504
2505         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2506
2507         if (prompter.run () == 1) {
2508                 _route->clear_processors (p);
2509         }
2510 }
2511
2512 bool
2513 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2514 {
2515         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2516         if (at && at->freeze_state() == AudioTrack::Frozen) {
2517                 return false;
2518         }
2519
2520         if (
2521                 boost::dynamic_pointer_cast<Send> (processor) ||
2522                 boost::dynamic_pointer_cast<Return> (processor) ||
2523                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2524                 boost::dynamic_pointer_cast<PortInsert> (processor)
2525                 ) {
2526                 return true;
2527         }
2528
2529         return false;
2530 }
2531
2532 bool
2533 ProcessorBox::one_processor_can_be_edited ()
2534 {
2535         list<ProcessorEntry*> selection = processor_display.selection ();
2536         list<ProcessorEntry*>::iterator i = selection.begin();
2537         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2538                 ++i;
2539         }
2540
2541         return (i != selection.end());
2542 }
2543
2544 Gtk::Window*
2545 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
2546 {
2547         boost::shared_ptr<Send> send;
2548         boost::shared_ptr<InternalSend> internal_send;
2549         boost::shared_ptr<Return> retrn;
2550         boost::shared_ptr<PluginInsert> plugin_insert;
2551         boost::shared_ptr<PortInsert> port_insert;
2552         Window* gidget = 0;
2553
2554         /* This method may or may not return a Window, but if it does not it
2555          * will modify the parent mixer strip appearance layout to allow
2556          * "editing" the @param processor that was passed in.
2557          *
2558          * So for example, if the processor is an Amp (gain), the parent strip
2559          * will be forced back into a model where the fader controls the main gain.
2560          * If the processor is a send, then we map the send controls onto the
2561          * strip.
2562          *
2563          * Plugins and others will return a window for control.
2564          */
2565
2566         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2567
2568                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2569                         return 0;
2570                 }
2571         }
2572
2573         if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->type() == X_("amp")) {
2574
2575                 if (_parent_strip) {
2576                         _parent_strip->revert_to_default_display ();
2577                 }
2578
2579         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2580
2581                 if (!_session->engine().connected()) {
2582                         return 0;
2583                 }
2584
2585                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2586
2587                         gidget = new SendUIWindow (send, _session);
2588                 }
2589
2590         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2591
2592                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2593                         /* no GUI for these */
2594                         return 0;
2595                 }
2596
2597                 if (!_session->engine().connected()) {
2598                         return 0;
2599                 }
2600
2601                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2602
2603                 ReturnUIWindow *return_ui;
2604                 Window* w = get_processor_ui (retrn);
2605
2606                 if (w == 0) {
2607
2608                         return_ui = new ReturnUIWindow (retrn, _session);
2609                         return_ui->set_title (retrn->name ());
2610                         set_processor_ui (send, return_ui);
2611
2612                 } else {
2613                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
2614                 }
2615
2616                 gidget = return_ui;
2617
2618         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2619
2620                 PluginUIWindow *plugin_ui;
2621
2622                 /* these are both allowed to be null */
2623
2624                 Window* w = get_processor_ui (plugin_insert);
2625
2626                 if (w == 0) {
2627                         plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
2628                         plugin_ui->set_title (generate_processor_title (plugin_insert));
2629                         set_processor_ui (plugin_insert, plugin_ui);
2630
2631                 } else {
2632                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2633                 }
2634
2635                 gidget = plugin_ui;
2636
2637         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2638
2639                 if (!_session->engine().connected()) {
2640                         MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
2641                         msg.run ();
2642                         return 0;
2643                 }
2644
2645                 PortInsertWindow *io_selector;
2646
2647                 Window* w = get_processor_ui (port_insert);
2648
2649                 if (w == 0) {
2650                         io_selector = new PortInsertWindow (_session, port_insert);
2651                         set_processor_ui (port_insert, io_selector);
2652
2653                 } else {
2654                         io_selector = dynamic_cast<PortInsertWindow *> (w);
2655                 }
2656
2657                 gidget = io_selector;
2658         }
2659
2660         return gidget;
2661 }
2662
2663 Gtk::Window*
2664 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
2665 {
2666         boost::shared_ptr<PluginInsert> plugin_insert
2667                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2668
2669         if (!plugin_insert) {
2670                 return 0;
2671         }
2672
2673         PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
2674         win->set_title (generate_processor_title (plugin_insert));
2675
2676         return win;
2677 }
2678
2679 void
2680 ProcessorBox::register_actions ()
2681 {
2682         Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = Gtk::ActionGroup::create(X_("ProcessorMenu"));
2683         Glib::RefPtr<Action> act;
2684
2685         /* new stuff */
2686         ActionManager::register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2687                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2688
2689         act = ActionManager::register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2690                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2691         ActionManager::engine_sensitive_actions.push_back (act);
2692         act = ActionManager::register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2693                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
2694         ActionManager::engine_sensitive_actions.push_back (act);
2695
2696         ActionManager::register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2697
2698         ActionManager::register_action (popup_act_grp, X_("controls"), _("Controls"));
2699         ActionManager::register_action (popup_act_grp, X_("send_options"), _("Send Options"));
2700
2701         ActionManager::register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2702                         sigc::ptr_fun (ProcessorBox::rb_clear));
2703         ActionManager::register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2704                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2705         ActionManager::register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2706                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
2707
2708         /* standard editing stuff */
2709         cut_action = ActionManager::register_action (popup_act_grp, X_("cut"), _("Cut"),
2710                                                      sigc::ptr_fun (ProcessorBox::rb_cut));
2711         copy_action = ActionManager::register_action (popup_act_grp, X_("copy"), _("Copy"),
2712                         sigc::ptr_fun (ProcessorBox::rb_copy));
2713         delete_action = ActionManager::register_action (popup_act_grp, X_("delete"), _("Delete"),
2714                         sigc::ptr_fun (ProcessorBox::rb_delete));
2715
2716         paste_action = ActionManager::register_action (popup_act_grp, X_("paste"), _("Paste"),
2717                         sigc::ptr_fun (ProcessorBox::rb_paste));
2718         rename_action = ActionManager::register_action (popup_act_grp, X_("rename"), _("Rename"),
2719                         sigc::ptr_fun (ProcessorBox::rb_rename));
2720         ActionManager::register_action (popup_act_grp, X_("selectall"), _("Select All"),
2721                         sigc::ptr_fun (ProcessorBox::rb_select_all));
2722         ActionManager::register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2723                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2724
2725         /* activation etc. */
2726
2727         ActionManager::register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2728                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
2729         ActionManager::register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2730                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2731         ActionManager::register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2732                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2733
2734         /* show editors */
2735         edit_action = ActionManager::register_action (
2736                 popup_act_grp, X_("edit"), _("Edit..."),
2737                 sigc::ptr_fun (ProcessorBox::rb_edit));
2738
2739         edit_generic_action = ActionManager::register_action (
2740                 popup_act_grp, X_("edit-generic"), _("Edit with generic controls..."),
2741                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2742
2743         ActionManager::add_action_group (popup_act_grp);
2744 }
2745
2746 void
2747 ProcessorBox::rb_edit_generic ()
2748 {
2749         if (_current_processor_box == 0) {
2750                 return;
2751         }
2752
2753         _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
2754 }
2755
2756 void
2757 ProcessorBox::rb_ab_plugins ()
2758 {
2759         if (_current_processor_box == 0) {
2760                 return;
2761         }
2762
2763         _current_processor_box->ab_plugins ();
2764 }
2765
2766 void
2767 ProcessorBox::rb_choose_plugin ()
2768 {
2769         if (_current_processor_box == 0) {
2770                 return;
2771         }
2772         _current_processor_box->choose_plugin ();
2773 }
2774
2775 void
2776 ProcessorBox::rb_choose_insert ()
2777 {
2778         if (_current_processor_box == 0) {
2779                 return;
2780         }
2781         _current_processor_box->choose_insert ();
2782 }
2783
2784 void
2785 ProcessorBox::rb_choose_send ()
2786 {
2787         if (_current_processor_box == 0) {
2788                 return;
2789         }
2790         _current_processor_box->choose_send ();
2791 }
2792
2793 void
2794 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
2795 {
2796         if (_current_processor_box == 0) {
2797                 return;
2798         }
2799
2800         _current_processor_box->choose_aux (wr);
2801 }
2802
2803 void
2804 ProcessorBox::rb_clear ()
2805 {
2806         if (_current_processor_box == 0) {
2807                 return;
2808         }
2809
2810         _current_processor_box->clear_processors ();
2811 }
2812
2813
2814 void
2815 ProcessorBox::rb_clear_pre ()
2816 {
2817         if (_current_processor_box == 0) {
2818                 return;
2819         }
2820
2821         _current_processor_box->clear_processors (PreFader);
2822 }
2823
2824
2825 void
2826 ProcessorBox::rb_clear_post ()
2827 {
2828         if (_current_processor_box == 0) {
2829                 return;
2830         }
2831
2832         _current_processor_box->clear_processors (PostFader);
2833 }
2834
2835 void
2836 ProcessorBox::rb_cut ()
2837 {
2838         if (_current_processor_box == 0) {
2839                 return;
2840         }
2841
2842         _current_processor_box->processor_operation (ProcessorsCut);
2843 }
2844
2845 void
2846 ProcessorBox::rb_delete ()
2847 {
2848         if (_current_processor_box == 0) {
2849                 return;
2850         }
2851
2852         _current_processor_box->processor_operation (ProcessorsDelete);
2853 }
2854
2855 void
2856 ProcessorBox::rb_copy ()
2857 {
2858         if (_current_processor_box == 0) {
2859                 return;
2860         }
2861         _current_processor_box->processor_operation (ProcessorsCopy);
2862 }
2863
2864 void
2865 ProcessorBox::rb_paste ()
2866 {
2867         if (_current_processor_box == 0) {
2868                 return;
2869         }
2870
2871         _current_processor_box->processor_operation (ProcessorsPaste);
2872 }
2873
2874 void
2875 ProcessorBox::rb_rename ()
2876 {
2877         if (_current_processor_box == 0) {
2878                 return;
2879         }
2880         _current_processor_box->rename_processors ();
2881 }
2882
2883 void
2884 ProcessorBox::rb_select_all ()
2885 {
2886         if (_current_processor_box == 0) {
2887                 return;
2888         }
2889
2890         _current_processor_box->processor_operation (ProcessorsSelectAll);
2891 }
2892
2893 void
2894 ProcessorBox::rb_deselect_all ()
2895 {
2896         if (_current_processor_box == 0) {
2897                 return;
2898         }
2899
2900         _current_processor_box->deselect_all_processors ();
2901 }
2902
2903 void
2904 ProcessorBox::rb_activate_all ()
2905 {
2906         if (_current_processor_box == 0) {
2907                 return;
2908         }
2909
2910         _current_processor_box->all_visible_processors_active (true);
2911 }
2912
2913 void
2914 ProcessorBox::rb_deactivate_all ()
2915 {
2916         if (_current_processor_box == 0) {
2917                 return;
2918         }
2919         _current_processor_box->all_visible_processors_active (false);
2920 }
2921
2922 void
2923 ProcessorBox::rb_edit ()
2924 {
2925         if (_current_processor_box == 0) {
2926                 return;
2927         }
2928
2929         _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
2930 }
2931
2932 bool
2933 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
2934 {
2935         if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2936                 return false;
2937         }
2938
2939         if (_parent_strip) {
2940                 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2941                 if (_parent_strip->current_delivery() == send) {
2942                         _parent_strip->revert_to_default_display ();
2943                 } else {
2944                         _parent_strip->show_send(send);
2945                 }
2946         }
2947         return true;
2948 }
2949
2950 void
2951 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
2952 {
2953         if (!processor) {
2954                 return;
2955         }
2956         if (edit_aux_send (processor)) {
2957                 return;
2958         }
2959
2960         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2961
2962         if (proxy) {
2963                 proxy->set_custom_ui_mode (true);
2964                 proxy->toggle ();
2965         }
2966 }
2967
2968 void
2969 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
2970 {
2971         if (!processor) {
2972                 return;
2973         }
2974         if (edit_aux_send (processor)) {
2975                 return;
2976         }
2977
2978         ProcessorWindowProxy* proxy = find_window_proxy (processor);
2979
2980         if (proxy) {
2981                 proxy->set_custom_ui_mode (false);
2982                 proxy->toggle ();
2983         }
2984 }
2985
2986 void
2987 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
2988 {
2989         if (!what_changed.contains (ARDOUR::Properties::name)) {
2990                 return;
2991         }
2992
2993         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
2994
2995         boost::shared_ptr<Processor> processor;
2996         boost::shared_ptr<PluginInsert> plugin_insert;
2997         boost::shared_ptr<Send> send;
2998
2999         list<ProcessorEntry*> children = processor_display.children();
3000
3001         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3002
3003                 processor = (*iter)->processor ();
3004
3005                 if (!processor) {
3006                         continue;
3007                 }
3008
3009                 Window* w = get_processor_ui (processor);
3010
3011                 if (!w) {
3012                         continue;
3013                 }
3014
3015                 /* rename editor windows for sends and plugins */
3016
3017                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3018                         w->set_title (send->name ());
3019                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3020                         w->set_title (generate_processor_title (plugin_insert));
3021                 }
3022         }
3023 }
3024
3025 string
3026 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3027 {
3028         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3029         string::size_type email_pos;
3030
3031         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3032                 maker = maker.substr (0, email_pos - 1);
3033         }
3034
3035         if (maker.length() > 32) {
3036                 maker = maker.substr (0, 32);
3037                 maker += " ...";
3038         }
3039
3040         SessionObject* owner = pi->owner();
3041
3042         if (owner) {
3043                 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
3044         } else {
3045                 return string_compose(_("%1 (by %2)"), pi->name(), maker);
3046         }
3047 }
3048
3049 /** @param p Processor.
3050  *  @return the UI window for \a p.
3051  */
3052 Window *
3053 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
3054 {
3055         ProcessorWindowProxy* wp = p->window_proxy();
3056         if (wp) {
3057                 return wp->get ();
3058         }
3059         return 0;
3060 }
3061
3062 /** Make a note of the UI window that a processor is using.
3063  *  @param p Processor.
3064  *  @param w UI window.
3065  */
3066 void
3067 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
3068 {
3069         assert (p->window_proxy());
3070         p->set_ui (w);
3071         p->window_proxy()->use_window (*w);
3072 }
3073
3074 void
3075 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
3076 {
3077         boost::shared_ptr<Delivery> d = w.lock ();
3078         if (!d) {
3079                 return;
3080         }
3081
3082         list<ProcessorEntry*> children = processor_display.children ();
3083         list<ProcessorEntry*>::const_iterator i = children.begin();
3084         while (i != children.end() && (*i)->processor() != d) {
3085                 ++i;
3086         }
3087
3088         if (i == children.end()) {
3089                 processor_display.set_active (0);
3090         } else {
3091                 processor_display.set_active (*i);
3092         }
3093 }
3094
3095 /** Called to repair the damage of Editor::show_window doing a show_all() */
3096 void
3097 ProcessorBox::hide_things ()
3098 {
3099         list<ProcessorEntry*> c = processor_display.children ();
3100         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
3101                 (*i)->hide_things ();
3102         }
3103 }
3104
3105 void
3106 ProcessorBox::processor_menu_unmapped ()
3107 {
3108         processor_display.remove_placeholder ();
3109 }
3110
3111 XMLNode *
3112 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
3113 {
3114         if (!_parent_strip) {
3115                 return 0;
3116         }
3117
3118         GUIObjectState& st = _parent_strip->gui_object_state ();
3119
3120         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
3121         assert (strip);
3122         return st.get_or_add_node (strip, entry->state_id());
3123 }
3124
3125 void
3126 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
3127 {
3128         XMLNode* proc = entry_gui_object_state (entry);
3129         if (!proc) {
3130                 return;
3131         }
3132
3133         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
3134         proc->remove_nodes_and_delete (X_("Object"));
3135         entry->add_control_state (proc);
3136 }
3137
3138 bool
3139 ProcessorBox::is_editor_mixer_strip() const
3140 {
3141         return _parent_strip && !_parent_strip->mixer_owned();
3142 }
3143
3144 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
3145         : WM::ProxyBase (name, string())
3146         , _processor_box (box)
3147         , _processor (processor)
3148         , is_custom (false)
3149         , want_custom (false)
3150 {
3151         boost::shared_ptr<Processor> p = _processor.lock ();
3152         if (!p) {
3153                 return;
3154         }
3155         p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
3156 }
3157
3158 ProcessorWindowProxy::~ProcessorWindowProxy()
3159 {
3160         /* processor window proxies do not own the windows they create with
3161          * ::get(), so set _window to null before the normal WindowProxy method
3162          * deletes it.
3163          */
3164         _window = 0;
3165 }
3166
3167 void
3168 ProcessorWindowProxy::processor_going_away ()
3169 {
3170         delete _window;
3171         _window = 0;
3172         WM::Manager::instance().remove (this);
3173         /* should be no real reason to do this, since the object that would
3174            send DropReferences is about to be deleted, but lets do it anyway.
3175         */
3176         going_away_connection.disconnect();
3177 }
3178
3179 ARDOUR::SessionHandlePtr*
3180 ProcessorWindowProxy::session_handle()
3181 {
3182         /* we don't care */
3183         return 0;
3184 }
3185
3186 XMLNode&
3187 ProcessorWindowProxy::get_state () const
3188 {
3189         XMLNode *node;
3190         node = &ProxyBase::get_state();
3191         node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
3192         return *node;
3193 }
3194
3195 void
3196 ProcessorWindowProxy::set_state (const XMLNode& node)
3197 {
3198         XMLNodeList children = node.children ();
3199         XMLNodeList::const_iterator i = children.begin ();
3200         while (i != children.end()) {
3201                 XMLProperty* prop = (*i)->property (X_("name"));
3202                 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
3203                         break;
3204                 }
3205                 ++i;
3206         }
3207
3208         if (i != children.end()) {
3209                 XMLProperty* prop;
3210                 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
3211                         want_custom = PBD::string_is_affirmative (prop->value ());
3212                 }
3213         }
3214
3215         ProxyBase::set_state(node);
3216 }
3217
3218 Gtk::Window*
3219 ProcessorWindowProxy::get (bool create)
3220 {
3221         boost::shared_ptr<Processor> p = _processor.lock ();
3222
3223         if (!p) {
3224                 return 0;
3225         }
3226         if (_window && (is_custom != want_custom)) {
3227                 /* drop existing window - wrong type */
3228                 drop_window ();
3229         }
3230
3231         if (!_window) {
3232                 if (!create) {
3233                         return 0;
3234                 }
3235
3236                 is_custom = want_custom;
3237                 _window = _processor_box->get_editor_window (p, is_custom);
3238
3239                 if (_window) {
3240                         setup ();
3241                 }
3242         }
3243
3244         return _window;
3245 }
3246
3247 void
3248 ProcessorWindowProxy::toggle ()
3249 {
3250         if (_window && (is_custom != want_custom)) {
3251                 /* drop existing window - wrong type */
3252                 drop_window ();
3253         }
3254         is_custom = want_custom;
3255
3256         WM::ProxyBase::toggle ();
3257 }