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