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