2 Copyright (C) 2000 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.
26 #include <pbd/stl_delete.h>
27 #include <pbd/xml++.h>
28 #include <pbd/failed_constructor.h>
30 #include <gtkmm2ext/click_box.h>
31 #include <gtkmm2ext/fastmeter.h>
32 #include <gtkmm2ext/barcontroller.h>
33 #include <gtkmm2ext/utils.h>
34 #include <gtkmm2ext/doi.h>
35 #include <gtkmm2ext/slider_controller.h>
37 #include <midi++/manager.h>
39 #include <ardour/audioengine.h>
40 #include <ardour/plugin.h>
41 #include <ardour/insert.h>
42 #include <ardour/ladspa_plugin.h>
44 #include <ardour/vst_plugin.h>
49 #include "ardour_ui.h"
51 #include "plugin_ui.h"
53 #include "gui_thread.h"
58 using namespace ARDOUR;
60 using namespace Gtkmm2ext;
64 PluginUIWindow::PluginUIWindow (AudioEngine &engine, boost::shared_ptr<PluginInsert> insert, bool scrollable)
65 : ArdourDialog ("plugin ui")
67 if (insert->plugin()->has_editor()) {
71 boost::shared_ptr<VSTPlugin> vp;
73 if ((vp = boost::dynamic_pointer_cast<VSTPlugin> (insert->plugin())) != 0) {
76 VSTPluginUI* vpu = new VSTPluginUI (insert, vp);
79 get_vbox()->add (*vpu);
84 error << _("unknown type of editor-supplying plugin (note: no VST support in this version of ardour)")
86 throw failed_constructor ();
93 PluginUI* pu = new PluginUI (engine, insert, scrollable);
96 get_vbox()->add (*pu);
98 signal_map_event().connect (mem_fun (*pu, &PluginUI::start_updating));
99 signal_unmap_event().connect (mem_fun (*pu, &PluginUI::stop_updating));
102 set_position (Gtk::WIN_POS_MOUSE);
103 set_name ("PluginEditor");
104 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
106 signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window*> (this)));
107 insert->GoingAway.connect (mem_fun(*this, &PluginUIWindow::plugin_going_away));
110 gint h = _pluginui->get_preferred_height ();
111 if (h > 600) h = 600;
112 set_default_size (450, h);
116 PluginUIWindow::~PluginUIWindow ()
120 PluginUI::PluginUI (AudioEngine &engine, boost::shared_ptr<PluginInsert> pi, bool scrollable)
123 button_table (initial_button_rows, initial_button_cols),
124 output_table (initial_output_rows, initial_output_cols),
125 hAdjustment(0.0, 0.0, 0.0),
126 vAdjustment(0.0, 0.0, 0.0),
127 scroller_view(hAdjustment, vAdjustment),
129 is_scrollable(scrollable)
131 set_name ("PluginEditor");
132 set_border_width (10);
133 set_homogeneous (false);
135 settings_box.set_homogeneous (false);
137 HBox* constraint_hbox = manage (new HBox);
138 HBox* smaller_hbox = manage (new HBox);
139 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
140 combo_label->set_use_markup (true);
142 smaller_hbox->pack_start (*combo_label, false, false, 10);
143 smaller_hbox->pack_start (combo, false, false);
144 smaller_hbox->pack_start (save_button, false, false);
146 constraint_hbox->set_spacing (5);
147 constraint_hbox->pack_start (*smaller_hbox, true, false);
148 constraint_hbox->pack_end (bypass_button, false, false);
150 settings_box.pack_end (*constraint_hbox, false, false);
152 pack_start (settings_box, false, false);
154 if ( is_scrollable ) {
155 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
156 scroller.set_name ("PluginEditor");
157 scroller_view.set_name("PluginEditor");
158 scroller_view.add (hpacker);
159 scroller.add (scroller_view);
161 pack_start (scroller, true, true);
165 pack_start (hpacker, false, false);
168 insert->active_changed.connect (mem_fun(*this, &PluginUI::redirect_active_changed));
169 bypass_button.set_active (!insert->active());
174 PluginUI::~PluginUI ()
176 if (output_controls.size() > 0) {
177 screen_update_connection.disconnect();
182 PluginUI::build (AudioEngine &engine)
190 int output_row, output_col;
191 int button_row, button_col;
192 int output_rows, output_cols;
193 int button_rows, button_cols;
194 guint32 n_ins=0, n_outs = 0;
197 hpacker.set_spacing (10);
199 output_rows = initial_output_rows;
200 output_cols = initial_output_cols;
201 button_rows = initial_button_rows;
202 button_cols = initial_button_cols;
208 button_table.set_homogeneous (false);
209 button_table.set_row_spacings (2);
210 button_table.set_col_spacings (2);
211 output_table.set_homogeneous (true);
212 output_table.set_row_spacings (2);
213 output_table.set_col_spacings (2);
214 button_table.set_border_width (5);
215 output_table.set_border_width (5);
217 hpacker.set_border_width (10);
219 bt_frame = manage (new Frame);
220 bt_frame->set_name ("BaseFrame");
221 bt_frame->add (button_table);
222 hpacker.pack_start(*bt_frame, true, true);
224 box = manage (new VBox);
225 box->set_border_width (5);
226 box->set_spacing (1);
228 frame = manage (new Frame);
229 frame->set_name ("BaseFrame");
230 frame->set_label (_("Controls"));
232 hpacker.pack_start(*frame, true, true);
234 /* find all ports. build control elements for all appropriate control ports */
236 for (i = 0; i < plugin->parameter_count(); ++i) {
238 if (plugin->parameter_is_control (i)) {
240 /* Don't show latency control ports */
242 if (plugin->describe_parameter (i) == X_("latency")) {
248 /* if we are scrollable, just use one long column */
250 if (!is_scrollable) {
252 frame = manage (new Frame);
253 frame->set_name ("BaseFrame");
254 box = manage (new VBox);
256 box->set_border_width (5);
257 box->set_spacing (1);
260 hpacker.pack_start(*frame,true,true);
266 if ((cui = build_control_ui (engine, i, plugin->get_nth_control (i))) == 0) {
267 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
271 if (cui->control || cui->clickbox || cui->combo) {
273 box->pack_start (*cui, false, false);
275 } else if (cui->button) {
277 if (button_row == button_rows) {
279 if (++button_col == button_cols) {
281 button_table.resize (button_rows, button_cols);
285 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
289 } else if (cui->display) {
291 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
294 // TODO: The meters should be divided into multiple rows
296 if (++output_col == output_cols) {
298 output_table.resize (output_rows, output_cols);
301 /* old code, which divides meters into
302 * columns first, rows later. New code divides into one row
304 if (output_row == output_rows) {
306 if (++output_col == output_cols) {
308 output_table.resize (output_rows, output_cols);
312 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
319 /* HACK: ideally the preferred height would be queried from
320 the complete hpacker, but I can't seem to get that
321 information in time, so this is an estimation
329 n_ins = plugin->get_info().n_inputs;
330 n_outs = plugin->get_info().n_outputs;
332 if (box->children().empty()) {
333 hpacker.remove (*frame);
336 if (button_table.children().empty()) {
337 hpacker.remove (*bt_frame);
340 if (!output_table.children().empty()) {
341 frame = manage (new Frame);
342 frame->set_name ("BaseFrame");
343 frame->add (output_table);
344 hpacker.pack_end (*frame, true, true);
349 output_table.show_all ();
350 button_table.show_all ();
353 PluginUI::ControlUI::ControlUI ()
354 : automate_button (X_("")) // force creation of a label
356 automate_button.set_name ("PluginAutomateButton");
357 ARDOUR_UI::instance()->tooltips().set_tip (automate_button,
358 _("Automation control"));
360 /* don't fix the height, it messes up the bar controllers */
362 set_size_request_to_display_given_text (automate_button, X_("lngnuf"), 2, 2);
373 PluginUI::ControlUI::~ControlUI()
380 delete meterinfo->meter;
386 PluginUI::automation_state_changed (ControlUI* cui)
388 /* update button label */
390 switch (insert->get_port_automation_state (cui->port_index) & (Off|Play|Touch|Write)) {
392 cui->automate_button.set_label (_("Off"));
395 cui->automate_button.set_label (_("Play"));
398 cui->automate_button.set_label (_("Write"));
401 cui->automate_button.set_label (_("Touch"));
404 cui->automate_button.set_label (_("???"));
410 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
412 snprintf (buf, 32, "%.0f", adj.get_value());
416 PluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
418 plugin->print_parameter (param, buf, len);
422 PluginUI::build_control_ui (AudioEngine &engine, guint32 port_index, PBD::Controllable* mcontrol)
425 ControlUI* control_ui;
426 Plugin::ParameterDescriptor desc;
428 plugin->get_parameter_descriptor (port_index, desc);
430 control_ui = manage (new ControlUI ());
431 control_ui->adjustment = 0;
432 control_ui->combo = 0;
433 control_ui->combo_map = 0;
434 control_ui->port_index = port_index;
435 control_ui->update_pending = false;
436 control_ui->label.set_text (desc.label);
437 control_ui->label.set_alignment (0.0, 0.5);
438 control_ui->label.set_name ("PluginParameterLabel");
440 control_ui->set_spacing (5);
442 if (plugin->parameter_is_input (port_index)) {
444 boost::shared_ptr<LadspaPlugin> lp;
446 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
448 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
450 if (defaults && defaults->count > 0) {
452 control_ui->combo = new Gtk::ComboBoxText;
453 //control_ui->combo->set_value_in_list(true, false);
454 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
455 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &PluginUI::control_combo_changed), control_ui));
456 plugin->ParameterChanged.connect (bind (mem_fun (*this, &PluginUI::parameter_changed), control_ui));
457 control_ui->pack_start(control_ui->label, true, true);
458 control_ui->pack_start(*control_ui->combo, false, true);
460 update_control_display(control_ui);
462 lrdf_free_setting_values(defaults);
471 control_ui->button = manage (new ToggleButton ());
472 control_ui->button->set_name ("PluginEditorButton");
473 control_ui->button->set_size_request (20, 20);
475 control_ui->pack_start (control_ui->label, true, true);
476 control_ui->pack_start (*control_ui->button, false, true);
477 control_ui->pack_start (control_ui->automate_button, false, false);
479 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &PluginUI::control_port_toggled), control_ui));
481 if(plugin->get_parameter (port_index) == 1){
482 control_ui->button->set_active(true);
488 control_ui->adjustment = new Adjustment (0, 0, 0, 0, 0);
490 /* XXX this code is not right yet, because it doesn't handle
491 the absence of bounds in any sensible fashion.
494 control_ui->adjustment->set_lower (desc.lower);
495 control_ui->adjustment->set_upper (desc.upper);
497 control_ui->logarithmic = desc.logarithmic;
498 if (control_ui->logarithmic) {
499 if (control_ui->adjustment->get_lower() == 0.0) {
500 control_ui->adjustment->set_lower (control_ui->adjustment->get_upper()/10000);
502 control_ui->adjustment->set_upper (log(control_ui->adjustment->get_upper()));
503 control_ui->adjustment->set_lower (log(control_ui->adjustment->get_lower()));
506 float delta = desc.upper - desc.lower;
508 control_ui->adjustment->set_page_size (delta/100.0);
509 control_ui->adjustment->set_step_increment (desc.step);
510 control_ui->adjustment->set_page_increment (desc.largestep);
512 if (desc.integer_step) {
513 control_ui->clickbox = new ClickBox (control_ui->adjustment, "PluginUIClickBox");
514 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
515 control_ui->clickbox->set_print_func (integer_printer, 0);
517 sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &PluginUI::print_parameter), (uint32_t) port_index);
519 control_ui->control = new BarController (*control_ui->adjustment, *mcontrol, pslot);
520 // should really match the height of the text in the automation button+label
521 control_ui->control->set_size_request (200, 22);
522 control_ui->control->set_name (X_("PluginSlider"));
523 control_ui->control->set_style (BarController::LeftToRight);
524 control_ui->control->set_use_parent (true);
526 control_ui->control->StartGesture.connect (bind (mem_fun(*this, &PluginUI::start_touch), control_ui));
527 control_ui->control->StopGesture.connect (bind (mem_fun(*this, &PluginUI::stop_touch), control_ui));
531 if (control_ui->logarithmic) {
532 control_ui->adjustment->set_value(log(plugin->get_parameter(port_index)));
534 control_ui->adjustment->set_value(plugin->get_parameter(port_index));
537 /* XXX memory leak: SliderController not destroyed by ControlUI
538 destructor, and manage() reports object hierarchy
542 control_ui->pack_start (control_ui->label, true, true);
543 if (desc.integer_step) {
544 control_ui->pack_start (*control_ui->clickbox, false, false);
546 control_ui->pack_start (*control_ui->control, false, false);
549 control_ui->pack_start (control_ui->automate_button, false, false);
550 control_ui->adjustment->signal_value_changed().connect (bind (mem_fun(*this, &PluginUI::control_adjustment_changed), control_ui));
551 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &PluginUI::astate_clicked), control_ui, (uint32_t) port_index));
553 automation_state_changed (control_ui);
555 plugin->ParameterChanged.connect (bind (mem_fun(*this, &PluginUI::parameter_changed), control_ui));
556 insert->automation_list (port_index).automation_state_changed.connect
557 (bind (mem_fun(*this, &PluginUI::automation_state_changed), control_ui));
559 } else if (plugin->parameter_is_output (port_index)) {
561 control_ui->display = manage (new EventBox);
562 control_ui->display->set_name ("ParameterValueDisplay");
564 control_ui->display_label = manage (new Label);
566 control_ui->display_label->set_name ("ParameterValueDisplay");
568 control_ui->display->add (*control_ui->display_label);
569 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
571 control_ui->display->show_all ();
574 /* TODO: only make a meter if the port is Hinted for it */
576 MeterInfo * info = new MeterInfo(port_index);
577 control_ui->meterinfo = info;
579 info->meter = new FastMeter (5, 100, FastMeter::Vertical);
581 info->min_unbound = desc.min_unbound;
582 info->max_unbound = desc.max_unbound;
584 info->min = desc.lower;
585 info->max = desc.upper;
587 control_ui->vbox = manage (new VBox);
588 control_ui->hbox = manage (new HBox);
590 control_ui->label.set_angle(90);
591 control_ui->hbox->pack_start (control_ui->label, false, false);
592 control_ui->hbox->pack_start (*info->meter, false, false);
594 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
596 control_ui->vbox->pack_start (*control_ui->display, false, false);
598 control_ui->pack_start (*control_ui->vbox);
600 control_ui->meterinfo->meter->show_all();
601 control_ui->meterinfo->packed = true;
603 output_controls.push_back (control_ui);
606 plugin->ParameterChanged.connect (bind (mem_fun(*this, &PluginUI::parameter_changed), control_ui));
611 PluginUI::start_touch (PluginUI::ControlUI* cui)
613 insert->automation_list (cui->port_index).start_touch ();
617 PluginUI::stop_touch (PluginUI::ControlUI* cui)
619 insert->automation_list (cui->port_index).stop_touch ();
623 PluginUI::astate_clicked (ControlUI* cui, uint32_t port)
625 using namespace Menu_Helpers;
627 if (automation_menu == 0) {
628 automation_menu = manage (new Menu);
629 automation_menu->set_name ("ArdourContextMenu");
632 MenuList& items (automation_menu->items());
635 items.push_back (MenuElem (_("Off"),
636 bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Off, cui)));
637 items.push_back (MenuElem (_("Play"),
638 bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Play, cui)));
639 items.push_back (MenuElem (_("Write"),
640 bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Write, cui)));
641 items.push_back (MenuElem (_("Touch"),
642 bind (mem_fun(*this, &PluginUI::set_automation_state), (AutoState) Touch, cui)));
644 automation_menu->popup (1, 0);
648 PluginUI::set_automation_state (AutoState state, ControlUI* cui)
650 insert->set_port_automation_state (cui->port_index, state);
654 PluginUI::control_adjustment_changed (ControlUI* cui)
656 if (cui->ignore_change) {
660 double value = cui->adjustment->get_value();
662 if (cui->logarithmic) {
666 insert->set_parameter (cui->port_index, (float) value);
670 PluginUI::parameter_changed (uint32_t abs_port_id, float val, ControlUI* cui)
672 if (cui->port_index == abs_port_id) {
673 if (!cui->update_pending) {
674 cui->update_pending = true;
675 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &PluginUI::update_control_display), cui));
681 PluginUI::update_control_display (ControlUI* cui)
683 /* XXX how do we handle logarithmic stuff here ? */
685 cui->update_pending = false;
687 float val = plugin->get_parameter (cui->port_index);
689 cui->ignore_change++;
691 std::map<string,float>::iterator it;
692 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
693 if (it->second == val) {
694 cui->combo->set_active_text(it->first);
698 } else if (cui->adjustment == 0) {
701 cui->button->set_active (true);
703 cui->button->set_active (false);
707 if (cui->logarithmic) {
710 if (val != cui->adjustment->get_value()) {
711 cui->adjustment->set_value (val);
714 cui->ignore_change--;
718 PluginUI::control_port_toggled (ControlUI* cui)
720 if (!cui->ignore_change) {
721 insert->set_parameter (cui->port_index, cui->button->get_active());
726 PluginUI::control_combo_changed (ControlUI* cui)
728 if (!cui->ignore_change) {
729 string value = cui->combo->get_active_text();
730 std::map<string,float> mapping = *cui->combo_map;
731 insert->set_parameter (cui->port_index, mapping[value]);
737 PluginUIWindow::plugin_going_away (ARDOUR::Redirect* ignored)
739 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginUIWindow::plugin_going_away), ignored));
741 _pluginui->stop_updating(0);
742 delete_when_idle (this);
746 PluginUI::redirect_active_changed (Redirect* r, void* src)
748 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginUI::redirect_active_changed), r, src));
750 bypass_button.set_active (!r->active());
754 PluginUI::start_updating (GdkEventAny* ignored)
756 if (output_controls.size() > 0 ) {
757 screen_update_connection.disconnect();
758 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
759 (mem_fun(*this, &PluginUI::output_update));
765 PluginUI::stop_updating (GdkEventAny* ignored)
767 if (output_controls.size() > 0 ) {
768 screen_update_connection.disconnect();
774 PluginUI::output_update ()
776 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
777 float val = plugin->get_parameter ((*i)->port_index);
779 snprintf (buf, sizeof(buf), "%.2f", val);
780 (*i)->display_label->set_text (buf);
782 /* autoscaling for the meter */
783 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
785 if (val < (*i)->meterinfo->min) {
786 if ((*i)->meterinfo->min_unbound)
787 (*i)->meterinfo->min = val;
789 val = (*i)->meterinfo->min;
792 if (val > (*i)->meterinfo->max) {
793 if ((*i)->meterinfo->max_unbound)
794 (*i)->meterinfo->max = val;
796 val = (*i)->meterinfo->max;
799 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
800 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
801 (*i)->meterinfo->meter->set (lval );
808 PluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
810 vector<string> enums;
811 boost::shared_ptr<LadspaPlugin> lp = boost::dynamic_pointer_cast<LadspaPlugin> (plugin);
813 cui->combo_map = new std::map<string, float>;
814 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
816 for (uint32_t i = 0; i < defaults->count; ++i) {
817 enums.push_back(defaults->items[i].label);
818 pair<string, float> newpair;
819 newpair.first = defaults->items[i].label;
820 newpair.second = defaults->items[i].value;
821 cui->combo_map->insert(newpair);
824 lrdf_free_setting_values(defaults);
830 PlugUIBase::PlugUIBase (boost::shared_ptr<PluginInsert> pi)
832 plugin (insert->plugin()),
833 save_button(_("Add")),
834 bypass_button (_("Bypass"))
836 //combo.set_use_arrows_always(true);
837 set_popdown_strings (combo, plugin->get_presets());
838 combo.set_size_request (100, -1);
839 combo.set_active_text ("");
840 combo.signal_changed().connect(mem_fun(*this, &PlugUIBase::setting_selected));
842 save_button.set_name ("PluginSaveButton");
843 save_button.signal_clicked().connect(mem_fun(*this, &PlugUIBase::save_plugin_setting));
845 bypass_button.set_name ("PluginBypassButton");
846 bypass_button.signal_toggled().connect (mem_fun(*this, &PlugUIBase::bypass_toggled));
850 PlugUIBase::setting_selected()
852 if (combo.get_active_text().length() > 0) {
853 if (!plugin->load_preset(combo.get_active_text())) {
854 warning << string_compose(_("Plugin preset %1 not found"), combo.get_active_text()) << endmsg;
861 PlugUIBase::save_plugin_setting ()
863 ArdourPrompter prompter (true);
864 prompter.set_prompt(_("Name of New Preset:"));
865 prompter.add_button (Gtk::Stock::ADD, Gtk::RESPONSE_ACCEPT);
866 prompter.set_response_sensitive (Gtk::RESPONSE_ACCEPT, false);
870 switch (prompter.run ()) {
871 case Gtk::RESPONSE_ACCEPT:
875 prompter.get_result(name);
878 if(plugin->save_preset(name)){
879 set_popdown_strings (combo, plugin->get_presets());
880 combo.set_active_text (name);
888 PlugUIBase::bypass_toggled ()
892 if ((x = bypass_button.get_active()) == insert->active()) {
893 insert->set_active (!x, this);