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