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