gtk2_ardour/processor_box.cc

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