2 Copyright (C) 2000-2004 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "gtk2ardour-config.h"
28 #include <sigc++/bind.h>
30 #include "pbd/convert.h"
31 #include "canvas/utils.h"
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <gtkmm/messagedialog.h>
38 #include <gtkmm2ext/gtk_ui.h>
39 #include <gtkmm2ext/utils.h>
40 #include <gtkmm2ext/choice.h>
41 #include <gtkmm2ext/utils.h>
42 #include <gtkmm2ext/doi.h>
43 #include <gtkmm2ext/rgb_macros.h>
45 #include "ardour/amp.h"
46 #include "ardour/audio_track.h"
47 #include "ardour/audioengine.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/internal_send.h"
50 #include "ardour/luaproc.h"
51 #include "ardour/luascripting.h"
52 #include "ardour/meter.h"
53 #include "ardour/panner_shell.h"
54 #include "ardour/plugin_insert.h"
55 #include "ardour/pannable.h"
56 #include "ardour/port_insert.h"
57 #include "ardour/profile.h"
58 #include "ardour/return.h"
59 #include "ardour/route.h"
60 #include "ardour/send.h"
61 #include "ardour/session.h"
62 #include "ardour/types.h"
64 #include "LuaBridge/LuaBridge.h"
67 #include "ardour_dialog.h"
68 #include "ardour_ui.h"
69 #include "gui_thread.h"
70 #include "io_selector.h"
72 #include "luainstance.h"
74 #include "mixer_strip.h"
75 #include "plugin_pin_dialog.h"
76 #include "plugin_selector.h"
77 #include "plugin_ui.h"
78 #include "port_insert_ui.h"
79 #include "processor_box.h"
80 #include "public_editor.h"
81 #include "return_ui.h"
82 #include "route_processor_selection.h"
83 #include "script_selector.h"
87 #include "new_plugin_preset_dialog.h"
91 #ifdef AUDIOUNIT_SUPPORT
96 bool ProcessorBox::show_all_processors = false;
100 using namespace ARDOUR;
103 using namespace Glib;
104 using namespace Gtkmm2ext;
106 ProcessorBox* ProcessorBox::_current_processor_box = 0;
107 RefPtr<Action> ProcessorBox::paste_action;
108 RefPtr<Action> ProcessorBox::cut_action;
109 RefPtr<Action> ProcessorBox::copy_action;
110 RefPtr<Action> ProcessorBox::rename_action;
111 RefPtr<Action> ProcessorBox::delete_action;
112 RefPtr<Action> ProcessorBox::manage_pins_action;
113 RefPtr<Action> ProcessorBox::edit_action;
114 RefPtr<Action> ProcessorBox::edit_generic_action;
115 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
116 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
117 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
120 // TODO consolidate with PluginPinDialog::set_color
121 static void set_routing_color (cairo_t* cr, bool midi)
123 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
124 static const uint32_t midi_port_color = 0x960909FF; //Red
127 cairo_set_source_rgb (cr,
128 UINT_RGBA_R_FLT(midi_port_color),
129 UINT_RGBA_G_FLT(midi_port_color),
130 UINT_RGBA_B_FLT(midi_port_color));
132 cairo_set_source_rgb (cr,
133 UINT_RGBA_R_FLT(audio_port_color),
134 UINT_RGBA_G_FLT(audio_port_color),
135 UINT_RGBA_B_FLT(audio_port_color));
139 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
140 : _button (ArdourButton::led_default_elements)
141 , _position (PreFader)
145 , _unknown_processor(false)
151 , output_routing_icon(false)
156 _button.set_distinct_led_click (true);
157 _button.set_fallthrough_to_parent(true);
158 _button.set_led_left (true);
159 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
160 _button.set_text (name (_width));
162 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
163 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
165 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
166 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
167 _unknown_processor = true;
170 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
171 if (pi && pi->plugin() && pi->plugin()->get_info()->type != ARDOUR::Lua) {
172 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
177 _vbox.pack_start (routing_icon);
178 _vbox.pack_start (input_icon);
179 _vbox.pack_start (_button, true, true);
181 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
182 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
183 if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
184 _plugin_display = new PluginDisplay (pi->plugin(),
185 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
187 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
188 _plugin_display = new LuaPluginDisplay (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
189 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
191 _vbox.pack_start (*_plugin_display);
192 _plugin_display->set_no_show_all (true);
193 if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
194 _plugin_display->show ();
197 _vbox.pack_end (output_routing_icon);
198 _vbox.pack_end (output_icon);
200 _button.set_active (_processor->active());
202 input_icon.set_no_show_all(true);
203 routing_icon.set_no_show_all(true);
204 output_icon.set_no_show_all(true);
205 output_routing_icon.set_no_show_all(true);
211 output_routing_icon.hide();
213 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
214 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
215 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
217 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
218 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
220 std::string label = _processor->describe_parameter (*i);
222 if (boost::dynamic_pointer_cast<Send> (_processor)) {
224 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
228 Control* c = new Control (_processor->automation_control (*i), label);
230 _controls.push_back (c);
232 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
233 /* Add non-Amp (Fader & Trim) controls to the processor box */
234 _vbox.pack_start (c->box);
241 _vbox.set_size_request (-1, _button.size_request().height);
245 ProcessorEntry::~ProcessorEntry ()
247 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
250 delete _plugin_display;
254 ProcessorEntry::action_widget ()
260 ProcessorEntry::widget ()
266 ProcessorEntry::drag_text () const
272 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
274 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
278 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
279 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
280 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
281 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
284 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
287 if (!my_pi || !ot_pi) {
290 if (my_pi->type() != ot_pi->type()) {
293 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
294 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
295 if (!my_p || !ot_p) {
298 if (my_p->unique_id() != ot_p->unique_id()) {
305 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
307 if (data.get_target() == "PluginPresetPtr") {
308 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
310 if (!_plugin_preset_pointer || !pi) {
311 data.set (data.get_target(), 8, NULL, 0);
315 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
318 PluginManager& manager (PluginManager::instance());
319 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
321 NewPluginPresetDialog d (plugin,
322 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
324 _plugin_preset_pointer->_preset.valid = false;
327 case Gtk::RESPONSE_CANCEL:
328 data.set (data.get_target(), 8, NULL, 0);
332 case Gtk::RESPONSE_NO:
335 case Gtk::RESPONSE_ACCEPT:
336 if (d.name().empty()) {
341 plugin->remove_preset (d.name ());
344 Plugin::PresetRecord const r = plugin->save_preset (d.name());
346 if (!r.uri.empty ()) {
347 _plugin_preset_pointer->_preset.uri = r.uri;
348 _plugin_preset_pointer->_preset.label = r.label;
349 _plugin_preset_pointer->_preset.user = r.user;
350 _plugin_preset_pointer->_preset.valid = r.valid;
353 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
360 ProcessorEntry::set_position (Position p, uint32_t num)
368 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
371 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
373 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
378 ProcessorEntry::setup_visuals ()
380 if (_unknown_processor) {
381 _button.set_name ("processor stub");
384 boost::shared_ptr<Send> send;
385 if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
386 if (send->remove_on_disconnect ()) {
387 _button.set_name ("processor sidechain");
394 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
395 _button.set_name ("processor prefader");
399 _button.set_name ("processor fader");
403 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
404 _button.set_name ("processor postfader");
410 boost::shared_ptr<Processor>
411 ProcessorEntry::processor () const
414 return boost::shared_ptr<Processor>();
420 ProcessorEntry::set_enum_width (Width w)
423 _button.set_text (name (_width));
427 ProcessorEntry::led_clicked(GdkEventButton *ev)
429 bool ctrl_shift_pressed = false;
430 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
432 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
433 ctrl_shift_pressed = true;
437 if (_button.get_active ()) {
438 if (ctrl_shift_pressed) {
439 _parent->all_visible_processors_active(false);
441 if (_position == Fader) {
442 _processor->deactivate ();
446 _processor->deactivate ();
450 if (ctrl_shift_pressed) {
451 _parent->all_visible_processors_active(true);
453 if (_position == Fader) {
454 _processor->activate ();
458 _processor->activate ();
465 ProcessorEntry::processor_active_changed ()
468 _button.set_active (_processor->active());
473 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
475 if (what_changed.contains (ARDOUR::Properties::name)) {
476 _button.set_text (name (_width));
482 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
484 _parent->setup_routing_feeds ();
485 input_icon.queue_draw();
486 output_icon.queue_draw();
487 routing_icon.queue_draw();
488 output_routing_icon.queue_draw();
492 ProcessorEntry::setup_tooltip ()
495 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
497 std::string postfix = "";
499 if ((replicated = pi->get_count()) > 1) {
500 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
502 if (pi->plugin()->has_editor()) {
503 ARDOUR_UI_UTILS::set_tooltip (_button,
504 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::primary_modifier_name (), postfix));
506 ARDOUR_UI_UTILS::set_tooltip (_button,
507 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
511 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
512 ARDOUR_UI::instance()->set_tip (_button,
513 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
516 if (boost::dynamic_pointer_cast<Send> (_processor) && !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
517 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>", _processor->name()));
521 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
525 ProcessorEntry::name (Width w) const
527 boost::shared_ptr<Send> send;
534 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
535 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
538 std::string send_name;
539 bool pretty_ok = true;
541 if (send->remove_on_disconnect ()) {
542 // assume it's a sidechain, find pretty name of connected port(s)
543 PortSet& ps (send->output ()->ports ());
544 for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
545 vector<string> connections;
546 if (i->get_connections (connections)) {
547 vector<string>::const_iterator ci;
548 for (ci = connections.begin(); ci != connections.end(); ++ci) {
549 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
553 if (send_name.empty ()) {
555 } else if (send_name != pn) {
556 // pretty names don't match
569 /* grab the send name out of its overall name */
570 if (send_name.empty()) {
571 send_name = send->name();
572 string::size_type lbracket, rbracket;
573 lbracket = send_name.find ('[');
574 rbracket = send_name.find (']');
575 send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
580 name_display += send_name;
583 name_display += PBD::short_version (send_name, 5);
588 boost::shared_ptr<ARDOUR::PluginInsert> pi;
590 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
591 && (replicated = pi->get_count()) > 1)
593 name_display += string_compose(_("(%1x1) "), replicated);
598 name_display += _processor->display_name();
601 name_display += PBD::short_version (_processor->display_name(), 5);
611 ProcessorEntry::show_all_controls ()
613 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
614 (*i)->set_visible (true);
617 _parent->update_gui_object_state (this);
621 ProcessorEntry::hide_all_controls ()
623 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
624 (*i)->set_visible (false);
627 _parent->update_gui_object_state (this);
631 ProcessorEntry::add_control_state (XMLNode* node) const
633 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
634 (*i)->add_state (node);
637 if (_plugin_display) {
638 XMLNode* c = new XMLNode (X_("Object"));
639 c->add_property (X_("id"), X_("InlineDisplay"));
640 c->add_property (X_("visible"), _plugin_display->is_visible ());
641 node->add_child_nocopy (*c);
646 ProcessorEntry::set_control_state (XMLNode const * node)
648 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
649 (*i)->set_state (node);
652 if (_plugin_display) {
653 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
654 XMLProperty* p = n ? n->property (X_("visible")) : NULL;
656 if (string_is_affirmative (p->value ())) {
657 _plugin_display->show();
659 _plugin_display->hide();
666 ProcessorEntry::state_id () const
668 return string_compose ("processor %1", _processor->id().to_s());
672 ProcessorEntry::hide_things ()
674 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
675 (*i)->hide_things ();
681 ProcessorEntry::build_controls_menu ()
683 using namespace Menu_Helpers;
684 Menu* menu = manage (new Menu);
685 MenuList& items = menu->items ();
687 if (_plugin_display) {
688 items.push_back (CheckMenuElem (_("Inline Display")));
689 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
690 c->set_active (_plugin_display->is_visible ());
691 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
692 items.push_back (SeparatorElem ());
696 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
700 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
703 if (!_controls.empty ()) {
704 items.push_back (SeparatorElem ());
707 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
708 items.push_back (CheckMenuElem ((*i)->name ()));
709 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
710 c->set_active ((*i)->visible ());
711 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
718 ProcessorEntry::toggle_inline_display_visibility ()
720 if (_plugin_display->is_visible ()) {
721 _plugin_display->hide();
723 _plugin_display->show();
725 _parent->update_gui_object_state (this);
729 ProcessorEntry::toggle_control_visibility (Control* c)
731 c->set_visible (!c->visible ());
732 _parent->update_gui_object_state (this);
736 ProcessorEntry::build_send_options_menu ()
738 using namespace Menu_Helpers;
739 Menu* menu = manage (new Menu);
740 MenuList& items = menu->items ();
742 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
745 items.push_back (CheckMenuElem (_("Link panner controls")));
746 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
747 c->set_active (send->panner_shell()->is_linked_to_route());
748 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
755 ProcessorEntry::toggle_panner_link ()
757 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
759 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
763 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
765 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
766 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
767 , _slider_persistant_tooltip (&_slider)
768 , _button (ArdourButton::led_default_elements)
769 , _ignore_ui_adjustment (false)
773 _slider.set_controllable (c);
774 box.set_padding(0, 0, 4, 4);
777 _button.set_text (_name);
778 _button.set_led_left (true);
779 _button.set_name ("processor control button");
783 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
784 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
785 // dup. currently timers are used :(
786 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
790 _slider.set_name ("ProcessorControlSlider");
791 _slider.set_text (_name);
796 const ARDOUR::ParameterDescriptor& desc = c->desc();
797 double const lo = c->internal_to_interface(desc.lower);
798 double const up = c->internal_to_interface(desc.upper);
799 double const normal = c->internal_to_interface(desc.normal);
800 double smallstep = desc.smallstep;
801 double largestep = desc.largestep;
803 if (smallstep == 0.0) {
804 smallstep = up / 1000.;
806 smallstep = c->internal_to_interface(desc.lower + smallstep);
809 if (largestep == 0.0) {
810 largestep = up / 40.;
812 largestep = c->internal_to_interface(desc.lower + largestep);
815 _adjustment.set_lower (lo);
816 _adjustment.set_upper (up);
817 _adjustment.set_step_increment (smallstep);
818 _adjustment.set_page_increment (largestep);
819 _slider.set_default_value (normal);
821 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
822 // dup. currently timers are used :(
823 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
826 // yuck, do we really need to do this?
827 // according to c404374 this is only needed for send automation
828 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
833 /* We're providing our own PersistentTooltip */
834 set_no_tooltip_whatsoever (_slider);
837 ProcessorEntry::Control::~Control ()
839 timer_connection.disconnect ();
843 ProcessorEntry::Control::set_tooltip ()
845 boost::shared_ptr<AutomationControl> c = _control.lock ();
852 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
854 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
857 string sm = Gtkmm2ext::markup_escape_text (tmp);
858 _slider_persistant_tooltip.set_tip (sm);
859 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
863 ProcessorEntry::Control::slider_adjusted ()
865 if (_ignore_ui_adjustment) {
869 boost::shared_ptr<AutomationControl> c = _control.lock ();
875 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
880 ProcessorEntry::Control::button_clicked ()
882 boost::shared_ptr<AutomationControl> c = _control.lock ();
888 bool const n = _button.get_active ();
890 c->set_value (n ? 0 : 1, Controllable::NoGroup);
891 _button.set_active (!n);
896 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
904 ProcessorEntry::Control::control_changed ()
906 boost::shared_ptr<AutomationControl> c = _control.lock ();
911 _ignore_ui_adjustment = true;
915 _button.set_active (c->get_value() > 0.5);
918 // as long as rapid timers are used, only update the tooltip
919 // if the value has changed.
920 const double nval = c->internal_to_interface (c->get_value ());
921 if (_adjustment.get_value() != nval) {
922 _adjustment.set_value (nval);
927 _ignore_ui_adjustment = false;
931 ProcessorEntry::Control::add_state (XMLNode* node) const
933 XMLNode* c = new XMLNode (X_("Object"));
934 c->add_property (X_("id"), state_id ());
935 c->add_property (X_("visible"), _visible);
936 node->add_child_nocopy (*c);
940 ProcessorEntry::Control::set_state (XMLNode const * node)
942 XMLNode* n = GUIObjectState::get_node (node, state_id ());
944 XMLProperty* p = n->property (X_("visible"));
945 set_visible (p && string_is_affirmative (p->value ()));
952 ProcessorEntry::Control::set_visible (bool v)
963 /** Called when the Editor might have re-shown things that
967 ProcessorEntry::Control::hide_things ()
975 ProcessorEntry::Control::state_id () const
977 boost::shared_ptr<AutomationControl> c = _control.lock ();
980 return string_compose (X_("control %1"), c->id().to_s ());
983 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
984 : ProcessorEntry (b, p, w)
987 p->PluginIoReConfigure.connect (
988 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
990 p->PluginMapChanged.connect (
991 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
993 p->PluginConfigChanged.connect (
994 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
999 PluginInsertProcessorEntry::iomap_changed ()
1001 _parent->setup_routing_feeds ();
1002 routing_icon.queue_draw();
1003 output_routing_icon.queue_draw();
1007 PluginInsertProcessorEntry::hide_things ()
1009 ProcessorEntry::hide_things ();
1012 ProcessorEntry::PortIcon::PortIcon(bool input) {
1014 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1015 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1019 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1021 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1023 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1026 Gtk::Allocation a = get_allocation();
1027 double const width = a.get_width();
1028 double const height = a.get_height();
1030 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1031 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1033 cairo_rectangle (cr, 0, 0, width, height);
1036 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1037 if (_ports.n_total() > 1) {
1038 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1039 set_routing_color (cr, i < _ports.n_midi());
1040 const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
1041 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1044 } else if (_ports.n_total() == 1) {
1045 set_routing_color (cr, _ports.n_midi() == 1);
1046 const float x = rintf(width * .5);
1047 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1055 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1059 set_terminal (false);
1063 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1065 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1067 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1069 set_size_request (-1, h);
1073 ProcessorEntry::RoutingIcon::set (
1074 const ARDOUR::ChanCount& in,
1075 const ARDOUR::ChanCount& out,
1076 const ARDOUR::ChanCount& sinks,
1077 const ARDOUR::ChanCount& sources,
1078 const ARDOUR::ChanMapping& in_map,
1079 const ARDOUR::ChanMapping& out_map,
1080 const ARDOUR::ChanMapping& thru_map)
1088 _thru_map = thru_map;
1092 ProcessorEntry::RoutingIcon::in_identity () const {
1093 if (_thru_map.n_total () > 0) {
1096 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1099 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1106 ProcessorEntry::RoutingIcon::out_identity () const {
1107 if (_thru_map.n_total () > 0) {
1108 // TODO skip if trhu is not connected to any of next's inputs
1111 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1114 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1121 ProcessorEntry::RoutingIcon::can_coalesce () const {
1122 if (_thru_map.n_total () > 0) {
1125 if (_fed_by && _f_out != _f_sources) {
1128 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1135 ProcessorEntry::RoutingIcon::set_fed_by (
1136 const ARDOUR::ChanCount& out,
1137 const ARDOUR::ChanCount& sources,
1138 const ARDOUR::ChanMapping& out_map,
1139 const ARDOUR::ChanMapping& thru_map)
1142 _f_sources = sources;
1143 _f_out_map = out_map;
1144 _f_thru_map = thru_map;
1149 ProcessorEntry::RoutingIcon::set_feeding (
1150 const ARDOUR::ChanCount& in,
1151 const ARDOUR::ChanCount& sinks,
1152 const ARDOUR::ChanMapping& in_map,
1153 const ARDOUR::ChanMapping& thru_map)
1158 _i_thru_map = thru_map;
1163 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1165 if (!midi) { i += n_midi; }
1168 return rint (width * .5) +.5;
1170 return rint (width * (.2 + .6 * i / (n_total - 1))) + .5;
1174 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1176 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1177 const double y1 = rint (height * .66) + .5;
1180 cairo_translate (cr, x0, y0);
1181 cairo_move_to (cr, 0, height);
1182 cairo_line_to (cr, 0, y1);
1183 cairo_move_to (cr, 0 - dx, y1);
1184 cairo_line_to (cr, 0 + dx, y1);
1186 set_routing_color (cr, midi);
1187 cairo_set_line_width (cr, 1.0);
1193 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1195 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1196 const double y1 = rint (height * .5) - .5;
1199 cairo_translate (cr, x0, y0);
1200 cairo_move_to (cr, 0 - dx, height);
1201 cairo_line_to (cr, 0, y1);
1202 cairo_line_to (cr, 0 + dx, height);
1203 cairo_close_path (cr);
1205 set_routing_color (cr, midi);
1211 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1213 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1214 const double y1 = rint (height * .5) + .5;
1217 cairo_translate (cr, x0, y0);
1218 cairo_move_to (cr, 0 - dx - .5, y1);
1219 cairo_line_to (cr, 0 + dx + .5, y1 - 2);
1221 cairo_move_to (cr, 0 - dx - .5, y1 + 2);
1222 cairo_line_to (cr, 0 + dx + .5, y1);
1224 cairo_move_to (cr, 0, y1 + 1);
1225 cairo_line_to (cr, 0, height);
1227 set_routing_color (cr, midi);
1228 cairo_set_line_width (cr, 1.0);
1234 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1236 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1237 const double y1 = rint (height * .5) - .5;
1240 cairo_translate (cr, x0, y0);
1241 cairo_move_to (cr, 0 - dx - .5, y1);
1242 cairo_line_to (cr, 0 + dx + .5, y1 - 2);
1244 cairo_move_to (cr, 0 - dx - .5, y1 + 2);
1245 cairo_line_to (cr, 0 + dx + .5, y1);
1247 cairo_move_to (cr, 0, y1 - 1);
1248 cairo_line_to (cr, 0, 0);
1250 set_routing_color (cr, midi);
1251 cairo_set_line_width (cr, 1.0);
1257 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1259 double bz = abs (y1 - y0);
1261 cairo_move_to (cr, x0, y0);
1262 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1263 cairo_set_line_width (cr, 1.0);
1264 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1265 cairo_set_source_rgb (cr, 1, 0, 0);
1267 const double dashes[] = { 2, 3 };
1268 cairo_set_dash (cr, dashes, 2, 0);
1270 set_routing_color (cr, midi);
1273 cairo_set_dash (cr, 0, 0, 0);
1278 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1280 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1282 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1285 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1287 Gtk::Allocation a = get_allocation();
1288 double const width = a.get_width();
1289 double const height = a.get_height();
1291 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1292 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1294 cairo_rectangle (cr, 0, 0, width, height);
1298 if (can_coalesce ()) {
1299 expose_coalesced_input_map (cr, width, height);
1301 expose_input_map (cr, width, height);
1304 expose_output_map (cr, width, height);
1312 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1314 const uint32_t pc_in = _sinks.n_total();
1315 const uint32_t pc_in_midi = _sinks.n_midi();
1317 for (uint32_t i = 0; i < pc_in; ++i) {
1318 const bool is_midi = i < pc_in_midi;
1320 uint32_t pn = is_midi ? i : i - pc_in_midi;
1321 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1322 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1324 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1325 draw_gnd (cr, x, 0, height, is_midi);
1328 if (idx >= _in.get (dt)) {
1329 // side-chain, probably
1330 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1331 draw_sidechain (cr, x, 0, height, is_midi);
1335 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1339 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1341 double x = pin_x_pos (i, width, pc_in, 0, false);
1343 _f_thru_map.get (dt, idx, &valid_thru);
1345 draw_thru_src (cr, x, 0, height, is_midi);
1347 draw_gnd (cr, x, 0, height, is_midi);
1351 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1353 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1355 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1360 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1362 const uint32_t n_in = _in.n_total();
1363 const uint32_t n_in_midi = _in.n_midi();
1364 const uint32_t pc_in = _sinks.n_total();
1365 const uint32_t pc_in_midi = _sinks.n_midi();
1367 // draw inputs to this
1368 for (uint32_t i = 0; i < pc_in; ++i) {
1369 const bool is_midi = i < pc_in_midi;
1371 uint32_t pn = is_midi ? i : i - pc_in_midi;
1372 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1373 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1374 // check if it's fed
1375 bool valid_src = true;
1376 if (valid_in && idx < _in.get (dt) && _fed_by) {
1379 _f_out_map.get_src (dt, idx, &valid_out);
1380 _f_thru_map.get (dt, idx, &valid_thru);
1381 if (!valid_out && !valid_thru) {
1385 if (!valid_in || !valid_src) {
1386 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1387 draw_gnd (cr, x, 0, height, is_midi);
1390 if (idx >= _in.get (dt)) {
1391 // side-chain, probably
1392 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1393 draw_sidechain (cr, x, 0, height, is_midi);
1396 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1397 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1398 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1401 // draw reverse thru
1402 for (uint32_t i = 0; i < n_in; ++i) {
1403 const bool is_midi = i < n_in_midi;
1405 uint32_t pn = is_midi ? i : i - n_in_midi;
1406 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1407 _thru_map.get_src (dt, pn, &valid_thru);
1411 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1412 draw_thru_sink (cr, x, 0, height, is_midi);
1417 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1419 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1420 double ht = _terminal ? height - dh : height;
1422 // draw outputs of this
1423 const uint32_t pc_out = _sources.n_total();
1424 const uint32_t pc_out_midi = _sources.n_midi();
1425 const uint32_t n_out = _out.n_total();
1426 const uint32_t n_out_midi = _out.n_midi();
1428 for (uint32_t i = 0; i < pc_out; ++i) {
1429 const bool is_midi = i < pc_out_midi;
1431 uint32_t pn = is_midi ? i : i - pc_out_midi;
1432 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1433 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1437 // skip connections that are not used in the next's input
1439 bool valid_thru, valid_sink;
1440 _i_in_map.get_src (dt, idx, &valid_sink);
1441 _i_thru_map.get_src (dt, idx, &valid_thru);
1442 if (!valid_thru && !valid_sink) {
1446 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1447 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1448 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1451 for (uint32_t i = 0; i < n_out; ++i) {
1452 const bool is_midi = i < n_out_midi;
1453 uint32_t pn = is_midi ? i : i - n_out_midi;
1454 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1455 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1458 // only check thru (gnd is part of input)
1460 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1465 // skip connections that are not used in the next's input :(
1468 _i_in_map.get_src (dt, pn, &valid_sink);
1469 _i_thru_map.get_src (dt, pn, &valid_thru);
1470 if (!valid_thru && !valid_sink) {
1475 if (idx >= _in.get (dt)) {
1476 draw_sidechain (cr, x, 0, ht, is_midi);
1478 draw_thru_src (cr, x, 0, ht, is_midi);
1482 // terminal node, add arrows
1484 _out_map.get_src (dt, pn, &valid_src);
1487 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1489 if (idx >= _in.get (dt)) {
1490 draw_sidechain (cr, x, 0, height - dh, is_midi);
1492 draw_thru_src (cr, x, 0, height - dh, is_midi);
1495 draw_gnd (cr, x, 0, height - dh, is_midi);
1499 set_routing_color (cr, is_midi);
1500 cairo_set_line_width (cr, 1.0);
1501 cairo_move_to (cr, x, height - dh);
1502 cairo_line_to (cr, x, height - 2);
1505 const double ar = dh - 1;
1506 cairo_move_to (cr, x - ar, height - ar);
1507 cairo_line_to (cr, x , height - .5);
1508 cairo_line_to (cr, x + ar, height - ar);
1509 cairo_line_to (cr, x , height - ar * .5);
1510 cairo_close_path (cr);
1511 cairo_fill_preserve (cr);
1517 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1520 , _max_height (max_height)
1524 set_name ("processor prefader");
1525 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1526 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1529 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1532 cairo_surface_destroy (_surf);
1537 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1540 req->height = _cur_height;
1545 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1547 /* work-around scroll-bar + aspect ratio
1548 * show inline-view -> height changes -> scrollbar gets added
1549 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1550 * -> scroll bar is removed [-> width changes ; repeat ]
1552 uint32_t shm = std::min (_max_height, inline_height);
1554 Gtk::Container* pr = get_parent();
1555 for (uint32_t i = 0; i < 4 && pr; ++i) {
1556 // VBox, EventBox, ViewPort, ScrolledWindow
1557 pr = pr->get_parent();
1559 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1561 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1562 sc = vsb && vsb->is_visible();
1565 if (shm != _cur_height) {
1566 if (_scroll == sc || _cur_height < shm) {
1575 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1577 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1582 /* allocate a local image-surface,
1583 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1584 * since pixman keeps a reference to it.
1585 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1586 * it might be possible to work around via cairo_surface_set_user_data().
1589 || dis->width != cairo_image_surface_get_width (_surf)
1590 || dis->height != cairo_image_surface_get_height (_surf)
1593 cairo_surface_destroy (_surf);
1595 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1598 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1599 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1601 unsigned char *src = dis->data;
1602 unsigned char *dst = cairo_image_surface_get_data (_surf);
1603 const int dst_stride = cairo_image_surface_get_stride (_surf);
1604 for (int y = 0; y < dis->height; ++y) {
1605 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1611 cairo_surface_mark_dirty(_surf);
1612 const double xc = floor ((width - dis->width) * .5);
1613 cairo_set_source_surface(cr, _surf, xc, 0);
1620 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1622 Gtk::Allocation a = get_allocation();
1623 double const width = a.get_width();
1624 double const height = a.get_height();
1626 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1627 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1630 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1631 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1632 cairo_rectangle (cr, 0, 0, width, height);
1636 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1637 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1639 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1641 uint32_t ht = render_inline (cr, width);
1646 if (_cur_height != 1) {
1653 update_height_alloc (ht);
1656 bool failed = false;
1657 std::string name = get_name();
1658 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1660 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1661 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1662 cairo_set_line_width(cr, 1.0);
1663 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1670 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1671 : PluginDisplay (p, max_height)
1673 , _lua_render_inline (0)
1675 p->setup_lua_inline_gui (&lua_gui);
1677 lua_State* LG = lua_gui.getState ();
1678 LuaInstance::bind_cairo (LG);
1679 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1680 assert (lua_render.isFunction ());
1681 _lua_render_inline = new luabridge::LuaRef (lua_render);
1684 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1686 delete (_lua_render_inline);
1690 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1692 Cairo::Context ctx (cr);
1694 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1695 if (rv.isTable ()) {
1699 } catch (luabridge::LuaException const& e) {
1706 static std::list<Gtk::TargetEntry> drop_targets()
1708 std::list<Gtk::TargetEntry> tmp;
1709 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1710 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1711 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // from sidebar
1715 static std::list<Gtk::TargetEntry> drag_targets()
1717 std::list<Gtk::TargetEntry> tmp;
1718 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1719 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1723 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1725 std::list<Gtk::TargetEntry> tmp;
1726 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1730 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1731 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1732 : _parent_strip (parent)
1733 , _owner_is_mixer (owner_is_mixer)
1734 , ab_direction (true)
1735 , _get_plugin_selector (get_plugin_selector)
1737 , _visible_prefader_processors (0)
1738 , _rr_selection(rsel)
1739 , processor_display (drop_targets())
1740 , _redisplay_pending (false)
1744 /* ProcessorBox actions and bindings created statically by call to
1745 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1746 * are available for context menus.
1749 processor_display.set_data ("ardour-bindings", bindings);
1753 no_processor_redisplay = false;
1755 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1756 processor_scroller.add (processor_display);
1757 pack_start (processor_scroller, true, true);
1759 processor_display.set_flags (CAN_FOCUS);
1760 processor_display.set_name ("ProcessorList");
1761 processor_display.set_data ("processorbox", this);
1762 processor_display.set_size_request (48, -1);
1763 processor_display.set_spacing (0);
1765 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1766 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1768 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1769 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1771 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1772 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1773 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1775 processor_scroller.show ();
1776 processor_display.show ();
1779 parent->DeliveryChanged.connect (
1780 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1784 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1787 ProcessorBox::~ProcessorBox ()
1789 /* it may appear as if we should delete processor_menu but that is a
1790 * pointer to a widget owned by the UI Manager, and has potentially
1791 * be returned to many other ProcessorBoxes. GTK doesn't really make
1792 * clear the ownership of this widget, which is a menu and thus is
1793 * never packed into any container other than an implict GtkWindow.
1795 * For now, until or if we ever get clarification over the ownership
1796 * story just let it continue to exist. At worst, its a small memory leak.
1801 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1807 _route_connections.drop_connections();
1809 /* new route: any existing block on processor redisplay must be meaningless */
1810 no_processor_redisplay = false;
1813 _route->processors_changed.connect (
1814 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1817 _route->DropReferences.connect (
1818 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1821 _route->PropertyChanged.connect (
1822 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1825 redisplay_processors ();
1829 ProcessorBox::route_going_away ()
1831 /* don't keep updating display as processors are deleted */
1832 no_processor_redisplay = true;
1836 boost::shared_ptr<Processor>
1837 ProcessorBox::find_drop_position (ProcessorEntry* position)
1839 boost::shared_ptr<Processor> p;
1841 p = position->processor ();
1843 /* dropped on the blank entry (which will be before the
1844 fader), so use the first non-blank child as our
1845 `dropped on' processor */
1846 list<ProcessorEntry*> c = processor_display.children ();
1847 list<ProcessorEntry*>::iterator i = c.begin ();
1849 assert (i != c.end ());
1850 p = (*i)->processor ();
1858 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1860 const void * d = data.get_data();
1861 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1863 PluginPresetList nfos;
1865 tv->get_object_drag_data (nfos, &source);
1867 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1868 PluginPresetPtr ppp = (*i);
1869 PluginInfoPtr pip = ppp->_pip;
1870 PluginPtr p = pip->load (*_session);
1875 if (ppp->_preset.valid) {
1876 p->load_preset (ppp->_preset);
1879 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1880 if (Config->get_new_plugins_active ()) {
1881 processor->activate ();
1883 pl.push_back (processor);
1888 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1890 const void * d = data.get_data();
1891 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1892 PluginInfoList nfos;
1895 tv->get_object_drag_data (nfos, &source);
1897 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1898 PluginPtr p = (*i)->load (*_session);
1902 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1903 if (Config->get_new_plugins_active ()) {
1904 processor->activate ();
1906 pl.push_back (processor);
1911 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1917 boost::shared_ptr<Processor> p = find_drop_position (position);
1918 Route::ProcessorList pl;
1920 if (data.get_target() == "PluginInfoPtr") {
1921 _drop_plugin (data, pl);
1923 else if (data.get_target() == "PluginPresetPtr") {
1924 _drop_plugin_preset (data, pl);
1930 Route::ProcessorStreams err;
1931 if (_route->add_processors (pl, p, &err)) {
1933 "Processor Drag/Drop failed. Probably because\n\
1934 the I/O configuration of the plugins could\n\
1935 not match the configuration of this track.");
1936 MessageDialog am (msg);
1942 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1944 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1945 list<ProcessorEntry*> children = source->selection ();
1946 assert (children.size() == 1);
1947 ProcessorEntry* other = *children.begin();
1948 assert (other->can_copy_state (position));
1949 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1950 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1951 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1952 assert (otherproc && proc && pi);
1954 PBD::ID id = pi->id();
1955 XMLNode& state = otherproc->get_state ();
1956 /* strip side-chain state (processor inside processor must be a side-chain)
1957 * otherwise we'll end up with duplicate ports-names.
1958 * (this needs a better solution which retains connections)
1960 state.remove_nodes ("Processor");
1961 proc->set_state (state, Stateful::loading_state_version);
1962 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1966 boost::shared_ptr<Processor> p = find_drop_position (position);
1968 list<ProcessorEntry*> children = source->selection ();
1969 list<boost::shared_ptr<Processor> > procs;
1970 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1971 if ((*i)->processor ()) {
1972 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1975 procs.push_back ((*i)->processor ());
1979 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1980 XMLNode& state = (*i)->get_state ();
1982 nlist.push_back (&state);
1983 paste_processor_state (nlist, p);
1987 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1991 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1992 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1994 other->delete_dragged_processors (procs);
2000 ProcessorBox::set_width (Width w)
2008 list<ProcessorEntry*> children = processor_display.children ();
2009 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2010 (*i)->set_enum_width (w);
2017 ProcessorBox::build_possible_aux_menu ()
2019 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2022 /* No aux sends if there are no busses */
2026 if (_route->is_monitor ()) {
2030 using namespace Menu_Helpers;
2031 Menu* menu = manage (new Menu);
2032 MenuList& items = menu->items();
2034 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2035 if (!_route->internal_send_for (*r) && *r != _route) {
2036 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2044 ProcessorBox::show_processor_menu (int arg)
2046 if (processor_menu == 0) {
2047 processor_menu = build_processor_menu ();
2048 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2051 /* Sort out the plugin submenu */
2053 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2055 if (plugin_menu_item) {
2056 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2059 /* And the aux submenu */
2061 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2063 if (aux_menu_item) {
2064 Menu* m = build_possible_aux_menu();
2065 if (m && !m->items().empty()) {
2066 aux_menu_item->set_submenu (*m);
2067 aux_menu_item->set_sensitive (true);
2069 /* stupid gtkmm: we need to pass a null reference here */
2070 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2071 aux_menu_item->set_sensitive (false);
2075 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2076 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2078 ProcessorEntry* single_selection = 0;
2079 if (processor_display.selection().size() == 1) {
2080 single_selection = processor_display.selection().front();
2083 /* And the controls submenu */
2085 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2087 if (controls_menu_item) {
2088 if (single_selection) {
2089 Menu* m = single_selection->build_controls_menu ();
2090 if (m && !m->items().empty()) {
2091 controls_menu_item->set_submenu (*m);
2092 controls_menu_item->set_sensitive (true);
2094 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2095 controls_menu_item->set_sensitive (false);
2098 controls_menu_item->set_sensitive (false);
2102 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2103 if (send_menu_item) {
2104 if (single_selection && !_route->is_monitor()) {
2105 Menu* m = single_selection->build_send_options_menu ();
2106 if (m && !m->items().empty()) {
2107 send_menu_item->set_submenu (*m);
2108 send_menu_item->set_sensitive (true);
2110 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2111 send_menu_item->set_sensitive (false);
2114 send_menu_item->set_sensitive (false);
2118 /* Sensitise actions as approprioate */
2121 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2123 paste_action->set_sensitive (!_rr_selection.processors.empty());
2124 cut_action->set_sensitive (sensitive && can_cut ());
2125 copy_action->set_sensitive (sensitive);
2126 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2128 edit_action->set_sensitive (one_processor_can_be_edited ());
2129 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2131 boost::shared_ptr<PluginInsert> pi;
2132 if (single_selection) {
2133 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2136 manage_pins_action->set_sensitive (pi != 0);
2138 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2139 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2141 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2142 rename_action->set_sensitive (single_selection
2144 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2145 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2147 processor_menu->popup (1, arg);
2149 /* Add a placeholder gap to the processor list to indicate where a processor would be
2150 inserted were one chosen from the menu.
2153 processor_display.get_pointer (x, y);
2154 _placement = processor_display.add_placeholder (y);
2156 if (_visible_prefader_processors == 0 && _placement > 0) {
2162 ProcessorBox::enter_notify (GdkEventCrossing*)
2164 processor_display.grab_focus ();
2165 _current_processor_box = this;
2170 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2172 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2176 Widget* top = get_toplevel();
2178 if (top->is_toplevel()) {
2179 Window* win = dynamic_cast<Window*> (top);
2180 gtk_window_set_focus (win->gobj(), 0);
2187 ProcessorBox::processor_operation (ProcessorOperation op)
2189 ProcSelection targets;
2191 get_selected_processors (targets);
2193 /* if (targets.empty()) {
2196 processor_display.get_pointer (x, y);
2198 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2200 if (pointer.first && pointer.first->processor()) {
2201 targets.push_back (pointer.first->processor ());
2206 if ((op == ProcessorsDelete) && targets.empty()) {
2207 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2211 case ProcessorsSelectAll:
2212 processor_display.select_all ();
2215 case ProcessorsSelectNone:
2216 processor_display.select_none ();
2219 case ProcessorsCopy:
2220 copy_processors (targets);
2224 cut_processors (targets);
2227 case ProcessorsPaste:
2228 // some processors are not selectable (e.g fader, meter), target is empty.
2229 if (targets.empty() && _placement >= 0) {
2231 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2233 targets.push_back (proc);
2236 if (targets.empty()) {
2237 paste_processors ();
2239 paste_processors (targets.front());
2243 case ProcessorsDelete:
2244 delete_processors (targets);
2247 case ProcessorsToggleActive:
2248 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2249 if ((*i)->active()) {
2250 (*i)->deactivate ();
2268 ProcessorWindowProxy*
2269 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2271 return processor->window_proxy();
2276 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2278 boost::shared_ptr<Processor> processor;
2280 processor = child->processor ();
2284 bool selected = processor_display.selected (child);
2286 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2288 if (_session->engine().connected()) {
2289 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2291 if (!one_processor_can_be_edited ()) {
2295 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2296 generic_edit_processor (processor);
2298 edit_processor (processor);
2304 } else if (Keyboard::is_context_menu_event (ev)) {
2306 show_processor_menu (ev->time);
2310 } else if (processor && ev->button == 1 && selected) {
2312 // this is purely informational but necessary for route params UI
2313 ProcessorSelected (processor); // emit
2315 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2318 _get_plugin_selector()->show_manager ();
2325 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2327 boost::shared_ptr<Processor> processor;
2329 processor = child->processor ();
2332 if (processor && Keyboard::is_delete_event (ev)) {
2334 Glib::signal_idle().connect (sigc::bind (
2335 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2336 boost::weak_ptr<Processor>(processor)));
2338 } else if (processor && Keyboard::is_button2_event (ev)
2340 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2344 /* button2-click with no/appropriate modifiers */
2346 if (processor->active()) {
2347 processor->deactivate ();
2349 processor->activate ();
2357 ProcessorBox::build_processor_menu ()
2359 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2360 processor_menu->set_name ("ArdourContextMenu");
2361 return processor_menu;
2365 ProcessorBox::select_all_processors ()
2367 processor_display.select_all ();
2371 ProcessorBox::deselect_all_processors ()
2373 processor_display.select_none ();
2377 ProcessorBox::choose_plugin ()
2379 _get_plugin_selector()->set_interested_object (*this);
2382 /** @return true if an error occurred, otherwise false */
2384 ProcessorBox::choose_lua ()
2386 LuaScriptInfoPtr spi;
2388 ScriptSelector ss (_("Add Lua DSP Processor"), LuaScriptInfo::DSP);
2389 switch (ss.run ()) {
2390 case Gtk::RESPONSE_ACCEPT:
2400 LuaPluginInfoPtr lpi (new LuaPluginInfo(spi));
2401 p = (lpi->load (*_session));
2404 "Failed to instantiate Lua DSP Processor,\n"
2405 "probably because the script is invalid (no dsp function).");
2406 MessageDialog am (msg);
2411 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
2413 Route::ProcessorStreams err_streams;
2414 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2416 "Failed to add Lua DSP Processor at the given position,\n"
2417 "probably because the I/O configuration of the plugins\n"
2418 "could not match the configuration of this track.");
2419 MessageDialog am (msg);
2425 /** @return true if an error occurred, otherwise false */
2427 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2429 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2431 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2433 Route::ProcessorStreams err_streams;
2435 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2436 weird_plugin_dialog (**p, err_streams);
2438 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2439 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2440 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2442 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2443 if ((*p)->has_editor ()) {
2444 edit_processor (processor);
2446 generic_edit_processor (processor);
2456 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2458 ArdourDialog dialog (_("Plugin Incompatibility"));
2461 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2462 p.name(), streams.index);
2464 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2465 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2467 text += _("\nThis plugin has:\n");
2469 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2470 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2473 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2474 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2477 text += _("\nbut at the insertion point, there are:\n");
2479 uint32_t const n = streams.count.n_midi ();
2480 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2483 uint32_t const n = streams.count.n_audio ();
2484 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2487 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2488 label.set_text(text);
2490 dialog.get_vbox()->pack_start (label);
2491 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2493 dialog.set_name (X_("PluginIODialog"));
2494 dialog.set_modal (true);
2501 ProcessorBox::choose_insert ()
2503 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2504 _route->add_processor_by_index (processor, _placement);
2507 /* Caller must not hold process lock */
2509 ProcessorBox::choose_send ()
2511 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2512 boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
2514 /* make an educated guess at the initial number of outputs for the send */
2515 ChanCount outs = (_session->master_out())
2516 ? _session->master_out()->n_outputs()
2517 : _route->n_outputs();
2519 /* XXX need processor lock on route */
2521 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2522 send->output()->ensure_io (outs, false, this);
2523 } catch (AudioEngine::PortRegistrationFailure& err) {
2524 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2528 /* let the user adjust the IO setup before creation.
2530 Note: this dialog is NOT modal - we just leave it to run and it will
2531 return when its Finished signal is emitted - typically when the window
2535 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2538 /* keep a reference to the send so it doesn't get deleted while
2539 the IOSelectorWindow is doing its stuff
2541 _processor_being_created = send;
2543 ios->selector().Finished.connect (sigc::bind (
2544 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2545 boost::weak_ptr<Processor>(send), ios));
2550 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2552 boost::shared_ptr<Processor> processor (weak_processor.lock());
2554 /* drop our temporary reference to the new send */
2555 _processor_being_created.reset ();
2562 case IOSelector::Cancelled:
2563 // processor will go away when all shared_ptrs to it vanish
2566 case IOSelector::Accepted:
2567 _route->add_processor_by_index (processor, _placement);
2571 delete_when_idle (ios);
2575 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2577 boost::shared_ptr<Processor> processor (weak_processor.lock());
2579 /* drop our temporary reference to the new return */
2580 _processor_being_created.reset ();
2587 case IOSelector::Cancelled:
2588 // processor will go away when all shared_ptrs to it vanish
2591 case IOSelector::Accepted:
2592 _route->add_processor_by_index (processor, _placement);
2596 delete_when_idle (ios);
2600 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2606 boost::shared_ptr<Route> target = wr.lock();
2612 _session->add_internal_send (target, _placement, _route);
2616 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2618 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2619 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2623 redisplay_processors ();
2627 ProcessorBox::redisplay_processors ()
2629 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2632 if (no_processor_redisplay) {
2636 processor_display.clear ();
2638 _visible_prefader_processors = 0;
2641 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2642 &_visible_prefader_processors, &fader_seen));
2644 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2645 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2646 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2648 setup_entry_positions ();
2651 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2652 * not already have one.
2655 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2657 boost::shared_ptr<Processor> p = w.lock ();
2661 if (p->window_proxy()) {
2665 /* not on the list; add it */
2668 #if 0 // is this still needed? Why?
2669 if (_parent_strip) {
2670 if (_parent_strip->mixer_owned()) {
2682 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2683 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2687 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2690 wp->set_state (*ui_xml, 0);
2693 void* existing_ui = p->get_ui ();
2696 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2699 p->set_window_proxy (wp);
2700 WM::Manager::instance().register_window (wp);
2704 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2706 boost::shared_ptr<Processor> p = w.lock ();
2707 if (!p || p->pinmgr_proxy ()) {
2711 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2712 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2713 wp->set_session (_session);
2715 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2717 wp->set_state (*ui_xml, 0);
2720 void* existing_ui = p->get_ui ();
2723 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2726 p->set_pingmgr_proxy (wp);
2727 WM::Manager::instance().register_window (wp);
2730 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2732 boost::shared_ptr<Processor> processor (p.lock ());
2734 if (processor && ( processor->display_to_user()
2736 || show_all_processors
2741 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2742 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2753 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2755 boost::shared_ptr<Processor> processor (p.lock ());
2757 if (!processor || ( !processor->display_to_user()
2759 && !show_all_processors
2766 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2768 ProcessorEntry* e = 0;
2769 if (plugin_insert) {
2770 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2772 e = new ProcessorEntry (this, processor, _width);
2775 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2776 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2777 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2779 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2780 if (!send && !plugin_insert && !ext && !stub)
2781 e->set_selectable(false);
2783 bool mark_send_visible = false;
2784 if (send && _parent_strip) {
2785 /* show controls of new sends by default */
2786 GUIObjectState& st = _parent_strip->gui_object_state ();
2787 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2789 /* check if state exists, if not it must be a new send */
2790 if (!st.get_node(strip, e->state_id())) {
2791 mark_send_visible = true;
2795 /* Set up this entry's state from the GUIObjectState */
2796 XMLNode* proc = entry_gui_object_state (e);
2798 e->set_control_state (proc);
2801 if (mark_send_visible) {
2802 e->show_all_controls ();
2807 && !plugin_insert->plugin(0)->is_channelstrip()
2811 processor_display.add_child (e, drag_targets());
2813 processor_display.add_child (e, drag_targets_noplugin());
2818 ProcessorBox::reordered ()
2820 compute_processor_sort_keys ();
2821 setup_entry_positions ();
2825 ProcessorBox::setup_routing_feeds ()
2827 list<ProcessorEntry*> children = processor_display.children ();
2828 /* first set the i/o maps for every processor */
2829 list<ProcessorEntry*>::iterator prev = children.begin();
2831 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2832 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2833 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2835 list<ProcessorEntry*>::iterator next = i;
2839 ChanCount sinks = pi->natural_input_streams ();
2840 ChanCount sources = pi->natural_output_streams ();
2841 uint32_t count = pi->get_count ();
2843 pi->configured_io (in, out);
2845 ChanCount midi_thru;
2846 ChanCount midi_bypass;
2847 ChanMapping input_map (pi->input_map ());
2848 if (pi->has_midi_thru ()) {
2849 midi_thru.set(DataType::MIDI, 1);
2850 input_map.set (DataType::MIDI, 0, 0);
2852 if (pi->has_midi_bypass ()) {
2853 midi_bypass.set(DataType::MIDI, 1);
2856 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2857 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2859 (*i)->routing_icon.set (
2861 sinks * count + midi_thru,
2862 sources * count + midi_bypass,
2867 if (next != children.end()) {
2868 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2869 pi->output_map (), pi->thru_map ());
2873 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2874 pi->input_map (), pi->thru_map ());
2878 (*i)->input_icon.set_ports (p->input_streams());
2879 (*i)->output_icon.set_ports (p->output_streams());
2880 ChanMapping inmap (p->input_streams ());
2881 ChanMapping outmap (p->input_streams ());
2882 ChanMapping thrumap;
2883 (*i)->routing_icon.set (
2885 p->output_streams(),
2887 p->output_streams(),
2888 inmap, outmap, thrumap);
2890 if (next != children.end()) {
2891 (*next)->routing_icon.set_fed_by (
2892 p->output_streams(),
2893 p->output_streams(),
2897 (*prev)->routing_icon.set_feeding (
2899 p->output_streams(),
2904 if (i == children.begin()) {
2905 (*i)->routing_icon.unset_fed_by ();
2908 (*i)->input_icon.hide();
2911 /* now set which icons need to be displayed */
2912 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2913 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2915 if ((*i)->routing_icon.in_identity ()) {
2916 (*i)->routing_icon.hide();
2917 if (i == children.begin()) {
2918 (*i)->input_icon.show();
2921 (*i)->routing_icon.show();
2922 (*i)->routing_icon.queue_draw();
2923 (*i)->input_icon.show();
2926 list<ProcessorEntry*>::iterator next = i;
2927 if (++next == children.end()) {
2928 // last processor in the chain
2929 (*i)->output_routing_icon.set_terminal(true);
2930 (*i)->output_routing_icon.unset_feeding ();
2931 if ((*i)->routing_icon.out_identity ()) {
2932 (*i)->output_routing_icon.hide();
2934 (*i)->output_routing_icon.show();
2935 (*i)->output_routing_icon.queue_draw();
2938 (*i)->output_routing_icon.set_terminal(false);
2939 if (!(*i)->routing_icon.out_identity ()
2940 && !(*i)->routing_icon.in_identity ()
2941 && (*i)->routing_icon.can_coalesce ()) {
2942 (*i)->output_routing_icon.hide();
2943 } else if (!(*i)->routing_icon.out_identity ()) {
2944 (*i)->output_routing_icon.show();
2945 (*i)->output_routing_icon.queue_draw();
2946 (*next)->input_icon.show();
2948 (*i)->output_routing_icon.hide();
2955 ProcessorBox::setup_entry_positions ()
2957 list<ProcessorEntry*> children = processor_display.children ();
2958 bool pre_fader = true;
2961 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2962 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2963 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2965 (*i)->set_position (ProcessorEntry::Fader, num++);
2968 (*i)->set_position (ProcessorEntry::PreFader, num++);
2970 (*i)->set_position (ProcessorEntry::PostFader, num++);
2974 setup_routing_feeds ();
2978 ProcessorBox::compute_processor_sort_keys ()
2980 list<ProcessorEntry*> children = processor_display.children ();
2981 Route::ProcessorList our_processors;
2983 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2984 if ((*i)->processor()) {
2985 our_processors.push_back ((*i)->processor ());
2989 if (_route->reorder_processors (our_processors)) {
2990 /* Reorder failed, so report this to the user. As far as I can see this must be done
2991 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2992 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2993 when the drag is torn down after this handler function is finished.
2995 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
3000 ProcessorBox::report_failed_reorder ()
3002 /* reorder failed, so redisplay */
3004 redisplay_processors ();
3006 /* now tell them about the problem */
3008 ArdourDialog dialog (_("Plugin Incompatibility"));
3011 label.set_text (_("\
3012 You cannot reorder these plugins/sends/inserts\n\
3013 in that way because the inputs and\n\
3014 outputs will not work correctly."));
3016 dialog.get_vbox()->set_border_width (12);
3017 dialog.get_vbox()->pack_start (label);
3018 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
3020 dialog.set_name (X_("PluginIODialog"));
3021 dialog.set_modal (true);
3028 ProcessorBox::rename_processors ()
3030 ProcSelection to_be_renamed;
3032 get_selected_processors (to_be_renamed);
3034 if (to_be_renamed.empty()) {
3038 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3039 rename_processor (*i);
3044 ProcessorBox::can_cut () const
3046 vector<boost::shared_ptr<Processor> > sel;
3048 get_selected_processors (sel);
3050 /* cut_processors () does not cut inserts */
3052 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3054 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3055 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3056 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3065 ProcessorBox::stub_processor_selected () const
3067 vector<boost::shared_ptr<Processor> > sel;
3069 get_selected_processors (sel);
3071 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3072 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3081 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3083 if (to_be_removed.empty()) {
3087 XMLNode* node = new XMLNode (X_("cut"));
3088 Route::ProcessorList to_cut;
3090 no_processor_redisplay = true;
3091 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3092 // Cut only plugins, sends and returns
3093 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3094 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3095 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3097 Window* w = get_processor_ui (*i);
3103 XMLNode& child ((*i)->get_state());
3104 node->add_child_nocopy (child);
3105 to_cut.push_back (*i);
3109 if (_route->remove_processors (to_cut) != 0) {
3111 no_processor_redisplay = false;
3115 _rr_selection.set (node);
3117 no_processor_redisplay = false;
3118 redisplay_processors ();
3122 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3124 if (to_be_copied.empty()) {
3128 XMLNode* node = new XMLNode (X_("copy"));
3130 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3131 // Copy only plugins, sends, returns
3132 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3133 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3134 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3135 node->add_child_nocopy ((*i)->get_state());
3139 _rr_selection.set (node);
3143 ProcessorBox::delete_processors (const ProcSelection& targets)
3145 if (targets.empty()) {
3149 no_processor_redisplay = true;
3151 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3153 Window* w = get_processor_ui (*i);
3159 _route->remove_processor(*i);
3162 no_processor_redisplay = false;
3163 redisplay_processors ();
3167 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3169 list<boost::shared_ptr<Processor> >::const_iterator x;
3171 no_processor_redisplay = true;
3172 for (x = procs.begin(); x != procs.end(); ++x) {
3174 Window* w = get_processor_ui (*x);
3180 _route->remove_processor(*x);
3183 no_processor_redisplay = false;
3184 redisplay_processors ();
3188 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3190 boost::shared_ptr<Processor> processor (weak_processor.lock());
3196 /* NOT copied to _mixer.selection() */
3198 no_processor_redisplay = true;
3199 _route->remove_processor (processor);
3200 no_processor_redisplay = false;
3201 redisplay_processors ();
3207 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3209 ArdourPrompter name_prompter (true);
3211 name_prompter.set_title (_("Rename Processor"));
3212 name_prompter.set_prompt (_("New name:"));
3213 name_prompter.set_initial_text (processor->name());
3214 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3215 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3216 name_prompter.show_all ();
3218 switch (name_prompter.run ()) {
3220 case Gtk::RESPONSE_ACCEPT:
3221 name_prompter.get_result (result);
3222 if (result.length()) {
3225 string test = result;
3227 while (tries < 100) {
3228 if (_session->io_name_is_legal (test)) {
3234 test = string_compose ("%1-%2", result, tries);
3238 processor->set_name (result);
3241 ARDOUR_UI::instance()->popup_error
3242 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3252 ProcessorBox::paste_processors ()
3254 if (_rr_selection.processors.empty()) {
3258 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3262 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3265 if (_rr_selection.processors.empty()) {
3269 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3273 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3275 XMLNodeConstIterator niter;
3276 list<boost::shared_ptr<Processor> > copies;
3278 if (nlist.empty()) {
3282 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3284 XMLProperty const * type = (*niter)->property ("type");
3285 XMLProperty const * role = (*niter)->property ("role");
3288 boost::shared_ptr<Processor> p;
3290 if (type->value() == "meter" ||
3291 type->value() == "main-outs" ||
3292 type->value() == "amp" ||
3293 type->value() == "intreturn") {
3294 /* do not paste meter, main outs, amp or internal returns */
3297 } else if (type->value() == "intsend") {
3299 /* aux sends are OK, but those used for
3300 * other purposes, are not.
3305 if (role->value() != "Aux") {
3309 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3310 XMLNode n (**niter);
3311 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3312 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3314 IOProcessor::prepare_for_reset (n, s->name());
3316 if (s->set_state (n, Stateful::loading_state_version)) {
3323 } else if (type->value() == "send") {
3325 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3326 XMLNode n (**niter);
3328 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3330 IOProcessor::prepare_for_reset (n, s->name());
3332 if (s->set_state (n, Stateful::loading_state_version)) {
3339 } else if (type->value() == "return") {
3341 XMLNode n (**niter);
3342 Return* r = new Return (*_session);
3344 IOProcessor::prepare_for_reset (n, r->name());
3346 if (r->set_state (n, Stateful::loading_state_version)) {
3353 } else if (type->value() == "port") {
3355 XMLNode n (**niter);
3356 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3358 IOProcessor::prepare_for_reset (n, pi->name());
3360 if (pi->set_state (n, Stateful::loading_state_version)) {
3366 /* XXX its a bit limiting to assume that everything else
3369 p.reset (new PluginInsert (*_session));
3370 /* we can't use RAII Stateful::ForceIDRegeneration
3371 * because that'd void copying the state and wrongly bump
3372 * the state-version counter.
3373 * we need to load the state (incl external files) first and
3374 * only then update the ID)
3376 PBD::ID id = p->id();
3377 /* strip side-chain state (processor inside processor must be a side-chain)
3378 * otherwise we'll end up with duplicate ports-names.
3379 * (this needs a better solution which retains connections)
3380 * We really would want Stateful::ForceIDRegeneration here :(
3382 XMLNode state (**niter);
3383 state.remove_nodes ("Processor");
3385 p->set_state (state, Stateful::current_state_version);
3386 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3389 copies.push_back (p);
3393 error << _("plugin insert constructor failed") << endmsg;
3397 if (copies.empty()) {
3401 if (_route->add_processors (copies, p)) {
3404 "Copying the set of processors on the clipboard failed,\n\
3405 probably because the I/O configuration of the plugins\n\
3406 could not match the configuration of this track.");
3407 MessageDialog am (msg);
3413 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3415 const list<ProcessorEntry*> selection = processor_display.selection ();
3416 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3417 processors.push_back ((*i)->processor ());
3422 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3424 list<ProcessorEntry*> selection = processor_display.selection ();
3425 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3426 (this->*method) ((*i)->processor ());
3431 ProcessorBox::all_visible_processors_active (bool state)
3433 _route->all_visible_processors_active (state);
3437 ProcessorBox::ab_plugins ()
3439 _route->ab_plugins (ab_direction);
3440 ab_direction = !ab_direction;
3445 ProcessorBox::clear_processors ()
3448 vector<string> choices;
3450 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3451 "(this cannot be undone)"), _route->name());
3453 choices.push_back (_("Cancel"));
3454 choices.push_back (_("Yes, remove them all"));
3456 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3458 if (prompter.run () == 1) {
3459 _route->clear_processors (PreFader);
3460 _route->clear_processors (PostFader);
3465 ProcessorBox::clear_processors (Placement p)
3468 vector<string> choices;
3470 if (p == PreFader) {
3471 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3472 "(this cannot be undone)"), _route->name());
3474 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3475 "(this cannot be undone)"), _route->name());
3478 choices.push_back (_("Cancel"));
3479 choices.push_back (_("Yes, remove them all"));
3481 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3483 if (prompter.run () == 1) {
3484 _route->clear_processors (p);
3489 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3491 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3492 if (at && at->freeze_state() == AudioTrack::Frozen) {
3497 boost::dynamic_pointer_cast<Send> (processor) ||
3498 boost::dynamic_pointer_cast<Return> (processor) ||
3499 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3500 boost::dynamic_pointer_cast<PortInsert> (processor)
3509 ProcessorBox::one_processor_can_be_edited ()
3511 list<ProcessorEntry*> selection = processor_display.selection ();
3512 list<ProcessorEntry*>::iterator i = selection.begin();
3513 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3517 return (i != selection.end());
3521 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3523 boost::shared_ptr<Send> send;
3524 boost::shared_ptr<InternalSend> internal_send;
3525 boost::shared_ptr<Return> retrn;
3526 boost::shared_ptr<PluginInsert> plugin_insert;
3527 boost::shared_ptr<PortInsert> port_insert;
3530 /* This method may or may not return a Window, but if it does not it
3531 * will modify the parent mixer strip appearance layout to allow
3532 * "editing" the @param processor that was passed in.
3534 * So for example, if the processor is an Amp (gain), the parent strip
3535 * will be forced back into a model where the fader controls the main gain.
3536 * If the processor is a send, then we map the send controls onto the
3539 * Plugins and others will return a window for control.
3542 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3544 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3549 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3551 if (_parent_strip) {
3552 _parent_strip->revert_to_default_display ();
3555 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3557 if (!_session->engine().connected()) {
3561 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3563 gidget = new SendUIWindow (send, _session);
3566 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3568 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3569 /* no GUI for these */
3573 if (!_session->engine().connected()) {
3577 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3579 ReturnUIWindow *return_ui;
3580 Window* w = get_processor_ui (retrn);
3584 return_ui = new ReturnUIWindow (retrn, _session);
3585 return_ui->set_title (retrn->name ());
3586 set_processor_ui (send, return_ui);
3589 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3594 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3596 PluginUIWindow *plugin_ui;
3598 /* these are both allowed to be null */
3600 Window* w = get_processor_ui (plugin_insert);
3603 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3604 plugin_ui->set_title (generate_processor_title (plugin_insert));
3605 set_processor_ui (plugin_insert, plugin_ui);
3608 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3613 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3615 if (!_session->engine().connected()) {
3616 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3621 PortInsertWindow *io_selector;
3623 Window* w = get_processor_ui (port_insert);
3626 io_selector = new PortInsertWindow (_session, port_insert);
3627 set_processor_ui (port_insert, io_selector);
3630 io_selector = dynamic_cast<PortInsertWindow *> (w);
3633 gidget = io_selector;
3640 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3642 boost::shared_ptr<PluginInsert> plugin_insert
3643 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3645 if (!plugin_insert) {
3649 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3650 win->set_title (generate_processor_title (plugin_insert));
3656 ProcessorBox::register_actions ()
3658 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3660 Glib::RefPtr<Action> act;
3663 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3664 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3666 act = myactions.register_action (processor_box_actions, X_("newlua"), _("New Lua DSP"),
3667 sigc::ptr_fun (ProcessorBox::rb_choose_lua));
3668 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3669 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3670 ActionManager::engine_sensitive_actions.push_back (act);
3671 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3672 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3673 ActionManager::engine_sensitive_actions.push_back (act);
3675 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3677 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3678 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3680 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3681 sigc::ptr_fun (ProcessorBox::rb_clear));
3682 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3683 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3684 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3685 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3687 /* standard editing stuff */
3689 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3690 sigc::ptr_fun (ProcessorBox::rb_cut));
3691 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3692 sigc::ptr_fun (ProcessorBox::rb_copy));
3693 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3694 sigc::ptr_fun (ProcessorBox::rb_delete));
3696 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3697 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3698 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3700 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3701 sigc::ptr_fun (ProcessorBox::rb_paste));
3702 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3703 sigc::ptr_fun (ProcessorBox::rb_rename));
3704 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3705 sigc::ptr_fun (ProcessorBox::rb_select_all));
3706 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3707 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3709 /* activation etc. */
3711 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3712 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3713 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3714 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3715 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3716 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3718 manage_pins_action = myactions.register_action (
3719 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3720 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3723 edit_action = myactions.register_action (
3724 processor_box_actions, X_("edit"), _("Edit..."),
3725 sigc::ptr_fun (ProcessorBox::rb_edit));
3727 edit_generic_action = myactions.register_action (
3728 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3729 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3735 ProcessorBox::rb_edit_generic ()
3737 if (_current_processor_box == 0) {
3741 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3745 ProcessorBox::rb_ab_plugins ()
3747 if (_current_processor_box == 0) {
3751 _current_processor_box->ab_plugins ();
3755 ProcessorBox::rb_manage_pins ()
3757 if (_current_processor_box == 0) {
3761 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3764 ProcessorBox::rb_choose_plugin ()
3766 if (_current_processor_box == 0) {
3769 _current_processor_box->choose_plugin ();
3773 ProcessorBox::rb_choose_lua ()
3775 if (_current_processor_box == 0) {
3778 _current_processor_box->choose_lua ();
3782 ProcessorBox::rb_choose_insert ()
3784 if (_current_processor_box == 0) {
3787 _current_processor_box->choose_insert ();
3791 ProcessorBox::rb_choose_send ()
3793 if (_current_processor_box == 0) {
3796 _current_processor_box->choose_send ();
3800 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3802 if (_current_processor_box == 0) {
3806 _current_processor_box->choose_aux (wr);
3810 ProcessorBox::rb_clear ()
3812 if (_current_processor_box == 0) {
3816 _current_processor_box->clear_processors ();
3821 ProcessorBox::rb_clear_pre ()
3823 if (_current_processor_box == 0) {
3827 _current_processor_box->clear_processors (PreFader);
3832 ProcessorBox::rb_clear_post ()
3834 if (_current_processor_box == 0) {
3838 _current_processor_box->clear_processors (PostFader);
3842 ProcessorBox::rb_cut ()
3844 if (_current_processor_box == 0) {
3848 _current_processor_box->processor_operation (ProcessorsCut);
3852 ProcessorBox::rb_delete ()
3854 if (_current_processor_box == 0) {
3858 _current_processor_box->processor_operation (ProcessorsDelete);
3862 ProcessorBox::rb_copy ()
3864 if (_current_processor_box == 0) {
3867 _current_processor_box->processor_operation (ProcessorsCopy);
3871 ProcessorBox::rb_paste ()
3873 if (_current_processor_box == 0) {
3877 _current_processor_box->processor_operation (ProcessorsPaste);
3881 ProcessorBox::rb_rename ()
3883 if (_current_processor_box == 0) {
3886 _current_processor_box->rename_processors ();
3890 ProcessorBox::rb_select_all ()
3892 if (_current_processor_box == 0) {
3896 _current_processor_box->processor_operation (ProcessorsSelectAll);
3900 ProcessorBox::rb_deselect_all ()
3902 if (_current_processor_box == 0) {
3906 _current_processor_box->deselect_all_processors ();
3910 ProcessorBox::rb_activate_all ()
3912 if (_current_processor_box == 0) {
3916 _current_processor_box->all_visible_processors_active (true);
3920 ProcessorBox::rb_deactivate_all ()
3922 if (_current_processor_box == 0) {
3925 _current_processor_box->all_visible_processors_active (false);
3929 ProcessorBox::rb_edit ()
3931 if (_current_processor_box == 0) {
3935 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3939 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3941 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3945 if (_parent_strip) {
3946 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3947 if (_parent_strip->current_delivery() == send) {
3948 _parent_strip->revert_to_default_display ();
3950 _parent_strip->show_send(send);
3957 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3962 if (edit_aux_send (processor)) {
3966 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3969 proxy->set_custom_ui_mode (true);
3970 proxy->show_the_right_window ();
3975 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3980 if (edit_aux_send (processor)) {
3984 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3987 proxy->set_custom_ui_mode (false);
3988 proxy->show_the_right_window ();
3993 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3998 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
4007 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
4009 if (!what_changed.contains (ARDOUR::Properties::name)) {
4013 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
4015 boost::shared_ptr<Processor> processor;
4016 boost::shared_ptr<PluginInsert> plugin_insert;
4017 boost::shared_ptr<Send> send;
4019 list<ProcessorEntry*> children = processor_display.children();
4021 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
4023 processor = (*iter)->processor ();
4029 Window* w = get_processor_ui (processor);
4035 /* rename editor windows for sends and plugins */
4037 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4038 w->set_title (send->name ());
4039 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4040 w->set_title (generate_processor_title (plugin_insert));
4046 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4048 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4049 string::size_type email_pos;
4051 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4052 maker = maker.substr (0, email_pos - 1);
4055 if (maker.length() > 32) {
4056 maker = maker.substr (0, 32);
4060 SessionObject* owner = pi->owner();
4063 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4065 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4069 /** @param p Processor.
4070 * @return the UI window for \a p.
4073 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4075 ProcessorWindowProxy* wp = p->window_proxy();
4082 /** Make a note of the UI window that a processor is using.
4083 * @param p Processor.
4084 * @param w UI window.
4087 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4089 assert (p->window_proxy());
4091 p->window_proxy()->use_window (*w);
4095 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4097 boost::shared_ptr<Delivery> d = w.lock ();
4102 list<ProcessorEntry*> children = processor_display.children ();
4103 list<ProcessorEntry*>::const_iterator i = children.begin();
4104 while (i != children.end() && (*i)->processor() != d) {
4108 if (i == children.end()) {
4109 processor_display.set_active (0);
4111 processor_display.set_active (*i);
4115 /** Called to repair the damage of Editor::show_window doing a show_all() */
4117 ProcessorBox::hide_things ()
4119 list<ProcessorEntry*> c = processor_display.children ();
4120 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4121 (*i)->hide_things ();
4126 ProcessorBox::processor_menu_unmapped ()
4128 processor_display.remove_placeholder ();
4129 /* make all possibly-desensitized actions sensitive again so that
4130 they be activated by other means (e.g. bindings)
4132 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4136 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4138 if (!_parent_strip) {
4142 GUIObjectState& st = _parent_strip->gui_object_state ();
4144 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4146 return st.get_or_add_node (strip, entry->state_id());
4150 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4152 XMLNode* proc = entry_gui_object_state (entry);
4157 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4158 proc->remove_nodes_and_delete (X_("Object"));
4159 entry->add_control_state (proc);
4163 ProcessorBox::is_editor_mixer_strip() const
4165 return _parent_strip && !_parent_strip->mixer_owned();
4168 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4169 : WM::ProxyBase (name, string())
4170 , _processor_box (box)
4171 , _processor (processor)
4173 , want_custom (false)
4175 boost::shared_ptr<Processor> p = _processor.lock ();
4179 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4182 ProcessorWindowProxy::~ProcessorWindowProxy()
4184 /* processor window proxies do not own the windows they create with
4185 * ::get(), so set _window to null before the normal WindowProxy method
4192 ProcessorWindowProxy::processor_going_away ()
4196 WM::Manager::instance().remove (this);
4197 /* should be no real reason to do this, since the object that would
4198 send DropReferences is about to be deleted, but lets do it anyway.
4200 going_away_connection.disconnect();
4203 ARDOUR::SessionHandlePtr*
4204 ProcessorWindowProxy::session_handle()
4211 ProcessorWindowProxy::get_state ()
4214 node = &ProxyBase::get_state();
4215 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4220 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4222 XMLNodeList children = node.children ();
4223 XMLNodeList::const_iterator i = children.begin ();
4224 while (i != children.end()) {
4225 XMLProperty* prop = (*i)->property (X_("name"));
4226 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4232 if (i != children.end()) {
4234 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4235 want_custom = PBD::string_is_affirmative (prop->value ());
4239 return ProxyBase::set_state (node, 0);
4243 ProcessorWindowProxy::get (bool create)
4245 boost::shared_ptr<Processor> p = _processor.lock ();
4250 if (_window && (is_custom != want_custom)) {
4251 /* drop existing window - wrong type */
4260 is_custom = want_custom;
4261 _window = _processor_box->get_editor_window (p, is_custom);
4267 _window->show_all ();
4272 ProcessorWindowProxy::show_the_right_window ()
4274 if (_window && (is_custom != want_custom)) {
4275 /* drop existing window - wrong type */
4280 is_custom = want_custom;
4287 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4288 : WM::ProxyBase (name, string())
4289 , _processor (processor)
4291 boost::shared_ptr<Processor> p = _processor.lock ();
4295 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4298 PluginPinWindowProxy::~PluginPinWindowProxy()
4303 ARDOUR::SessionHandlePtr*
4304 PluginPinWindowProxy::session_handle ()
4306 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4307 if (aw) { return aw; }
4312 PluginPinWindowProxy::get (bool create)
4314 boost::shared_ptr<Processor> p = _processor.lock ();
4315 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4324 _window = new PluginPinDialog (pi);
4325 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4327 aw->set_session (_session);
4331 _window->show_all ();
4336 PluginPinWindowProxy::processor_going_away ()
4340 WM::Manager::instance().remove (this);
4341 going_away_connection.disconnect();
4345 ProcessorBox::load_bindings ()
4347 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);