gtk2_ardour/processor_box.cc

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