gtk2_ardour/processor_box.cc

   1 /*
   2     Copyright (C) 2000-2004 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifdef WAF_BUILD
  21 #include "gtk2ardour-config.h"
  22 #endif
  23
  24 #include <cmath>
  25 #include <iostream>
  26 #include <set>
  27
  28 #include <sigc++/bind.h>
  29
  30 #include "pbd/convert.h"
  31
  32 #include <glibmm/miscutils.h>
  33
  34 #include <gtkmm/messagedialog.h>
  35
  36 #include <gtkmm2ext/gtk_ui.h>
  37 #include <gtkmm2ext/utils.h>
  38 #include <gtkmm2ext/choice.h>
  39 #include <gtkmm2ext/utils.h>
  40 #include <gtkmm2ext/doi.h>
  41
  42 #include "ardour/amp.h"
  43 #include "ardour/audio_track.h"
  44 #include "ardour/audioengine.h"
  45 #include "ardour/internal_return.h"
  46 #include "ardour/internal_send.h"
  47 #include "ardour/plugin_insert.h"
  48 #include "ardour/port_insert.h"
  49 #include "ardour/profile.h"
  50 #include "ardour/return.h"
  51 #include "ardour/route.h"
  52 #include "ardour/send.h"
  53 #include "ardour/session.h"
  54 #include "ardour/types.h"
  55
  56 #include "actions.h"
  57 #include "ardour_dialog.h"
  58 #include "ardour_ui.h"
  59 #include "gui_thread.h"
  60 #include "io_selector.h"
  61 #include "keyboard.h"
  62 #include "mixer_ui.h"
  63 #include "mixer_strip.h"
  64 #include "plugin_selector.h"
  65 #include "plugin_ui.h"
  66 #include "port_insert_ui.h"
  67 #include "processor_box.h"
  68 #include "public_editor.h"
  69 #include "return_ui.h"
  70 #include "route_processor_selection.h"
  71 #include "send_ui.h"
  72 #include "utils.h"
  73
  74 #include "i18n.h"
  75
  76 #ifdef AUDIOUNIT_SUPPORT
  77 class AUPluginUI;
  78 #endif
  79
  80 using namespace std;
  81 using namespace ARDOUR;
  82 using namespace PBD;
  83 using namespace Gtk;
  84 using namespace Glib;
  85 using namespace Gtkmm2ext;
  86
  87 ProcessorBox* ProcessorBox::_current_processor_box = 0;
  88 RefPtr<Action> ProcessorBox::paste_action;
  89 RefPtr<Action> ProcessorBox::cut_action;
  90 RefPtr<Action> ProcessorBox::rename_action;
  91 RefPtr<Action> ProcessorBox::edit_action;
  92 RefPtr<Action> ProcessorBox::edit_generic_action;
  93
  94 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
  95         : _button (ArdourButton::led_default_elements)
  96         , _position (PreFader)
  97         , _parent (parent)
  98         , _processor (p)
  99         , _width (w)
 100         , _visual_state (Gtk::STATE_NORMAL)
 101 {
 102         _vbox.show ();
 103
 104         _button.set_diameter (3);
 105         _button.set_distinct_led_click (true);
 106         _button.set_led_left (true);
 107         _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
 108         _button.set_text (name (_width));
 109
 110         if (_processor) {
 111
 112                 _vbox.pack_start (_button, true, true);
 113
 114                 _button.set_active (_processor->active());
 115                 _button.show ();
 116
 117                 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
 118                 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
 119
 120                 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
 121                 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
 122
 123                         Control* c = new Control (_processor->automation_control (*i), _processor->describe_parameter (*i));
 124
 125                         _controls.push_back (c);
 126
 127                         if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
 128                                 /* Add non-Amp controls to the processor box */
 129                                 _vbox.pack_start (c->box);
 130                         }
 131
 132                         if (boost::dynamic_pointer_cast<Send> (_processor)) {
 133                                 /* Don't label send faders */
 134                                 c->hide_label ();
 135                         }
 136                 }
 137
 138                 setup_tooltip ();
 139                 setup_visuals ();
 140         } else {
 141                 _vbox.set_size_request (-1, _button.size_request().height);
 142         }
 143 }
 144
 145 ProcessorEntry::~ProcessorEntry ()
 146 {
 147         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 148                 delete *i;
 149         }
 150 }
 151
 152 EventBox&
 153 ProcessorEntry::action_widget ()
 154 {
 155         return _button;
 156 }
 157
 158 Gtk::Widget&
 159 ProcessorEntry::widget ()
 160 {
 161         return _vbox;
 162 }
 163
 164 string
 165 ProcessorEntry::drag_text () const
 166 {
 167         return name (Wide);
 168 }
 169
 170 void
 171 ProcessorEntry::set_position (Position p)
 172 {
 173         _position = p;
 174         setup_visuals ();
 175 }
 176
 177 void
 178 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
 179 {
 180         if (yn) {
 181                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
 182         } else {
 183                 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
 184         }
 185 }
 186
 187 void
 188 ProcessorEntry::setup_visuals ()
 189 {
 190         switch (_position) {
 191         case PreFader:
 192                 _button.set_name ("processor prefader");
 193                 break;
 194
 195         case Fader:
 196                 _button.set_name ("processor fader");
 197                 break;
 198
 199         case PostFader:
 200                 _button.set_name ("processor postfader");
 201                 break;
 202         }
 203 }
 204
 205
 206 boost::shared_ptr<Processor>
 207 ProcessorEntry::processor () const
 208 {
 209         return _processor;
 210 }
 211
 212 void
 213 ProcessorEntry::set_enum_width (Width w)
 214 {
 215         _width = w;
 216 }
 217
 218 void
 219 ProcessorEntry::led_clicked()
 220 {
 221         if (_processor) {
 222                 if (_button.get_active ()) {
 223                         _processor->deactivate ();
 224                 } else {
 225                         _processor->activate ();
 226                 }
 227         }
 228 }
 229
 230 void
 231 ProcessorEntry::processor_active_changed ()
 232 {
 233         if (_processor) {
 234                 _button.set_active (_processor->active());
 235         }
 236 }
 237
 238 void
 239 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
 240 {
 241         if (what_changed.contains (ARDOUR::Properties::name)) {
 242                 _button.set_text (name (_width));
 243                 setup_tooltip ();
 244         }
 245 }
 246
 247 void
 248 ProcessorEntry::setup_tooltip ()
 249 {
 250         ARDOUR_UI::instance()->set_tip (_button, name (Wide));
 251 }
 252
 253 string
 254 ProcessorEntry::name (Width w) const
 255 {
 256         boost::shared_ptr<Send> send;
 257         string name_display;
 258
 259         if (!_processor) {
 260                 return string();
 261         }
 262
 263         if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
 264             !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
 265
 266                 name_display += '>';
 267
 268                 /* grab the send name out of its overall name */
 269
 270                 string::size_type lbracket, rbracket;
 271                 lbracket = send->name().find ('[');
 272                 rbracket = send->name().find (']');
 273
 274                 switch (w) {
 275                 case Wide:
 276                         name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
 277                         break;
 278                 case Narrow:
 279                         name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
 280                         break;
 281                 }
 282
 283         } else {
 284
 285                 switch (w) {
 286                 case Wide:
 287                         name_display += _processor->display_name();
 288                         break;
 289                 case Narrow:
 290                         name_display += PBD::short_version (_processor->display_name(), 5);
 291                         break;
 292                 }
 293
 294         }
 295
 296         return name_display;
 297 }
 298
 299 void
 300 ProcessorEntry::set_pixel_width (int p)
 301 {
 302         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 303                 (*i)->set_pixel_width (p);
 304         }
 305 }
 306
 307 void
 308 ProcessorEntry::show_all_controls ()
 309 {
 310         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 311                 (*i)->set_visible (true);
 312         }
 313
 314         _parent->update_gui_object_state (this);
 315 }
 316
 317 void
 318 ProcessorEntry::hide_all_controls ()
 319 {
 320         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 321                 (*i)->set_visible (false);
 322         }
 323
 324         _parent->update_gui_object_state (this);
 325 }
 326
 327 void
 328 ProcessorEntry::add_control_state (XMLNode* node) const
 329 {
 330         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 331                 (*i)->add_state (node);
 332         }
 333 }
 334
 335 void
 336 ProcessorEntry::set_control_state (XMLNode const * node)
 337 {
 338         for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
 339                 (*i)->set_state (node);
 340         }
 341 }
 342
 343 string
 344 ProcessorEntry::state_id () const
 345 {
 346         return string_compose ("processor %1", _processor->id().to_s());
 347 }
 348
 349 void
 350 ProcessorEntry::hide_things ()
 351 {
 352         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 353                 (*i)->hide_things ();
 354         }
 355 }
 356
 357
 358 Menu *
 359 ProcessorEntry::build_controls_menu ()
 360 {
 361         using namespace Menu_Helpers;
 362         Menu* menu = manage (new Menu);
 363         MenuList& items = menu->items ();
 364
 365         items.push_back (
 366                 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
 367                 );
 368
 369         items.push_back (
 370                 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
 371                 );
 372
 373         if (!_controls.empty ()) {
 374                 items.push_back (SeparatorElem ());
 375         }
 376
 377         for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
 378                 items.push_back (CheckMenuElem ((*i)->name ()));
 379                 CheckMenuItem* c = dynamic_cast<CheckMenuItem*> (&items.back ());
 380                 c->set_active ((*i)->visible ());
 381                 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
 382         }
 383
 384         return menu;
 385 }
 386
 387 void
 388 ProcessorEntry::toggle_control_visibility (Control* c)
 389 {
 390         c->set_visible (!c->visible ());
 391         _parent->update_gui_object_state (this);
 392 }
 393
 394 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
 395         : _control (c)
 396         , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
 397         , _slider (&_adjustment, 0, 13, false)
 398         , _slider_persistant_tooltip (&_slider)
 399         , _button (ArdourButton::Element (ArdourButton::Text | ArdourButton::Indicator))
 400         , _ignore_ui_adjustment (false)
 401         , _visible (false)
 402         , _name (n)
 403 {
 404         _slider.set_controllable (c);
 405
 406         if (c->toggled()) {
 407                 _button.set_text (_name);
 408                 _button.set_led_left (true);
 409                 _button.set_name ("processor control button");
 410                 box.pack_start (_button);
 411                 _button.show ();
 412
 413                 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
 414                 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
 415                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 416
 417         } else {
 418
 419                 _slider.set_name ("PluginSlider");
 420                 _slider.set_text (_name);
 421
 422 //              box.pack_start (_label);
 423 //              _label.show ();
 424 //              _label.set_text (_name);
 425                 box.pack_start (_slider);
 426                 _slider.show ();
 427
 428                 double const lo = c->internal_to_interface (c->lower ());
 429                 double const up = c->internal_to_interface (c->upper ());
 430
 431                 _adjustment.set_lower (lo);
 432                 _adjustment.set_upper (up);
 433                 _adjustment.set_step_increment ((up - lo) / 100);
 434                 _adjustment.set_page_increment ((up - lo) / 10);
 435                 _slider.set_default_value (c->internal_to_interface (c->normal ()));
 436
 437                 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
 438                 c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
 439         }
 440
 441         ARDOUR_UI::RapidScreenUpdate.connect (sigc::mem_fun (*this, &Control::control_changed));
 442
 443         control_changed ();
 444         set_tooltip ();
 445
 446         /* We're providing our own PersistentTooltip */
 447         set_no_tooltip_whatsoever (_slider);
 448 }
 449
 450 void
 451 ProcessorEntry::Control::set_tooltip ()
 452 {
 453         boost::shared_ptr<AutomationControl> c = _control.lock ();
 454
 455         if (!c) {
 456                 return;
 457         }
 458
 459         stringstream s;
 460         s << _name << ": ";
 461         if (c->toggled ()) {
 462                 s << (c->get_value() > 0.5 ? _("on") : _("off"));
 463         } else {
 464                 s << setprecision(2) << fixed;
 465                 s << c->internal_to_user (c->get_value ());
 466         }
 467
 468         ARDOUR_UI::instance()->set_tip (_label, s.str ());
 469         _slider_persistant_tooltip.set_tip (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         set_tooltip ();
 494 }
 495
 496 void
 497 ProcessorEntry::Control::button_clicked ()
 498 {
 499         boost::shared_ptr<AutomationControl> c = _control.lock ();
 500
 501         if (!c) {
 502                 return;
 503         }
 504
 505         bool const n = _button.get_active ();
 506
 507         c->set_value (n ? 0 : 1);
 508         _button.set_active (!n);
 509 }
 510
 511 void
 512 ProcessorEntry::Control::control_changed ()
 513 {
 514         boost::shared_ptr<AutomationControl> c = _control.lock ();
 515         if (!c) {
 516                 return;
 517         }
 518
 519         _ignore_ui_adjustment = true;
 520
 521         if (c->toggled ()) {
 522
 523                 _button.set_active (c->get_value() > 0.5);
 524
 525         } else {
 526
 527                 _adjustment.set_value (c->internal_to_interface (c->get_value ()));
 528
 529                 stringstream s;
 530                 s.precision (1);
 531                 s.setf (ios::fixed, ios::floatfield);
 532                 s << c->internal_to_user (c->get_value ());
 533         }
 534
 535         _ignore_ui_adjustment = false;
 536 }
 537
 538 void
 539 ProcessorEntry::Control::add_state (XMLNode* node) const
 540 {
 541         XMLNode* c = new XMLNode (X_("Object"));
 542         c->add_property (X_("id"), state_id ());
 543         c->add_property (X_("visible"), _visible);
 544         node->add_child_nocopy (*c);
 545 }
 546
 547 void
 548 ProcessorEntry::Control::set_state (XMLNode const * node)
 549 {
 550         XMLNode* n = GUIObjectState::get_node (node, state_id ());
 551         if (n) {
 552                 XMLProperty* p = n->property (X_("visible"));
 553                 set_visible (p && string_is_affirmative (p->value ()));
 554         } else {
 555                 set_visible (false);
 556         }
 557 }
 558
 559 void
 560 ProcessorEntry::Control::set_visible (bool v)
 561 {
 562         if (v) {
 563                 box.show ();
 564         } else {
 565                 box.hide ();
 566         }
 567
 568         _visible = v;
 569 }
 570
 571 /** Called when the Editor might have re-shown things that
 572     we want hidden.
 573 */
 574 void
 575 ProcessorEntry::Control::hide_things ()
 576 {
 577         if (!_visible) {
 578                 box.hide ();
 579         }
 580 }
 581
 582 void
 583 ProcessorEntry::Control::hide_label ()
 584 {
 585         _label.hide ();
 586 }
 587
 588 string
 589 ProcessorEntry::Control::state_id () const
 590 {
 591         boost::shared_ptr<AutomationControl> c = _control.lock ();
 592         assert (c);
 593
 594         return string_compose (X_("control %1"), c->id().to_s ());
 595 }
 596
 597 BlankProcessorEntry::BlankProcessorEntry (ProcessorBox* b, Width w)
 598         : ProcessorEntry (b, boost::shared_ptr<Processor>(), w)
 599 {
 600 }
 601
 602 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
 603         : ProcessorEntry (b, p, w)
 604         , _plugin_insert (p)
 605 {
 606         p->SplittingChanged.connect (
 607                 _splitting_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::plugin_insert_splitting_changed, this), gui_context()
 608                 );
 609
 610         _splitting_icon.set_size_request (-1, 12);
 611
 612         _vbox.pack_start (_splitting_icon);
 613         _vbox.reorder_child (_splitting_icon, 0);
 614
 615         plugin_insert_splitting_changed ();
 616 }
 617
 618 void
 619 PluginInsertProcessorEntry::plugin_insert_splitting_changed ()
 620 {
 621         if (_plugin_insert->splitting ()) {
 622                 _splitting_icon.show ();
 623         } else {
 624                 _splitting_icon.hide ();
 625         }
 626 }
 627
 628 void
 629 PluginInsertProcessorEntry::hide_things ()
 630 {
 631         ProcessorEntry::hide_things ();
 632         plugin_insert_splitting_changed ();
 633 }
 634
 635 void
 636 PluginInsertProcessorEntry::setup_visuals ()
 637 {
 638         switch (_position) {
 639         case PreFader:
 640                 _splitting_icon.set_name ("ProcessorPreFader");
 641                 break;
 642
 643         case Fader:
 644                 _splitting_icon.set_name ("ProcessorFader");
 645                 break;
 646
 647         case PostFader:
 648                 _splitting_icon.set_name ("ProcessorPostFader");
 649                 break;
 650         }
 651
 652         ProcessorEntry::setup_visuals ();
 653 }
 654
 655 bool
 656 PluginInsertProcessorEntry::SplittingIcon::on_expose_event (GdkEventExpose* ev)
 657 {
 658         cairo_t* cr = gdk_cairo_create (get_window()->gobj());
 659
 660         cairo_set_line_width (cr, 1);
 661
 662         double const width = ev->area.width;
 663         double const height = ev->area.height;
 664
 665         Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
 666         cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
 667
 668         cairo_rectangle (cr, 0, 0, width, height);
 669         cairo_fill (cr);
 670
 671         Gdk::Color const fg = get_style()->get_fg (STATE_NORMAL);
 672         cairo_set_source_rgb (cr, fg.get_red_p (), fg.get_green_p (), fg.get_blue_p ());
 673
 674         cairo_move_to (cr, width * 0.3, height);
 675         cairo_line_to (cr, width * 0.3, height * 0.5);
 676         cairo_line_to (cr, width * 0.7, height * 0.5);
 677         cairo_line_to (cr, width * 0.7, height);
 678         cairo_move_to (cr, width * 0.5, height * 0.5);
 679         cairo_line_to (cr, width * 0.5, 0);
 680         cairo_stroke (cr);
 681
 682         return true;
 683 }
 684
 685 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
 686                             RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
 687         : _parent_strip (parent)
 688         , _owner_is_mixer (owner_is_mixer)
 689         , ab_direction (true)
 690         , _get_plugin_selector (get_plugin_selector)
 691         , _placement (-1)
 692         , _visible_prefader_processors (0)
 693         , _rr_selection(rsel)
 694 {
 695         set_session (sess);
 696
 697         _width = Wide;
 698         processor_menu = 0;
 699         no_processor_redisplay = false;
 700
 701         processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 702         processor_scroller.add (processor_display);
 703         pack_start (processor_scroller, true, true);
 704
 705         processor_display.set_flags (CAN_FOCUS);
 706         processor_display.set_name ("ProcessorList");
 707         processor_display.set_size_request (48, -1);
 708         processor_display.set_data ("processorbox", this);
 709         processor_display.set_spacing (2);
 710
 711         processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
 712         processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
 713
 714         processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
 715         processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
 716
 717         processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
 718         processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
 719
 720         processor_scroller.show ();
 721         processor_display.show ();
 722
 723         if (parent) {
 724                 parent->DeliveryChanged.connect (
 725                         _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
 726                         );
 727         }
 728
 729         ARDOUR_UI::instance()->set_tip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
 730 }
 731
 732 ProcessorBox::~ProcessorBox ()
 733 {
 734         /* it may appear as if we should delete processor_menu but that is a
 735          * pointer to a widget owned by the UI Manager, and has potentially
 736          * be returned to many other ProcessorBoxes. GTK doesn't really make
 737          * clear the ownership of this widget, which is a menu and thus is
 738          * never packed into any container other than an implict GtkWindow.
 739          *
 740          * For now, until or if we ever get clarification over the ownership
 741          * story just let it continue to exist. At worst, its a small memory leak.
 742          */
 743 }
 744
 745 void
 746 ProcessorBox::set_route (boost::shared_ptr<Route> r)
 747 {
 748         if (_route == r) {
 749                 return;
 750         }
 751
 752         _route_connections.drop_connections();
 753
 754         /* new route: any existing block on processor redisplay must be meaningless */
 755         no_processor_redisplay = false;
 756         _route = r;
 757
 758         _route->processors_changed.connect (
 759                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
 760                 );
 761
 762         _route->DropReferences.connect (
 763                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
 764                 );
 765
 766         _route->PropertyChanged.connect (
 767                 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
 768                 );
 769
 770         redisplay_processors ();
 771 }
 772
 773 void
 774 ProcessorBox::route_going_away ()
 775 {
 776         /* don't keep updating display as processors are deleted */
 777         no_processor_redisplay = true;
 778         _route.reset ();
 779 }
 780
 781 void
 782 ProcessorBox::object_drop(DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
 783 {
 784         boost::shared_ptr<Processor> p;
 785         if (position) {
 786                 p = position->processor ();
 787                 if (!p) {
 788                         /* dropped on the blank entry (which will be before the
 789                            fader), so use the first non-blank child as our
 790                            `dropped on' processor */
 791                         list<ProcessorEntry*> c = processor_display.children ();
 792                         list<ProcessorEntry*>::iterator i = c.begin ();
 793                         while (dynamic_cast<BlankProcessorEntry*> (*i)) {
 794                                 assert (i != c.end ());
 795                                 ++i;
 796                         }
 797
 798                         assert (i != c.end ());
 799                         p = (*i)->processor ();
 800                         assert (p);
 801                 }
 802         }
 803
 804         list<ProcessorEntry*> children = source->selection ();
 805         list<boost::shared_ptr<Processor> > procs;
 806         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
 807                 if ((*i)->processor ()) {
 808                         procs.push_back ((*i)->processor ());
 809                 }
 810         }
 811
 812         for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
 813                 XMLNode& state = (*i)->get_state ();
 814                 XMLNodeList nlist;
 815                 nlist.push_back (&state);
 816                 paste_processor_state (nlist, p);
 817                 delete &state;
 818         }
 819
 820         /* since the dndvbox doesn't take care of this properly, we have to delete the originals
 821            ourselves.
 822         */
 823
 824         if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
 825                 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
 826                 if (other) {
 827                         other->delete_dragged_processors (procs);
 828                 }
 829         }
 830 }
 831
 832 void
 833 ProcessorBox::set_width (Width w)
 834 {
 835         if (_width == w) {
 836                 return;
 837         }
 838
 839         _width = w;
 840
 841         list<ProcessorEntry*> children = processor_display.children ();
 842         for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
 843                 (*i)->set_enum_width (w);
 844         }
 845
 846         redisplay_processors ();
 847 }
 848
 849 Gtk::Menu*
 850 ProcessorBox::build_possible_aux_menu ()
 851 {
 852         boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
 853
 854         if (rl->empty()) {
 855                 /* No aux sends if there are no busses */
 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*)
 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::Threads::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                 XMLProperty const * role = (*niter)->property ("role");
1819                 assert (type);
1820                 assert (role);
1821
1822                 boost::shared_ptr<Processor> p;
1823                 try {
1824                         if (type->value() == "meter" ||
1825                             type->value() == "main-outs" ||
1826                             type->value() == "amp" ||
1827                             type->value() == "intreturn") {
1828                                 /* do not paste meter, main outs, amp or internal returns */
1829                                 continue;
1830
1831                         } else if (type->value() == "intsend") {
1832
1833                                 /* aux sends are OK, but those used for
1834                                  * other purposes, are not.
1835                                  */
1836
1837                                 if (role->value() != "Aux") {
1838                                         continue;
1839                                 }
1840
1841                                 XMLNode n (**niter);
1842                                 InternalSend* s = new InternalSend (*_session, _route->pannable(), _route->mute_master(),
1843                                                                     boost::shared_ptr<Route>(), Delivery::Aux);
1844
1845                                 IOProcessor::prepare_for_reset (n, s->name());
1846
1847                                 if (s->set_state (n, Stateful::loading_state_version)) {
1848                                         delete s;
1849                                         return;
1850                                 }
1851
1852                                 p.reset (s);
1853
1854                         } else if (type->value() == "send") {
1855
1856                                 XMLNode n (**niter);
1857                                 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
1858
1859                                 IOProcessor::prepare_for_reset (n, s->name());
1860
1861                                 if (s->set_state (n, Stateful::loading_state_version)) {
1862                                         delete s;
1863                                         return;
1864                                 }
1865
1866                                 p.reset (s);
1867
1868                         } else if (type->value() == "return") {
1869
1870                                 XMLNode n (**niter);
1871                                 Return* r = new Return (*_session);
1872
1873                                 IOProcessor::prepare_for_reset (n, r->name());
1874
1875                                 if (r->set_state (n, Stateful::loading_state_version)) {
1876                                         delete r;
1877                                         return;
1878                                 }
1879
1880                                 p.reset (r);
1881
1882                         } else if (type->value() == "port") {
1883
1884                                 XMLNode n (**niter);
1885                                 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
1886
1887                                 IOProcessor::prepare_for_reset (n, pi->name());
1888
1889                                 if (pi->set_state (n, Stateful::loading_state_version)) {
1890                                         return;
1891                                 }
1892
1893                                 p.reset (pi);
1894
1895                         } else {
1896                                 /* XXX its a bit limiting to assume that everything else
1897                                    is a plugin.
1898                                 */
1899
1900                                 p.reset (new PluginInsert (*_session));
1901                                 p->set_state (**niter, Stateful::current_state_version);
1902                         }
1903
1904                         copies.push_back (p);
1905                 }
1906
1907                 catch (...) {
1908                         error << _("plugin insert constructor failed") << endmsg;
1909                 }
1910         }
1911
1912         if (copies.empty()) {
1913                 return;
1914         }
1915
1916         if (_route->add_processors (copies, p)) {
1917
1918                 string msg = _(
1919                         "Copying the set of processors on the clipboard failed,\n\
1920 probably because the I/O configuration of the plugins\n\
1921 could not match the configuration of this track.");
1922                 MessageDialog am (msg);
1923                 am.run ();
1924         }
1925 }
1926
1927 void
1928 ProcessorBox::get_selected_processors (ProcSelection& processors) const
1929 {
1930         const list<ProcessorEntry*> selection = processor_display.selection ();
1931         for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
1932                 processors.push_back ((*i)->processor ());
1933         }
1934 }
1935
1936 void
1937 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
1938 {
1939         list<ProcessorEntry*> selection = processor_display.selection ();
1940         for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
1941                 (this->*method) ((*i)->processor ());
1942         }
1943 }
1944
1945 void
1946 ProcessorBox::all_visible_processors_active (bool state)
1947 {
1948         _route->all_visible_processors_active (state);
1949 }
1950
1951 void
1952 ProcessorBox::ab_plugins ()
1953 {
1954         _route->ab_plugins (ab_direction);
1955         ab_direction = !ab_direction;
1956 }
1957
1958
1959 void
1960 ProcessorBox::clear_processors ()
1961 {
1962         string prompt;
1963         vector<string> choices;
1964
1965         prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
1966                                    "(this cannot be undone)"), _route->name());
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 (PreFader);
1975                 _route->clear_processors (PostFader);
1976         }
1977 }
1978
1979 void
1980 ProcessorBox::clear_processors (Placement p)
1981 {
1982         string prompt;
1983         vector<string> choices;
1984
1985         if (p == PreFader) {
1986                 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
1987                                            "(this cannot be undone)"), _route->name());
1988         } else {
1989                 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
1990                                            "(this cannot be undone)"), _route->name());
1991         }
1992
1993         choices.push_back (_("Cancel"));
1994         choices.push_back (_("Yes, remove them all"));
1995
1996         Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
1997
1998         if (prompter.run () == 1) {
1999                 _route->clear_processors (p);
2000         }
2001 }
2002
2003 bool
2004 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2005 {
2006         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2007         if (at && at->freeze_state() == AudioTrack::Frozen) {
2008                 return false;
2009         }
2010
2011         if (
2012                 (boost::dynamic_pointer_cast<Send> (processor) && !boost::dynamic_pointer_cast<InternalSend> (processor))||
2013                 boost::dynamic_pointer_cast<Return> (processor) ||
2014                 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2015                 boost::dynamic_pointer_cast<PortInsert> (processor)
2016                 ) {
2017                 return true;
2018         }
2019
2020         return false;
2021 }
2022
2023 bool
2024 ProcessorBox::one_processor_can_be_edited ()
2025 {
2026         list<ProcessorEntry*> selection = processor_display.selection ();
2027         list<ProcessorEntry*>::iterator i = selection.begin();
2028         while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2029                 ++i;
2030         }
2031
2032         return (i != selection.end());
2033 }
2034
2035 void
2036 ProcessorBox::toggle_edit_processor (boost::shared_ptr<Processor> processor)
2037 {
2038         boost::shared_ptr<Send> send;
2039         boost::shared_ptr<InternalSend> internal_send;
2040         boost::shared_ptr<Return> retrn;
2041         boost::shared_ptr<PluginInsert> plugin_insert;
2042         boost::shared_ptr<PortInsert> port_insert;
2043         Window* gidget = 0;
2044
2045         if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2046
2047                 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2048                         return;
2049                 }
2050         }
2051
2052         if (boost::dynamic_pointer_cast<Amp> (processor)) {
2053
2054                 if (_parent_strip) {
2055                         _parent_strip->revert_to_default_display ();
2056                 }
2057
2058         } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2059
2060                 if (!_session->engine().connected()) {
2061                         return;
2062                 }
2063
2064                 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2065                         SendUIWindow* w = new SendUIWindow (send, _session);
2066                         w->show ();
2067                 } else {
2068                         /* assign internal send to main fader */
2069                         if (_parent_strip) {
2070                                 if (_parent_strip->current_delivery() == send) {
2071                                         _parent_strip->revert_to_default_display ();
2072                                 } else {
2073                                         _parent_strip->show_send(send);
2074                                 }
2075                         }
2076                 }
2077
2078         } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2079
2080                 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2081                         /* no GUI for these */
2082                         return;
2083                 }
2084
2085                 if (!_session->engine().connected()) {
2086                         return;
2087                 }
2088
2089                 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2090
2091                 ReturnUIWindow *return_ui;
2092                 Window* w = get_processor_ui (retrn);
2093
2094                 if (w == 0) {
2095
2096                         return_ui = new ReturnUIWindow (retrn, _session);
2097                         return_ui->set_title (retrn->name ());
2098                         set_processor_ui (send, return_ui);
2099
2100                 } else {
2101                         return_ui = dynamic_cast<ReturnUIWindow *> (w);
2102                 }
2103
2104                 gidget = return_ui;
2105
2106         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2107
2108                 PluginUIWindow *plugin_ui;
2109
2110                 /* these are both allowed to be null */
2111
2112                 Container* toplevel = get_toplevel();
2113                 Window* win = dynamic_cast<Gtk::Window*>(toplevel);
2114
2115                 Window* w = get_processor_ui (plugin_insert);
2116
2117                 if (w == 0) {
2118
2119                         plugin_ui = new PluginUIWindow (win, plugin_insert);
2120                         plugin_ui->set_title (generate_processor_title (plugin_insert));
2121                         set_processor_ui (plugin_insert, plugin_ui);
2122
2123                 } else {
2124                         plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2125                         plugin_ui->set_parent (win);
2126                 }
2127
2128                 gidget = plugin_ui;
2129
2130         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2131
2132                 if (!_session->engine().connected()) {
2133                         MessageDialog msg ( _("Not connected to JACK - no I/O changes are possible"));
2134                         msg.run ();
2135                         return;
2136                 }
2137
2138                 PortInsertWindow *io_selector;
2139
2140                 Window* w = get_processor_ui (port_insert);
2141
2142                 if (w == 0) {
2143                         io_selector = new PortInsertWindow (_session, port_insert);
2144                         set_processor_ui (port_insert, io_selector);
2145
2146                 } else {
2147                         io_selector = dynamic_cast<PortInsertWindow *> (w);
2148                 }
2149
2150                 gidget = io_selector;
2151         }
2152
2153         if (gidget) {
2154                 if (gidget->is_visible()) {
2155                         gidget->hide ();
2156                 } else {
2157                         gidget->show_all ();
2158                         gidget->present ();
2159                 }
2160         }
2161 }
2162
2163 /** Toggle a generic (Ardour-generated) plugin UI */
2164 void
2165 ProcessorBox::toggle_edit_generic_processor (boost::shared_ptr<Processor> processor)
2166 {
2167         boost::shared_ptr<PluginInsert> plugin_insert
2168                 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2169         if (!plugin_insert) {
2170                 return;
2171         }
2172
2173         Container*      toplevel  = get_toplevel();
2174         Window*         win       = dynamic_cast<Gtk::Window*>(toplevel);
2175         PluginUIWindow* plugin_ui = new PluginUIWindow(win, plugin_insert, true, false);
2176         plugin_ui->set_title(generate_processor_title (plugin_insert));
2177
2178         if (plugin_ui->is_visible()) {
2179                 plugin_ui->hide();
2180         } else {
2181                 plugin_ui->show_all();
2182                 plugin_ui->present();
2183         }
2184 }
2185
2186 void
2187 ProcessorBox::register_actions ()
2188 {
2189         Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = Gtk::ActionGroup::create(X_("ProcessorMenu"));
2190         Glib::RefPtr<Action> act;
2191
2192         /* new stuff */
2193         ActionManager::register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2194                         sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2195
2196         act = ActionManager::register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2197                         sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2198         ActionManager::jack_sensitive_actions.push_back (act);
2199         act = ActionManager::register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2200                         sigc::ptr_fun (ProcessorBox::rb_choose_send));
2201         ActionManager::jack_sensitive_actions.push_back (act);
2202
2203         ActionManager::register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2204
2205         ActionManager::register_action (popup_act_grp, X_("controls"), _("Controls"));
2206
2207         ActionManager::register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2208                         sigc::ptr_fun (ProcessorBox::rb_clear));
2209         ActionManager::register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2210                         sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2211         ActionManager::register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2212                         sigc::ptr_fun (ProcessorBox::rb_clear_post));
2213
2214         /* standard editing stuff */
2215         cut_action = ActionManager::register_action (popup_act_grp, X_("cut"), _("Cut"),
2216                                                      sigc::ptr_fun (ProcessorBox::rb_cut));
2217         ActionManager::plugin_selection_sensitive_actions.push_back(cut_action);
2218         act = ActionManager::register_action (popup_act_grp, X_("copy"), _("Copy"),
2219                         sigc::ptr_fun (ProcessorBox::rb_copy));
2220         ActionManager::plugin_selection_sensitive_actions.push_back(act);
2221
2222         act = ActionManager::register_action (popup_act_grp, X_("delete"), _("Delete"),
2223                         sigc::ptr_fun (ProcessorBox::rb_delete));
2224         ActionManager::plugin_selection_sensitive_actions.push_back(act); // ??
2225
2226         paste_action = ActionManager::register_action (popup_act_grp, X_("paste"), _("Paste"),
2227                         sigc::ptr_fun (ProcessorBox::rb_paste));
2228         rename_action = ActionManager::register_action (popup_act_grp, X_("rename"), _("Rename"),
2229                         sigc::ptr_fun (ProcessorBox::rb_rename));
2230         ActionManager::register_action (popup_act_grp, X_("selectall"), _("Select All"),
2231                         sigc::ptr_fun (ProcessorBox::rb_select_all));
2232         ActionManager::register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2233                         sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2234
2235         /* activation etc. */
2236
2237         ActionManager::register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2238                         sigc::ptr_fun (ProcessorBox::rb_activate_all));
2239         ActionManager::register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2240                         sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2241         ActionManager::register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2242                         sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2243
2244         /* show editors */
2245         edit_action = ActionManager::register_action (
2246                 popup_act_grp, X_("edit"), _("Edit..."),
2247                 sigc::ptr_fun (ProcessorBox::rb_edit));
2248
2249         edit_generic_action = ActionManager::register_action (
2250                 popup_act_grp, X_("edit-generic"), _("Edit with basic controls..."),
2251                 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2252
2253         ActionManager::add_action_group (popup_act_grp);
2254 }
2255
2256 void
2257 ProcessorBox::rb_edit_generic ()
2258 {
2259         if (_current_processor_box == 0) {
2260                 return;
2261         }
2262
2263         _current_processor_box->for_selected_processors (&ProcessorBox::toggle_edit_generic_processor);
2264 }
2265
2266 void
2267 ProcessorBox::rb_ab_plugins ()
2268 {
2269         if (_current_processor_box == 0) {
2270                 return;
2271         }
2272
2273         _current_processor_box->ab_plugins ();
2274 }
2275
2276 void
2277 ProcessorBox::rb_choose_plugin ()
2278 {
2279         if (_current_processor_box == 0) {
2280                 return;
2281         }
2282         _current_processor_box->choose_plugin ();
2283 }
2284
2285 void
2286 ProcessorBox::rb_choose_insert ()
2287 {
2288         if (_current_processor_box == 0) {
2289                 return;
2290         }
2291         _current_processor_box->choose_insert ();
2292 }
2293
2294 void
2295 ProcessorBox::rb_choose_send ()
2296 {
2297         if (_current_processor_box == 0) {
2298                 return;
2299         }
2300         _current_processor_box->choose_send ();
2301 }
2302
2303 void
2304 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
2305 {
2306         if (_current_processor_box == 0) {
2307                 return;
2308         }
2309
2310         _current_processor_box->choose_aux (wr);
2311 }
2312
2313 void
2314 ProcessorBox::rb_clear ()
2315 {
2316         if (_current_processor_box == 0) {
2317                 return;
2318         }
2319
2320         _current_processor_box->clear_processors ();
2321 }
2322
2323
2324 void
2325 ProcessorBox::rb_clear_pre ()
2326 {
2327         if (_current_processor_box == 0) {
2328                 return;
2329         }
2330
2331         _current_processor_box->clear_processors (PreFader);
2332 }
2333
2334
2335 void
2336 ProcessorBox::rb_clear_post ()
2337 {
2338         if (_current_processor_box == 0) {
2339                 return;
2340         }
2341
2342         _current_processor_box->clear_processors (PostFader);
2343 }
2344
2345 void
2346 ProcessorBox::rb_cut ()
2347 {
2348         if (_current_processor_box == 0) {
2349                 return;
2350         }
2351
2352         _current_processor_box->processor_operation (ProcessorsCut);
2353 }
2354
2355 void
2356 ProcessorBox::rb_delete ()
2357 {
2358         if (_current_processor_box == 0) {
2359                 return;
2360         }
2361
2362         _current_processor_box->processor_operation (ProcessorsDelete);
2363 }
2364
2365 void
2366 ProcessorBox::rb_copy ()
2367 {
2368         if (_current_processor_box == 0) {
2369                 return;
2370         }
2371         _current_processor_box->processor_operation (ProcessorsCopy);
2372 }
2373
2374 void
2375 ProcessorBox::rb_paste ()
2376 {
2377         if (_current_processor_box == 0) {
2378                 return;
2379         }
2380
2381         _current_processor_box->processor_operation (ProcessorsPaste);
2382 }
2383
2384 void
2385 ProcessorBox::rb_rename ()
2386 {
2387         if (_current_processor_box == 0) {
2388                 return;
2389         }
2390         _current_processor_box->rename_processors ();
2391 }
2392
2393 void
2394 ProcessorBox::rb_select_all ()
2395 {
2396         if (_current_processor_box == 0) {
2397                 return;
2398         }
2399
2400         _current_processor_box->processor_operation (ProcessorsSelectAll);
2401 }
2402
2403 void
2404 ProcessorBox::rb_deselect_all ()
2405 {
2406         if (_current_processor_box == 0) {
2407                 return;
2408         }
2409
2410         _current_processor_box->deselect_all_processors ();
2411 }
2412
2413 void
2414 ProcessorBox::rb_activate_all ()
2415 {
2416         if (_current_processor_box == 0) {
2417                 return;
2418         }
2419
2420         _current_processor_box->all_visible_processors_active (true);
2421 }
2422
2423 void
2424 ProcessorBox::rb_deactivate_all ()
2425 {
2426         if (_current_processor_box == 0) {
2427                 return;
2428         }
2429         _current_processor_box->all_visible_processors_active (false);
2430 }
2431
2432 void
2433 ProcessorBox::rb_edit ()
2434 {
2435         if (_current_processor_box == 0) {
2436                 return;
2437         }
2438
2439         _current_processor_box->for_selected_processors (&ProcessorBox::toggle_edit_processor);
2440 }
2441
2442 void
2443 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
2444 {
2445         if (!what_changed.contains (ARDOUR::Properties::name)) {
2446                 return;
2447         }
2448
2449         ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
2450
2451         boost::shared_ptr<Processor> processor;
2452         boost::shared_ptr<PluginInsert> plugin_insert;
2453         boost::shared_ptr<Send> send;
2454
2455         list<ProcessorEntry*> children = processor_display.children();
2456
2457         for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
2458
2459                 processor = (*iter)->processor ();
2460
2461                 if (!processor) {
2462                         continue;
2463                 }
2464
2465                 Window* w = get_processor_ui (processor);
2466
2467                 if (!w) {
2468                         continue;
2469                 }
2470
2471                 /* rename editor windows for sends and plugins */
2472
2473                 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2474                         w->set_title (send->name ());
2475                 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2476                         w->set_title (generate_processor_title (plugin_insert));
2477                 }
2478         }
2479 }
2480
2481 string
2482 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
2483 {
2484         string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
2485         string::size_type email_pos;
2486
2487         if ((email_pos = maker.find_first_of ('<')) != string::npos) {
2488                 maker = maker.substr (0, email_pos - 1);
2489         }
2490
2491         if (maker.length() > 32) {
2492                 maker = maker.substr (0, 32);
2493                 maker += " ...";
2494         }
2495
2496         return string_compose(_("%1: %2 (by %3)"), _route->name(), pi->name(), maker);
2497 }
2498
2499 void
2500 ProcessorBox::on_size_allocate (Allocation& a)
2501 {
2502         HBox::on_size_allocate (a);
2503
2504         list<ProcessorEntry*> children = processor_display.children ();
2505         for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
2506                 (*i)->set_pixel_width (a.get_width ());
2507         }
2508 }
2509
2510 /** @param p Processor.
2511  *  @return the UI window for \a p.
2512  */
2513 Window *
2514 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
2515 {
2516         list<ProcessorWindowProxy*>::const_iterator i = _processor_window_proxies.begin ();
2517         while (i != _processor_window_proxies.end()) {
2518                 boost::shared_ptr<Processor> t = (*i)->processor().lock ();
2519                 if (t && t == p) {
2520                         return (*i)->get ();
2521                 }
2522
2523                 ++i;
2524         }
2525
2526         return 0;
2527 }
2528
2529 /** Make a note of the UI window that a processor is using.
2530  *  @param p Processor.
2531  *  @param w UI window.
2532  */
2533 void
2534 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
2535 {
2536         list<ProcessorWindowProxy*>::iterator i = _processor_window_proxies.begin ();
2537
2538         p->set_ui (w);
2539
2540         while (i != _processor_window_proxies.end()) {
2541                 boost::shared_ptr<Processor> t = (*i)->processor().lock ();
2542                 if (t && t == p) {
2543                         (*i)->set (w);
2544                         return;
2545                 }
2546
2547                 ++i;
2548         }
2549
2550         /* we shouldn't get here, because the ProcessorUIList should always contain
2551            an entry for each processor.
2552         */
2553         assert (false);
2554 }
2555
2556 void
2557 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
2558 {
2559         boost::shared_ptr<Delivery> d = w.lock ();
2560         if (!d) {
2561                 return;
2562         }
2563
2564         list<ProcessorEntry*> children = processor_display.children ();
2565         list<ProcessorEntry*>::const_iterator i = children.begin();
2566         while (i != children.end() && (*i)->processor() != d) {
2567                 ++i;
2568         }
2569
2570         if (i == children.end()) {
2571                 processor_display.set_active (0);
2572         } else {
2573                 processor_display.set_active (*i);
2574         }
2575 }
2576
2577 /** Called to repair the damage of Editor::show_window doing a show_all() */
2578 void
2579 ProcessorBox::hide_things ()
2580 {
2581         list<ProcessorEntry*> c = processor_display.children ();
2582         for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
2583                 (*i)->hide_things ();
2584         }
2585 }
2586
2587 void
2588 ProcessorBox::processor_menu_unmapped ()
2589 {
2590         processor_display.remove_placeholder ();
2591 }
2592
2593 XMLNode *
2594 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
2595 {
2596         if (!_parent_strip) {
2597                 return 0;
2598         }
2599
2600         GUIObjectState& st = _parent_strip->gui_object_state ();
2601
2602         XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2603         assert (strip);
2604         return st.get_or_add_node (strip, entry->state_id());
2605 }
2606
2607 void
2608 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
2609 {
2610         XMLNode* proc = entry_gui_object_state (entry);
2611         if (!proc) {
2612                 return;
2613         }
2614
2615         /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
2616         proc->remove_nodes_and_delete (X_("Object"));
2617         entry->add_control_state (proc);
2618 }
2619
2620 ProcessorWindowProxy::ProcessorWindowProxy (
2621         string const & name,
2622         XMLNode const * node,
2623         ProcessorBox* box,
2624         boost::weak_ptr<Processor> processor
2625         )
2626         : WindowProxy<Gtk::Window> (name, node)
2627         , marked (false)
2628         , _processor_box (box)
2629         , _processor (processor)
2630 {
2631
2632 }
2633
2634
2635 void
2636 ProcessorWindowProxy::show ()
2637 {
2638         boost::shared_ptr<Processor> p = _processor.lock ();
2639         if (!p) {
2640                 return;
2641         }
2642
2643         _processor_box->toggle_edit_processor (p);
2644 }
2645