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 <glibmm/miscutils.h>
31 #include <glibmm/fileutils.h>
33 #include <gtkmm/messagedialog.h>
35 #include "gtkmm2ext/colors.h"
36 #include "gtkmm2ext/gtk_ui.h"
37 #include "gtkmm2ext/menu_elems.h"
38 #include "gtkmm2ext/utils.h"
39 #include "gtkmm2ext/doi.h"
40 #include "gtkmm2ext/rgb_macros.h"
42 #include "widgets/choice.h"
43 #include "widgets/prompter.h"
44 #include "widgets/tooltips.h"
46 #include "ardour/amp.h"
47 #include "ardour/audio_track.h"
48 #include "ardour/audioengine.h"
49 #include "ardour/internal_return.h"
50 #include "ardour/internal_send.h"
51 #include "ardour/luaproc.h"
52 #include "ardour/luascripting.h"
53 #include "ardour/meter.h"
54 #include "ardour/panner_shell.h"
55 #include "ardour/plugin_insert.h"
56 #include "ardour/pannable.h"
57 #include "ardour/port_insert.h"
58 #include "ardour/profile.h"
59 #include "ardour/return.h"
60 #include "ardour/route.h"
61 #include "ardour/send.h"
62 #include "ardour/session.h"
63 #include "ardour/types.h"
64 #include "ardour/value_as_string.h"
66 #include "LuaBridge/LuaBridge.h"
69 #include "ardour_dialog.h"
70 #include "ardour_ui.h"
71 #include "gui_thread.h"
72 #include "io_selector.h"
74 #include "luainstance.h"
76 #include "mixer_strip.h"
77 #include "plugin_pin_dialog.h"
78 #include "plugin_selector.h"
79 #include "plugin_ui.h"
80 #include "port_insert_ui.h"
81 #include "processor_box.h"
82 #include "processor_selection.h"
83 #include "public_editor.h"
84 #include "return_ui.h"
85 #include "script_selector.h"
88 #include "new_plugin_preset_dialog.h"
92 #ifdef AUDIOUNIT_SUPPORT
97 bool ProcessorBox::show_all_processors = false;
101 using namespace ARDOUR;
104 using namespace Glib;
105 using namespace Gtkmm2ext;
106 using namespace ArdourWidgets;
108 ProcessorBox* ProcessorBox::_current_processor_box = 0;
109 RefPtr<Action> ProcessorBox::paste_action;
110 RefPtr<Action> ProcessorBox::cut_action;
111 RefPtr<Action> ProcessorBox::copy_action;
112 RefPtr<Action> ProcessorBox::rename_action;
113 RefPtr<Action> ProcessorBox::delete_action;
114 RefPtr<Action> ProcessorBox::backspace_action;
115 RefPtr<Action> ProcessorBox::manage_pins_action;
116 RefPtr<Action> ProcessorBox::disk_io_action;
117 RefPtr<Action> ProcessorBox::edit_action;
118 RefPtr<Action> ProcessorBox::edit_generic_action;
119 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
120 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
121 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
124 // TODO consolidate with PluginPinDialog::set_color
125 static void set_routing_color (cairo_t* cr, bool midi)
127 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
128 static const uint32_t midi_port_color = 0x960909FF; //Red
131 cairo_set_source_rgb (cr,
132 UINT_RGBA_R_FLT(midi_port_color),
133 UINT_RGBA_G_FLT(midi_port_color),
134 UINT_RGBA_B_FLT(midi_port_color));
136 cairo_set_source_rgb (cr,
137 UINT_RGBA_R_FLT(audio_port_color),
138 UINT_RGBA_G_FLT(audio_port_color),
139 UINT_RGBA_B_FLT(audio_port_color));
143 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
144 : _button (ArdourButton::led_default_elements)
145 , _position (PreFader)
149 , _unknown_processor(false)
155 , output_routing_icon(false)
160 _button.set_distinct_led_click (true);
161 _button.set_fallthrough_to_parent(true);
162 _button.set_led_left (true);
163 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
164 _button.set_text (name (_width));
166 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
167 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
169 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
170 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
171 _unknown_processor = true;
174 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
175 if (pi && pi->plugin()) {
176 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
181 _vbox.pack_start (routing_icon);
182 _vbox.pack_start (input_icon);
183 _vbox.pack_start (_button, true, true);
185 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
186 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
187 if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
188 _plugin_display = new PluginInlineDisplay (*this, pi->plugin(),
189 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
191 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
192 _plugin_display = new LuaPluginDisplay (*this, boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
193 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
195 _vbox.pack_start (*_plugin_display);
196 _plugin_display->set_no_show_all (true);
197 if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
198 _plugin_display->show ();
201 _vbox.pack_end (output_routing_icon);
202 _vbox.pack_end (output_icon);
204 _button.set_active (_processor->enabled ());
206 input_icon.set_no_show_all(true);
207 routing_icon.set_no_show_all(true);
208 output_icon.set_no_show_all(true);
209 output_routing_icon.set_no_show_all(true);
215 output_routing_icon.hide();
217 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
218 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
219 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
221 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
222 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
224 std::string label = _processor->describe_parameter (*i);
226 if (boost::dynamic_pointer_cast<Send> (_processor)) {
228 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
232 Control* c = new Control (_processor->automation_control (*i), label);
234 _controls.push_back (c);
236 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
237 /* Add non-Amp (Fader & Trim) controls to the processor box */
238 _vbox.pack_start (c->box);
245 _vbox.set_size_request (-1, _button.size_request().height);
249 ProcessorEntry::~ProcessorEntry ()
251 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
254 delete _plugin_display;
258 ProcessorEntry::action_widget ()
264 ProcessorEntry::widget ()
270 ProcessorEntry::drag_text () const
276 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
278 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
282 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
283 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
284 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
285 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
288 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
291 if (!my_pi || !ot_pi) {
294 if (my_pi->type() != ot_pi->type()) {
297 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
298 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
299 if (!my_p || !ot_p) {
302 if (my_p->unique_id() != ot_p->unique_id()) {
309 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
311 if (data.get_target() == "PluginPresetPtr") {
312 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
314 if (!_plugin_preset_pointer || !pi) {
315 data.set (data.get_target(), 8, NULL, 0);
319 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
322 PluginManager& manager (PluginManager::instance());
323 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
325 NewPluginPresetDialog d (plugin,
326 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
328 _plugin_preset_pointer->_preset.valid = false;
331 case Gtk::RESPONSE_CANCEL:
332 data.set (data.get_target(), 8, NULL, 0);
336 case Gtk::RESPONSE_NO:
339 case Gtk::RESPONSE_ACCEPT:
340 if (d.name().empty()) {
345 plugin->remove_preset (d.name ());
348 Plugin::PresetRecord const r = plugin->save_preset (d.name());
350 if (!r.uri.empty ()) {
351 _plugin_preset_pointer->_preset.uri = r.uri;
352 _plugin_preset_pointer->_preset.label = r.label;
353 _plugin_preset_pointer->_preset.user = r.user;
354 _plugin_preset_pointer->_preset.valid = r.valid;
357 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
364 ProcessorEntry::set_position (Position p, uint32_t num)
372 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
375 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
377 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
382 ProcessorEntry::setup_visuals ()
384 if (_unknown_processor) {
385 _button.set_name ("processor stub");
388 boost::shared_ptr<Send> send;
389 if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
390 if (send->remove_on_disconnect ()) {
391 _button.set_name ("processor sidechain");
396 boost::shared_ptr<InternalSend> aux;
397 if ((aux = boost::dynamic_pointer_cast<InternalSend> (_processor))) {
398 if (aux->allow_feedback ()) {
399 _button.set_name ("processor auxfeedback");
406 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
407 _button.set_name ("processor prefader");
411 _button.set_name ("processor fader");
415 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
416 _button.set_name ("processor postfader");
422 boost::shared_ptr<Processor>
423 ProcessorEntry::processor () const
426 return boost::shared_ptr<Processor>();
432 ProcessorEntry::set_enum_width (Width w)
435 _button.set_text (name (_width));
439 ProcessorEntry::led_clicked(GdkEventButton *ev)
441 bool ctrl_shift_pressed = false;
442 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
444 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
445 ctrl_shift_pressed = true;
449 if (_button.get_active ()) {
450 if (ctrl_shift_pressed) {
451 _parent->all_visible_processors_active(false);
453 if (_position == Fader) {
454 _processor->enable (false);
458 _processor->enable (false);
462 if (ctrl_shift_pressed) {
463 _parent->all_visible_processors_active(true);
465 if (_position == Fader) {
466 _processor->enable (true);
470 _processor->enable (true);
477 ProcessorEntry::processor_active_changed ()
480 _button.set_active (_processor->enabled ());
485 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
487 if (what_changed.contains (ARDOUR::Properties::name)) {
488 _button.set_text (name (_width));
494 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
496 _parent->setup_routing_feeds ();
497 input_icon.queue_draw();
498 output_icon.queue_draw();
499 routing_icon.queue_draw();
500 output_routing_icon.queue_draw();
504 ProcessorEntry::setup_tooltip ()
507 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
509 std::string postfix = "";
512 if (pi->plugin()->has_inline_display()) {
513 postfix += string_compose(_("\n%1+double-click to toggle inline-display"), Keyboard::tertiary_modifier_name ());
516 if ((replicated = pi->get_count()) > 1) {
517 postfix += string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
520 if (pi->plugin()->has_editor()) {
521 set_tooltip (_button,
522 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::secondary_modifier_name (), postfix));
524 set_tooltip (_button,
525 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
529 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
530 ARDOUR_UI::instance()->set_tip (_button,
531 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
534 boost::shared_ptr<Send> send;
535 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
536 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
537 if (send->remove_on_disconnect ()) {
538 set_tooltip (_button, string_compose ("<b>> %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
540 set_tooltip (_button, string_compose ("<b>> %1</b>", _processor->name()));
545 set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
549 ProcessorEntry::name (Width w) const
551 boost::shared_ptr<Send> send;
558 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
559 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
562 std::string send_name;
563 bool pretty_ok = true;
565 if (send->remove_on_disconnect ()) {
566 // assume it's a sidechain, find pretty name of connected port(s)
567 PortSet& ps (send->output ()->ports ());
568 for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
569 vector<string> connections;
570 if (i->get_connections (connections)) {
571 vector<string>::const_iterator ci;
572 for (ci = connections.begin(); ci != connections.end(); ++ci) {
573 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
577 if (send_name.empty ()) {
579 } else if (send_name != pn) {
580 // pretty names don't match
593 /* grab the send name out of its overall name */
594 if (send_name.empty()) {
595 send_name = send->name();
596 string::size_type lbracket, rbracket;
597 lbracket = send_name.find ('[');
598 rbracket = send_name.find (']');
599 send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
604 name_display += send_name;
607 name_display += PBD::short_version (send_name, 5);
612 boost::shared_ptr<ARDOUR::PluginInsert> pi;
614 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
615 && (replicated = pi->get_count()) > 1)
617 name_display += string_compose(_("(%1x1) "), replicated);
622 name_display += _processor->display_name();
625 name_display += PBD::short_version (_processor->display_name(), 5);
635 ProcessorEntry::show_all_controls ()
637 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
638 (*i)->set_visible (true);
641 _parent->update_gui_object_state (this);
645 ProcessorEntry::hide_all_controls ()
647 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
648 (*i)->set_visible (false);
651 _parent->update_gui_object_state (this);
655 ProcessorEntry::add_control_state (XMLNode* node) const
657 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
658 (*i)->add_state (node);
661 if (_plugin_display) {
662 XMLNode* c = new XMLNode (X_("Object"));
663 c->set_property (X_("id"), X_("InlineDisplay"));
664 c->set_property (X_("visible"), _plugin_display->is_visible ());
665 node->add_child_nocopy (*c);
670 ProcessorEntry::set_control_state (XMLNode const * node)
672 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
673 (*i)->set_state (node);
676 if (_plugin_display) {
677 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
681 if (n->get_property (X_("visible"), visible)) {
683 _plugin_display->show ();
685 _plugin_display->hide ();
692 ProcessorEntry::state_id () const
694 return string_compose ("processor %1", _processor->id().to_s());
698 ProcessorEntry::hide_things ()
700 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
701 (*i)->hide_things ();
707 ProcessorEntry::build_controls_menu ()
709 using namespace Menu_Helpers;
710 Menu* menu = manage (new Menu);
711 MenuList& items = menu->items ();
713 if (_plugin_display) {
714 items.push_back (CheckMenuElem (_("Inline Display")));
715 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
716 c->set_active (_plugin_display->is_visible ());
717 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
718 items.push_back (SeparatorElem ());
722 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
726 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
729 if (!_controls.empty ()) {
730 items.push_back (SeparatorElem ());
733 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
734 items.push_back (CheckMenuElemNoMnemonic ((*i)->name ()));
735 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
736 c->set_active ((*i)->visible ());
737 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
744 ProcessorEntry::toggle_inline_display_visibility ()
746 if (_plugin_display->is_visible ()) {
747 _plugin_display->hide();
749 _plugin_display->show();
751 _parent->update_gui_object_state (this);
755 ProcessorEntry::toggle_control_visibility (Control* c)
757 c->set_visible (!c->visible ());
758 _parent->update_gui_object_state (this);
762 ProcessorEntry::build_send_options_menu ()
764 using namespace Menu_Helpers;
765 Menu* menu = manage (new Menu);
766 MenuList& items = menu->items ();
768 if (!ARDOUR::Profile->get_mixbus()) {
769 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
771 items.push_back (CheckMenuElem (_("Link panner controls")));
772 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
773 c->set_active (send->panner_shell()->is_linked_to_route());
774 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
778 boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
780 items.push_back (CheckMenuElem (_("Allow Feedback Loop")));
781 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
782 c->set_active (aux->allow_feedback());
783 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_allow_feedback));
789 ProcessorEntry::toggle_panner_link ()
791 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
793 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
798 ProcessorEntry::toggle_allow_feedback ()
800 boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
802 aux->set_allow_feedback (!aux->allow_feedback ());
806 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
808 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
809 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
810 , _slider_persistant_tooltip (&_slider)
811 , _button (ArdourButton::led_default_elements)
812 , _ignore_ui_adjustment (false)
816 _slider.set_controllable (c);
817 box.set_padding(0, 0, 4, 4);
820 _button.set_text (_name);
821 _button.set_led_left (true);
822 _button.set_name ("processor control button");
826 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
827 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
828 c->Changed.connect (_connections, invalidator (*this), boost::bind (&Control::control_changed, this), gui_context ());
830 c->alist()->automation_state_changed.connect (_connections, invalidator (*this), boost::bind (&Control::control_automation_state_changed, this), gui_context());
831 control_automation_state_changed ();
836 _slider.set_name ("ProcessorControlSlider");
837 _slider.set_text (_name);
842 const ARDOUR::ParameterDescriptor& desc = c->desc();
843 double const lo = c->internal_to_interface (desc.lower);
844 double const up = c->internal_to_interface (desc.upper);
845 double const normal = c->internal_to_interface (desc.normal);
846 double const smallstep = c->internal_to_interface (desc.lower + desc.smallstep);
847 double const largestep = c->internal_to_interface (desc.lower + desc.largestep);
849 _adjustment.set_lower (lo);
850 _adjustment.set_upper (up);
851 _adjustment.set_step_increment (smallstep);
852 _adjustment.set_page_increment (largestep);
853 _slider.set_default_value (normal);
855 _slider.StartGesture.connect(sigc::mem_fun(*this, &Control::start_touch));
856 _slider.StopGesture.connect(sigc::mem_fun(*this, &Control::end_touch));
858 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
859 c->Changed.connect (_connections, invalidator (*this), boost::bind (&Control::control_changed, this), gui_context ());
861 c->alist()->automation_state_changed.connect (_connections, invalidator (*this), boost::bind (&Control::control_automation_state_changed, this), gui_context());
862 control_automation_state_changed ();
869 /* We're providing our own PersistentTooltip */
870 set_no_tooltip_whatsoever (_slider);
873 ProcessorEntry::Control::~Control ()
878 ProcessorEntry::Control::set_tooltip ()
880 boost::shared_ptr<AutomationControl> c = _control.lock ();
885 std::string tt = _name + ": " + ARDOUR::value_as_string (c->desc(), c->get_value ());
886 string sm = Gtkmm2ext::markup_escape_text (tt);
887 _slider_persistant_tooltip.set_tip (sm);
888 ArdourWidgets::set_tooltip (_button, Gtkmm2ext::markup_escape_text (sm));
892 ProcessorEntry::Control::slider_adjusted ()
894 if (_ignore_ui_adjustment) {
898 boost::shared_ptr<AutomationControl> c = _control.lock ();
904 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
909 ProcessorEntry::Control::start_touch ()
911 boost::shared_ptr<AutomationControl> c = _control.lock ();
915 c->start_touch (c->session().transport_sample());
919 ProcessorEntry::Control::end_touch ()
921 boost::shared_ptr<AutomationControl> c = _control.lock ();
925 c->stop_touch (c->session().transport_sample());
929 ProcessorEntry::Control::button_clicked ()
931 boost::shared_ptr<AutomationControl> c = _control.lock ();
937 bool const n = _button.get_active ();
939 c->set_value (n ? 0 : 1, Controllable::NoGroup);
940 _button.set_active (!n);
945 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
953 ProcessorEntry::Control::control_automation_state_changed ()
955 boost::shared_ptr<AutomationControl> c = _control.lock ();
959 bool x = c->alist()->automation_state() & Play;
961 _button.set_sensitive (!x);
963 _slider.set_sensitive (!x);
968 ProcessorEntry::Control::control_changed ()
970 boost::shared_ptr<AutomationControl> c = _control.lock ();
975 _ignore_ui_adjustment = true;
978 _button.set_active (c->get_value() > 0.5);
980 // Note: the _slider watches the controllable by itself
981 const double nval = c->internal_to_interface (c->get_value ());
982 if (_adjustment.get_value() != nval) {
983 _adjustment.set_value (nval);
988 _ignore_ui_adjustment = false;
992 ProcessorEntry::Control::add_state (XMLNode* node) const
994 XMLNode* c = new XMLNode (X_("Object"));
995 c->set_property (X_("id"), state_id ());
996 c->set_property (X_("visible"), _visible);
997 node->add_child_nocopy (*c);
1001 ProcessorEntry::Control::set_state (XMLNode const * node)
1003 XMLNode* n = GUIObjectState::get_node (node, state_id ());
1006 if (n->get_property (X_("visible"), visible)) {
1007 set_visible (visible);
1010 set_visible (false);
1015 ProcessorEntry::Control::set_visible (bool v)
1026 /** Called when the Editor might have re-shown things that
1030 ProcessorEntry::Control::hide_things ()
1038 ProcessorEntry::Control::state_id () const
1040 boost::shared_ptr<AutomationControl> c = _control.lock ();
1043 return string_compose (X_("control %1"), c->id().to_s ());
1046 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
1047 : ProcessorEntry (b, p, w)
1048 , _plugin_insert (p)
1050 p->PluginIoReConfigure.connect (
1051 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1053 p->PluginMapChanged.connect (
1054 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1056 p->PluginConfigChanged.connect (
1057 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1062 PluginInsertProcessorEntry::iomap_changed ()
1064 _parent->setup_routing_feeds ();
1065 routing_icon.queue_draw();
1066 output_routing_icon.queue_draw();
1070 PluginInsertProcessorEntry::hide_things ()
1072 ProcessorEntry::hide_things ();
1075 ProcessorEntry::PortIcon::PortIcon(bool input) {
1077 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1078 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1082 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1084 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1086 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1089 Gtk::Allocation a = get_allocation();
1090 double const width = a.get_width();
1091 double const height = a.get_height();
1093 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1094 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1096 cairo_rectangle (cr, 0, 0, width, height);
1099 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1100 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1101 set_routing_color (cr, i < _ports.n_midi());
1102 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1103 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1111 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1115 set_terminal (false);
1119 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1121 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1123 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1125 set_size_request (-1, h);
1129 ProcessorEntry::RoutingIcon::set (
1130 const ARDOUR::ChanCount& in,
1131 const ARDOUR::ChanCount& out,
1132 const ARDOUR::ChanCount& sinks,
1133 const ARDOUR::ChanCount& sources,
1134 const ARDOUR::ChanMapping& in_map,
1135 const ARDOUR::ChanMapping& out_map,
1136 const ARDOUR::ChanMapping& thru_map)
1144 _thru_map = thru_map;
1148 ProcessorEntry::RoutingIcon::in_identity () const {
1149 if (_thru_map.n_total () > 0) {
1152 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1155 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1162 ProcessorEntry::RoutingIcon::out_identity () const {
1163 if (_thru_map.n_total () > 0) {
1164 // TODO skip if trhu is not connected to any of next's inputs
1167 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1170 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1177 ProcessorEntry::RoutingIcon::can_coalesce () const {
1178 if (_thru_map.n_total () > 0) {
1181 if (_fed_by && _f_out != _f_sources) {
1184 if (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1187 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1194 ProcessorEntry::RoutingIcon::set_fed_by (
1195 const ARDOUR::ChanCount& out,
1196 const ARDOUR::ChanCount& sources,
1197 const ARDOUR::ChanMapping& out_map,
1198 const ARDOUR::ChanMapping& thru_map)
1201 _f_sources = sources;
1202 _f_out_map = out_map;
1203 _f_thru_map = thru_map;
1208 ProcessorEntry::RoutingIcon::set_feeding (
1209 const ARDOUR::ChanCount& in,
1210 const ARDOUR::ChanCount& sinks,
1211 const ARDOUR::ChanMapping& in_map,
1212 const ARDOUR::ChanMapping& thru_map)
1217 _i_thru_map = thru_map;
1222 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1224 if (!midi) { i += n_midi; }
1227 return rint (width * .5) +.5;
1229 return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1233 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1235 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1236 const double y1 = rint (height * .66) + .5;
1239 cairo_translate (cr, x0, y0);
1240 cairo_move_to (cr, 0, height);
1241 cairo_line_to (cr, 0, y1);
1242 cairo_move_to (cr, 0 - dx, y1);
1243 cairo_line_to (cr, 0 + dx, y1);
1245 set_routing_color (cr, midi);
1246 cairo_set_line_width (cr, 1.0);
1252 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1254 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1255 const double y1 = rint (height * .5) - .5;
1258 cairo_translate (cr, x0, y0);
1259 cairo_move_to (cr, 0 - dx, height);
1260 cairo_line_to (cr, 0, y1);
1261 cairo_line_to (cr, 0 + dx, height);
1262 cairo_close_path (cr);
1264 set_routing_color (cr, midi);
1270 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1272 const double rad = 1;
1273 const double y1 = height - rad - 1.5;
1275 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1276 cairo_move_to (cr, x0, y0 + height - 1.5);
1277 cairo_line_to (cr, x0, y0 + height);
1278 set_routing_color (cr, midi);
1279 cairo_set_line_width (cr, 1.0);
1284 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1286 const double rad = 1;
1287 const double y1 = rad + 1;
1289 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1290 cairo_move_to (cr, x0, y0);
1291 cairo_line_to (cr, x0, y0 + 1);
1292 set_routing_color (cr, midi);
1293 cairo_set_line_width (cr, 1.0);
1298 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1300 double bz = abs (y1 - y0);
1302 cairo_move_to (cr, x0, y0);
1303 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1304 cairo_set_line_width (cr, 1.0);
1305 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1306 cairo_set_source_rgb (cr, 1, 0, 0);
1308 const double dashes[] = { 2, 3 };
1309 cairo_set_dash (cr, dashes, 2, 0);
1311 set_routing_color (cr, midi);
1314 cairo_set_dash (cr, 0, 0, 0);
1319 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1321 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1323 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1326 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1328 Gtk::Allocation a = get_allocation();
1329 double const width = a.get_width();
1330 double const height = a.get_height();
1332 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1333 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1335 cairo_rectangle (cr, 0, 0, width, height);
1339 if (can_coalesce ()) {
1340 expose_coalesced_input_map (cr, width, height);
1342 expose_input_map (cr, width, height);
1345 expose_output_map (cr, width, height);
1353 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1355 const uint32_t pc_in = _sinks.n_total();
1356 const uint32_t pc_in_midi = _sinks.n_midi();
1358 for (uint32_t i = 0; i < pc_in; ++i) {
1359 const bool is_midi = i < pc_in_midi;
1361 uint32_t pn = is_midi ? i : i - pc_in_midi;
1362 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1363 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1365 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1366 draw_gnd (cr, x, 0, height, is_midi);
1369 if (idx >= _in.get (dt)) {
1370 // side-chain, probably
1371 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1372 draw_sidechain (cr, x, 0, height, is_midi);
1376 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1380 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1382 double x = pin_x_pos (i, width, pc_in, 0, false);
1384 _f_thru_map.get (dt, idx, &valid_thru);
1386 draw_thru_src (cr, x, 0, height, is_midi);
1388 draw_gnd (cr, x, 0, height, is_midi);
1392 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1394 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1396 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1401 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1403 const uint32_t n_in = _in.n_total();
1404 const uint32_t n_in_midi = _in.n_midi();
1405 const uint32_t pc_in = _sinks.n_total();
1406 const uint32_t pc_in_midi = _sinks.n_midi();
1408 // draw inputs to this
1409 for (uint32_t i = 0; i < pc_in; ++i) {
1410 const bool is_midi = i < pc_in_midi;
1412 uint32_t pn = is_midi ? i : i - pc_in_midi;
1413 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1414 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1415 // check if it's fed
1416 bool valid_src = true;
1417 if (valid_in && idx < _in.get (dt) && _fed_by) {
1420 _f_out_map.get_src (dt, idx, &valid_out);
1421 _f_thru_map.get (dt, idx, &valid_thru);
1422 if (!valid_out && !valid_thru) {
1426 if (!valid_in || !valid_src) {
1427 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1428 draw_gnd (cr, x, 0, height, is_midi);
1431 if (idx >= _in.get (dt)) {
1432 // side-chain, probably
1433 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1434 draw_sidechain (cr, x, 0, height, is_midi);
1437 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1438 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1439 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1442 // draw reverse thru
1443 for (uint32_t i = 0; i < n_in; ++i) {
1444 const bool is_midi = i < n_in_midi;
1446 uint32_t pn = is_midi ? i : i - n_in_midi;
1447 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1448 _thru_map.get_src (dt, pn, &valid_thru);
1452 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1453 draw_thru_sink (cr, x, 0, height, is_midi);
1458 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1460 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1461 double ht = _terminal ? height - dh : height;
1463 // draw outputs of this
1464 const uint32_t pc_out = _sources.n_total();
1465 const uint32_t pc_out_midi = _sources.n_midi();
1466 const uint32_t n_out = _out.n_total();
1467 const uint32_t n_out_midi = _out.n_midi();
1469 for (uint32_t i = 0; i < pc_out; ++i) {
1470 const bool is_midi = i < pc_out_midi;
1472 uint32_t pn = is_midi ? i : i - pc_out_midi;
1473 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1474 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1478 // skip connections that are not used in the next's input
1480 bool valid_thru, valid_sink;
1481 _i_in_map.get_src (dt, idx, &valid_sink);
1482 _i_thru_map.get_src (dt, idx, &valid_thru);
1483 if (!valid_thru && !valid_sink) {
1484 if (!is_midi || i != 0) { // special case midi-bypass
1489 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1490 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1491 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1494 for (uint32_t i = 0; i < n_out; ++i) {
1495 const bool is_midi = i < n_out_midi;
1496 uint32_t pn = is_midi ? i : i - n_out_midi;
1497 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1498 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1501 bool valid_thru_f = false;
1502 // skip connections that are not used in the next's input
1505 _i_in_map.get_src (dt, pn, &valid_sink);
1506 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1507 if (!valid_thru_f && !valid_sink) {
1508 if (!is_midi || i != 0) { // special case midi-bypass
1515 _out_map.get_src (dt, pn, &valid_src);
1518 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1520 if (idx >= _in.get (dt)) {
1521 draw_sidechain (cr, x, 0, height, is_midi);
1523 draw_thru_src (cr, x, 0, height, is_midi);
1525 } else if (valid_thru_f){
1526 // gnd is part of input, unless it's a thru input
1527 // (also only true if !coalesced into one small display)
1528 draw_gnd (cr, x, 0, height, is_midi);
1532 // terminal node, add arrows
1534 _out_map.get_src (dt, pn, &valid_src);
1537 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1539 if (idx >= _in.get (dt)) {
1540 draw_sidechain (cr, x, 0, height - dh, is_midi);
1542 draw_thru_src (cr, x, 0, height - dh, is_midi);
1545 draw_gnd (cr, x, 0, height - dh, is_midi);
1549 set_routing_color (cr, is_midi);
1550 cairo_set_line_width (cr, 1.0);
1551 cairo_move_to (cr, x, height - dh);
1552 cairo_line_to (cr, x, height - 2);
1555 const double ar = dh - 1;
1556 cairo_move_to (cr, x - ar, height - ar);
1557 cairo_line_to (cr, x , height - .5);
1558 cairo_line_to (cr, x + ar, height - ar);
1559 cairo_line_to (cr, x , height - ar * .5);
1560 cairo_close_path (cr);
1561 cairo_fill_preserve (cr);
1567 ProcessorEntry::PluginInlineDisplay::PluginInlineDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1568 : PluginDisplay (p, max_height)
1572 std::string postfix = string_compose(_("\n%1+double-click to toggle inline-display"), Keyboard::tertiary_modifier_name ());
1574 if (_plug->has_editor()) {
1576 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), e.name (Wide), Keyboard::primary_modifier_name (), postfix));
1579 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), e.name (Wide), postfix));
1585 ProcessorEntry::PluginInlineDisplay::on_button_press_event (GdkEventButton *ev)
1587 assert (_entry.processor ());
1589 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_entry.processor());
1590 // duplicated code :(
1591 // consider some tweaks to pass this up to the DnDVBox somehow:
1592 // select processor, then call (private)
1593 //_entry._parent->processor_button_press_event (ev, &_entry);
1594 if (pi && pi->plugin() && pi->plugin()->has_inline_display()
1595 && Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)
1597 && ev->type == GDK_2BUTTON_PRESS) {
1598 _entry.toggle_inline_display_visibility ();
1601 else if (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS)) {
1602 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1603 _entry._parent->generic_edit_processor (_entry.processor ());
1605 _entry._parent->edit_processor (_entry.processor ());
1613 ProcessorEntry::PluginInlineDisplay::on_size_request (Requisition* req)
1616 req->height = _cur_height;
1621 ProcessorEntry::PluginInlineDisplay::update_height_alloc (uint32_t inline_height)
1623 /* work-around scroll-bar + aspect ratio
1624 * show inline-view -> height changes -> scrollbar gets added
1625 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1626 * -> scroll bar is removed [-> width changes ; repeat ]
1628 uint32_t shm = std::min (_max_height, inline_height);
1630 Gtk::Container* pr = get_parent();
1631 for (uint32_t i = 0; i < 4 && pr; ++i) {
1632 // VBox, EventBox, ViewPort, ScrolledWindow
1633 pr = pr->get_parent();
1635 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1637 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1638 sc = vsb && vsb->is_visible();
1641 if (shm != _cur_height) {
1642 if (_scroll == sc || _cur_height < shm) {
1651 ProcessorEntry::PluginInlineDisplay::display_sample (cairo_t* cr, double w, double h)
1653 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, w - 1, h + 1, 7);
1656 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1657 : PluginInlineDisplay (e, p, max_height)
1659 , _lua_render_inline (0)
1661 p->setup_lua_inline_gui (&lua_gui);
1663 lua_State* LG = lua_gui.getState ();
1664 LuaInstance::bind_cairo (LG);
1665 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1666 assert (lua_render.isFunction ());
1667 _lua_render_inline = new luabridge::LuaRef (lua_render);
1670 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1672 delete (_lua_render_inline);
1676 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1678 Cairo::Context ctx (cr);
1680 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1681 lua_gui.collect_garbage_step ();
1682 if (rv.isTable ()) {
1686 } catch (luabridge::LuaException const& e) {
1688 cerr << "LuaException:" << e.what () << endl;
1695 static std::list<Gtk::TargetEntry> drop_targets()
1697 std::list<Gtk::TargetEntry> tmp;
1698 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1699 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1700 tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1704 static std::list<Gtk::TargetEntry> drag_targets()
1706 std::list<Gtk::TargetEntry> tmp;
1707 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1708 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1712 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1714 std::list<Gtk::TargetEntry> tmp;
1715 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1719 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1720 ProcessorSelection& psel, MixerStrip* parent, bool owner_is_mixer)
1721 : _parent_strip (parent)
1722 , _owner_is_mixer (owner_is_mixer)
1723 , ab_direction (true)
1724 , _get_plugin_selector (get_plugin_selector)
1726 , _p_selection(psel)
1727 , processor_display (drop_targets())
1728 , _redisplay_pending (false)
1732 /* ProcessorBox actions and bindings created statically by call to
1733 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1734 * are available for context menus.
1737 processor_display.set_data ("ardour-bindings", bindings);
1741 no_processor_redisplay = false;
1743 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1744 processor_scroller.add (processor_display);
1745 pack_start (processor_scroller, true, true);
1747 processor_display.set_flags (CAN_FOCUS);
1748 processor_display.set_name ("ProcessorList");
1749 processor_display.set_data ("processorbox", this);
1750 processor_display.set_size_request (48, -1);
1751 processor_display.set_spacing (0);
1753 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1754 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1756 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1757 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1759 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1760 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1761 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1763 processor_scroller.show ();
1764 processor_display.show ();
1767 parent->DeliveryChanged.connect (
1768 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1772 set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1775 ProcessorBox::~ProcessorBox ()
1777 /* it may appear as if we should delete processor_menu but that is a
1778 * pointer to a widget owned by the UI Manager, and has potentially
1779 * be returned to many other ProcessorBoxes. GTK doesn't really make
1780 * clear the ownership of this widget, which is a menu and thus is
1781 * never packed into any container other than an implict GtkWindow.
1783 * For now, until or if we ever get clarification over the ownership
1784 * story just let it continue to exist. At worst, its a small memory leak.
1789 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1795 _route_connections.drop_connections();
1797 /* new route: any existing block on processor redisplay must be meaningless */
1798 no_processor_redisplay = false;
1801 _route->processors_changed.connect (
1802 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1805 _route->DropReferences.connect (
1806 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1809 _route->PropertyChanged.connect (
1810 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1813 redisplay_processors ();
1817 ProcessorBox::route_going_away ()
1819 /* don't keep updating display as processors are deleted */
1820 no_processor_redisplay = true;
1824 boost::shared_ptr<Processor>
1825 ProcessorBox::find_drop_position (ProcessorEntry* position)
1827 boost::shared_ptr<Processor> p;
1829 p = position->processor ();
1831 /* dropped on the blank entry (which will be before the
1832 fader), so use the first non-blank child as our
1833 `dropped on' processor */
1834 list<ProcessorEntry*> c = processor_display.children ();
1835 list<ProcessorEntry*>::iterator i = c.begin ();
1837 assert (i != c.end ());
1838 p = (*i)->processor ();
1846 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1848 const void * d = data.get_data();
1849 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1851 PluginPresetList nfos;
1853 tv->get_object_drag_data (nfos, &source);
1855 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1856 PluginPresetPtr ppp = (*i);
1857 PluginInfoPtr pip = ppp->_pip;
1858 PluginPtr p = pip->load (*_session);
1863 if (ppp->_preset.valid) {
1864 p->load_preset (ppp->_preset);
1867 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1868 if (Config->get_new_plugins_active ()) {
1869 processor->enable (true);
1871 pl.push_back (processor);
1876 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1878 const void * d = data.get_data();
1879 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1880 PluginInfoList nfos;
1883 tv->get_object_drag_data (nfos, &source);
1885 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1886 PluginPtr p = (*i)->load (*_session);
1890 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1891 if (Config->get_new_plugins_active ()) {
1892 processor->enable (true);
1894 pl.push_back (processor);
1899 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1905 boost::shared_ptr<Processor> p = find_drop_position (position);
1906 Route::ProcessorList pl;
1908 if (data.get_target() == "PluginInfoPtr") {
1909 _drop_plugin (data, pl);
1911 else if (data.get_target() == "PluginFavoritePtr") {
1912 _drop_plugin_preset (data, pl);
1918 Route::ProcessorStreams err;
1919 if (_route->add_processors (pl, p, &err)) {
1921 "Processor Drag/Drop failed. Probably because\n\
1922 the I/O configuration of the plugins could\n\
1923 not match the configuration of this track.");
1924 MessageDialog am (msg);
1930 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1932 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1933 list<ProcessorEntry*> children = source->selection ();
1934 assert (children.size() == 1);
1935 ProcessorEntry* other = *children.begin();
1936 assert (other->can_copy_state (position));
1937 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1938 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1939 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1940 assert (otherproc && proc && pi);
1942 PBD::ID id = pi->id();
1943 XMLNode& state = otherproc->get_state ();
1944 /* strip side-chain state (processor inside processor must be a side-chain)
1945 * otherwise we'll end up with duplicate ports-names.
1946 * (this needs a better solution which retains connections)
1948 state.remove_nodes_and_delete ("Processor");
1949 proc->set_state (state, Stateful::loading_state_version);
1950 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1954 boost::shared_ptr<Processor> p = find_drop_position (position);
1956 list<ProcessorEntry*> children = source->selection (true);
1957 list<boost::shared_ptr<Processor> > procs;
1958 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1959 if ((*i)->processor ()) {
1960 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1963 procs.push_back ((*i)->processor ());
1967 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1968 XMLNode& state = (*i)->get_state ();
1970 nlist.push_back (&state);
1971 paste_processor_state (nlist, p);
1975 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1979 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1980 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1982 other->delete_dragged_processors (procs);
1988 ProcessorBox::set_width (Width w)
1996 list<ProcessorEntry*> children = processor_display.children ();
1997 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1998 (*i)->set_enum_width (w);
2005 ProcessorBox::build_possible_aux_menu ()
2007 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2010 /* No aux sends if there are no busses */
2014 if (_route->is_monitor ()) {
2018 using namespace Menu_Helpers;
2019 Menu* menu = manage (new Menu);
2020 MenuList& items = menu->items();
2022 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2023 if (!_route->internal_send_for (*r) && *r != _route) {
2024 items.push_back (MenuElemNoMnemonic ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2032 ProcessorBox::show_processor_menu (int arg)
2034 if (processor_menu == 0) {
2035 processor_menu = build_processor_menu ();
2036 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2039 /* Sort out the plugin submenu */
2041 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2043 if (plugin_menu_item) {
2044 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2047 /* And the aux submenu */
2049 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2051 if (aux_menu_item) {
2052 Menu* m = build_possible_aux_menu();
2053 if (m && !m->items().empty()) {
2054 aux_menu_item->set_submenu (*m);
2055 aux_menu_item->set_sensitive (true);
2057 /* stupid gtkmm: we need to pass a null reference here */
2058 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2059 aux_menu_item->set_sensitive (false);
2063 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2064 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2066 ProcessorEntry* single_selection = 0;
2067 if (processor_display.selection().size() == 1) {
2068 single_selection = processor_display.selection().front();
2071 /* And the controls submenu */
2073 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2075 if (controls_menu_item) {
2076 if (single_selection) {
2077 Menu* m = single_selection->build_controls_menu ();
2078 if (m && !m->items().empty()) {
2079 controls_menu_item->set_submenu (*m);
2080 controls_menu_item->set_sensitive (true);
2082 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2083 controls_menu_item->set_sensitive (false);
2086 controls_menu_item->set_sensitive (false);
2091 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2092 if (send_menu_item) {
2093 if (single_selection && !_route->is_monitor()) {
2094 Menu* m = single_selection->build_send_options_menu ();
2095 if (m && !m->items().empty()) {
2096 send_menu_item->set_submenu (*m);
2097 send_menu_item->set_sensitive (true);
2099 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2100 send_menu_item->set_sensitive (false);
2103 send_menu_item->set_sensitive (false);
2107 /* Sensitise actions as approprioate */
2109 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2111 paste_action->set_sensitive (!_p_selection.processors.empty());
2112 cut_action->set_sensitive (sensitive && can_cut ());
2113 copy_action->set_sensitive (sensitive);
2114 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2115 backspace_action->set_sensitive (sensitive || stub_processor_selected ());
2117 edit_action->set_sensitive (one_processor_can_be_edited ());
2118 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2120 boost::shared_ptr<PluginInsert> pi;
2121 if (single_selection) {
2122 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2125 manage_pins_action->set_sensitive (pi != 0);
2126 if (boost::dynamic_pointer_cast<Track>(_route)) {
2127 disk_io_action->set_sensitive (true);
2129 disk_io_action->set_sensitive (false);
2132 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2133 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2135 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2136 rename_action->set_sensitive (single_selection
2138 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2139 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2141 processor_menu->popup (1, arg);
2143 /* Add a placeholder gap to the processor list to indicate where a processor would be
2144 inserted were one chosen from the menu.
2147 processor_display.get_pointer (x, y);
2148 _placement = processor_display.add_placeholder (y);
2152 ProcessorBox::enter_notify (GdkEventCrossing*)
2154 processor_display.grab_focus ();
2155 _current_processor_box = this;
2160 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2162 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2166 Widget* top = get_toplevel();
2168 if (top->is_toplevel()) {
2169 Window* win = dynamic_cast<Window*> (top);
2170 gtk_window_set_focus (win->gobj(), 0);
2177 ProcessorBox::processor_operation (ProcessorOperation op)
2179 ProcSelection targets;
2181 get_selected_processors (targets);
2183 /* if (targets.empty()) {
2186 processor_display.get_pointer (x, y);
2188 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2190 if (pointer.first && pointer.first->processor()) {
2191 targets.push_back (pointer.first->processor ());
2196 if ((op == ProcessorsDelete) && targets.empty()) {
2197 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2201 case ProcessorsSelectAll:
2202 processor_display.select_all ();
2205 case ProcessorsSelectNone:
2206 processor_display.select_none ();
2209 case ProcessorsCopy:
2210 copy_processors (targets);
2214 cut_processors (targets);
2217 case ProcessorsPaste:
2218 // some processors are not selectable (e.g fader, meter), target is empty.
2219 if (targets.empty() && _placement >= 0) {
2221 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2223 targets.push_back (proc);
2226 if (targets.empty()) {
2227 paste_processors ();
2229 paste_processors (targets.front());
2233 case ProcessorsDelete:
2234 delete_processors (targets);
2237 case ProcessorsToggleActive:
2238 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2239 if (!(*i)->display_to_user ()) {
2240 assert (0); // these should not be selectable to begin with.
2243 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
2247 if (boost::dynamic_pointer_cast<PluginInsert> (*i)->is_channelstrip()) {
2251 (*i)->enable (!(*i)->enabled ());
2266 ProcessorWindowProxy*
2267 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2269 return processor->window_proxy();
2274 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2276 boost::shared_ptr<Processor> processor;
2278 processor = child->processor ();
2282 bool selected = processor_display.selected (child);
2284 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
2285 if (pi && pi->plugin() && pi->plugin()->has_inline_display()
2286 && Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)
2288 && ev->type == GDK_2BUTTON_PRESS) {
2289 child->toggle_inline_display_visibility ();
2293 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2295 if (_session->engine().connected()) {
2296 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2298 if (!one_processor_can_be_edited ()) {
2302 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2303 generic_edit_processor (processor);
2305 edit_processor (processor);
2311 } else if (Keyboard::is_context_menu_event (ev)) {
2313 show_processor_menu (ev->time);
2317 } else if (processor && ev->button == 1 && selected) {
2319 // this is purely informational but necessary for route params UI
2320 ProcessorSelected (processor); // emit
2322 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2325 _get_plugin_selector()->show_manager ();
2332 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2334 boost::shared_ptr<Processor> processor;
2336 processor = child->processor ();
2339 if (processor && Keyboard::is_delete_event (ev)) {
2341 Glib::signal_idle().connect (sigc::bind (
2342 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2343 boost::weak_ptr<Processor>(processor)));
2345 } else if (processor && Keyboard::is_button2_event (ev)
2347 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2351 /* button2-click with no/appropriate modifiers */
2352 processor->enable (!processor->enabled ());
2359 ProcessorBox::build_processor_menu ()
2361 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2362 processor_menu->set_name ("ArdourContextMenu");
2363 return processor_menu;
2367 ProcessorBox::select_all_processors ()
2369 processor_display.select_all ();
2373 ProcessorBox::deselect_all_processors ()
2375 processor_display.select_none ();
2379 ProcessorBox::choose_plugin ()
2381 _get_plugin_selector()->set_interested_object (*this);
2384 /** @return true if an error occurred, otherwise false */
2386 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2388 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2390 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2392 Route::ProcessorStreams err_streams;
2394 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2395 weird_plugin_dialog (**p, err_streams);
2397 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2398 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2399 if (processor->what_can_be_automated ().size () == 0) {
2400 ; /* plugin without controls, don't show ui */
2402 else if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2403 ; /* only show inline display */
2405 else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2406 if ((*p)->has_editor ()) {
2407 edit_processor (processor);
2408 } else if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->parameter_count() > 0) {
2409 generic_edit_processor (processor);
2413 /* add next processor below the currently added.
2414 * Note: placement < 0: add the bottom */
2415 if (_placement >= 0) {
2424 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2426 /* XXX this needs to be re-worked!
2428 * With new pin-management "streams" is no longer correct.
2429 * p.get_info () is also incorrect for variable i/o plugins (always -1,-1).
2431 * Since pin-management was added, this dialog will only show in a very rare
2432 * condition (non-replicated variable i/o configuration failed).
2434 * TODO: simplify the message after the string-freeze is lifted.
2436 ArdourDialog dialog (_("Plugin Incompatibility"));
2439 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2440 p.name(), streams.index);
2442 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2443 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2445 text += _("\nThis plugin has:\n");
2447 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2448 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2451 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2452 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2455 text += _("\nbut at the insertion point, there are:\n");
2457 uint32_t const n = streams.count.n_midi ();
2458 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2461 uint32_t const n = streams.count.n_audio ();
2462 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2465 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2466 label.set_text(text);
2468 dialog.get_vbox()->pack_start (label);
2469 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2471 dialog.set_name (X_("PluginIODialog"));
2472 dialog.set_modal (true);
2479 ProcessorBox::choose_insert ()
2481 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2482 _route->add_processor_by_index (processor, _placement);
2485 /* Caller must not hold process lock */
2487 ProcessorBox::choose_send ()
2489 boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2491 /* make an educated guess at the initial number of outputs for the send */
2492 ChanCount outs = (_route->n_outputs().n_audio() && _session->master_out())
2493 ? _session->master_out()->n_outputs()
2494 : _route->n_outputs();
2496 /* XXX need processor lock on route */
2498 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2499 send->output()->ensure_io (outs, false, this);
2500 } catch (AudioEngine::PortRegistrationFailure& err) {
2501 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2505 /* let the user adjust the IO setup before creation.
2507 Note: this dialog is NOT modal - we just leave it to run and it will
2508 return when its Finished signal is emitted - typically when the window
2512 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2515 /* keep a reference to the send so it doesn't get deleted while
2516 the IOSelectorWindow is doing its stuff
2518 _processor_being_created = send;
2520 ios->selector().Finished.connect (sigc::bind (
2521 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2522 boost::weak_ptr<Processor>(send), ios));
2527 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2529 boost::shared_ptr<Processor> processor (weak_processor.lock());
2531 /* drop our temporary reference to the new send */
2532 _processor_being_created.reset ();
2539 case IOSelector::Cancelled:
2540 // processor will go away when all shared_ptrs to it vanish
2543 case IOSelector::Accepted:
2544 _route->add_processor_by_index (processor, _placement);
2548 delete_when_idle (ios);
2552 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2554 boost::shared_ptr<Processor> processor (weak_processor.lock());
2556 /* drop our temporary reference to the new return */
2557 _processor_being_created.reset ();
2564 case IOSelector::Cancelled:
2565 // processor will go away when all shared_ptrs to it vanish
2568 case IOSelector::Accepted:
2569 _route->add_processor_by_index (processor, _placement);
2573 delete_when_idle (ios);
2577 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2583 boost::shared_ptr<Route> target = wr.lock();
2589 _session->add_internal_send (target, _placement, _route);
2593 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2595 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2596 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2600 redisplay_processors ();
2604 ProcessorBox::redisplay_processors ()
2606 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2608 if (no_processor_redisplay) {
2612 processor_display.clear ();
2614 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2615 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2616 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2618 setup_entry_positions ();
2621 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2622 * not already have one.
2625 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2627 boost::shared_ptr<Processor> p = w.lock ();
2631 if (p->window_proxy()) {
2635 /* see also ProcessorBox::get_editor_window */
2636 bool have_ui = false;
2638 if (boost::dynamic_pointer_cast<PluginInsert> (p)) {
2641 else if (boost::dynamic_pointer_cast<PortInsert> (p)) {
2644 else if (boost::dynamic_pointer_cast<Send> (p)) {
2645 if (!boost::dynamic_pointer_cast<InternalSend> (p)) {
2649 else if (boost::dynamic_pointer_cast<Return> (p)) {
2650 if (!boost::dynamic_pointer_cast<InternalReturn> (p)) {
2659 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2660 string_compose ("P-%1-%2", _route->id(), p->id()),
2664 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2667 wp->set_state (*ui_xml, 0);
2670 p->set_window_proxy (wp);
2671 WM::Manager::instance().register_window (wp);
2675 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2677 boost::shared_ptr<Processor> p = w.lock ();
2678 if (!p || p->pinmgr_proxy ()) {
2681 if (!boost::dynamic_pointer_cast<PluginInsert> (p)) {
2685 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2686 string_compose ("PM-%1-%2", _route->id(), p->id()), w);
2687 wp->set_session (_session);
2689 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2691 wp->set_state (*ui_xml, 0);
2694 p->set_pingmgr_proxy (wp);
2695 WM::Manager::instance().register_window (wp);
2699 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2701 boost::shared_ptr<Processor> processor (p.lock ());
2703 if (!processor || ( !processor->display_to_user()
2705 && !show_all_processors
2712 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2714 ProcessorEntry* e = 0;
2715 if (plugin_insert) {
2716 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2718 e = new ProcessorEntry (this, processor, _width);
2721 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2722 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2723 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2725 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2726 if (!send && !plugin_insert && !ext && !stub)
2727 e->set_selectable(false);
2729 bool mark_send_visible = false;
2730 if (send && _parent_strip) {
2731 /* show controls of new sends by default */
2732 GUIObjectState& st = _parent_strip->gui_object_state ();
2733 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2735 /* check if state exists, if not it must be a new send */
2736 if (!st.get_node(strip, e->state_id())) {
2737 mark_send_visible = true;
2741 /* Set up this entry's state from the GUIObjectState */
2742 XMLNode* proc = entry_gui_object_state (e);
2744 e->set_control_state (proc);
2747 if (mark_send_visible) {
2748 e->show_all_controls ();
2753 && !plugin_insert->plugin(0)->is_channelstrip()
2757 processor_display.add_child (e, drag_targets());
2759 processor_display.add_child (e, drag_targets_noplugin());
2764 ProcessorBox::reordered ()
2766 compute_processor_sort_keys ();
2767 setup_entry_positions ();
2771 ProcessorBox::setup_routing_feeds ()
2773 list<ProcessorEntry*> children = processor_display.children ();
2774 /* first set the i/o maps for every processor */
2775 list<ProcessorEntry*>::iterator prev = children.begin();
2777 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2778 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2779 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2781 list<ProcessorEntry*>::iterator next = i;
2785 ChanCount sinks = pi->natural_input_streams ();
2786 ChanCount sources = pi->natural_output_streams ();
2787 uint32_t count = pi->get_count ();
2789 pi->configured_io (in, out);
2791 ChanCount midi_thru;
2792 ChanCount midi_bypass;
2793 ChanMapping input_map (pi->input_map ());
2794 if (pi->has_midi_thru ()) {
2795 midi_thru.set(DataType::MIDI, 1);
2796 input_map.set (DataType::MIDI, 0, 0);
2798 if (pi->has_midi_bypass ()) {
2799 midi_bypass.set(DataType::MIDI, 1);
2802 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2803 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2805 (*i)->routing_icon.set (
2807 sinks * count + midi_thru,
2808 sources * count + midi_bypass,
2813 if (next != children.end()) {
2814 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2815 pi->output_map (), pi->thru_map ());
2819 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2820 pi->input_map (), pi->thru_map ());
2824 (*i)->input_icon.set_ports (p->input_streams());
2825 (*i)->output_icon.set_ports (p->output_streams());
2826 ChanMapping inmap (p->input_streams ());
2827 ChanMapping outmap (p->output_streams ());
2828 ChanMapping thrumap;
2829 (*i)->routing_icon.set (
2831 p->output_streams(),
2833 p->output_streams(),
2834 inmap, outmap, thrumap);
2836 if (next != children.end()) {
2837 (*next)->routing_icon.set_fed_by (
2838 p->output_streams(),
2839 p->output_streams(),
2843 (*prev)->routing_icon.set_feeding (
2845 p->output_streams(),
2850 if (i == children.begin()) {
2851 (*i)->routing_icon.unset_fed_by ();
2854 (*i)->input_icon.hide();
2857 /* now set which icons need to be displayed */
2858 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2859 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2861 if ((*i)->routing_icon.in_identity ()) {
2862 (*i)->routing_icon.hide();
2863 if (i == children.begin()) {
2864 (*i)->input_icon.show();
2867 (*i)->routing_icon.show();
2868 (*i)->routing_icon.queue_draw();
2869 (*i)->input_icon.show();
2872 list<ProcessorEntry*>::iterator next = i;
2873 if (++next == children.end()) {
2874 // last processor in the chain
2875 (*i)->output_routing_icon.set_terminal(true);
2876 (*i)->output_routing_icon.unset_feeding ();
2877 if ((*i)->routing_icon.out_identity ()) {
2878 (*i)->output_routing_icon.hide();
2880 (*i)->output_routing_icon.show();
2881 (*i)->output_routing_icon.queue_draw();
2884 (*i)->output_routing_icon.set_terminal(false);
2885 if ( !(*i)->routing_icon.out_identity ()
2886 && !(*next)->routing_icon.in_identity ()
2887 && (*next)->routing_icon.can_coalesce ()) {
2888 (*i)->output_routing_icon.hide();
2889 } else if (!(*i)->routing_icon.out_identity ()) {
2890 (*i)->output_routing_icon.show();
2891 (*i)->output_routing_icon.queue_draw();
2892 (*next)->input_icon.show();
2894 (*i)->output_routing_icon.hide();
2901 ProcessorBox::setup_entry_positions ()
2903 list<ProcessorEntry*> children = processor_display.children ();
2904 bool pre_fader = true;
2907 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2908 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2909 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2911 (*i)->set_position (ProcessorEntry::Fader, num++);
2914 (*i)->set_position (ProcessorEntry::PreFader, num++);
2916 (*i)->set_position (ProcessorEntry::PostFader, num++);
2920 setup_routing_feeds ();
2924 ProcessorBox::compute_processor_sort_keys ()
2926 list<ProcessorEntry*> children = processor_display.children ();
2927 Route::ProcessorList our_processors;
2929 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2930 if ((*i)->processor()) {
2931 our_processors.push_back ((*i)->processor ());
2935 if (_route->reorder_processors (our_processors)) {
2936 /* Reorder failed, so report this to the user. As far as I can see this must be done
2937 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2938 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2939 when the drag is torn down after this handler function is finished.
2941 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2946 ProcessorBox::report_failed_reorder ()
2948 /* reorder failed, so redisplay */
2950 redisplay_processors ();
2952 /* now tell them about the problem */
2954 ArdourDialog dialog (_("Plugin Incompatibility"));
2957 label.set_text (_("\
2958 You cannot reorder these plugins/sends/inserts\n\
2959 in that way because the inputs and\n\
2960 outputs will not work correctly."));
2962 dialog.get_vbox()->set_border_width (12);
2963 dialog.get_vbox()->pack_start (label);
2964 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2966 dialog.set_name (X_("PluginIODialog"));
2967 dialog.set_modal (true);
2974 ProcessorBox::rename_processors ()
2976 ProcSelection to_be_renamed;
2978 get_selected_processors (to_be_renamed);
2980 if (to_be_renamed.empty()) {
2984 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2985 rename_processor (*i);
2990 ProcessorBox::can_cut () const
2992 vector<boost::shared_ptr<Processor> > sel;
2994 get_selected_processors (sel);
2996 /* cut_processors () does not cut inserts */
2998 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3000 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3001 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3002 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3011 ProcessorBox::stub_processor_selected () const
3013 vector<boost::shared_ptr<Processor> > sel;
3015 get_selected_processors (sel);
3017 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3018 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3027 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3029 if (to_be_removed.empty()) {
3033 XMLNode* node = new XMLNode (X_("cut"));
3034 Route::ProcessorList to_cut;
3036 no_processor_redisplay = true;
3037 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3038 // Cut only plugins, sends and returns
3039 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3040 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3041 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3043 Window* w = get_processor_ui (*i);
3049 XMLNode& child ((*i)->get_state());
3050 node->add_child_nocopy (child);
3051 to_cut.push_back (*i);
3055 if (_route->remove_processors (to_cut) != 0) {
3057 no_processor_redisplay = false;
3061 _p_selection.set (node);
3063 no_processor_redisplay = false;
3064 redisplay_processors ();
3068 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3070 if (to_be_copied.empty()) {
3074 XMLNode* node = new XMLNode (X_("copy"));
3076 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3077 // Copy only plugins, sends, returns
3078 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3079 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3080 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3081 node->add_child_nocopy ((*i)->get_state());
3085 _p_selection.set (node);
3089 ProcessorBox::delete_processors (const ProcSelection& targets)
3091 if (targets.empty()) {
3095 no_processor_redisplay = true;
3097 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3099 Window* w = get_processor_ui (*i);
3105 _route->remove_processor(*i);
3108 no_processor_redisplay = false;
3109 redisplay_processors ();
3113 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3115 list<boost::shared_ptr<Processor> >::const_iterator x;
3117 no_processor_redisplay = true;
3118 for (x = procs.begin(); x != procs.end(); ++x) {
3120 Window* w = get_processor_ui (*x);
3126 _route->remove_processor(*x);
3129 no_processor_redisplay = false;
3130 redisplay_processors ();
3134 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3136 boost::shared_ptr<Processor> processor (weak_processor.lock());
3142 /* NOT copied to _mixer.selection() */
3144 no_processor_redisplay = true;
3145 _route->remove_processor (processor);
3146 no_processor_redisplay = false;
3147 redisplay_processors ();
3153 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3155 Prompter name_prompter (true);
3157 name_prompter.set_title (_("Rename Processor"));
3158 name_prompter.set_prompt (_("New name:"));
3159 name_prompter.set_initial_text (processor->name());
3160 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3161 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3162 name_prompter.show_all ();
3164 switch (name_prompter.run ()) {
3166 case Gtk::RESPONSE_ACCEPT:
3167 name_prompter.get_result (result);
3168 if (result.length()) {
3171 string test = result;
3173 while (tries < 100) {
3174 if (_session->io_name_is_legal (test)) {
3180 test = string_compose ("%1-%2", result, tries);
3184 processor->set_name (result);
3187 ARDOUR_UI::instance()->popup_error
3188 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3198 ProcessorBox::paste_processors ()
3200 if (_p_selection.processors.empty()) {
3204 paste_processor_state (_p_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3208 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3211 if (_p_selection.processors.empty()) {
3215 paste_processor_state (_p_selection.processors.get_node().children(), before);
3219 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3221 XMLNodeConstIterator niter;
3222 list<boost::shared_ptr<Processor> > copies;
3224 if (nlist.empty()) {
3228 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3230 XMLProperty const * type = (*niter)->property ("type");
3231 XMLProperty const * role = (*niter)->property ("role");
3234 boost::shared_ptr<Processor> p;
3236 if (type->value() == "meter" ||
3237 type->value() == "main-outs" ||
3238 type->value() == "amp" ||
3239 type->value() == "intreturn") {
3240 /* do not paste meter, main outs, amp or internal returns */
3243 } else if (type->value() == "intsend") {
3245 /* aux sends are OK, but those used for
3246 * other purposes, are not.
3251 if (role->value() != "Aux") {
3255 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3256 XMLNode n (**niter);
3257 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3258 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3260 IOProcessor::prepare_for_reset (n, s->name());
3262 if (s->set_state (n, Stateful::loading_state_version)) {
3269 } else if (type->value() == "send") {
3271 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3272 XMLNode n (**niter);
3274 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3276 IOProcessor::prepare_for_reset (n, s->name());
3278 if (s->set_state (n, Stateful::loading_state_version)) {
3285 } else if (type->value() == "return") {
3287 XMLNode n (**niter);
3288 Return* r = new Return (*_session);
3290 IOProcessor::prepare_for_reset (n, r->name());
3292 if (r->set_state (n, Stateful::loading_state_version)) {
3299 } else if (type->value() == "port") {
3301 XMLNode n (**niter);
3302 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3304 IOProcessor::prepare_for_reset (n, pi->name());
3306 if (pi->set_state (n, Stateful::loading_state_version)) {
3312 /* XXX its a bit limiting to assume that everything else
3315 p.reset (new PluginInsert (*_session));
3316 /* we can't use RAII Stateful::ForceIDRegeneration
3317 * because that'd void copying the state and wrongly bump
3318 * the state-version counter.
3319 * we need to load the state (incl external files) first and
3320 * only then update the ID)
3322 PBD::ID id = p->id();
3323 /* strip side-chain state (processor inside processor must be a side-chain)
3324 * otherwise we'll end up with duplicate ports-names.
3325 * (this needs a better solution which retains connections)
3326 * We really would want Stateful::ForceIDRegeneration here :(
3328 XMLNode state (**niter);
3329 state.remove_nodes_and_delete ("Processor");
3331 p->set_state (state, Stateful::current_state_version);
3332 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3335 copies.push_back (p);
3339 error << _("plugin insert constructor failed") << endmsg;
3343 if (copies.empty()) {
3347 if (_route->add_processors (copies, p)) {
3350 "Copying the set of processors on the clipboard failed,\n\
3351 probably because the I/O configuration of the plugins\n\
3352 could not match the configuration of this track.");
3353 MessageDialog am (msg);
3359 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3361 const list<ProcessorEntry*> selection = processor_display.selection (true);
3362 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3363 processors.push_back ((*i)->processor ());
3368 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3370 list<ProcessorEntry*> selection = processor_display.selection ();
3371 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3372 (this->*method) ((*i)->processor ());
3377 ProcessorBox::all_visible_processors_active (bool state)
3379 _route->all_visible_processors_active (state);
3383 ProcessorBox::ab_plugins ()
3385 _route->ab_plugins (ab_direction);
3386 ab_direction = !ab_direction;
3390 ProcessorBox::set_disk_io_position (DiskIOPoint diop)
3392 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_route);
3394 t->set_disk_io_point (diop);
3399 ProcessorBox::clear_processors ()
3402 vector<string> choices;
3404 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3405 "(this cannot be undone)"), _route->name());
3407 choices.push_back (_("Cancel"));
3408 choices.push_back (_("Yes, remove them all"));
3410 ArdourWidgets::Choice prompter (_("Remove processors"), prompt, choices);
3412 if (prompter.run () == 1) {
3413 _route->clear_processors (PreFader);
3414 _route->clear_processors (PostFader);
3419 ProcessorBox::clear_processors (Placement p)
3422 vector<string> choices;
3424 if (p == PreFader) {
3425 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3426 "(this cannot be undone)"), _route->name());
3428 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3429 "(this cannot be undone)"), _route->name());
3432 choices.push_back (_("Cancel"));
3433 choices.push_back (_("Yes, remove them all"));
3435 ArdourWidgets::Choice prompter (_("Remove processors"), prompt, choices);
3437 if (prompter.run () == 1) {
3438 _route->clear_processors (p);
3443 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3445 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3446 if (at && at->freeze_state() == AudioTrack::Frozen) {
3451 boost::dynamic_pointer_cast<Send> (processor) ||
3452 boost::dynamic_pointer_cast<Return> (processor) ||
3453 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3454 boost::dynamic_pointer_cast<PortInsert> (processor)
3463 ProcessorBox::one_processor_can_be_edited ()
3465 list<ProcessorEntry*> selection = processor_display.selection ();
3466 list<ProcessorEntry*>::iterator i = selection.begin();
3467 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3471 return (i != selection.end());
3475 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3477 boost::shared_ptr<Send> send;
3478 boost::shared_ptr<InternalSend> internal_send;
3479 boost::shared_ptr<Return> retrn;
3480 boost::shared_ptr<PluginInsert> plugin_insert;
3481 boost::shared_ptr<PortInsert> port_insert;
3484 /* This method may or may not return a Window, but if it does not it
3485 * will modify the parent mixer strip appearance layout to allow
3486 * "editing" the @param processor that was passed in.
3488 * So for example, if the processor is an Amp (gain), the parent strip
3489 * will be forced back into a model where the fader controls the main gain.
3490 * If the processor is a send, then we map the send controls onto the
3493 * Plugins and others will return a window for control.
3496 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3498 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3503 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3505 if (_parent_strip) {
3506 _parent_strip->revert_to_default_display ();
3509 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3511 if (!_session->engine().connected()) {
3515 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3517 gidget = new SendUIWindow (send, _session);
3520 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3522 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3523 /* no GUI for these */
3527 if (!_session->engine().connected()) {
3531 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3533 ReturnUIWindow *return_ui;
3534 Window* w = get_processor_ui (retrn);
3538 return_ui = new ReturnUIWindow (retrn, _session);
3539 return_ui->set_title (retrn->name ());
3540 set_processor_ui (send, return_ui);
3543 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3548 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3550 PluginUIWindow *plugin_ui;
3552 /* these are both allowed to be null */
3554 Window* w = get_processor_ui (plugin_insert);
3557 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3558 plugin_ui->set_title (generate_processor_title (plugin_insert));
3559 set_processor_ui (plugin_insert, plugin_ui);
3562 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3567 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3569 if (!_session->engine().connected()) {
3570 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3575 PortInsertWindow *io_selector;
3577 Window* w = get_processor_ui (port_insert);
3580 io_selector = new PortInsertWindow (_session, port_insert);
3581 set_processor_ui (port_insert, io_selector);
3584 io_selector = dynamic_cast<PortInsertWindow *> (w);
3587 gidget = io_selector;
3594 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3596 boost::shared_ptr<PluginInsert> plugin_insert
3597 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3599 if (!plugin_insert) {
3603 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3604 win->set_title (generate_processor_title (plugin_insert));
3610 ProcessorBox::register_actions ()
3612 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3614 Glib::RefPtr<Action> act;
3617 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3618 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3620 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3621 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3622 ActionManager::engine_sensitive_actions.push_back (act);
3623 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3624 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3625 ActionManager::engine_sensitive_actions.push_back (act);
3627 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3629 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3630 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3632 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3633 sigc::ptr_fun (ProcessorBox::rb_clear));
3634 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3635 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3636 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3637 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3639 /* standard editing stuff */
3641 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3642 sigc::ptr_fun (ProcessorBox::rb_cut));
3643 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3644 sigc::ptr_fun (ProcessorBox::rb_copy));
3645 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3646 sigc::ptr_fun (ProcessorBox::rb_delete));
3647 backspace_action = myactions.register_action (processor_box_actions, X_("backspace"), _("Delete"),
3648 sigc::ptr_fun (ProcessorBox::rb_delete));
3650 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3651 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3652 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3653 ActionManager::plugin_selection_sensitive_actions.push_back (backspace_action);
3655 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3656 sigc::ptr_fun (ProcessorBox::rb_paste));
3657 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3658 sigc::ptr_fun (ProcessorBox::rb_rename));
3659 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3660 sigc::ptr_fun (ProcessorBox::rb_select_all));
3661 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3662 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3664 /* activation etc. */
3666 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3667 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3668 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3669 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3670 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3671 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3673 manage_pins_action = myactions.register_action (
3674 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3675 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3678 disk_io_action = myactions.register_action (processor_box_actions, X_("disk-io-menu"), _("Disk I/O ..."));
3679 myactions.register_action (processor_box_actions, X_("disk-io-prefader"), _("Pre-Fader."), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_set_disk_io_position), DiskIOPreFader));
3680 myactions.register_action (processor_box_actions, X_("disk-io-postfader"), _("Post-Fader."), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_set_disk_io_position), DiskIOPostFader));
3681 myactions.register_action (processor_box_actions, X_("disk-io-custom"), _("Custom."), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_set_disk_io_position), DiskIOCustom));
3684 edit_action = myactions.register_action (
3685 processor_box_actions, X_("edit"), _("Edit..."),
3686 sigc::ptr_fun (ProcessorBox::rb_edit));
3688 edit_generic_action = myactions.register_action (
3689 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3690 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3696 ProcessorBox::rb_edit_generic ()
3698 if (_current_processor_box == 0) {
3702 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3706 ProcessorBox::rb_ab_plugins ()
3708 if (_current_processor_box == 0) {
3712 _current_processor_box->ab_plugins ();
3716 ProcessorBox::rb_set_disk_io_position (DiskIOPoint diop)
3718 if (_current_processor_box == 0) {
3722 _current_processor_box->set_disk_io_position (diop);
3726 ProcessorBox::rb_manage_pins ()
3728 if (_current_processor_box == 0) {
3732 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3735 ProcessorBox::rb_choose_plugin ()
3737 if (_current_processor_box == 0) {
3740 _current_processor_box->choose_plugin ();
3744 ProcessorBox::rb_choose_insert ()
3746 if (_current_processor_box == 0) {
3749 _current_processor_box->choose_insert ();
3753 ProcessorBox::rb_choose_send ()
3755 if (_current_processor_box == 0) {
3758 _current_processor_box->choose_send ();
3762 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3764 if (_current_processor_box == 0) {
3768 _current_processor_box->choose_aux (wr);
3772 ProcessorBox::rb_clear ()
3774 if (_current_processor_box == 0) {
3778 _current_processor_box->clear_processors ();
3783 ProcessorBox::rb_clear_pre ()
3785 if (_current_processor_box == 0) {
3789 _current_processor_box->clear_processors (PreFader);
3794 ProcessorBox::rb_clear_post ()
3796 if (_current_processor_box == 0) {
3800 _current_processor_box->clear_processors (PostFader);
3804 ProcessorBox::rb_cut ()
3806 if (_current_processor_box == 0) {
3810 _current_processor_box->processor_operation (ProcessorsCut);
3814 ProcessorBox::rb_delete ()
3816 if (_current_processor_box == 0) {
3820 _current_processor_box->processor_operation (ProcessorsDelete);
3824 ProcessorBox::rb_copy ()
3826 if (_current_processor_box == 0) {
3829 _current_processor_box->processor_operation (ProcessorsCopy);
3833 ProcessorBox::rb_paste ()
3835 if (_current_processor_box == 0) {
3839 _current_processor_box->processor_operation (ProcessorsPaste);
3843 ProcessorBox::rb_rename ()
3845 if (_current_processor_box == 0) {
3848 _current_processor_box->rename_processors ();
3852 ProcessorBox::rb_select_all ()
3854 if (_current_processor_box == 0) {
3858 _current_processor_box->processor_operation (ProcessorsSelectAll);
3862 ProcessorBox::rb_deselect_all ()
3864 if (_current_processor_box == 0) {
3868 _current_processor_box->deselect_all_processors ();
3872 ProcessorBox::rb_activate_all ()
3874 if (_current_processor_box == 0) {
3878 _current_processor_box->all_visible_processors_active (true);
3882 ProcessorBox::rb_deactivate_all ()
3884 if (_current_processor_box == 0) {
3887 _current_processor_box->all_visible_processors_active (false);
3891 ProcessorBox::rb_edit ()
3893 if (_current_processor_box == 0) {
3897 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3901 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3903 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3907 if (_parent_strip) {
3908 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3909 if (_parent_strip->current_delivery() == send) {
3910 _parent_strip->revert_to_default_display ();
3912 _parent_strip->show_send(send);
3919 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3924 if (edit_aux_send (processor)) {
3927 if (!_session->engine().connected()) {
3931 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3934 proxy->set_custom_ui_mode (true);
3935 proxy->show_the_right_window ();
3940 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3945 if (edit_aux_send (processor)) {
3948 if (!_session->engine().connected()) {
3952 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3955 proxy->set_custom_ui_mode (false);
3956 proxy->show_the_right_window ();
3961 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3966 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3975 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3977 if (!what_changed.contains (ARDOUR::Properties::name)) {
3981 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3983 boost::shared_ptr<Processor> processor;
3984 boost::shared_ptr<PluginInsert> plugin_insert;
3985 boost::shared_ptr<Send> send;
3987 list<ProcessorEntry*> children = processor_display.children();
3989 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3991 processor = (*iter)->processor ();
3997 Window* w = get_processor_ui (processor);
4003 /* rename editor windows for sends and plugins */
4005 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4006 w->set_title (send->name ());
4007 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4008 w->set_title (generate_processor_title (plugin_insert));
4014 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4016 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4017 string::size_type email_pos;
4019 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4020 maker = maker.substr (0, email_pos - 1);
4023 if (maker.length() > 32) {
4024 maker = maker.substr (0, 32);
4028 SessionObject* owner = pi->owner();
4031 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4033 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4037 /** @param p Processor.
4038 * @return the UI window for \a p.
4041 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4043 ProcessorWindowProxy* wp = p->window_proxy();
4050 /** Make a note of the UI window that a processor is using.
4051 * @param p Processor.
4052 * @param w UI window.
4055 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4057 assert (p->window_proxy());
4058 p->window_proxy()->use_window (*w);
4062 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4064 boost::shared_ptr<Delivery> d = w.lock ();
4069 list<ProcessorEntry*> children = processor_display.children ();
4070 list<ProcessorEntry*>::const_iterator i = children.begin();
4071 while (i != children.end() && (*i)->processor() != d) {
4075 if (i == children.end()) {
4076 processor_display.set_active (0);
4078 processor_display.set_active (*i);
4082 /** Called to repair the damage of Editor::show_window doing a show_all() */
4084 ProcessorBox::hide_things ()
4086 list<ProcessorEntry*> c = processor_display.children ();
4087 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4088 (*i)->hide_things ();
4093 ProcessorBox::processor_menu_unmapped ()
4095 processor_display.remove_placeholder ();
4096 /* make all possibly-desensitized actions sensitive again so that
4097 they be activated by other means (e.g. bindings)
4099 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4103 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4105 if (!_parent_strip) {
4109 GUIObjectState& st = _parent_strip->gui_object_state ();
4111 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4113 return st.get_or_add_node (strip, entry->state_id());
4117 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4119 XMLNode* proc = entry_gui_object_state (entry);
4124 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4125 proc->remove_nodes_and_delete (X_("Object"));
4126 entry->add_control_state (proc);
4130 ProcessorBox::is_editor_mixer_strip() const
4132 return _parent_strip && !_parent_strip->mixer_owned();
4135 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4136 : WM::ProxyBase (name, string())
4137 , _processor_box (box)
4138 , _processor (processor)
4140 , want_custom (true)
4142 boost::shared_ptr<Processor> p = _processor.lock ();
4146 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4148 p->ToggleUI.connect (gui_connections, invalidator (*this), boost::bind (&ProcessorWindowProxy::show_the_right_window, this, false), gui_context());
4149 p->ShowUI.connect (gui_connections, invalidator (*this), boost::bind (&ProcessorWindowProxy::show_the_right_window, this, true), gui_context());
4150 p->HideUI.connect (gui_connections, invalidator (*this), boost::bind (&ProcessorWindowProxy::hide, this), gui_context());
4153 ProcessorWindowProxy::~ProcessorWindowProxy()
4155 /* processor window proxies do not own the windows they create with
4156 * ::get(), so set _window to null before the normal WindowProxy method
4163 ProcessorWindowProxy::processor_going_away ()
4165 gui_connections.drop_connections ();
4168 WM::Manager::instance().remove (this);
4169 /* should be no real reason to do this, since the object that would
4170 send DropReferences is about to be deleted, but lets do it anyway.
4172 going_away_connection.disconnect();
4176 ARDOUR::SessionHandlePtr*
4177 ProcessorWindowProxy::session_handle()
4184 ProcessorWindowProxy::get_state ()
4187 node = &ProxyBase::get_state();
4188 node->set_property (X_("custom-ui"), is_custom);
4193 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4195 XMLNodeList children = node.children ();
4196 XMLNodeList::const_iterator i = children.begin ();
4197 while (i != children.end()) {
4199 if ((*i)->name() == X_("Window") && (*i)->get_property (X_("name"), name) && name == _name) {
4205 if (i != children.end()) {
4206 (*i)->get_property (X_("custom-ui"), want_custom);
4209 return ProxyBase::set_state (node, 0);
4213 ProcessorWindowProxy::get (bool create)
4215 boost::shared_ptr<Processor> p = _processor.lock ();
4220 if (_window && (is_custom != want_custom)) {
4221 /* drop existing window - wrong type */
4222 set_state_mask (Gtkmm2ext::WindowProxy::StateMask (state_mask () & ~WindowProxy::Size));
4231 is_custom = want_custom;
4232 _window = _processor_box->get_editor_window (p, is_custom);
4236 _window->show_all ();
4243 ProcessorWindowProxy::show_the_right_window (bool show_not_toggle)
4245 if (_window && (is_custom != want_custom)) {
4246 /* drop existing window - wrong type */
4247 set_state_mask (Gtkmm2ext::WindowProxy::StateMask (state_mask () & ~WindowProxy::Size));
4250 if (_window && fully_visible () && show_not_toggle) {
4257 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4258 : WM::ProxyBase (name, string())
4259 , _processor (processor)
4261 boost::shared_ptr<Processor> p = _processor.lock ();
4265 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4268 PluginPinWindowProxy::~PluginPinWindowProxy()
4273 ARDOUR::SessionHandlePtr*
4274 PluginPinWindowProxy::session_handle ()
4276 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4277 if (aw) { return aw; }
4282 PluginPinWindowProxy::get (bool create)
4284 boost::shared_ptr<Processor> p = _processor.lock ();
4285 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4294 _window = new PluginPinDialog (pi);
4295 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4297 aw->set_session (_session);
4299 _window->show_all ();
4305 PluginPinWindowProxy::processor_going_away ()
4309 WM::Manager::instance().remove (this);
4310 going_away_connection.disconnect();
4315 ProcessorBox::load_bindings ()
4317 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);