gtk2_ardour/processor_box.cc

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