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