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