2 Copyright (C) 2000-2004 Paul Davis
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.
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.
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.
21 #include "gtk2ardour-config.h"
28 #include <sigc++/bind.h>
30 #include "pbd/convert.h"
32 #include <glibmm/miscutils.h>
33 #include <glibmm/fileutils.h>
35 #include <gtkmm/messagedialog.h>
37 #include <gtkmm2ext/gtk_ui.h>
38 #include <gtkmm2ext/utils.h>
39 #include <gtkmm2ext/choice.h>
40 #include <gtkmm2ext/utils.h>
41 #include <gtkmm2ext/doi.h>
42 #include <gtkmm2ext/rgb_macros.h>
44 #include "ardour/amp.h"
45 #include "ardour/audio_track.h"
46 #include "ardour/audioengine.h"
47 #include "ardour/internal_return.h"
48 #include "ardour/internal_send.h"
49 #include "ardour/luaproc.h"
50 #include "ardour/luascripting.h"
51 #include "ardour/meter.h"
52 #include "ardour/panner_shell.h"
53 #include "ardour/plugin_insert.h"
54 #include "ardour/pannable.h"
55 #include "ardour/port_insert.h"
56 #include "ardour/profile.h"
57 #include "ardour/return.h"
58 #include "ardour/route.h"
59 #include "ardour/send.h"
60 #include "ardour/session.h"
61 #include "ardour/types.h"
64 #include "ardour_dialog.h"
65 #include "ardour_ui.h"
66 #include "gui_thread.h"
67 #include "io_selector.h"
70 #include "mixer_strip.h"
71 #include "plugin_selector.h"
72 #include "plugin_ui.h"
73 #include "port_insert_ui.h"
74 #include "processor_box.h"
75 #include "public_editor.h"
76 #include "return_ui.h"
77 #include "route_processor_selection.h"
78 #include "script_selector.h"
82 #include "new_plugin_preset_dialog.h"
86 #ifdef AUDIOUNIT_SUPPORT
91 bool ProcessorBox::show_all_processors = false;
95 using namespace ARDOUR;
99 using namespace Gtkmm2ext;
101 ProcessorBox* ProcessorBox::_current_processor_box = 0;
102 RefPtr<Action> ProcessorBox::paste_action;
103 RefPtr<Action> ProcessorBox::cut_action;
104 RefPtr<Action> ProcessorBox::copy_action;
105 RefPtr<Action> ProcessorBox::rename_action;
106 RefPtr<Action> ProcessorBox::delete_action;
107 RefPtr<Action> ProcessorBox::edit_action;
108 RefPtr<Action> ProcessorBox::edit_generic_action;
109 ActionMap ProcessorBox::processor_box_actions (X_("processor box"));
111 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
112 static const uint32_t midi_port_color = 0x960909FF; //Red
114 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
115 : _button (ArdourButton::led_default_elements)
116 , _position (PreFader)
119 , _unknown_processor(false)
124 , _output_icon(false)
128 _button.set_distinct_led_click (true);
129 _button.set_fallthrough_to_parent(true);
130 _button.set_led_left (true);
131 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
132 _button.set_text (name (_width));
134 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
135 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
137 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
138 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
139 _unknown_processor = true;
142 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
143 if (pi && pi->plugin() && pi->plugin()->get_info()->type != ARDOUR::Lua) {
144 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
149 _vbox.pack_start (_routing_icon);
150 _vbox.pack_start (_input_icon);
151 _vbox.pack_start (_button, true, true);
152 _vbox.pack_end (_output_icon);
154 _button.set_active (_processor->active());
156 _routing_icon.set_no_show_all(true);
157 _input_icon.set_no_show_all(true);
160 _routing_icon.set_visible(false);
164 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
165 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
166 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
168 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
169 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
171 std::string label = _processor->describe_parameter (*i);
173 if (boost::dynamic_pointer_cast<Send> (_processor)) {
175 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
179 Control* c = new Control (_processor->automation_control (*i), label);
181 _controls.push_back (c);
183 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
184 /* Add non-Amp (Fader & Trim) controls to the processor box */
185 _vbox.pack_start (c->box);
189 _input_icon.set_ports(_processor->input_streams());
190 _output_icon.set_ports(_processor->output_streams());
192 _routing_icon.set_sources(_processor->input_streams());
193 _routing_icon.set_sinks(_processor->output_streams());
198 _vbox.set_size_request (-1, _button.size_request().height);
202 ProcessorEntry::~ProcessorEntry ()
204 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
210 ProcessorEntry::action_widget ()
216 ProcessorEntry::widget ()
222 ProcessorEntry::drag_text () const
228 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
230 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
234 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
235 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
236 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
237 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
240 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
243 if (!my_pi || !ot_pi) {
246 if (my_pi->type() != ot_pi->type()) {
249 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
250 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
251 if (!my_p || !ot_p) {
254 if (my_p->unique_id() != ot_p->unique_id()) {
261 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
263 if (data.get_target() == "PluginPresetPtr") {
264 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
266 if (!_plugin_preset_pointer || !pi) {
267 data.set (data.get_target(), 8, NULL, 0);
271 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
274 PluginManager& manager (PluginManager::instance());
275 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
277 NewPluginPresetDialog d (plugin,
278 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
280 _plugin_preset_pointer->_preset.valid = false;
283 case Gtk::RESPONSE_CANCEL:
284 data.set (data.get_target(), 8, NULL, 0);
288 case Gtk::RESPONSE_NO:
291 case Gtk::RESPONSE_ACCEPT:
292 if (d.name().empty()) {
297 plugin->remove_preset (d.name ());
300 Plugin::PresetRecord const r = plugin->save_preset (d.name());
302 if (!r.uri.empty ()) {
303 _plugin_preset_pointer->_preset.uri = r.uri;
304 _plugin_preset_pointer->_preset.label = r.label;
305 _plugin_preset_pointer->_preset.user = r.user;
306 _plugin_preset_pointer->_preset.valid = r.valid;
309 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
316 ProcessorEntry::set_position (Position p, uint32_t num)
321 if (_position_num == 0 || _routing_icon.get_visible()) {
331 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
334 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
336 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
341 ProcessorEntry::setup_visuals ()
343 if (_unknown_processor) {
344 _button.set_name ("processor stub");
350 _button.set_name ("processor prefader");
354 _button.set_name ("processor fader");
358 _button.set_name ("processor postfader");
364 boost::shared_ptr<Processor>
365 ProcessorEntry::processor () const
368 return boost::shared_ptr<Processor>();
374 ProcessorEntry::set_enum_width (Width w)
377 _button.set_text (name (_width));
381 ProcessorEntry::led_clicked(GdkEventButton *ev)
383 bool ctrl_shift_pressed = false;
384 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
386 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
387 ctrl_shift_pressed = true;
391 if (_button.get_active ()) {
392 if (ctrl_shift_pressed) {
393 _parent->all_visible_processors_active(false);
395 if (_position == Fader) {
396 _processor->deactivate ();
400 _processor->deactivate ();
404 if (ctrl_shift_pressed) {
405 _parent->all_visible_processors_active(true);
407 if (_position == Fader) {
408 _processor->activate ();
412 _processor->activate ();
419 ProcessorEntry::processor_active_changed ()
422 _button.set_active (_processor->active());
427 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
429 if (what_changed.contains (ARDOUR::Properties::name)) {
430 _button.set_text (name (_width));
436 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
438 _input_icon.set_ports(in);
439 _output_icon.set_ports(out);
440 _routing_icon.set_sources(in);
441 _routing_icon.set_sinks(out);
442 _input_icon.queue_draw();
443 _output_icon.queue_draw();
444 _routing_icon.queue_draw();
448 ProcessorEntry::setup_tooltip ()
451 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
453 std::string postfix = "";
455 if ((replicated = pi->get_count()) > 1) {
456 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
458 if (pi->plugin()->has_editor()) {
459 ARDOUR_UI_UTILS::set_tooltip (_button,
460 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::primary_modifier_name (), postfix));
462 ARDOUR_UI_UTILS::set_tooltip (_button,
463 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
467 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
468 ARDOUR_UI::instance()->set_tip (_button,
469 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
473 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
477 ProcessorEntry::name (Width w) const
479 boost::shared_ptr<Send> send;
486 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
487 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
491 /* grab the send name out of its overall name */
493 string::size_type lbracket, rbracket;
494 lbracket = send->name().find ('[');
495 rbracket = send->name().find (']');
499 name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
502 name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
507 boost::shared_ptr<ARDOUR::PluginInsert> pi;
509 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
510 && (replicated = pi->get_count()) > 1)
512 name_display += string_compose(_("(%1x1) "), replicated);
517 name_display += _processor->display_name();
520 name_display += PBD::short_version (_processor->display_name(), 5);
530 ProcessorEntry::show_all_controls ()
532 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
533 (*i)->set_visible (true);
536 _parent->update_gui_object_state (this);
540 ProcessorEntry::hide_all_controls ()
542 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
543 (*i)->set_visible (false);
546 _parent->update_gui_object_state (this);
550 ProcessorEntry::add_control_state (XMLNode* node) const
552 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
553 (*i)->add_state (node);
558 ProcessorEntry::set_control_state (XMLNode const * node)
560 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
561 (*i)->set_state (node);
566 ProcessorEntry::state_id () const
568 return string_compose ("processor %1", _processor->id().to_s());
572 ProcessorEntry::hide_things ()
574 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
575 (*i)->hide_things ();
581 ProcessorEntry::build_controls_menu ()
583 using namespace Menu_Helpers;
584 Menu* menu = manage (new Menu);
585 MenuList& items = menu->items ();
588 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
592 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
595 if (!_controls.empty ()) {
596 items.push_back (SeparatorElem ());
599 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
600 items.push_back (CheckMenuElem ((*i)->name ()));
601 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
602 c->set_active ((*i)->visible ());
603 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
610 ProcessorEntry::toggle_control_visibility (Control* c)
612 c->set_visible (!c->visible ());
613 _parent->update_gui_object_state (this);
617 ProcessorEntry::build_send_options_menu ()
619 using namespace Menu_Helpers;
620 Menu* menu = manage (new Menu);
621 MenuList& items = menu->items ();
623 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
626 items.push_back (CheckMenuElem (_("Link panner controls")));
627 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
628 c->set_active (send->panner_shell()->is_linked_to_route());
629 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
636 ProcessorEntry::toggle_panner_link ()
638 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
640 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
644 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
646 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
647 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
648 , _slider_persistant_tooltip (&_slider)
649 , _button (ArdourButton::led_default_elements)
650 , _ignore_ui_adjustment (false)
654 _slider.set_controllable (c);
655 box.set_padding(0, 0, 4, 4);
658 _button.set_text (_name);
659 _button.set_led_left (true);
660 _button.set_name ("processor control button");
664 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
665 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
666 // dup. currently timers are used :(
667 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
671 _slider.set_name ("ProcessorControlSlider");
672 _slider.set_text (_name);
677 const ARDOUR::ParameterDescriptor& desc = c->desc();
678 double const lo = c->internal_to_interface(desc.lower);
679 double const up = c->internal_to_interface(desc.upper);
680 double const normal = c->internal_to_interface(desc.normal);
681 double smallstep = desc.smallstep;
682 double largestep = desc.largestep;
684 if (smallstep == 0.0) {
685 smallstep = up / 1000.;
687 smallstep = c->internal_to_interface(desc.lower + smallstep);
690 if (largestep == 0.0) {
691 largestep = up / 40.;
693 largestep = c->internal_to_interface(desc.lower + largestep);
696 _adjustment.set_lower (lo);
697 _adjustment.set_upper (up);
698 _adjustment.set_step_increment (smallstep);
699 _adjustment.set_page_increment (largestep);
700 _slider.set_default_value (normal);
702 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
703 // dup. currently timers are used :(
704 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
707 // yuck, do we really need to do this?
708 // according to c404374 this is only needed for send automation
709 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
714 /* We're providing our own PersistentTooltip */
715 set_no_tooltip_whatsoever (_slider);
718 ProcessorEntry::Control::~Control ()
720 timer_connection.disconnect ();
724 ProcessorEntry::Control::set_tooltip ()
726 boost::shared_ptr<AutomationControl> c = _control.lock ();
733 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
735 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
738 string sm = Gtkmm2ext::markup_escape_text (tmp);
739 _slider_persistant_tooltip.set_tip (sm);
740 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
744 ProcessorEntry::Control::slider_adjusted ()
746 if (_ignore_ui_adjustment) {
750 boost::shared_ptr<AutomationControl> c = _control.lock ();
756 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
761 ProcessorEntry::Control::button_clicked ()
763 boost::shared_ptr<AutomationControl> c = _control.lock ();
769 bool const n = _button.get_active ();
771 c->set_value (n ? 0 : 1, Controllable::NoGroup);
772 _button.set_active (!n);
777 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
785 ProcessorEntry::Control::control_changed ()
787 boost::shared_ptr<AutomationControl> c = _control.lock ();
792 _ignore_ui_adjustment = true;
796 _button.set_active (c->get_value() > 0.5);
799 // as long as rapid timers are used, only update the tooltip
800 // if the value has changed.
801 const double nval = c->internal_to_interface (c->get_value ());
802 if (_adjustment.get_value() != nval) {
803 _adjustment.set_value (nval);
808 _ignore_ui_adjustment = false;
812 ProcessorEntry::Control::add_state (XMLNode* node) const
814 XMLNode* c = new XMLNode (X_("Object"));
815 c->add_property (X_("id"), state_id ());
816 c->add_property (X_("visible"), _visible);
817 node->add_child_nocopy (*c);
821 ProcessorEntry::Control::set_state (XMLNode const * node)
823 XMLNode* n = GUIObjectState::get_node (node, state_id ());
825 XMLProperty* p = n->property (X_("visible"));
826 set_visible (p && string_is_affirmative (p->value ()));
833 ProcessorEntry::Control::set_visible (bool v)
844 /** Called when the Editor might have re-shown things that
848 ProcessorEntry::Control::hide_things ()
856 ProcessorEntry::Control::state_id () const
858 boost::shared_ptr<AutomationControl> c = _control.lock ();
861 return string_compose (X_("control %1"), c->id().to_s ());
864 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
865 : ProcessorEntry (b, p, w)
868 p->PluginIoReConfigure.connect (
869 _splitting_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::plugin_insert_splitting_changed, this), gui_context()
872 plugin_insert_splitting_changed ();
876 PluginInsertProcessorEntry::plugin_insert_splitting_changed ()
878 ChanCount in, out; // actual configured i/o
879 _plugin_insert->configured_io (in, out);
881 /* get number of input ports */
882 ChanCount sinks = _plugin_insert->natural_input_streams();
883 if (!_plugin_insert->splitting () && _plugin_insert->get_count() > 1) {
884 /* replicated instances */
885 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
886 sinks.set(*t, sinks.get(*t) * _plugin_insert->get_count());
890 if (_plugin_insert->natural_output_streams().n_midi() == 0 &&
891 _plugin_insert->output_streams().n_midi() == 1) {
892 in.set(DataType::MIDI, 1);
893 out.set(DataType::MIDI, 1);
894 sinks.set(DataType::MIDI, 1);
897 /* the Input streams available (*valid* outputs from prev. plugin)
898 * this will be <= sinks. Some input-ports of this processor
899 * may be unconnected.
901 _routing_icon.set_sources(in);
903 /* the actual input ports of this processor */
904 _input_icon.set_ports(sinks);
905 _routing_icon.set_sinks(sinks);
907 /* set/override plugin-output ports to actual outputs-streams.
909 * This plugin may have unconnected output-ports (currently only in Mixbus,
910 * e.g channelstrip-EQ at the top of a MIDI-channel before the synth).
912 * The *next* processor below this one will only see the
913 * actual available streams (it cannot know the real outputs
916 * There is currently no API to query the ports of the previous (or next)
919 * (normally - iff configuration succeeds - this is set during
920 * ProcessorEntry::processor_configuration_changed() and should
921 * equal _plugin_insert->output_streams())
923 _output_icon.set_ports(out);
925 if (out != _plugin_insert->output_streams()) {
926 std::cerr << "Processor Wiring: " << processor()->name()
927 << " out-ports: " << _plugin_insert->output_streams() // NB. does not include midi-bypass
928 << " out-connections: " << out
933 _routing_icon.set_splitting(_plugin_insert->splitting ());
935 if (_plugin_insert->splitting () || in != sinks)
937 _routing_icon.set_size_request (-1, std::max (7.f, rintf(7.f * UIConfiguration::instance().get_ui_scale())));
938 _routing_icon.set_visible(true);
941 _routing_icon.set_visible(false);
942 if (_position_num != 0) {
947 _input_icon.queue_draw();
948 _output_icon.queue_draw();
949 _routing_icon.queue_draw();
953 PluginInsertProcessorEntry::hide_things ()
955 ProcessorEntry::hide_things ();
956 plugin_insert_splitting_changed ();
959 ProcessorEntry::PortIcon::PortIcon(bool input) {
961 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
962 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
966 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
968 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
970 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
973 Gtk::Allocation a = get_allocation();
974 double const width = a.get_width();
975 double const height = a.get_height();
977 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
978 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
980 cairo_rectangle (cr, 0, 0, width, height);
983 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
984 if (_ports.n_total() > 1) {
985 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
986 if (i < _ports.n_midi()) {
987 cairo_set_source_rgb (cr,
988 UINT_RGBA_R_FLT(midi_port_color),
989 UINT_RGBA_G_FLT(midi_port_color),
990 UINT_RGBA_B_FLT(midi_port_color));
992 cairo_set_source_rgb (cr,
993 UINT_RGBA_R_FLT(audio_port_color),
994 UINT_RGBA_G_FLT(audio_port_color),
995 UINT_RGBA_B_FLT(audio_port_color));
997 const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
998 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1001 } else if (_ports.n_total() == 1) {
1002 if (_ports.n_midi() == 1) {
1003 cairo_set_source_rgb (cr,
1004 UINT_RGBA_R_FLT(midi_port_color),
1005 UINT_RGBA_G_FLT(midi_port_color),
1006 UINT_RGBA_B_FLT(midi_port_color));
1008 cairo_set_source_rgb (cr,
1009 UINT_RGBA_R_FLT(audio_port_color),
1010 UINT_RGBA_G_FLT(audio_port_color),
1011 UINT_RGBA_B_FLT(audio_port_color));
1013 const float x = rintf(width * .5);
1014 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1024 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1026 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1028 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1031 cairo_set_line_width (cr, max (1.f, UIConfiguration::instance().get_ui_scale()));
1032 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1034 Gtk::Allocation a = get_allocation();
1035 double const width = a.get_width();
1036 double const height = a.get_height();
1038 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1039 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1041 cairo_rectangle (cr, 0, 0, width, height);
1044 Gdk::Color const fg = get_style()->get_fg (STATE_NORMAL);
1045 cairo_set_source_rgb (cr, fg.get_red_p (), fg.get_green_p (), fg.get_blue_p ());
1047 const uint32_t sources = _sources.n_total();
1048 const uint32_t sinks = _sinks.n_total();
1050 const uint32_t midi_sources = _sources.n_midi();
1051 const uint32_t midi_sinks = _sinks.n_midi();
1052 const uint32_t audio_sources = _sources.n_audio();
1053 const uint32_t audio_sinks = _sinks.n_audio();
1056 cairo_set_source_rgb (cr,
1057 UINT_RGBA_R_FLT(midi_port_color),
1058 UINT_RGBA_G_FLT(midi_port_color),
1059 UINT_RGBA_B_FLT(midi_port_color));
1060 if (midi_sources > 0 && midi_sinks > 0 && sinks > 1 && sources > 1) {
1061 for (uint32_t i = 0 ; i < midi_sources; ++i) {
1062 const float si_x = rintf(width * (.2f + .6f * i / (sinks - 1.f))) + .5f;
1063 const float si_x0 = rintf(width * (.2f + .6f * i / (sources - 1.f))) + .5f;
1064 cairo_move_to (cr, si_x, height);
1065 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1068 } else if (midi_sources == 1 && midi_sinks == 1 && sinks == 1 && sources == 1) {
1069 const float si_x = rintf(width * .5f) + .5f;
1070 cairo_move_to (cr, si_x, height);
1071 cairo_line_to (cr, si_x, 0);
1073 } else if (midi_sources == 1 && midi_sinks == 1) {
1074 /* unusual cases -- removed synth, midi-track w/audio plugins */
1075 const float si_x = rintf(width * (sinks > 1 ? .2f : .5f)) + .5f;
1076 const float si_x0 = rintf(width * (sources > 1 ? .2f : .5f)) + .5f;
1077 cairo_move_to (cr, si_x, height);
1078 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1080 } else if (midi_sources == 0 && midi_sinks == 1) {
1081 const double dx = 1 + rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1083 // TODO connect back to track-input of last midi-out if any, otherwise draw "X"
1084 const float si_x = rintf(width * .2f) + .5f;
1085 cairo_move_to (cr, si_x, height);
1086 cairo_line_to (cr, si_x, height * .66);
1087 cairo_move_to (cr, si_x - dx, height * .66);
1088 cairo_line_to (cr, si_x + dx, height * .66);
1091 } else if (midi_sources != 0 && midi_sinks != 0) {
1092 PBD::warning << string_compose("Programming error: midi routing display: A %1 -> %2 | M %3 -> %4 | T %5 -> %6",
1093 audio_sources, audio_sinks, midi_sources, midi_sinks, sources, sinks) << endmsg;
1098 cairo_set_source_rgb (cr,
1099 UINT_RGBA_R_FLT(audio_port_color),
1100 UINT_RGBA_G_FLT(audio_port_color),
1101 UINT_RGBA_B_FLT(audio_port_color));
1104 assert(audio_sources < 2);
1105 assert(audio_sinks > 1);
1106 /* assume there is only ever one MIDI port */
1107 const float si_x0 = rintf(width * (midi_sources > 0 ? .8f : .5f)) + .5f;
1108 for (uint32_t i = midi_sinks; i < sinks; ++i) {
1109 const float si_x = rintf(width * (.2f + .6f * i / (sinks - 1.f))) + .5f;
1110 cairo_move_to (cr, si_x, height);
1111 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1114 } else if (audio_sources > 1 && sinks > 1) {
1115 for (uint32_t i = 0 ; i < audio_sources; ++i) {
1116 const float si_x = rintf(width * (.2f + .6f * (i + midi_sinks) / (sinks - 1.f))) + .5f;
1117 const float si_x0 = rintf(width * (.2f + .6f * (i + midi_sources) / (sources - 1.f))) + .5f;
1118 cairo_move_to (cr, si_x, height);
1119 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1122 } else if (audio_sources == 1 && audio_sinks > 0) {
1125 si_x = rintf(width * .5f) + .5f;
1127 si_x = rintf(width * (.2f + .6f * midi_sinks / (sinks - 1.f))) + .5f;
1130 si_x0 = rintf(width * .5f) + .5f;
1132 si_x0 = rintf(width * (.2f + .6f * midi_sources / (sources - 1.f))) + .5f;
1134 cairo_move_to (cr, si_x, height);
1135 cairo_curve_to (cr, si_x, 0, si_x0, height, si_x0, 0);
1138 } else if (audio_sources != 0 && audio_sinks != 0) {
1139 PBD::warning << string_compose("Programming error: audio routing display: A %1 -> %2 | M %3 -> %4 | T %5 -> %6",
1140 audio_sources, audio_sinks, midi_sources, midi_sinks, sources, sinks) << endmsg;
1147 static std::list<Gtk::TargetEntry> drop_targets()
1149 std::list<Gtk::TargetEntry> tmp;
1150 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1151 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1152 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // from sidebar
1156 static std::list<Gtk::TargetEntry> drag_targets()
1158 std::list<Gtk::TargetEntry> tmp;
1159 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1160 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1164 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1166 std::list<Gtk::TargetEntry> tmp;
1167 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1171 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1172 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1173 : _parent_strip (parent)
1174 , _owner_is_mixer (owner_is_mixer)
1175 , ab_direction (true)
1176 , _get_plugin_selector (get_plugin_selector)
1178 , _visible_prefader_processors (0)
1179 , _rr_selection(rsel)
1180 , processor_display (drop_targets())
1181 , _redisplay_pending (false)
1188 no_processor_redisplay = false;
1190 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1191 processor_scroller.add (processor_display);
1192 pack_start (processor_scroller, true, true);
1194 processor_display.set_flags (CAN_FOCUS);
1195 processor_display.set_name ("ProcessorList");
1196 processor_display.set_data ("processorbox", this);
1197 processor_display.set_size_request (48, -1);
1198 processor_display.set_spacing (0);
1200 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1201 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1203 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1204 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1206 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1207 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1208 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1210 processor_scroller.show ();
1211 processor_display.show ();
1214 parent->DeliveryChanged.connect (
1215 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1219 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1222 ProcessorBox::~ProcessorBox ()
1224 /* it may appear as if we should delete processor_menu but that is a
1225 * pointer to a widget owned by the UI Manager, and has potentially
1226 * be returned to many other ProcessorBoxes. GTK doesn't really make
1227 * clear the ownership of this widget, which is a menu and thus is
1228 * never packed into any container other than an implict GtkWindow.
1230 * For now, until or if we ever get clarification over the ownership
1231 * story just let it continue to exist. At worst, its a small memory leak.
1236 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1242 _route_connections.drop_connections();
1244 /* new route: any existing block on processor redisplay must be meaningless */
1245 no_processor_redisplay = false;
1248 _route->processors_changed.connect (
1249 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1252 _route->DropReferences.connect (
1253 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1256 _route->PropertyChanged.connect (
1257 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1260 redisplay_processors ();
1264 ProcessorBox::route_going_away ()
1266 /* don't keep updating display as processors are deleted */
1267 no_processor_redisplay = true;
1271 boost::shared_ptr<Processor>
1272 ProcessorBox::find_drop_position (ProcessorEntry* position)
1274 boost::shared_ptr<Processor> p;
1276 p = position->processor ();
1278 /* dropped on the blank entry (which will be before the
1279 fader), so use the first non-blank child as our
1280 `dropped on' processor */
1281 list<ProcessorEntry*> c = processor_display.children ();
1282 list<ProcessorEntry*>::iterator i = c.begin ();
1284 assert (i != c.end ());
1285 p = (*i)->processor ();
1293 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1295 const void * d = data.get_data();
1296 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1298 PluginPresetList nfos;
1300 tv->get_object_drag_data (nfos, &source);
1302 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1303 PluginPresetPtr ppp = (*i);
1304 PluginInfoPtr pip = ppp->_pip;
1305 PluginPtr p = pip->load (*_session);
1310 if (ppp->_preset.valid) {
1311 p->load_preset (ppp->_preset);
1314 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1315 if (Config->get_new_plugins_active ()) {
1316 processor->activate ();
1318 pl.push_back (processor);
1323 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1325 const void * d = data.get_data();
1326 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1327 PluginInfoList nfos;
1330 tv->get_object_drag_data (nfos, &source);
1332 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1333 PluginPtr p = (*i)->load (*_session);
1337 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1338 if (Config->get_new_plugins_active ()) {
1339 processor->activate ();
1341 pl.push_back (processor);
1346 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1352 boost::shared_ptr<Processor> p = find_drop_position (position);
1353 Route::ProcessorList pl;
1355 if (data.get_target() == "PluginInfoPtr") {
1356 _drop_plugin (data, pl);
1358 else if (data.get_target() == "PluginPresetPtr") {
1359 _drop_plugin_preset (data, pl);
1365 Route::ProcessorStreams err;
1366 if (_route->add_processors (pl, p, &err)) {
1368 "Processor Drag/Drop failed. Probably because\n\
1369 the I/O configuration of the plugins could\n\
1370 not match the configuration of this track.");
1371 MessageDialog am (msg);
1377 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1379 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1380 list<ProcessorEntry*> children = source->selection ();
1381 assert (children.size() == 1);
1382 ProcessorEntry* other = *children.begin();
1383 assert (other->can_copy_state (position));
1384 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1385 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1386 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1387 assert (otherproc && proc && pi);
1389 PBD::ID id = pi->id();
1390 XMLNode& state = otherproc->get_state ();
1391 proc->set_state (state, Stateful::loading_state_version);
1392 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1396 boost::shared_ptr<Processor> p = find_drop_position (position);
1398 list<ProcessorEntry*> children = source->selection ();
1399 list<boost::shared_ptr<Processor> > procs;
1400 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1401 if ((*i)->processor ()) {
1402 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1405 procs.push_back ((*i)->processor ());
1409 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1410 XMLNode& state = (*i)->get_state ();
1412 nlist.push_back (&state);
1413 paste_processor_state (nlist, p);
1417 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1421 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1422 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1424 other->delete_dragged_processors (procs);
1430 ProcessorBox::set_width (Width w)
1438 list<ProcessorEntry*> children = processor_display.children ();
1439 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1440 (*i)->set_enum_width (w);
1447 ProcessorBox::build_possible_aux_menu ()
1449 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1452 /* No aux sends if there are no busses */
1456 if (_route->is_monitor ()) {
1460 using namespace Menu_Helpers;
1461 Menu* menu = manage (new Menu);
1462 MenuList& items = menu->items();
1464 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1465 if (!_route->internal_send_for (*r) && *r != _route) {
1466 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
1474 ProcessorBox::show_processor_menu (int arg)
1476 if (processor_menu == 0) {
1477 processor_menu = build_processor_menu ();
1478 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
1481 /* Sort out the plugin submenu */
1483 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
1485 if (plugin_menu_item) {
1486 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
1489 /* And the aux submenu */
1491 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
1493 if (aux_menu_item) {
1494 Menu* m = build_possible_aux_menu();
1495 if (m && !m->items().empty()) {
1496 aux_menu_item->set_submenu (*m);
1497 aux_menu_item->set_sensitive (true);
1499 /* stupid gtkmm: we need to pass a null reference here */
1500 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
1501 aux_menu_item->set_sensitive (false);
1505 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
1506 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
1508 ProcessorEntry* single_selection = 0;
1509 if (processor_display.selection().size() == 1) {
1510 single_selection = processor_display.selection().front();
1513 /* And the controls submenu */
1515 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
1517 if (controls_menu_item) {
1518 if (single_selection) {
1519 Menu* m = single_selection->build_controls_menu ();
1520 if (m && !m->items().empty()) {
1521 controls_menu_item->set_submenu (*m);
1522 controls_menu_item->set_sensitive (true);
1524 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
1525 controls_menu_item->set_sensitive (false);
1528 controls_menu_item->set_sensitive (false);
1532 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
1533 if (send_menu_item) {
1534 if (single_selection && !_route->is_monitor()) {
1535 Menu* m = single_selection->build_send_options_menu ();
1536 if (m && !m->items().empty()) {
1537 send_menu_item->set_submenu (*m);
1538 send_menu_item->set_sensitive (true);
1540 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
1541 send_menu_item->set_sensitive (false);
1544 send_menu_item->set_sensitive (false);
1548 /* Sensitise actions as approprioate */
1551 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
1553 paste_action->set_sensitive (!_rr_selection.processors.empty());
1554 cut_action->set_sensitive (sensitive && can_cut ());
1555 copy_action->set_sensitive (sensitive);
1556 delete_action->set_sensitive (sensitive || stub_processor_selected ());
1558 edit_action->set_sensitive (one_processor_can_be_edited ());
1559 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
1561 boost::shared_ptr<PluginInsert> pi;
1562 if (single_selection) {
1563 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
1566 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
1567 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
1569 /* disallow rename for multiple selections, for plugin inserts and for the fader */
1570 rename_action->set_sensitive (single_selection
1572 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
1573 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
1575 processor_menu->popup (1, arg);
1577 /* Add a placeholder gap to the processor list to indicate where a processor would be
1578 inserted were one chosen from the menu.
1581 processor_display.get_pointer (x, y);
1582 _placement = processor_display.add_placeholder (y);
1584 if (_visible_prefader_processors == 0 && _placement > 0) {
1590 ProcessorBox::enter_notify (GdkEventCrossing*)
1592 _current_processor_box = this;
1597 ProcessorBox::leave_notify (GdkEventCrossing*)
1603 ProcessorBox::processor_operation (ProcessorOperation op)
1605 ProcSelection targets;
1607 get_selected_processors (targets);
1609 /* if (targets.empty()) {
1612 processor_display.get_pointer (x, y);
1614 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
1616 if (pointer.first && pointer.first->processor()) {
1617 targets.push_back (pointer.first->processor ());
1622 if ( (op == ProcessorsDelete) && targets.empty() )
1623 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
1626 case ProcessorsSelectAll:
1627 processor_display.select_all ();
1630 case ProcessorsSelectNone:
1631 processor_display.select_none ();
1634 case ProcessorsCopy:
1635 copy_processors (targets);
1639 cut_processors (targets);
1642 case ProcessorsPaste:
1643 // some processors are not selectable (e.g fader, meter), target is empty.
1644 if (targets.empty() && _placement >= 0) {
1646 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
1648 targets.push_back (proc);
1651 if (targets.empty()) {
1652 paste_processors ();
1654 paste_processors (targets.front());
1658 case ProcessorsDelete:
1659 delete_processors (targets);
1662 case ProcessorsToggleActive:
1663 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
1664 if ((*i)->active()) {
1665 (*i)->deactivate ();
1683 ProcessorWindowProxy*
1684 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
1686 return processor->window_proxy();
1691 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
1693 boost::shared_ptr<Processor> processor;
1695 processor = child->processor ();
1699 bool selected = processor_display.selected (child);
1701 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
1703 if (_session->engine().connected()) {
1704 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
1706 if (!one_processor_can_be_edited ()) {
1710 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1711 generic_edit_processor (processor);
1713 edit_processor (processor);
1719 } else if (Keyboard::is_context_menu_event (ev)) {
1721 show_processor_menu (ev->time);
1725 } else if (processor && ev->button == 1 && selected) {
1727 // this is purely informational but necessary for route params UI
1728 ProcessorSelected (processor); // emit
1730 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
1733 _get_plugin_selector()->show_manager ();
1740 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
1742 boost::shared_ptr<Processor> processor;
1744 processor = child->processor ();
1747 if (processor && Keyboard::is_delete_event (ev)) {
1749 Glib::signal_idle().connect (sigc::bind (
1750 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
1751 boost::weak_ptr<Processor>(processor)));
1753 } else if (processor && Keyboard::is_button2_event (ev)
1755 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
1759 /* button2-click with no/appropriate modifiers */
1761 if (processor->active()) {
1762 processor->deactivate ();
1764 processor->activate ();
1772 ProcessorBox::build_processor_menu ()
1774 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
1775 processor_menu->set_name ("ArdourContextMenu");
1776 return processor_menu;
1780 ProcessorBox::select_all_processors ()
1782 processor_display.select_all ();
1786 ProcessorBox::deselect_all_processors ()
1788 processor_display.select_none ();
1792 ProcessorBox::choose_plugin ()
1794 _get_plugin_selector()->set_interested_object (*this);
1797 /** @return true if an error occurred, otherwise false */
1799 ProcessorBox::choose_lua ()
1801 LuaScriptInfoPtr spi;
1803 ScriptSelector ss (_("Add Lua DSP Processor"), LuaScriptInfo::DSP);
1804 switch (ss.run ()) {
1805 case Gtk::RESPONSE_ACCEPT:
1814 LuaPluginInfoPtr lpi (new LuaPluginInfo(spi));
1815 p = (lpi->load (*_session));
1818 "Failed to instantiate Lua DSP Processor,\n"
1819 "probably because the script is invalid (no dsp function).");
1820 MessageDialog am (msg);
1825 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1827 Route::ProcessorStreams err_streams;
1828 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1830 "Failed to add Lua DSP Processor at the given position,\n"
1831 "probably because the I/O configuration of the plugins\n"
1832 "could not match the configuration of this track.");
1833 MessageDialog am (msg);
1839 /** @return true if an error occurred, otherwise false */
1841 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
1843 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
1845 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
1847 Route::ProcessorStreams err_streams;
1849 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
1850 weird_plugin_dialog (**p, err_streams);
1852 // XXX SHAREDPTR delete plugin here .. do we even need to care?
1853 } else if (plugins.size() == 1 && Config->get_open_gui_after_adding_plugin()) {
1854 if (_session->engine().connected () && processor_can_be_edited (processor)) {
1855 if ((*p)->has_editor ()) {
1856 edit_processor (processor);
1858 generic_edit_processor (processor);
1868 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
1870 ArdourDialog dialog (_("Plugin Incompatibility"));
1873 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
1874 p.name(), streams.index);
1876 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
1877 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
1879 text += _("\nThis plugin has:\n");
1881 uint32_t const n = p.get_info()->n_inputs.n_midi ();
1882 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
1885 uint32_t const n = p.get_info()->n_inputs.n_audio ();
1886 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
1889 text += _("\nbut at the insertion point, there are:\n");
1891 uint32_t const n = streams.count.n_midi ();
1892 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
1895 uint32_t const n = streams.count.n_audio ();
1896 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
1899 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
1900 label.set_text(text);
1902 dialog.get_vbox()->pack_start (label);
1903 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
1905 dialog.set_name (X_("PluginIODialog"));
1906 dialog.set_modal (true);
1913 ProcessorBox::choose_insert ()
1915 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
1916 _route->add_processor_by_index (processor, _placement);
1919 /* Caller must not hold process lock */
1921 ProcessorBox::choose_send ()
1923 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
1924 boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
1926 /* make an educated guess at the initial number of outputs for the send */
1927 ChanCount outs = (_session->master_out())
1928 ? _session->master_out()->n_outputs()
1929 : _route->n_outputs();
1931 /* XXX need processor lock on route */
1933 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
1934 send->output()->ensure_io (outs, false, this);
1935 } catch (AudioEngine::PortRegistrationFailure& err) {
1936 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
1940 /* let the user adjust the IO setup before creation.
1942 Note: this dialog is NOT modal - we just leave it to run and it will
1943 return when its Finished signal is emitted - typically when the window
1947 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
1950 /* keep a reference to the send so it doesn't get deleted while
1951 the IOSelectorWindow is doing its stuff
1953 _processor_being_created = send;
1955 ios->selector().Finished.connect (sigc::bind (
1956 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
1957 boost::weak_ptr<Processor>(send), ios));
1962 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1964 boost::shared_ptr<Processor> processor (weak_processor.lock());
1966 /* drop our temporary reference to the new send */
1967 _processor_being_created.reset ();
1974 case IOSelector::Cancelled:
1975 // processor will go away when all shared_ptrs to it vanish
1978 case IOSelector::Accepted:
1979 _route->add_processor_by_index (processor, _placement);
1983 delete_when_idle (ios);
1987 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
1989 boost::shared_ptr<Processor> processor (weak_processor.lock());
1991 /* drop our temporary reference to the new return */
1992 _processor_being_created.reset ();
1999 case IOSelector::Cancelled:
2000 // processor will go away when all shared_ptrs to it vanish
2003 case IOSelector::Accepted:
2004 _route->add_processor_by_index (processor, _placement);
2008 delete_when_idle (ios);
2012 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2018 boost::shared_ptr<Route> target = wr.lock();
2024 _session->add_internal_send (target, _placement, _route);
2028 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2030 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2031 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2035 redisplay_processors ();
2039 ProcessorBox::redisplay_processors ()
2041 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2044 if (no_processor_redisplay) {
2048 processor_display.clear ();
2050 _visible_prefader_processors = 0;
2053 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2054 &_visible_prefader_processors, &fader_seen));
2056 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2057 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2058 setup_entry_positions ();
2061 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2062 * not already have one.
2065 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2067 boost::shared_ptr<Processor> p = w.lock ();
2071 if (p->window_proxy()) {
2075 /* not on the list; add it */
2078 #if 0 // is this still needed? Why?
2079 if (_parent_strip) {
2080 if (_parent_strip->mixer_owned()) {
2092 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2093 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2097 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2100 wp->set_state (*ui_xml, 0);
2103 void* existing_ui = p->get_ui ();
2106 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2109 p->set_window_proxy (wp);
2110 WM::Manager::instance().register_window (wp);
2114 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2116 boost::shared_ptr<Processor> processor (p.lock ());
2118 if (processor && ( processor->display_to_user()
2120 || show_all_processors
2125 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2126 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2137 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2139 boost::shared_ptr<Processor> processor (p.lock ());
2141 if (!processor || ( !processor->display_to_user()
2143 && !show_all_processors
2150 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2152 ProcessorEntry* e = 0;
2153 if (plugin_insert) {
2154 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2156 e = new ProcessorEntry (this, processor, _width);
2159 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2160 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2161 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2163 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2164 if (!send && !plugin_insert && !ext && !stub)
2165 e->set_selectable(false);
2167 bool mark_send_visible = false;
2168 if (send && _parent_strip) {
2169 /* show controls of new sends by default */
2170 GUIObjectState& st = _parent_strip->gui_object_state ();
2171 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2173 /* check if state exists, if not it must be a new send */
2174 if (!st.get_node(strip, e->state_id())) {
2175 mark_send_visible = true;
2179 /* Set up this entry's state from the GUIObjectState */
2180 XMLNode* proc = entry_gui_object_state (e);
2182 e->set_control_state (proc);
2185 if (mark_send_visible) {
2186 e->show_all_controls ();
2191 && !plugin_insert->plugin(0)->is_channelstrip()
2195 processor_display.add_child (e, drag_targets());
2197 processor_display.add_child (e, drag_targets_noplugin());
2202 ProcessorBox::reordered ()
2204 compute_processor_sort_keys ();
2205 setup_entry_positions ();
2209 ProcessorBox::setup_entry_positions ()
2211 list<ProcessorEntry*> children = processor_display.children ();
2212 bool pre_fader = true;
2215 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2216 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2217 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2219 (*i)->set_position (ProcessorEntry::Fader, num++);
2222 (*i)->set_position (ProcessorEntry::PreFader, num++);
2224 (*i)->set_position (ProcessorEntry::PostFader, num++);
2231 ProcessorBox::compute_processor_sort_keys ()
2233 list<ProcessorEntry*> children = processor_display.children ();
2234 Route::ProcessorList our_processors;
2236 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2237 if ((*i)->processor()) {
2238 our_processors.push_back ((*i)->processor ());
2242 if (_route->reorder_processors (our_processors)) {
2243 /* Reorder failed, so report this to the user. As far as I can see this must be done
2244 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2245 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2246 when the drag is torn down after this handler function is finished.
2248 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2253 ProcessorBox::report_failed_reorder ()
2255 /* reorder failed, so redisplay */
2257 redisplay_processors ();
2259 /* now tell them about the problem */
2261 ArdourDialog dialog (_("Plugin Incompatibility"));
2264 label.set_text (_("\
2265 You cannot reorder these plugins/sends/inserts\n\
2266 in that way because the inputs and\n\
2267 outputs will not work correctly."));
2269 dialog.get_vbox()->set_border_width (12);
2270 dialog.get_vbox()->pack_start (label);
2271 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2273 dialog.set_name (X_("PluginIODialog"));
2274 dialog.set_modal (true);
2281 ProcessorBox::rename_processors ()
2283 ProcSelection to_be_renamed;
2285 get_selected_processors (to_be_renamed);
2287 if (to_be_renamed.empty()) {
2291 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2292 rename_processor (*i);
2297 ProcessorBox::can_cut () const
2299 vector<boost::shared_ptr<Processor> > sel;
2301 get_selected_processors (sel);
2303 /* cut_processors () does not cut inserts */
2305 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2307 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2308 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2309 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2318 ProcessorBox::stub_processor_selected () const
2320 vector<boost::shared_ptr<Processor> > sel;
2322 get_selected_processors (sel);
2324 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2325 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
2334 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
2336 if (to_be_removed.empty()) {
2340 XMLNode* node = new XMLNode (X_("cut"));
2341 Route::ProcessorList to_cut;
2343 no_processor_redisplay = true;
2344 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
2345 // Cut only plugins, sends and returns
2346 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2347 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2348 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2350 Window* w = get_processor_ui (*i);
2356 XMLNode& child ((*i)->get_state());
2357 node->add_child_nocopy (child);
2358 to_cut.push_back (*i);
2362 if (_route->remove_processors (to_cut) != 0) {
2364 no_processor_redisplay = false;
2368 _rr_selection.set (node);
2370 no_processor_redisplay = false;
2371 redisplay_processors ();
2375 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
2377 if (to_be_copied.empty()) {
2381 XMLNode* node = new XMLNode (X_("copy"));
2383 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
2384 // Copy only plugins, sends, returns
2385 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2386 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2387 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
2388 node->add_child_nocopy ((*i)->get_state());
2392 _rr_selection.set (node);
2396 ProcessorBox::delete_processors (const ProcSelection& targets)
2398 if (targets.empty()) {
2402 no_processor_redisplay = true;
2404 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
2406 Window* w = get_processor_ui (*i);
2412 _route->remove_processor(*i);
2415 no_processor_redisplay = false;
2416 redisplay_processors ();
2420 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
2422 list<boost::shared_ptr<Processor> >::const_iterator x;
2424 no_processor_redisplay = true;
2425 for (x = procs.begin(); x != procs.end(); ++x) {
2427 Window* w = get_processor_ui (*x);
2433 _route->remove_processor(*x);
2436 no_processor_redisplay = false;
2437 redisplay_processors ();
2441 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
2443 boost::shared_ptr<Processor> processor (weak_processor.lock());
2449 /* NOT copied to _mixer.selection() */
2451 no_processor_redisplay = true;
2452 _route->remove_processor (processor);
2453 no_processor_redisplay = false;
2454 redisplay_processors ();
2460 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
2462 ArdourPrompter name_prompter (true);
2464 name_prompter.set_title (_("Rename Processor"));
2465 name_prompter.set_prompt (_("New name:"));
2466 name_prompter.set_initial_text (processor->name());
2467 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
2468 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
2469 name_prompter.show_all ();
2471 switch (name_prompter.run ()) {
2473 case Gtk::RESPONSE_ACCEPT:
2474 name_prompter.get_result (result);
2475 if (result.length()) {
2478 string test = result;
2480 while (tries < 100) {
2481 if (_session->io_name_is_legal (test)) {
2487 test = string_compose ("%1-%2", result, tries);
2491 processor->set_name (result);
2494 ARDOUR_UI::instance()->popup_error
2495 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
2505 ProcessorBox::paste_processors ()
2507 if (_rr_selection.processors.empty()) {
2511 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
2515 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
2518 if (_rr_selection.processors.empty()) {
2522 paste_processor_state (_rr_selection.processors.get_node().children(), before);
2526 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
2528 XMLNodeConstIterator niter;
2529 list<boost::shared_ptr<Processor> > copies;
2531 if (nlist.empty()) {
2535 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2537 XMLProperty const * type = (*niter)->property ("type");
2538 XMLProperty const * role = (*niter)->property ("role");
2541 boost::shared_ptr<Processor> p;
2543 if (type->value() == "meter" ||
2544 type->value() == "main-outs" ||
2545 type->value() == "amp" ||
2546 type->value() == "intreturn") {
2547 /* do not paste meter, main outs, amp or internal returns */
2550 } else if (type->value() == "intsend") {
2552 /* aux sends are OK, but those used for
2553 * other purposes, are not.
2558 if (role->value() != "Aux") {
2562 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2563 XMLNode n (**niter);
2564 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
2565 _route, boost::shared_ptr<Route>(), Delivery::Aux);
2567 IOProcessor::prepare_for_reset (n, s->name());
2569 if (s->set_state (n, Stateful::loading_state_version)) {
2576 } else if (type->value() == "send") {
2578 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2579 XMLNode n (**niter);
2581 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
2583 IOProcessor::prepare_for_reset (n, s->name());
2585 if (s->set_state (n, Stateful::loading_state_version)) {
2592 } else if (type->value() == "return") {
2594 XMLNode n (**niter);
2595 Return* r = new Return (*_session);
2597 IOProcessor::prepare_for_reset (n, r->name());
2599 if (r->set_state (n, Stateful::loading_state_version)) {
2606 } else if (type->value() == "port") {
2608 XMLNode n (**niter);
2609 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
2611 IOProcessor::prepare_for_reset (n, pi->name());
2613 if (pi->set_state (n, Stateful::loading_state_version)) {
2619 /* XXX its a bit limiting to assume that everything else
2622 p.reset (new PluginInsert (*_session));
2623 PBD::ID id = p->id();
2624 p->set_state (**niter, Stateful::current_state_version);
2625 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
2628 copies.push_back (p);
2632 error << _("plugin insert constructor failed") << endmsg;
2636 if (copies.empty()) {
2640 if (_route->add_processors (copies, p)) {
2643 "Copying the set of processors on the clipboard failed,\n\
2644 probably because the I/O configuration of the plugins\n\
2645 could not match the configuration of this track.");
2646 MessageDialog am (msg);
2652 ProcessorBox::get_selected_processors (ProcSelection& processors) const
2654 const list<ProcessorEntry*> selection = processor_display.selection ();
2655 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
2656 processors.push_back ((*i)->processor ());
2661 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
2663 list<ProcessorEntry*> selection = processor_display.selection ();
2664 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
2665 (this->*method) ((*i)->processor ());
2670 ProcessorBox::all_visible_processors_active (bool state)
2672 _route->all_visible_processors_active (state);
2676 ProcessorBox::ab_plugins ()
2678 _route->ab_plugins (ab_direction);
2679 ab_direction = !ab_direction;
2684 ProcessorBox::clear_processors ()
2687 vector<string> choices;
2689 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
2690 "(this cannot be undone)"), _route->name());
2692 choices.push_back (_("Cancel"));
2693 choices.push_back (_("Yes, remove them all"));
2695 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2697 if (prompter.run () == 1) {
2698 _route->clear_processors (PreFader);
2699 _route->clear_processors (PostFader);
2704 ProcessorBox::clear_processors (Placement p)
2707 vector<string> choices;
2709 if (p == PreFader) {
2710 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
2711 "(this cannot be undone)"), _route->name());
2713 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
2714 "(this cannot be undone)"), _route->name());
2717 choices.push_back (_("Cancel"));
2718 choices.push_back (_("Yes, remove them all"));
2720 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
2722 if (prompter.run () == 1) {
2723 _route->clear_processors (p);
2728 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
2730 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
2731 if (at && at->freeze_state() == AudioTrack::Frozen) {
2736 boost::dynamic_pointer_cast<Send> (processor) ||
2737 boost::dynamic_pointer_cast<Return> (processor) ||
2738 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
2739 boost::dynamic_pointer_cast<PortInsert> (processor)
2748 ProcessorBox::one_processor_can_be_edited ()
2750 list<ProcessorEntry*> selection = processor_display.selection ();
2751 list<ProcessorEntry*>::iterator i = selection.begin();
2752 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
2756 return (i != selection.end());
2760 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
2762 boost::shared_ptr<Send> send;
2763 boost::shared_ptr<InternalSend> internal_send;
2764 boost::shared_ptr<Return> retrn;
2765 boost::shared_ptr<PluginInsert> plugin_insert;
2766 boost::shared_ptr<PortInsert> port_insert;
2769 /* This method may or may not return a Window, but if it does not it
2770 * will modify the parent mixer strip appearance layout to allow
2771 * "editing" the @param processor that was passed in.
2773 * So for example, if the processor is an Amp (gain), the parent strip
2774 * will be forced back into a model where the fader controls the main gain.
2775 * If the processor is a send, then we map the send controls onto the
2778 * Plugins and others will return a window for control.
2781 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
2783 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
2788 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
2790 if (_parent_strip) {
2791 _parent_strip->revert_to_default_display ();
2794 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
2796 if (!_session->engine().connected()) {
2800 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
2802 gidget = new SendUIWindow (send, _session);
2805 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
2807 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
2808 /* no GUI for these */
2812 if (!_session->engine().connected()) {
2816 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
2818 ReturnUIWindow *return_ui;
2819 Window* w = get_processor_ui (retrn);
2823 return_ui = new ReturnUIWindow (retrn, _session);
2824 return_ui->set_title (retrn->name ());
2825 set_processor_ui (send, return_ui);
2828 return_ui = dynamic_cast<ReturnUIWindow *> (w);
2833 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
2835 PluginUIWindow *plugin_ui;
2837 /* these are both allowed to be null */
2839 Window* w = get_processor_ui (plugin_insert);
2842 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
2843 plugin_ui->set_title (generate_processor_title (plugin_insert));
2844 set_processor_ui (plugin_insert, plugin_ui);
2847 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
2852 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
2854 if (!_session->engine().connected()) {
2855 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
2860 PortInsertWindow *io_selector;
2862 Window* w = get_processor_ui (port_insert);
2865 io_selector = new PortInsertWindow (_session, port_insert);
2866 set_processor_ui (port_insert, io_selector);
2869 io_selector = dynamic_cast<PortInsertWindow *> (w);
2872 gidget = io_selector;
2879 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
2881 boost::shared_ptr<PluginInsert> plugin_insert
2882 = boost::dynamic_pointer_cast<PluginInsert>(processor);
2884 if (!plugin_insert) {
2888 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
2889 win->set_title (generate_processor_title (plugin_insert));
2895 ProcessorBox::register_actions ()
2897 Glib::RefPtr<Gtk::ActionGroup> popup_act_grp = processor_box_actions.create_action_group (X_("ProcessorMenu"));
2898 Glib::RefPtr<Action> act;
2901 processor_box_actions.register_action (popup_act_grp, X_("newplugin"), _("New Plugin"),
2902 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
2904 act = processor_box_actions.register_action (popup_act_grp, X_("newlua"), _("New Lua Proc"),
2905 sigc::ptr_fun (ProcessorBox::rb_choose_lua));
2906 act = processor_box_actions.register_action (popup_act_grp, X_("newinsert"), _("New Insert"),
2907 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
2908 ActionManager::engine_sensitive_actions.push_back (act);
2909 act = processor_box_actions.register_action (popup_act_grp, X_("newsend"), _("New External Send ..."),
2910 sigc::ptr_fun (ProcessorBox::rb_choose_send));
2911 ActionManager::engine_sensitive_actions.push_back (act);
2913 processor_box_actions.register_action (popup_act_grp, X_("newaux"), _("New Aux Send ..."));
2915 processor_box_actions.register_action (popup_act_grp, X_("controls"), _("Controls"));
2916 processor_box_actions.register_action (popup_act_grp, X_("send_options"), _("Send Options"));
2918 processor_box_actions.register_action (popup_act_grp, X_("clear"), _("Clear (all)"),
2919 sigc::ptr_fun (ProcessorBox::rb_clear));
2920 processor_box_actions.register_action (popup_act_grp, X_("clear_pre"), _("Clear (pre-fader)"),
2921 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
2922 processor_box_actions.register_action (popup_act_grp, X_("clear_post"), _("Clear (post-fader)"),
2923 sigc::ptr_fun (ProcessorBox::rb_clear_post));
2925 /* standard editing stuff */
2927 cut_action = processor_box_actions.register_action (popup_act_grp, X_("cut"), _("Cut"),
2928 sigc::ptr_fun (ProcessorBox::rb_cut));
2929 copy_action = processor_box_actions.register_action (popup_act_grp, X_("copy"), _("Copy"),
2930 sigc::ptr_fun (ProcessorBox::rb_copy));
2931 delete_action = processor_box_actions.register_action (popup_act_grp, X_("delete"), _("Delete"),
2932 sigc::ptr_fun (ProcessorBox::rb_delete));
2934 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
2935 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
2936 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
2938 paste_action = processor_box_actions.register_action (popup_act_grp, X_("paste"), _("Paste"),
2939 sigc::ptr_fun (ProcessorBox::rb_paste));
2940 rename_action = processor_box_actions.register_action (popup_act_grp, X_("rename"), _("Rename"),
2941 sigc::ptr_fun (ProcessorBox::rb_rename));
2942 processor_box_actions.register_action (popup_act_grp, X_("selectall"), _("Select All"),
2943 sigc::ptr_fun (ProcessorBox::rb_select_all));
2944 processor_box_actions.register_action (popup_act_grp, X_("deselectall"), _("Deselect All"),
2945 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
2947 /* activation etc. */
2949 processor_box_actions.register_action (popup_act_grp, X_("activate_all"), _("Activate All"),
2950 sigc::ptr_fun (ProcessorBox::rb_activate_all));
2951 processor_box_actions.register_action (popup_act_grp, X_("deactivate_all"), _("Deactivate All"),
2952 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
2953 processor_box_actions.register_action (popup_act_grp, X_("ab_plugins"), _("A/B Plugins"),
2954 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
2957 edit_action = processor_box_actions.register_action (
2958 popup_act_grp, X_("edit"), _("Edit..."),
2959 sigc::ptr_fun (ProcessorBox::rb_edit));
2961 edit_generic_action = processor_box_actions.register_action (
2962 popup_act_grp, X_("edit-generic"), _("Edit with generic controls..."),
2963 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
2967 ProcessorBox::rb_edit_generic ()
2969 if (_current_processor_box == 0) {
2973 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
2977 ProcessorBox::rb_ab_plugins ()
2979 if (_current_processor_box == 0) {
2983 _current_processor_box->ab_plugins ();
2987 ProcessorBox::rb_choose_plugin ()
2989 if (_current_processor_box == 0) {
2992 _current_processor_box->choose_plugin ();
2996 ProcessorBox::rb_choose_lua ()
2998 if (_current_processor_box == 0) {
3001 _current_processor_box->choose_lua ();
3005 ProcessorBox::rb_choose_insert ()
3007 if (_current_processor_box == 0) {
3010 _current_processor_box->choose_insert ();
3014 ProcessorBox::rb_choose_send ()
3016 if (_current_processor_box == 0) {
3019 _current_processor_box->choose_send ();
3023 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3025 if (_current_processor_box == 0) {
3029 _current_processor_box->choose_aux (wr);
3033 ProcessorBox::rb_clear ()
3035 if (_current_processor_box == 0) {
3039 _current_processor_box->clear_processors ();
3044 ProcessorBox::rb_clear_pre ()
3046 if (_current_processor_box == 0) {
3050 _current_processor_box->clear_processors (PreFader);
3055 ProcessorBox::rb_clear_post ()
3057 if (_current_processor_box == 0) {
3061 _current_processor_box->clear_processors (PostFader);
3065 ProcessorBox::rb_cut ()
3067 if (_current_processor_box == 0) {
3071 _current_processor_box->processor_operation (ProcessorsCut);
3075 ProcessorBox::rb_delete ()
3077 if (_current_processor_box == 0) {
3081 _current_processor_box->processor_operation (ProcessorsDelete);
3085 ProcessorBox::rb_copy ()
3087 if (_current_processor_box == 0) {
3090 _current_processor_box->processor_operation (ProcessorsCopy);
3094 ProcessorBox::rb_paste ()
3096 if (_current_processor_box == 0) {
3100 _current_processor_box->processor_operation (ProcessorsPaste);
3104 ProcessorBox::rb_rename ()
3106 if (_current_processor_box == 0) {
3109 _current_processor_box->rename_processors ();
3113 ProcessorBox::rb_select_all ()
3115 if (_current_processor_box == 0) {
3119 _current_processor_box->processor_operation (ProcessorsSelectAll);
3123 ProcessorBox::rb_deselect_all ()
3125 if (_current_processor_box == 0) {
3129 _current_processor_box->deselect_all_processors ();
3133 ProcessorBox::rb_activate_all ()
3135 if (_current_processor_box == 0) {
3139 _current_processor_box->all_visible_processors_active (true);
3143 ProcessorBox::rb_deactivate_all ()
3145 if (_current_processor_box == 0) {
3148 _current_processor_box->all_visible_processors_active (false);
3152 ProcessorBox::rb_edit ()
3154 if (_current_processor_box == 0) {
3158 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3162 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3164 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3168 if (_parent_strip) {
3169 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3170 if (_parent_strip->current_delivery() == send) {
3171 _parent_strip->revert_to_default_display ();
3173 _parent_strip->show_send(send);
3180 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3185 if (edit_aux_send (processor)) {
3189 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3192 proxy->set_custom_ui_mode (true);
3193 proxy->show_the_right_window ();
3198 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3203 if (edit_aux_send (processor)) {
3207 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3210 proxy->set_custom_ui_mode (false);
3211 proxy->show_the_right_window ();
3216 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3218 if (!what_changed.contains (ARDOUR::Properties::name)) {
3222 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3224 boost::shared_ptr<Processor> processor;
3225 boost::shared_ptr<PluginInsert> plugin_insert;
3226 boost::shared_ptr<Send> send;
3228 list<ProcessorEntry*> children = processor_display.children();
3230 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3232 processor = (*iter)->processor ();
3238 Window* w = get_processor_ui (processor);
3244 /* rename editor windows for sends and plugins */
3246 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3247 w->set_title (send->name ());
3248 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3249 w->set_title (generate_processor_title (plugin_insert));
3255 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3257 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3258 string::size_type email_pos;
3260 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3261 maker = maker.substr (0, email_pos - 1);
3264 if (maker.length() > 32) {
3265 maker = maker.substr (0, 32);
3269 SessionObject* owner = pi->owner();
3272 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
3274 return string_compose(_("%1 (by %2)"), pi->name(), maker);
3278 /** @param p Processor.
3279 * @return the UI window for \a p.
3282 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
3284 ProcessorWindowProxy* wp = p->window_proxy();
3291 /** Make a note of the UI window that a processor is using.
3292 * @param p Processor.
3293 * @param w UI window.
3296 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
3298 assert (p->window_proxy());
3300 p->window_proxy()->use_window (*w);
3304 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
3306 boost::shared_ptr<Delivery> d = w.lock ();
3311 list<ProcessorEntry*> children = processor_display.children ();
3312 list<ProcessorEntry*>::const_iterator i = children.begin();
3313 while (i != children.end() && (*i)->processor() != d) {
3317 if (i == children.end()) {
3318 processor_display.set_active (0);
3320 processor_display.set_active (*i);
3324 /** Called to repair the damage of Editor::show_window doing a show_all() */
3326 ProcessorBox::hide_things ()
3328 list<ProcessorEntry*> c = processor_display.children ();
3329 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
3330 (*i)->hide_things ();
3335 ProcessorBox::processor_menu_unmapped ()
3337 processor_display.remove_placeholder ();
3341 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
3343 if (!_parent_strip) {
3347 GUIObjectState& st = _parent_strip->gui_object_state ();
3349 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
3351 return st.get_or_add_node (strip, entry->state_id());
3355 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
3357 XMLNode* proc = entry_gui_object_state (entry);
3362 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
3363 proc->remove_nodes_and_delete (X_("Object"));
3364 entry->add_control_state (proc);
3368 ProcessorBox::is_editor_mixer_strip() const
3370 return _parent_strip && !_parent_strip->mixer_owned();
3373 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
3374 : WM::ProxyBase (name, string())
3375 , _processor_box (box)
3376 , _processor (processor)
3378 , want_custom (false)
3380 boost::shared_ptr<Processor> p = _processor.lock ();
3384 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
3387 ProcessorWindowProxy::~ProcessorWindowProxy()
3389 /* processor window proxies do not own the windows they create with
3390 * ::get(), so set _window to null before the normal WindowProxy method
3397 ProcessorWindowProxy::processor_going_away ()
3401 WM::Manager::instance().remove (this);
3402 /* should be no real reason to do this, since the object that would
3403 send DropReferences is about to be deleted, but lets do it anyway.
3405 going_away_connection.disconnect();
3408 ARDOUR::SessionHandlePtr*
3409 ProcessorWindowProxy::session_handle()
3416 ProcessorWindowProxy::get_state ()
3419 node = &ProxyBase::get_state();
3420 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
3425 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
3427 XMLNodeList children = node.children ();
3428 XMLNodeList::const_iterator i = children.begin ();
3429 while (i != children.end()) {
3430 XMLProperty* prop = (*i)->property (X_("name"));
3431 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
3437 if (i != children.end()) {
3439 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
3440 want_custom = PBD::string_is_affirmative (prop->value ());
3444 return ProxyBase::set_state (node, 0);
3448 ProcessorWindowProxy::get (bool create)
3450 boost::shared_ptr<Processor> p = _processor.lock ();
3455 if (_window && (is_custom != want_custom)) {
3456 /* drop existing window - wrong type */
3465 is_custom = want_custom;
3466 _window = _processor_box->get_editor_window (p, is_custom);
3477 ProcessorWindowProxy::show_the_right_window ()
3479 if (_window && (is_custom != want_custom)) {
3480 /* drop existing window - wrong type */
3485 is_custom = want_custom;