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 (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1130 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1137 ProcessorEntry::RoutingIcon::set_fed_by (
1138 const ARDOUR::ChanCount& out,
1139 const ARDOUR::ChanCount& sources,
1140 const ARDOUR::ChanMapping& out_map,
1141 const ARDOUR::ChanMapping& thru_map)
1144 _f_sources = sources;
1145 _f_out_map = out_map;
1146 _f_thru_map = thru_map;
1151 ProcessorEntry::RoutingIcon::set_feeding (
1152 const ARDOUR::ChanCount& in,
1153 const ARDOUR::ChanCount& sinks,
1154 const ARDOUR::ChanMapping& in_map,
1155 const ARDOUR::ChanMapping& thru_map)
1160 _i_thru_map = thru_map;
1165 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1167 if (!midi) { i += n_midi; }
1170 return rint (width * .5) +.5;
1172 return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1176 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1178 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1179 const double y1 = rint (height * .66) + .5;
1182 cairo_translate (cr, x0, y0);
1183 cairo_move_to (cr, 0, height);
1184 cairo_line_to (cr, 0, y1);
1185 cairo_move_to (cr, 0 - dx, y1);
1186 cairo_line_to (cr, 0 + dx, y1);
1188 set_routing_color (cr, midi);
1189 cairo_set_line_width (cr, 1.0);
1195 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1197 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1198 const double y1 = rint (height * .5) - .5;
1201 cairo_translate (cr, x0, y0);
1202 cairo_move_to (cr, 0 - dx, height);
1203 cairo_line_to (cr, 0, y1);
1204 cairo_line_to (cr, 0 + dx, height);
1205 cairo_close_path (cr);
1207 set_routing_color (cr, midi);
1213 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1215 const double rad = 1;
1216 const double y1 = height - rad - 1.5;
1218 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1219 cairo_move_to (cr, x0, y0 + height - 1.5);
1220 cairo_line_to (cr, x0, y0 + height);
1221 set_routing_color (cr, midi);
1222 cairo_set_line_width (cr, 1.0);
1227 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1229 const double rad = 1;
1230 const double y1 = rad + 1;
1232 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1233 cairo_move_to (cr, x0, y0);
1234 cairo_line_to (cr, x0, y0 + 1);
1235 set_routing_color (cr, midi);
1236 cairo_set_line_width (cr, 1.0);
1241 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1243 double bz = abs (y1 - y0);
1245 cairo_move_to (cr, x0, y0);
1246 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1247 cairo_set_line_width (cr, 1.0);
1248 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1249 cairo_set_source_rgb (cr, 1, 0, 0);
1251 const double dashes[] = { 2, 3 };
1252 cairo_set_dash (cr, dashes, 2, 0);
1254 set_routing_color (cr, midi);
1257 cairo_set_dash (cr, 0, 0, 0);
1262 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1264 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1266 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1269 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1271 Gtk::Allocation a = get_allocation();
1272 double const width = a.get_width();
1273 double const height = a.get_height();
1275 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1276 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1278 cairo_rectangle (cr, 0, 0, width, height);
1282 if (can_coalesce ()) {
1283 expose_coalesced_input_map (cr, width, height);
1285 expose_input_map (cr, width, height);
1288 expose_output_map (cr, width, height);
1296 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1298 const uint32_t pc_in = _sinks.n_total();
1299 const uint32_t pc_in_midi = _sinks.n_midi();
1301 for (uint32_t i = 0; i < pc_in; ++i) {
1302 const bool is_midi = i < pc_in_midi;
1304 uint32_t pn = is_midi ? i : i - pc_in_midi;
1305 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1306 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1308 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1309 draw_gnd (cr, x, 0, height, is_midi);
1312 if (idx >= _in.get (dt)) {
1313 // side-chain, probably
1314 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1315 draw_sidechain (cr, x, 0, height, is_midi);
1319 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1323 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1325 double x = pin_x_pos (i, width, pc_in, 0, false);
1327 _f_thru_map.get (dt, idx, &valid_thru);
1329 draw_thru_src (cr, x, 0, height, is_midi);
1331 draw_gnd (cr, x, 0, height, is_midi);
1335 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1337 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1339 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1344 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1346 const uint32_t n_in = _in.n_total();
1347 const uint32_t n_in_midi = _in.n_midi();
1348 const uint32_t pc_in = _sinks.n_total();
1349 const uint32_t pc_in_midi = _sinks.n_midi();
1351 // draw inputs to this
1352 for (uint32_t i = 0; i < pc_in; ++i) {
1353 const bool is_midi = i < pc_in_midi;
1355 uint32_t pn = is_midi ? i : i - pc_in_midi;
1356 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1357 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1358 // check if it's fed
1359 bool valid_src = true;
1360 if (valid_in && idx < _in.get (dt) && _fed_by) {
1363 _f_out_map.get_src (dt, idx, &valid_out);
1364 _f_thru_map.get (dt, idx, &valid_thru);
1365 if (!valid_out && !valid_thru) {
1369 if (!valid_in || !valid_src) {
1370 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1371 draw_gnd (cr, x, 0, height, is_midi);
1374 if (idx >= _in.get (dt)) {
1375 // side-chain, probably
1376 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1377 draw_sidechain (cr, x, 0, height, is_midi);
1380 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1381 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1382 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1385 // draw reverse thru
1386 for (uint32_t i = 0; i < n_in; ++i) {
1387 const bool is_midi = i < n_in_midi;
1389 uint32_t pn = is_midi ? i : i - n_in_midi;
1390 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1391 _thru_map.get_src (dt, pn, &valid_thru);
1395 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1396 draw_thru_sink (cr, x, 0, height, is_midi);
1401 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1403 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1404 double ht = _terminal ? height - dh : height;
1406 // draw outputs of this
1407 const uint32_t pc_out = _sources.n_total();
1408 const uint32_t pc_out_midi = _sources.n_midi();
1409 const uint32_t n_out = _out.n_total();
1410 const uint32_t n_out_midi = _out.n_midi();
1412 for (uint32_t i = 0; i < pc_out; ++i) {
1413 const bool is_midi = i < pc_out_midi;
1415 uint32_t pn = is_midi ? i : i - pc_out_midi;
1416 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1417 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1421 // skip connections that are not used in the next's input
1423 bool valid_thru, valid_sink;
1424 _i_in_map.get_src (dt, idx, &valid_sink);
1425 _i_thru_map.get_src (dt, idx, &valid_thru);
1426 if (!valid_thru && !valid_sink) {
1427 if (!is_midi || i != 0) { // special case midi-bypass
1432 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1433 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1434 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1437 for (uint32_t i = 0; i < n_out; ++i) {
1438 const bool is_midi = i < n_out_midi;
1439 uint32_t pn = is_midi ? i : i - n_out_midi;
1440 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1441 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1444 bool valid_thru_f = false;
1445 // skip connections that are not used in the next's input
1448 _i_in_map.get_src (dt, pn, &valid_sink);
1449 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1450 if (!valid_thru_f && !valid_sink) {
1451 if (!is_midi || i != 0) { // special case midi-bypass
1458 _out_map.get_src (dt, pn, &valid_src);
1461 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1463 if (idx >= _in.get (dt)) {
1464 draw_sidechain (cr, x, 0, height, is_midi);
1466 draw_thru_src (cr, x, 0, height, is_midi);
1468 } else if (valid_thru_f){
1469 // gnd is part of input, unless it's a thru input
1470 // (also only true if !coalesced into one small display)
1471 draw_gnd (cr, x, 0, height, is_midi);
1475 // terminal node, add arrows
1477 _out_map.get_src (dt, pn, &valid_src);
1480 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1482 if (idx >= _in.get (dt)) {
1483 draw_sidechain (cr, x, 0, height - dh, is_midi);
1485 draw_thru_src (cr, x, 0, height - dh, is_midi);
1488 draw_gnd (cr, x, 0, height - dh, is_midi);
1492 set_routing_color (cr, is_midi);
1493 cairo_set_line_width (cr, 1.0);
1494 cairo_move_to (cr, x, height - dh);
1495 cairo_line_to (cr, x, height - 2);
1498 const double ar = dh - 1;
1499 cairo_move_to (cr, x - ar, height - ar);
1500 cairo_line_to (cr, x , height - .5);
1501 cairo_line_to (cr, x + ar, height - ar);
1502 cairo_line_to (cr, x , height - ar * .5);
1503 cairo_close_path (cr);
1504 cairo_fill_preserve (cr);
1510 ProcessorEntry::PluginDisplay::PluginDisplay (boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1513 , _max_height (max_height)
1517 set_name ("processor prefader");
1518 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1519 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1522 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1525 cairo_surface_destroy (_surf);
1530 ProcessorEntry::PluginDisplay::on_size_request (Gtk::Requisition* req)
1533 req->height = _cur_height;
1538 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1540 /* work-around scroll-bar + aspect ratio
1541 * show inline-view -> height changes -> scrollbar gets added
1542 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1543 * -> scroll bar is removed [-> width changes ; repeat ]
1545 uint32_t shm = std::min (_max_height, inline_height);
1547 Gtk::Container* pr = get_parent();
1548 for (uint32_t i = 0; i < 4 && pr; ++i) {
1549 // VBox, EventBox, ViewPort, ScrolledWindow
1550 pr = pr->get_parent();
1552 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1554 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1555 sc = vsb && vsb->is_visible();
1558 if (shm != _cur_height) {
1559 if (_scroll == sc || _cur_height < shm) {
1568 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1570 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1575 /* allocate a local image-surface,
1576 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1577 * since pixman keeps a reference to it.
1578 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1579 * it might be possible to work around via cairo_surface_set_user_data().
1582 || dis->width != cairo_image_surface_get_width (_surf)
1583 || dis->height != cairo_image_surface_get_height (_surf)
1586 cairo_surface_destroy (_surf);
1588 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1591 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1592 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1594 unsigned char *src = dis->data;
1595 unsigned char *dst = cairo_image_surface_get_data (_surf);
1596 const int dst_stride = cairo_image_surface_get_stride (_surf);
1597 for (int y = 0; y < dis->height; ++y) {
1598 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1604 cairo_surface_mark_dirty(_surf);
1605 const double xc = floor ((width - dis->width) * .5);
1606 cairo_set_source_surface(cr, _surf, xc, 0);
1613 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1615 Gtk::Allocation a = get_allocation();
1616 double const width = a.get_width();
1617 double const height = a.get_height();
1619 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1620 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1623 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1624 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1625 cairo_rectangle (cr, 0, 0, width, height);
1629 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1630 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1632 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1634 uint32_t ht = render_inline (cr, width);
1639 if (_cur_height != 1) {
1646 update_height_alloc (ht);
1649 bool failed = false;
1650 std::string name = get_name();
1651 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1653 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1654 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1655 cairo_set_line_width(cr, 1.0);
1656 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1663 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1664 : PluginDisplay (p, max_height)
1666 , _lua_render_inline (0)
1668 p->setup_lua_inline_gui (&lua_gui);
1670 lua_State* LG = lua_gui.getState ();
1671 LuaInstance::bind_cairo (LG);
1672 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1673 assert (lua_render.isFunction ());
1674 _lua_render_inline = new luabridge::LuaRef (lua_render);
1677 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1679 delete (_lua_render_inline);
1683 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1685 Cairo::Context ctx (cr);
1687 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1688 if (rv.isTable ()) {
1692 } catch (luabridge::LuaException const& e) {
1694 cerr << "LuaException:" << e.what () << endl;
1701 static std::list<Gtk::TargetEntry> drop_targets()
1703 std::list<Gtk::TargetEntry> tmp;
1704 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1705 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1706 tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1710 static std::list<Gtk::TargetEntry> drag_targets()
1712 std::list<Gtk::TargetEntry> tmp;
1713 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1714 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1718 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1720 std::list<Gtk::TargetEntry> tmp;
1721 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1725 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1726 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1727 : _parent_strip (parent)
1728 , _owner_is_mixer (owner_is_mixer)
1729 , ab_direction (true)
1730 , _get_plugin_selector (get_plugin_selector)
1732 , _visible_prefader_processors (0)
1733 , _rr_selection(rsel)
1734 , processor_display (drop_targets())
1735 , _redisplay_pending (false)
1739 /* ProcessorBox actions and bindings created statically by call to
1740 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1741 * are available for context menus.
1744 processor_display.set_data ("ardour-bindings", bindings);
1748 no_processor_redisplay = false;
1750 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1751 processor_scroller.add (processor_display);
1752 pack_start (processor_scroller, true, true);
1754 processor_display.set_flags (CAN_FOCUS);
1755 processor_display.set_name ("ProcessorList");
1756 processor_display.set_data ("processorbox", this);
1757 processor_display.set_size_request (48, -1);
1758 processor_display.set_spacing (0);
1760 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1761 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1763 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1764 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1766 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1767 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1768 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1770 processor_scroller.show ();
1771 processor_display.show ();
1774 parent->DeliveryChanged.connect (
1775 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1779 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1782 ProcessorBox::~ProcessorBox ()
1784 /* it may appear as if we should delete processor_menu but that is a
1785 * pointer to a widget owned by the UI Manager, and has potentially
1786 * be returned to many other ProcessorBoxes. GTK doesn't really make
1787 * clear the ownership of this widget, which is a menu and thus is
1788 * never packed into any container other than an implict GtkWindow.
1790 * For now, until or if we ever get clarification over the ownership
1791 * story just let it continue to exist. At worst, its a small memory leak.
1796 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1802 _route_connections.drop_connections();
1804 /* new route: any existing block on processor redisplay must be meaningless */
1805 no_processor_redisplay = false;
1808 _route->processors_changed.connect (
1809 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1812 _route->DropReferences.connect (
1813 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1816 _route->PropertyChanged.connect (
1817 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1820 redisplay_processors ();
1824 ProcessorBox::route_going_away ()
1826 /* don't keep updating display as processors are deleted */
1827 no_processor_redisplay = true;
1831 boost::shared_ptr<Processor>
1832 ProcessorBox::find_drop_position (ProcessorEntry* position)
1834 boost::shared_ptr<Processor> p;
1836 p = position->processor ();
1838 /* dropped on the blank entry (which will be before the
1839 fader), so use the first non-blank child as our
1840 `dropped on' processor */
1841 list<ProcessorEntry*> c = processor_display.children ();
1842 list<ProcessorEntry*>::iterator i = c.begin ();
1844 assert (i != c.end ());
1845 p = (*i)->processor ();
1853 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1855 const void * d = data.get_data();
1856 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1858 PluginPresetList nfos;
1860 tv->get_object_drag_data (nfos, &source);
1862 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1863 PluginPresetPtr ppp = (*i);
1864 PluginInfoPtr pip = ppp->_pip;
1865 PluginPtr p = pip->load (*_session);
1870 if (ppp->_preset.valid) {
1871 p->load_preset (ppp->_preset);
1874 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1875 if (Config->get_new_plugins_active ()) {
1876 processor->activate ();
1878 pl.push_back (processor);
1883 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1885 const void * d = data.get_data();
1886 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1887 PluginInfoList nfos;
1890 tv->get_object_drag_data (nfos, &source);
1892 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1893 PluginPtr p = (*i)->load (*_session);
1897 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1898 if (Config->get_new_plugins_active ()) {
1899 processor->activate ();
1901 pl.push_back (processor);
1906 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1912 boost::shared_ptr<Processor> p = find_drop_position (position);
1913 Route::ProcessorList pl;
1915 if (data.get_target() == "PluginInfoPtr") {
1916 _drop_plugin (data, pl);
1918 else if (data.get_target() == "PluginFavoritePtr") {
1919 _drop_plugin_preset (data, pl);
1925 Route::ProcessorStreams err;
1926 if (_route->add_processors (pl, p, &err)) {
1928 "Processor Drag/Drop failed. Probably because\n\
1929 the I/O configuration of the plugins could\n\
1930 not match the configuration of this track.");
1931 MessageDialog am (msg);
1937 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1939 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1940 list<ProcessorEntry*> children = source->selection ();
1941 assert (children.size() == 1);
1942 ProcessorEntry* other = *children.begin();
1943 assert (other->can_copy_state (position));
1944 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1945 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1946 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1947 assert (otherproc && proc && pi);
1949 PBD::ID id = pi->id();
1950 XMLNode& state = otherproc->get_state ();
1951 /* strip side-chain state (processor inside processor must be a side-chain)
1952 * otherwise we'll end up with duplicate ports-names.
1953 * (this needs a better solution which retains connections)
1955 state.remove_nodes ("Processor");
1956 proc->set_state (state, Stateful::loading_state_version);
1957 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1961 boost::shared_ptr<Processor> p = find_drop_position (position);
1963 list<ProcessorEntry*> children = source->selection ();
1964 list<boost::shared_ptr<Processor> > procs;
1965 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
1966 if ((*i)->processor ()) {
1967 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
1970 procs.push_back ((*i)->processor ());
1974 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
1975 XMLNode& state = (*i)->get_state ();
1977 nlist.push_back (&state);
1978 paste_processor_state (nlist, p);
1982 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
1986 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
1987 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
1989 other->delete_dragged_processors (procs);
1995 ProcessorBox::set_width (Width w)
2003 list<ProcessorEntry*> children = processor_display.children ();
2004 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2005 (*i)->set_enum_width (w);
2012 ProcessorBox::build_possible_aux_menu ()
2014 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2017 /* No aux sends if there are no busses */
2021 if (_route->is_monitor ()) {
2025 using namespace Menu_Helpers;
2026 Menu* menu = manage (new Menu);
2027 MenuList& items = menu->items();
2029 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2030 if (!_route->internal_send_for (*r) && *r != _route) {
2031 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2039 ProcessorBox::show_processor_menu (int arg)
2041 if (processor_menu == 0) {
2042 processor_menu = build_processor_menu ();
2043 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2046 /* Sort out the plugin submenu */
2048 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2050 if (plugin_menu_item) {
2051 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2054 /* And the aux submenu */
2056 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2058 if (aux_menu_item) {
2059 Menu* m = build_possible_aux_menu();
2060 if (m && !m->items().empty()) {
2061 aux_menu_item->set_submenu (*m);
2062 aux_menu_item->set_sensitive (true);
2064 /* stupid gtkmm: we need to pass a null reference here */
2065 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2066 aux_menu_item->set_sensitive (false);
2070 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2071 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2073 ProcessorEntry* single_selection = 0;
2074 if (processor_display.selection().size() == 1) {
2075 single_selection = processor_display.selection().front();
2078 /* And the controls submenu */
2080 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2082 if (controls_menu_item) {
2083 if (single_selection) {
2084 Menu* m = single_selection->build_controls_menu ();
2085 if (m && !m->items().empty()) {
2086 controls_menu_item->set_submenu (*m);
2087 controls_menu_item->set_sensitive (true);
2089 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2090 controls_menu_item->set_sensitive (false);
2093 controls_menu_item->set_sensitive (false);
2098 if (!ARDOUR::Profile->get_mixbus()) {
2099 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2100 if (send_menu_item) {
2101 if (single_selection && !_route->is_monitor()) {
2102 Menu* m = single_selection->build_send_options_menu ();
2103 if (m && !m->items().empty()) {
2104 send_menu_item->set_submenu (*m);
2105 send_menu_item->set_sensitive (true);
2107 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2108 send_menu_item->set_sensitive (false);
2111 send_menu_item->set_sensitive (false);
2116 /* Sensitise actions as approprioate */
2119 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2121 paste_action->set_sensitive (!_rr_selection.processors.empty());
2122 cut_action->set_sensitive (sensitive && can_cut ());
2123 copy_action->set_sensitive (sensitive);
2124 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2126 edit_action->set_sensitive (one_processor_can_be_edited ());
2127 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2129 boost::shared_ptr<PluginInsert> pi;
2130 if (single_selection) {
2131 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2134 manage_pins_action->set_sensitive (pi != 0);
2136 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2137 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2139 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2140 rename_action->set_sensitive (single_selection
2142 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2143 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2145 processor_menu->popup (1, arg);
2147 /* Add a placeholder gap to the processor list to indicate where a processor would be
2148 inserted were one chosen from the menu.
2151 processor_display.get_pointer (x, y);
2152 _placement = processor_display.add_placeholder (y);
2154 if (_visible_prefader_processors == 0 && _placement > 0) {
2160 ProcessorBox::enter_notify (GdkEventCrossing*)
2162 processor_display.grab_focus ();
2163 _current_processor_box = this;
2168 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2170 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2174 Widget* top = get_toplevel();
2176 if (top->is_toplevel()) {
2177 Window* win = dynamic_cast<Window*> (top);
2178 gtk_window_set_focus (win->gobj(), 0);
2185 ProcessorBox::processor_operation (ProcessorOperation op)
2187 ProcSelection targets;
2189 get_selected_processors (targets);
2191 /* if (targets.empty()) {
2194 processor_display.get_pointer (x, y);
2196 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2198 if (pointer.first && pointer.first->processor()) {
2199 targets.push_back (pointer.first->processor ());
2204 if ((op == ProcessorsDelete) && targets.empty()) {
2205 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2209 case ProcessorsSelectAll:
2210 processor_display.select_all ();
2213 case ProcessorsSelectNone:
2214 processor_display.select_none ();
2217 case ProcessorsCopy:
2218 copy_processors (targets);
2222 cut_processors (targets);
2225 case ProcessorsPaste:
2226 // some processors are not selectable (e.g fader, meter), target is empty.
2227 if (targets.empty() && _placement >= 0) {
2229 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2231 targets.push_back (proc);
2234 if (targets.empty()) {
2235 paste_processors ();
2237 paste_processors (targets.front());
2241 case ProcessorsDelete:
2242 delete_processors (targets);
2245 case ProcessorsToggleActive:
2246 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2247 if ((*i)->active()) {
2248 (*i)->deactivate ();
2266 ProcessorWindowProxy*
2267 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2269 return processor->window_proxy();
2274 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2276 boost::shared_ptr<Processor> processor;
2278 processor = child->processor ();
2282 bool selected = processor_display.selected (child);
2284 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2286 if (_session->engine().connected()) {
2287 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2289 if (!one_processor_can_be_edited ()) {
2293 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2294 generic_edit_processor (processor);
2296 edit_processor (processor);
2302 } else if (Keyboard::is_context_menu_event (ev)) {
2304 show_processor_menu (ev->time);
2308 } else if (processor && ev->button == 1 && selected) {
2310 // this is purely informational but necessary for route params UI
2311 ProcessorSelected (processor); // emit
2313 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2316 _get_plugin_selector()->show_manager ();
2323 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2325 boost::shared_ptr<Processor> processor;
2327 processor = child->processor ();
2330 if (processor && Keyboard::is_delete_event (ev)) {
2332 Glib::signal_idle().connect (sigc::bind (
2333 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2334 boost::weak_ptr<Processor>(processor)));
2336 } else if (processor && Keyboard::is_button2_event (ev)
2338 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2342 /* button2-click with no/appropriate modifiers */
2344 if (processor->active()) {
2345 processor->deactivate ();
2347 processor->activate ();
2355 ProcessorBox::build_processor_menu ()
2357 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2358 processor_menu->set_name ("ArdourContextMenu");
2359 return processor_menu;
2363 ProcessorBox::select_all_processors ()
2365 processor_display.select_all ();
2369 ProcessorBox::deselect_all_processors ()
2371 processor_display.select_none ();
2375 ProcessorBox::choose_plugin ()
2377 _get_plugin_selector()->set_interested_object (*this);
2380 /** @return true if an error occurred, otherwise false */
2382 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2384 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2386 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2388 Route::ProcessorStreams err_streams;
2390 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2391 weird_plugin_dialog (**p, err_streams);
2393 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2394 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2395 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2397 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2398 if ((*p)->has_editor ()) {
2399 edit_processor (processor);
2401 generic_edit_processor (processor);
2411 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2413 ArdourDialog dialog (_("Plugin Incompatibility"));
2416 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2417 p.name(), streams.index);
2419 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2420 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2422 text += _("\nThis plugin has:\n");
2424 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2425 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2428 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2429 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2432 text += _("\nbut at the insertion point, there are:\n");
2434 uint32_t const n = streams.count.n_midi ();
2435 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2438 uint32_t const n = streams.count.n_audio ();
2439 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2442 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2443 label.set_text(text);
2445 dialog.get_vbox()->pack_start (label);
2446 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2448 dialog.set_name (X_("PluginIODialog"));
2449 dialog.set_modal (true);
2456 ProcessorBox::choose_insert ()
2458 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2459 _route->add_processor_by_index (processor, _placement);
2462 /* Caller must not hold process lock */
2464 ProcessorBox::choose_send ()
2466 boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2468 /* make an educated guess at the initial number of outputs for the send */
2469 ChanCount outs = (_session->master_out())
2470 ? _session->master_out()->n_outputs()
2471 : _route->n_outputs();
2473 /* XXX need processor lock on route */
2475 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2476 send->output()->ensure_io (outs, false, this);
2477 } catch (AudioEngine::PortRegistrationFailure& err) {
2478 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2482 /* let the user adjust the IO setup before creation.
2484 Note: this dialog is NOT modal - we just leave it to run and it will
2485 return when its Finished signal is emitted - typically when the window
2489 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2492 /* keep a reference to the send so it doesn't get deleted while
2493 the IOSelectorWindow is doing its stuff
2495 _processor_being_created = send;
2497 ios->selector().Finished.connect (sigc::bind (
2498 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2499 boost::weak_ptr<Processor>(send), ios));
2504 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2506 boost::shared_ptr<Processor> processor (weak_processor.lock());
2508 /* drop our temporary reference to the new send */
2509 _processor_being_created.reset ();
2516 case IOSelector::Cancelled:
2517 // processor will go away when all shared_ptrs to it vanish
2520 case IOSelector::Accepted:
2521 _route->add_processor_by_index (processor, _placement);
2525 delete_when_idle (ios);
2529 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2531 boost::shared_ptr<Processor> processor (weak_processor.lock());
2533 /* drop our temporary reference to the new return */
2534 _processor_being_created.reset ();
2541 case IOSelector::Cancelled:
2542 // processor will go away when all shared_ptrs to it vanish
2545 case IOSelector::Accepted:
2546 _route->add_processor_by_index (processor, _placement);
2550 delete_when_idle (ios);
2554 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2560 boost::shared_ptr<Route> target = wr.lock();
2566 _session->add_internal_send (target, _placement, _route);
2570 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2572 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2573 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2577 redisplay_processors ();
2581 ProcessorBox::redisplay_processors ()
2583 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2586 if (no_processor_redisplay) {
2590 processor_display.clear ();
2592 _visible_prefader_processors = 0;
2595 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2596 &_visible_prefader_processors, &fader_seen));
2598 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2599 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2600 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2602 setup_entry_positions ();
2605 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2606 * not already have one.
2609 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2611 boost::shared_ptr<Processor> p = w.lock ();
2615 if (p->window_proxy()) {
2619 /* not on the list; add it */
2622 #if 0 // is this still needed? Why?
2623 if (_parent_strip) {
2624 if (_parent_strip->mixer_owned()) {
2636 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2637 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2641 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2644 wp->set_state (*ui_xml, 0);
2647 void* existing_ui = p->get_ui ();
2650 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2653 p->set_window_proxy (wp);
2654 WM::Manager::instance().register_window (wp);
2658 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2660 boost::shared_ptr<Processor> p = w.lock ();
2661 if (!p || p->pinmgr_proxy ()) {
2665 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2666 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2667 wp->set_session (_session);
2669 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2671 wp->set_state (*ui_xml, 0);
2674 p->set_pingmgr_proxy (wp);
2675 WM::Manager::instance().register_window (wp);
2678 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2680 boost::shared_ptr<Processor> processor (p.lock ());
2682 if (processor && ( processor->display_to_user()
2684 || show_all_processors
2689 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2690 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2701 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2703 boost::shared_ptr<Processor> processor (p.lock ());
2705 if (!processor || ( !processor->display_to_user()
2707 && !show_all_processors
2714 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2716 ProcessorEntry* e = 0;
2717 if (plugin_insert) {
2718 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2720 e = new ProcessorEntry (this, processor, _width);
2723 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2724 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2725 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2727 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2728 if (!send && !plugin_insert && !ext && !stub)
2729 e->set_selectable(false);
2731 bool mark_send_visible = false;
2732 if (send && _parent_strip) {
2733 /* show controls of new sends by default */
2734 GUIObjectState& st = _parent_strip->gui_object_state ();
2735 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2737 /* check if state exists, if not it must be a new send */
2738 if (!st.get_node(strip, e->state_id())) {
2739 mark_send_visible = true;
2743 /* Set up this entry's state from the GUIObjectState */
2744 XMLNode* proc = entry_gui_object_state (e);
2746 e->set_control_state (proc);
2749 if (mark_send_visible) {
2750 e->show_all_controls ();
2755 && !plugin_insert->plugin(0)->is_channelstrip()
2759 processor_display.add_child (e, drag_targets());
2761 processor_display.add_child (e, drag_targets_noplugin());
2766 ProcessorBox::reordered ()
2768 compute_processor_sort_keys ();
2769 setup_entry_positions ();
2773 ProcessorBox::setup_routing_feeds ()
2775 list<ProcessorEntry*> children = processor_display.children ();
2776 /* first set the i/o maps for every processor */
2777 list<ProcessorEntry*>::iterator prev = children.begin();
2779 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2780 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2781 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2783 list<ProcessorEntry*>::iterator next = i;
2787 ChanCount sinks = pi->natural_input_streams ();
2788 ChanCount sources = pi->natural_output_streams ();
2789 uint32_t count = pi->get_count ();
2791 pi->configured_io (in, out);
2793 ChanCount midi_thru;
2794 ChanCount midi_bypass;
2795 ChanMapping input_map (pi->input_map ());
2796 if (pi->has_midi_thru ()) {
2797 midi_thru.set(DataType::MIDI, 1);
2798 input_map.set (DataType::MIDI, 0, 0);
2800 if (pi->has_midi_bypass ()) {
2801 midi_bypass.set(DataType::MIDI, 1);
2804 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2805 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2807 (*i)->routing_icon.set (
2809 sinks * count + midi_thru,
2810 sources * count + midi_bypass,
2815 if (next != children.end()) {
2816 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2817 pi->output_map (), pi->thru_map ());
2821 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2822 pi->input_map (), pi->thru_map ());
2826 (*i)->input_icon.set_ports (p->input_streams());
2827 (*i)->output_icon.set_ports (p->output_streams());
2828 ChanMapping inmap (p->input_streams ());
2829 ChanMapping outmap (p->input_streams ());
2830 ChanMapping thrumap;
2831 (*i)->routing_icon.set (
2833 p->output_streams(),
2835 p->output_streams(),
2836 inmap, outmap, thrumap);
2838 if (next != children.end()) {
2839 (*next)->routing_icon.set_fed_by (
2840 p->output_streams(),
2841 p->output_streams(),
2845 (*prev)->routing_icon.set_feeding (
2847 p->output_streams(),
2852 if (i == children.begin()) {
2853 (*i)->routing_icon.unset_fed_by ();
2856 (*i)->input_icon.hide();
2859 /* now set which icons need to be displayed */
2860 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2861 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2863 if ((*i)->routing_icon.in_identity ()) {
2864 (*i)->routing_icon.hide();
2865 if (i == children.begin()) {
2866 (*i)->input_icon.show();
2869 (*i)->routing_icon.show();
2870 (*i)->routing_icon.queue_draw();
2871 (*i)->input_icon.show();
2874 list<ProcessorEntry*>::iterator next = i;
2875 if (++next == children.end()) {
2876 // last processor in the chain
2877 (*i)->output_routing_icon.set_terminal(true);
2878 (*i)->output_routing_icon.unset_feeding ();
2879 if ((*i)->routing_icon.out_identity ()) {
2880 (*i)->output_routing_icon.hide();
2882 (*i)->output_routing_icon.show();
2883 (*i)->output_routing_icon.queue_draw();
2886 (*i)->output_routing_icon.set_terminal(false);
2887 if ( !(*i)->routing_icon.out_identity ()
2888 && !(*next)->routing_icon.in_identity ()
2889 && (*next)->routing_icon.can_coalesce ()) {
2890 (*i)->output_routing_icon.hide();
2891 } else if (!(*i)->routing_icon.out_identity ()) {
2892 (*i)->output_routing_icon.show();
2893 (*i)->output_routing_icon.queue_draw();
2894 (*next)->input_icon.show();
2896 (*i)->output_routing_icon.hide();
2903 ProcessorBox::setup_entry_positions ()
2905 list<ProcessorEntry*> children = processor_display.children ();
2906 bool pre_fader = true;
2909 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2910 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2911 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2913 (*i)->set_position (ProcessorEntry::Fader, num++);
2916 (*i)->set_position (ProcessorEntry::PreFader, num++);
2918 (*i)->set_position (ProcessorEntry::PostFader, num++);
2922 setup_routing_feeds ();
2926 ProcessorBox::compute_processor_sort_keys ()
2928 list<ProcessorEntry*> children = processor_display.children ();
2929 Route::ProcessorList our_processors;
2931 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2932 if ((*i)->processor()) {
2933 our_processors.push_back ((*i)->processor ());
2937 if (_route->reorder_processors (our_processors)) {
2938 /* Reorder failed, so report this to the user. As far as I can see this must be done
2939 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2940 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2941 when the drag is torn down after this handler function is finished.
2943 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2948 ProcessorBox::report_failed_reorder ()
2950 /* reorder failed, so redisplay */
2952 redisplay_processors ();
2954 /* now tell them about the problem */
2956 ArdourDialog dialog (_("Plugin Incompatibility"));
2959 label.set_text (_("\
2960 You cannot reorder these plugins/sends/inserts\n\
2961 in that way because the inputs and\n\
2962 outputs will not work correctly."));
2964 dialog.get_vbox()->set_border_width (12);
2965 dialog.get_vbox()->pack_start (label);
2966 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2968 dialog.set_name (X_("PluginIODialog"));
2969 dialog.set_modal (true);
2976 ProcessorBox::rename_processors ()
2978 ProcSelection to_be_renamed;
2980 get_selected_processors (to_be_renamed);
2982 if (to_be_renamed.empty()) {
2986 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
2987 rename_processor (*i);
2992 ProcessorBox::can_cut () const
2994 vector<boost::shared_ptr<Processor> > sel;
2996 get_selected_processors (sel);
2998 /* cut_processors () does not cut inserts */
3000 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3002 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3003 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3004 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3013 ProcessorBox::stub_processor_selected () const
3015 vector<boost::shared_ptr<Processor> > sel;
3017 get_selected_processors (sel);
3019 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3020 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3029 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3031 if (to_be_removed.empty()) {
3035 XMLNode* node = new XMLNode (X_("cut"));
3036 Route::ProcessorList to_cut;
3038 no_processor_redisplay = true;
3039 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3040 // Cut only plugins, sends and returns
3041 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3042 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3043 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3045 Window* w = get_processor_ui (*i);
3051 XMLNode& child ((*i)->get_state());
3052 node->add_child_nocopy (child);
3053 to_cut.push_back (*i);
3057 if (_route->remove_processors (to_cut) != 0) {
3059 no_processor_redisplay = false;
3063 _rr_selection.set (node);
3065 no_processor_redisplay = false;
3066 redisplay_processors ();
3070 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3072 if (to_be_copied.empty()) {
3076 XMLNode* node = new XMLNode (X_("copy"));
3078 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3079 // Copy only plugins, sends, returns
3080 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3081 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3082 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3083 node->add_child_nocopy ((*i)->get_state());
3087 _rr_selection.set (node);
3091 ProcessorBox::delete_processors (const ProcSelection& targets)
3093 if (targets.empty()) {
3097 no_processor_redisplay = true;
3099 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3101 Window* w = get_processor_ui (*i);
3107 _route->remove_processor(*i);
3110 no_processor_redisplay = false;
3111 redisplay_processors ();
3115 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3117 list<boost::shared_ptr<Processor> >::const_iterator x;
3119 no_processor_redisplay = true;
3120 for (x = procs.begin(); x != procs.end(); ++x) {
3122 Window* w = get_processor_ui (*x);
3128 _route->remove_processor(*x);
3131 no_processor_redisplay = false;
3132 redisplay_processors ();
3136 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3138 boost::shared_ptr<Processor> processor (weak_processor.lock());
3144 /* NOT copied to _mixer.selection() */
3146 no_processor_redisplay = true;
3147 _route->remove_processor (processor);
3148 no_processor_redisplay = false;
3149 redisplay_processors ();
3155 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3157 ArdourPrompter name_prompter (true);
3159 name_prompter.set_title (_("Rename Processor"));
3160 name_prompter.set_prompt (_("New name:"));
3161 name_prompter.set_initial_text (processor->name());
3162 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3163 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3164 name_prompter.show_all ();
3166 switch (name_prompter.run ()) {
3168 case Gtk::RESPONSE_ACCEPT:
3169 name_prompter.get_result (result);
3170 if (result.length()) {
3173 string test = result;
3175 while (tries < 100) {
3176 if (_session->io_name_is_legal (test)) {
3182 test = string_compose ("%1-%2", result, tries);
3186 processor->set_name (result);
3189 ARDOUR_UI::instance()->popup_error
3190 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3200 ProcessorBox::paste_processors ()
3202 if (_rr_selection.processors.empty()) {
3206 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3210 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3213 if (_rr_selection.processors.empty()) {
3217 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3221 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3223 XMLNodeConstIterator niter;
3224 list<boost::shared_ptr<Processor> > copies;
3226 if (nlist.empty()) {
3230 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3232 XMLProperty const * type = (*niter)->property ("type");
3233 XMLProperty const * role = (*niter)->property ("role");
3236 boost::shared_ptr<Processor> p;
3238 if (type->value() == "meter" ||
3239 type->value() == "main-outs" ||
3240 type->value() == "amp" ||
3241 type->value() == "intreturn") {
3242 /* do not paste meter, main outs, amp or internal returns */
3245 } else if (type->value() == "intsend") {
3247 /* aux sends are OK, but those used for
3248 * other purposes, are not.
3253 if (role->value() != "Aux") {
3257 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3258 XMLNode n (**niter);
3259 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3260 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3262 IOProcessor::prepare_for_reset (n, s->name());
3264 if (s->set_state (n, Stateful::loading_state_version)) {
3271 } else if (type->value() == "send") {
3273 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3274 XMLNode n (**niter);
3276 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3278 IOProcessor::prepare_for_reset (n, s->name());
3280 if (s->set_state (n, Stateful::loading_state_version)) {
3287 } else if (type->value() == "return") {
3289 XMLNode n (**niter);
3290 Return* r = new Return (*_session);
3292 IOProcessor::prepare_for_reset (n, r->name());
3294 if (r->set_state (n, Stateful::loading_state_version)) {
3301 } else if (type->value() == "port") {
3303 XMLNode n (**niter);
3304 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3306 IOProcessor::prepare_for_reset (n, pi->name());
3308 if (pi->set_state (n, Stateful::loading_state_version)) {
3314 /* XXX its a bit limiting to assume that everything else
3317 p.reset (new PluginInsert (*_session));
3318 /* we can't use RAII Stateful::ForceIDRegeneration
3319 * because that'd void copying the state and wrongly bump
3320 * the state-version counter.
3321 * we need to load the state (incl external files) first and
3322 * only then update the ID)
3324 PBD::ID id = p->id();
3325 /* strip side-chain state (processor inside processor must be a side-chain)
3326 * otherwise we'll end up with duplicate ports-names.
3327 * (this needs a better solution which retains connections)
3328 * We really would want Stateful::ForceIDRegeneration here :(
3330 XMLNode state (**niter);
3331 state.remove_nodes ("Processor");
3333 p->set_state (state, Stateful::current_state_version);
3334 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3337 copies.push_back (p);
3341 error << _("plugin insert constructor failed") << endmsg;
3345 if (copies.empty()) {
3349 if (_route->add_processors (copies, p)) {
3352 "Copying the set of processors on the clipboard failed,\n\
3353 probably because the I/O configuration of the plugins\n\
3354 could not match the configuration of this track.");
3355 MessageDialog am (msg);
3361 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3363 const list<ProcessorEntry*> selection = processor_display.selection ();
3364 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3365 processors.push_back ((*i)->processor ());
3370 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3372 list<ProcessorEntry*> selection = processor_display.selection ();
3373 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3374 (this->*method) ((*i)->processor ());
3379 ProcessorBox::all_visible_processors_active (bool state)
3381 _route->all_visible_processors_active (state);
3385 ProcessorBox::ab_plugins ()
3387 _route->ab_plugins (ab_direction);
3388 ab_direction = !ab_direction;
3393 ProcessorBox::clear_processors ()
3396 vector<string> choices;
3398 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3399 "(this cannot be undone)"), _route->name());
3401 choices.push_back (_("Cancel"));
3402 choices.push_back (_("Yes, remove them all"));
3404 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3406 if (prompter.run () == 1) {
3407 _route->clear_processors (PreFader);
3408 _route->clear_processors (PostFader);
3413 ProcessorBox::clear_processors (Placement p)
3416 vector<string> choices;
3418 if (p == PreFader) {
3419 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3420 "(this cannot be undone)"), _route->name());
3422 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3423 "(this cannot be undone)"), _route->name());
3426 choices.push_back (_("Cancel"));
3427 choices.push_back (_("Yes, remove them all"));
3429 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3431 if (prompter.run () == 1) {
3432 _route->clear_processors (p);
3437 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3439 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3440 if (at && at->freeze_state() == AudioTrack::Frozen) {
3445 boost::dynamic_pointer_cast<Send> (processor) ||
3446 boost::dynamic_pointer_cast<Return> (processor) ||
3447 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3448 boost::dynamic_pointer_cast<PortInsert> (processor)
3457 ProcessorBox::one_processor_can_be_edited ()
3459 list<ProcessorEntry*> selection = processor_display.selection ();
3460 list<ProcessorEntry*>::iterator i = selection.begin();
3461 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3465 return (i != selection.end());
3469 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3471 boost::shared_ptr<Send> send;
3472 boost::shared_ptr<InternalSend> internal_send;
3473 boost::shared_ptr<Return> retrn;
3474 boost::shared_ptr<PluginInsert> plugin_insert;
3475 boost::shared_ptr<PortInsert> port_insert;
3478 /* This method may or may not return a Window, but if it does not it
3479 * will modify the parent mixer strip appearance layout to allow
3480 * "editing" the @param processor that was passed in.
3482 * So for example, if the processor is an Amp (gain), the parent strip
3483 * will be forced back into a model where the fader controls the main gain.
3484 * If the processor is a send, then we map the send controls onto the
3487 * Plugins and others will return a window for control.
3490 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3492 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3497 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3499 if (_parent_strip) {
3500 _parent_strip->revert_to_default_display ();
3503 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3505 if (!_session->engine().connected()) {
3509 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3511 gidget = new SendUIWindow (send, _session);
3514 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3516 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3517 /* no GUI for these */
3521 if (!_session->engine().connected()) {
3525 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3527 ReturnUIWindow *return_ui;
3528 Window* w = get_processor_ui (retrn);
3532 return_ui = new ReturnUIWindow (retrn, _session);
3533 return_ui->set_title (retrn->name ());
3534 set_processor_ui (send, return_ui);
3537 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3542 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3544 PluginUIWindow *plugin_ui;
3546 /* these are both allowed to be null */
3548 Window* w = get_processor_ui (plugin_insert);
3551 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3552 plugin_ui->set_title (generate_processor_title (plugin_insert));
3553 set_processor_ui (plugin_insert, plugin_ui);
3556 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3561 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3563 if (!_session->engine().connected()) {
3564 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3569 PortInsertWindow *io_selector;
3571 Window* w = get_processor_ui (port_insert);
3574 io_selector = new PortInsertWindow (_session, port_insert);
3575 set_processor_ui (port_insert, io_selector);
3578 io_selector = dynamic_cast<PortInsertWindow *> (w);
3581 gidget = io_selector;
3588 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3590 boost::shared_ptr<PluginInsert> plugin_insert
3591 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3593 if (!plugin_insert) {
3597 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3598 win->set_title (generate_processor_title (plugin_insert));
3604 ProcessorBox::register_actions ()
3606 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3608 Glib::RefPtr<Action> act;
3611 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3612 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3614 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3615 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3616 ActionManager::engine_sensitive_actions.push_back (act);
3617 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3618 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3619 ActionManager::engine_sensitive_actions.push_back (act);
3621 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3623 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3624 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3626 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3627 sigc::ptr_fun (ProcessorBox::rb_clear));
3628 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3629 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3630 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3631 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3633 /* standard editing stuff */
3635 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3636 sigc::ptr_fun (ProcessorBox::rb_cut));
3637 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3638 sigc::ptr_fun (ProcessorBox::rb_copy));
3639 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3640 sigc::ptr_fun (ProcessorBox::rb_delete));
3642 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3643 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3644 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3646 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3647 sigc::ptr_fun (ProcessorBox::rb_paste));
3648 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3649 sigc::ptr_fun (ProcessorBox::rb_rename));
3650 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3651 sigc::ptr_fun (ProcessorBox::rb_select_all));
3652 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3653 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3655 /* activation etc. */
3657 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3658 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3659 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3660 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3661 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3662 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3664 manage_pins_action = myactions.register_action (
3665 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3666 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3669 edit_action = myactions.register_action (
3670 processor_box_actions, X_("edit"), _("Edit..."),
3671 sigc::ptr_fun (ProcessorBox::rb_edit));
3673 edit_generic_action = myactions.register_action (
3674 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3675 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3681 ProcessorBox::rb_edit_generic ()
3683 if (_current_processor_box == 0) {
3687 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3691 ProcessorBox::rb_ab_plugins ()
3693 if (_current_processor_box == 0) {
3697 _current_processor_box->ab_plugins ();
3701 ProcessorBox::rb_manage_pins ()
3703 if (_current_processor_box == 0) {
3707 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3710 ProcessorBox::rb_choose_plugin ()
3712 if (_current_processor_box == 0) {
3715 _current_processor_box->choose_plugin ();
3719 ProcessorBox::rb_choose_insert ()
3721 if (_current_processor_box == 0) {
3724 _current_processor_box->choose_insert ();
3728 ProcessorBox::rb_choose_send ()
3730 if (_current_processor_box == 0) {
3733 _current_processor_box->choose_send ();
3737 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3739 if (_current_processor_box == 0) {
3743 _current_processor_box->choose_aux (wr);
3747 ProcessorBox::rb_clear ()
3749 if (_current_processor_box == 0) {
3753 _current_processor_box->clear_processors ();
3758 ProcessorBox::rb_clear_pre ()
3760 if (_current_processor_box == 0) {
3764 _current_processor_box->clear_processors (PreFader);
3769 ProcessorBox::rb_clear_post ()
3771 if (_current_processor_box == 0) {
3775 _current_processor_box->clear_processors (PostFader);
3779 ProcessorBox::rb_cut ()
3781 if (_current_processor_box == 0) {
3785 _current_processor_box->processor_operation (ProcessorsCut);
3789 ProcessorBox::rb_delete ()
3791 if (_current_processor_box == 0) {
3795 _current_processor_box->processor_operation (ProcessorsDelete);
3799 ProcessorBox::rb_copy ()
3801 if (_current_processor_box == 0) {
3804 _current_processor_box->processor_operation (ProcessorsCopy);
3808 ProcessorBox::rb_paste ()
3810 if (_current_processor_box == 0) {
3814 _current_processor_box->processor_operation (ProcessorsPaste);
3818 ProcessorBox::rb_rename ()
3820 if (_current_processor_box == 0) {
3823 _current_processor_box->rename_processors ();
3827 ProcessorBox::rb_select_all ()
3829 if (_current_processor_box == 0) {
3833 _current_processor_box->processor_operation (ProcessorsSelectAll);
3837 ProcessorBox::rb_deselect_all ()
3839 if (_current_processor_box == 0) {
3843 _current_processor_box->deselect_all_processors ();
3847 ProcessorBox::rb_activate_all ()
3849 if (_current_processor_box == 0) {
3853 _current_processor_box->all_visible_processors_active (true);
3857 ProcessorBox::rb_deactivate_all ()
3859 if (_current_processor_box == 0) {
3862 _current_processor_box->all_visible_processors_active (false);
3866 ProcessorBox::rb_edit ()
3868 if (_current_processor_box == 0) {
3872 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3876 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3878 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3882 if (_parent_strip) {
3883 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3884 if (_parent_strip->current_delivery() == send) {
3885 _parent_strip->revert_to_default_display ();
3887 _parent_strip->show_send(send);
3894 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3899 if (edit_aux_send (processor)) {
3903 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3906 proxy->set_custom_ui_mode (true);
3907 proxy->show_the_right_window ();
3912 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3917 if (edit_aux_send (processor)) {
3921 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3924 proxy->set_custom_ui_mode (false);
3925 proxy->show_the_right_window ();
3930 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3935 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3944 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3946 if (!what_changed.contains (ARDOUR::Properties::name)) {
3950 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3952 boost::shared_ptr<Processor> processor;
3953 boost::shared_ptr<PluginInsert> plugin_insert;
3954 boost::shared_ptr<Send> send;
3956 list<ProcessorEntry*> children = processor_display.children();
3958 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3960 processor = (*iter)->processor ();
3966 Window* w = get_processor_ui (processor);
3972 /* rename editor windows for sends and plugins */
3974 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3975 w->set_title (send->name ());
3976 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3977 w->set_title (generate_processor_title (plugin_insert));
3983 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
3985 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
3986 string::size_type email_pos;
3988 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
3989 maker = maker.substr (0, email_pos - 1);
3992 if (maker.length() > 32) {
3993 maker = maker.substr (0, 32);
3997 SessionObject* owner = pi->owner();
4000 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4002 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4006 /** @param p Processor.
4007 * @return the UI window for \a p.
4010 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4012 ProcessorWindowProxy* wp = p->window_proxy();
4019 /** Make a note of the UI window that a processor is using.
4020 * @param p Processor.
4021 * @param w UI window.
4024 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4026 assert (p->window_proxy());
4028 p->window_proxy()->use_window (*w);
4032 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4034 boost::shared_ptr<Delivery> d = w.lock ();
4039 list<ProcessorEntry*> children = processor_display.children ();
4040 list<ProcessorEntry*>::const_iterator i = children.begin();
4041 while (i != children.end() && (*i)->processor() != d) {
4045 if (i == children.end()) {
4046 processor_display.set_active (0);
4048 processor_display.set_active (*i);
4052 /** Called to repair the damage of Editor::show_window doing a show_all() */
4054 ProcessorBox::hide_things ()
4056 list<ProcessorEntry*> c = processor_display.children ();
4057 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4058 (*i)->hide_things ();
4063 ProcessorBox::processor_menu_unmapped ()
4065 processor_display.remove_placeholder ();
4066 /* make all possibly-desensitized actions sensitive again so that
4067 they be activated by other means (e.g. bindings)
4069 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4073 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4075 if (!_parent_strip) {
4079 GUIObjectState& st = _parent_strip->gui_object_state ();
4081 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4083 return st.get_or_add_node (strip, entry->state_id());
4087 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4089 XMLNode* proc = entry_gui_object_state (entry);
4094 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4095 proc->remove_nodes_and_delete (X_("Object"));
4096 entry->add_control_state (proc);
4100 ProcessorBox::is_editor_mixer_strip() const
4102 return _parent_strip && !_parent_strip->mixer_owned();
4105 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4106 : WM::ProxyBase (name, string())
4107 , _processor_box (box)
4108 , _processor (processor)
4110 , want_custom (false)
4112 boost::shared_ptr<Processor> p = _processor.lock ();
4116 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4119 ProcessorWindowProxy::~ProcessorWindowProxy()
4121 /* processor window proxies do not own the windows they create with
4122 * ::get(), so set _window to null before the normal WindowProxy method
4129 ProcessorWindowProxy::processor_going_away ()
4133 WM::Manager::instance().remove (this);
4134 /* should be no real reason to do this, since the object that would
4135 send DropReferences is about to be deleted, but lets do it anyway.
4137 going_away_connection.disconnect();
4140 ARDOUR::SessionHandlePtr*
4141 ProcessorWindowProxy::session_handle()
4148 ProcessorWindowProxy::get_state ()
4151 node = &ProxyBase::get_state();
4152 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4157 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4159 XMLNodeList children = node.children ();
4160 XMLNodeList::const_iterator i = children.begin ();
4161 while (i != children.end()) {
4162 XMLProperty const * prop = (*i)->property (X_("name"));
4163 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4169 if (i != children.end()) {
4170 XMLProperty const * prop;
4171 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4172 want_custom = PBD::string_is_affirmative (prop->value ());
4176 return ProxyBase::set_state (node, 0);
4180 ProcessorWindowProxy::get (bool create)
4182 boost::shared_ptr<Processor> p = _processor.lock ();
4187 if (_window && (is_custom != want_custom)) {
4188 /* drop existing window - wrong type */
4197 is_custom = want_custom;
4198 _window = _processor_box->get_editor_window (p, is_custom);
4203 _window->show_all ();
4209 ProcessorWindowProxy::show_the_right_window ()
4211 if (_window && (is_custom != want_custom)) {
4212 /* drop existing window - wrong type */
4217 is_custom = want_custom;
4224 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4225 : WM::ProxyBase (name, string())
4226 , _processor (processor)
4228 boost::shared_ptr<Processor> p = _processor.lock ();
4232 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4235 PluginPinWindowProxy::~PluginPinWindowProxy()
4240 ARDOUR::SessionHandlePtr*
4241 PluginPinWindowProxy::session_handle ()
4243 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4244 if (aw) { return aw; }
4249 PluginPinWindowProxy::get (bool create)
4251 boost::shared_ptr<Processor> p = _processor.lock ();
4252 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4261 _window = new PluginPinDialog (pi);
4262 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4264 aw->set_session (_session);
4266 _window->show_all ();
4272 PluginPinWindowProxy::processor_going_away ()
4276 WM::Manager::instance().remove (this);
4277 going_away_connection.disconnect();
4281 ProcessorBox::load_bindings ()
4283 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);