2 Copyright (C) 2000-2004 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "gtk2ardour-config.h"
28 #include <sigc++/bind.h>
30 #include "pbd/convert.h"
31 #include "canvas/utils.h"
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <gtkmm/messagedialog.h>
38 #include <gtkmm2ext/gtk_ui.h>
39 #include <gtkmm2ext/utils.h>
40 #include <gtkmm2ext/choice.h>
41 #include <gtkmm2ext/utils.h>
42 #include <gtkmm2ext/doi.h>
43 #include <gtkmm2ext/rgb_macros.h>
45 #include "ardour/amp.h"
46 #include "ardour/audio_track.h"
47 #include "ardour/audioengine.h"
48 #include "ardour/internal_return.h"
49 #include "ardour/internal_send.h"
50 #include "ardour/luaproc.h"
51 #include "ardour/luascripting.h"
52 #include "ardour/meter.h"
53 #include "ardour/panner_shell.h"
54 #include "ardour/plugin_insert.h"
55 #include "ardour/pannable.h"
56 #include "ardour/port_insert.h"
57 #include "ardour/profile.h"
58 #include "ardour/return.h"
59 #include "ardour/route.h"
60 #include "ardour/send.h"
61 #include "ardour/session.h"
62 #include "ardour/types.h"
64 #include "LuaBridge/LuaBridge.h"
67 #include "ardour_dialog.h"
68 #include "ardour_ui.h"
69 #include "gui_thread.h"
70 #include "io_selector.h"
72 #include "luainstance.h"
74 #include "mixer_strip.h"
75 #include "plugin_pin_dialog.h"
76 #include "plugin_selector.h"
77 #include "plugin_ui.h"
78 #include "port_insert_ui.h"
79 #include "processor_box.h"
80 #include "public_editor.h"
81 #include "return_ui.h"
82 #include "route_processor_selection.h"
83 #include "script_selector.h"
87 #include "new_plugin_preset_dialog.h"
91 #ifdef AUDIOUNIT_SUPPORT
96 bool ProcessorBox::show_all_processors = false;
100 using namespace ARDOUR;
103 using namespace Glib;
104 using namespace Gtkmm2ext;
106 ProcessorBox* ProcessorBox::_current_processor_box = 0;
107 RefPtr<Action> ProcessorBox::paste_action;
108 RefPtr<Action> ProcessorBox::cut_action;
109 RefPtr<Action> ProcessorBox::copy_action;
110 RefPtr<Action> ProcessorBox::rename_action;
111 RefPtr<Action> ProcessorBox::delete_action;
112 RefPtr<Action> ProcessorBox::backspace_action;
113 RefPtr<Action> ProcessorBox::manage_pins_action;
114 RefPtr<Action> ProcessorBox::edit_action;
115 RefPtr<Action> ProcessorBox::edit_generic_action;
116 RefPtr<ActionGroup> ProcessorBox::processor_box_actions;
117 Gtkmm2ext::ActionMap ProcessorBox::myactions (X_("processor box"));
118 Gtkmm2ext::Bindings* ProcessorBox::bindings = 0;
121 // TODO consolidate with PluginPinDialog::set_color
122 static void set_routing_color (cairo_t* cr, bool midi)
124 static const uint32_t audio_port_color = 0x4A8A0EFF; // Green
125 static const uint32_t midi_port_color = 0x960909FF; //Red
128 cairo_set_source_rgb (cr,
129 UINT_RGBA_R_FLT(midi_port_color),
130 UINT_RGBA_G_FLT(midi_port_color),
131 UINT_RGBA_B_FLT(midi_port_color));
133 cairo_set_source_rgb (cr,
134 UINT_RGBA_R_FLT(audio_port_color),
135 UINT_RGBA_G_FLT(audio_port_color),
136 UINT_RGBA_B_FLT(audio_port_color));
140 ProcessorEntry::ProcessorEntry (ProcessorBox* parent, boost::shared_ptr<Processor> p, Width w)
141 : _button (ArdourButton::led_default_elements)
142 , _position (PreFader)
146 , _unknown_processor(false)
152 , output_routing_icon(false)
157 _button.set_distinct_led_click (true);
158 _button.set_fallthrough_to_parent(true);
159 _button.set_led_left (true);
160 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &ProcessorEntry::led_clicked));
161 _button.set_text (name (_width));
163 if (boost::dynamic_pointer_cast<PeakMeter> (_processor)) {
164 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
166 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
167 _button.set_elements(ArdourButton::Element(_button.elements() & ~ArdourButton::Indicator));
168 _unknown_processor = true;
171 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
172 if (pi && pi->plugin()) {
173 _plugin_preset_pointer = PluginPresetPtr (new PluginPreset (pi->plugin()->get_info()));
178 _vbox.pack_start (routing_icon);
179 _vbox.pack_start (input_icon);
180 _vbox.pack_start (_button, true, true);
182 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
183 if (pi && pi->plugin() && pi->plugin()->has_inline_display()) {
184 if (pi->plugin()->get_info()->type != ARDOUR::Lua) {
185 _plugin_display = new PluginDisplay (*this, pi->plugin(),
186 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
188 assert (boost::dynamic_pointer_cast<LuaProc>(pi->plugin()));
189 _plugin_display = new LuaPluginDisplay (*this, boost::dynamic_pointer_cast<LuaProc>(pi->plugin()),
190 std::max (60.f, rintf(112.f * UIConfiguration::instance().get_ui_scale())));
192 _vbox.pack_start (*_plugin_display);
193 _plugin_display->set_no_show_all (true);
194 if (UIConfiguration::instance().get_show_inline_display_by_default ()) {
195 _plugin_display->show ();
198 _vbox.pack_end (output_routing_icon);
199 _vbox.pack_end (output_icon);
201 _button.set_active (_processor->enabled ());
203 input_icon.set_no_show_all(true);
204 routing_icon.set_no_show_all(true);
205 output_icon.set_no_show_all(true);
206 output_routing_icon.set_no_show_all(true);
212 output_routing_icon.hide();
214 _processor->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_active_changed, this), gui_context());
215 _processor->PropertyChanged.connect (name_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_property_changed, this, _1), gui_context());
216 _processor->ConfigurationChanged.connect (config_connection, invalidator (*this), boost::bind (&ProcessorEntry::processor_configuration_changed, this, _1, _2), gui_context());
218 set<Evoral::Parameter> p = _processor->what_can_be_automated ();
219 for (set<Evoral::Parameter>::iterator i = p.begin(); i != p.end(); ++i) {
221 std::string label = _processor->describe_parameter (*i);
223 if (boost::dynamic_pointer_cast<Send> (_processor)) {
225 } else if (boost::dynamic_pointer_cast<Return> (_processor)) {
229 Control* c = new Control (_processor->automation_control (*i), label);
231 _controls.push_back (c);
233 if (boost::dynamic_pointer_cast<Amp> (_processor) == 0) {
234 /* Add non-Amp (Fader & Trim) controls to the processor box */
235 _vbox.pack_start (c->box);
242 _vbox.set_size_request (-1, _button.size_request().height);
246 ProcessorEntry::~ProcessorEntry ()
248 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
251 delete _plugin_display;
255 ProcessorEntry::action_widget ()
261 ProcessorEntry::widget ()
267 ProcessorEntry::drag_text () const
273 ProcessorEntry::can_copy_state (Gtkmm2ext::DnDVBoxChild* o) const
275 ProcessorEntry *other = dynamic_cast<ProcessorEntry*> (o);
279 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
280 boost::shared_ptr<PluginInsert> my_pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
281 boost::shared_ptr<PluginInsert> ot_pi = boost::dynamic_pointer_cast<PluginInsert> (otherproc);
282 if (boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
285 if (boost::dynamic_pointer_cast<UnknownProcessor> (otherproc)) {
288 if (!my_pi || !ot_pi) {
291 if (my_pi->type() != ot_pi->type()) {
294 boost::shared_ptr<Plugin> my_p = my_pi->plugin();
295 boost::shared_ptr<Plugin> ot_p = ot_pi->plugin();
296 if (!my_p || !ot_p) {
299 if (my_p->unique_id() != ot_p->unique_id()) {
306 ProcessorEntry::drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &data)
308 if (data.get_target() == "PluginPresetPtr") {
309 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
311 if (!_plugin_preset_pointer || !pi) {
312 data.set (data.get_target(), 8, NULL, 0);
316 boost::shared_ptr<ARDOUR::Plugin> plugin = pi->plugin();
319 PluginManager& manager (PluginManager::instance());
320 bool fav = manager.get_status (_plugin_preset_pointer->_pip) == PluginManager::Favorite;
322 NewPluginPresetDialog d (plugin,
323 string_compose(_("New Favorite Preset for \"%1\""),_plugin_preset_pointer->_pip->name), !fav);
325 _plugin_preset_pointer->_preset.valid = false;
328 case Gtk::RESPONSE_CANCEL:
329 data.set (data.get_target(), 8, NULL, 0);
333 case Gtk::RESPONSE_NO:
336 case Gtk::RESPONSE_ACCEPT:
337 if (d.name().empty()) {
342 plugin->remove_preset (d.name ());
345 Plugin::PresetRecord const r = plugin->save_preset (d.name());
347 if (!r.uri.empty ()) {
348 _plugin_preset_pointer->_preset.uri = r.uri;
349 _plugin_preset_pointer->_preset.label = r.label;
350 _plugin_preset_pointer->_preset.user = r.user;
351 _plugin_preset_pointer->_preset.valid = r.valid;
354 data.set (data.get_target(), 8, (const guchar *) &_plugin_preset_pointer, sizeof (PluginPresetPtr));
361 ProcessorEntry::set_position (Position p, uint32_t num)
369 ProcessorEntry::set_visual_state (Gtkmm2ext::VisualState s, bool yn)
372 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() | s));
374 _button.set_visual_state (Gtkmm2ext::VisualState (_button.visual_state() & ~s));
379 ProcessorEntry::setup_visuals ()
381 if (_unknown_processor) {
382 _button.set_name ("processor stub");
385 boost::shared_ptr<Send> send;
386 if ((send = boost::dynamic_pointer_cast<Send> (_processor))) {
387 if (send->remove_on_disconnect ()) {
388 _button.set_name ("processor sidechain");
395 if (_plugin_display) { _plugin_display->set_name ("processor prefader"); }
396 _button.set_name ("processor prefader");
400 _button.set_name ("processor fader");
404 if (_plugin_display) { _plugin_display->set_name ("processor postfader"); }
405 _button.set_name ("processor postfader");
411 boost::shared_ptr<Processor>
412 ProcessorEntry::processor () const
415 return boost::shared_ptr<Processor>();
421 ProcessorEntry::set_enum_width (Width w)
424 _button.set_text (name (_width));
428 ProcessorEntry::led_clicked(GdkEventButton *ev)
430 bool ctrl_shift_pressed = false;
431 Keyboard::ModifierMask ctrl_shift_mask = Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier);
433 if (Keyboard::modifier_state_equals (ev->state, ctrl_shift_mask)) {
434 ctrl_shift_pressed = true;
438 if (_button.get_active ()) {
439 if (ctrl_shift_pressed) {
440 _parent->all_visible_processors_active(false);
442 if (_position == Fader) {
443 _processor->enable (false);
447 _processor->enable (false);
451 if (ctrl_shift_pressed) {
452 _parent->all_visible_processors_active(true);
454 if (_position == Fader) {
455 _processor->enable (true);
459 _processor->enable (true);
466 ProcessorEntry::processor_active_changed ()
469 _button.set_active (_processor->enabled ());
474 ProcessorEntry::processor_property_changed (const PropertyChange& what_changed)
476 if (what_changed.contains (ARDOUR::Properties::name)) {
477 _button.set_text (name (_width));
483 ProcessorEntry::processor_configuration_changed (const ChanCount in, const ChanCount out)
485 _parent->setup_routing_feeds ();
486 input_icon.queue_draw();
487 output_icon.queue_draw();
488 routing_icon.queue_draw();
489 output_routing_icon.queue_draw();
493 ProcessorEntry::setup_tooltip ()
496 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_processor);
498 std::string postfix = "";
500 if ((replicated = pi->get_count()) > 1) {
501 postfix = string_compose(_("\nThis mono plugin has been replicated %1 times."), replicated);
503 if (pi->plugin()->has_editor()) {
504 ARDOUR_UI_UTILS::set_tooltip (_button,
505 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));
507 ARDOUR_UI_UTILS::set_tooltip (_button,
508 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), name (Wide), postfix));
512 if(boost::dynamic_pointer_cast<UnknownProcessor> (_processor)) {
513 ARDOUR_UI::instance()->set_tip (_button,
514 string_compose (_("<b>%1</b>\nThe Plugin is not available on this system\nand has been replaced by a stub."), name (Wide)));
517 boost::shared_ptr<Send> send;
518 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
519 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
520 if (send->remove_on_disconnect ()) {
521 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>\nThis (sidechain) send will be removed when disconnected.", _processor->name()));
523 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>> %1</b>", _processor->name()));
528 ARDOUR_UI_UTILS::set_tooltip (_button, string_compose ("<b>%1</b>", name (Wide)));
532 ProcessorEntry::name (Width w) const
534 boost::shared_ptr<Send> send;
541 if ((send = boost::dynamic_pointer_cast<Send> (_processor)) != 0 &&
542 !boost::dynamic_pointer_cast<InternalSend>(_processor)) {
545 std::string send_name;
546 bool pretty_ok = true;
548 if (send->remove_on_disconnect ()) {
549 // assume it's a sidechain, find pretty name of connected port(s)
550 PortSet& ps (send->output ()->ports ());
551 for (PortSet::iterator i = ps.begin (); i != ps.end () && pretty_ok; ++i) {
552 vector<string> connections;
553 if (i->get_connections (connections)) {
554 vector<string>::const_iterator ci;
555 for (ci = connections.begin(); ci != connections.end(); ++ci) {
556 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (*ci);
560 if (send_name.empty ()) {
562 } else if (send_name != pn) {
563 // pretty names don't match
576 /* grab the send name out of its overall name */
577 if (send_name.empty()) {
578 send_name = send->name();
579 string::size_type lbracket, rbracket;
580 lbracket = send_name.find ('[');
581 rbracket = send_name.find (']');
582 send_name = send_name.substr (lbracket+1, lbracket-rbracket-1);
587 name_display += send_name;
590 name_display += PBD::short_version (send_name, 5);
595 boost::shared_ptr<ARDOUR::PluginInsert> pi;
597 if ((pi = boost::dynamic_pointer_cast<ARDOUR::PluginInsert> (_processor)) != 0
598 && (replicated = pi->get_count()) > 1)
600 name_display += string_compose(_("(%1x1) "), replicated);
605 name_display += _processor->display_name();
608 name_display += PBD::short_version (_processor->display_name(), 5);
618 ProcessorEntry::show_all_controls ()
620 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
621 (*i)->set_visible (true);
624 _parent->update_gui_object_state (this);
628 ProcessorEntry::hide_all_controls ()
630 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
631 (*i)->set_visible (false);
634 _parent->update_gui_object_state (this);
638 ProcessorEntry::add_control_state (XMLNode* node) const
640 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
641 (*i)->add_state (node);
644 if (_plugin_display) {
645 XMLNode* c = new XMLNode (X_("Object"));
646 c->add_property (X_("id"), X_("InlineDisplay"));
647 c->add_property (X_("visible"), _plugin_display->is_visible ());
648 node->add_child_nocopy (*c);
653 ProcessorEntry::set_control_state (XMLNode const * node)
655 for (list<Control*>::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
656 (*i)->set_state (node);
659 if (_plugin_display) {
660 XMLNode* n = GUIObjectState::get_node (node, X_("InlineDisplay"));
661 XMLProperty const * p = n ? n->property (X_("visible")) : NULL;
663 if (string_is_affirmative (p->value ())) {
664 _plugin_display->show();
666 _plugin_display->hide();
673 ProcessorEntry::state_id () const
675 return string_compose ("processor %1", _processor->id().to_s());
679 ProcessorEntry::hide_things ()
681 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
682 (*i)->hide_things ();
688 ProcessorEntry::build_controls_menu ()
690 using namespace Menu_Helpers;
691 Menu* menu = manage (new Menu);
692 MenuList& items = menu->items ();
694 if (_plugin_display) {
695 items.push_back (CheckMenuElem (_("Inline Display")));
696 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
697 c->set_active (_plugin_display->is_visible ());
698 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_inline_display_visibility));
699 items.push_back (SeparatorElem ());
703 MenuElem (_("Show All Controls"), sigc::mem_fun (*this, &ProcessorEntry::show_all_controls))
707 MenuElem (_("Hide All Controls"), sigc::mem_fun (*this, &ProcessorEntry::hide_all_controls))
710 if (!_controls.empty ()) {
711 items.push_back (SeparatorElem ());
714 for (list<Control*>::iterator i = _controls.begin(); i != _controls.end(); ++i) {
715 items.push_back (CheckMenuElem ((*i)->name ()));
716 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
717 c->set_active ((*i)->visible ());
718 c->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &ProcessorEntry::toggle_control_visibility), *i));
725 ProcessorEntry::toggle_inline_display_visibility ()
727 if (_plugin_display->is_visible ()) {
728 _plugin_display->hide();
730 _plugin_display->show();
732 _parent->update_gui_object_state (this);
736 ProcessorEntry::toggle_control_visibility (Control* c)
738 c->set_visible (!c->visible ());
739 _parent->update_gui_object_state (this);
743 ProcessorEntry::build_send_options_menu ()
745 using namespace Menu_Helpers;
746 Menu* menu = manage (new Menu);
747 MenuList& items = menu->items ();
749 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
752 items.push_back (CheckMenuElem (_("Link panner controls")));
753 Gtk::CheckMenuItem* c = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
754 c->set_active (send->panner_shell()->is_linked_to_route());
755 c->signal_toggled().connect (sigc::mem_fun (*this, &ProcessorEntry::toggle_panner_link));
762 ProcessorEntry::toggle_panner_link ()
764 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (_processor);
766 send->panner_shell()->set_linked_to_route(!send->panner_shell()->is_linked_to_route());
770 ProcessorEntry::Control::Control (boost::shared_ptr<AutomationControl> c, string const & n)
772 , _adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
773 , _slider (&_adjustment, boost::shared_ptr<PBD::Controllable>(), 0, max(13.f, rintf(13.f * UIConfiguration::instance().get_ui_scale())))
774 , _slider_persistant_tooltip (&_slider)
775 , _button (ArdourButton::led_default_elements)
776 , _ignore_ui_adjustment (false)
780 _slider.set_controllable (c);
781 box.set_padding(0, 0, 4, 4);
784 _button.set_text (_name);
785 _button.set_led_left (true);
786 _button.set_name ("processor control button");
790 _button.signal_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked));
791 _button.signal_led_clicked.connect (sigc::mem_fun (*this, &Control::button_clicked_event));
792 // dup. currently timers are used :(
793 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
797 _slider.set_name ("ProcessorControlSlider");
798 _slider.set_text (_name);
803 const ARDOUR::ParameterDescriptor& desc = c->desc();
804 double const lo = c->internal_to_interface(desc.lower);
805 double const up = c->internal_to_interface(desc.upper);
806 double const normal = c->internal_to_interface(desc.normal);
807 double smallstep = desc.smallstep;
808 double largestep = desc.largestep;
810 if (smallstep == 0.0) {
811 smallstep = up / 1000.;
813 smallstep = c->internal_to_interface(desc.lower + smallstep);
816 if (largestep == 0.0) {
817 largestep = up / 40.;
819 largestep = c->internal_to_interface(desc.lower + largestep);
822 _adjustment.set_lower (lo);
823 _adjustment.set_upper (up);
824 _adjustment.set_step_increment (smallstep);
825 _adjustment.set_page_increment (largestep);
826 _slider.set_default_value (normal);
828 _adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &Control::slider_adjusted));
829 // dup. currently timers are used :(
830 //c->Changed.connect (_connection, MISSING_INVALIDATOR, boost::bind (&Control::control_changed, this), gui_context ());
833 // yuck, do we really need to do this?
834 // according to c404374 this is only needed for send automation
835 timer_connection = Timers::rapid_connect (sigc::mem_fun (*this, &Control::control_changed));
840 /* We're providing our own PersistentTooltip */
841 set_no_tooltip_whatsoever (_slider);
844 ProcessorEntry::Control::~Control ()
846 timer_connection.disconnect ();
850 ProcessorEntry::Control::set_tooltip ()
852 boost::shared_ptr<AutomationControl> c = _control.lock ();
859 snprintf (tmp, sizeof(tmp), "%s: %s", _name.c_str(), c->get_value() > 0.5 ? _("on") : _("off"));
861 snprintf (tmp, sizeof(tmp), "%s: %.2f", _name.c_str(), c->internal_to_user (c->get_value ()));
864 string sm = Gtkmm2ext::markup_escape_text (tmp);
865 _slider_persistant_tooltip.set_tip (sm);
866 ARDOUR_UI_UTILS::set_tooltip (_button, sm);
870 ProcessorEntry::Control::slider_adjusted ()
872 if (_ignore_ui_adjustment) {
876 boost::shared_ptr<AutomationControl> c = _control.lock ();
882 c->set_value ( c->interface_to_internal(_adjustment.get_value ()) , Controllable::NoGroup);
887 ProcessorEntry::Control::button_clicked ()
889 boost::shared_ptr<AutomationControl> c = _control.lock ();
895 bool const n = _button.get_active ();
897 c->set_value (n ? 0 : 1, Controllable::NoGroup);
898 _button.set_active (!n);
903 ProcessorEntry::Control::button_clicked_event (GdkEventButton *ev)
911 ProcessorEntry::Control::control_changed ()
913 boost::shared_ptr<AutomationControl> c = _control.lock ();
918 _ignore_ui_adjustment = true;
922 _button.set_active (c->get_value() > 0.5);
925 // as long as rapid timers are used, only update the tooltip
926 // if the value has changed.
927 const double nval = c->internal_to_interface (c->get_value ());
928 if (_adjustment.get_value() != nval) {
929 _adjustment.set_value (nval);
934 _ignore_ui_adjustment = false;
938 ProcessorEntry::Control::add_state (XMLNode* node) const
940 XMLNode* c = new XMLNode (X_("Object"));
941 c->add_property (X_("id"), state_id ());
942 c->add_property (X_("visible"), _visible);
943 node->add_child_nocopy (*c);
947 ProcessorEntry::Control::set_state (XMLNode const * node)
949 XMLNode* n = GUIObjectState::get_node (node, state_id ());
951 XMLProperty const * p = n->property (X_("visible"));
952 set_visible (p && string_is_affirmative (p->value ()));
959 ProcessorEntry::Control::set_visible (bool v)
970 /** Called when the Editor might have re-shown things that
974 ProcessorEntry::Control::hide_things ()
982 ProcessorEntry::Control::state_id () const
984 boost::shared_ptr<AutomationControl> c = _control.lock ();
987 return string_compose (X_("control %1"), c->id().to_s ());
990 PluginInsertProcessorEntry::PluginInsertProcessorEntry (ProcessorBox* b, boost::shared_ptr<ARDOUR::PluginInsert> p, Width w)
991 : ProcessorEntry (b, p, w)
994 p->PluginIoReConfigure.connect (
995 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
997 p->PluginMapChanged.connect (
998 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1000 p->PluginConfigChanged.connect (
1001 _iomap_connection, invalidator (*this), boost::bind (&PluginInsertProcessorEntry::iomap_changed, this), gui_context()
1006 PluginInsertProcessorEntry::iomap_changed ()
1008 _parent->setup_routing_feeds ();
1009 routing_icon.queue_draw();
1010 output_routing_icon.queue_draw();
1014 PluginInsertProcessorEntry::hide_things ()
1016 ProcessorEntry::hide_things ();
1019 ProcessorEntry::PortIcon::PortIcon(bool input) {
1021 _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
1022 set_size_request (-1, std::max (2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale())));
1026 ProcessorEntry::PortIcon::on_expose_event (GdkEventExpose* ev)
1028 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1030 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1033 Gtk::Allocation a = get_allocation();
1034 double const width = a.get_width();
1035 double const height = a.get_height();
1037 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1038 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1040 cairo_rectangle (cr, 0, 0, width, height);
1043 const double dx = rint(max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1044 for (uint32_t i = 0; i < _ports.n_total(); ++i) {
1045 set_routing_color (cr, i < _ports.n_midi());
1046 const double x = ProcessorEntry::RoutingIcon::pin_x_pos (i, width, _ports.n_total(), 0 , false);
1047 cairo_rectangle (cr, x - .5 - dx * .5, 0, 1 + dx, height);
1055 ProcessorEntry::RoutingIcon::RoutingIcon (bool input)
1059 set_terminal (false);
1063 ProcessorEntry::RoutingIcon::set_terminal (bool b) {
1065 int h = std::max (8.f, rintf(8.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1067 h += std::max (4.f, rintf(4.f * sqrt (UIConfiguration::instance().get_ui_scale())));
1069 set_size_request (-1, h);
1073 ProcessorEntry::RoutingIcon::set (
1074 const ARDOUR::ChanCount& in,
1075 const ARDOUR::ChanCount& out,
1076 const ARDOUR::ChanCount& sinks,
1077 const ARDOUR::ChanCount& sources,
1078 const ARDOUR::ChanMapping& in_map,
1079 const ARDOUR::ChanMapping& out_map,
1080 const ARDOUR::ChanMapping& thru_map)
1088 _thru_map = thru_map;
1092 ProcessorEntry::RoutingIcon::in_identity () const {
1093 if (_thru_map.n_total () > 0) {
1096 if (!_in_map.is_monotonic () || !_in_map.is_identity ()) {
1099 if (_in_map.n_total () != _sinks.n_total () || _in.n_total () != _sinks.n_total ()) {
1106 ProcessorEntry::RoutingIcon::out_identity () const {
1107 if (_thru_map.n_total () > 0) {
1108 // TODO skip if trhu is not connected to any of next's inputs
1111 if (!_out_map.is_monotonic () || !_out_map.is_identity ()) {
1114 if (_out_map.n_total () != _sources.n_total () || _out.n_total () != _sources.n_total ()) {
1121 ProcessorEntry::RoutingIcon::can_coalesce () const {
1122 if (_thru_map.n_total () > 0) {
1125 if (_fed_by && _f_out != _f_sources) {
1128 if (_fed_by && !_f_out_map.is_identity () && !_in_map.is_identity ()) {
1131 if (_input && _sinks == _in && (!_fed_by || _f_out == _in)) {
1138 ProcessorEntry::RoutingIcon::set_fed_by (
1139 const ARDOUR::ChanCount& out,
1140 const ARDOUR::ChanCount& sources,
1141 const ARDOUR::ChanMapping& out_map,
1142 const ARDOUR::ChanMapping& thru_map)
1145 _f_sources = sources;
1146 _f_out_map = out_map;
1147 _f_thru_map = thru_map;
1152 ProcessorEntry::RoutingIcon::set_feeding (
1153 const ARDOUR::ChanCount& in,
1154 const ARDOUR::ChanCount& sinks,
1155 const ARDOUR::ChanMapping& in_map,
1156 const ARDOUR::ChanMapping& thru_map)
1161 _i_thru_map = thru_map;
1166 ProcessorEntry::RoutingIcon::pin_x_pos (uint32_t i, double width, uint32_t n_total, uint32_t n_midi, bool midi)
1168 if (!midi) { i += n_midi; }
1171 return rint (width * .5) +.5;
1173 return rint (width * (.15 + .7 * i / (n_total - 1))) + .5;
1177 ProcessorEntry::RoutingIcon::draw_gnd (cairo_t* cr, double x0, double y0, double height, bool midi)
1179 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1180 const double y1 = rint (height * .66) + .5;
1183 cairo_translate (cr, x0, y0);
1184 cairo_move_to (cr, 0, height);
1185 cairo_line_to (cr, 0, y1);
1186 cairo_move_to (cr, 0 - dx, y1);
1187 cairo_line_to (cr, 0 + dx, y1);
1189 set_routing_color (cr, midi);
1190 cairo_set_line_width (cr, 1.0);
1196 ProcessorEntry::RoutingIcon::draw_sidechain (cairo_t* cr, double x0, double y0, double height, bool midi)
1198 const double dx = 1 + rint (max(2., 2. * UIConfiguration::instance().get_ui_scale()));
1199 const double y1 = rint (height * .5) - .5;
1202 cairo_translate (cr, x0, y0);
1203 cairo_move_to (cr, 0 - dx, height);
1204 cairo_line_to (cr, 0, y1);
1205 cairo_line_to (cr, 0 + dx, height);
1206 cairo_close_path (cr);
1208 set_routing_color (cr, midi);
1214 ProcessorEntry::RoutingIcon::draw_thru_src (cairo_t* cr, double x0, double y0, double height, bool midi)
1216 const double rad = 1;
1217 const double y1 = height - rad - 1.5;
1219 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1220 cairo_move_to (cr, x0, y0 + height - 1.5);
1221 cairo_line_to (cr, x0, y0 + height);
1222 set_routing_color (cr, midi);
1223 cairo_set_line_width (cr, 1.0);
1228 ProcessorEntry::RoutingIcon::draw_thru_sink (cairo_t* cr, double x0, double y0, double height, bool midi)
1230 const double rad = 1;
1231 const double y1 = rad + 1;
1233 cairo_arc (cr, x0, y0 + y1, rad, 0, 2. * M_PI);
1234 cairo_move_to (cr, x0, y0);
1235 cairo_line_to (cr, x0, y0 + 1);
1236 set_routing_color (cr, midi);
1237 cairo_set_line_width (cr, 1.0);
1242 ProcessorEntry::RoutingIcon::draw_connection (cairo_t* cr, double x0, double x1, double y0, double y1, bool midi, bool dashed)
1244 double bz = abs (y1 - y0);
1246 cairo_move_to (cr, x0, y0);
1247 cairo_curve_to (cr, x0, y0 + bz, x1, y1 - bz, x1, y1);
1248 cairo_set_line_width (cr, 1.0);
1249 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1250 cairo_set_source_rgb (cr, 1, 0, 0);
1252 const double dashes[] = { 2, 3 };
1253 cairo_set_dash (cr, dashes, 2, 0);
1255 set_routing_color (cr, midi);
1258 cairo_set_dash (cr, 0, 0, 0);
1263 ProcessorEntry::RoutingIcon::on_expose_event (GdkEventExpose* ev)
1265 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1267 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1270 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
1272 Gtk::Allocation a = get_allocation();
1273 double const width = a.get_width();
1274 double const height = a.get_height();
1276 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1277 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1279 cairo_rectangle (cr, 0, 0, width, height);
1283 if (can_coalesce ()) {
1284 expose_coalesced_input_map (cr, width, height);
1286 expose_input_map (cr, width, height);
1289 expose_output_map (cr, width, height);
1297 ProcessorEntry::RoutingIcon::expose_coalesced_input_map (cairo_t* cr, const double width, const double height)
1299 const uint32_t pc_in = _sinks.n_total();
1300 const uint32_t pc_in_midi = _sinks.n_midi();
1302 for (uint32_t i = 0; i < pc_in; ++i) {
1303 const bool is_midi = i < pc_in_midi;
1305 uint32_t pn = is_midi ? i : i - pc_in_midi;
1306 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1307 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1309 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1310 draw_gnd (cr, x, 0, height, is_midi);
1313 if (idx >= _in.get (dt)) {
1314 // side-chain, probably
1315 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1316 draw_sidechain (cr, x, 0, height, is_midi);
1320 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1324 uint32_t src = _f_out_map.get_src (dt, idx, &valid_src);
1326 double x = pin_x_pos (i, width, pc_in, 0, false);
1328 _f_thru_map.get (dt, idx, &valid_thru);
1330 draw_thru_src (cr, x, 0, height, is_midi);
1332 draw_gnd (cr, x, 0, height, is_midi);
1336 c_x0 = pin_x_pos (src, width, _f_sources.n_total(), _f_sources.n_midi(), is_midi);
1338 c_x0 = pin_x_pos (idx, width, _in.n_total(), _in.n_midi(), is_midi);
1340 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1345 ProcessorEntry::RoutingIcon::expose_input_map (cairo_t* cr, const double width, const double height)
1347 const uint32_t n_in = _in.n_total();
1348 const uint32_t n_in_midi = _in.n_midi();
1349 const uint32_t pc_in = _sinks.n_total();
1350 const uint32_t pc_in_midi = _sinks.n_midi();
1352 // draw inputs to this
1353 for (uint32_t i = 0; i < pc_in; ++i) {
1354 const bool is_midi = i < pc_in_midi;
1356 uint32_t pn = is_midi ? i : i - pc_in_midi;
1357 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1358 uint32_t idx = _in_map.get (dt, pn, &valid_in);
1359 // check if it's fed
1360 bool valid_src = true;
1361 if (valid_in && idx < _in.get (dt) && _fed_by) {
1364 _f_out_map.get_src (dt, idx, &valid_out);
1365 _f_thru_map.get (dt, idx, &valid_thru);
1366 if (!valid_out && !valid_thru) {
1370 if (!valid_in || !valid_src) {
1371 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1372 draw_gnd (cr, x, 0, height, is_midi);
1375 if (idx >= _in.get (dt)) {
1376 // side-chain, probably
1377 double x = pin_x_pos (i, width, pc_in, 0, is_midi);
1378 draw_sidechain (cr, x, 0, height, is_midi);
1381 double c_x1 = pin_x_pos (i, width, pc_in, 0, false);
1382 double c_x0 = pin_x_pos (idx, width, n_in, n_in_midi, is_midi);
1383 draw_connection (cr, c_x0, c_x1, 0, height, is_midi);
1386 // draw reverse thru
1387 for (uint32_t i = 0; i < n_in; ++i) {
1388 const bool is_midi = i < n_in_midi;
1390 uint32_t pn = is_midi ? i : i - n_in_midi;
1391 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1392 _thru_map.get_src (dt, pn, &valid_thru);
1396 double x = pin_x_pos (i, width, n_in, 0, is_midi);
1397 draw_thru_sink (cr, x, 0, height, is_midi);
1402 ProcessorEntry::RoutingIcon::expose_output_map (cairo_t* cr, const double width, const double height)
1404 int dh = std::max (4.f, rintf(4.f * UIConfiguration::instance().get_ui_scale()));
1405 double ht = _terminal ? height - dh : height;
1407 // draw outputs of this
1408 const uint32_t pc_out = _sources.n_total();
1409 const uint32_t pc_out_midi = _sources.n_midi();
1410 const uint32_t n_out = _out.n_total();
1411 const uint32_t n_out_midi = _out.n_midi();
1413 for (uint32_t i = 0; i < pc_out; ++i) {
1414 const bool is_midi = i < pc_out_midi;
1416 uint32_t pn = is_midi ? i : i - pc_out_midi;
1417 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1418 uint32_t idx = _out_map.get (dt, pn, &valid_out);
1422 // skip connections that are not used in the next's input
1424 bool valid_thru, valid_sink;
1425 _i_in_map.get_src (dt, idx, &valid_sink);
1426 _i_thru_map.get_src (dt, idx, &valid_thru);
1427 if (!valid_thru && !valid_sink) {
1428 if (!is_midi || i != 0) { // special case midi-bypass
1433 double c_x0 = pin_x_pos (i, width, pc_out, 0, false);
1434 double c_x1 = pin_x_pos (idx, width, n_out, n_out_midi, is_midi);
1435 draw_connection (cr, c_x0, c_x1, 0, ht, is_midi);
1438 for (uint32_t i = 0; i < n_out; ++i) {
1439 const bool is_midi = i < n_out_midi;
1440 uint32_t pn = is_midi ? i : i - n_out_midi;
1441 DataType dt = is_midi ? DataType::MIDI : DataType::AUDIO;
1442 double x = pin_x_pos (i, width, n_out, 0, is_midi);
1445 bool valid_thru_f = false;
1446 // skip connections that are not used in the next's input
1449 _i_in_map.get_src (dt, pn, &valid_sink);
1450 _i_thru_map.get_src (dt, pn, &valid_thru_f);
1451 if (!valid_thru_f && !valid_sink) {
1452 if (!is_midi || i != 0) { // special case midi-bypass
1459 _out_map.get_src (dt, pn, &valid_src);
1462 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1464 if (idx >= _in.get (dt)) {
1465 draw_sidechain (cr, x, 0, height, is_midi);
1467 draw_thru_src (cr, x, 0, height, is_midi);
1469 } else if (valid_thru_f){
1470 // gnd is part of input, unless it's a thru input
1471 // (also only true if !coalesced into one small display)
1472 draw_gnd (cr, x, 0, height, is_midi);
1476 // terminal node, add arrows
1478 _out_map.get_src (dt, pn, &valid_src);
1481 uint32_t idx = _thru_map.get (dt, pn, &valid_thru);
1483 if (idx >= _in.get (dt)) {
1484 draw_sidechain (cr, x, 0, height - dh, is_midi);
1486 draw_thru_src (cr, x, 0, height - dh, is_midi);
1489 draw_gnd (cr, x, 0, height - dh, is_midi);
1493 set_routing_color (cr, is_midi);
1494 cairo_set_line_width (cr, 1.0);
1495 cairo_move_to (cr, x, height - dh);
1496 cairo_line_to (cr, x, height - 2);
1499 const double ar = dh - 1;
1500 cairo_move_to (cr, x - ar, height - ar);
1501 cairo_line_to (cr, x , height - .5);
1502 cairo_line_to (cr, x + ar, height - ar);
1503 cairo_line_to (cr, x , height - ar * .5);
1504 cairo_close_path (cr);
1505 cairo_fill_preserve (cr);
1511 ProcessorEntry::PluginDisplay::PluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::Plugin> p, uint32_t max_height)
1515 , _max_height (max_height)
1519 set_name ("processor prefader");
1520 add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
1521 _plug->QueueDraw.connect (_qdraw_connection, invalidator (*this),
1522 boost::bind (&Gtk::Widget::queue_draw, this), gui_context ());
1524 std::string postfix = "";
1525 if (_plug->has_editor()) {
1526 ARDOUR_UI_UTILS::set_tooltip (*this,
1527 string_compose (_("<b>%1</b>\nDouble-click to show GUI.\n%2+double-click to show generic GUI.%3"), e.name (Wide), Keyboard::primary_modifier_name (), postfix));
1529 ARDOUR_UI_UTILS::set_tooltip (*this,
1530 string_compose (_("<b>%1</b>\nDouble-click to show generic GUI.%2"), e.name (Wide), postfix));
1534 ProcessorEntry::PluginDisplay::~PluginDisplay ()
1537 cairo_surface_destroy (_surf);
1542 ProcessorEntry::PluginDisplay::on_button_press_event (GdkEventButton *ev)
1544 assert (_entry.processor ());
1546 // consider some tweaks to pass this up to the DnDVBox somehow:
1547 // select processor, then call (private)
1548 //_entry._parent->processor_button_press_event (ev, &_entry);
1549 if (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS)) {
1550 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
1551 _entry._parent->generic_edit_processor (_entry.processor ());
1553 _entry._parent->edit_processor (_entry.processor ());
1561 ProcessorEntry::PluginDisplay::on_button_release_event (GdkEventButton *ev)
1567 ProcessorEntry::PluginDisplay::on_size_request (Requisition* req)
1570 req->height = _cur_height;
1575 ProcessorEntry::PluginDisplay::update_height_alloc (uint32_t inline_height)
1577 /* work-around scroll-bar + aspect ratio
1578 * show inline-view -> height changes -> scrollbar gets added
1579 * -> width changes -> inline-view, fixed aspect ratio -> height changes
1580 * -> scroll bar is removed [-> width changes ; repeat ]
1582 uint32_t shm = std::min (_max_height, inline_height);
1584 Gtk::Container* pr = get_parent();
1585 for (uint32_t i = 0; i < 4 && pr; ++i) {
1586 // VBox, EventBox, ViewPort, ScrolledWindow
1587 pr = pr->get_parent();
1589 Gtk::ScrolledWindow* sw = dynamic_cast<Gtk::ScrolledWindow*> (pr);
1591 const Gtk::VScrollbar* vsb = sw->get_vscrollbar();
1592 sc = vsb && vsb->is_visible();
1595 if (shm != _cur_height) {
1596 if (_scroll == sc || _cur_height < shm) {
1605 ProcessorEntry::PluginDisplay::render_inline (cairo_t* cr, uint32_t width)
1607 Plugin::Display_Image_Surface* dis = _plug->render_inline_display (width, _max_height);
1612 /* allocate a local image-surface,
1613 * We cannot re-use the data via cairo_image_surface_create_for_data(),
1614 * since pixman keeps a reference to it.
1615 * we'd need to hand over the data and ha cairo_surface_destroy to free it.
1616 * it might be possible to work around via cairo_surface_set_user_data().
1619 || dis->width != cairo_image_surface_get_width (_surf)
1620 || dis->height != cairo_image_surface_get_height (_surf)
1623 cairo_surface_destroy (_surf);
1625 _surf = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, dis->width, dis->height);
1628 if (cairo_image_surface_get_stride (_surf) == dis->stride) {
1629 memcpy (cairo_image_surface_get_data (_surf), dis->data, dis->stride * dis->height);
1631 unsigned char *src = dis->data;
1632 unsigned char *dst = cairo_image_surface_get_data (_surf);
1633 const int dst_stride = cairo_image_surface_get_stride (_surf);
1634 for (int y = 0; y < dis->height; ++y) {
1635 memcpy (dst, src, dis->width * 4 /*ARGB32*/);
1641 cairo_surface_flush(_surf);
1642 cairo_surface_mark_dirty(_surf);
1643 const double xc = floor ((width - dis->width) * .5);
1644 cairo_set_source_surface(cr, _surf, xc, 0);
1651 ProcessorEntry::PluginDisplay::on_expose_event (GdkEventExpose* ev)
1653 Gtk::Allocation a = get_allocation();
1654 double const width = a.get_width();
1655 double const height = a.get_height();
1657 cairo_t* cr = gdk_cairo_create (get_window()->gobj());
1658 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
1661 Gdk::Color const bg = get_style()->get_bg (STATE_NORMAL);
1662 cairo_set_source_rgb (cr, bg.get_red_p (), bg.get_green_p (), bg.get_blue_p ());
1663 cairo_rectangle (cr, 0, 0, width, height);
1667 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
1668 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1670 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1672 uint32_t ht = render_inline (cr, width);
1677 if (_cur_height != 1) {
1684 update_height_alloc (ht);
1687 bool failed = false;
1688 std::string name = get_name();
1689 ArdourCanvas::Color fill_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
1691 Gtkmm2ext::rounded_rectangle (cr, .5, -1.5, width - 1, height + 1, 7);
1692 cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
1693 cairo_set_line_width(cr, 1.0);
1694 ArdourCanvas::set_source_rgb_a (cr, fill_color, 1.0);
1701 ProcessorEntry::LuaPluginDisplay::LuaPluginDisplay (ProcessorEntry& e, boost::shared_ptr<ARDOUR::LuaProc> p, uint32_t max_height)
1702 : PluginDisplay (e, p, max_height)
1704 , _lua_render_inline (0)
1706 p->setup_lua_inline_gui (&lua_gui);
1708 lua_State* LG = lua_gui.getState ();
1709 LuaInstance::bind_cairo (LG);
1710 luabridge::LuaRef lua_render = luabridge::getGlobal (LG, "render_inline");
1711 assert (lua_render.isFunction ());
1712 _lua_render_inline = new luabridge::LuaRef (lua_render);
1715 ProcessorEntry::LuaPluginDisplay::~LuaPluginDisplay ()
1717 delete (_lua_render_inline);
1721 ProcessorEntry::LuaPluginDisplay::render_inline (cairo_t *cr, uint32_t width)
1723 Cairo::Context ctx (cr);
1725 luabridge::LuaRef rv = (*_lua_render_inline)((Cairo::Context *)&ctx, width, _max_height);
1726 if (rv.isTable ()) {
1730 } catch (luabridge::LuaException const& e) {
1732 cerr << "LuaException:" << e.what () << endl;
1739 static std::list<Gtk::TargetEntry> drop_targets()
1741 std::list<Gtk::TargetEntry> tmp;
1742 tmp.push_back (Gtk::TargetEntry ("processor")); // from processor-box to processor-box
1743 tmp.push_back (Gtk::TargetEntry ("PluginInfoPtr")); // from plugin-manager
1744 tmp.push_back (Gtk::TargetEntry ("PluginFavoritePtr")); // from sidebar
1748 static std::list<Gtk::TargetEntry> drag_targets()
1750 std::list<Gtk::TargetEntry> tmp;
1751 tmp.push_back (Gtk::TargetEntry ("PluginPresetPtr")); // to sidebar (optional preset)
1752 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor-box (copy)
1756 static std::list<Gtk::TargetEntry> drag_targets_noplugin()
1758 std::list<Gtk::TargetEntry> tmp;
1759 tmp.push_back (Gtk::TargetEntry ("processor")); // to processor box (sends, faders re-order)
1763 ProcessorBox::ProcessorBox (ARDOUR::Session* sess, boost::function<PluginSelector*()> get_plugin_selector,
1764 RouteProcessorSelection& rsel, MixerStrip* parent, bool owner_is_mixer)
1765 : _parent_strip (parent)
1766 , _owner_is_mixer (owner_is_mixer)
1767 , ab_direction (true)
1768 , _get_plugin_selector (get_plugin_selector)
1770 , _visible_prefader_processors (0)
1771 , _rr_selection(rsel)
1772 , processor_display (drop_targets())
1773 , _redisplay_pending (false)
1777 /* ProcessorBox actions and bindings created statically by call to
1778 * ProcessorBox::register_actions(), made by ARDOUR_UI so that actions
1779 * are available for context menus.
1782 processor_display.set_data ("ardour-bindings", bindings);
1786 no_processor_redisplay = false;
1788 processor_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
1789 processor_scroller.add (processor_display);
1790 pack_start (processor_scroller, true, true);
1792 processor_display.set_flags (CAN_FOCUS);
1793 processor_display.set_name ("ProcessorList");
1794 processor_display.set_data ("processorbox", this);
1795 processor_display.set_size_request (48, -1);
1796 processor_display.set_spacing (0);
1798 processor_display.signal_enter_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::enter_notify), false);
1799 processor_display.signal_leave_notify_event().connect (sigc::mem_fun(*this, &ProcessorBox::leave_notify), false);
1801 processor_display.ButtonPress.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_press_event));
1802 processor_display.ButtonRelease.connect (sigc::mem_fun (*this, &ProcessorBox::processor_button_release_event));
1804 processor_display.Reordered.connect (sigc::mem_fun (*this, &ProcessorBox::reordered));
1805 processor_display.DropFromAnotherBox.connect (sigc::mem_fun (*this, &ProcessorBox::object_drop));
1806 processor_display.DropFromExternal.connect (sigc::mem_fun (*this, &ProcessorBox::plugin_drop));
1808 processor_scroller.show ();
1809 processor_display.show ();
1812 parent->DeliveryChanged.connect (
1813 _mixer_strip_connections, invalidator (*this), boost::bind (&ProcessorBox::mixer_strip_delivery_changed, this, _1), gui_context ()
1817 ARDOUR_UI_UTILS::set_tooltip (processor_display, _("Right-click to add/remove/edit\nplugins,inserts,sends and more"));
1820 ProcessorBox::~ProcessorBox ()
1822 /* it may appear as if we should delete processor_menu but that is a
1823 * pointer to a widget owned by the UI Manager, and has potentially
1824 * be returned to many other ProcessorBoxes. GTK doesn't really make
1825 * clear the ownership of this widget, which is a menu and thus is
1826 * never packed into any container other than an implict GtkWindow.
1828 * For now, until or if we ever get clarification over the ownership
1829 * story just let it continue to exist. At worst, its a small memory leak.
1834 ProcessorBox::set_route (boost::shared_ptr<Route> r)
1840 _route_connections.drop_connections();
1842 /* new route: any existing block on processor redisplay must be meaningless */
1843 no_processor_redisplay = false;
1846 _route->processors_changed.connect (
1847 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_processors_changed, this, _1), gui_context()
1850 _route->DropReferences.connect (
1851 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_going_away, this), gui_context()
1854 _route->PropertyChanged.connect (
1855 _route_connections, invalidator (*this), boost::bind (&ProcessorBox::route_property_changed, this, _1), gui_context()
1858 redisplay_processors ();
1862 ProcessorBox::route_going_away ()
1864 /* don't keep updating display as processors are deleted */
1865 no_processor_redisplay = true;
1869 boost::shared_ptr<Processor>
1870 ProcessorBox::find_drop_position (ProcessorEntry* position)
1872 boost::shared_ptr<Processor> p;
1874 p = position->processor ();
1876 /* dropped on the blank entry (which will be before the
1877 fader), so use the first non-blank child as our
1878 `dropped on' processor */
1879 list<ProcessorEntry*> c = processor_display.children ();
1880 list<ProcessorEntry*>::iterator i = c.begin ();
1882 assert (i != c.end ());
1883 p = (*i)->processor ();
1891 ProcessorBox::_drop_plugin_preset (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1893 const void * d = data.get_data();
1894 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr>*>(d);
1896 PluginPresetList nfos;
1898 tv->get_object_drag_data (nfos, &source);
1900 for (list<PluginPresetPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1901 PluginPresetPtr ppp = (*i);
1902 PluginInfoPtr pip = ppp->_pip;
1903 PluginPtr p = pip->load (*_session);
1908 if (ppp->_preset.valid) {
1909 p->load_preset (ppp->_preset);
1912 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1913 if (Config->get_new_plugins_active ()) {
1914 processor->enable (true);
1916 pl.push_back (processor);
1921 ProcessorBox::_drop_plugin (Gtk::SelectionData const &data, Route::ProcessorList &pl)
1923 const void * d = data.get_data();
1924 const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>* tv = reinterpret_cast<const Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr>*>(d);
1925 PluginInfoList nfos;
1928 tv->get_object_drag_data (nfos, &source);
1930 for (list<PluginInfoPtr>::const_iterator i = nfos.begin(); i != nfos.end(); ++i) {
1931 PluginPtr p = (*i)->load (*_session);
1935 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, p));
1936 if (Config->get_new_plugins_active ()) {
1937 processor->enable (true);
1939 pl.push_back (processor);
1944 ProcessorBox::plugin_drop (Gtk::SelectionData const &data, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1950 boost::shared_ptr<Processor> p = find_drop_position (position);
1951 Route::ProcessorList pl;
1953 if (data.get_target() == "PluginInfoPtr") {
1954 _drop_plugin (data, pl);
1956 else if (data.get_target() == "PluginFavoritePtr") {
1957 _drop_plugin_preset (data, pl);
1963 Route::ProcessorStreams err;
1964 if (_route->add_processors (pl, p, &err)) {
1966 "Processor Drag/Drop failed. Probably because\n\
1967 the I/O configuration of the plugins could\n\
1968 not match the configuration of this track.");
1969 MessageDialog am (msg);
1975 ProcessorBox::object_drop (DnDVBox<ProcessorEntry>* source, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context)
1977 if (Gdk::ACTION_LINK == context->get_selected_action()) {
1978 list<ProcessorEntry*> children = source->selection ();
1979 assert (children.size() == 1);
1980 ProcessorEntry* other = *children.begin();
1981 assert (other->can_copy_state (position));
1982 boost::shared_ptr<ARDOUR::Processor> otherproc = other->processor();
1983 boost::shared_ptr<ARDOUR::Processor> proc = position->processor();
1984 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
1985 assert (otherproc && proc && pi);
1987 PBD::ID id = pi->id();
1988 XMLNode& state = otherproc->get_state ();
1989 /* strip side-chain state (processor inside processor must be a side-chain)
1990 * otherwise we'll end up with duplicate ports-names.
1991 * (this needs a better solution which retains connections)
1993 state.remove_nodes ("Processor");
1994 proc->set_state (state, Stateful::loading_state_version);
1995 boost::dynamic_pointer_cast<PluginInsert>(proc)->update_id (id);
1999 boost::shared_ptr<Processor> p = find_drop_position (position);
2001 list<ProcessorEntry*> children = source->selection ();
2002 list<boost::shared_ptr<Processor> > procs;
2003 for (list<ProcessorEntry*>::const_iterator i = children.begin(); i != children.end(); ++i) {
2004 if ((*i)->processor ()) {
2005 if (boost::dynamic_pointer_cast<UnknownProcessor> ((*i)->processor())) {
2008 procs.push_back ((*i)->processor ());
2012 for (list<boost::shared_ptr<Processor> >::const_iterator i = procs.begin(); i != procs.end(); ++i) {
2013 XMLNode& state = (*i)->get_state ();
2015 nlist.push_back (&state);
2016 paste_processor_state (nlist, p);
2020 /* since the dndvbox doesn't take care of this properly, we have to delete the originals
2024 if ((context->get_suggested_action() == Gdk::ACTION_MOVE) && source) {
2025 ProcessorBox* other = reinterpret_cast<ProcessorBox*> (source->get_data ("processorbox"));
2027 other->delete_dragged_processors (procs);
2033 ProcessorBox::set_width (Width w)
2041 list<ProcessorEntry*> children = processor_display.children ();
2042 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2043 (*i)->set_enum_width (w);
2050 ProcessorBox::build_possible_aux_menu ()
2052 boost::shared_ptr<RouteList> rl = _session->get_routes_with_internal_returns();
2055 /* No aux sends if there are no busses */
2059 if (_route->is_monitor ()) {
2063 using namespace Menu_Helpers;
2064 Menu* menu = manage (new Menu);
2065 MenuList& items = menu->items();
2067 for (RouteList::iterator r = rl->begin(); r != rl->end(); ++r) {
2068 if (!_route->internal_send_for (*r) && *r != _route) {
2069 items.push_back (MenuElem ((*r)->name(), sigc::bind (sigc::ptr_fun (ProcessorBox::rb_choose_aux), boost::weak_ptr<Route>(*r))));
2077 ProcessorBox::show_processor_menu (int arg)
2079 if (processor_menu == 0) {
2080 processor_menu = build_processor_menu ();
2081 processor_menu->signal_unmap().connect (sigc::mem_fun (*this, &ProcessorBox::processor_menu_unmapped));
2084 /* Sort out the plugin submenu */
2086 Gtk::MenuItem* plugin_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newplugin"));
2088 if (plugin_menu_item) {
2089 plugin_menu_item->set_submenu (*_get_plugin_selector()->plugin_menu());
2092 /* And the aux submenu */
2094 Gtk::MenuItem* aux_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/newaux"));
2096 if (aux_menu_item) {
2097 Menu* m = build_possible_aux_menu();
2098 if (m && !m->items().empty()) {
2099 aux_menu_item->set_submenu (*m);
2100 aux_menu_item->set_sensitive (true);
2102 /* stupid gtkmm: we need to pass a null reference here */
2103 gtk_menu_item_set_submenu (aux_menu_item->gobj(), 0);
2104 aux_menu_item->set_sensitive (false);
2108 ActionManager::get_action (X_("ProcessorMenu"), "newinsert")->set_sensitive (!_route->is_monitor ());
2109 ActionManager::get_action (X_("ProcessorMenu"), "newsend")->set_sensitive (!_route->is_monitor ());
2111 ProcessorEntry* single_selection = 0;
2112 if (processor_display.selection().size() == 1) {
2113 single_selection = processor_display.selection().front();
2116 /* And the controls submenu */
2118 Gtk::MenuItem* controls_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/controls"));
2120 if (controls_menu_item) {
2121 if (single_selection) {
2122 Menu* m = single_selection->build_controls_menu ();
2123 if (m && !m->items().empty()) {
2124 controls_menu_item->set_submenu (*m);
2125 controls_menu_item->set_sensitive (true);
2127 gtk_menu_item_set_submenu (controls_menu_item->gobj(), 0);
2128 controls_menu_item->set_sensitive (false);
2131 controls_menu_item->set_sensitive (false);
2136 if (!ARDOUR::Profile->get_mixbus()) {
2137 Gtk::MenuItem* send_menu_item = dynamic_cast<Gtk::MenuItem*>(ActionManager::get_widget("/ProcessorMenu/send_options"));
2138 if (send_menu_item) {
2139 if (single_selection && !_route->is_monitor()) {
2140 Menu* m = single_selection->build_send_options_menu ();
2141 if (m && !m->items().empty()) {
2142 send_menu_item->set_submenu (*m);
2143 send_menu_item->set_sensitive (true);
2145 gtk_menu_item_set_submenu (send_menu_item->gobj(), 0);
2146 send_menu_item->set_sensitive (false);
2149 send_menu_item->set_sensitive (false);
2154 /* Sensitise actions as approprioate */
2157 const bool sensitive = !processor_display.selection().empty() && ! stub_processor_selected ();
2159 paste_action->set_sensitive (!_rr_selection.processors.empty());
2160 cut_action->set_sensitive (sensitive && can_cut ());
2161 copy_action->set_sensitive (sensitive);
2162 delete_action->set_sensitive (sensitive || stub_processor_selected ());
2163 backspace_action->set_sensitive (sensitive || stub_processor_selected ());
2165 edit_action->set_sensitive (one_processor_can_be_edited ());
2166 edit_generic_action->set_sensitive (one_processor_can_be_edited ());
2168 boost::shared_ptr<PluginInsert> pi;
2169 if (single_selection) {
2170 pi = boost::dynamic_pointer_cast<PluginInsert> (single_selection->processor ());
2173 manage_pins_action->set_sensitive (pi != 0);
2175 /* allow editing with an Ardour-generated UI for plugin inserts with editors */
2176 edit_action->set_sensitive (pi && pi->plugin()->has_editor ());
2178 /* disallow rename for multiple selections, for plugin inserts and for the fader */
2179 rename_action->set_sensitive (single_selection
2181 && !boost::dynamic_pointer_cast<Amp> (single_selection->processor ())
2182 && !boost::dynamic_pointer_cast<UnknownProcessor> (single_selection->processor ()));
2184 processor_menu->popup (1, arg);
2186 /* Add a placeholder gap to the processor list to indicate where a processor would be
2187 inserted were one chosen from the menu.
2190 processor_display.get_pointer (x, y);
2191 _placement = processor_display.add_placeholder (y);
2193 if (_visible_prefader_processors == 0 && _placement > 0) {
2199 ProcessorBox::enter_notify (GdkEventCrossing*)
2201 processor_display.grab_focus ();
2202 _current_processor_box = this;
2207 ProcessorBox::leave_notify (GdkEventCrossing* ev)
2209 if (ev->detail == GDK_NOTIFY_INFERIOR) {
2213 Widget* top = get_toplevel();
2215 if (top->is_toplevel()) {
2216 Window* win = dynamic_cast<Window*> (top);
2217 gtk_window_set_focus (win->gobj(), 0);
2224 ProcessorBox::processor_operation (ProcessorOperation op)
2226 ProcSelection targets;
2228 get_selected_processors (targets);
2230 /* if (targets.empty()) {
2233 processor_display.get_pointer (x, y);
2235 pair<ProcessorEntry *, double> const pointer = processor_display.get_child_at_position (y);
2237 if (pointer.first && pointer.first->processor()) {
2238 targets.push_back (pointer.first->processor ());
2243 if ((op == ProcessorsDelete) && targets.empty()) {
2244 return false; //nothing to delete. return false so the editor-mixer, because the user was probably intending to delete something in the editor
2248 case ProcessorsSelectAll:
2249 processor_display.select_all ();
2252 case ProcessorsSelectNone:
2253 processor_display.select_none ();
2256 case ProcessorsCopy:
2257 copy_processors (targets);
2261 cut_processors (targets);
2264 case ProcessorsPaste:
2265 // some processors are not selectable (e.g fader, meter), target is empty.
2266 if (targets.empty() && _placement >= 0) {
2268 boost::shared_ptr<Processor> proc = _route->before_processor_for_index (_placement);
2270 targets.push_back (proc);
2273 if (targets.empty()) {
2274 paste_processors ();
2276 paste_processors (targets.front());
2280 case ProcessorsDelete:
2281 delete_processors (targets);
2284 case ProcessorsToggleActive:
2285 for (ProcSelection::iterator i = targets.begin(); i != targets.end(); ++i) {
2286 (*i)->enable (!(*i)->enabled ());
2301 ProcessorWindowProxy*
2302 ProcessorBox::find_window_proxy (boost::shared_ptr<Processor> processor) const
2304 return processor->window_proxy();
2309 ProcessorBox::processor_button_press_event (GdkEventButton *ev, ProcessorEntry* child)
2311 boost::shared_ptr<Processor> processor;
2313 processor = child->processor ();
2317 bool selected = processor_display.selected (child);
2319 if (processor && (Keyboard::is_edit_event (ev) || (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS))) {
2321 if (_session->engine().connected()) {
2322 /* XXX giving an error message here is hard, because we may be in the midst of a button press */
2324 if (!one_processor_can_be_edited ()) {
2328 if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
2329 generic_edit_processor (processor);
2331 edit_processor (processor);
2337 } else if (Keyboard::is_context_menu_event (ev)) {
2339 show_processor_menu (ev->time);
2343 } else if (processor && ev->button == 1 && selected) {
2345 // this is purely informational but necessary for route params UI
2346 ProcessorSelected (processor); // emit
2348 } else if (!processor && ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
2351 _get_plugin_selector()->show_manager ();
2358 ProcessorBox::processor_button_release_event (GdkEventButton *ev, ProcessorEntry* child)
2360 boost::shared_ptr<Processor> processor;
2362 processor = child->processor ();
2365 if (processor && Keyboard::is_delete_event (ev)) {
2367 Glib::signal_idle().connect (sigc::bind (
2368 sigc::mem_fun(*this, &ProcessorBox::idle_delete_processor),
2369 boost::weak_ptr<Processor>(processor)));
2371 } else if (processor && Keyboard::is_button2_event (ev)
2373 && (Keyboard::no_modifier_keys_pressed (ev) && ((ev->state & Gdk::BUTTON2_MASK) == Gdk::BUTTON2_MASK))
2377 /* button2-click with no/appropriate modifiers */
2378 processor->enable (!processor->enabled ());
2385 ProcessorBox::build_processor_menu ()
2387 processor_menu = dynamic_cast<Gtk::Menu*>(ActionManager::get_widget("/ProcessorMenu") );
2388 processor_menu->set_name ("ArdourContextMenu");
2389 return processor_menu;
2393 ProcessorBox::select_all_processors ()
2395 processor_display.select_all ();
2399 ProcessorBox::deselect_all_processors ()
2401 processor_display.select_none ();
2405 ProcessorBox::choose_plugin ()
2407 _get_plugin_selector()->set_interested_object (*this);
2410 /** @return true if an error occurred, otherwise false */
2412 ProcessorBox::use_plugins (const SelectedPlugins& plugins)
2414 for (SelectedPlugins::const_iterator p = plugins.begin(); p != plugins.end(); ++p) {
2416 boost::shared_ptr<Processor> processor (new PluginInsert (*_session, *p));
2418 Route::ProcessorStreams err_streams;
2420 if (_route->add_processor_by_index (processor, _placement, &err_streams, Config->get_new_plugins_active ())) {
2421 weird_plugin_dialog (**p, err_streams);
2423 // XXX SHAREDPTR delete plugin here .. do we even need to care?
2424 } else if (plugins.size() == 1 && UIConfiguration::instance().get_open_gui_after_adding_plugin()) {
2425 if (boost::dynamic_pointer_cast<PluginInsert>(processor)->plugin()->has_inline_display() && UIConfiguration::instance().get_prefer_inline_over_gui()) {
2427 } else if (_session->engine().connected () && processor_can_be_edited (processor)) {
2428 if ((*p)->has_editor ()) {
2429 edit_processor (processor);
2431 generic_edit_processor (processor);
2441 ProcessorBox::weird_plugin_dialog (Plugin& p, Route::ProcessorStreams streams)
2443 ArdourDialog dialog (_("Plugin Incompatibility"));
2446 string text = string_compose(_("You attempted to add the plugin \"%1\" in slot %2.\n"),
2447 p.name(), streams.index);
2449 bool has_midi = streams.count.n_midi() > 0 || p.get_info()->n_inputs.n_midi() > 0;
2450 bool has_audio = streams.count.n_audio() > 0 || p.get_info()->n_inputs.n_audio() > 0;
2452 text += _("\nThis plugin has:\n");
2454 uint32_t const n = p.get_info()->n_inputs.n_midi ();
2455 text += string_compose (ngettext ("\t%1 MIDI input\n", "\t%1 MIDI inputs\n", n), n);
2458 uint32_t const n = p.get_info()->n_inputs.n_audio ();
2459 text += string_compose (ngettext ("\t%1 audio input\n", "\t%1 audio inputs\n", n), n);
2462 text += _("\nbut at the insertion point, there are:\n");
2464 uint32_t const n = streams.count.n_midi ();
2465 text += string_compose (ngettext ("\t%1 MIDI channel\n", "\t%1 MIDI channels\n", n), n);
2468 uint32_t const n = streams.count.n_audio ();
2469 text += string_compose (ngettext ("\t%1 audio channel\n", "\t%1 audio channels\n", n), n);
2472 text += string_compose (_("\n%1 is unable to insert this plugin here.\n"), PROGRAM_NAME);
2473 label.set_text(text);
2475 dialog.get_vbox()->pack_start (label);
2476 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2478 dialog.set_name (X_("PluginIODialog"));
2479 dialog.set_modal (true);
2486 ProcessorBox::choose_insert ()
2488 boost::shared_ptr<Processor> processor (new PortInsert (*_session, _route->pannable(), _route->mute_master()));
2489 _route->add_processor_by_index (processor, _placement);
2492 /* Caller must not hold process lock */
2494 ProcessorBox::choose_send ()
2496 boost::shared_ptr<Send> send (new Send (*_session, _route->pannable (), _route->mute_master()));
2498 /* make an educated guess at the initial number of outputs for the send */
2499 ChanCount outs = (_session->master_out())
2500 ? _session->master_out()->n_outputs()
2501 : _route->n_outputs();
2503 /* XXX need processor lock on route */
2505 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock());
2506 send->output()->ensure_io (outs, false, this);
2507 } catch (AudioEngine::PortRegistrationFailure& err) {
2508 error << string_compose (_("Cannot set up new send: %1"), err.what()) << endmsg;
2512 /* let the user adjust the IO setup before creation.
2514 Note: this dialog is NOT modal - we just leave it to run and it will
2515 return when its Finished signal is emitted - typically when the window
2519 IOSelectorWindow *ios = new IOSelectorWindow (_session, send->output(), true);
2522 /* keep a reference to the send so it doesn't get deleted while
2523 the IOSelectorWindow is doing its stuff
2525 _processor_being_created = send;
2527 ios->selector().Finished.connect (sigc::bind (
2528 sigc::mem_fun(*this, &ProcessorBox::send_io_finished),
2529 boost::weak_ptr<Processor>(send), ios));
2534 ProcessorBox::send_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2536 boost::shared_ptr<Processor> processor (weak_processor.lock());
2538 /* drop our temporary reference to the new send */
2539 _processor_being_created.reset ();
2546 case IOSelector::Cancelled:
2547 // processor will go away when all shared_ptrs to it vanish
2550 case IOSelector::Accepted:
2551 _route->add_processor_by_index (processor, _placement);
2555 delete_when_idle (ios);
2559 ProcessorBox::return_io_finished (IOSelector::Result r, boost::weak_ptr<Processor> weak_processor, IOSelectorWindow* ios)
2561 boost::shared_ptr<Processor> processor (weak_processor.lock());
2563 /* drop our temporary reference to the new return */
2564 _processor_being_created.reset ();
2571 case IOSelector::Cancelled:
2572 // processor will go away when all shared_ptrs to it vanish
2575 case IOSelector::Accepted:
2576 _route->add_processor_by_index (processor, _placement);
2580 delete_when_idle (ios);
2584 ProcessorBox::choose_aux (boost::weak_ptr<Route> wr)
2590 boost::shared_ptr<Route> target = wr.lock();
2596 _session->add_internal_send (target, _placement, _route);
2600 ProcessorBox::route_processors_changed (RouteProcessorChange c)
2602 if (c.type == RouteProcessorChange::MeterPointChange && c.meter_visibly_changed == false) {
2603 /* the meter has moved, but it was and still is invisible to the user, so nothing to do */
2607 redisplay_processors ();
2611 ProcessorBox::redisplay_processors ()
2613 ENSURE_GUI_THREAD (*this, &ProcessorBox::redisplay_processors);
2616 if (no_processor_redisplay) {
2620 processor_display.clear ();
2622 _visible_prefader_processors = 0;
2625 _route->foreach_processor (sigc::bind (sigc::mem_fun (*this, &ProcessorBox::help_count_visible_prefader_processors),
2626 &_visible_prefader_processors, &fader_seen));
2628 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::add_processor_to_display));
2629 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_to_ui_list));
2630 _route->foreach_processor (sigc::mem_fun (*this, &ProcessorBox::maybe_add_processor_pin_mgr));
2632 setup_entry_positions ();
2635 /** Add a ProcessorWindowProxy for a processor to our list, if that processor does
2636 * not already have one.
2639 ProcessorBox::maybe_add_processor_to_ui_list (boost::weak_ptr<Processor> w)
2641 boost::shared_ptr<Processor> p = w.lock ();
2645 if (p->window_proxy()) {
2649 /* not on the list; add it */
2652 #if 0 // is this still needed? Why?
2653 if (_parent_strip) {
2654 if (_parent_strip->mixer_owned()) {
2666 ProcessorWindowProxy* wp = new ProcessorWindowProxy (
2667 string_compose ("%1-%2-%3", loc, _route->id(), p->id()),
2671 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2674 wp->set_state (*ui_xml, 0);
2677 void* existing_ui = p->get_ui ();
2680 wp->use_window (*(reinterpret_cast<Gtk::Window*>(existing_ui)));
2683 p->set_window_proxy (wp);
2684 WM::Manager::instance().register_window (wp);
2688 ProcessorBox::maybe_add_processor_pin_mgr (boost::weak_ptr<Processor> w)
2690 boost::shared_ptr<Processor> p = w.lock ();
2691 if (!p || p->pinmgr_proxy ()) {
2695 PluginPinWindowProxy* wp = new PluginPinWindowProxy (
2696 string_compose ("PM-%2-%3", _route->id(), p->id()), w);
2697 wp->set_session (_session);
2699 const XMLNode* ui_xml = _session->extra_xml (X_("UI"));
2701 wp->set_state (*ui_xml, 0);
2704 p->set_pingmgr_proxy (wp);
2705 WM::Manager::instance().register_window (wp);
2708 ProcessorBox::help_count_visible_prefader_processors (boost::weak_ptr<Processor> p, uint32_t* cnt, bool* amp_seen)
2710 boost::shared_ptr<Processor> processor (p.lock ());
2712 if (processor && ( processor->display_to_user()
2714 || show_all_processors
2719 if (boost::dynamic_pointer_cast<Amp>(processor) &&
2720 boost::dynamic_pointer_cast<Amp>(processor)->gain_control()->parameter().type() == GainAutomation) {
2731 ProcessorBox::add_processor_to_display (boost::weak_ptr<Processor> p)
2733 boost::shared_ptr<Processor> processor (p.lock ());
2735 if (!processor || ( !processor->display_to_user()
2737 && !show_all_processors
2744 boost::shared_ptr<PluginInsert> plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor);
2746 ProcessorEntry* e = 0;
2747 if (plugin_insert) {
2748 e = new PluginInsertProcessorEntry (this, plugin_insert, _width);
2750 e = new ProcessorEntry (this, processor, _width);
2753 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
2754 boost::shared_ptr<PortInsert> ext = boost::dynamic_pointer_cast<PortInsert> (processor);
2755 boost::shared_ptr<UnknownProcessor> stub = boost::dynamic_pointer_cast<UnknownProcessor> (processor);
2757 //faders and meters are not deletable, copy/paste-able, so they shouldn't be selectable
2758 if (!send && !plugin_insert && !ext && !stub)
2759 e->set_selectable(false);
2761 bool mark_send_visible = false;
2762 if (send && _parent_strip) {
2763 /* show controls of new sends by default */
2764 GUIObjectState& st = _parent_strip->gui_object_state ();
2765 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
2767 /* check if state exists, if not it must be a new send */
2768 if (!st.get_node(strip, e->state_id())) {
2769 mark_send_visible = true;
2773 /* Set up this entry's state from the GUIObjectState */
2774 XMLNode* proc = entry_gui_object_state (e);
2776 e->set_control_state (proc);
2779 if (mark_send_visible) {
2780 e->show_all_controls ();
2785 && !plugin_insert->plugin(0)->is_channelstrip()
2789 processor_display.add_child (e, drag_targets());
2791 processor_display.add_child (e, drag_targets_noplugin());
2796 ProcessorBox::reordered ()
2798 compute_processor_sort_keys ();
2799 setup_entry_positions ();
2803 ProcessorBox::setup_routing_feeds ()
2805 list<ProcessorEntry*> children = processor_display.children ();
2806 /* first set the i/o maps for every processor */
2807 list<ProcessorEntry*>::iterator prev = children.begin();
2809 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2810 boost::shared_ptr<ARDOUR::Processor> p = (*i)->processor();
2811 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
2813 list<ProcessorEntry*>::iterator next = i;
2817 ChanCount sinks = pi->natural_input_streams ();
2818 ChanCount sources = pi->natural_output_streams ();
2819 uint32_t count = pi->get_count ();
2821 pi->configured_io (in, out);
2823 ChanCount midi_thru;
2824 ChanCount midi_bypass;
2825 ChanMapping input_map (pi->input_map ());
2826 if (pi->has_midi_thru ()) {
2827 midi_thru.set(DataType::MIDI, 1);
2828 input_map.set (DataType::MIDI, 0, 0);
2830 if (pi->has_midi_bypass ()) {
2831 midi_bypass.set(DataType::MIDI, 1);
2834 (*i)->input_icon.set_ports (sinks * count + midi_thru);
2835 (*i)->output_icon.set_ports (sources * count + midi_bypass);
2837 (*i)->routing_icon.set (
2839 sinks * count + midi_thru,
2840 sources * count + midi_bypass,
2845 if (next != children.end()) {
2846 (*next)->routing_icon.set_fed_by (out, sources * count + midi_bypass,
2847 pi->output_map (), pi->thru_map ());
2851 (*prev)->routing_icon.set_feeding (in, sinks * count + midi_thru,
2852 pi->input_map (), pi->thru_map ());
2856 (*i)->input_icon.set_ports (p->input_streams());
2857 (*i)->output_icon.set_ports (p->output_streams());
2858 ChanMapping inmap (p->input_streams ());
2859 ChanMapping outmap (p->input_streams ());
2860 ChanMapping thrumap;
2861 (*i)->routing_icon.set (
2863 p->output_streams(),
2865 p->output_streams(),
2866 inmap, outmap, thrumap);
2868 if (next != children.end()) {
2869 (*next)->routing_icon.set_fed_by (
2870 p->output_streams(),
2871 p->output_streams(),
2875 (*prev)->routing_icon.set_feeding (
2877 p->output_streams(),
2882 if (i == children.begin()) {
2883 (*i)->routing_icon.unset_fed_by ();
2886 (*i)->input_icon.hide();
2889 /* now set which icons need to be displayed */
2890 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2891 (*i)->output_routing_icon.copy_state ((*i)->routing_icon);
2893 if ((*i)->routing_icon.in_identity ()) {
2894 (*i)->routing_icon.hide();
2895 if (i == children.begin()) {
2896 (*i)->input_icon.show();
2899 (*i)->routing_icon.show();
2900 (*i)->routing_icon.queue_draw();
2901 (*i)->input_icon.show();
2904 list<ProcessorEntry*>::iterator next = i;
2905 if (++next == children.end()) {
2906 // last processor in the chain
2907 (*i)->output_routing_icon.set_terminal(true);
2908 (*i)->output_routing_icon.unset_feeding ();
2909 if ((*i)->routing_icon.out_identity ()) {
2910 (*i)->output_routing_icon.hide();
2912 (*i)->output_routing_icon.show();
2913 (*i)->output_routing_icon.queue_draw();
2916 (*i)->output_routing_icon.set_terminal(false);
2917 if ( !(*i)->routing_icon.out_identity ()
2918 && !(*next)->routing_icon.in_identity ()
2919 && (*next)->routing_icon.can_coalesce ()) {
2920 (*i)->output_routing_icon.hide();
2921 } else if (!(*i)->routing_icon.out_identity ()) {
2922 (*i)->output_routing_icon.show();
2923 (*i)->output_routing_icon.queue_draw();
2924 (*next)->input_icon.show();
2926 (*i)->output_routing_icon.hide();
2933 ProcessorBox::setup_entry_positions ()
2935 list<ProcessorEntry*> children = processor_display.children ();
2936 bool pre_fader = true;
2939 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2940 if (boost::dynamic_pointer_cast<Amp>((*i)->processor()) &&
2941 boost::dynamic_pointer_cast<Amp>((*i)->processor())->gain_control()->parameter().type() == GainAutomation) {
2943 (*i)->set_position (ProcessorEntry::Fader, num++);
2946 (*i)->set_position (ProcessorEntry::PreFader, num++);
2948 (*i)->set_position (ProcessorEntry::PostFader, num++);
2952 setup_routing_feeds ();
2956 ProcessorBox::compute_processor_sort_keys ()
2958 list<ProcessorEntry*> children = processor_display.children ();
2959 Route::ProcessorList our_processors;
2961 for (list<ProcessorEntry*>::iterator i = children.begin(); i != children.end(); ++i) {
2962 if ((*i)->processor()) {
2963 our_processors.push_back ((*i)->processor ());
2967 if (_route->reorder_processors (our_processors)) {
2968 /* Reorder failed, so report this to the user. As far as I can see this must be done
2969 in an idle handler: it seems that the redisplay_processors() that happens below destroys
2970 widgets that were involved in the drag-and-drop on the processor list, which causes problems
2971 when the drag is torn down after this handler function is finished.
2973 Glib::signal_idle().connect_once (sigc::mem_fun (*this, &ProcessorBox::report_failed_reorder));
2978 ProcessorBox::report_failed_reorder ()
2980 /* reorder failed, so redisplay */
2982 redisplay_processors ();
2984 /* now tell them about the problem */
2986 ArdourDialog dialog (_("Plugin Incompatibility"));
2989 label.set_text (_("\
2990 You cannot reorder these plugins/sends/inserts\n\
2991 in that way because the inputs and\n\
2992 outputs will not work correctly."));
2994 dialog.get_vbox()->set_border_width (12);
2995 dialog.get_vbox()->pack_start (label);
2996 dialog.add_button (Stock::OK, RESPONSE_ACCEPT);
2998 dialog.set_name (X_("PluginIODialog"));
2999 dialog.set_modal (true);
3006 ProcessorBox::rename_processors ()
3008 ProcSelection to_be_renamed;
3010 get_selected_processors (to_be_renamed);
3012 if (to_be_renamed.empty()) {
3016 for (ProcSelection::iterator i = to_be_renamed.begin(); i != to_be_renamed.end(); ++i) {
3017 rename_processor (*i);
3022 ProcessorBox::can_cut () const
3024 vector<boost::shared_ptr<Processor> > sel;
3026 get_selected_processors (sel);
3028 /* cut_processors () does not cut inserts */
3030 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3032 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3033 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3034 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3043 ProcessorBox::stub_processor_selected () const
3045 vector<boost::shared_ptr<Processor> > sel;
3047 get_selected_processors (sel);
3049 for (vector<boost::shared_ptr<Processor> >::const_iterator i = sel.begin (); i != sel.end (); ++i) {
3050 if (boost::dynamic_pointer_cast<UnknownProcessor>((*i)) != 0) {
3059 ProcessorBox::cut_processors (const ProcSelection& to_be_removed)
3061 if (to_be_removed.empty()) {
3065 XMLNode* node = new XMLNode (X_("cut"));
3066 Route::ProcessorList to_cut;
3068 no_processor_redisplay = true;
3069 for (ProcSelection::const_iterator i = to_be_removed.begin(); i != to_be_removed.end(); ++i) {
3070 // Cut only plugins, sends and returns
3071 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3072 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3073 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3075 Window* w = get_processor_ui (*i);
3081 XMLNode& child ((*i)->get_state());
3082 node->add_child_nocopy (child);
3083 to_cut.push_back (*i);
3087 if (_route->remove_processors (to_cut) != 0) {
3089 no_processor_redisplay = false;
3093 _rr_selection.set (node);
3095 no_processor_redisplay = false;
3096 redisplay_processors ();
3100 ProcessorBox::copy_processors (const ProcSelection& to_be_copied)
3102 if (to_be_copied.empty()) {
3106 XMLNode* node = new XMLNode (X_("copy"));
3108 for (ProcSelection::const_iterator i = to_be_copied.begin(); i != to_be_copied.end(); ++i) {
3109 // Copy only plugins, sends, returns
3110 if (boost::dynamic_pointer_cast<PluginInsert>((*i)) != 0 ||
3111 (boost::dynamic_pointer_cast<Send>((*i)) != 0) ||
3112 (boost::dynamic_pointer_cast<Return>((*i)) != 0)) {
3113 node->add_child_nocopy ((*i)->get_state());
3117 _rr_selection.set (node);
3121 ProcessorBox::delete_processors (const ProcSelection& targets)
3123 if (targets.empty()) {
3127 no_processor_redisplay = true;
3129 for (ProcSelection::const_iterator i = targets.begin(); i != targets.end(); ++i) {
3131 Window* w = get_processor_ui (*i);
3137 _route->remove_processor(*i);
3140 no_processor_redisplay = false;
3141 redisplay_processors ();
3145 ProcessorBox::delete_dragged_processors (const list<boost::shared_ptr<Processor> >& procs)
3147 list<boost::shared_ptr<Processor> >::const_iterator x;
3149 no_processor_redisplay = true;
3150 for (x = procs.begin(); x != procs.end(); ++x) {
3152 Window* w = get_processor_ui (*x);
3158 _route->remove_processor(*x);
3161 no_processor_redisplay = false;
3162 redisplay_processors ();
3166 ProcessorBox::idle_delete_processor (boost::weak_ptr<Processor> weak_processor)
3168 boost::shared_ptr<Processor> processor (weak_processor.lock());
3174 /* NOT copied to _mixer.selection() */
3176 no_processor_redisplay = true;
3177 _route->remove_processor (processor);
3178 no_processor_redisplay = false;
3179 redisplay_processors ();
3185 ProcessorBox::rename_processor (boost::shared_ptr<Processor> processor)
3187 ArdourPrompter name_prompter (true);
3189 name_prompter.set_title (_("Rename Processor"));
3190 name_prompter.set_prompt (_("New name:"));
3191 name_prompter.set_initial_text (processor->name());
3192 name_prompter.add_button (_("Rename"), Gtk::RESPONSE_ACCEPT);
3193 name_prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
3194 name_prompter.show_all ();
3196 switch (name_prompter.run ()) {
3198 case Gtk::RESPONSE_ACCEPT:
3199 name_prompter.get_result (result);
3200 if (result.length()) {
3203 string test = result;
3205 while (tries < 100) {
3206 if (_session->io_name_is_legal (test)) {
3212 test = string_compose ("%1-%2", result, tries);
3216 processor->set_name (result);
3219 ARDOUR_UI::instance()->popup_error
3220 (string_compose (_("At least 100 IO objects exist with a name like %1 - name not changed"), result));
3230 ProcessorBox::paste_processors ()
3232 if (_rr_selection.processors.empty()) {
3236 paste_processor_state (_rr_selection.processors.get_node().children(), boost::shared_ptr<Processor>());
3240 ProcessorBox::paste_processors (boost::shared_ptr<Processor> before)
3243 if (_rr_selection.processors.empty()) {
3247 paste_processor_state (_rr_selection.processors.get_node().children(), before);
3251 ProcessorBox::paste_processor_state (const XMLNodeList& nlist, boost::shared_ptr<Processor> p)
3253 XMLNodeConstIterator niter;
3254 list<boost::shared_ptr<Processor> > copies;
3256 if (nlist.empty()) {
3260 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3262 XMLProperty const * type = (*niter)->property ("type");
3263 XMLProperty const * role = (*niter)->property ("role");
3266 boost::shared_ptr<Processor> p;
3268 if (type->value() == "meter" ||
3269 type->value() == "main-outs" ||
3270 type->value() == "amp" ||
3271 type->value() == "intreturn") {
3272 /* do not paste meter, main outs, amp or internal returns */
3275 } else if (type->value() == "intsend") {
3277 /* aux sends are OK, but those used for
3278 * other purposes, are not.
3283 if (role->value() != "Aux") {
3287 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3288 XMLNode n (**niter);
3289 InternalSend* s = new InternalSend (*_session, sendpan, _route->mute_master(),
3290 _route, boost::shared_ptr<Route>(), Delivery::Aux);
3292 IOProcessor::prepare_for_reset (n, s->name());
3294 if (s->set_state (n, Stateful::loading_state_version)) {
3301 } else if (type->value() == "send") {
3303 boost::shared_ptr<Pannable> sendpan(new Pannable (*_session));
3304 XMLNode n (**niter);
3306 Send* s = new Send (*_session, _route->pannable(), _route->mute_master());
3308 IOProcessor::prepare_for_reset (n, s->name());
3310 if (s->set_state (n, Stateful::loading_state_version)) {
3317 } else if (type->value() == "return") {
3319 XMLNode n (**niter);
3320 Return* r = new Return (*_session);
3322 IOProcessor::prepare_for_reset (n, r->name());
3324 if (r->set_state (n, Stateful::loading_state_version)) {
3331 } else if (type->value() == "port") {
3333 XMLNode n (**niter);
3334 PortInsert* pi = new PortInsert (*_session, _route->pannable (), _route->mute_master ());
3336 IOProcessor::prepare_for_reset (n, pi->name());
3338 if (pi->set_state (n, Stateful::loading_state_version)) {
3344 /* XXX its a bit limiting to assume that everything else
3347 p.reset (new PluginInsert (*_session));
3348 /* we can't use RAII Stateful::ForceIDRegeneration
3349 * because that'd void copying the state and wrongly bump
3350 * the state-version counter.
3351 * we need to load the state (incl external files) first and
3352 * only then update the ID)
3354 PBD::ID id = p->id();
3355 /* strip side-chain state (processor inside processor must be a side-chain)
3356 * otherwise we'll end up with duplicate ports-names.
3357 * (this needs a better solution which retains connections)
3358 * We really would want Stateful::ForceIDRegeneration here :(
3360 XMLNode state (**niter);
3361 state.remove_nodes ("Processor");
3363 p->set_state (state, Stateful::current_state_version);
3364 boost::dynamic_pointer_cast<PluginInsert>(p)->update_id (id);
3367 copies.push_back (p);
3371 error << _("plugin insert constructor failed") << endmsg;
3375 if (copies.empty()) {
3379 if (_route->add_processors (copies, p)) {
3382 "Copying the set of processors on the clipboard failed,\n\
3383 probably because the I/O configuration of the plugins\n\
3384 could not match the configuration of this track.");
3385 MessageDialog am (msg);
3391 ProcessorBox::get_selected_processors (ProcSelection& processors) const
3393 const list<ProcessorEntry*> selection = processor_display.selection ();
3394 for (list<ProcessorEntry*>::const_iterator i = selection.begin(); i != selection.end(); ++i) {
3395 processors.push_back ((*i)->processor ());
3400 ProcessorBox::for_selected_processors (void (ProcessorBox::*method)(boost::shared_ptr<Processor>))
3402 list<ProcessorEntry*> selection = processor_display.selection ();
3403 for (list<ProcessorEntry*>::iterator i = selection.begin(); i != selection.end(); ++i) {
3404 (this->*method) ((*i)->processor ());
3409 ProcessorBox::all_visible_processors_active (bool state)
3411 _route->all_visible_processors_active (state);
3415 ProcessorBox::ab_plugins ()
3417 _route->ab_plugins (ab_direction);
3418 ab_direction = !ab_direction;
3423 ProcessorBox::clear_processors ()
3426 vector<string> choices;
3428 prompt = string_compose (_("Do you really want to remove all processors from %1?\n"
3429 "(this cannot be undone)"), _route->name());
3431 choices.push_back (_("Cancel"));
3432 choices.push_back (_("Yes, remove them all"));
3434 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3436 if (prompter.run () == 1) {
3437 _route->clear_processors (PreFader);
3438 _route->clear_processors (PostFader);
3443 ProcessorBox::clear_processors (Placement p)
3446 vector<string> choices;
3448 if (p == PreFader) {
3449 prompt = string_compose (_("Do you really want to remove all pre-fader processors from %1?\n"
3450 "(this cannot be undone)"), _route->name());
3452 prompt = string_compose (_("Do you really want to remove all post-fader processors from %1?\n"
3453 "(this cannot be undone)"), _route->name());
3456 choices.push_back (_("Cancel"));
3457 choices.push_back (_("Yes, remove them all"));
3459 Gtkmm2ext::Choice prompter (_("Remove processors"), prompt, choices);
3461 if (prompter.run () == 1) {
3462 _route->clear_processors (p);
3467 ProcessorBox::processor_can_be_edited (boost::shared_ptr<Processor> processor)
3469 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack> (_route);
3470 if (at && at->freeze_state() == AudioTrack::Frozen) {
3475 boost::dynamic_pointer_cast<Send> (processor) ||
3476 boost::dynamic_pointer_cast<Return> (processor) ||
3477 boost::dynamic_pointer_cast<PluginInsert> (processor) ||
3478 boost::dynamic_pointer_cast<PortInsert> (processor)
3487 ProcessorBox::one_processor_can_be_edited ()
3489 list<ProcessorEntry*> selection = processor_display.selection ();
3490 list<ProcessorEntry*>::iterator i = selection.begin();
3491 while (i != selection.end() && processor_can_be_edited ((*i)->processor()) == false) {
3495 return (i != selection.end());
3499 ProcessorBox::get_editor_window (boost::shared_ptr<Processor> processor, bool use_custom)
3501 boost::shared_ptr<Send> send;
3502 boost::shared_ptr<InternalSend> internal_send;
3503 boost::shared_ptr<Return> retrn;
3504 boost::shared_ptr<PluginInsert> plugin_insert;
3505 boost::shared_ptr<PortInsert> port_insert;
3508 /* This method may or may not return a Window, but if it does not it
3509 * will modify the parent mixer strip appearance layout to allow
3510 * "editing" the @param processor that was passed in.
3512 * So for example, if the processor is an Amp (gain), the parent strip
3513 * will be forced back into a model where the fader controls the main gain.
3514 * If the processor is a send, then we map the send controls onto the
3517 * Plugins and others will return a window for control.
3520 if (boost::dynamic_pointer_cast<AudioTrack>(_route) != 0) {
3522 if (boost::dynamic_pointer_cast<AudioTrack> (_route)->freeze_state() == AudioTrack::Frozen) {
3527 if (boost::dynamic_pointer_cast<Amp> (processor) && boost::dynamic_pointer_cast<Amp> (processor)->gain_control()->parameter().type() == GainAutomation) {
3529 if (_parent_strip) {
3530 _parent_strip->revert_to_default_display ();
3533 } else if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
3535 if (!_session->engine().connected()) {
3539 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3541 gidget = new SendUIWindow (send, _session);
3544 } else if ((retrn = boost::dynamic_pointer_cast<Return> (processor)) != 0) {
3546 if (boost::dynamic_pointer_cast<InternalReturn> (retrn)) {
3547 /* no GUI for these */
3551 if (!_session->engine().connected()) {
3555 boost::shared_ptr<Return> retrn = boost::dynamic_pointer_cast<Return> (processor);
3557 ReturnUIWindow *return_ui;
3558 Window* w = get_processor_ui (retrn);
3562 return_ui = new ReturnUIWindow (retrn, _session);
3563 return_ui->set_title (retrn->name ());
3564 set_processor_ui (send, return_ui);
3567 return_ui = dynamic_cast<ReturnUIWindow *> (w);
3572 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
3574 PluginUIWindow *plugin_ui;
3576 /* these are both allowed to be null */
3578 Window* w = get_processor_ui (plugin_insert);
3581 plugin_ui = new PluginUIWindow (plugin_insert, false, use_custom);
3582 plugin_ui->set_title (generate_processor_title (plugin_insert));
3583 set_processor_ui (plugin_insert, plugin_ui);
3586 plugin_ui = dynamic_cast<PluginUIWindow *> (w);
3591 } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (processor)) != 0) {
3593 if (!_session->engine().connected()) {
3594 MessageDialog msg ( _("Not connected to audio engine - no I/O changes are possible"));
3599 PortInsertWindow *io_selector;
3601 Window* w = get_processor_ui (port_insert);
3604 io_selector = new PortInsertWindow (_session, port_insert);
3605 set_processor_ui (port_insert, io_selector);
3608 io_selector = dynamic_cast<PortInsertWindow *> (w);
3611 gidget = io_selector;
3618 ProcessorBox::get_generic_editor_window (boost::shared_ptr<Processor> processor)
3620 boost::shared_ptr<PluginInsert> plugin_insert
3621 = boost::dynamic_pointer_cast<PluginInsert>(processor);
3623 if (!plugin_insert) {
3627 PluginUIWindow* win = new PluginUIWindow (plugin_insert, true, false);
3628 win->set_title (generate_processor_title (plugin_insert));
3634 ProcessorBox::register_actions ()
3636 processor_box_actions = myactions.create_action_group (X_("ProcessorMenu"));
3638 Glib::RefPtr<Action> act;
3641 myactions.register_action (processor_box_actions, X_("newplugin"), _("New Plugin"),
3642 sigc::ptr_fun (ProcessorBox::rb_choose_plugin));
3644 act = myactions.register_action (processor_box_actions, X_("newinsert"), _("New Insert"),
3645 sigc::ptr_fun (ProcessorBox::rb_choose_insert));
3646 ActionManager::engine_sensitive_actions.push_back (act);
3647 act = myactions.register_action (processor_box_actions, X_("newsend"), _("New External Send ..."),
3648 sigc::ptr_fun (ProcessorBox::rb_choose_send));
3649 ActionManager::engine_sensitive_actions.push_back (act);
3651 myactions.register_action (processor_box_actions, X_("newaux"), _("New Aux Send ..."));
3653 myactions.register_action (processor_box_actions, X_("controls"), _("Controls"));
3654 myactions.register_action (processor_box_actions, X_("send_options"), _("Send Options"));
3656 myactions.register_action (processor_box_actions, X_("clear"), _("Clear (all)"),
3657 sigc::ptr_fun (ProcessorBox::rb_clear));
3658 myactions.register_action (processor_box_actions, X_("clear_pre"), _("Clear (pre-fader)"),
3659 sigc::ptr_fun (ProcessorBox::rb_clear_pre));
3660 myactions.register_action (processor_box_actions, X_("clear_post"), _("Clear (post-fader)"),
3661 sigc::ptr_fun (ProcessorBox::rb_clear_post));
3663 /* standard editing stuff */
3665 cut_action = myactions.register_action (processor_box_actions, X_("cut"), _("Cut"),
3666 sigc::ptr_fun (ProcessorBox::rb_cut));
3667 copy_action = myactions.register_action (processor_box_actions, X_("copy"), _("Copy"),
3668 sigc::ptr_fun (ProcessorBox::rb_copy));
3669 delete_action = myactions.register_action (processor_box_actions, X_("delete"), _("Delete"),
3670 sigc::ptr_fun (ProcessorBox::rb_delete));
3671 backspace_action = myactions.register_action (processor_box_actions, X_("backspace"), _("Delete"),
3672 sigc::ptr_fun (ProcessorBox::rb_delete));
3674 ActionManager::plugin_selection_sensitive_actions.push_back (cut_action);
3675 ActionManager::plugin_selection_sensitive_actions.push_back (copy_action);
3676 ActionManager::plugin_selection_sensitive_actions.push_back (delete_action);
3677 ActionManager::plugin_selection_sensitive_actions.push_back (backspace_action);
3679 paste_action = myactions.register_action (processor_box_actions, X_("paste"), _("Paste"),
3680 sigc::ptr_fun (ProcessorBox::rb_paste));
3681 rename_action = myactions.register_action (processor_box_actions, X_("rename"), _("Rename"),
3682 sigc::ptr_fun (ProcessorBox::rb_rename));
3683 myactions.register_action (processor_box_actions, X_("selectall"), _("Select All"),
3684 sigc::ptr_fun (ProcessorBox::rb_select_all));
3685 myactions.register_action (processor_box_actions, X_("deselectall"), _("Deselect All"),
3686 sigc::ptr_fun (ProcessorBox::rb_deselect_all));
3688 /* activation etc. */
3690 myactions.register_action (processor_box_actions, X_("activate_all"), _("Activate All"),
3691 sigc::ptr_fun (ProcessorBox::rb_activate_all));
3692 myactions.register_action (processor_box_actions, X_("deactivate_all"), _("Deactivate All"),
3693 sigc::ptr_fun (ProcessorBox::rb_deactivate_all));
3694 myactions.register_action (processor_box_actions, X_("ab_plugins"), _("A/B Plugins"),
3695 sigc::ptr_fun (ProcessorBox::rb_ab_plugins));
3697 manage_pins_action = myactions.register_action (
3698 processor_box_actions, X_("manage-pins"), _("Pin Connections..."),
3699 sigc::ptr_fun (ProcessorBox::rb_manage_pins));
3702 edit_action = myactions.register_action (
3703 processor_box_actions, X_("edit"), _("Edit..."),
3704 sigc::ptr_fun (ProcessorBox::rb_edit));
3706 edit_generic_action = myactions.register_action (
3707 processor_box_actions, X_("edit-generic"), _("Edit with generic controls..."),
3708 sigc::ptr_fun (ProcessorBox::rb_edit_generic));
3714 ProcessorBox::rb_edit_generic ()
3716 if (_current_processor_box == 0) {
3720 _current_processor_box->for_selected_processors (&ProcessorBox::generic_edit_processor);
3724 ProcessorBox::rb_ab_plugins ()
3726 if (_current_processor_box == 0) {
3730 _current_processor_box->ab_plugins ();
3734 ProcessorBox::rb_manage_pins ()
3736 if (_current_processor_box == 0) {
3740 _current_processor_box->for_selected_processors (&ProcessorBox::manage_pins);
3743 ProcessorBox::rb_choose_plugin ()
3745 if (_current_processor_box == 0) {
3748 _current_processor_box->choose_plugin ();
3752 ProcessorBox::rb_choose_insert ()
3754 if (_current_processor_box == 0) {
3757 _current_processor_box->choose_insert ();
3761 ProcessorBox::rb_choose_send ()
3763 if (_current_processor_box == 0) {
3766 _current_processor_box->choose_send ();
3770 ProcessorBox::rb_choose_aux (boost::weak_ptr<Route> wr)
3772 if (_current_processor_box == 0) {
3776 _current_processor_box->choose_aux (wr);
3780 ProcessorBox::rb_clear ()
3782 if (_current_processor_box == 0) {
3786 _current_processor_box->clear_processors ();
3791 ProcessorBox::rb_clear_pre ()
3793 if (_current_processor_box == 0) {
3797 _current_processor_box->clear_processors (PreFader);
3802 ProcessorBox::rb_clear_post ()
3804 if (_current_processor_box == 0) {
3808 _current_processor_box->clear_processors (PostFader);
3812 ProcessorBox::rb_cut ()
3814 if (_current_processor_box == 0) {
3818 _current_processor_box->processor_operation (ProcessorsCut);
3822 ProcessorBox::rb_delete ()
3824 if (_current_processor_box == 0) {
3828 _current_processor_box->processor_operation (ProcessorsDelete);
3832 ProcessorBox::rb_copy ()
3834 if (_current_processor_box == 0) {
3837 _current_processor_box->processor_operation (ProcessorsCopy);
3841 ProcessorBox::rb_paste ()
3843 if (_current_processor_box == 0) {
3847 _current_processor_box->processor_operation (ProcessorsPaste);
3851 ProcessorBox::rb_rename ()
3853 if (_current_processor_box == 0) {
3856 _current_processor_box->rename_processors ();
3860 ProcessorBox::rb_select_all ()
3862 if (_current_processor_box == 0) {
3866 _current_processor_box->processor_operation (ProcessorsSelectAll);
3870 ProcessorBox::rb_deselect_all ()
3872 if (_current_processor_box == 0) {
3876 _current_processor_box->deselect_all_processors ();
3880 ProcessorBox::rb_activate_all ()
3882 if (_current_processor_box == 0) {
3886 _current_processor_box->all_visible_processors_active (true);
3890 ProcessorBox::rb_deactivate_all ()
3892 if (_current_processor_box == 0) {
3895 _current_processor_box->all_visible_processors_active (false);
3899 ProcessorBox::rb_edit ()
3901 if (_current_processor_box == 0) {
3905 _current_processor_box->for_selected_processors (&ProcessorBox::edit_processor);
3909 ProcessorBox::edit_aux_send (boost::shared_ptr<Processor> processor)
3911 if (boost::dynamic_pointer_cast<InternalSend> (processor) == 0) {
3915 if (_parent_strip) {
3916 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3917 if (_parent_strip->current_delivery() == send) {
3918 _parent_strip->revert_to_default_display ();
3920 _parent_strip->show_send(send);
3927 ProcessorBox::edit_processor (boost::shared_ptr<Processor> processor)
3932 if (edit_aux_send (processor)) {
3935 if (!_session->engine().connected()) {
3939 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3942 proxy->set_custom_ui_mode (true);
3943 proxy->show_the_right_window ();
3948 ProcessorBox::generic_edit_processor (boost::shared_ptr<Processor> processor)
3953 if (edit_aux_send (processor)) {
3956 if (!_session->engine().connected()) {
3960 ProcessorWindowProxy* proxy = find_window_proxy (processor);
3963 proxy->set_custom_ui_mode (false);
3964 proxy->show_the_right_window ();
3969 ProcessorBox::manage_pins (boost::shared_ptr<Processor> processor)
3974 PluginPinWindowProxy* proxy = processor->pinmgr_proxy ();
3983 ProcessorBox::route_property_changed (const PropertyChange& what_changed)
3985 if (!what_changed.contains (ARDOUR::Properties::name)) {
3989 ENSURE_GUI_THREAD (*this, &ProcessorBox::route_property_changed, what_changed);
3991 boost::shared_ptr<Processor> processor;
3992 boost::shared_ptr<PluginInsert> plugin_insert;
3993 boost::shared_ptr<Send> send;
3995 list<ProcessorEntry*> children = processor_display.children();
3997 for (list<ProcessorEntry*>::iterator iter = children.begin(); iter != children.end(); ++iter) {
3999 processor = (*iter)->processor ();
4005 Window* w = get_processor_ui (processor);
4011 /* rename editor windows for sends and plugins */
4013 if ((send = boost::dynamic_pointer_cast<Send> (processor)) != 0) {
4014 w->set_title (send->name ());
4015 } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (processor)) != 0) {
4016 w->set_title (generate_processor_title (plugin_insert));
4022 ProcessorBox::generate_processor_title (boost::shared_ptr<PluginInsert> pi)
4024 string maker = pi->plugin()->maker() ? pi->plugin()->maker() : "";
4025 string::size_type email_pos;
4027 if ((email_pos = maker.find_first_of ('<')) != string::npos) {
4028 maker = maker.substr (0, email_pos - 1);
4031 if (maker.length() > 32) {
4032 maker = maker.substr (0, 32);
4036 SessionObject* owner = pi->owner();
4039 return string_compose(_("%1: %2 (by %3)"), owner->name(), pi->name(), maker);
4041 return string_compose(_("%1 (by %2)"), pi->name(), maker);
4045 /** @param p Processor.
4046 * @return the UI window for \a p.
4049 ProcessorBox::get_processor_ui (boost::shared_ptr<Processor> p) const
4051 ProcessorWindowProxy* wp = p->window_proxy();
4058 /** Make a note of the UI window that a processor is using.
4059 * @param p Processor.
4060 * @param w UI window.
4063 ProcessorBox::set_processor_ui (boost::shared_ptr<Processor> p, Gtk::Window* w)
4065 assert (p->window_proxy());
4067 p->window_proxy()->use_window (*w);
4071 ProcessorBox::mixer_strip_delivery_changed (boost::weak_ptr<Delivery> w)
4073 boost::shared_ptr<Delivery> d = w.lock ();
4078 list<ProcessorEntry*> children = processor_display.children ();
4079 list<ProcessorEntry*>::const_iterator i = children.begin();
4080 while (i != children.end() && (*i)->processor() != d) {
4084 if (i == children.end()) {
4085 processor_display.set_active (0);
4087 processor_display.set_active (*i);
4091 /** Called to repair the damage of Editor::show_window doing a show_all() */
4093 ProcessorBox::hide_things ()
4095 list<ProcessorEntry*> c = processor_display.children ();
4096 for (list<ProcessorEntry*>::iterator i = c.begin(); i != c.end(); ++i) {
4097 (*i)->hide_things ();
4102 ProcessorBox::processor_menu_unmapped ()
4104 processor_display.remove_placeholder ();
4105 /* make all possibly-desensitized actions sensitive again so that
4106 they be activated by other means (e.g. bindings)
4108 ActionManager::set_sensitive (ActionManager::plugin_selection_sensitive_actions, true);
4112 ProcessorBox::entry_gui_object_state (ProcessorEntry* entry)
4114 if (!_parent_strip) {
4118 GUIObjectState& st = _parent_strip->gui_object_state ();
4120 XMLNode* strip = st.get_or_add_node (_parent_strip->state_id ());
4122 return st.get_or_add_node (strip, entry->state_id());
4126 ProcessorBox::update_gui_object_state (ProcessorEntry* entry)
4128 XMLNode* proc = entry_gui_object_state (entry);
4133 /* XXX: this is a bit inefficient; we just remove all child nodes and re-add them */
4134 proc->remove_nodes_and_delete (X_("Object"));
4135 entry->add_control_state (proc);
4139 ProcessorBox::is_editor_mixer_strip() const
4141 return _parent_strip && !_parent_strip->mixer_owned();
4144 ProcessorWindowProxy::ProcessorWindowProxy (string const & name, ProcessorBox* box, boost::weak_ptr<Processor> processor)
4145 : WM::ProxyBase (name, string())
4146 , _processor_box (box)
4147 , _processor (processor)
4149 , want_custom (false)
4151 boost::shared_ptr<Processor> p = _processor.lock ();
4155 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&ProcessorWindowProxy::processor_going_away, this), gui_context());
4158 ProcessorWindowProxy::~ProcessorWindowProxy()
4160 /* processor window proxies do not own the windows they create with
4161 * ::get(), so set _window to null before the normal WindowProxy method
4168 ProcessorWindowProxy::processor_going_away ()
4172 WM::Manager::instance().remove (this);
4173 /* should be no real reason to do this, since the object that would
4174 send DropReferences is about to be deleted, but lets do it anyway.
4176 going_away_connection.disconnect();
4179 ARDOUR::SessionHandlePtr*
4180 ProcessorWindowProxy::session_handle()
4187 ProcessorWindowProxy::get_state ()
4190 node = &ProxyBase::get_state();
4191 node->add_property (X_("custom-ui"), is_custom? X_("yes") : X_("no"));
4196 ProcessorWindowProxy::set_state (const XMLNode& node, int /*version*/)
4198 XMLNodeList children = node.children ();
4199 XMLNodeList::const_iterator i = children.begin ();
4200 while (i != children.end()) {
4201 XMLProperty const * prop = (*i)->property (X_("name"));
4202 if ((*i)->name() == X_("Window") && prop && prop->value() == _name) {
4208 if (i != children.end()) {
4209 XMLProperty const * prop;
4210 if ((prop = (*i)->property (X_("custom-ui"))) != 0) {
4211 want_custom = PBD::string_is_affirmative (prop->value ());
4215 return ProxyBase::set_state (node, 0);
4219 ProcessorWindowProxy::get (bool create)
4221 boost::shared_ptr<Processor> p = _processor.lock ();
4226 if (_window && (is_custom != want_custom)) {
4227 /* drop existing window - wrong type */
4236 is_custom = want_custom;
4237 _window = _processor_box->get_editor_window (p, is_custom);
4242 _window->show_all ();
4248 ProcessorWindowProxy::show_the_right_window ()
4250 if (_window && (is_custom != want_custom)) {
4251 /* drop existing window - wrong type */
4258 PluginPinWindowProxy::PluginPinWindowProxy(std::string const &name, boost::weak_ptr<ARDOUR::Processor> processor)
4259 : WM::ProxyBase (name, string())
4260 , _processor (processor)
4262 boost::shared_ptr<Processor> p = _processor.lock ();
4266 p->DropReferences.connect (going_away_connection, MISSING_INVALIDATOR, boost::bind (&PluginPinWindowProxy::processor_going_away, this), gui_context());
4269 PluginPinWindowProxy::~PluginPinWindowProxy()
4274 ARDOUR::SessionHandlePtr*
4275 PluginPinWindowProxy::session_handle ()
4277 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4278 if (aw) { return aw; }
4283 PluginPinWindowProxy::get (bool create)
4285 boost::shared_ptr<Processor> p = _processor.lock ();
4286 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (p);
4295 _window = new PluginPinDialog (pi);
4296 ArdourWindow* aw = dynamic_cast<ArdourWindow*> (_window);
4298 aw->set_session (_session);
4300 _window->show_all ();
4306 PluginPinWindowProxy::processor_going_away ()
4310 WM::Manager::instance().remove (this);
4311 going_away_connection.disconnect();
4315 ProcessorBox::load_bindings ()
4317 bindings = Bindings::get_bindings (X_("Processor Box"), myactions);