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::backspace_action;
113 RefPtr<Action> ProcessorBox::manage_pins_action;
114 RefPtr<Action> ProcessorBox::edit_action;
115 RefPtr<Action> ProcessorBox::edit_generic_action;
116 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
117 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
118 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
121 // TODO consolidate with PluginPinDialog::set_color
122 static void set_routing_color (cairo_t* cr, bool midi)
124 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
125 static const uint32_t midi_port_color = 0x960909FF; //Red
128 cairo_set_source_rgb (cr,
129 UINT_RGBA_R_FLT(midi_port_color),
130 UINT_RGBA_G_FLT(midi_port_color),
131 UINT_RGBA_B_FLT(midi_port_color));
133 cairo_set_source_rgb (cr,
134 UINT_RGBA_R_FLT(audio_port_color),
135 UINT_RGBA_G_FLT(audio_port_color),
136 UINT_RGBA_B_FLT(audio_port_color));
140 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
141 : _button (ArdourButton::led_default_elements)
142 , _position (PreFader)
146 , _unknown_processor(false)
152 , output_routing_icon(false)
157 _button.set_distinct_led_click (true);
158 _button.set_fallthrough_to_parent(true);
159 _button.set_led_left (true);
160 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
161 _button.set_text (name (_width));
163 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
164 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
166 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
167 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
168 _unknown_processor = true;
171 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
172 if (pi && pi->plugin()) {
173 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
178 _vbox.pack_start (routing_icon);
179 _vbox.pack_start (input_icon);
180 _vbox.pack_start (_button, true, true);
182 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
183 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
184 if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
185 _plugin_display = new PluginDisplay (*this, pi->plugin(),
186 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
188 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
189 _plugin_display = new LuaPluginDisplay (*this, boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
190 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
192 _vbox.pack_start (*_plugin_display);
193 _plugin_display->set_no_show_all (true);
194 if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
195 _plugin_display->show ();
198 _vbox.pack_end (output_routing_icon);
199 _vbox.pack_end (output_icon);
201 _button.set_active (_processor->enabled ());
203 input_icon.set_no_show_all(true);
204 routing_icon.set_no_show_all(true);
205 output_icon.set_no_show_all(true);
206 output_routing_icon.set_no_show_all(true);
212 output_routing_icon.hide();
214 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
215 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
216 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
218 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
219 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
221 std::string label = _processor->describe_parameter (*i);
223 if (boost::dynamic_pointer_cast<Send> (_processor)) {
225 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
229 Control* c = new Control (_processor->automation_control (*i), label);
231 _controls.push_back (c);
233 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
234 /* Add non-Amp (Fader & Trim) controls to the processor box */
235 _vbox.pack_start (c->box);
242 _vbox.set_size_request (-1, _button.size_request().height);
246 ProcessorEntry::~ProcessorEntry ()
248 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
251 delete _plugin_display;
255 ProcessorEntry::action_widget ()
261 ProcessorEntry::widget ()
267 ProcessorEntry::drag_text () const
273 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
275 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
279 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
280 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
281 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
282 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
285 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
288 if (!my_pi || !ot_pi) {
291 if (my_pi->type() != ot_pi->type()) {
294 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
295 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
296 if (!my_p || !ot_p) {
299 if (my_p->unique_id() != ot_p->unique_id()) {
306 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
308 if (data.get_target() == "PluginPresetPtr") {
309 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
311 if (!_plugin_preset_pointer || !pi) {
312 data.set (data.get_target(), 8, NULL, 0);
316 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
319 PluginManager& manager (PluginManager::instance());
320 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
322 NewPluginPresetDialog d (plugin,
323 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
325 _plugin_preset_pointer->_preset.valid = false;
328 case Gtk::RESPONSE_CANCEL:
329 data.set (data.get_target(), 8, NULL, 0);
333 case Gtk::RESPONSE_NO:
336 case Gtk::RESPONSE_ACCEPT:
337 if (d.name().empty()) {
342 plugin->remove_preset (d.name ());
345 Plugin::PresetRecord const r = plugin->save_preset (d.name());
347 if (!r.uri.empty ()) {
348 _plugin_preset_pointer->_preset.uri = r.uri;
349 _plugin_preset_pointer->_preset.label = r.label;
350 _plugin_preset_pointer->_preset.user = r.user;
351 _plugin_preset_pointer->_preset.valid = r.valid;
354 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
361 ProcessorEntry::set_position (Position p, uint32_t num)
369 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
372 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
374 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
379 ProcessorEntry::setup_visuals ()
381 if (_unknown_processor) {
382 _button.set_name ("processor stub");
385 boost::shared_ptr<Send> send;
386 if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
387 if (send->remove_on_disconnect ()) {
388 _button.set_name ("processor sidechain");
393 boost::shared_ptr<InternalSend> aux;
394 if ((aux = boost::dynamic_pointer_cast<InternalSend> (_processor))) {
395 if (aux->allow_feedback ()) {
396 _button.set_name ("processor auxfeedback");
403 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
404 _button.set_name ("processor prefader");
408 _button.set_name ("processor fader");
412 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
413 _button.set_name ("processor postfader");
419 boost::shared_ptr<Processor>
420 ProcessorEntry::processor () const
423 return boost::shared_ptr<Processor>();
429 ProcessorEntry::set_enum_width (Width w)
432 _button.set_text (name (_width));
436 ProcessorEntry::led_clicked(GdkEventButton *ev)
438 bool ctrl_shift_pressed = false;
439 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
441 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
442 ctrl_shift_pressed = true;
446 if (_button.get_active ()) {
447 if (ctrl_shift_pressed) {
448 _parent->all_visible_processors_active(false);
450 if (_position == Fader) {
451 _processor->enable (false);
455 _processor->enable (false);
459 if (ctrl_shift_pressed) {
460 _parent->all_visible_processors_active(true);
462 if (_position == Fader) {
463 _processor->enable (true);
467 _processor->enable (true);
474 ProcessorEntry::processor_active_changed ()
477 _button.set_active (_processor->enabled ());
482 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
484 if (what_changed.contains (ARDOUR::Properties::name)) {
485 _button.set_text (name (_width));
491 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
493 _parent->setup_routing_feeds ();
494 input_icon.queue_draw();
495 output_icon.queue_draw();
496 routing_icon.queue_draw();
497 output_routing_icon.queue_draw();
501 ProcessorEntry::setup_tooltip ()
504 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
506 std::string postfix = "";
508 if ((replicated = pi->get_count()) > 1) {
509 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
511 if (pi->plugin()->has_editor()) {
512 ARDOUR_UI_UTILS::set_tooltip (_button,
513 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));
515 ARDOUR_UI_UTILS::set_tooltip (_button,
516 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
520 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
521 ARDOUR_UI::instance()->set_tip (_button,
522 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
525 boost::shared_ptr<Send> send;
526 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
527 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
528 if (send->remove_on_disconnect ()) {
529 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
531 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>", _processor->name()));
536 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
540 ProcessorEntry::name (Width w) const
542 boost::shared_ptr<Send> send;
549 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
550 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
553 std::string send_name;
554 bool pretty_ok = true;
556 if (send->remove_on_disconnect ()) {
557 // assume it's a sidechain, find pretty name of connected port(s)
558 PortSet& ps (send->output ()->ports ());
559 for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
560 vector<string> connections;
561 if (i->get_connections (connections)) {
562 vector<string>::const_iterator ci;
563 for (ci = connections.begin(); ci != connections.end(); ++ci) {
564 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
568 if (send_name.empty ()) {
570 } else if (send_name != pn) {
571 // pretty names don't match
584 /* grab the send name out of its overall name */
585 if (send_name.empty()) {
586 send_name = send->name();
587 string::size_type lbracket, rbracket;
588 lbracket = send_name.find ('[');
589 rbracket = send_name.find (']');
590 send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
595 name_display += send_name;
598 name_display += PBD::short_version (send_name, 5);
603 boost::shared_ptr<ARDOUR::PluginInsert> pi;
605 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
606 && (replicated = pi->get_count()) > 1)
608 name_display += string_compose(_("(%1x1) "), replicated);
613 name_display += _processor->display_name();
616 name_display += PBD::short_version (_processor->display_name(), 5);
626 ProcessorEntry::show_all_controls ()
628 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
629 (*i)->set_visible (true);
632 _parent->update_gui_object_state (this);
636 ProcessorEntry::hide_all_controls ()
638 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
639 (*i)->set_visible (false);
642 _parent->update_gui_object_state (this);
646 ProcessorEntry::add_control_state (XMLNode* node) const
648 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
649 (*i)->add_state (node);
652 if (_plugin_display) {
653 XMLNode* c = new XMLNode (X_("Object"));
654 c->add_property (X_("id"), X_("InlineDisplay"));
655 c->add_property (X_("visible"), _plugin_display->is_visible ());
656 node->add_child_nocopy (*c);
661 ProcessorEntry::set_control_state (XMLNode const * node)
663 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
664 (*i)->set_state (node);
667 if (_plugin_display) {
668 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
669 XMLProperty const * p = n ? n->property (X_("visible")) : NULL;
671 if (string_is_affirmative (p->value ())) {
672 _plugin_display->show();
674 _plugin_display->hide();
681 ProcessorEntry::state_id () const
683 return string_compose ("processor %1", _processor->id().to_s());
687 ProcessorEntry::hide_things ()
689 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
690 (*i)->hide_things ();
696 ProcessorEntry::build_controls_menu ()
698 using namespace Menu_Helpers;
699 Menu* menu = manage (new Menu);
700 MenuList& items = menu->items ();
702 if (_plugin_display) {
703 items.push_back (CheckMenuElem (_("Inline Display")));
704 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
705 c->set_active (_plugin_display->is_visible ());
706 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
707 items.push_back (SeparatorElem ());
711 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
715 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
718 if (!_controls.empty ()) {
719 items.push_back (SeparatorElem ());
722 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
723 items.push_back (CheckMenuElem ((*i)->name ()));
724 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
725 c->set_active ((*i)->visible ());
726 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
733 ProcessorEntry::toggle_inline_display_visibility ()
735 if (_plugin_display->is_visible ()) {
736 _plugin_display->hide();
738 _plugin_display->show();
740 _parent->update_gui_object_state (this);
744 ProcessorEntry::toggle_control_visibility (Control* c)
746 c->set_visible (!c->visible ());
747 _parent->update_gui_object_state (this);
751 ProcessorEntry::build_send_options_menu ()
753 using namespace Menu_Helpers;
754 Menu* menu = manage (new Menu);
755 MenuList& items = menu->items ();
757 if (!ARDOUR::Profile->get_mixbus()) {
758 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
760 items.push_back (CheckMenuElem (_("Link panner controls")));
761 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
762 c->set_active (send->panner_shell()->is_linked_to_route());
763 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
767 boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
769 items.push_back (CheckMenuElem (_("Allow Feedback Loop")));
770 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
771 c->set_active (aux->allow_feedback());
772 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_allow_feedback));
778 ProcessorEntry::toggle_panner_link ()
780 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
782 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
787 ProcessorEntry::toggle_allow_feedback ()
789 boost::shared_ptr<InternalSend> aux = boost::dynamic_pointer_cast<InternalSend> (_processor);
791 aux->set_allow_feedback (!aux->allow_feedback ());
795 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
797 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
798 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
799 , _slider_persistant_tooltip (&_slider)
800 , _button (ArdourButton::led_default_elements)
801 , _ignore_ui_adjustment (false)
805 _slider.set_controllable (c);
806 box.set_padding(0, 0, 4, 4);
809 _button.set_text (_name);
810 _button.set_led_left (true);
811 _button.set_name ("processor control button");
815 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
816 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
817 // dup. currently timers are used :(
818 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
822 _slider.set_name ("ProcessorControlSlider");
823 _slider.set_text (_name);
828 const ARDOUR::ParameterDescriptor& desc = c->desc();
829 double const lo = c->internal_to_interface(desc.lower);
830 double const up = c->internal_to_interface(desc.upper);
831 double const normal = c->internal_to_interface(desc.normal);
832 double smallstep = desc.smallstep;
833 double largestep = desc.largestep;
835 if (smallstep == 0.0) {
836 smallstep = up / 1000.;
838 smallstep = c->internal_to_interface(desc.lower + smallstep);
841 if (largestep == 0.0) {
842 largestep = up / 40.;
844 largestep = c->internal_to_interface(desc.lower + largestep);
847 _adjustment.set_lower (lo);
848 _adjustment.set_upper (up);
849 _adjustment.set_step_increment (smallstep);
850 _adjustment.set_page_increment (largestep);
851 _slider.set_default_value (normal);
853 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
854 // dup. currently timers are used :(
855 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
858 // yuck, do we really need to do this?
859 // according to c404374 this is only needed for send automation
860 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
865 /* We're providing our own PersistentTooltip */
866 set_no_tooltip_whatsoever (_slider);
869 ProcessorEntry::Control::~Control ()
871 timer_connection.disconnect ();
875 ProcessorEntry::Control::set_tooltip ()
877 boost::shared_ptr<AutomationControl> c = _control.lock ();
884 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
886 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
889 string sm = Gtkmm2ext::markup_escape_text (tmp);
890 _slider_persistant_tooltip.set_tip (sm);
891 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
895 ProcessorEntry::Control::slider_adjusted ()
897 if (_ignore_ui_adjustment) {
901 boost::shared_ptr<AutomationControl> c = _control.lock ();
907 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
912 ProcessorEntry::Control::button_clicked ()
914 boost::shared_ptr<AutomationControl> c = _control.lock ();
920 bool const n = _button.get_active ();
922 c->set_value (n ? 0 : 1, Controllable::NoGroup);
923 _button.set_active (!n);
928 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
936 ProcessorEntry::Control::control_changed ()
938 boost::shared_ptr<AutomationControl> c = _control.lock ();
943 _ignore_ui_adjustment = true;
947 _button.set_active (c->get_value() > 0.5);
950 // as long as rapid timers are used, only update the tooltip
951 // if the value has changed.
952 const double nval = c->internal_to_interface (c->get_value ());
953 if (_adjustment.get_value() != nval) {
954 _adjustment.set_value (nval);
959 _ignore_ui_adjustment = false;
963 ProcessorEntry::Control::add_state (XMLNode* node) const
965 XMLNode* c = new XMLNode (X_("Object"));
966 c->add_property (X_("id"), state_id ());
967 c->add_property (X_("visible"), _visible);
968 node->add_child_nocopy (*c);
972 ProcessorEntry::Control::set_state (XMLNode const * node)
974 XMLNode* n = GUIObjectState::get_node (node, state_id ());
976 XMLProperty const * p = n->property (X_("visible"));
977 set_visible (p && string_is_affirmative (p->value ()));
984 ProcessorEntry::Control::set_visible (bool v)
995 /** Called when the Editor might have re-shown things that
999 ProcessorEntry::Control::hide_things ()
1007 ProcessorEntry::Control::state_id () const
1009 boost::shared_ptr<AutomationControl> c = _control.lock ();
1012 return string_compose (X_("control %1"), c->id().to_s ());
1015 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
1016 : ProcessorEntry (b, p, w)
1017 , _plugin_insert (p)
1019 p->PluginIoReConfigure.connect (
1020 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1022 p->PluginMapChanged.connect (
1023 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1025 p->PluginConfigChanged.connect (
1026 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1031 PluginInsertProcessorEntry::iomap_changed ()
1033 _parent->setup_routing_feeds ();
1034 routing_icon.queue_draw();
1035 output_routing_icon.queue_draw();
1039 PluginInsertProcessorEntry::hide_things ()
1041 ProcessorEntry::hide_things ();
1044 ProcessorEntry::PortIcon::PortIcon(bool input) {
1046 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1047 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1051 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1053 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1055 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1058 Gtk::Allocation a = get_allocation();
1059 double const width = a.get_width();
1060 double const height = a.get_height();
1062 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1063 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1065 cairo_rectangle (cr, 0, 0, width, height);
1068 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1069 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1070 set_routing_color (cr, i < _ports.n_midi());
1071 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1072 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1080 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1084 set_terminal (false);
1088 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1090 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1092 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1094 set_size_request (-1, h);
1098 ProcessorEntry::RoutingIcon::set (
1099 const ARDOUR::ChanCount& in,
1100 const ARDOUR::ChanCount& out,
1101 const ARDOUR::ChanCount& sinks,
1102 const ARDOUR::ChanCount& sources,
1103 const ARDOUR::ChanMapping& in_map,
1104 const ARDOUR::ChanMapping& out_map,
1105 const ARDOUR::ChanMapping& thru_map)
1113 _thru_map = thru_map;
1117 ProcessorEntry::RoutingIcon::in_identity () const {
1118 if (_thru_map.n_total () > 0) {
1121 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1124 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1131 ProcessorEntry::RoutingIcon::out_identity () const {
1132 if (_thru_map.n_total () > 0) {
1133 // TODO skip if trhu is not connected to any of next's inputs
1136 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1139 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1146 ProcessorEntry::RoutingIcon::can_coalesce () const {
1147 if (_thru_map.n_total () > 0) {
1150 if (_fed_by && _f_out != _f_sources) {
1153 if (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1156 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1163 ProcessorEntry::RoutingIcon::set_fed_by (
1164 const ARDOUR::ChanCount& out,
1165 const ARDOUR::ChanCount& sources,
1166 const ARDOUR::ChanMapping& out_map,
1167 const ARDOUR::ChanMapping& thru_map)
1170 _f_sources = sources;
1171 _f_out_map = out_map;
1172 _f_thru_map = thru_map;
1177 ProcessorEntry::RoutingIcon::set_feeding (
1178 const ARDOUR::ChanCount& in,
1179 const ARDOUR::ChanCount& sinks,
1180 const ARDOUR::ChanMapping& in_map,
1181 const ARDOUR::ChanMapping& thru_map)
1186 _i_thru_map = thru_map;
1191 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1193 if (!midi) { i += n_midi; }
1196 return rint (width * .5) +.5;
1198 return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1202 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1204 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1205 const double y1 = rint (height * .66) + .5;
1208 cairo_translate (cr, x0, y0);
1209 cairo_move_to (cr, 0, height);
1210 cairo_line_to (cr, 0, y1);
1211 cairo_move_to (cr, 0 - dx, y1);
1212 cairo_line_to (cr, 0 + dx, y1);
1214 set_routing_color (cr, midi);
1215 cairo_set_line_width (cr, 1.0);
1221 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1223 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1224 const double y1 = rint (height * .5) - .5;
1227 cairo_translate (cr, x0, y0);
1228 cairo_move_to (cr, 0 - dx, height);
1229 cairo_line_to (cr, 0, y1);
1230 cairo_line_to (cr, 0 + dx, height);
1231 cairo_close_path (cr);
1233 set_routing_color (cr, midi);
1239 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1241 const double rad = 1;
1242 const double y1 = height - rad - 1.5;
1244 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1245 cairo_move_to (cr, x0, y0 + height - 1.5);
1246 cairo_line_to (cr, x0, y0 + height);
1247 set_routing_color (cr, midi);
1248 cairo_set_line_width (cr, 1.0);
1253 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1255 const double rad = 1;
1256 const double y1 = rad + 1;
1258 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1259 cairo_move_to (cr, x0, y0);
1260 cairo_line_to (cr, x0, y0 + 1);
1261 set_routing_color (cr, midi);
1262 cairo_set_line_width (cr, 1.0);
1267 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1269 double bz = abs (y1 - y0);
1271 cairo_move_to (cr, x0, y0);
1272 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1273 cairo_set_line_width (cr, 1.0);
1274 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1275 cairo_set_source_rgb (cr, 1, 0, 0);
1277 const double dashes[] = { 2, 3 };
1278 cairo_set_dash (cr, dashes, 2, 0);
1280 set_routing_color (cr, midi);
1283 cairo_set_dash (cr, 0, 0, 0);
1288 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1290 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1292 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1295 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1297 Gtk::Allocation a = get_allocation();
1298 double const width = a.get_width();
1299 double const height = a.get_height();
1301 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1302 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1304 cairo_rectangle (cr, 0, 0, width, height);
1308 if (can_coalesce ()) {
1309 expose_coalesced_input_map (cr, width, height);
1311 expose_input_map (cr, width, height);
1314 expose_output_map (cr, width, height);
1322 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1324 const uint32_t pc_in = _sinks.n_total();
1325 const uint32_t pc_in_midi = _sinks.n_midi();
1327 for (uint32_t i = 0; i < pc_in; ++i) {
1328 const bool is_midi = i < pc_in_midi;
1330 uint32_t pn = is_midi ? i : i - pc_in_midi;
1331 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1332 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1334 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1335 draw_gnd (cr, x, 0, height, is_midi);
1338 if (idx >= _in.get (dt)) {
1339 // side-chain, probably
1340 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1341 draw_sidechain (cr, x, 0, height, is_midi);
1345 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1349 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1351 double x = pin_x_pos (i, width, pc_in, 0, false);
1353 _f_thru_map.get (dt, idx, &valid_thru);
1355 draw_thru_src (cr, x, 0, height, is_midi);
1357 draw_gnd (cr, x, 0, height, is_midi);
1361 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1363 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1365 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1370 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1372 const uint32_t n_in = _in.n_total();
1373 const uint32_t n_in_midi = _in.n_midi();
1374 const uint32_t pc_in = _sinks.n_total();
1375 const uint32_t pc_in_midi = _sinks.n_midi();
1377 // draw inputs to this
1378 for (uint32_t i = 0; i < pc_in; ++i) {
1379 const bool is_midi = i < pc_in_midi;
1381 uint32_t pn = is_midi ? i : i - pc_in_midi;
1382 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1383 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1384 // check if it's fed
1385 bool valid_src = true;
1386 if (valid_in && idx < _in.get (dt) && _fed_by) {
1389 _f_out_map.get_src (dt, idx, &valid_out);
1390 _f_thru_map.get (dt, idx, &valid_thru);
1391 if (!valid_out && !valid_thru) {
1395 if (!valid_in || !valid_src) {
1396 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1397 draw_gnd (cr, x, 0, height, is_midi);
1400 if (idx >= _in.get (dt)) {
1401 // side-chain, probably
1402 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1403 draw_sidechain (cr, x, 0, height, is_midi);
1406 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1407 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1408 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1411 // draw reverse thru
1412 for (uint32_t i = 0; i < n_in; ++i) {
1413 const bool is_midi = i < n_in_midi;
1415 uint32_t pn = is_midi ? i : i - n_in_midi;
1416 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1417 _thru_map.get_src (dt, pn, &valid_thru);
1421 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1422 draw_thru_sink (cr, x, 0, height, is_midi);
1427 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1429 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1430 double ht = _terminal ? height - dh : height;
1432 // draw outputs of this
1433 const uint32_t pc_out = _sources.n_total();
1434 const uint32_t pc_out_midi = _sources.n_midi();
1435 const uint32_t n_out = _out.n_total();
1436 const uint32_t n_out_midi = _out.n_midi();
1438 for (uint32_t i = 0; i < pc_out; ++i) {
1439 const bool is_midi = i < pc_out_midi;
1441 uint32_t pn = is_midi ? i : i - pc_out_midi;
1442 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1443 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1447 // skip connections that are not used in the next's input
1449 bool valid_thru, valid_sink;
1450 _i_in_map.get_src (dt, idx, &valid_sink);
1451 _i_thru_map.get_src (dt, idx, &valid_thru);
1452 if (!valid_thru && !valid_sink) {
1453 if (!is_midi || i != 0) { // special case midi-bypass
1458 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1459 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1460 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1463 for (uint32_t i = 0; i < n_out; ++i) {
1464 const bool is_midi = i < n_out_midi;
1465 uint32_t pn = is_midi ? i : i - n_out_midi;
1466 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1467 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1470 bool valid_thru_f = false;
1471 // skip connections that are not used in the next's input
1474 _i_in_map.get_src (dt, pn, &valid_sink);
1475 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1476 if (!valid_thru_f && !valid_sink) {
1477 if (!is_midi || i != 0) { // special case midi-bypass
1484 _out_map.get_src (dt, pn, &valid_src);
1487 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1489 if (idx >= _in.get (dt)) {
1490 draw_sidechain (cr, x, 0, height, is_midi);
1492 draw_thru_src (cr, x, 0, height, is_midi);
1494 } else if (valid_thru_f){
1495 // gnd is part of input, unless it's a thru input
1496 // (also only true if !coalesced into one small display)
1497 draw_gnd (cr, x, 0, height, is_midi);
1501 // terminal node, add arrows
1503 _out_map.get_src (dt, pn, &valid_src);
1506 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1508 if (idx >= _in.get (dt)) {
1509 draw_sidechain (cr, x, 0, height - dh, is_midi);
1511 draw_thru_src (cr, x, 0, height - dh, is_midi);
1514 draw_gnd (cr, x, 0, height - dh, is_midi);
1518 set_routing_color (cr, is_midi);
1519 cairo_set_line_width (cr, 1.0);
1520 cairo_move_to (cr, x, height - dh);
1521 cairo_line_to (cr, x, height - 2);
1524 const double ar = dh - 1;
1525 cairo_move_to (cr, x - ar, height - ar);
1526 cairo_line_to (cr, x , height - .5);
1527 cairo_line_to (cr, x + ar, height - ar);
1528 cairo_line_to (cr, x , height - ar * .5);
1529 cairo_close_path (cr);
1530 cairo_fill_preserve (cr);
1536 ProcessorEntry::PluginDisplay::PluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1540 , _max_height (max_height)
1544 set_name ("processor prefader");
1545 add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
1546 _plug->DropReferences.connect (_death_connection, invalidator (*this), boost::bind (&PluginDisplay::plugin_going_away, this), gui_context());
1547 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1548 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1550 std::string postfix = "";
1551 if (_plug->has_editor()) {
1552 ARDOUR_UI_UTILS::set_tooltip (*this,
1553 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), e.name (Wide), Keyboard::primary_modifier_name (), postfix));
1555 ARDOUR_UI_UTILS::set_tooltip (*this,
1556 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), e.name (Wide), postfix));
1560 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1563 cairo_surface_destroy (_surf);
1568 ProcessorEntry::PluginDisplay::on_button_press_event (GdkEventButton *ev)
1570 assert (_entry.processor ());
1572 // consider some tweaks to pass this up to the DnDVBox somehow:
1573 // select processor, then call (private)
1574 //_entry._parent->processor_button_press_event (ev, &_entry);
1575 if (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS)) {
1576 if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1577 _entry._parent->generic_edit_processor (_entry.processor ());
1579 _entry._parent->edit_processor (_entry.processor ());
1587 ProcessorEntry::PluginDisplay::on_button_release_event (GdkEventButton *ev)
1593 ProcessorEntry::PluginDisplay::on_size_request (Requisition* req)
1596 req->height = _cur_height;
1601 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1603 /* work-around scroll-bar + aspect ratio
1604 * show inline-view -> height changes -> scrollbar gets added
1605 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1606 * -> scroll bar is removed [-> width changes ; repeat ]
1608 uint32_t shm = std::min (_max_height, inline_height);
1610 Gtk::Container* pr = get_parent();
1611 for (uint32_t i = 0; i < 4 && pr; ++i) {
1612 // VBox, EventBox, ViewPort, ScrolledWindow
1613 pr = pr->get_parent();
1615 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1617 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1618 sc = vsb && vsb->is_visible();
1621 if (shm != _cur_height) {
1622 if (_scroll == sc || _cur_height < shm) {
1631 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1633 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1638 /* allocate a local image-surface,
1639 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1640 * since pixman keeps a reference to it.
1641 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1642 * it might be possible to work around via cairo_surface_set_user_data().
1645 || dis->width != cairo_image_surface_get_width (_surf)
1646 || dis->height != cairo_image_surface_get_height (_surf)
1649 cairo_surface_destroy (_surf);
1651 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1654 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1655 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1657 unsigned char *src = dis->data;
1658 unsigned char *dst = cairo_image_surface_get_data (_surf);
1659 const int dst_stride = cairo_image_surface_get_stride (_surf);
1660 for (int y = 0; y < dis->height; ++y) {
1661 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1667 cairo_surface_flush(_surf);
1668 cairo_surface_mark_dirty(_surf);
1669 const double xc = floor ((width - dis->width) * .5);
1670 cairo_set_source_surface(cr, _surf, xc, 0);
1677 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1679 Gtk::Allocation a = get_allocation();
1680 double const width = a.get_width();
1681 double const height = a.get_height();
1683 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1684 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1687 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1688 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1689 cairo_rectangle (cr, 0, 0, width, height);
1693 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1694 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1696 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1698 uint32_t ht = render_inline (cr, width);
1703 if (_cur_height != 1) {
1710 update_height_alloc (ht);
1713 bool failed = false;
1714 std::string name = get_name();
1715 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1717 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1718 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1719 cairo_set_line_width(cr, 1.0);
1720 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1727 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1728 : PluginDisplay (e, p, max_height)
1730 , _lua_render_inline (0)
1732 p->setup_lua_inline_gui (&lua_gui);
1734 lua_State* LG = lua_gui.getState ();
1735 LuaInstance::bind_cairo (LG);
1736 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1737 assert (lua_render.isFunction ());
1738 _lua_render_inline = new luabridge::LuaRef (lua_render);
1741 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1743 delete (_lua_render_inline);
1747 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1749 Cairo::Context ctx (cr);
1751 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1752 lua_gui.collect_garbage_step ();
1753 if (rv.isTable ()) {
1757 } catch (luabridge::LuaException const& e) {
1759 cerr << "LuaException:" << e.what () << endl;
1766 static std::list<Gtk::TargetEntry> drop_targets()
1768 std::list<Gtk::TargetEntry> tmp;
1769 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1770 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1771 tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1775 static std::list<Gtk::TargetEntry> drag_targets()
1777 std::list<Gtk::TargetEntry> tmp;
1778 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1779 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1783 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1785 std::list<Gtk::TargetEntry> tmp;
1786 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1790 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1791 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1792 : _parent_strip (parent)
1793 , _owner_is_mixer (owner_is_mixer)
1794 , ab_direction (true)
1795 , _get_plugin_selector (get_plugin_selector)
1797 , _visible_prefader_processors (0)
1798 , _rr_selection(rsel)
1799 , processor_display (drop_targets())
1800 , _redisplay_pending (false)
1804 /* ProcessorBox actions and bindings created statically by call to
1805 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1806 * are available for context menus.
1809 processor_display.set_data ("ardour-bindings", bindings);
1813 no_processor_redisplay = false;
1815 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1816 processor_scroller.add (processor_display);
1817 pack_start (processor_scroller, true, true);
1819 processor_display.set_flags (CAN_FOCUS);
1820 processor_display.set_name ("ProcessorList");
1821 processor_display.set_data ("processorbox", this);
1822 processor_display.set_size_request (48, -1);
1823 processor_display.set_spacing (0);
1825 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1826 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1828 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1829 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1831 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1832 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1833 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1835 processor_scroller.show ();
1836 processor_display.show ();
1839 parent->DeliveryChanged.connect (
1840 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1844 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1847 ProcessorBox::~ProcessorBox ()
1849 /* it may appear as if we should delete processor_menu but that is a
1850 * pointer to a widget owned by the UI Manager, and has potentially
1851 * be returned to many other ProcessorBoxes. GTK doesn't really make
1852 * clear the ownership of this widget, which is a menu and thus is
1853 * never packed into any container other than an implict GtkWindow.
1855 * For now, until or if we ever get clarification over the ownership
1856 * story just let it continue to exist. At worst, its a small memory leak.
1861 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1867 _route_connections.drop_connections();
1869 /* new route: any existing block on processor redisplay must be meaningless */
1870 no_processor_redisplay = false;
1873 _route->processors_changed.connect (
1874 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1877 _route->DropReferences.connect (
1878 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1881 _route->PropertyChanged.connect (
1882 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1885 redisplay_processors ();
1889 ProcessorBox::route_going_away ()
1891 /* don't keep updating display as processors are deleted */
1892 no_processor_redisplay = true;
1896 boost::shared_ptr<Processor>
1897 ProcessorBox::find_drop_position (ProcessorEntry* position)
1899 boost::shared_ptr<Processor> p;
1901 p = position->processor ();
1903 /* dropped on the blank entry (which will be before the
1904 fader), so use the first non-blank child as our
1905 `dropped on' processor */
1906 list<ProcessorEntry*> c = processor_display.children ();
1907 list<ProcessorEntry*>::iterator i = c.begin ();
1909 assert (i != c.end ());
1910 p = (*i)->processor ();
1918 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1920 const void * d = data.get_data();
1921 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1923 PluginPresetList nfos;
1925 tv->get_object_drag_data (nfos, &source);
1927 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1928 PluginPresetPtr ppp = (*i);
1929 PluginInfoPtr pip = ppp->_pip;
1930 PluginPtr p = pip->load (*_session);
1935 if (ppp->_preset.valid) {
1936 p->load_preset (ppp->_preset);
1939 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1940 if (Config->get_new_plugins_active ()) {
1941 processor->enable (true);
1943 pl.push_back (processor);
1948 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1950 const void * d = data.get_data();
1951 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1952 PluginInfoList nfos;
1955 tv->get_object_drag_data (nfos, &source);
1957 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1958 PluginPtr p = (*i)->load (*_session);
1962 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1963 if (Config->get_new_plugins_active ()) {
1964 processor->enable (true);
1966 pl.push_back (processor);
1971 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1977 boost::shared_ptr<Processor> p = find_drop_position (position);
1978 Route::ProcessorList pl;
1980 if (data.get_target() == "PluginInfoPtr") {
1981 _drop_plugin (data, pl);
1983 else if (data.get_target() == "PluginFavoritePtr") {
1984 _drop_plugin_preset (data, pl);
1990 Route::ProcessorStreams err;
1991 if (_route->add_processors (pl, p, &err)) {
1993 "Processor Drag/Drop failed. Probably because\n\
1994 the I/O configuration of the plugins could\n\
1995 not match the configuration of this track.");
1996 MessageDialog am (msg);
2002 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
2004 if (Gdk::ACTION_LINK == context->get_selected_action()) {
2005 list<ProcessorEntry*> children = source->selection ();
2006 assert (children.size() == 1);
2007 ProcessorEntry* other = *children.begin();
2008 assert (other->can_copy_state (position));
2009 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
2010 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
2011 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
2012 assert (otherproc && proc && pi);
2014 PBD::ID id = pi->id();
2015 XMLNode& state = otherproc->get_state ();
2016 /* strip side-chain state (processor inside processor must be a side-chain)
2017 * otherwise we'll end up with duplicate ports-names.
2018 * (this needs a better solution which retains connections)
2020 state.remove_nodes ("Processor");
2021 proc->set_state (state, Stateful::loading_state_version);
2022 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
2026 boost::shared_ptr<Processor> p = find_drop_position (position);
2028 list<ProcessorEntry*> children = source->selection ();
2029 list<boost::shared_ptr<Processor> > procs;
2030 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
2031 if ((*i)->processor ()) {
2032 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
2035 procs.push_back ((*i)->processor ());
2039 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
2040 XMLNode& state = (*i)->get_state ();
2042 nlist.push_back (&state);
2043 paste_processor_state (nlist, p);
2047 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
2051 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
2052 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
2054 other->delete_dragged_processors (procs);
2060 ProcessorBox::set_width (Width w)
2068 list<ProcessorEntry*> children = processor_display.children ();
2069 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2070 (*i)->set_enum_width (w);
2077 ProcessorBox::build_possible_aux_menu ()
2079 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2082 /* No aux sends if there are no busses */
2086 if (_route->is_monitor ()) {
2090 using namespace Menu_Helpers;
2091 Menu* menu = manage (new Menu);
2092 MenuList& items = menu->items();
2094 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2095 if (!_route->internal_send_for (*r) && *r != _route) {
2096 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2104 ProcessorBox::show_processor_menu (int arg)
2106 if (processor_menu == 0) {
2107 processor_menu = build_processor_menu ();
2108 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2111 /* Sort out the plugin submenu */
2113 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2115 if (plugin_menu_item) {
2116 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2119 /* And the aux submenu */
2121 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2123 if (aux_menu_item) {
2124 Menu* m = build_possible_aux_menu();
2125 if (m && !m->items().empty()) {
2126 aux_menu_item->set_submenu (*m);
2127 aux_menu_item->set_sensitive (true);
2129 /* stupid gtkmm: we need to pass a null reference here */
2130 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2131 aux_menu_item->set_sensitive (false);
2135 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2136 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2138 ProcessorEntry* single_selection = 0;
2139 if (processor_display.selection().size() == 1) {
2140 single_selection = processor_display.selection().front();
2143 /* And the controls submenu */
2145 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2147 if (controls_menu_item) {
2148 if (single_selection) {
2149 Menu* m = single_selection->build_controls_menu ();
2150 if (m && !m->items().empty()) {
2151 controls_menu_item->set_submenu (*m);
2152 controls_menu_item->set_sensitive (true);
2154 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2155 controls_menu_item->set_sensitive (false);
2158 controls_menu_item->set_sensitive (false);
2163 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2164 if (send_menu_item) {
2165 if (single_selection && !_route->is_monitor()) {
2166 Menu* m = single_selection->build_send_options_menu ();
2167 if (m && !m->items().empty()) {
2168 send_menu_item->set_submenu (*m);
2169 send_menu_item->set_sensitive (true);
2171 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2172 send_menu_item->set_sensitive (false);
2175 send_menu_item->set_sensitive (false);
2179 /* Sensitise actions as approprioate */
2182 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2184 paste_action->set_sensitive (!_rr_selection.processors.empty());
2185 cut_action->set_sensitive (sensitive && can_cut ());
2186 copy_action->set_sensitive (sensitive);
2187 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2188 backspace_action->set_sensitive (sensitive || stub_processor_selected ());
2190 edit_action->set_sensitive (one_processor_can_be_edited ());
2191 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2193 boost::shared_ptr<PluginInsert> pi;
2194 if (single_selection) {
2195 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2198 manage_pins_action->set_sensitive (pi != 0);
2200 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2201 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2203 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2204 rename_action->set_sensitive (single_selection
2206 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2207 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2209 processor_menu->popup (1, arg);
2211 /* Add a placeholder gap to the processor list to indicate where a processor would be
2212 inserted were one chosen from the menu.
2215 processor_display.get_pointer (x, y);
2216 _placement = processor_display.add_placeholder (y);
2218 if (_visible_prefader_processors == 0 && _placement > 0) {
2224 ProcessorBox::enter_notify (GdkEventCrossing*)
2226 processor_display.grab_focus ();
2227 _current_processor_box = this;
2232 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2234 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2238 Widget* top = get_toplevel();
2240 if (top->is_toplevel()) {
2241 Window* win = dynamic_cast<Window*> (top);
2242 gtk_window_set_focus (win->gobj(), 0);
2249 ProcessorBox::processor_operation (ProcessorOperation op)
2251 ProcSelection targets;
2253 get_selected_processors (targets);
2255 /* if (targets.empty()) {
2258 processor_display.get_pointer (x, y);
2260 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2262 if (pointer.first && pointer.first->processor()) {
2263 targets.push_back (pointer.first->processor ());
2268 if ((op == ProcessorsDelete) && targets.empty()) {
2269 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2273 case ProcessorsSelectAll:
2274 processor_display.select_all ();
2277 case ProcessorsSelectNone:
2278 processor_display.select_none ();
2281 case ProcessorsCopy:
2282 copy_processors (targets);
2286 cut_processors (targets);
2289 case ProcessorsPaste:
2290 // some processors are not selectable (e.g fader, meter), target is empty.
2291 if (targets.empty() && _placement >= 0) {
2293 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2295 targets.push_back (proc);
2298 if (targets.empty()) {
2299 paste_processors ();
2301 paste_processors (targets.front());
2305 case ProcessorsDelete:
2306 delete_processors (targets);
2309 case ProcessorsToggleActive:
2310 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2311 (*i)->enable (!(*i)->enabled ());
2326 ProcessorWindowProxy*
2327 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2329 return processor->window_proxy();
2334 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2336 boost::shared_ptr<Processor> processor;
2338 processor = child->processor ();
2342 bool selected = processor_display.selected (child);
2344 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2346 if (_session->engine().connected()) {
2347 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2349 if (!one_processor_can_be_edited ()) {
2353 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2354 generic_edit_processor (processor);
2356 edit_processor (processor);
2362 } else if (Keyboard::is_context_menu_event (ev)) {
2364 show_processor_menu (ev->time);
2368 } else if (processor && ev->button == 1 && selected) {
2370 // this is purely informational but necessary for route params UI
2371 ProcessorSelected (processor); // emit
2373 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2376 _get_plugin_selector()->show_manager ();
2383 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2385 boost::shared_ptr<Processor> processor;
2387 processor = child->processor ();
2390 if (processor && Keyboard::is_delete_event (ev)) {
2392 Glib::signal_idle().connect (sigc::bind (
2393 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2394 boost::weak_ptr<Processor>(processor)));
2396 } else if (processor && Keyboard::is_button2_event (ev)
2398 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2402 /* button2-click with no/appropriate modifiers */
2403 processor->enable (!processor->enabled ());
2410 ProcessorBox::build_processor_menu ()
2412 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2413 processor_menu->set_name ("ArdourContextMenu");
2414 return processor_menu;
2418 ProcessorBox::select_all_processors ()
2420 processor_display.select_all ();
2424 ProcessorBox::deselect_all_processors ()
2426 processor_display.select_none ();
2430 ProcessorBox::choose_plugin ()
2432 _get_plugin_selector()->set_interested_object (*this);
2435 /** @return true if an error occurred, otherwise false */
2437 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2439 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2441 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2443 Route::ProcessorStreams err_streams;
2445 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2446 weird_plugin_dialog (**p, err_streams);
2448 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2449 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2450 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2452 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2453 if ((*p)->has_editor ()) {
2454 edit_processor (processor);
2456 generic_edit_processor (processor);
2466 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2468 /* XXX this needs to be re-worked!
2470 * With new pin-management "streams" is no longer correct.
2471 * p.get_info () is also incorrect for variable i/o plugins (always -1,-1).
2473 * Since pin-management was added, this dialog will only show in a very rare
2474 * condition (non-replicated variable i/o configuration failed).
2476 * TODO: simplify the message after the string-freeze is lifted.
2478 ArdourDialog dialog (_("Plugin Incompatibility"));
2481 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2482 p.name(), streams.index);
2484 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2485 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2487 text += _("\nThis plugin has:\n");
2489 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2490 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2493 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2494 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2497 text += _("\nbut at the insertion point, there are:\n");
2499 uint32_t const n = streams.count.n_midi ();
2500 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2503 uint32_t const n = streams.count.n_audio ();
2504 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2507 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2508 label.set_text(text);
2510 dialog.get_vbox()->pack_start (label);
2511 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2513 dialog.set_name (X_("PluginIODialog"));
2514 dialog.set_modal (true);
2521 ProcessorBox::choose_insert ()
2523 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2524 _route->add_processor_by_index (processor, _placement);
2527 /* Caller must not hold process lock */
2529 ProcessorBox::choose_send ()
2531 boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2533 /* make an educated guess at the initial number of outputs for the send */
2534 ChanCount outs = (_route->n_outputs().n_audio() && _session->master_out())
2535 ? _session->master_out()->n_outputs()
2536 : _route->n_outputs();
2538 /* XXX need processor lock on route */
2540 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2541 send->output()->ensure_io (outs, false, this);
2542 } catch (AudioEngine::PortRegistrationFailure& err) {
2543 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2547 /* let the user adjust the IO setup before creation.
2549 Note: this dialog is NOT modal - we just leave it to run and it will
2550 return when its Finished signal is emitted - typically when the window
2554 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2557 /* keep a reference to the send so it doesn't get deleted while
2558 the IOSelectorWindow is doing its stuff
2560 _processor_being_created = send;
2562 ios->selector().Finished.connect (sigc::bind (
2563 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2564 boost::weak_ptr<Processor>(send), ios));
2569 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2571 boost::shared_ptr<Processor> processor (weak_processor.lock());
2573 /* drop our temporary reference to the new send */
2574 _processor_being_created.reset ();
2581 case IOSelector::Cancelled:
2582 // processor will go away when all shared_ptrs to it vanish
2585 case IOSelector::Accepted:
2586 _route->add_processor_by_index (processor, _placement);
2590 delete_when_idle (ios);
2594 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2596 boost::shared_ptr<Processor> processor (weak_processor.lock());
2598 /* drop our temporary reference to the new return */
2599 _processor_being_created.reset ();
2606 case IOSelector::Cancelled:
2607 // processor will go away when all shared_ptrs to it vanish
2610 case IOSelector::Accepted:
2611 _route->add_processor_by_index (processor, _placement);
2615 delete_when_idle (ios);
2619 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2625 boost::shared_ptr<Route> target = wr.lock();
2631 _session->add_internal_send (target, _placement, _route);
2635 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2637 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2638 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2642 redisplay_processors ();
2646 ProcessorBox::redisplay_processors ()
2648 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2651 if (no_processor_redisplay) {
2655 processor_display.clear ();
2657 _visible_prefader_processors = 0;
2660 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2661 &_visible_prefader_processors, &fader_seen));
2663 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2664 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2665 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2667 setup_entry_positions ();
2670 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2671 * not already have one.
2674 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2676 boost::shared_ptr<Processor> p = w.lock ();
2680 if (p->window_proxy()) {
2684 /* not on the list; add it */
2687 #if 0 // is this still needed? Why?
2688 if (_parent_strip) {
2689 if (_parent_strip->mixer_owned()) {
2701 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2702 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2706 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2709 wp->set_state (*ui_xml, 0);
2712 void* existing_ui = p->get_ui ();
2715 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2718 p->set_window_proxy (wp);
2719 WM::Manager::instance().register_window (wp);
2723 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2725 boost::shared_ptr<Processor> p = w.lock ();
2726 if (!p || p->pinmgr_proxy ()) {
2730 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2731 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2732 wp->set_session (_session);
2734 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2736 wp->set_state (*ui_xml, 0);
2739 p->set_pingmgr_proxy (wp);
2740 WM::Manager::instance().register_window (wp);
2743 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2745 boost::shared_ptr<Processor> processor (p.lock ());
2747 if (processor && ( processor->display_to_user()
2749 || show_all_processors
2754 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2755 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2766 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2768 boost::shared_ptr<Processor> processor (p.lock ());
2770 if (!processor || ( !processor->display_to_user()
2772 && !show_all_processors
2779 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2781 ProcessorEntry* e = 0;
2782 if (plugin_insert) {
2783 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2785 e = new ProcessorEntry (this, processor, _width);
2788 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2789 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2790 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2792 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2793 if (!send && !plugin_insert && !ext && !stub)
2794 e->set_selectable(false);
2796 bool mark_send_visible = false;
2797 if (send && _parent_strip) {
2798 /* show controls of new sends by default */
2799 GUIObjectState& st = _parent_strip->gui_object_state ();
2800 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2802 /* check if state exists, if not it must be a new send */
2803 if (!st.get_node(strip, e->state_id())) {
2804 mark_send_visible = true;
2808 /* Set up this entry's state from the GUIObjectState */
2809 XMLNode* proc = entry_gui_object_state (e);
2811 e->set_control_state (proc);
2814 if (mark_send_visible) {
2815 e->show_all_controls ();
2820 && !plugin_insert->plugin(0)->is_channelstrip()
2824 processor_display.add_child (e, drag_targets());
2826 processor_display.add_child (e, drag_targets_noplugin());
2831 ProcessorBox::reordered ()
2833 compute_processor_sort_keys ();
2834 setup_entry_positions ();
2838 ProcessorBox::setup_routing_feeds ()
2840 list<ProcessorEntry*> children = processor_display.children ();
2841 /* first set the i/o maps for every processor */
2842 list<ProcessorEntry*>::iterator prev = children.begin();
2844 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2845 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2846 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2848 list<ProcessorEntry*>::iterator next = i;
2852 ChanCount sinks = pi->natural_input_streams ();
2853 ChanCount sources = pi->natural_output_streams ();
2854 uint32_t count = pi->get_count ();
2856 pi->configured_io (in, out);
2858 ChanCount midi_thru;
2859 ChanCount midi_bypass;
2860 ChanMapping input_map (pi->input_map ());
2861 if (pi->has_midi_thru ()) {
2862 midi_thru.set(DataType::MIDI, 1);
2863 input_map.set (DataType::MIDI, 0, 0);
2865 if (pi->has_midi_bypass ()) {
2866 midi_bypass.set(DataType::MIDI, 1);
2869 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2870 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2872 (*i)->routing_icon.set (
2874 sinks * count + midi_thru,
2875 sources * count + midi_bypass,
2880 if (next != children.end()) {
2881 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2882 pi->output_map (), pi->thru_map ());
2886 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2887 pi->input_map (), pi->thru_map ());
2891 (*i)->input_icon.set_ports (p->input_streams());
2892 (*i)->output_icon.set_ports (p->output_streams());
2893 ChanMapping inmap (p->input_streams ());
2894 ChanMapping outmap (p->input_streams ());
2895 ChanMapping thrumap;
2896 (*i)->routing_icon.set (
2898 p->output_streams(),
2900 p->output_streams(),
2901 inmap, outmap, thrumap);
2903 if (next != children.end()) {
2904 (*next)->routing_icon.set_fed_by (
2905 p->output_streams(),
2906 p->output_streams(),
2910 (*prev)->routing_icon.set_feeding (
2912 p->output_streams(),
2917 if (i == children.begin()) {
2918 (*i)->routing_icon.unset_fed_by ();
2921 (*i)->input_icon.hide();
2924 /* now set which icons need to be displayed */
2925 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2926 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2928 if ((*i)->routing_icon.in_identity ()) {
2929 (*i)->routing_icon.hide();
2930 if (i == children.begin()) {
2931 (*i)->input_icon.show();
2934 (*i)->routing_icon.show();
2935 (*i)->routing_icon.queue_draw();
2936 (*i)->input_icon.show();
2939 list<ProcessorEntry*>::iterator next = i;
2940 if (++next == children.end()) {
2941 // last processor in the chain
2942 (*i)->output_routing_icon.set_terminal(true);
2943 (*i)->output_routing_icon.unset_feeding ();
2944 if ((*i)->routing_icon.out_identity ()) {
2945 (*i)->output_routing_icon.hide();
2947 (*i)->output_routing_icon.show();
2948 (*i)->output_routing_icon.queue_draw();
2951 (*i)->output_routing_icon.set_terminal(false);
2952 if ( !(*i)->routing_icon.out_identity ()
2953 && !(*next)->routing_icon.in_identity ()
2954 && (*next)->routing_icon.can_coalesce ()) {
2955 (*i)->output_routing_icon.hide();
2956 } else if (!(*i)->routing_icon.out_identity ()) {
2957 (*i)->output_routing_icon.show();
2958 (*i)->output_routing_icon.queue_draw();
2959 (*next)->input_icon.show();
2961 (*i)->output_routing_icon.hide();
2968 ProcessorBox::setup_entry_positions ()
2970 list<ProcessorEntry*> children = processor_display.children ();
2971 bool pre_fader = true;
2974 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2975 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2976 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2978 (*i)->set_position (ProcessorEntry::Fader, num++);
2981 (*i)->set_position (ProcessorEntry::PreFader, num++);
2983 (*i)->set_position (ProcessorEntry::PostFader, num++);
2987 setup_routing_feeds ();
2991 ProcessorBox::compute_processor_sort_keys ()
2993 list<ProcessorEntry*> children = processor_display.children ();
2994 Route::ProcessorList our_processors;
2996 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2997 if ((*i)->processor()) {
2998 our_processors.push_back ((*i)->processor ());
3002 if (_route->reorder_processors (our_processors)) {
3003 /* Reorder failed, so report this to the user. As far as I can see this must be done
3004 in an idle handler: it seems that the redisplay_processors() that happens below destroys
3005 widgets that were involved in the drag-and-drop on the processor list, which causes problems
3006 when the drag is torn down after this handler function is finished.
3008 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
3013 ProcessorBox::report_failed_reorder ()
3015 /* reorder failed, so redisplay */
3017 redisplay_processors ();
3019 /* now tell them about the problem */
3021 ArdourDialog dialog (_("Plugin Incompatibility"));
3024 label.set_text (_("\
3025 You cannot reorder these plugins/sends/inserts\n\
3026 in that way because the inputs and\n\
3027 outputs will not work correctly."));
3029 dialog.get_vbox()->set_border_width (12);
3030 dialog.get_vbox()->pack_start (label);
3031 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
3033 dialog.set_name (X_("PluginIODialog"));
3034 dialog.set_modal (true);
3041 ProcessorBox::rename_processors ()
3043 ProcSelection to_be_renamed;
3045 get_selected_processors (to_be_renamed);
3047 if (to_be_renamed.empty()) {
3051 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3052 rename_processor (*i);
3057 ProcessorBox::can_cut () const
3059 vector<boost::shared_ptr<Processor> > sel;
3061 get_selected_processors (sel);
3063 /* cut_processors () does not cut inserts */
3065 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3067 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3068 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3069 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3078 ProcessorBox::stub_processor_selected () const
3080 vector<boost::shared_ptr<Processor> > sel;
3082 get_selected_processors (sel);
3084 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3085 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3094 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3096 if (to_be_removed.empty()) {
3100 XMLNode* node = new XMLNode (X_("cut"));
3101 Route::ProcessorList to_cut;
3103 no_processor_redisplay = true;
3104 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3105 // Cut only plugins, sends and returns
3106 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3107 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3108 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3110 Window* w = get_processor_ui (*i);
3116 XMLNode& child ((*i)->get_state());
3117 node->add_child_nocopy (child);
3118 to_cut.push_back (*i);
3122 if (_route->remove_processors (to_cut) != 0) {
3124 no_processor_redisplay = false;
3128 _rr_selection.set (node);
3130 no_processor_redisplay = false;
3131 redisplay_processors ();
3135 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3137 if (to_be_copied.empty()) {
3141 XMLNode* node = new XMLNode (X_("copy"));
3143 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3144 // Copy only plugins, sends, returns
3145 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3146 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3147 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3148 node->add_child_nocopy ((*i)->get_state());
3152 _rr_selection.set (node);
3156 ProcessorBox::delete_processors (const ProcSelection& targets)
3158 if (targets.empty()) {
3162 no_processor_redisplay = true;
3164 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3166 Window* w = get_processor_ui (*i);
3172 _route->remove_processor(*i);
3175 no_processor_redisplay = false;
3176 redisplay_processors ();
3180 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3182 list<boost::shared_ptr<Processor> >::const_iterator x;
3184 no_processor_redisplay = true;
3185 for (x = procs.begin(); x != procs.end(); ++x) {
3187 Window* w = get_processor_ui (*x);
3193 _route->remove_processor(*x);
3196 no_processor_redisplay = false;
3197 redisplay_processors ();
3201 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3203 boost::shared_ptr<Processor> processor (weak_processor.lock());
3209 /* NOT copied to _mixer.selection() */
3211 no_processor_redisplay = true;
3212 _route->remove_processor (processor);
3213 no_processor_redisplay = false;
3214 redisplay_processors ();
3220 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3222 ArdourPrompter name_prompter (true);
3224 name_prompter.set_title (_("Rename Processor"));
3225 name_prompter.set_prompt (_("New name:"));
3226 name_prompter.set_initial_text (processor->name());
3227 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3228 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3229 name_prompter.show_all ();
3231 switch (name_prompter.run ()) {
3233 case Gtk::RESPONSE_ACCEPT:
3234 name_prompter.get_result (result);
3235 if (result.length()) {
3238 string test = result;
3240 while (tries < 100) {
3241 if (_session->io_name_is_legal (test)) {
3247 test = string_compose ("%1-%2", result, tries);
3251 processor->set_name (result);
3254 ARDOUR_UI::instance()->popup_error
3255 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3265 ProcessorBox::paste_processors ()
3267 if (_rr_selection.processors.empty()) {
3271 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3275 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3278 if (_rr_selection.processors.empty()) {
3282 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3286 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3288 XMLNodeConstIterator niter;
3289 list<boost::shared_ptr<Processor> > copies;
3291 if (nlist.empty()) {
3295 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3297 XMLProperty const * type = (*niter)->property ("type");
3298 XMLProperty const * role = (*niter)->property ("role");
3301 boost::shared_ptr<Processor> p;
3303 if (type->value() == "meter" ||
3304 type->value() == "main-outs" ||
3305 type->value() == "amp" ||
3306 type->value() == "intreturn") {
3307 /* do not paste meter, main outs, amp or internal returns */
3310 } else if (type->value() == "intsend") {
3312 /* aux sends are OK, but those used for
3313 * other purposes, are not.
3318 if (role->value() != "Aux") {
3322 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3323 XMLNode n (**niter);
3324 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3325 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3327 IOProcessor::prepare_for_reset (n, s->name());
3329 if (s->set_state (n, Stateful::loading_state_version)) {
3336 } else if (type->value() == "send") {
3338 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3339 XMLNode n (**niter);
3341 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3343 IOProcessor::prepare_for_reset (n, s->name());
3345 if (s->set_state (n, Stateful::loading_state_version)) {
3352 } else if (type->value() == "return") {
3354 XMLNode n (**niter);
3355 Return* r = new Return (*_session);
3357 IOProcessor::prepare_for_reset (n, r->name());
3359 if (r->set_state (n, Stateful::loading_state_version)) {
3366 } else if (type->value() == "port") {
3368 XMLNode n (**niter);
3369 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3371 IOProcessor::prepare_for_reset (n, pi->name());
3373 if (pi->set_state (n, Stateful::loading_state_version)) {
3379 /* XXX its a bit limiting to assume that everything else
3382 p.reset (new PluginInsert (*_session));
3383 /* we can't use RAII Stateful::ForceIDRegeneration
3384 * because that'd void copying the state and wrongly bump
3385 * the state-version counter.
3386 * we need to load the state (incl external files) first and
3387 * only then update the ID)
3389 PBD::ID id = p->id();
3390 /* strip side-chain state (processor inside processor must be a side-chain)
3391 * otherwise we'll end up with duplicate ports-names.
3392 * (this needs a better solution which retains connections)
3393 * We really would want Stateful::ForceIDRegeneration here :(
3395 XMLNode state (**niter);
3396 state.remove_nodes ("Processor");
3398 p->set_state (state, Stateful::current_state_version);
3399 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3402 copies.push_back (p);
3406 error << _("plugin insert constructor failed") << endmsg;
3410 if (copies.empty()) {
3414 if (_route->add_processors (copies, p)) {
3417 "Copying the set of processors on the clipboard failed,\n\
3418 probably because the I/O configuration of the plugins\n\
3419 could not match the configuration of this track.");
3420 MessageDialog am (msg);
3426 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3428 const list<ProcessorEntry*> selection = processor_display.selection ();
3429 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3430 processors.push_back ((*i)->processor ());
3435 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3437 list<ProcessorEntry*> selection = processor_display.selection ();
3438 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3439 (this->*method) ((*i)->processor ());
3444 ProcessorBox::all_visible_processors_active (bool state)
3446 _route->all_visible_processors_active (state);
3450 ProcessorBox::ab_plugins ()
3452 _route->ab_plugins (ab_direction);
3453 ab_direction = !ab_direction;
3458 ProcessorBox::clear_processors ()
3461 vector<string> choices;
3463 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3464 "(this cannot be undone)"), _route->name());
3466 choices.push_back (_("Cancel"));
3467 choices.push_back (_("Yes, remove them all"));
3469 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3471 if (prompter.run () == 1) {
3472 _route->clear_processors (PreFader);
3473 _route->clear_processors (PostFader);
3478 ProcessorBox::clear_processors (Placement p)
3481 vector<string> choices;
3483 if (p == PreFader) {
3484 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3485 "(this cannot be undone)"), _route->name());
3487 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3488 "(this cannot be undone)"), _route->name());
3491 choices.push_back (_("Cancel"));
3492 choices.push_back (_("Yes, remove them all"));
3494 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3496 if (prompter.run () == 1) {
3497 _route->clear_processors (p);
3502 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3504 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3505 if (at && at->freeze_state() == AudioTrack::Frozen) {
3510 boost::dynamic_pointer_cast<Send> (processor) ||
3511 boost::dynamic_pointer_cast<Return> (processor) ||
3512 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3513 boost::dynamic_pointer_cast<PortInsert> (processor)
3522 ProcessorBox::one_processor_can_be_edited ()
3524 list<ProcessorEntry*> selection = processor_display.selection ();
3525 list<ProcessorEntry*>::iterator i = selection.begin();
3526 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3530 return (i != selection.end());
3534 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3536 boost::shared_ptr<Send> send;
3537 boost::shared_ptr<InternalSend> internal_send;
3538 boost::shared_ptr<Return> retrn;
3539 boost::shared_ptr<PluginInsert> plugin_insert;
3540 boost::shared_ptr<PortInsert> port_insert;
3543 /* This method may or may not return a Window, but if it does not it
3544 * will modify the parent mixer strip appearance layout to allow
3545 * "editing" the @param processor that was passed in.
3547 * So for example, if the processor is an Amp (gain), the parent strip
3548 * will be forced back into a model where the fader controls the main gain.
3549 * If the processor is a send, then we map the send controls onto the
3552 * Plugins and others will return a window for control.
3555 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3557 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3562 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3564 if (_parent_strip) {
3565 _parent_strip->revert_to_default_display ();
3568 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3570 if (!_session->engine().connected()) {
3574 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3576 gidget = new SendUIWindow (send, _session);
3579 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3581 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3582 /* no GUI for these */
3586 if (!_session->engine().connected()) {
3590 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3592 ReturnUIWindow *return_ui;
3593 Window* w = get_processor_ui (retrn);
3597 return_ui = new ReturnUIWindow (retrn, _session);
3598 return_ui->set_title (retrn->name ());
3599 set_processor_ui (send, return_ui);
3602 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3607 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3609 PluginUIWindow *plugin_ui;
3611 /* these are both allowed to be null */
3613 Window* w = get_processor_ui (plugin_insert);
3616 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3617 plugin_ui->set_title (generate_processor_title (plugin_insert));
3618 set_processor_ui (plugin_insert, plugin_ui);
3621 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3626 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3628 if (!_session->engine().connected()) {
3629 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3634 PortInsertWindow *io_selector;
3636 Window* w = get_processor_ui (port_insert);
3639 io_selector = new PortInsertWindow (_session, port_insert);
3640 set_processor_ui (port_insert, io_selector);
3643 io_selector = dynamic_cast<PortInsertWindow *> (w);
3646 gidget = io_selector;
3653 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3655 boost::shared_ptr<PluginInsert> plugin_insert
3656 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3658 if (!plugin_insert) {
3662 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3663 win->set_title (generate_processor_title (plugin_insert));
3669 ProcessorBox::register_actions ()
3671 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3673 Glib::RefPtr<Action> act;
3676 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3677 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3679 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3680 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3681 ActionManager::engine_sensitive_actions.push_back (act);
3682 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3683 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3684 ActionManager::engine_sensitive_actions.push_back (act);
3686 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3688 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3689 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3691 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3692 sigc::ptr_fun (ProcessorBox::rb_clear));
3693 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3694 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3695 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3696 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3698 /* standard editing stuff */
3700 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3701 sigc::ptr_fun (ProcessorBox::rb_cut));
3702 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3703 sigc::ptr_fun (ProcessorBox::rb_copy));
3704 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3705 sigc::ptr_fun (ProcessorBox::rb_delete));
3706 backspace_action = myactions.register_action (processor_box_actions, X_("backspace"), _("Delete"),
3707 sigc::ptr_fun (ProcessorBox::rb_delete));
3709 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3710 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3711 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3712 ActionManager::plugin_selection_sensitive_actions.push_back (backspace_action);
3714 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3715 sigc::ptr_fun (ProcessorBox::rb_paste));
3716 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3717 sigc::ptr_fun (ProcessorBox::rb_rename));
3718 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3719 sigc::ptr_fun (ProcessorBox::rb_select_all));
3720 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3721 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3723 /* activation etc. */
3725 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3726 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3727 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3728 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3729 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3730 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3732 manage_pins_action = myactions.register_action (
3733 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3734 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3737 edit_action = myactions.register_action (
3738 processor_box_actions, X_("edit"), _("Edit..."),
3739 sigc::ptr_fun (ProcessorBox::rb_edit));
3741 edit_generic_action = myactions.register_action (
3742 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3743 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3749 ProcessorBox::rb_edit_generic ()
3751 if (_current_processor_box == 0) {
3755 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3759 ProcessorBox::rb_ab_plugins ()
3761 if (_current_processor_box == 0) {
3765 _current_processor_box->ab_plugins ();
3769 ProcessorBox::rb_manage_pins ()
3771 if (_current_processor_box == 0) {
3775 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3778 ProcessorBox::rb_choose_plugin ()
3780 if (_current_processor_box == 0) {
3783 _current_processor_box->choose_plugin ();
3787 ProcessorBox::rb_choose_insert ()
3789 if (_current_processor_box == 0) {
3792 _current_processor_box->choose_insert ();
3796 ProcessorBox::rb_choose_send ()
3798 if (_current_processor_box == 0) {
3801 _current_processor_box->choose_send ();
3805 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3807 if (_current_processor_box == 0) {
3811 _current_processor_box->choose_aux (wr);
3815 ProcessorBox::rb_clear ()
3817 if (_current_processor_box == 0) {
3821 _current_processor_box->clear_processors ();
3826 ProcessorBox::rb_clear_pre ()
3828 if (_current_processor_box == 0) {
3832 _current_processor_box->clear_processors (PreFader);
3837 ProcessorBox::rb_clear_post ()
3839 if (_current_processor_box == 0) {
3843 _current_processor_box->clear_processors (PostFader);
3847 ProcessorBox::rb_cut ()
3849 if (_current_processor_box == 0) {
3853 _current_processor_box->processor_operation (ProcessorsCut);
3857 ProcessorBox::rb_delete ()
3859 if (_current_processor_box == 0) {
3863 _current_processor_box->processor_operation (ProcessorsDelete);
3867 ProcessorBox::rb_copy ()
3869 if (_current_processor_box == 0) {
3872 _current_processor_box->processor_operation (ProcessorsCopy);
3876 ProcessorBox::rb_paste ()
3878 if (_current_processor_box == 0) {
3882 _current_processor_box->processor_operation (ProcessorsPaste);
3886 ProcessorBox::rb_rename ()
3888 if (_current_processor_box == 0) {
3891 _current_processor_box->rename_processors ();
3895 ProcessorBox::rb_select_all ()
3897 if (_current_processor_box == 0) {
3901 _current_processor_box->processor_operation (ProcessorsSelectAll);
3905 ProcessorBox::rb_deselect_all ()
3907 if (_current_processor_box == 0) {
3911 _current_processor_box->deselect_all_processors ();
3915 ProcessorBox::rb_activate_all ()
3917 if (_current_processor_box == 0) {
3921 _current_processor_box->all_visible_processors_active (true);
3925 ProcessorBox::rb_deactivate_all ()
3927 if (_current_processor_box == 0) {
3930 _current_processor_box->all_visible_processors_active (false);
3934 ProcessorBox::rb_edit ()
3936 if (_current_processor_box == 0) {
3940 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3944 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3946 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3950 if (_parent_strip) {
3951 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3952 if (_parent_strip->current_delivery() == send) {
3953 _parent_strip->revert_to_default_display ();
3955 _parent_strip->show_send(send);
3962 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3967 if (edit_aux_send (processor)) {
3970 if (!_session->engine().connected()) {
3974 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3977 proxy->set_custom_ui_mode (true);
3978 proxy->show_the_right_window ();
3983 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3988 if (edit_aux_send (processor)) {
3991 if (!_session->engine().connected()) {
3995 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3998 proxy->set_custom_ui_mode (false);
3999 proxy->show_the_right_window ();
4004 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
4009 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
4018 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
4020 if (!what_changed.contains (ARDOUR::Properties::name)) {
4024 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
4026 boost::shared_ptr<Processor> processor;
4027 boost::shared_ptr<PluginInsert> plugin_insert;
4028 boost::shared_ptr<Send> send;
4030 list<ProcessorEntry*> children = processor_display.children();
4032 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
4034 processor = (*iter)->processor ();
4040 Window* w = get_processor_ui (processor);
4046 /* rename editor windows for sends and plugins */
4048 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4049 w->set_title (send->name ());
4050 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4051 w->set_title (generate_processor_title (plugin_insert));
4057 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4059 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4060 string::size_type email_pos;
4062 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4063 maker = maker.substr (0, email_pos - 1);
4066 if (maker.length() > 32) {
4067 maker = maker.substr (0, 32);
4071 SessionObject* owner = pi->owner();
4074 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4076 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4080 /** @param p Processor.
4081 * @return the UI window for \a p.
4084 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4086 ProcessorWindowProxy* wp = p->window_proxy();
4093 /** Make a note of the UI window that a processor is using.
4094 * @param p Processor.
4095 * @param w UI window.
4098 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4100 assert (p->window_proxy());
4102 p->window_proxy()->use_window (*w);
4106 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4108 boost::shared_ptr<Delivery> d = w.lock ();
4113 list<ProcessorEntry*> children = processor_display.children ();
4114 list<ProcessorEntry*>::const_iterator i = children.begin();
4115 while (i != children.end() && (*i)->processor() != d) {
4119 if (i == children.end()) {
4120 processor_display.set_active (0);
4122 processor_display.set_active (*i);
4126 /** Called to repair the damage of Editor::show_window doing a show_all() */
4128 ProcessorBox::hide_things ()
4130 list<ProcessorEntry*> c = processor_display.children ();
4131 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4132 (*i)->hide_things ();
4137 ProcessorBox::processor_menu_unmapped ()
4139 processor_display.remove_placeholder ();
4140 /* make all possibly-desensitized actions sensitive again so that
4141 they be activated by other means (e.g. bindings)
4143 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4147 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4149 if (!_parent_strip) {
4153 GUIObjectState& st = _parent_strip->gui_object_state ();
4155 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4157 return st.get_or_add_node (strip, entry->state_id());
4161 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4163 XMLNode* proc = entry_gui_object_state (entry);
4168 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4169 proc->remove_nodes_and_delete (X_("Object"));
4170 entry->add_control_state (proc);
4174 ProcessorBox::is_editor_mixer_strip() const
4176 return _parent_strip && !_parent_strip->mixer_owned();
4179 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4180 : WM::ProxyBase (name, string())
4181 , _processor_box (box)
4182 , _processor (processor)
4184 , want_custom (false)
4186 boost::shared_ptr<Processor> p = _processor.lock ();
4190 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4193 ProcessorWindowProxy::~ProcessorWindowProxy()
4195 /* processor window proxies do not own the windows they create with
4196 * ::get(), so set _window to null before the normal WindowProxy method
4203 ProcessorWindowProxy::processor_going_away ()
4207 WM::Manager::instance().remove (this);
4208 /* should be no real reason to do this, since the object that would
4209 send DropReferences is about to be deleted, but lets do it anyway.
4211 going_away_connection.disconnect();
4214 ARDOUR::SessionHandlePtr*
4215 ProcessorWindowProxy::session_handle()
4222 ProcessorWindowProxy::get_state ()
4225 node = &ProxyBase::get_state();
4226 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4231 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4233 XMLNodeList children = node.children ();
4234 XMLNodeList::const_iterator i = children.begin ();
4235 while (i != children.end()) {
4236 XMLProperty const * prop = (*i)->property (X_("name"));
4237 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4243 if (i != children.end()) {
4244 XMLProperty const * prop;
4245 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4246 want_custom = PBD::string_is_affirmative (prop->value ());
4250 return ProxyBase::set_state (node, 0);
4254 ProcessorWindowProxy::get (bool create)
4256 boost::shared_ptr<Processor> p = _processor.lock ();
4261 if (_window && (is_custom != want_custom)) {
4262 /* drop existing window - wrong type */
4271 is_custom = want_custom;
4272 _window = _processor_box->get_editor_window (p, is_custom);
4277 _window->show_all ();
4283 ProcessorWindowProxy::show_the_right_window ()
4285 if (_window && (is_custom != want_custom)) {
4286 /* drop existing window - wrong type */
4293 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4294 : WM::ProxyBase (name, string())
4295 , _processor (processor)
4297 boost::shared_ptr<Processor> p = _processor.lock ();
4301 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4304 PluginPinWindowProxy::~PluginPinWindowProxy()
4309 ARDOUR::SessionHandlePtr*
4310 PluginPinWindowProxy::session_handle ()
4312 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4313 if (aw) { return aw; }
4318 PluginPinWindowProxy::get (bool create)
4320 boost::shared_ptr<Processor> p = _processor.lock ();
4321 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4330 _window = new PluginPinDialog (pi);
4331 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4333 aw->set_session (_session);
4335 _window->show_all ();
4341 PluginPinWindowProxy::processor_going_away ()
4345 WM::Manager::instance().remove (this);
4346 going_away_connection.disconnect();
4350 ProcessorBox::load_bindings ()
4352 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);