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");
387 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
388 _button.set_name ("processor prefader");
392 _button.set_name ("processor fader");
396 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
397 _button.set_name ("processor postfader");
403 boost::shared_ptr<Processor>
404 ProcessorEntry::processor () const
407 return boost::shared_ptr<Processor>();
413 ProcessorEntry::set_enum_width (Width w)
416 _button.set_text (name (_width));
420 ProcessorEntry::led_clicked(GdkEventButton *ev)
422 bool ctrl_shift_pressed = false;
423 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
425 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
426 ctrl_shift_pressed = true;
430 if (_button.get_active ()) {
431 if (ctrl_shift_pressed) {
432 _parent->all_visible_processors_active(false);
434 if (_position == Fader) {
435 _processor->deactivate ();
439 _processor->deactivate ();
443 if (ctrl_shift_pressed) {
444 _parent->all_visible_processors_active(true);
446 if (_position == Fader) {
447 _processor->activate ();
451 _processor->activate ();
458 ProcessorEntry::processor_active_changed ()
461 _button.set_active (_processor->active());
466 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
468 if (what_changed.contains (ARDOUR::Properties::name)) {
469 _button.set_text (name (_width));
475 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
477 _parent->setup_routing_feeds ();
478 input_icon.queue_draw();
479 output_icon.queue_draw();
480 routing_icon.queue_draw();
481 output_routing_icon.queue_draw();
485 ProcessorEntry::setup_tooltip ()
488 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
490 std::string postfix = "";
492 if ((replicated = pi->get_count()) > 1) {
493 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
495 if (pi->plugin()->has_editor()) {
496 ARDOUR_UI_UTILS::set_tooltip (_button,
497 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));
499 ARDOUR_UI_UTILS::set_tooltip (_button,
500 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
504 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
505 ARDOUR_UI::instance()->set_tip (_button,
506 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
510 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
514 ProcessorEntry::name (Width w) const
516 boost::shared_ptr<Send> send;
523 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
524 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
528 /* grab the send name out of its overall name */
530 string::size_type lbracket, rbracket;
531 lbracket = send->name().find ('[');
532 rbracket = send->name().find (']');
536 name_display += send->name().substr (lbracket+1, lbracket-rbracket-1);
539 name_display += PBD::short_version (send->name().substr (lbracket+1, lbracket-rbracket-1), 4);
544 boost::shared_ptr<ARDOUR::PluginInsert> pi;
546 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
547 && (replicated = pi->get_count()) > 1)
549 name_display += string_compose(_("(%1x1) "), replicated);
554 name_display += _processor->display_name();
557 name_display += PBD::short_version (_processor->display_name(), 5);
567 ProcessorEntry::show_all_controls ()
569 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
570 (*i)->set_visible (true);
573 _parent->update_gui_object_state (this);
577 ProcessorEntry::hide_all_controls ()
579 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
580 (*i)->set_visible (false);
583 _parent->update_gui_object_state (this);
587 ProcessorEntry::add_control_state (XMLNode* node) const
589 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
590 (*i)->add_state (node);
593 if (_plugin_display) {
594 XMLNode* c = new XMLNode (X_("Object"));
595 c->add_property (X_("id"), X_("InlineDisplay"));
596 c->add_property (X_("visible"), _plugin_display->is_visible ());
597 node->add_child_nocopy (*c);
602 ProcessorEntry::set_control_state (XMLNode const * node)
604 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
605 (*i)->set_state (node);
608 if (_plugin_display) {
609 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
610 XMLProperty* p = n ? n->property (X_("visible")) : NULL;
612 if (string_is_affirmative (p->value ())) {
613 _plugin_display->show();
615 _plugin_display->hide();
622 ProcessorEntry::state_id () const
624 return string_compose ("processor %1", _processor->id().to_s());
628 ProcessorEntry::hide_things ()
630 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
631 (*i)->hide_things ();
637 ProcessorEntry::build_controls_menu ()
639 using namespace Menu_Helpers;
640 Menu* menu = manage (new Menu);
641 MenuList& items = menu->items ();
643 if (_plugin_display) {
644 items.push_back (CheckMenuElem (_("Inline Display")));
645 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
646 c->set_active (_plugin_display->is_visible ());
647 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
648 items.push_back (SeparatorElem ());
652 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
656 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
659 if (!_controls.empty ()) {
660 items.push_back (SeparatorElem ());
663 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
664 items.push_back (CheckMenuElem ((*i)->name ()));
665 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
666 c->set_active ((*i)->visible ());
667 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
674 ProcessorEntry::toggle_inline_display_visibility ()
676 if (_plugin_display->is_visible ()) {
677 _plugin_display->hide();
679 _plugin_display->show();
681 _parent->update_gui_object_state (this);
685 ProcessorEntry::toggle_control_visibility (Control* c)
687 c->set_visible (!c->visible ());
688 _parent->update_gui_object_state (this);
692 ProcessorEntry::build_send_options_menu ()
694 using namespace Menu_Helpers;
695 Menu* menu = manage (new Menu);
696 MenuList& items = menu->items ();
698 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
701 items.push_back (CheckMenuElem (_("Link panner controls")));
702 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
703 c->set_active (send->panner_shell()->is_linked_to_route());
704 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
711 ProcessorEntry::toggle_panner_link ()
713 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
715 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
719 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
721 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
722 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
723 , _slider_persistant_tooltip (&_slider)
724 , _button (ArdourButton::led_default_elements)
725 , _ignore_ui_adjustment (false)
729 _slider.set_controllable (c);
730 box.set_padding(0, 0, 4, 4);
733 _button.set_text (_name);
734 _button.set_led_left (true);
735 _button.set_name ("processor control button");
739 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
740 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
741 // dup. currently timers are used :(
742 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
746 _slider.set_name ("ProcessorControlSlider");
747 _slider.set_text (_name);
752 const ARDOUR::ParameterDescriptor& desc = c->desc();
753 double const lo = c->internal_to_interface(desc.lower);
754 double const up = c->internal_to_interface(desc.upper);
755 double const normal = c->internal_to_interface(desc.normal);
756 double smallstep = desc.smallstep;
757 double largestep = desc.largestep;
759 if (smallstep == 0.0) {
760 smallstep = up / 1000.;
762 smallstep = c->internal_to_interface(desc.lower + smallstep);
765 if (largestep == 0.0) {
766 largestep = up / 40.;
768 largestep = c->internal_to_interface(desc.lower + largestep);
771 _adjustment.set_lower (lo);
772 _adjustment.set_upper (up);
773 _adjustment.set_step_increment (smallstep);
774 _adjustment.set_page_increment (largestep);
775 _slider.set_default_value (normal);
777 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
778 // dup. currently timers are used :(
779 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
782 // yuck, do we really need to do this?
783 // according to c404374 this is only needed for send automation
784 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
789 /* We're providing our own PersistentTooltip */
790 set_no_tooltip_whatsoever (_slider);
793 ProcessorEntry::Control::~Control ()
795 timer_connection.disconnect ();
799 ProcessorEntry::Control::set_tooltip ()
801 boost::shared_ptr<AutomationControl> c = _control.lock ();
808 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
810 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
813 string sm = Gtkmm2ext::markup_escape_text (tmp);
814 _slider_persistant_tooltip.set_tip (sm);
815 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
819 ProcessorEntry::Control::slider_adjusted ()
821 if (_ignore_ui_adjustment) {
825 boost::shared_ptr<AutomationControl> c = _control.lock ();
831 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
836 ProcessorEntry::Control::button_clicked ()
838 boost::shared_ptr<AutomationControl> c = _control.lock ();
844 bool const n = _button.get_active ();
846 c->set_value (n ? 0 : 1, Controllable::NoGroup);
847 _button.set_active (!n);
852 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
860 ProcessorEntry::Control::control_changed ()
862 boost::shared_ptr<AutomationControl> c = _control.lock ();
867 _ignore_ui_adjustment = true;
871 _button.set_active (c->get_value() > 0.5);
874 // as long as rapid timers are used, only update the tooltip
875 // if the value has changed.
876 const double nval = c->internal_to_interface (c->get_value ());
877 if (_adjustment.get_value() != nval) {
878 _adjustment.set_value (nval);
883 _ignore_ui_adjustment = false;
887 ProcessorEntry::Control::add_state (XMLNode* node) const
889 XMLNode* c = new XMLNode (X_("Object"));
890 c->add_property (X_("id"), state_id ());
891 c->add_property (X_("visible"), _visible);
892 node->add_child_nocopy (*c);
896 ProcessorEntry::Control::set_state (XMLNode const * node)
898 XMLNode* n = GUIObjectState::get_node (node, state_id ());
900 XMLProperty* p = n->property (X_("visible"));
901 set_visible (p && string_is_affirmative (p->value ()));
908 ProcessorEntry::Control::set_visible (bool v)
919 /** Called when the Editor might have re-shown things that
923 ProcessorEntry::Control::hide_things ()
931 ProcessorEntry::Control::state_id () const
933 boost::shared_ptr<AutomationControl> c = _control.lock ();
936 return string_compose (X_("control %1"), c->id().to_s ());
939 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
940 : ProcessorEntry (b, p, w)
943 p->PluginIoReConfigure.connect (
944 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
946 p->PluginMapChanged.connect (
947 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
949 p->PluginConfigChanged.connect (
950 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
955 PluginInsertProcessorEntry::iomap_changed ()
957 _parent->setup_routing_feeds ();
958 routing_icon.queue_draw();
959 output_routing_icon.queue_draw();
963 PluginInsertProcessorEntry::hide_things ()
965 ProcessorEntry::hide_things ();
968 ProcessorEntry::PortIcon::PortIcon(bool input) {
970 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
971 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
975 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
977 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
979 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
982 Gtk::Allocation a = get_allocation();
983 double const width = a.get_width();
984 double const height = a.get_height();
986 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
987 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
989 cairo_rectangle (cr, 0, 0, width, height);
992 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
993 if (_ports.n_total() > 1) {
994 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
995 set_routing_color (cr, i < _ports.n_midi());
996 const float x = rintf(width * (.2f + .6f * i / (_ports.n_total() - 1.f)));
997 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1000 } else if (_ports.n_total() == 1) {
1001 set_routing_color (cr, _ports.n_midi() == 1);
1002 const float x = rintf(width * .5);
1003 cairo_rectangle (cr, x-dx * .5, 0, 1+dx, height);
1011 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1015 set_terminal (false);
1019 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1021 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1023 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1025 set_size_request (-1, h);
1029 ProcessorEntry::RoutingIcon::set (
1030 const ARDOUR::ChanCount& in,
1031 const ARDOUR::ChanCount& out,
1032 const ARDOUR::ChanCount& sinks,
1033 const ARDOUR::ChanCount& sources,
1034 const ARDOUR::ChanMapping& in_map,
1035 const ARDOUR::ChanMapping& out_map,
1036 const ARDOUR::ChanMapping& thru_map)
1044 _thru_map = thru_map;
1048 ProcessorEntry::RoutingIcon::in_identity () const {
1049 if (_thru_map.n_total () > 0) {
1052 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1055 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1062 ProcessorEntry::RoutingIcon::out_identity () const {
1063 if (_thru_map.n_total () > 0) {
1064 // TODO skip if trhu is not connected to any of next's inputs
1067 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1070 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1077 ProcessorEntry::RoutingIcon::can_coalesce () const {
1078 if (_thru_map.n_total () > 0) {
1081 if (_fed_by && _f_out != _f_sources) {
1084 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1091 ProcessorEntry::RoutingIcon::set_fed_by (
1092 const ARDOUR::ChanCount& out,
1093 const ARDOUR::ChanCount& sources,
1094 const ARDOUR::ChanMapping& out_map,
1095 const ARDOUR::ChanMapping& thru_map)
1098 _f_sources = sources;
1099 _f_out_map = out_map;
1100 _f_thru_map = thru_map;
1105 ProcessorEntry::RoutingIcon::set_feeding (
1106 const ARDOUR::ChanCount& in,
1107 const ARDOUR::ChanCount& sinks,
1108 const ARDOUR::ChanMapping& in_map,
1109 const ARDOUR::ChanMapping& thru_map)
1114 _i_thru_map = thru_map;
1119 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1121 if (!midi) { i += n_midi; }
1124 return rint (width * .5) +.5;
1126 return rint (width * (.2 + .6 * i / (n_total - 1))) + .5;
1130 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1132 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1133 const double y1 = rint (height * .66) + .5;
1136 cairo_translate (cr, x0, y0);
1137 cairo_move_to (cr, 0, height);
1138 cairo_line_to (cr, 0, y1);
1139 cairo_move_to (cr, 0 - dx, y1);
1140 cairo_line_to (cr, 0 + dx, y1);
1142 set_routing_color (cr, midi);
1143 cairo_set_line_width (cr, 1.0);
1149 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1151 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1152 const double y1 = rint (height * .5) - .5;
1155 cairo_translate (cr, x0, y0);
1156 cairo_move_to (cr, 0 - dx, height);
1157 cairo_line_to (cr, 0, y1);
1158 cairo_line_to (cr, 0 + dx, height);
1159 cairo_close_path (cr);
1161 set_routing_color (cr, midi);
1167 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1169 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1170 const double y1 = rint (height * .5) + .5;
1173 cairo_translate (cr, x0, y0);
1174 cairo_move_to (cr, 0 - dx - .5, y1);
1175 cairo_line_to (cr, 0 + dx + .5, y1 - 2);
1177 cairo_move_to (cr, 0 - dx - .5, y1 + 2);
1178 cairo_line_to (cr, 0 + dx + .5, y1);
1180 cairo_move_to (cr, 0, y1 + 1);
1181 cairo_line_to (cr, 0, height);
1183 set_routing_color (cr, midi);
1184 cairo_set_line_width (cr, 1.0);
1190 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1192 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1193 const double y1 = rint (height * .5) - .5;
1196 cairo_translate (cr, x0, y0);
1197 cairo_move_to (cr, 0 - dx - .5, y1);
1198 cairo_line_to (cr, 0 + dx + .5, y1 - 2);
1200 cairo_move_to (cr, 0 - dx - .5, y1 + 2);
1201 cairo_line_to (cr, 0 + dx + .5, y1);
1203 cairo_move_to (cr, 0, y1 - 1);
1204 cairo_line_to (cr, 0, 0);
1206 set_routing_color (cr, midi);
1207 cairo_set_line_width (cr, 1.0);
1213 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1215 double bz = abs (y1 - y0);
1217 cairo_move_to (cr, x0, y0);
1218 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1219 cairo_set_line_width (cr, 1.0);
1220 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1221 cairo_set_source_rgb (cr, 1, 0, 0);
1223 const double dashes[] = { 2, 3 };
1224 cairo_set_dash (cr, dashes, 2, 0);
1226 set_routing_color (cr, midi);
1229 cairo_set_dash (cr, 0, 0, 0);
1234 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1236 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1238 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1241 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1243 Gtk::Allocation a = get_allocation();
1244 double const width = a.get_width();
1245 double const height = a.get_height();
1247 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1248 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1250 cairo_rectangle (cr, 0, 0, width, height);
1254 if (can_coalesce ()) {
1255 expose_coalesced_input_map (cr, width, height);
1257 expose_input_map (cr, width, height);
1260 expose_output_map (cr, width, height);
1268 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1270 const uint32_t pc_in = _sinks.n_total();
1271 const uint32_t pc_in_midi = _sinks.n_midi();
1273 for (uint32_t i = 0; i < pc_in; ++i) {
1274 const bool is_midi = i < pc_in_midi;
1276 uint32_t pn = is_midi ? i : i - pc_in_midi;
1277 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1278 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1280 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1281 draw_gnd (cr, x, 0, height, is_midi);
1284 if (idx >= _in.get (dt)) {
1285 // side-chain, probably
1286 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1287 draw_sidechain (cr, x, 0, height, is_midi);
1291 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1295 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1297 double x = pin_x_pos (i, width, pc_in, 0, false);
1299 _f_thru_map.get (dt, idx, &valid_thru);
1301 draw_thru_src (cr, x, 0, height, is_midi);
1303 draw_gnd (cr, x, 0, height, is_midi);
1307 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1309 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1311 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1316 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1318 const uint32_t n_in = _in.n_total();
1319 const uint32_t n_in_midi = _in.n_midi();
1320 const uint32_t pc_in = _sinks.n_total();
1321 const uint32_t pc_in_midi = _sinks.n_midi();
1323 // draw inputs to this
1324 for (uint32_t i = 0; i < pc_in; ++i) {
1325 const bool is_midi = i < pc_in_midi;
1327 uint32_t pn = is_midi ? i : i - pc_in_midi;
1328 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1329 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1330 // check if it's fed
1331 bool valid_src = true;
1332 if (valid_in && idx < _in.get (dt) && _fed_by) {
1335 _f_out_map.get_src (dt, idx, &valid_out);
1336 _f_thru_map.get (dt, idx, &valid_thru);
1337 if (!valid_out && !valid_thru) {
1341 if (!valid_in || !valid_src) {
1342 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1343 draw_gnd (cr, x, 0, height, is_midi);
1346 if (idx >= _in.get (dt)) {
1347 // side-chain, probably
1348 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1349 draw_sidechain (cr, x, 0, height, is_midi);
1352 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1353 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1354 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1357 // draw reverse thru
1358 for (uint32_t i = 0; i < n_in; ++i) {
1359 const bool is_midi = i < n_in_midi;
1361 uint32_t pn = is_midi ? i : i - n_in_midi;
1362 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1363 uint32_t idx = _thru_map.get_src (dt, pn, &valid_thru);
1367 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1368 draw_thru_sink (cr, x, 0, height, is_midi);
1373 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1375 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1376 double ht = _terminal ? height - dh : height;
1378 // draw outputs of this
1379 const uint32_t pc_out = _sources.n_total();
1380 const uint32_t pc_out_midi = _sources.n_midi();
1381 const uint32_t n_out = _out.n_total();
1382 const uint32_t n_out_midi = _out.n_midi();
1384 for (uint32_t i = 0; i < pc_out; ++i) {
1385 const bool is_midi = i < pc_out_midi;
1387 uint32_t pn = is_midi ? i : i - pc_out_midi;
1388 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1389 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1393 // skip connections that are not used in the next's input
1395 bool valid_thru, valid_sink;
1396 _i_in_map.get_src (dt, idx, &valid_sink);
1397 _i_thru_map.get_src (dt, idx, &valid_thru);
1398 if (!valid_thru && !valid_sink) {
1402 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1403 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1404 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1407 for (uint32_t i = 0; i < n_out; ++i) {
1408 const bool is_midi = i < n_out_midi;
1409 uint32_t pn = is_midi ? i : i - n_out_midi;
1410 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1411 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1414 // only check thru (gnd is part of input)
1416 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1421 // skip connections that are not used in the next's input :(
1424 _i_in_map.get_src (dt, pn, &valid_sink);
1425 _i_thru_map.get_src (dt, pn, &valid_thru);
1426 if (!valid_thru && !valid_sink) {
1431 if (idx >= _in.get (dt)) {
1432 draw_sidechain (cr, x, 0, ht, is_midi);
1434 draw_thru_src (cr, x, 0, ht, is_midi);
1438 // terminal node, add arrows
1440 _out_map.get_src (dt, pn, &valid_src);
1443 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1445 if (idx >= _in.get (dt)) {
1446 draw_sidechain (cr, x, 0, height - dh, is_midi);
1448 draw_thru_src (cr, x, 0, height - dh, is_midi);
1451 draw_gnd (cr, x, 0, height - dh, is_midi);
1455 set_routing_color (cr, is_midi);
1456 cairo_set_line_width (cr, 1.0);
1457 cairo_move_to (cr, x, height - dh);
1458 cairo_line_to (cr, x, height - 2);
1461 const double ar = dh - 1;
1462 cairo_move_to (cr, x - ar, height - ar);
1463 cairo_line_to (cr, x , height - .5);
1464 cairo_line_to (cr, x + ar, height - ar);
1465 cairo_line_to (cr, x , height - ar * .5);
1466 cairo_close_path (cr);
1467 cairo_fill_preserve (cr);
1473 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1476 , _max_height (max_height)
1480 set_name ("processor prefader");
1481 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1482 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1485 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1488 cairo_surface_destroy (_surf);
1493 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1496 req->height = _cur_height;
1501 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1503 /* work-around scroll-bar + aspect ratio
1504 * show inline-view -> height changes -> scrollbar gets added
1505 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1506 * -> scroll bar is removed [-> width changes ; repeat ]
1508 uint32_t shm = std::min (_max_height, inline_height);
1510 Gtk::Container* pr = get_parent();
1511 for (uint32_t i = 0; i < 4 && pr; ++i) {
1512 // VBox, EventBox, ViewPort, ScrolledWindow
1513 pr = pr->get_parent();
1515 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1517 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1518 sc = vsb && vsb->is_visible();
1521 if (shm != _cur_height) {
1522 if (_scroll == sc || _cur_height < shm) {
1531 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1533 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1538 /* allocate a local image-surface,
1539 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1540 * since pixman keeps a reference to it.
1541 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1542 * it might be possible to work around via cairo_surface_set_user_data().
1545 || dis->width != cairo_image_surface_get_width (_surf)
1546 || dis->height != cairo_image_surface_get_height (_surf)
1549 cairo_surface_destroy (_surf);
1551 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1554 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1555 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1557 unsigned char *src = dis->data;
1558 unsigned char *dst = cairo_image_surface_get_data (_surf);
1559 const int dst_stride = cairo_image_surface_get_stride (_surf);
1560 for (int y = 0; y < dis->height; ++y) {
1561 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1567 cairo_surface_mark_dirty(_surf);
1568 const double xc = floor ((width - dis->width) * .5);
1569 cairo_set_source_surface(cr, _surf, xc, 0);
1576 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1578 Gtk::Allocation a = get_allocation();
1579 double const width = a.get_width();
1580 double const height = a.get_height();
1582 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1583 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1586 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1587 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1588 cairo_rectangle (cr, 0, 0, width, height);
1592 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1593 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1595 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1597 uint32_t ht = render_inline (cr, width);
1602 if (_cur_height != 1) {
1609 update_height_alloc (ht);
1612 bool failed = false;
1613 std::string name = get_name();
1614 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1616 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1617 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1618 cairo_set_line_width(cr, 1.0);
1619 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1626 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1627 : PluginDisplay (p, max_height)
1629 , _lua_render_inline (0)
1631 p->setup_lua_inline_gui (&lua_gui);
1633 lua_State* LG = lua_gui.getState ();
1634 LuaInstance::bind_cairo (LG);
1635 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1636 assert (lua_render.isFunction ());
1637 _lua_render_inline = new luabridge::LuaRef (lua_render);
1640 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1642 delete (_lua_render_inline);
1646 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1648 Cairo::Context ctx (cr);
1650 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1651 if (rv.isTable ()) {
1655 } catch (luabridge::LuaException const& e) {
1662 static std::list<Gtk::TargetEntry> drop_targets()
1664 std::list<Gtk::TargetEntry> tmp;
1665 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1666 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1667 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // from sidebar
1671 static std::list<Gtk::TargetEntry> drag_targets()
1673 std::list<Gtk::TargetEntry> tmp;
1674 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1675 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1679 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1681 std::list<Gtk::TargetEntry> tmp;
1682 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1686 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1687 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1688 : _parent_strip (parent)
1689 , _owner_is_mixer (owner_is_mixer)
1690 , ab_direction (true)
1691 , _get_plugin_selector (get_plugin_selector)
1693 , _visible_prefader_processors (0)
1694 , _rr_selection(rsel)
1695 , processor_display (drop_targets())
1696 , _redisplay_pending (false)
1700 /* ProcessorBox actions and bindings created statically by call to
1701 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1702 * are available for context menus.
1705 processor_display.set_data ("ardour-bindings", bindings);
1709 no_processor_redisplay = false;
1711 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1712 processor_scroller.add (processor_display);
1713 pack_start (processor_scroller, true, true);
1715 processor_display.set_flags (CAN_FOCUS);
1716 processor_display.set_name ("ProcessorList");
1717 processor_display.set_data ("processorbox", this);
1718 processor_display.set_size_request (48, -1);
1719 processor_display.set_spacing (0);
1721 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1722 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1724 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1725 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1727 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1728 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1729 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1731 processor_scroller.show ();
1732 processor_display.show ();
1735 parent->DeliveryChanged.connect (
1736 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1740 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1743 ProcessorBox::~ProcessorBox ()
1745 /* it may appear as if we should delete processor_menu but that is a
1746 * pointer to a widget owned by the UI Manager, and has potentially
1747 * be returned to many other ProcessorBoxes. GTK doesn't really make
1748 * clear the ownership of this widget, which is a menu and thus is
1749 * never packed into any container other than an implict GtkWindow.
1751 * For now, until or if we ever get clarification over the ownership
1752 * story just let it continue to exist. At worst, its a small memory leak.
1757 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1763 _route_connections.drop_connections();
1765 /* new route: any existing block on processor redisplay must be meaningless */
1766 no_processor_redisplay = false;
1769 _route->processors_changed.connect (
1770 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1773 _route->DropReferences.connect (
1774 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1777 _route->PropertyChanged.connect (
1778 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1781 redisplay_processors ();
1785 ProcessorBox::route_going_away ()
1787 /* don't keep updating display as processors are deleted */
1788 no_processor_redisplay = true;
1792 boost::shared_ptr<Processor>
1793 ProcessorBox::find_drop_position (ProcessorEntry* position)
1795 boost::shared_ptr<Processor> p;
1797 p = position->processor ();
1799 /* dropped on the blank entry (which will be before the
1800 fader), so use the first non-blank child as our
1801 `dropped on' processor */
1802 list<ProcessorEntry*> c = processor_display.children ();
1803 list<ProcessorEntry*>::iterator i = c.begin ();
1805 assert (i != c.end ());
1806 p = (*i)->processor ();
1814 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1816 const void * d = data.get_data();
1817 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1819 PluginPresetList nfos;
1821 tv->get_object_drag_data (nfos, &source);
1823 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1824 PluginPresetPtr ppp = (*i);
1825 PluginInfoPtr pip = ppp->_pip;
1826 PluginPtr p = pip->load (*_session);
1831 if (ppp->_preset.valid) {
1832 p->load_preset (ppp->_preset);
1835 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1836 if (Config->get_new_plugins_active ()) {
1837 processor->activate ();
1839 pl.push_back (processor);
1844 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1846 const void * d = data.get_data();
1847 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1848 PluginInfoList nfos;
1851 tv->get_object_drag_data (nfos, &source);
1853 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1854 PluginPtr p = (*i)->load (*_session);
1858 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1859 if (Config->get_new_plugins_active ()) {
1860 processor->activate ();
1862 pl.push_back (processor);
1867 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1873 boost::shared_ptr<Processor> p = find_drop_position (position);
1874 Route::ProcessorList pl;
1876 if (data.get_target() == "PluginInfoPtr") {
1877 _drop_plugin (data, pl);
1879 else if (data.get_target() == "PluginPresetPtr") {
1880 _drop_plugin_preset (data, pl);
1886 Route::ProcessorStreams err;
1887 if (_route->add_processors (pl, p, &err)) {
1889 "Processor Drag/Drop failed. Probably because\n\
1890 the I/O configuration of the plugins could\n\
1891 not match the configuration of this track.");
1892 MessageDialog am (msg);
1898 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1900 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1901 list<ProcessorEntry*> children = source->selection ();
1902 assert (children.size() == 1);
1903 ProcessorEntry* other = *children.begin();
1904 assert (other->can_copy_state (position));
1905 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1906 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1907 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1908 assert (otherproc && proc && pi);
1910 PBD::ID id = pi->id();
1911 XMLNode& state = otherproc->get_state ();
1912 /* strip side-chain state (processor inside processor must be a side-chain)
1913 * otherwise we'll end up with duplicate ports-names.
1914 * (this needs a better solution which retains connections)
1916 state.remove_nodes ("Processor");
1917 proc->set_state (state, Stateful::loading_state_version);
1918 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1922 boost::shared_ptr<Processor> p = find_drop_position (position);
1924 list<ProcessorEntry*> children = source->selection ();
1925 list<boost::shared_ptr<Processor> > procs;
1926 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1927 if ((*i)->processor ()) {
1928 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1931 procs.push_back ((*i)->processor ());
1935 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1936 XMLNode& state = (*i)->get_state ();
1938 nlist.push_back (&state);
1939 paste_processor_state (nlist, p);
1943 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1947 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1948 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1950 other->delete_dragged_processors (procs);
1956 ProcessorBox::set_width (Width w)
1964 list<ProcessorEntry*> children = processor_display.children ();
1965 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
1966 (*i)->set_enum_width (w);
1973 ProcessorBox::build_possible_aux_menu ()
1975 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
1978 /* No aux sends if there are no busses */
1982 if (_route->is_monitor ()) {
1986 using namespace Menu_Helpers;
1987 Menu* menu = manage (new Menu);
1988 MenuList& items = menu->items();
1990 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
1991 if (!_route->internal_send_for (*r) && *r != _route) {
1992 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2000 ProcessorBox::show_processor_menu (int arg)
2002 if (processor_menu == 0) {
2003 processor_menu = build_processor_menu ();
2004 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2007 /* Sort out the plugin submenu */
2009 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2011 if (plugin_menu_item) {
2012 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2015 /* And the aux submenu */
2017 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2019 if (aux_menu_item) {
2020 Menu* m = build_possible_aux_menu();
2021 if (m && !m->items().empty()) {
2022 aux_menu_item->set_submenu (*m);
2023 aux_menu_item->set_sensitive (true);
2025 /* stupid gtkmm: we need to pass a null reference here */
2026 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2027 aux_menu_item->set_sensitive (false);
2031 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2032 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2034 ProcessorEntry* single_selection = 0;
2035 if (processor_display.selection().size() == 1) {
2036 single_selection = processor_display.selection().front();
2039 /* And the controls submenu */
2041 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2043 if (controls_menu_item) {
2044 if (single_selection) {
2045 Menu* m = single_selection->build_controls_menu ();
2046 if (m && !m->items().empty()) {
2047 controls_menu_item->set_submenu (*m);
2048 controls_menu_item->set_sensitive (true);
2050 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2051 controls_menu_item->set_sensitive (false);
2054 controls_menu_item->set_sensitive (false);
2058 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2059 if (send_menu_item) {
2060 if (single_selection && !_route->is_monitor()) {
2061 Menu* m = single_selection->build_send_options_menu ();
2062 if (m && !m->items().empty()) {
2063 send_menu_item->set_submenu (*m);
2064 send_menu_item->set_sensitive (true);
2066 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2067 send_menu_item->set_sensitive (false);
2070 send_menu_item->set_sensitive (false);
2074 /* Sensitise actions as approprioate */
2077 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2079 paste_action->set_sensitive (!_rr_selection.processors.empty());
2080 cut_action->set_sensitive (sensitive && can_cut ());
2081 copy_action->set_sensitive (sensitive);
2082 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2084 edit_action->set_sensitive (one_processor_can_be_edited ());
2085 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2087 boost::shared_ptr<PluginInsert> pi;
2088 if (single_selection) {
2089 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2092 manage_pins_action->set_sensitive (pi != 0);
2094 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2095 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2097 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2098 rename_action->set_sensitive (single_selection
2100 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2101 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2103 processor_menu->popup (1, arg);
2105 /* Add a placeholder gap to the processor list to indicate where a processor would be
2106 inserted were one chosen from the menu.
2109 processor_display.get_pointer (x, y);
2110 _placement = processor_display.add_placeholder (y);
2112 if (_visible_prefader_processors == 0 && _placement > 0) {
2118 ProcessorBox::enter_notify (GdkEventCrossing*)
2120 processor_display.grab_focus ();
2121 _current_processor_box = this;
2126 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2128 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2132 Widget* top = get_toplevel();
2134 if (top->is_toplevel()) {
2135 Window* win = dynamic_cast<Window*> (top);
2136 gtk_window_set_focus (win->gobj(), 0);
2143 ProcessorBox::processor_operation (ProcessorOperation op)
2145 ProcSelection targets;
2147 get_selected_processors (targets);
2149 /* if (targets.empty()) {
2152 processor_display.get_pointer (x, y);
2154 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2156 if (pointer.first && pointer.first->processor()) {
2157 targets.push_back (pointer.first->processor ());
2162 if ((op == ProcessorsDelete) && targets.empty()) {
2163 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2167 case ProcessorsSelectAll:
2168 processor_display.select_all ();
2171 case ProcessorsSelectNone:
2172 processor_display.select_none ();
2175 case ProcessorsCopy:
2176 copy_processors (targets);
2180 cut_processors (targets);
2183 case ProcessorsPaste:
2184 // some processors are not selectable (e.g fader, meter), target is empty.
2185 if (targets.empty() && _placement >= 0) {
2187 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2189 targets.push_back (proc);
2192 if (targets.empty()) {
2193 paste_processors ();
2195 paste_processors (targets.front());
2199 case ProcessorsDelete:
2200 delete_processors (targets);
2203 case ProcessorsToggleActive:
2204 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2205 if ((*i)->active()) {
2206 (*i)->deactivate ();
2224 ProcessorWindowProxy*
2225 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2227 return processor->window_proxy();
2232 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2234 boost::shared_ptr<Processor> processor;
2236 processor = child->processor ();
2240 bool selected = processor_display.selected (child);
2242 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2244 if (_session->engine().connected()) {
2245 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2247 if (!one_processor_can_be_edited ()) {
2251 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2252 generic_edit_processor (processor);
2254 edit_processor (processor);
2260 } else if (Keyboard::is_context_menu_event (ev)) {
2262 show_processor_menu (ev->time);
2266 } else if (processor && ev->button == 1 && selected) {
2268 // this is purely informational but necessary for route params UI
2269 ProcessorSelected (processor); // emit
2271 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2274 _get_plugin_selector()->show_manager ();
2281 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2283 boost::shared_ptr<Processor> processor;
2285 processor = child->processor ();
2288 if (processor && Keyboard::is_delete_event (ev)) {
2290 Glib::signal_idle().connect (sigc::bind (
2291 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2292 boost::weak_ptr<Processor>(processor)));
2294 } else if (processor && Keyboard::is_button2_event (ev)
2296 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2300 /* button2-click with no/appropriate modifiers */
2302 if (processor->active()) {
2303 processor->deactivate ();
2305 processor->activate ();
2313 ProcessorBox::build_processor_menu ()
2315 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2316 processor_menu->set_name ("ArdourContextMenu");
2317 return processor_menu;
2321 ProcessorBox::select_all_processors ()
2323 processor_display.select_all ();
2327 ProcessorBox::deselect_all_processors ()
2329 processor_display.select_none ();
2333 ProcessorBox::choose_plugin ()
2335 _get_plugin_selector()->set_interested_object (*this);
2338 /** @return true if an error occurred, otherwise false */
2340 ProcessorBox::choose_lua ()
2342 LuaScriptInfoPtr spi;
2344 ScriptSelector ss (_("Add Lua DSP Processor"), LuaScriptInfo::DSP);
2345 switch (ss.run ()) {
2346 case Gtk::RESPONSE_ACCEPT:
2356 LuaPluginInfoPtr lpi (new LuaPluginInfo(spi));
2357 p = (lpi->load (*_session));
2360 "Failed to instantiate Lua DSP Processor,\n"
2361 "probably because the script is invalid (no dsp function).");
2362 MessageDialog am (msg);
2367 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
2369 Route::ProcessorStreams err_streams;
2370 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2372 "Failed to add Lua DSP Processor at the given position,\n"
2373 "probably because the I/O configuration of the plugins\n"
2374 "could not match the configuration of this track.");
2375 MessageDialog am (msg);
2381 /** @return true if an error occurred, otherwise false */
2383 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2385 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2387 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2389 Route::ProcessorStreams err_streams;
2391 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2392 weird_plugin_dialog (**p, err_streams);
2394 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2395 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2396 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2398 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2399 if ((*p)->has_editor ()) {
2400 edit_processor (processor);
2402 generic_edit_processor (processor);
2412 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2414 ArdourDialog dialog (_("Plugin Incompatibility"));
2417 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2418 p.name(), streams.index);
2420 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2421 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2423 text += _("\nThis plugin has:\n");
2425 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2426 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2429 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2430 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2433 text += _("\nbut at the insertion point, there are:\n");
2435 uint32_t const n = streams.count.n_midi ();
2436 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2439 uint32_t const n = streams.count.n_audio ();
2440 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2443 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2444 label.set_text(text);
2446 dialog.get_vbox()->pack_start (label);
2447 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2449 dialog.set_name (X_("PluginIODialog"));
2450 dialog.set_modal (true);
2457 ProcessorBox::choose_insert ()
2459 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2460 _route->add_processor_by_index (processor, _placement);
2463 /* Caller must not hold process lock */
2465 ProcessorBox::choose_send ()
2467 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
2468 boost::shared_ptr<Send> send (new Send (*_session, sendpan, _route->mute_master()));
2470 /* make an educated guess at the initial number of outputs for the send */
2471 ChanCount outs = (_session->master_out())
2472 ? _session->master_out()->n_outputs()
2473 : _route->n_outputs();
2475 /* XXX need processor lock on route */
2477 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2478 send->output()->ensure_io (outs, false, this);
2479 } catch (AudioEngine::PortRegistrationFailure& err) {
2480 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2484 /* let the user adjust the IO setup before creation.
2486 Note: this dialog is NOT modal - we just leave it to run and it will
2487 return when its Finished signal is emitted - typically when the window
2491 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2494 /* keep a reference to the send so it doesn't get deleted while
2495 the IOSelectorWindow is doing its stuff
2497 _processor_being_created = send;
2499 ios->selector().Finished.connect (sigc::bind (
2500 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2501 boost::weak_ptr<Processor>(send), ios));
2506 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2508 boost::shared_ptr<Processor> processor (weak_processor.lock());
2510 /* drop our temporary reference to the new send */
2511 _processor_being_created.reset ();
2518 case IOSelector::Cancelled:
2519 // processor will go away when all shared_ptrs to it vanish
2522 case IOSelector::Accepted:
2523 _route->add_processor_by_index (processor, _placement);
2527 delete_when_idle (ios);
2531 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2533 boost::shared_ptr<Processor> processor (weak_processor.lock());
2535 /* drop our temporary reference to the new return */
2536 _processor_being_created.reset ();
2543 case IOSelector::Cancelled:
2544 // processor will go away when all shared_ptrs to it vanish
2547 case IOSelector::Accepted:
2548 _route->add_processor_by_index (processor, _placement);
2552 delete_when_idle (ios);
2556 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2562 boost::shared_ptr<Route> target = wr.lock();
2568 _session->add_internal_send (target, _placement, _route);
2572 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2574 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2575 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2579 redisplay_processors ();
2583 ProcessorBox::redisplay_processors ()
2585 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2588 if (no_processor_redisplay) {
2592 processor_display.clear ();
2594 _visible_prefader_processors = 0;
2597 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2598 &_visible_prefader_processors, &fader_seen));
2600 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2601 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2602 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2604 setup_entry_positions ();
2607 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2608 * not already have one.
2611 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2613 boost::shared_ptr<Processor> p = w.lock ();
2617 if (p->window_proxy()) {
2621 /* not on the list; add it */
2624 #if 0 // is this still needed? Why?
2625 if (_parent_strip) {
2626 if (_parent_strip->mixer_owned()) {
2638 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2639 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2643 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2646 wp->set_state (*ui_xml, 0);
2649 void* existing_ui = p->get_ui ();
2652 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2655 p->set_window_proxy (wp);
2656 WM::Manager::instance().register_window (wp);
2660 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2662 boost::shared_ptr<Processor> p = w.lock ();
2663 if (!p || p->pinmgr_proxy ()) {
2667 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2668 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2669 wp->set_session (_session);
2671 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2673 wp->set_state (*ui_xml, 0);
2676 void* existing_ui = p->get_ui ();
2679 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2682 p->set_pingmgr_proxy (wp);
2683 WM::Manager::instance().register_window (wp);
2686 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2688 boost::shared_ptr<Processor> processor (p.lock ());
2690 if (processor && ( processor->display_to_user()
2692 || show_all_processors
2697 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2698 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2709 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2711 boost::shared_ptr<Processor> processor (p.lock ());
2713 if (!processor || ( !processor->display_to_user()
2715 && !show_all_processors
2722 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2724 ProcessorEntry* e = 0;
2725 if (plugin_insert) {
2726 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2728 e = new ProcessorEntry (this, processor, _width);
2731 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2732 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2733 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2735 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2736 if (!send && !plugin_insert && !ext && !stub)
2737 e->set_selectable(false);
2739 bool mark_send_visible = false;
2740 if (send && _parent_strip) {
2741 /* show controls of new sends by default */
2742 GUIObjectState& st = _parent_strip->gui_object_state ();
2743 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2745 /* check if state exists, if not it must be a new send */
2746 if (!st.get_node(strip, e->state_id())) {
2747 mark_send_visible = true;
2751 /* Set up this entry's state from the GUIObjectState */
2752 XMLNode* proc = entry_gui_object_state (e);
2754 e->set_control_state (proc);
2757 if (mark_send_visible) {
2758 e->show_all_controls ();
2763 && !plugin_insert->plugin(0)->is_channelstrip()
2767 processor_display.add_child (e, drag_targets());
2769 processor_display.add_child (e, drag_targets_noplugin());
2774 ProcessorBox::reordered ()
2776 compute_processor_sort_keys ();
2777 setup_entry_positions ();
2781 ProcessorBox::setup_routing_feeds ()
2783 list<ProcessorEntry*> children = processor_display.children ();
2784 /* first set the i/o maps for every processor */
2785 list<ProcessorEntry*>::iterator prev = children.begin();
2787 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2788 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2789 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2791 list<ProcessorEntry*>::iterator next = i;
2795 ChanCount sinks = pi->natural_input_streams ();
2796 ChanCount sources = pi->natural_output_streams ();
2797 uint32_t count = pi->get_count ();
2799 pi->configured_io (in, out);
2801 ChanCount midi_thru;
2802 ChanCount midi_bypass;
2803 ChanMapping input_map (pi->input_map ());
2804 if (pi->has_midi_thru ()) {
2805 midi_thru.set(DataType::MIDI, 1);
2806 input_map.set (DataType::MIDI, 0, 0);
2808 if (pi->has_midi_bypass ()) {
2809 midi_bypass.set(DataType::MIDI, 1);
2812 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2813 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2815 (*i)->routing_icon.set (
2817 sinks * count + midi_thru,
2818 sources * count + midi_bypass,
2823 if (next != children.end()) {
2824 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2825 pi->output_map (), pi->thru_map ());
2829 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2830 pi->input_map (), pi->thru_map ());
2834 (*i)->input_icon.set_ports (p->input_streams());
2835 (*i)->output_icon.set_ports (p->output_streams());
2836 ChanMapping inmap (p->input_streams ());
2837 ChanMapping outmap (p->input_streams ());
2838 ChanMapping thrumap;
2839 (*i)->routing_icon.set (
2841 p->output_streams(),
2843 p->output_streams(),
2844 inmap, outmap, thrumap);
2846 if (next != children.end()) {
2847 (*next)->routing_icon.set_fed_by (
2848 p->output_streams(),
2849 p->output_streams(),
2853 (*prev)->routing_icon.set_feeding (
2855 p->output_streams(),
2860 if (i == children.begin()) {
2861 (*i)->routing_icon.unset_fed_by ();
2866 /* now set which icons need to be displayed */
2867 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2868 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2870 if ((*i)->routing_icon.in_identity ()) {
2871 (*i)->routing_icon.hide();
2872 if (i == children.begin()) {
2873 (*i)->input_icon.show();
2875 (*i)->input_icon.hide();
2878 (*i)->routing_icon.show();
2879 (*i)->routing_icon.queue_draw();
2880 (*i)->input_icon.show();
2883 list<ProcessorEntry*>::iterator next = i;
2884 if (++next == children.end()) {
2885 // last processor in the chain
2886 (*i)->output_routing_icon.set_terminal(true);
2887 (*i)->output_routing_icon.unset_feeding ();
2888 if ((*i)->routing_icon.out_identity ()) {
2889 (*i)->output_routing_icon.hide();
2891 (*i)->output_routing_icon.show();
2892 (*i)->output_routing_icon.queue_draw();
2895 (*i)->output_routing_icon.set_terminal(false);
2896 if (!(*i)->routing_icon.out_identity () && (*i)->routing_icon.can_coalesce ()){
2897 (*i)->output_routing_icon.hide();
2898 } else if (!(*i)->routing_icon.out_identity ()) {
2899 (*i)->output_routing_icon.show();
2900 (*i)->output_routing_icon.queue_draw();
2902 (*i)->output_routing_icon.hide();
2909 ProcessorBox::setup_entry_positions ()
2911 list<ProcessorEntry*> children = processor_display.children ();
2912 bool pre_fader = true;
2915 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2916 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2917 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2919 (*i)->set_position (ProcessorEntry::Fader, num++);
2922 (*i)->set_position (ProcessorEntry::PreFader, num++);
2924 (*i)->set_position (ProcessorEntry::PostFader, num++);
2928 setup_routing_feeds ();
2932 ProcessorBox::compute_processor_sort_keys ()
2934 list<ProcessorEntry*> children = processor_display.children ();
2935 Route::ProcessorList our_processors;
2937 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2938 if ((*i)->processor()) {
2939 our_processors.push_back ((*i)->processor ());
2943 if (_route->reorder_processors (our_processors)) {
2944 /* Reorder failed, so report this to the user. As far as I can see this must be done
2945 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2946 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2947 when the drag is torn down after this handler function is finished.
2949 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2954 ProcessorBox::report_failed_reorder ()
2956 /* reorder failed, so redisplay */
2958 redisplay_processors ();
2960 /* now tell them about the problem */
2962 ArdourDialog dialog (_("Plugin Incompatibility"));
2965 label.set_text (_("\
2966 You cannot reorder these plugins/sends/inserts\n\
2967 in that way because the inputs and\n\
2968 outputs will not work correctly."));
2970 dialog.get_vbox()->set_border_width (12);
2971 dialog.get_vbox()->pack_start (label);
2972 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2974 dialog.set_name (X_("PluginIODialog"));
2975 dialog.set_modal (true);
2982 ProcessorBox::rename_processors ()
2984 ProcSelection to_be_renamed;
2986 get_selected_processors (to_be_renamed);
2988 if (to_be_renamed.empty()) {
2992 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2993 rename_processor (*i);
2998 ProcessorBox::can_cut () const
3000 vector<boost::shared_ptr<Processor> > sel;
3002 get_selected_processors (sel);
3004 /* cut_processors () does not cut inserts */
3006 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3008 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3009 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3010 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3019 ProcessorBox::stub_processor_selected () const
3021 vector<boost::shared_ptr<Processor> > sel;
3023 get_selected_processors (sel);
3025 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3026 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3035 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3037 if (to_be_removed.empty()) {
3041 XMLNode* node = new XMLNode (X_("cut"));
3042 Route::ProcessorList to_cut;
3044 no_processor_redisplay = true;
3045 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3046 // Cut only plugins, sends and returns
3047 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3048 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3049 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3051 Window* w = get_processor_ui (*i);
3057 XMLNode& child ((*i)->get_state());
3058 node->add_child_nocopy (child);
3059 to_cut.push_back (*i);
3063 if (_route->remove_processors (to_cut) != 0) {
3065 no_processor_redisplay = false;
3069 _rr_selection.set (node);
3071 no_processor_redisplay = false;
3072 redisplay_processors ();
3076 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3078 if (to_be_copied.empty()) {
3082 XMLNode* node = new XMLNode (X_("copy"));
3084 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3085 // Copy only plugins, sends, returns
3086 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3087 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3088 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3089 node->add_child_nocopy ((*i)->get_state());
3093 _rr_selection.set (node);
3097 ProcessorBox::delete_processors (const ProcSelection& targets)
3099 if (targets.empty()) {
3103 no_processor_redisplay = true;
3105 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3107 Window* w = get_processor_ui (*i);
3113 _route->remove_processor(*i);
3116 no_processor_redisplay = false;
3117 redisplay_processors ();
3121 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3123 list<boost::shared_ptr<Processor> >::const_iterator x;
3125 no_processor_redisplay = true;
3126 for (x = procs.begin(); x != procs.end(); ++x) {
3128 Window* w = get_processor_ui (*x);
3134 _route->remove_processor(*x);
3137 no_processor_redisplay = false;
3138 redisplay_processors ();
3142 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3144 boost::shared_ptr<Processor> processor (weak_processor.lock());
3150 /* NOT copied to _mixer.selection() */
3152 no_processor_redisplay = true;
3153 _route->remove_processor (processor);
3154 no_processor_redisplay = false;
3155 redisplay_processors ();
3161 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3163 ArdourPrompter name_prompter (true);
3165 name_prompter.set_title (_("Rename Processor"));
3166 name_prompter.set_prompt (_("New name:"));
3167 name_prompter.set_initial_text (processor->name());
3168 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3169 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3170 name_prompter.show_all ();
3172 switch (name_prompter.run ()) {
3174 case Gtk::RESPONSE_ACCEPT:
3175 name_prompter.get_result (result);
3176 if (result.length()) {
3179 string test = result;
3181 while (tries < 100) {
3182 if (_session->io_name_is_legal (test)) {
3188 test = string_compose ("%1-%2", result, tries);
3192 processor->set_name (result);
3195 ARDOUR_UI::instance()->popup_error
3196 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3206 ProcessorBox::paste_processors ()
3208 if (_rr_selection.processors.empty()) {
3212 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3216 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3219 if (_rr_selection.processors.empty()) {
3223 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3227 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3229 XMLNodeConstIterator niter;
3230 list<boost::shared_ptr<Processor> > copies;
3232 if (nlist.empty()) {
3236 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3238 XMLProperty const * type = (*niter)->property ("type");
3239 XMLProperty const * role = (*niter)->property ("role");
3242 boost::shared_ptr<Processor> p;
3244 if (type->value() == "meter" ||
3245 type->value() == "main-outs" ||
3246 type->value() == "amp" ||
3247 type->value() == "intreturn") {
3248 /* do not paste meter, main outs, amp or internal returns */
3251 } else if (type->value() == "intsend") {
3253 /* aux sends are OK, but those used for
3254 * other purposes, are not.
3259 if (role->value() != "Aux") {
3263 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3264 XMLNode n (**niter);
3265 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3266 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3268 IOProcessor::prepare_for_reset (n, s->name());
3270 if (s->set_state (n, Stateful::loading_state_version)) {
3277 } else if (type->value() == "send") {
3279 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3280 XMLNode n (**niter);
3282 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3284 IOProcessor::prepare_for_reset (n, s->name());
3286 if (s->set_state (n, Stateful::loading_state_version)) {
3293 } else if (type->value() == "return") {
3295 XMLNode n (**niter);
3296 Return* r = new Return (*_session);
3298 IOProcessor::prepare_for_reset (n, r->name());
3300 if (r->set_state (n, Stateful::loading_state_version)) {
3307 } else if (type->value() == "port") {
3309 XMLNode n (**niter);
3310 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3312 IOProcessor::prepare_for_reset (n, pi->name());
3314 if (pi->set_state (n, Stateful::loading_state_version)) {
3320 /* XXX its a bit limiting to assume that everything else
3323 p.reset (new PluginInsert (*_session));
3324 /* we can't use RAII Stateful::ForceIDRegeneration
3325 * because that'd void copying the state and wrongly bump
3326 * the state-version counter.
3327 * we need to load the state (incl external files) first and
3328 * only then update the ID)
3330 PBD::ID id = p->id();
3331 /* strip side-chain state (processor inside processor must be a side-chain)
3332 * otherwise we'll end up with duplicate ports-names.
3333 * (this needs a better solution which retains connections)
3334 * We really would want Stateful::ForceIDRegeneration here :(
3336 XMLNode state (**niter);
3337 state.remove_nodes ("Processor");
3339 p->set_state (state, Stateful::current_state_version);
3340 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3343 copies.push_back (p);
3347 error << _("plugin insert constructor failed") << endmsg;
3351 if (copies.empty()) {
3355 if (_route->add_processors (copies, p)) {
3358 "Copying the set of processors on the clipboard failed,\n\
3359 probably because the I/O configuration of the plugins\n\
3360 could not match the configuration of this track.");
3361 MessageDialog am (msg);
3367 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3369 const list<ProcessorEntry*> selection = processor_display.selection ();
3370 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3371 processors.push_back ((*i)->processor ());
3376 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3378 list<ProcessorEntry*> selection = processor_display.selection ();
3379 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3380 (this->*method) ((*i)->processor ());
3385 ProcessorBox::all_visible_processors_active (bool state)
3387 _route->all_visible_processors_active (state);
3391 ProcessorBox::ab_plugins ()
3393 _route->ab_plugins (ab_direction);
3394 ab_direction = !ab_direction;
3399 ProcessorBox::clear_processors ()
3402 vector<string> choices;
3404 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3405 "(this cannot be undone)"), _route->name());
3407 choices.push_back (_("Cancel"));
3408 choices.push_back (_("Yes, remove them all"));
3410 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3412 if (prompter.run () == 1) {
3413 _route->clear_processors (PreFader);
3414 _route->clear_processors (PostFader);
3419 ProcessorBox::clear_processors (Placement p)
3422 vector<string> choices;
3424 if (p == PreFader) {
3425 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3426 "(this cannot be undone)"), _route->name());
3428 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3429 "(this cannot be undone)"), _route->name());
3432 choices.push_back (_("Cancel"));
3433 choices.push_back (_("Yes, remove them all"));
3435 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3437 if (prompter.run () == 1) {
3438 _route->clear_processors (p);
3443 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3445 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3446 if (at && at->freeze_state() == AudioTrack::Frozen) {
3451 boost::dynamic_pointer_cast<Send> (processor) ||
3452 boost::dynamic_pointer_cast<Return> (processor) ||
3453 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3454 boost::dynamic_pointer_cast<PortInsert> (processor)
3463 ProcessorBox::one_processor_can_be_edited ()
3465 list<ProcessorEntry*> selection = processor_display.selection ();
3466 list<ProcessorEntry*>::iterator i = selection.begin();
3467 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3471 return (i != selection.end());
3475 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3477 boost::shared_ptr<Send> send;
3478 boost::shared_ptr<InternalSend> internal_send;
3479 boost::shared_ptr<Return> retrn;
3480 boost::shared_ptr<PluginInsert> plugin_insert;
3481 boost::shared_ptr<PortInsert> port_insert;
3484 /* This method may or may not return a Window, but if it does not it
3485 * will modify the parent mixer strip appearance layout to allow
3486 * "editing" the @param processor that was passed in.
3488 * So for example, if the processor is an Amp (gain), the parent strip
3489 * will be forced back into a model where the fader controls the main gain.
3490 * If the processor is a send, then we map the send controls onto the
3493 * Plugins and others will return a window for control.
3496 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3498 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3503 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3505 if (_parent_strip) {
3506 _parent_strip->revert_to_default_display ();
3509 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3511 if (!_session->engine().connected()) {
3515 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3517 gidget = new SendUIWindow (send, _session);
3520 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3522 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3523 /* no GUI for these */
3527 if (!_session->engine().connected()) {
3531 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3533 ReturnUIWindow *return_ui;
3534 Window* w = get_processor_ui (retrn);
3538 return_ui = new ReturnUIWindow (retrn, _session);
3539 return_ui->set_title (retrn->name ());
3540 set_processor_ui (send, return_ui);
3543 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3548 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3550 PluginUIWindow *plugin_ui;
3552 /* these are both allowed to be null */
3554 Window* w = get_processor_ui (plugin_insert);
3557 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3558 plugin_ui->set_title (generate_processor_title (plugin_insert));
3559 set_processor_ui (plugin_insert, plugin_ui);
3562 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3567 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3569 if (!_session->engine().connected()) {
3570 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3575 PortInsertWindow *io_selector;
3577 Window* w = get_processor_ui (port_insert);
3580 io_selector = new PortInsertWindow (_session, port_insert);
3581 set_processor_ui (port_insert, io_selector);
3584 io_selector = dynamic_cast<PortInsertWindow *> (w);
3587 gidget = io_selector;
3594 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3596 boost::shared_ptr<PluginInsert> plugin_insert
3597 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3599 if (!plugin_insert) {
3603 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3604 win->set_title (generate_processor_title (plugin_insert));
3610 ProcessorBox::register_actions ()
3612 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3614 Glib::RefPtr<Action> act;
3617 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3618 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3620 act = myactions.register_action (processor_box_actions, X_("newlua"), _("New Lua DSP"),
3621 sigc::ptr_fun (ProcessorBox::rb_choose_lua));
3622 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3623 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3624 ActionManager::engine_sensitive_actions.push_back (act);
3625 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3626 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3627 ActionManager::engine_sensitive_actions.push_back (act);
3629 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3631 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3632 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3634 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3635 sigc::ptr_fun (ProcessorBox::rb_clear));
3636 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3637 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3638 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3639 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3641 /* standard editing stuff */
3643 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3644 sigc::ptr_fun (ProcessorBox::rb_cut));
3645 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3646 sigc::ptr_fun (ProcessorBox::rb_copy));
3647 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3648 sigc::ptr_fun (ProcessorBox::rb_delete));
3650 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3651 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3652 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3654 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3655 sigc::ptr_fun (ProcessorBox::rb_paste));
3656 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3657 sigc::ptr_fun (ProcessorBox::rb_rename));
3658 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3659 sigc::ptr_fun (ProcessorBox::rb_select_all));
3660 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3661 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3663 /* activation etc. */
3665 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3666 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3667 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3668 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3669 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3670 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3672 manage_pins_action = myactions.register_action (
3673 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3674 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3677 edit_action = myactions.register_action (
3678 processor_box_actions, X_("edit"), _("Edit..."),
3679 sigc::ptr_fun (ProcessorBox::rb_edit));
3681 edit_generic_action = myactions.register_action (
3682 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3683 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3689 ProcessorBox::rb_edit_generic ()
3691 if (_current_processor_box == 0) {
3695 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3699 ProcessorBox::rb_ab_plugins ()
3701 if (_current_processor_box == 0) {
3705 _current_processor_box->ab_plugins ();
3709 ProcessorBox::rb_manage_pins ()
3711 if (_current_processor_box == 0) {
3715 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3718 ProcessorBox::rb_choose_plugin ()
3720 if (_current_processor_box == 0) {
3723 _current_processor_box->choose_plugin ();
3727 ProcessorBox::rb_choose_lua ()
3729 if (_current_processor_box == 0) {
3732 _current_processor_box->choose_lua ();
3736 ProcessorBox::rb_choose_insert ()
3738 if (_current_processor_box == 0) {
3741 _current_processor_box->choose_insert ();
3745 ProcessorBox::rb_choose_send ()
3747 if (_current_processor_box == 0) {
3750 _current_processor_box->choose_send ();
3754 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3756 if (_current_processor_box == 0) {
3760 _current_processor_box->choose_aux (wr);
3764 ProcessorBox::rb_clear ()
3766 if (_current_processor_box == 0) {
3770 _current_processor_box->clear_processors ();
3775 ProcessorBox::rb_clear_pre ()
3777 if (_current_processor_box == 0) {
3781 _current_processor_box->clear_processors (PreFader);
3786 ProcessorBox::rb_clear_post ()
3788 if (_current_processor_box == 0) {
3792 _current_processor_box->clear_processors (PostFader);
3796 ProcessorBox::rb_cut ()
3798 if (_current_processor_box == 0) {
3802 _current_processor_box->processor_operation (ProcessorsCut);
3806 ProcessorBox::rb_delete ()
3808 if (_current_processor_box == 0) {
3812 _current_processor_box->processor_operation (ProcessorsDelete);
3816 ProcessorBox::rb_copy ()
3818 if (_current_processor_box == 0) {
3821 _current_processor_box->processor_operation (ProcessorsCopy);
3825 ProcessorBox::rb_paste ()
3827 if (_current_processor_box == 0) {
3831 _current_processor_box->processor_operation (ProcessorsPaste);
3835 ProcessorBox::rb_rename ()
3837 if (_current_processor_box == 0) {
3840 _current_processor_box->rename_processors ();
3844 ProcessorBox::rb_select_all ()
3846 if (_current_processor_box == 0) {
3850 _current_processor_box->processor_operation (ProcessorsSelectAll);
3854 ProcessorBox::rb_deselect_all ()
3856 if (_current_processor_box == 0) {
3860 _current_processor_box->deselect_all_processors ();
3864 ProcessorBox::rb_activate_all ()
3866 if (_current_processor_box == 0) {
3870 _current_processor_box->all_visible_processors_active (true);
3874 ProcessorBox::rb_deactivate_all ()
3876 if (_current_processor_box == 0) {
3879 _current_processor_box->all_visible_processors_active (false);
3883 ProcessorBox::rb_edit ()
3885 if (_current_processor_box == 0) {
3889 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3893 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3895 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3899 if (_parent_strip) {
3900 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3901 if (_parent_strip->current_delivery() == send) {
3902 _parent_strip->revert_to_default_display ();
3904 _parent_strip->show_send(send);
3911 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3916 if (edit_aux_send (processor)) {
3920 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3923 proxy->set_custom_ui_mode (true);
3924 proxy->show_the_right_window ();
3929 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3934 if (edit_aux_send (processor)) {
3938 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3941 proxy->set_custom_ui_mode (false);
3942 proxy->show_the_right_window ();
3947 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3952 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3961 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3963 if (!what_changed.contains (ARDOUR::Properties::name)) {
3967 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3969 boost::shared_ptr<Processor> processor;
3970 boost::shared_ptr<PluginInsert> plugin_insert;
3971 boost::shared_ptr<Send> send;
3973 list<ProcessorEntry*> children = processor_display.children();
3975 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3977 processor = (*iter)->processor ();
3983 Window* w = get_processor_ui (processor);
3989 /* rename editor windows for sends and plugins */
3991 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3992 w->set_title (send->name ());
3993 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3994 w->set_title (generate_processor_title (plugin_insert));
4000 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4002 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4003 string::size_type email_pos;
4005 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4006 maker = maker.substr (0, email_pos - 1);
4009 if (maker.length() > 32) {
4010 maker = maker.substr (0, 32);
4014 SessionObject* owner = pi->owner();
4017 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4019 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4023 /** @param p Processor.
4024 * @return the UI window for \a p.
4027 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4029 ProcessorWindowProxy* wp = p->window_proxy();
4036 /** Make a note of the UI window that a processor is using.
4037 * @param p Processor.
4038 * @param w UI window.
4041 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4043 assert (p->window_proxy());
4045 p->window_proxy()->use_window (*w);
4049 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4051 boost::shared_ptr<Delivery> d = w.lock ();
4056 list<ProcessorEntry*> children = processor_display.children ();
4057 list<ProcessorEntry*>::const_iterator i = children.begin();
4058 while (i != children.end() && (*i)->processor() != d) {
4062 if (i == children.end()) {
4063 processor_display.set_active (0);
4065 processor_display.set_active (*i);
4069 /** Called to repair the damage of Editor::show_window doing a show_all() */
4071 ProcessorBox::hide_things ()
4073 list<ProcessorEntry*> c = processor_display.children ();
4074 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4075 (*i)->hide_things ();
4080 ProcessorBox::processor_menu_unmapped ()
4082 processor_display.remove_placeholder ();
4083 /* make all possibly-desensitized actions sensitive again so that
4084 they be activated by other means (e.g. bindings)
4086 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4090 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4092 if (!_parent_strip) {
4096 GUIObjectState& st = _parent_strip->gui_object_state ();
4098 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4100 return st.get_or_add_node (strip, entry->state_id());
4104 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4106 XMLNode* proc = entry_gui_object_state (entry);
4111 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4112 proc->remove_nodes_and_delete (X_("Object"));
4113 entry->add_control_state (proc);
4117 ProcessorBox::is_editor_mixer_strip() const
4119 return _parent_strip && !_parent_strip->mixer_owned();
4122 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4123 : WM::ProxyBase (name, string())
4124 , _processor_box (box)
4125 , _processor (processor)
4127 , want_custom (false)
4129 boost::shared_ptr<Processor> p = _processor.lock ();
4133 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4136 ProcessorWindowProxy::~ProcessorWindowProxy()
4138 /* processor window proxies do not own the windows they create with
4139 * ::get(), so set _window to null before the normal WindowProxy method
4146 ProcessorWindowProxy::processor_going_away ()
4150 WM::Manager::instance().remove (this);
4151 /* should be no real reason to do this, since the object that would
4152 send DropReferences is about to be deleted, but lets do it anyway.
4154 going_away_connection.disconnect();
4157 ARDOUR::SessionHandlePtr*
4158 ProcessorWindowProxy::session_handle()
4165 ProcessorWindowProxy::get_state ()
4168 node = &ProxyBase::get_state();
4169 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4174 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4176 XMLNodeList children = node.children ();
4177 XMLNodeList::const_iterator i = children.begin ();
4178 while (i != children.end()) {
4179 XMLProperty* prop = (*i)->property (X_("name"));
4180 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4186 if (i != children.end()) {
4188 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4189 want_custom = PBD::string_is_affirmative (prop->value ());
4193 return ProxyBase::set_state (node, 0);
4197 ProcessorWindowProxy::get (bool create)
4199 boost::shared_ptr<Processor> p = _processor.lock ();
4204 if (_window && (is_custom != want_custom)) {
4205 /* drop existing window - wrong type */
4214 is_custom = want_custom;
4215 _window = _processor_box->get_editor_window (p, is_custom);
4221 _window->show_all ();
4226 ProcessorWindowProxy::show_the_right_window ()
4228 if (_window && (is_custom != want_custom)) {
4229 /* drop existing window - wrong type */
4234 is_custom = want_custom;
4241 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4242 : WM::ProxyBase (name, string())
4243 , _processor (processor)
4245 boost::shared_ptr<Processor> p = _processor.lock ();
4249 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4252 PluginPinWindowProxy::~PluginPinWindowProxy()
4257 ARDOUR::SessionHandlePtr*
4258 PluginPinWindowProxy::session_handle ()
4260 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4261 if (aw) { return aw; }
4266 PluginPinWindowProxy::get (bool create)
4268 boost::shared_ptr<Processor> p = _processor.lock ();
4269 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4278 _window = new PluginPinDialog (pi);
4279 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4281 aw->set_session (_session);
4285 _window->show_all ();
4290 PluginPinWindowProxy::processor_going_away ()
4294 WM::Manager::instance().remove (this);
4295 going_away_connection.disconnect();
4299 ProcessorBox::load_bindings ()
4301 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);