2 Copyright (C) 2000-2004 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "gtk2ardour-config.h"
28 #include <sigc++/bind.h>
30 #include "pbd/convert.h"
31 #include "canvas/utils.h"
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <gtkmm/messagedialog.h>
38 #include <gtkmm2ext/gtk_ui.h>
39 #include <gtkmm2ext/utils.h>
40 #include <gtkmm2ext/choice.h>
41 #include <gtkmm2ext/utils.h>
42 #include <gtkmm2ext/doi.h>
43 #include <gtkmm2ext/rgb_macros.h>
45 #include "ardour/amp.h"
46 #include "ardour/audio_track.h"
47 #include "ardour/audioengine.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/internal_send.h"
50 #include "ardour/luaproc.h"
51 #include "ardour/luascripting.h"
52 #include "ardour/meter.h"
53 #include "ardour/panner_shell.h"
54 #include "ardour/plugin_insert.h"
55 #include "ardour/pannable.h"
56 #include "ardour/port_insert.h"
57 #include "ardour/profile.h"
58 #include "ardour/return.h"
59 #include "ardour/route.h"
60 #include "ardour/send.h"
61 #include "ardour/session.h"
62 #include "ardour/types.h"
64 #include "LuaBridge/LuaBridge.h"
67 #include "ardour_dialog.h"
68 #include "ardour_ui.h"
69 #include "gui_thread.h"
70 #include "io_selector.h"
72 #include "luainstance.h"
74 #include "mixer_strip.h"
75 #include "plugin_pin_dialog.h"
76 #include "plugin_selector.h"
77 #include "plugin_ui.h"
78 #include "port_insert_ui.h"
79 #include "processor_box.h"
80 #include "public_editor.h"
81 #include "return_ui.h"
82 #include "route_processor_selection.h"
83 #include "script_selector.h"
87 #include "new_plugin_preset_dialog.h"
91 #ifdef AUDIOUNIT_SUPPORT
96 bool ProcessorBox::show_all_processors = false;
100 using namespace ARDOUR;
103 using namespace Glib;
104 using namespace Gtkmm2ext;
106 ProcessorBox* ProcessorBox::_current_processor_box = 0;
107 RefPtr<Action> ProcessorBox::paste_action;
108 RefPtr<Action> ProcessorBox::cut_action;
109 RefPtr<Action> ProcessorBox::copy_action;
110 RefPtr<Action> ProcessorBox::rename_action;
111 RefPtr<Action> ProcessorBox::delete_action;
112 RefPtr<Action> ProcessorBox::manage_pins_action;
113 RefPtr<Action> ProcessorBox::edit_action;
114 RefPtr<Action> ProcessorBox::edit_generic_action;
115 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
116 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
117 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
120 // TODO consolidate with PluginPinDialog::set_color
121 static void set_routing_color (cairo_t* cr, bool midi)
123 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
124 static const uint32_t midi_port_color = 0x960909FF; //Red
127 cairo_set_source_rgb (cr,
128 UINT_RGBA_R_FLT(midi_port_color),
129 UINT_RGBA_G_FLT(midi_port_color),
130 UINT_RGBA_B_FLT(midi_port_color));
132 cairo_set_source_rgb (cr,
133 UINT_RGBA_R_FLT(audio_port_color),
134 UINT_RGBA_G_FLT(audio_port_color),
135 UINT_RGBA_B_FLT(audio_port_color));
139 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
140 : _button (ArdourButton::led_default_elements)
141 , _position (PreFader)
145 , _unknown_processor(false)
151 , output_routing_icon(false)
156 _button.set_distinct_led_click (true);
157 _button.set_fallthrough_to_parent(true);
158 _button.set_led_left (true);
159 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
160 _button.set_text (name (_width));
162 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
163 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
165 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
166 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
167 _unknown_processor = true;
170 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
171 if (pi && pi->plugin()) {
172 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
177 _vbox.pack_start (routing_icon);
178 _vbox.pack_start (input_icon);
179 _vbox.pack_start (_button, true, true);
181 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
182 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
183 if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
184 _plugin_display = new PluginDisplay (pi->plugin(),
185 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
187 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
188 _plugin_display = new LuaPluginDisplay (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
189 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
191 _vbox.pack_start (*_plugin_display);
192 _plugin_display->set_no_show_all (true);
193 if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
194 _plugin_display->show ();
197 _vbox.pack_end (output_routing_icon);
198 _vbox.pack_end (output_icon);
200 _button.set_active (_processor->active());
202 input_icon.set_no_show_all(true);
203 routing_icon.set_no_show_all(true);
204 output_icon.set_no_show_all(true);
205 output_routing_icon.set_no_show_all(true);
211 output_routing_icon.hide();
213 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
214 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
215 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
217 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
218 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
220 std::string label = _processor->describe_parameter (*i);
222 if (boost::dynamic_pointer_cast<Send> (_processor)) {
224 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
228 Control* c = new Control (_processor->automation_control (*i), label);
230 _controls.push_back (c);
232 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
233 /* Add non-Amp (Fader & Trim) controls to the processor box */
234 _vbox.pack_start (c->box);
241 _vbox.set_size_request (-1, _button.size_request().height);
245 ProcessorEntry::~ProcessorEntry ()
247 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
250 delete _plugin_display;
254 ProcessorEntry::action_widget ()
260 ProcessorEntry::widget ()
266 ProcessorEntry::drag_text () const
272 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
274 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
278 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
279 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
280 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
281 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
284 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
287 if (!my_pi || !ot_pi) {
290 if (my_pi->type() != ot_pi->type()) {
293 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
294 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
295 if (!my_p || !ot_p) {
298 if (my_p->unique_id() != ot_p->unique_id()) {
305 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
307 if (data.get_target() == "PluginPresetPtr") {
308 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
310 if (!_plugin_preset_pointer || !pi) {
311 data.set (data.get_target(), 8, NULL, 0);
315 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
318 PluginManager& manager (PluginManager::instance());
319 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
321 NewPluginPresetDialog d (plugin,
322 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
324 _plugin_preset_pointer->_preset.valid = false;
327 case Gtk::RESPONSE_CANCEL:
328 data.set (data.get_target(), 8, NULL, 0);
332 case Gtk::RESPONSE_NO:
335 case Gtk::RESPONSE_ACCEPT:
336 if (d.name().empty()) {
341 plugin->remove_preset (d.name ());
344 Plugin::PresetRecord const r = plugin->save_preset (d.name());
346 if (!r.uri.empty ()) {
347 _plugin_preset_pointer->_preset.uri = r.uri;
348 _plugin_preset_pointer->_preset.label = r.label;
349 _plugin_preset_pointer->_preset.user = r.user;
350 _plugin_preset_pointer->_preset.valid = r.valid;
353 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
360 ProcessorEntry::set_position (Position p, uint32_t num)
368 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
371 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
373 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
378 ProcessorEntry::setup_visuals ()
380 if (_unknown_processor) {
381 _button.set_name ("processor stub");
384 boost::shared_ptr<Send> send;
385 if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
386 if (send->remove_on_disconnect ()) {
387 _button.set_name ("processor sidechain");
394 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
395 _button.set_name ("processor prefader");
399 _button.set_name ("processor fader");
403 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
404 _button.set_name ("processor postfader");
410 boost::shared_ptr<Processor>
411 ProcessorEntry::processor () const
414 return boost::shared_ptr<Processor>();
420 ProcessorEntry::set_enum_width (Width w)
423 _button.set_text (name (_width));
427 ProcessorEntry::led_clicked(GdkEventButton *ev)
429 bool ctrl_shift_pressed = false;
430 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
432 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
433 ctrl_shift_pressed = true;
437 if (_button.get_active ()) {
438 if (ctrl_shift_pressed) {
439 _parent->all_visible_processors_active(false);
441 if (_position == Fader) {
442 _processor->deactivate ();
446 _processor->deactivate ();
450 if (ctrl_shift_pressed) {
451 _parent->all_visible_processors_active(true);
453 if (_position == Fader) {
454 _processor->activate ();
458 _processor->activate ();
465 ProcessorEntry::processor_active_changed ()
468 _button.set_active (_processor->active());
473 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
475 if (what_changed.contains (ARDOUR::Properties::name)) {
476 _button.set_text (name (_width));
482 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
484 _parent->setup_routing_feeds ();
485 input_icon.queue_draw();
486 output_icon.queue_draw();
487 routing_icon.queue_draw();
488 output_routing_icon.queue_draw();
492 ProcessorEntry::setup_tooltip ()
495 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
497 std::string postfix = "";
499 if ((replicated = pi->get_count()) > 1) {
500 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
502 if (pi->plugin()->has_editor()) {
503 ARDOUR_UI_UTILS::set_tooltip (_button,
504 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), name (Wide), Keyboard::primary_modifier_name (), postfix));
506 ARDOUR_UI_UTILS::set_tooltip (_button,
507 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
511 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
512 ARDOUR_UI::instance()->set_tip (_button,
513 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
516 boost::shared_ptr<Send> send;
517 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
518 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
519 if (send->remove_on_disconnect ()) {
520 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
522 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>", _processor->name()));
527 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
531 ProcessorEntry::name (Width w) const
533 boost::shared_ptr<Send> send;
540 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
541 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
544 std::string send_name;
545 bool pretty_ok = true;
547 if (send->remove_on_disconnect ()) {
548 // assume it's a sidechain, find pretty name of connected port(s)
549 PortSet& ps (send->output ()->ports ());
550 for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
551 vector<string> connections;
552 if (i->get_connections (connections)) {
553 vector<string>::const_iterator ci;
554 for (ci = connections.begin(); ci != connections.end(); ++ci) {
555 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
559 if (send_name.empty ()) {
561 } else if (send_name != pn) {
562 // pretty names don't match
575 /* grab the send name out of its overall name */
576 if (send_name.empty()) {
577 send_name = send->name();
578 string::size_type lbracket, rbracket;
579 lbracket = send_name.find ('[');
580 rbracket = send_name.find (']');
581 send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
586 name_display += send_name;
589 name_display += PBD::short_version (send_name, 5);
594 boost::shared_ptr<ARDOUR::PluginInsert> pi;
596 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
597 && (replicated = pi->get_count()) > 1)
599 name_display += string_compose(_("(%1x1) "), replicated);
604 name_display += _processor->display_name();
607 name_display += PBD::short_version (_processor->display_name(), 5);
617 ProcessorEntry::show_all_controls ()
619 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
620 (*i)->set_visible (true);
623 _parent->update_gui_object_state (this);
627 ProcessorEntry::hide_all_controls ()
629 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
630 (*i)->set_visible (false);
633 _parent->update_gui_object_state (this);
637 ProcessorEntry::add_control_state (XMLNode* node) const
639 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
640 (*i)->add_state (node);
643 if (_plugin_display) {
644 XMLNode* c = new XMLNode (X_("Object"));
645 c->add_property (X_("id"), X_("InlineDisplay"));
646 c->add_property (X_("visible"), _plugin_display->is_visible ());
647 node->add_child_nocopy (*c);
652 ProcessorEntry::set_control_state (XMLNode const * node)
654 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
655 (*i)->set_state (node);
658 if (_plugin_display) {
659 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
660 XMLProperty const * p = n ? n->property (X_("visible")) : NULL;
662 if (string_is_affirmative (p->value ())) {
663 _plugin_display->show();
665 _plugin_display->hide();
672 ProcessorEntry::state_id () const
674 return string_compose ("processor %1", _processor->id().to_s());
678 ProcessorEntry::hide_things ()
680 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
681 (*i)->hide_things ();
687 ProcessorEntry::build_controls_menu ()
689 using namespace Menu_Helpers;
690 Menu* menu = manage (new Menu);
691 MenuList& items = menu->items ();
693 if (_plugin_display) {
694 items.push_back (CheckMenuElem (_("Inline Display")));
695 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
696 c->set_active (_plugin_display->is_visible ());
697 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
698 items.push_back (SeparatorElem ());
702 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
706 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
709 if (!_controls.empty ()) {
710 items.push_back (SeparatorElem ());
713 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
714 items.push_back (CheckMenuElem ((*i)->name ()));
715 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
716 c->set_active ((*i)->visible ());
717 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
724 ProcessorEntry::toggle_inline_display_visibility ()
726 if (_plugin_display->is_visible ()) {
727 _plugin_display->hide();
729 _plugin_display->show();
731 _parent->update_gui_object_state (this);
735 ProcessorEntry::toggle_control_visibility (Control* c)
737 c->set_visible (!c->visible ());
738 _parent->update_gui_object_state (this);
742 ProcessorEntry::build_send_options_menu ()
744 using namespace Menu_Helpers;
745 Menu* menu = manage (new Menu);
746 MenuList& items = menu->items ();
748 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
751 items.push_back (CheckMenuElem (_("Link panner controls")));
752 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
753 c->set_active (send->panner_shell()->is_linked_to_route());
754 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
761 ProcessorEntry::toggle_panner_link ()
763 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
765 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
769 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
771 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
772 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
773 , _slider_persistant_tooltip (&_slider)
774 , _button (ArdourButton::led_default_elements)
775 , _ignore_ui_adjustment (false)
779 _slider.set_controllable (c);
780 box.set_padding(0, 0, 4, 4);
783 _button.set_text (_name);
784 _button.set_led_left (true);
785 _button.set_name ("processor control button");
789 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
790 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
791 // dup. currently timers are used :(
792 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
796 _slider.set_name ("ProcessorControlSlider");
797 _slider.set_text (_name);
802 const ARDOUR::ParameterDescriptor& desc = c->desc();
803 double const lo = c->internal_to_interface(desc.lower);
804 double const up = c->internal_to_interface(desc.upper);
805 double const normal = c->internal_to_interface(desc.normal);
806 double smallstep = desc.smallstep;
807 double largestep = desc.largestep;
809 if (smallstep == 0.0) {
810 smallstep = up / 1000.;
812 smallstep = c->internal_to_interface(desc.lower + smallstep);
815 if (largestep == 0.0) {
816 largestep = up / 40.;
818 largestep = c->internal_to_interface(desc.lower + largestep);
821 _adjustment.set_lower (lo);
822 _adjustment.set_upper (up);
823 _adjustment.set_step_increment (smallstep);
824 _adjustment.set_page_increment (largestep);
825 _slider.set_default_value (normal);
827 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
828 // dup. currently timers are used :(
829 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
832 // yuck, do we really need to do this?
833 // according to c404374 this is only needed for send automation
834 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
839 /* We're providing our own PersistentTooltip */
840 set_no_tooltip_whatsoever (_slider);
843 ProcessorEntry::Control::~Control ()
845 timer_connection.disconnect ();
849 ProcessorEntry::Control::set_tooltip ()
851 boost::shared_ptr<AutomationControl> c = _control.lock ();
858 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
860 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
863 string sm = Gtkmm2ext::markup_escape_text (tmp);
864 _slider_persistant_tooltip.set_tip (sm);
865 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
869 ProcessorEntry::Control::slider_adjusted ()
871 if (_ignore_ui_adjustment) {
875 boost::shared_ptr<AutomationControl> c = _control.lock ();
881 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
886 ProcessorEntry::Control::button_clicked ()
888 boost::shared_ptr<AutomationControl> c = _control.lock ();
894 bool const n = _button.get_active ();
896 c->set_value (n ? 0 : 1, Controllable::NoGroup);
897 _button.set_active (!n);
902 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
910 ProcessorEntry::Control::control_changed ()
912 boost::shared_ptr<AutomationControl> c = _control.lock ();
917 _ignore_ui_adjustment = true;
921 _button.set_active (c->get_value() > 0.5);
924 // as long as rapid timers are used, only update the tooltip
925 // if the value has changed.
926 const double nval = c->internal_to_interface (c->get_value ());
927 if (_adjustment.get_value() != nval) {
928 _adjustment.set_value (nval);
933 _ignore_ui_adjustment = false;
937 ProcessorEntry::Control::add_state (XMLNode* node) const
939 XMLNode* c = new XMLNode (X_("Object"));
940 c->add_property (X_("id"), state_id ());
941 c->add_property (X_("visible"), _visible);
942 node->add_child_nocopy (*c);
946 ProcessorEntry::Control::set_state (XMLNode const * node)
948 XMLNode* n = GUIObjectState::get_node (node, state_id ());
950 XMLProperty const * p = n->property (X_("visible"));
951 set_visible (p && string_is_affirmative (p->value ()));
958 ProcessorEntry::Control::set_visible (bool v)
969 /** Called when the Editor might have re-shown things that
973 ProcessorEntry::Control::hide_things ()
981 ProcessorEntry::Control::state_id () const
983 boost::shared_ptr<AutomationControl> c = _control.lock ();
986 return string_compose (X_("control %1"), c->id().to_s ());
989 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
990 : ProcessorEntry (b, p, w)
993 p->PluginIoReConfigure.connect (
994 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
996 p->PluginMapChanged.connect (
997 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
999 p->PluginConfigChanged.connect (
1000 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1005 PluginInsertProcessorEntry::iomap_changed ()
1007 _parent->setup_routing_feeds ();
1008 routing_icon.queue_draw();
1009 output_routing_icon.queue_draw();
1013 PluginInsertProcessorEntry::hide_things ()
1015 ProcessorEntry::hide_things ();
1018 ProcessorEntry::PortIcon::PortIcon(bool input) {
1020 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1021 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1025 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1027 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1029 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1032 Gtk::Allocation a = get_allocation();
1033 double const width = a.get_width();
1034 double const height = a.get_height();
1036 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1037 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1039 cairo_rectangle (cr, 0, 0, width, height);
1042 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1043 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1044 set_routing_color (cr, i < _ports.n_midi());
1045 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1046 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1054 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1058 set_terminal (false);
1062 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1064 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1066 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1068 set_size_request (-1, h);
1072 ProcessorEntry::RoutingIcon::set (
1073 const ARDOUR::ChanCount& in,
1074 const ARDOUR::ChanCount& out,
1075 const ARDOUR::ChanCount& sinks,
1076 const ARDOUR::ChanCount& sources,
1077 const ARDOUR::ChanMapping& in_map,
1078 const ARDOUR::ChanMapping& out_map,
1079 const ARDOUR::ChanMapping& thru_map)
1087 _thru_map = thru_map;
1091 ProcessorEntry::RoutingIcon::in_identity () const {
1092 if (_thru_map.n_total () > 0) {
1095 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1098 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1105 ProcessorEntry::RoutingIcon::out_identity () const {
1106 if (_thru_map.n_total () > 0) {
1107 // TODO skip if trhu is not connected to any of next's inputs
1110 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1113 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1120 ProcessorEntry::RoutingIcon::can_coalesce () const {
1121 if (_thru_map.n_total () > 0) {
1124 if (_fed_by && _f_out != _f_sources) {
1127 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1134 ProcessorEntry::RoutingIcon::set_fed_by (
1135 const ARDOUR::ChanCount& out,
1136 const ARDOUR::ChanCount& sources,
1137 const ARDOUR::ChanMapping& out_map,
1138 const ARDOUR::ChanMapping& thru_map)
1141 _f_sources = sources;
1142 _f_out_map = out_map;
1143 _f_thru_map = thru_map;
1148 ProcessorEntry::RoutingIcon::set_feeding (
1149 const ARDOUR::ChanCount& in,
1150 const ARDOUR::ChanCount& sinks,
1151 const ARDOUR::ChanMapping& in_map,
1152 const ARDOUR::ChanMapping& thru_map)
1157 _i_thru_map = thru_map;
1162 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1164 if (!midi) { i += n_midi; }
1167 return rint (width * .5) +.5;
1169 return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1173 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1175 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1176 const double y1 = rint (height * .66) + .5;
1179 cairo_translate (cr, x0, y0);
1180 cairo_move_to (cr, 0, height);
1181 cairo_line_to (cr, 0, y1);
1182 cairo_move_to (cr, 0 - dx, y1);
1183 cairo_line_to (cr, 0 + dx, y1);
1185 set_routing_color (cr, midi);
1186 cairo_set_line_width (cr, 1.0);
1192 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1194 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1195 const double y1 = rint (height * .5) - .5;
1198 cairo_translate (cr, x0, y0);
1199 cairo_move_to (cr, 0 - dx, height);
1200 cairo_line_to (cr, 0, y1);
1201 cairo_line_to (cr, 0 + dx, height);
1202 cairo_close_path (cr);
1204 set_routing_color (cr, midi);
1210 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1212 const double rad = 1;
1213 const double y1 = height - rad - 1.5;
1215 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1216 cairo_move_to (cr, x0, y0 + height - 1.5);
1217 cairo_line_to (cr, x0, y0 + height);
1218 set_routing_color (cr, midi);
1219 cairo_set_line_width (cr, 1.0);
1224 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1226 const double rad = 1;
1227 const double y1 = rad + 1;
1229 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1230 cairo_move_to (cr, x0, y0);
1231 cairo_line_to (cr, x0, y0 + 1);
1232 set_routing_color (cr, midi);
1233 cairo_set_line_width (cr, 1.0);
1238 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1240 double bz = abs (y1 - y0);
1242 cairo_move_to (cr, x0, y0);
1243 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1244 cairo_set_line_width (cr, 1.0);
1245 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1246 cairo_set_source_rgb (cr, 1, 0, 0);
1248 const double dashes[] = { 2, 3 };
1249 cairo_set_dash (cr, dashes, 2, 0);
1251 set_routing_color (cr, midi);
1254 cairo_set_dash (cr, 0, 0, 0);
1259 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1261 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1263 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1266 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1268 Gtk::Allocation a = get_allocation();
1269 double const width = a.get_width();
1270 double const height = a.get_height();
1272 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1273 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1275 cairo_rectangle (cr, 0, 0, width, height);
1279 if (can_coalesce ()) {
1280 expose_coalesced_input_map (cr, width, height);
1282 expose_input_map (cr, width, height);
1285 expose_output_map (cr, width, height);
1293 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1295 const uint32_t pc_in = _sinks.n_total();
1296 const uint32_t pc_in_midi = _sinks.n_midi();
1298 for (uint32_t i = 0; i < pc_in; ++i) {
1299 const bool is_midi = i < pc_in_midi;
1301 uint32_t pn = is_midi ? i : i - pc_in_midi;
1302 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1303 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1305 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1306 draw_gnd (cr, x, 0, height, is_midi);
1309 if (idx >= _in.get (dt)) {
1310 // side-chain, probably
1311 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1312 draw_sidechain (cr, x, 0, height, is_midi);
1316 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1320 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1322 double x = pin_x_pos (i, width, pc_in, 0, false);
1324 _f_thru_map.get (dt, idx, &valid_thru);
1326 draw_thru_src (cr, x, 0, height, is_midi);
1328 draw_gnd (cr, x, 0, height, is_midi);
1332 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1334 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1336 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1341 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1343 const uint32_t n_in = _in.n_total();
1344 const uint32_t n_in_midi = _in.n_midi();
1345 const uint32_t pc_in = _sinks.n_total();
1346 const uint32_t pc_in_midi = _sinks.n_midi();
1348 // draw inputs to this
1349 for (uint32_t i = 0; i < pc_in; ++i) {
1350 const bool is_midi = i < pc_in_midi;
1352 uint32_t pn = is_midi ? i : i - pc_in_midi;
1353 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1354 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1355 // check if it's fed
1356 bool valid_src = true;
1357 if (valid_in && idx < _in.get (dt) && _fed_by) {
1360 _f_out_map.get_src (dt, idx, &valid_out);
1361 _f_thru_map.get (dt, idx, &valid_thru);
1362 if (!valid_out && !valid_thru) {
1366 if (!valid_in || !valid_src) {
1367 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1368 draw_gnd (cr, x, 0, height, is_midi);
1371 if (idx >= _in.get (dt)) {
1372 // side-chain, probably
1373 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1374 draw_sidechain (cr, x, 0, height, is_midi);
1377 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1378 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1379 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1382 // draw reverse thru
1383 for (uint32_t i = 0; i < n_in; ++i) {
1384 const bool is_midi = i < n_in_midi;
1386 uint32_t pn = is_midi ? i : i - n_in_midi;
1387 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1388 _thru_map.get_src (dt, pn, &valid_thru);
1392 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1393 draw_thru_sink (cr, x, 0, height, is_midi);
1398 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1400 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1401 double ht = _terminal ? height - dh : height;
1403 // draw outputs of this
1404 const uint32_t pc_out = _sources.n_total();
1405 const uint32_t pc_out_midi = _sources.n_midi();
1406 const uint32_t n_out = _out.n_total();
1407 const uint32_t n_out_midi = _out.n_midi();
1409 for (uint32_t i = 0; i < pc_out; ++i) {
1410 const bool is_midi = i < pc_out_midi;
1412 uint32_t pn = is_midi ? i : i - pc_out_midi;
1413 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1414 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1418 // skip connections that are not used in the next's input
1420 bool valid_thru, valid_sink;
1421 _i_in_map.get_src (dt, idx, &valid_sink);
1422 _i_thru_map.get_src (dt, idx, &valid_thru);
1423 if (!valid_thru && !valid_sink) {
1424 if (!is_midi || i != 0) { // special case midi-bypass
1429 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1430 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1431 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1434 for (uint32_t i = 0; i < n_out; ++i) {
1435 const bool is_midi = i < n_out_midi;
1436 uint32_t pn = is_midi ? i : i - n_out_midi;
1437 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1438 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1441 bool valid_thru_f = false;
1442 // skip connections that are not used in the next's input
1445 _i_in_map.get_src (dt, pn, &valid_sink);
1446 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1447 if (!valid_thru_f && !valid_sink) {
1448 if (!is_midi || i != 0) { // special case midi-bypass
1455 _out_map.get_src (dt, pn, &valid_src);
1458 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1460 if (idx >= _in.get (dt)) {
1461 draw_sidechain (cr, x, 0, height, is_midi);
1463 draw_thru_src (cr, x, 0, height, is_midi);
1465 } else if (valid_thru_f){
1466 // gnd is part of input, unless it's a thru input
1467 // (also only true if !coalesced into one small display)
1468 draw_gnd (cr, x, 0, height, is_midi);
1472 // terminal node, add arrows
1474 _out_map.get_src (dt, pn, &valid_src);
1477 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1479 if (idx >= _in.get (dt)) {
1480 draw_sidechain (cr, x, 0, height - dh, is_midi);
1482 draw_thru_src (cr, x, 0, height - dh, is_midi);
1485 draw_gnd (cr, x, 0, height - dh, is_midi);
1489 set_routing_color (cr, is_midi);
1490 cairo_set_line_width (cr, 1.0);
1491 cairo_move_to (cr, x, height - dh);
1492 cairo_line_to (cr, x, height - 2);
1495 const double ar = dh - 1;
1496 cairo_move_to (cr, x - ar, height - ar);
1497 cairo_line_to (cr, x , height - .5);
1498 cairo_line_to (cr, x + ar, height - ar);
1499 cairo_line_to (cr, x , height - ar * .5);
1500 cairo_close_path (cr);
1501 cairo_fill_preserve (cr);
1507 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1510 , _max_height (max_height)
1514 set_name ("processor prefader");
1515 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1516 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1519 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1522 cairo_surface_destroy (_surf);
1527 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1530 req->height = _cur_height;
1535 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1537 /* work-around scroll-bar + aspect ratio
1538 * show inline-view -> height changes -> scrollbar gets added
1539 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1540 * -> scroll bar is removed [-> width changes ; repeat ]
1542 uint32_t shm = std::min (_max_height, inline_height);
1544 Gtk::Container* pr = get_parent();
1545 for (uint32_t i = 0; i < 4 && pr; ++i) {
1546 // VBox, EventBox, ViewPort, ScrolledWindow
1547 pr = pr->get_parent();
1549 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1551 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1552 sc = vsb && vsb->is_visible();
1555 if (shm != _cur_height) {
1556 if (_scroll == sc || _cur_height < shm) {
1565 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1567 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1572 /* allocate a local image-surface,
1573 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1574 * since pixman keeps a reference to it.
1575 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1576 * it might be possible to work around via cairo_surface_set_user_data().
1579 || dis->width != cairo_image_surface_get_width (_surf)
1580 || dis->height != cairo_image_surface_get_height (_surf)
1583 cairo_surface_destroy (_surf);
1585 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1588 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1589 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1591 unsigned char *src = dis->data;
1592 unsigned char *dst = cairo_image_surface_get_data (_surf);
1593 const int dst_stride = cairo_image_surface_get_stride (_surf);
1594 for (int y = 0; y < dis->height; ++y) {
1595 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1601 cairo_surface_mark_dirty(_surf);
1602 const double xc = floor ((width - dis->width) * .5);
1603 cairo_set_source_surface(cr, _surf, xc, 0);
1610 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1612 Gtk::Allocation a = get_allocation();
1613 double const width = a.get_width();
1614 double const height = a.get_height();
1616 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1617 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1620 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1621 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1622 cairo_rectangle (cr, 0, 0, width, height);
1626 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1627 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1629 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1631 uint32_t ht = render_inline (cr, width);
1636 if (_cur_height != 1) {
1643 update_height_alloc (ht);
1646 bool failed = false;
1647 std::string name = get_name();
1648 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1650 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1651 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1652 cairo_set_line_width(cr, 1.0);
1653 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1660 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1661 : PluginDisplay (p, max_height)
1663 , _lua_render_inline (0)
1665 p->setup_lua_inline_gui (&lua_gui);
1667 lua_State* LG = lua_gui.getState ();
1668 LuaInstance::bind_cairo (LG);
1669 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1670 assert (lua_render.isFunction ());
1671 _lua_render_inline = new luabridge::LuaRef (lua_render);
1674 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1676 delete (_lua_render_inline);
1680 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1682 Cairo::Context ctx (cr);
1684 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1685 if (rv.isTable ()) {
1689 } catch (luabridge::LuaException const& e) {
1696 static std::list<Gtk::TargetEntry> drop_targets()
1698 std::list<Gtk::TargetEntry> tmp;
1699 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1700 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1701 tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1705 static std::list<Gtk::TargetEntry> drag_targets()
1707 std::list<Gtk::TargetEntry> tmp;
1708 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1709 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1713 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1715 std::list<Gtk::TargetEntry> tmp;
1716 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1720 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1721 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1722 : _parent_strip (parent)
1723 , _owner_is_mixer (owner_is_mixer)
1724 , ab_direction (true)
1725 , _get_plugin_selector (get_plugin_selector)
1727 , _visible_prefader_processors (0)
1728 , _rr_selection(rsel)
1729 , processor_display (drop_targets())
1730 , _redisplay_pending (false)
1734 /* ProcessorBox actions and bindings created statically by call to
1735 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1736 * are available for context menus.
1739 processor_display.set_data ("ardour-bindings", bindings);
1743 no_processor_redisplay = false;
1745 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1746 processor_scroller.add (processor_display);
1747 pack_start (processor_scroller, true, true);
1749 processor_display.set_flags (CAN_FOCUS);
1750 processor_display.set_name ("ProcessorList");
1751 processor_display.set_data ("processorbox", this);
1752 processor_display.set_size_request (48, -1);
1753 processor_display.set_spacing (0);
1755 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1756 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1758 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1759 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1761 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1762 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1763 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1765 processor_scroller.show ();
1766 processor_display.show ();
1769 parent->DeliveryChanged.connect (
1770 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1774 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1777 ProcessorBox::~ProcessorBox ()
1779 /* it may appear as if we should delete processor_menu but that is a
1780 * pointer to a widget owned by the UI Manager, and has potentially
1781 * be returned to many other ProcessorBoxes. GTK doesn't really make
1782 * clear the ownership of this widget, which is a menu and thus is
1783 * never packed into any container other than an implict GtkWindow.
1785 * For now, until or if we ever get clarification over the ownership
1786 * story just let it continue to exist. At worst, its a small memory leak.
1791 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1797 _route_connections.drop_connections();
1799 /* new route: any existing block on processor redisplay must be meaningless */
1800 no_processor_redisplay = false;
1803 _route->processors_changed.connect (
1804 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1807 _route->DropReferences.connect (
1808 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1811 _route->PropertyChanged.connect (
1812 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1815 redisplay_processors ();
1819 ProcessorBox::route_going_away ()
1821 /* don't keep updating display as processors are deleted */
1822 no_processor_redisplay = true;
1826 boost::shared_ptr<Processor>
1827 ProcessorBox::find_drop_position (ProcessorEntry* position)
1829 boost::shared_ptr<Processor> p;
1831 p = position->processor ();
1833 /* dropped on the blank entry (which will be before the
1834 fader), so use the first non-blank child as our
1835 `dropped on' processor */
1836 list<ProcessorEntry*> c = processor_display.children ();
1837 list<ProcessorEntry*>::iterator i = c.begin ();
1839 assert (i != c.end ());
1840 p = (*i)->processor ();
1848 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1850 const void * d = data.get_data();
1851 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1853 PluginPresetList nfos;
1855 tv->get_object_drag_data (nfos, &source);
1857 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1858 PluginPresetPtr ppp = (*i);
1859 PluginInfoPtr pip = ppp->_pip;
1860 PluginPtr p = pip->load (*_session);
1865 if (ppp->_preset.valid) {
1866 p->load_preset (ppp->_preset);
1869 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1870 if (Config->get_new_plugins_active ()) {
1871 processor->activate ();
1873 pl.push_back (processor);
1878 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1880 const void * d = data.get_data();
1881 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1882 PluginInfoList nfos;
1885 tv->get_object_drag_data (nfos, &source);
1887 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1888 PluginPtr p = (*i)->load (*_session);
1892 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1893 if (Config->get_new_plugins_active ()) {
1894 processor->activate ();
1896 pl.push_back (processor);
1901 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1907 boost::shared_ptr<Processor> p = find_drop_position (position);
1908 Route::ProcessorList pl;
1910 if (data.get_target() == "PluginInfoPtr") {
1911 _drop_plugin (data, pl);
1913 else if (data.get_target() == "PluginFavoritePtr") {
1914 _drop_plugin_preset (data, pl);
1920 Route::ProcessorStreams err;
1921 if (_route->add_processors (pl, p, &err)) {
1923 "Processor Drag/Drop failed. Probably because\n\
1924 the I/O configuration of the plugins could\n\
1925 not match the configuration of this track.");
1926 MessageDialog am (msg);
1932 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1934 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1935 list<ProcessorEntry*> children = source->selection ();
1936 assert (children.size() == 1);
1937 ProcessorEntry* other = *children.begin();
1938 assert (other->can_copy_state (position));
1939 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1940 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1941 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1942 assert (otherproc && proc && pi);
1944 PBD::ID id = pi->id();
1945 XMLNode& state = otherproc->get_state ();
1946 /* strip side-chain state (processor inside processor must be a side-chain)
1947 * otherwise we'll end up with duplicate ports-names.
1948 * (this needs a better solution which retains connections)
1950 state.remove_nodes ("Processor");
1951 proc->set_state (state, Stateful::loading_state_version);
1952 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1956 boost::shared_ptr<Processor> p = find_drop_position (position);
1958 list<ProcessorEntry*> children = source->selection ();
1959 list<boost::shared_ptr<Processor> > procs;
1960 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1961 if ((*i)->processor ()) {
1962 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1965 procs.push_back ((*i)->processor ());
1969 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1970 XMLNode& state = (*i)->get_state ();
1972 nlist.push_back (&state);
1973 paste_processor_state (nlist, p);
1977 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1981 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1982 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1984 other->delete_dragged_processors (procs);
1990 ProcessorBox::set_width (Width w)
1998 list<ProcessorEntry*> children = processor_display.children ();
1999 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2000 (*i)->set_enum_width (w);
2007 ProcessorBox::build_possible_aux_menu ()
2009 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2012 /* No aux sends if there are no busses */
2016 if (_route->is_monitor ()) {
2020 using namespace Menu_Helpers;
2021 Menu* menu = manage (new Menu);
2022 MenuList& items = menu->items();
2024 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2025 if (!_route->internal_send_for (*r) && *r != _route) {
2026 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2034 ProcessorBox::show_processor_menu (int arg)
2036 if (processor_menu == 0) {
2037 processor_menu = build_processor_menu ();
2038 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2041 /* Sort out the plugin submenu */
2043 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2045 if (plugin_menu_item) {
2046 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2049 /* And the aux submenu */
2051 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2053 if (aux_menu_item) {
2054 Menu* m = build_possible_aux_menu();
2055 if (m && !m->items().empty()) {
2056 aux_menu_item->set_submenu (*m);
2057 aux_menu_item->set_sensitive (true);
2059 /* stupid gtkmm: we need to pass a null reference here */
2060 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2061 aux_menu_item->set_sensitive (false);
2065 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2066 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2068 ProcessorEntry* single_selection = 0;
2069 if (processor_display.selection().size() == 1) {
2070 single_selection = processor_display.selection().front();
2073 /* And the controls submenu */
2075 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2077 if (controls_menu_item) {
2078 if (single_selection) {
2079 Menu* m = single_selection->build_controls_menu ();
2080 if (m && !m->items().empty()) {
2081 controls_menu_item->set_submenu (*m);
2082 controls_menu_item->set_sensitive (true);
2084 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2085 controls_menu_item->set_sensitive (false);
2088 controls_menu_item->set_sensitive (false);
2093 if (!ARDOUR::Profile->get_mixbus()) {
2094 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2095 if (send_menu_item) {
2096 if (single_selection && !_route->is_monitor()) {
2097 Menu* m = single_selection->build_send_options_menu ();
2098 if (m && !m->items().empty()) {
2099 send_menu_item->set_submenu (*m);
2100 send_menu_item->set_sensitive (true);
2102 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2103 send_menu_item->set_sensitive (false);
2106 send_menu_item->set_sensitive (false);
2111 /* Sensitise actions as approprioate */
2114 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2116 paste_action->set_sensitive (!_rr_selection.processors.empty());
2117 cut_action->set_sensitive (sensitive && can_cut ());
2118 copy_action->set_sensitive (sensitive);
2119 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2121 edit_action->set_sensitive (one_processor_can_be_edited ());
2122 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2124 boost::shared_ptr<PluginInsert> pi;
2125 if (single_selection) {
2126 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2129 manage_pins_action->set_sensitive (pi != 0);
2131 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2132 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2134 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2135 rename_action->set_sensitive (single_selection
2137 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2138 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2140 processor_menu->popup (1, arg);
2142 /* Add a placeholder gap to the processor list to indicate where a processor would be
2143 inserted were one chosen from the menu.
2146 processor_display.get_pointer (x, y);
2147 _placement = processor_display.add_placeholder (y);
2149 if (_visible_prefader_processors == 0 && _placement > 0) {
2155 ProcessorBox::enter_notify (GdkEventCrossing*)
2157 processor_display.grab_focus ();
2158 _current_processor_box = this;
2163 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2165 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2169 Widget* top = get_toplevel();
2171 if (top->is_toplevel()) {
2172 Window* win = dynamic_cast<Window*> (top);
2173 gtk_window_set_focus (win->gobj(), 0);
2180 ProcessorBox::processor_operation (ProcessorOperation op)
2182 ProcSelection targets;
2184 get_selected_processors (targets);
2186 /* if (targets.empty()) {
2189 processor_display.get_pointer (x, y);
2191 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2193 if (pointer.first && pointer.first->processor()) {
2194 targets.push_back (pointer.first->processor ());
2199 if ((op == ProcessorsDelete) && targets.empty()) {
2200 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2204 case ProcessorsSelectAll:
2205 processor_display.select_all ();
2208 case ProcessorsSelectNone:
2209 processor_display.select_none ();
2212 case ProcessorsCopy:
2213 copy_processors (targets);
2217 cut_processors (targets);
2220 case ProcessorsPaste:
2221 // some processors are not selectable (e.g fader, meter), target is empty.
2222 if (targets.empty() && _placement >= 0) {
2224 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2226 targets.push_back (proc);
2229 if (targets.empty()) {
2230 paste_processors ();
2232 paste_processors (targets.front());
2236 case ProcessorsDelete:
2237 delete_processors (targets);
2240 case ProcessorsToggleActive:
2241 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2242 if ((*i)->active()) {
2243 (*i)->deactivate ();
2261 ProcessorWindowProxy*
2262 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2264 return processor->window_proxy();
2269 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2271 boost::shared_ptr<Processor> processor;
2273 processor = child->processor ();
2277 bool selected = processor_display.selected (child);
2279 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2281 if (_session->engine().connected()) {
2282 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2284 if (!one_processor_can_be_edited ()) {
2288 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2289 generic_edit_processor (processor);
2291 edit_processor (processor);
2297 } else if (Keyboard::is_context_menu_event (ev)) {
2299 show_processor_menu (ev->time);
2303 } else if (processor && ev->button == 1 && selected) {
2305 // this is purely informational but necessary for route params UI
2306 ProcessorSelected (processor); // emit
2308 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2311 _get_plugin_selector()->show_manager ();
2318 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2320 boost::shared_ptr<Processor> processor;
2322 processor = child->processor ();
2325 if (processor && Keyboard::is_delete_event (ev)) {
2327 Glib::signal_idle().connect (sigc::bind (
2328 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2329 boost::weak_ptr<Processor>(processor)));
2331 } else if (processor && Keyboard::is_button2_event (ev)
2333 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2337 /* button2-click with no/appropriate modifiers */
2339 if (processor->active()) {
2340 processor->deactivate ();
2342 processor->activate ();
2350 ProcessorBox::build_processor_menu ()
2352 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2353 processor_menu->set_name ("ArdourContextMenu");
2354 return processor_menu;
2358 ProcessorBox::select_all_processors ()
2360 processor_display.select_all ();
2364 ProcessorBox::deselect_all_processors ()
2366 processor_display.select_none ();
2370 ProcessorBox::choose_plugin ()
2372 _get_plugin_selector()->set_interested_object (*this);
2375 /** @return true if an error occurred, otherwise false */
2377 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2379 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2381 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2383 Route::ProcessorStreams err_streams;
2385 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2386 weird_plugin_dialog (**p, err_streams);
2388 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2389 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2390 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2392 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2393 if ((*p)->has_editor ()) {
2394 edit_processor (processor);
2396 generic_edit_processor (processor);
2406 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2408 ArdourDialog dialog (_("Plugin Incompatibility"));
2411 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2412 p.name(), streams.index);
2414 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2415 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2417 text += _("\nThis plugin has:\n");
2419 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2420 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2423 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2424 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2427 text += _("\nbut at the insertion point, there are:\n");
2429 uint32_t const n = streams.count.n_midi ();
2430 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2433 uint32_t const n = streams.count.n_audio ();
2434 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2437 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2438 label.set_text(text);
2440 dialog.get_vbox()->pack_start (label);
2441 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2443 dialog.set_name (X_("PluginIODialog"));
2444 dialog.set_modal (true);
2451 ProcessorBox::choose_insert ()
2453 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2454 _route->add_processor_by_index (processor, _placement);
2457 /* Caller must not hold process lock */
2459 ProcessorBox::choose_send ()
2461 boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2463 /* make an educated guess at the initial number of outputs for the send */
2464 ChanCount outs = (_session->master_out())
2465 ? _session->master_out()->n_outputs()
2466 : _route->n_outputs();
2468 /* XXX need processor lock on route */
2470 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2471 send->output()->ensure_io (outs, false, this);
2472 } catch (AudioEngine::PortRegistrationFailure& err) {
2473 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2477 /* let the user adjust the IO setup before creation.
2479 Note: this dialog is NOT modal - we just leave it to run and it will
2480 return when its Finished signal is emitted - typically when the window
2484 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2487 /* keep a reference to the send so it doesn't get deleted while
2488 the IOSelectorWindow is doing its stuff
2490 _processor_being_created = send;
2492 ios->selector().Finished.connect (sigc::bind (
2493 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2494 boost::weak_ptr<Processor>(send), ios));
2499 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2501 boost::shared_ptr<Processor> processor (weak_processor.lock());
2503 /* drop our temporary reference to the new send */
2504 _processor_being_created.reset ();
2511 case IOSelector::Cancelled:
2512 // processor will go away when all shared_ptrs to it vanish
2515 case IOSelector::Accepted:
2516 _route->add_processor_by_index (processor, _placement);
2520 delete_when_idle (ios);
2524 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2526 boost::shared_ptr<Processor> processor (weak_processor.lock());
2528 /* drop our temporary reference to the new return */
2529 _processor_being_created.reset ();
2536 case IOSelector::Cancelled:
2537 // processor will go away when all shared_ptrs to it vanish
2540 case IOSelector::Accepted:
2541 _route->add_processor_by_index (processor, _placement);
2545 delete_when_idle (ios);
2549 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2555 boost::shared_ptr<Route> target = wr.lock();
2561 _session->add_internal_send (target, _placement, _route);
2565 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2567 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2568 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2572 redisplay_processors ();
2576 ProcessorBox::redisplay_processors ()
2578 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2581 if (no_processor_redisplay) {
2585 processor_display.clear ();
2587 _visible_prefader_processors = 0;
2590 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2591 &_visible_prefader_processors, &fader_seen));
2593 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2594 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2595 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2597 setup_entry_positions ();
2600 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2601 * not already have one.
2604 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2606 boost::shared_ptr<Processor> p = w.lock ();
2610 if (p->window_proxy()) {
2614 /* not on the list; add it */
2617 #if 0 // is this still needed? Why?
2618 if (_parent_strip) {
2619 if (_parent_strip->mixer_owned()) {
2631 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2632 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2636 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2639 wp->set_state (*ui_xml, 0);
2642 void* existing_ui = p->get_ui ();
2645 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2648 p->set_window_proxy (wp);
2649 WM::Manager::instance().register_window (wp);
2653 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2655 boost::shared_ptr<Processor> p = w.lock ();
2656 if (!p || p->pinmgr_proxy ()) {
2660 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2661 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2662 wp->set_session (_session);
2664 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2666 wp->set_state (*ui_xml, 0);
2669 p->set_pingmgr_proxy (wp);
2670 WM::Manager::instance().register_window (wp);
2673 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2675 boost::shared_ptr<Processor> processor (p.lock ());
2677 if (processor && ( processor->display_to_user()
2679 || show_all_processors
2684 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2685 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2696 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2698 boost::shared_ptr<Processor> processor (p.lock ());
2700 if (!processor || ( !processor->display_to_user()
2702 && !show_all_processors
2709 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2711 ProcessorEntry* e = 0;
2712 if (plugin_insert) {
2713 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2715 e = new ProcessorEntry (this, processor, _width);
2718 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2719 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2720 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2722 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2723 if (!send && !plugin_insert && !ext && !stub)
2724 e->set_selectable(false);
2726 bool mark_send_visible = false;
2727 if (send && _parent_strip) {
2728 /* show controls of new sends by default */
2729 GUIObjectState& st = _parent_strip->gui_object_state ();
2730 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2732 /* check if state exists, if not it must be a new send */
2733 if (!st.get_node(strip, e->state_id())) {
2734 mark_send_visible = true;
2738 /* Set up this entry's state from the GUIObjectState */
2739 XMLNode* proc = entry_gui_object_state (e);
2741 e->set_control_state (proc);
2744 if (mark_send_visible) {
2745 e->show_all_controls ();
2750 && !plugin_insert->plugin(0)->is_channelstrip()
2754 processor_display.add_child (e, drag_targets());
2756 processor_display.add_child (e, drag_targets_noplugin());
2761 ProcessorBox::reordered ()
2763 compute_processor_sort_keys ();
2764 setup_entry_positions ();
2768 ProcessorBox::setup_routing_feeds ()
2770 list<ProcessorEntry*> children = processor_display.children ();
2771 /* first set the i/o maps for every processor */
2772 list<ProcessorEntry*>::iterator prev = children.begin();
2774 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2775 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2776 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2778 list<ProcessorEntry*>::iterator next = i;
2782 ChanCount sinks = pi->natural_input_streams ();
2783 ChanCount sources = pi->natural_output_streams ();
2784 uint32_t count = pi->get_count ();
2786 pi->configured_io (in, out);
2788 ChanCount midi_thru;
2789 ChanCount midi_bypass;
2790 ChanMapping input_map (pi->input_map ());
2791 if (pi->has_midi_thru ()) {
2792 midi_thru.set(DataType::MIDI, 1);
2793 input_map.set (DataType::MIDI, 0, 0);
2795 if (pi->has_midi_bypass ()) {
2796 midi_bypass.set(DataType::MIDI, 1);
2799 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2800 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2802 (*i)->routing_icon.set (
2804 sinks * count + midi_thru,
2805 sources * count + midi_bypass,
2810 if (next != children.end()) {
2811 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2812 pi->output_map (), pi->thru_map ());
2816 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2817 pi->input_map (), pi->thru_map ());
2821 (*i)->input_icon.set_ports (p->input_streams());
2822 (*i)->output_icon.set_ports (p->output_streams());
2823 ChanMapping inmap (p->input_streams ());
2824 ChanMapping outmap (p->input_streams ());
2825 ChanMapping thrumap;
2826 (*i)->routing_icon.set (
2828 p->output_streams(),
2830 p->output_streams(),
2831 inmap, outmap, thrumap);
2833 if (next != children.end()) {
2834 (*next)->routing_icon.set_fed_by (
2835 p->output_streams(),
2836 p->output_streams(),
2840 (*prev)->routing_icon.set_feeding (
2842 p->output_streams(),
2847 if (i == children.begin()) {
2848 (*i)->routing_icon.unset_fed_by ();
2851 (*i)->input_icon.hide();
2854 /* now set which icons need to be displayed */
2855 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2856 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2858 if ((*i)->routing_icon.in_identity ()) {
2859 (*i)->routing_icon.hide();
2860 if (i == children.begin()) {
2861 (*i)->input_icon.show();
2864 (*i)->routing_icon.show();
2865 (*i)->routing_icon.queue_draw();
2866 (*i)->input_icon.show();
2869 list<ProcessorEntry*>::iterator next = i;
2870 if (++next == children.end()) {
2871 // last processor in the chain
2872 (*i)->output_routing_icon.set_terminal(true);
2873 (*i)->output_routing_icon.unset_feeding ();
2874 if ((*i)->routing_icon.out_identity ()) {
2875 (*i)->output_routing_icon.hide();
2877 (*i)->output_routing_icon.show();
2878 (*i)->output_routing_icon.queue_draw();
2881 (*i)->output_routing_icon.set_terminal(false);
2882 if (!(*i)->routing_icon.out_identity ()
2883 && !(*i)->routing_icon.in_identity ()
2884 && (*i)->routing_icon.can_coalesce ()) {
2885 (*i)->output_routing_icon.hide();
2886 } else if (!(*i)->routing_icon.out_identity ()) {
2887 (*i)->output_routing_icon.show();
2888 (*i)->output_routing_icon.queue_draw();
2889 (*next)->input_icon.show();
2891 (*i)->output_routing_icon.hide();
2898 ProcessorBox::setup_entry_positions ()
2900 list<ProcessorEntry*> children = processor_display.children ();
2901 bool pre_fader = true;
2904 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2905 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2906 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2908 (*i)->set_position (ProcessorEntry::Fader, num++);
2911 (*i)->set_position (ProcessorEntry::PreFader, num++);
2913 (*i)->set_position (ProcessorEntry::PostFader, num++);
2917 setup_routing_feeds ();
2921 ProcessorBox::compute_processor_sort_keys ()
2923 list<ProcessorEntry*> children = processor_display.children ();
2924 Route::ProcessorList our_processors;
2926 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2927 if ((*i)->processor()) {
2928 our_processors.push_back ((*i)->processor ());
2932 if (_route->reorder_processors (our_processors)) {
2933 /* Reorder failed, so report this to the user. As far as I can see this must be done
2934 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2935 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2936 when the drag is torn down after this handler function is finished.
2938 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2943 ProcessorBox::report_failed_reorder ()
2945 /* reorder failed, so redisplay */
2947 redisplay_processors ();
2949 /* now tell them about the problem */
2951 ArdourDialog dialog (_("Plugin Incompatibility"));
2954 label.set_text (_("\
2955 You cannot reorder these plugins/sends/inserts\n\
2956 in that way because the inputs and\n\
2957 outputs will not work correctly."));
2959 dialog.get_vbox()->set_border_width (12);
2960 dialog.get_vbox()->pack_start (label);
2961 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2963 dialog.set_name (X_("PluginIODialog"));
2964 dialog.set_modal (true);
2971 ProcessorBox::rename_processors ()
2973 ProcSelection to_be_renamed;
2975 get_selected_processors (to_be_renamed);
2977 if (to_be_renamed.empty()) {
2981 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2982 rename_processor (*i);
2987 ProcessorBox::can_cut () const
2989 vector<boost::shared_ptr<Processor> > sel;
2991 get_selected_processors (sel);
2993 /* cut_processors () does not cut inserts */
2995 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
2997 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
2998 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
2999 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3008 ProcessorBox::stub_processor_selected () const
3010 vector<boost::shared_ptr<Processor> > sel;
3012 get_selected_processors (sel);
3014 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3015 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3024 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3026 if (to_be_removed.empty()) {
3030 XMLNode* node = new XMLNode (X_("cut"));
3031 Route::ProcessorList to_cut;
3033 no_processor_redisplay = true;
3034 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3035 // Cut only plugins, sends and returns
3036 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3037 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3038 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3040 Window* w = get_processor_ui (*i);
3046 XMLNode& child ((*i)->get_state());
3047 node->add_child_nocopy (child);
3048 to_cut.push_back (*i);
3052 if (_route->remove_processors (to_cut) != 0) {
3054 no_processor_redisplay = false;
3058 _rr_selection.set (node);
3060 no_processor_redisplay = false;
3061 redisplay_processors ();
3065 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3067 if (to_be_copied.empty()) {
3071 XMLNode* node = new XMLNode (X_("copy"));
3073 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3074 // Copy only plugins, sends, returns
3075 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3076 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3077 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3078 node->add_child_nocopy ((*i)->get_state());
3082 _rr_selection.set (node);
3086 ProcessorBox::delete_processors (const ProcSelection& targets)
3088 if (targets.empty()) {
3092 no_processor_redisplay = true;
3094 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3096 Window* w = get_processor_ui (*i);
3102 _route->remove_processor(*i);
3105 no_processor_redisplay = false;
3106 redisplay_processors ();
3110 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3112 list<boost::shared_ptr<Processor> >::const_iterator x;
3114 no_processor_redisplay = true;
3115 for (x = procs.begin(); x != procs.end(); ++x) {
3117 Window* w = get_processor_ui (*x);
3123 _route->remove_processor(*x);
3126 no_processor_redisplay = false;
3127 redisplay_processors ();
3131 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3133 boost::shared_ptr<Processor> processor (weak_processor.lock());
3139 /* NOT copied to _mixer.selection() */
3141 no_processor_redisplay = true;
3142 _route->remove_processor (processor);
3143 no_processor_redisplay = false;
3144 redisplay_processors ();
3150 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3152 ArdourPrompter name_prompter (true);
3154 name_prompter.set_title (_("Rename Processor"));
3155 name_prompter.set_prompt (_("New name:"));
3156 name_prompter.set_initial_text (processor->name());
3157 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3158 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3159 name_prompter.show_all ();
3161 switch (name_prompter.run ()) {
3163 case Gtk::RESPONSE_ACCEPT:
3164 name_prompter.get_result (result);
3165 if (result.length()) {
3168 string test = result;
3170 while (tries < 100) {
3171 if (_session->io_name_is_legal (test)) {
3177 test = string_compose ("%1-%2", result, tries);
3181 processor->set_name (result);
3184 ARDOUR_UI::instance()->popup_error
3185 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3195 ProcessorBox::paste_processors ()
3197 if (_rr_selection.processors.empty()) {
3201 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3205 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3208 if (_rr_selection.processors.empty()) {
3212 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3216 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3218 XMLNodeConstIterator niter;
3219 list<boost::shared_ptr<Processor> > copies;
3221 if (nlist.empty()) {
3225 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3227 XMLProperty const * type = (*niter)->property ("type");
3228 XMLProperty const * role = (*niter)->property ("role");
3231 boost::shared_ptr<Processor> p;
3233 if (type->value() == "meter" ||
3234 type->value() == "main-outs" ||
3235 type->value() == "amp" ||
3236 type->value() == "intreturn") {
3237 /* do not paste meter, main outs, amp or internal returns */
3240 } else if (type->value() == "intsend") {
3242 /* aux sends are OK, but those used for
3243 * other purposes, are not.
3248 if (role->value() != "Aux") {
3252 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3253 XMLNode n (**niter);
3254 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3255 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3257 IOProcessor::prepare_for_reset (n, s->name());
3259 if (s->set_state (n, Stateful::loading_state_version)) {
3266 } else if (type->value() == "send") {
3268 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3269 XMLNode n (**niter);
3271 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3273 IOProcessor::prepare_for_reset (n, s->name());
3275 if (s->set_state (n, Stateful::loading_state_version)) {
3282 } else if (type->value() == "return") {
3284 XMLNode n (**niter);
3285 Return* r = new Return (*_session);
3287 IOProcessor::prepare_for_reset (n, r->name());
3289 if (r->set_state (n, Stateful::loading_state_version)) {
3296 } else if (type->value() == "port") {
3298 XMLNode n (**niter);
3299 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3301 IOProcessor::prepare_for_reset (n, pi->name());
3303 if (pi->set_state (n, Stateful::loading_state_version)) {
3309 /* XXX its a bit limiting to assume that everything else
3312 p.reset (new PluginInsert (*_session));
3313 /* we can't use RAII Stateful::ForceIDRegeneration
3314 * because that'd void copying the state and wrongly bump
3315 * the state-version counter.
3316 * we need to load the state (incl external files) first and
3317 * only then update the ID)
3319 PBD::ID id = p->id();
3320 /* strip side-chain state (processor inside processor must be a side-chain)
3321 * otherwise we'll end up with duplicate ports-names.
3322 * (this needs a better solution which retains connections)
3323 * We really would want Stateful::ForceIDRegeneration here :(
3325 XMLNode state (**niter);
3326 state.remove_nodes ("Processor");
3328 p->set_state (state, Stateful::current_state_version);
3329 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3332 copies.push_back (p);
3336 error << _("plugin insert constructor failed") << endmsg;
3340 if (copies.empty()) {
3344 if (_route->add_processors (copies, p)) {
3347 "Copying the set of processors on the clipboard failed,\n\
3348 probably because the I/O configuration of the plugins\n\
3349 could not match the configuration of this track.");
3350 MessageDialog am (msg);
3356 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3358 const list<ProcessorEntry*> selection = processor_display.selection ();
3359 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3360 processors.push_back ((*i)->processor ());
3365 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3367 list<ProcessorEntry*> selection = processor_display.selection ();
3368 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3369 (this->*method) ((*i)->processor ());
3374 ProcessorBox::all_visible_processors_active (bool state)
3376 _route->all_visible_processors_active (state);
3380 ProcessorBox::ab_plugins ()
3382 _route->ab_plugins (ab_direction);
3383 ab_direction = !ab_direction;
3388 ProcessorBox::clear_processors ()
3391 vector<string> choices;
3393 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3394 "(this cannot be undone)"), _route->name());
3396 choices.push_back (_("Cancel"));
3397 choices.push_back (_("Yes, remove them all"));
3399 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3401 if (prompter.run () == 1) {
3402 _route->clear_processors (PreFader);
3403 _route->clear_processors (PostFader);
3408 ProcessorBox::clear_processors (Placement p)
3411 vector<string> choices;
3413 if (p == PreFader) {
3414 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3415 "(this cannot be undone)"), _route->name());
3417 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3418 "(this cannot be undone)"), _route->name());
3421 choices.push_back (_("Cancel"));
3422 choices.push_back (_("Yes, remove them all"));
3424 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3426 if (prompter.run () == 1) {
3427 _route->clear_processors (p);
3432 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3434 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3435 if (at && at->freeze_state() == AudioTrack::Frozen) {
3440 boost::dynamic_pointer_cast<Send> (processor) ||
3441 boost::dynamic_pointer_cast<Return> (processor) ||
3442 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3443 boost::dynamic_pointer_cast<PortInsert> (processor)
3452 ProcessorBox::one_processor_can_be_edited ()
3454 list<ProcessorEntry*> selection = processor_display.selection ();
3455 list<ProcessorEntry*>::iterator i = selection.begin();
3456 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3460 return (i != selection.end());
3464 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3466 boost::shared_ptr<Send> send;
3467 boost::shared_ptr<InternalSend> internal_send;
3468 boost::shared_ptr<Return> retrn;
3469 boost::shared_ptr<PluginInsert> plugin_insert;
3470 boost::shared_ptr<PortInsert> port_insert;
3473 /* This method may or may not return a Window, but if it does not it
3474 * will modify the parent mixer strip appearance layout to allow
3475 * "editing" the @param processor that was passed in.
3477 * So for example, if the processor is an Amp (gain), the parent strip
3478 * will be forced back into a model where the fader controls the main gain.
3479 * If the processor is a send, then we map the send controls onto the
3482 * Plugins and others will return a window for control.
3485 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3487 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3492 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3494 if (_parent_strip) {
3495 _parent_strip->revert_to_default_display ();
3498 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3500 if (!_session->engine().connected()) {
3504 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3506 gidget = new SendUIWindow (send, _session);
3509 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3511 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3512 /* no GUI for these */
3516 if (!_session->engine().connected()) {
3520 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3522 ReturnUIWindow *return_ui;
3523 Window* w = get_processor_ui (retrn);
3527 return_ui = new ReturnUIWindow (retrn, _session);
3528 return_ui->set_title (retrn->name ());
3529 set_processor_ui (send, return_ui);
3532 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3537 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3539 PluginUIWindow *plugin_ui;
3541 /* these are both allowed to be null */
3543 Window* w = get_processor_ui (plugin_insert);
3546 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3547 plugin_ui->set_title (generate_processor_title (plugin_insert));
3548 set_processor_ui (plugin_insert, plugin_ui);
3551 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3556 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3558 if (!_session->engine().connected()) {
3559 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3564 PortInsertWindow *io_selector;
3566 Window* w = get_processor_ui (port_insert);
3569 io_selector = new PortInsertWindow (_session, port_insert);
3570 set_processor_ui (port_insert, io_selector);
3573 io_selector = dynamic_cast<PortInsertWindow *> (w);
3576 gidget = io_selector;
3583 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3585 boost::shared_ptr<PluginInsert> plugin_insert
3586 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3588 if (!plugin_insert) {
3592 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3593 win->set_title (generate_processor_title (plugin_insert));
3599 ProcessorBox::register_actions ()
3601 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3603 Glib::RefPtr<Action> act;
3606 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3607 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3609 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3610 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3611 ActionManager::engine_sensitive_actions.push_back (act);
3612 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3613 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3614 ActionManager::engine_sensitive_actions.push_back (act);
3616 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3618 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3619 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3621 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3622 sigc::ptr_fun (ProcessorBox::rb_clear));
3623 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3624 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3625 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3626 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3628 /* standard editing stuff */
3630 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3631 sigc::ptr_fun (ProcessorBox::rb_cut));
3632 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3633 sigc::ptr_fun (ProcessorBox::rb_copy));
3634 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3635 sigc::ptr_fun (ProcessorBox::rb_delete));
3637 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3638 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3639 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3641 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3642 sigc::ptr_fun (ProcessorBox::rb_paste));
3643 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3644 sigc::ptr_fun (ProcessorBox::rb_rename));
3645 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3646 sigc::ptr_fun (ProcessorBox::rb_select_all));
3647 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3648 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3650 /* activation etc. */
3652 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3653 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3654 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3655 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3656 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3657 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3659 manage_pins_action = myactions.register_action (
3660 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3661 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3664 edit_action = myactions.register_action (
3665 processor_box_actions, X_("edit"), _("Edit..."),
3666 sigc::ptr_fun (ProcessorBox::rb_edit));
3668 edit_generic_action = myactions.register_action (
3669 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3670 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3676 ProcessorBox::rb_edit_generic ()
3678 if (_current_processor_box == 0) {
3682 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3686 ProcessorBox::rb_ab_plugins ()
3688 if (_current_processor_box == 0) {
3692 _current_processor_box->ab_plugins ();
3696 ProcessorBox::rb_manage_pins ()
3698 if (_current_processor_box == 0) {
3702 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3705 ProcessorBox::rb_choose_plugin ()
3707 if (_current_processor_box == 0) {
3710 _current_processor_box->choose_plugin ();
3714 ProcessorBox::rb_choose_insert ()
3716 if (_current_processor_box == 0) {
3719 _current_processor_box->choose_insert ();
3723 ProcessorBox::rb_choose_send ()
3725 if (_current_processor_box == 0) {
3728 _current_processor_box->choose_send ();
3732 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3734 if (_current_processor_box == 0) {
3738 _current_processor_box->choose_aux (wr);
3742 ProcessorBox::rb_clear ()
3744 if (_current_processor_box == 0) {
3748 _current_processor_box->clear_processors ();
3753 ProcessorBox::rb_clear_pre ()
3755 if (_current_processor_box == 0) {
3759 _current_processor_box->clear_processors (PreFader);
3764 ProcessorBox::rb_clear_post ()
3766 if (_current_processor_box == 0) {
3770 _current_processor_box->clear_processors (PostFader);
3774 ProcessorBox::rb_cut ()
3776 if (_current_processor_box == 0) {
3780 _current_processor_box->processor_operation (ProcessorsCut);
3784 ProcessorBox::rb_delete ()
3786 if (_current_processor_box == 0) {
3790 _current_processor_box->processor_operation (ProcessorsDelete);
3794 ProcessorBox::rb_copy ()
3796 if (_current_processor_box == 0) {
3799 _current_processor_box->processor_operation (ProcessorsCopy);
3803 ProcessorBox::rb_paste ()
3805 if (_current_processor_box == 0) {
3809 _current_processor_box->processor_operation (ProcessorsPaste);
3813 ProcessorBox::rb_rename ()
3815 if (_current_processor_box == 0) {
3818 _current_processor_box->rename_processors ();
3822 ProcessorBox::rb_select_all ()
3824 if (_current_processor_box == 0) {
3828 _current_processor_box->processor_operation (ProcessorsSelectAll);
3832 ProcessorBox::rb_deselect_all ()
3834 if (_current_processor_box == 0) {
3838 _current_processor_box->deselect_all_processors ();
3842 ProcessorBox::rb_activate_all ()
3844 if (_current_processor_box == 0) {
3848 _current_processor_box->all_visible_processors_active (true);
3852 ProcessorBox::rb_deactivate_all ()
3854 if (_current_processor_box == 0) {
3857 _current_processor_box->all_visible_processors_active (false);
3861 ProcessorBox::rb_edit ()
3863 if (_current_processor_box == 0) {
3867 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3871 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3873 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3877 if (_parent_strip) {
3878 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3879 if (_parent_strip->current_delivery() == send) {
3880 _parent_strip->revert_to_default_display ();
3882 _parent_strip->show_send(send);
3889 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3894 if (edit_aux_send (processor)) {
3898 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3901 proxy->set_custom_ui_mode (true);
3902 proxy->show_the_right_window ();
3907 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3912 if (edit_aux_send (processor)) {
3916 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3919 proxy->set_custom_ui_mode (false);
3920 proxy->show_the_right_window ();
3925 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3930 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3939 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3941 if (!what_changed.contains (ARDOUR::Properties::name)) {
3945 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3947 boost::shared_ptr<Processor> processor;
3948 boost::shared_ptr<PluginInsert> plugin_insert;
3949 boost::shared_ptr<Send> send;
3951 list<ProcessorEntry*> children = processor_display.children();
3953 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3955 processor = (*iter)->processor ();
3961 Window* w = get_processor_ui (processor);
3967 /* rename editor windows for sends and plugins */
3969 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3970 w->set_title (send->name ());
3971 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3972 w->set_title (generate_processor_title (plugin_insert));
3978 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3980 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3981 string::size_type email_pos;
3983 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3984 maker = maker.substr (0, email_pos - 1);
3987 if (maker.length() > 32) {
3988 maker = maker.substr (0, 32);
3992 SessionObject* owner = pi->owner();
3995 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
3997 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4001 /** @param p Processor.
4002 * @return the UI window for \a p.
4005 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4007 ProcessorWindowProxy* wp = p->window_proxy();
4014 /** Make a note of the UI window that a processor is using.
4015 * @param p Processor.
4016 * @param w UI window.
4019 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4021 assert (p->window_proxy());
4023 p->window_proxy()->use_window (*w);
4027 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4029 boost::shared_ptr<Delivery> d = w.lock ();
4034 list<ProcessorEntry*> children = processor_display.children ();
4035 list<ProcessorEntry*>::const_iterator i = children.begin();
4036 while (i != children.end() && (*i)->processor() != d) {
4040 if (i == children.end()) {
4041 processor_display.set_active (0);
4043 processor_display.set_active (*i);
4047 /** Called to repair the damage of Editor::show_window doing a show_all() */
4049 ProcessorBox::hide_things ()
4051 list<ProcessorEntry*> c = processor_display.children ();
4052 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4053 (*i)->hide_things ();
4058 ProcessorBox::processor_menu_unmapped ()
4060 processor_display.remove_placeholder ();
4061 /* make all possibly-desensitized actions sensitive again so that
4062 they be activated by other means (e.g. bindings)
4064 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4068 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4070 if (!_parent_strip) {
4074 GUIObjectState& st = _parent_strip->gui_object_state ();
4076 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4078 return st.get_or_add_node (strip, entry->state_id());
4082 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4084 XMLNode* proc = entry_gui_object_state (entry);
4089 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4090 proc->remove_nodes_and_delete (X_("Object"));
4091 entry->add_control_state (proc);
4095 ProcessorBox::is_editor_mixer_strip() const
4097 return _parent_strip && !_parent_strip->mixer_owned();
4100 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4101 : WM::ProxyBase (name, string())
4102 , _processor_box (box)
4103 , _processor (processor)
4105 , want_custom (false)
4107 boost::shared_ptr<Processor> p = _processor.lock ();
4111 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4114 ProcessorWindowProxy::~ProcessorWindowProxy()
4116 /* processor window proxies do not own the windows they create with
4117 * ::get(), so set _window to null before the normal WindowProxy method
4124 ProcessorWindowProxy::processor_going_away ()
4128 WM::Manager::instance().remove (this);
4129 /* should be no real reason to do this, since the object that would
4130 send DropReferences is about to be deleted, but lets do it anyway.
4132 going_away_connection.disconnect();
4135 ARDOUR::SessionHandlePtr*
4136 ProcessorWindowProxy::session_handle()
4143 ProcessorWindowProxy::get_state ()
4146 node = &ProxyBase::get_state();
4147 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4152 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4154 XMLNodeList children = node.children ();
4155 XMLNodeList::const_iterator i = children.begin ();
4156 while (i != children.end()) {
4157 XMLProperty const * prop = (*i)->property (X_("name"));
4158 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4164 if (i != children.end()) {
4165 XMLProperty const * prop;
4166 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4167 want_custom = PBD::string_is_affirmative (prop->value ());
4171 return ProxyBase::set_state (node, 0);
4175 ProcessorWindowProxy::get (bool create)
4177 boost::shared_ptr<Processor> p = _processor.lock ();
4182 if (_window && (is_custom != want_custom)) {
4183 /* drop existing window - wrong type */
4192 is_custom = want_custom;
4193 _window = _processor_box->get_editor_window (p, is_custom);
4198 _window->show_all ();
4204 ProcessorWindowProxy::show_the_right_window ()
4206 if (_window && (is_custom != want_custom)) {
4207 /* drop existing window - wrong type */
4212 is_custom = want_custom;
4219 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4220 : WM::ProxyBase (name, string())
4221 , _processor (processor)
4223 boost::shared_ptr<Processor> p = _processor.lock ();
4227 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4230 PluginPinWindowProxy::~PluginPinWindowProxy()
4235 ARDOUR::SessionHandlePtr*
4236 PluginPinWindowProxy::session_handle ()
4238 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4239 if (aw) { return aw; }
4244 PluginPinWindowProxy::get (bool create)
4246 boost::shared_ptr<Processor> p = _processor.lock ();
4247 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4256 _window = new PluginPinDialog (pi);
4257 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4259 aw->set_session (_session);
4261 _window->show_all ();
4267 PluginPinWindowProxy::processor_going_away ()
4271 WM::Manager::instance().remove (this);
4272 going_away_connection.disconnect();
4276 ProcessorBox::load_bindings ()
4278 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);