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.
25 #include <pbd/stl_delete.h>
26 #include <pbd/xml++.h>
27 #include <pbd/failed_constructor.h>
29 #include <gtkmm2ext/click_box.h>
30 #include <gtkmm2ext/fastmeter.h>
31 #include <gtkmm2ext/barcontroller.h>
32 #include <gtkmm2ext/utils.h>
33 #include <gtkmm2ext/doi.h>
34 #include <gtkmm2ext/slider_controller.h>
36 #include <midi++/manager.h>
38 #include <ardour/plugin.h>
39 #include <ardour/insert.h>
40 #include <ardour/ladspa_plugin.h>
42 #include <ardour/lv2_plugin.h>
47 #include "ardour_ui.h"
49 #include "plugin_ui.h"
51 #include "gui_thread.h"
56 using namespace ARDOUR;
58 using namespace Gtkmm2ext;
62 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
64 button_table (initial_button_rows, initial_button_cols),
65 output_table (initial_output_rows, initial_output_cols),
66 hAdjustment(0.0, 0.0, 0.0),
67 vAdjustment(0.0, 0.0, 0.0),
68 scroller_view(hAdjustment, vAdjustment),
70 is_scrollable(scrollable)
72 set_name ("PluginEditor");
73 set_border_width (10);
74 set_homogeneous (false);
76 settings_box.set_homogeneous (false);
78 HBox* constraint_hbox = manage (new HBox);
79 HBox* smaller_hbox = manage (new HBox);
80 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
81 combo_label->set_use_markup (true);
83 smaller_hbox->pack_start (*combo_label, false, false, 10);
84 smaller_hbox->pack_start (preset_combo, false, false);
85 smaller_hbox->pack_start (save_button, false, false);
87 constraint_hbox->set_spacing (5);
88 constraint_hbox->pack_start (*smaller_hbox, true, false);
89 constraint_hbox->pack_end (focus_button, false, false);
90 constraint_hbox->pack_end (bypass_button, false, false);
92 settings_box.pack_end (*constraint_hbox, false, false);
94 pack_start (settings_box, false, false);
96 if ( is_scrollable ) {
97 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
98 scroller.set_name ("PluginEditor");
99 scroller_view.set_name("PluginEditor");
100 scroller_view.add (hpacker);
101 scroller.add (scroller_view);
103 pack_start (scroller, true, true);
107 pack_start (hpacker, false, false);
110 insert->active_changed.connect (mem_fun(*this, &GenericPluginUI::redirect_active_changed));
111 bypass_button.set_active (!insert->active());
116 GenericPluginUI::~GenericPluginUI ()
118 if (output_controls.size() > 0) {
119 screen_update_connection.disconnect();
124 GenericPluginUI::build ()
132 int output_row, output_col;
133 int button_row, button_col;
134 int output_rows, output_cols;
135 int button_rows, button_cols;
136 guint32 n_ins=0, n_outs = 0;
139 hpacker.set_spacing (10);
141 output_rows = initial_output_rows;
142 output_cols = initial_output_cols;
143 button_rows = initial_button_rows;
144 button_cols = initial_button_cols;
150 button_table.set_homogeneous (false);
151 button_table.set_row_spacings (2);
152 button_table.set_col_spacings (2);
153 output_table.set_homogeneous (true);
154 output_table.set_row_spacings (2);
155 output_table.set_col_spacings (2);
156 button_table.set_border_width (5);
157 output_table.set_border_width (5);
159 hpacker.set_border_width (10);
161 bt_frame = manage (new Frame);
162 bt_frame->set_name ("BaseFrame");
163 bt_frame->add (button_table);
164 hpacker.pack_start(*bt_frame, true, true);
166 box = manage (new VBox);
167 box->set_border_width (5);
168 box->set_spacing (1);
170 frame = manage (new Frame);
171 frame->set_name ("BaseFrame");
172 frame->set_label (_("Controls"));
174 hpacker.pack_start(*frame, true, true);
176 /* find all ports. build control elements for all appropriate control ports */
178 for (i = 0; i < plugin->parameter_count(); ++i) {
180 if (plugin->parameter_is_control (i)) {
182 /* Don't show latency control ports */
184 if (plugin->describe_parameter (i) == X_("latency")) {
190 /* if we are scrollable, just use one long column */
192 if (!is_scrollable) {
194 frame = manage (new Frame);
195 frame->set_name ("BaseFrame");
196 box = manage (new VBox);
198 box->set_border_width (5);
199 box->set_spacing (1);
202 hpacker.pack_start(*frame,true,true);
208 if ((cui = build_control_ui (i, plugin->get_nth_control (i))) == 0) {
209 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
213 if (cui->control || cui->clickbox || cui->combo) {
215 box->pack_start (*cui, false, false);
217 } else if (cui->button) {
219 if (button_row == button_rows) {
221 if (++button_col == button_cols) {
223 button_table.resize (button_rows, button_cols);
227 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
231 } else if (cui->display) {
233 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
236 // TODO: The meters should be divided into multiple rows
238 if (++output_col == output_cols) {
240 output_table.resize (output_rows, output_cols);
243 /* old code, which divides meters into
244 * columns first, rows later. New code divides into one row
246 if (output_row == output_rows) {
248 if (++output_col == output_cols) {
250 output_table.resize (output_rows, output_cols);
254 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
261 /* HACK: ideally the preferred height would be queried from
262 the complete hpacker, but I can't seem to get that
263 information in time, so this is an estimation
271 n_ins = plugin->get_info()->n_inputs;
272 n_outs = plugin->get_info()->n_outputs;
274 if (box->children().empty()) {
275 hpacker.remove (*frame);
278 if (button_table.children().empty()) {
279 hpacker.remove (*bt_frame);
282 if (!output_table.children().empty()) {
283 frame = manage (new Frame);
284 frame->set_name ("BaseFrame");
285 frame->add (output_table);
286 hpacker.pack_end (*frame, true, true);
291 output_table.show_all ();
292 button_table.show_all ();
295 GenericPluginUI::ControlUI::ControlUI ()
296 : automate_button (X_("")) // force creation of a label
298 automate_button.set_name ("PluginAutomateButton");
299 ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("Automation control"));
301 /* XXX translators: use a string here that will be at least as long
302 as the longest automation label (see ::automation_state_changed()
303 below). be sure to include a descender.
306 set_size_request_to_display_given_text (*automate_button.get_child(), _("Mgnual"), 5, 5);
317 GenericPluginUI::ControlUI::~ControlUI()
324 delete meterinfo->meter;
330 GenericPluginUI::automation_state_changed (ControlUI* cui)
332 /* update button label */
334 switch (insert->get_port_automation_state (cui->port_index) & (Off|Play|Touch|Write)) {
336 cui->automate_button.set_label (_("Manual"));
339 cui->automate_button.set_label (_("Play"));
342 cui->automate_button.set_label (_("Write"));
345 cui->automate_button.set_label (_("Touch"));
348 cui->automate_button.set_label (_("???"));
354 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
356 snprintf (buf, 32, "%.0f", adj.get_value());
360 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
362 plugin->print_parameter (param, buf, len);
365 GenericPluginUI::ControlUI*
366 GenericPluginUI::build_control_ui (guint32 port_index, PBD::Controllable* mcontrol)
369 ControlUI* control_ui;
370 Plugin::ParameterDescriptor desc;
372 plugin->get_parameter_descriptor (port_index, desc);
374 control_ui = manage (new ControlUI ());
375 control_ui->adjustment = 0;
376 control_ui->combo = 0;
377 control_ui->combo_map = 0;
378 control_ui->port_index = port_index;
379 control_ui->update_pending = false;
380 control_ui->label.set_text (desc.label);
381 control_ui->label.set_alignment (0.0, 0.5);
382 control_ui->label.set_name ("PluginParameterLabel");
384 control_ui->set_spacing (5);
386 Gtk::Requisition req (control_ui->automate_button.size_request());
388 if (plugin->parameter_is_input (port_index)) {
390 boost::shared_ptr<LadspaPlugin> lp;
392 boost::shared_ptr<LV2Plugin> lv2p;
394 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
396 // all LADPSA plugins have a numeric unique ID
397 uint32_t id = atol (lp->unique_id().c_str());
399 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
401 if (defaults && defaults->count > 0) {
403 control_ui->combo = new Gtk::ComboBoxText;
404 //control_ui->combo->set_value_in_list(true, false);
405 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
406 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
407 plugin->ParameterChanged.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
408 control_ui->pack_start(control_ui->label, true, true);
409 control_ui->pack_start(*control_ui->combo, false, true);
411 update_control_display(control_ui);
413 lrdf_free_setting_values(defaults);
418 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
420 SLV2Port port = lv2p->slv2_port(port_index);
421 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
424 control_ui->combo = new Gtk::ComboBoxText;
425 //control_ui->combo->set_value_in_list(true, false);
426 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
427 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
428 plugin->ParameterChanged.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
429 control_ui->pack_start(control_ui->label, true, true);
430 control_ui->pack_start(*control_ui->combo, false, true);
432 update_control_display(control_ui);
434 slv2_scale_points_free(points);
444 control_ui->button = manage (new ToggleButton ());
445 control_ui->button->set_name ("PluginEditorButton");
446 control_ui->button->set_size_request (20, 20);
448 control_ui->pack_start (control_ui->label, true, true);
449 control_ui->pack_start (*control_ui->button, false, true);
450 control_ui->pack_start (control_ui->automate_button, false, false);
452 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
454 if(plugin->get_parameter (port_index) == 1){
455 control_ui->button->set_active(true);
461 control_ui->adjustment = new Adjustment (0, 0, 0, 0, 0);
463 /* XXX this code is not right yet, because it doesn't handle
464 the absence of bounds in any sensible fashion.
467 control_ui->adjustment->set_lower (desc.lower);
468 control_ui->adjustment->set_upper (desc.upper);
470 control_ui->logarithmic = desc.logarithmic;
471 if (control_ui->logarithmic) {
472 if (control_ui->adjustment->get_lower() == 0.0) {
473 control_ui->adjustment->set_lower (control_ui->adjustment->get_upper()/10000);
475 control_ui->adjustment->set_upper (log(control_ui->adjustment->get_upper()));
476 control_ui->adjustment->set_lower (log(control_ui->adjustment->get_lower()));
479 float delta = desc.upper - desc.lower;
481 control_ui->adjustment->set_page_size (delta/100.0);
482 control_ui->adjustment->set_step_increment (desc.step);
483 control_ui->adjustment->set_page_increment (desc.largestep);
485 if (desc.integer_step) {
486 control_ui->clickbox = new ClickBox (control_ui->adjustment, "PluginUIClickBox");
487 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
488 control_ui->clickbox->set_print_func (integer_printer, 0);
490 sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
492 control_ui->control = new BarController (*control_ui->adjustment, *mcontrol, pslot);
493 control_ui->control->set_size_request (200, req.height);
494 control_ui->control->set_name (X_("PluginSlider"));
495 control_ui->control->set_style (BarController::LeftToRight);
496 control_ui->control->set_use_parent (true);
498 control_ui->control->StartGesture.connect (bind (mem_fun(*this, &GenericPluginUI::start_touch), control_ui));
499 control_ui->control->StopGesture.connect (bind (mem_fun(*this, &GenericPluginUI::stop_touch), control_ui));
503 if (control_ui->logarithmic) {
504 control_ui->adjustment->set_value(log(plugin->get_parameter(port_index)));
506 control_ui->adjustment->set_value(plugin->get_parameter(port_index));
509 /* XXX memory leak: SliderController not destroyed by ControlUI
510 destructor, and manage() reports object hierarchy
514 control_ui->pack_start (control_ui->label, true, true);
515 if (desc.integer_step) {
516 control_ui->pack_start (*control_ui->clickbox, false, false);
518 control_ui->pack_start (*control_ui->control, false, false);
521 control_ui->pack_start (control_ui->automate_button, false, false);
522 control_ui->adjustment->signal_value_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_adjustment_changed), control_ui));
523 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
525 automation_state_changed (control_ui);
527 plugin->ParameterChanged.connect (bind (mem_fun(*this, &GenericPluginUI::parameter_changed), control_ui));
528 insert->automation_list (port_index).automation_state_changed.connect
529 (bind (mem_fun(*this, &GenericPluginUI::automation_state_changed), control_ui));
531 } else if (plugin->parameter_is_output (port_index)) {
533 control_ui->display = manage (new EventBox);
534 control_ui->display->set_name ("ParameterValueDisplay");
536 control_ui->display_label = manage (new Label);
538 control_ui->display_label->set_name ("ParameterValueDisplay");
540 control_ui->display->add (*control_ui->display_label);
541 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
543 control_ui->display->show_all ();
546 /* TODO: only make a meter if the port is Hinted for it */
548 MeterInfo * info = new MeterInfo(port_index);
549 control_ui->meterinfo = info;
551 info->meter = new FastMeter (5, 5, FastMeter::Vertical);
553 info->min_unbound = desc.min_unbound;
554 info->max_unbound = desc.max_unbound;
556 info->min = desc.lower;
557 info->max = desc.upper;
559 control_ui->vbox = manage (new VBox);
560 control_ui->hbox = manage (new HBox);
562 control_ui->label.set_angle(90);
563 control_ui->hbox->pack_start (control_ui->label, false, false);
564 control_ui->hbox->pack_start (*info->meter, false, false);
566 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
568 control_ui->vbox->pack_start (*control_ui->display, false, false);
570 control_ui->pack_start (*control_ui->vbox);
572 control_ui->meterinfo->meter->show_all();
573 control_ui->meterinfo->packed = true;
575 output_controls.push_back (control_ui);
578 plugin->ParameterChanged.connect (bind (mem_fun(*this, &GenericPluginUI::parameter_changed), control_ui));
583 GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui)
585 insert->automation_list (cui->port_index).start_touch ();
589 GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui)
591 insert->automation_list (cui->port_index).stop_touch ();
595 GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
597 using namespace Menu_Helpers;
599 if (automation_menu == 0) {
600 automation_menu = manage (new Menu);
601 automation_menu->set_name ("ArdourContextMenu");
604 MenuList& items (automation_menu->items());
607 items.push_back (MenuElem (_("Manual"),
608 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Off, cui)));
609 items.push_back (MenuElem (_("Play"),
610 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
611 items.push_back (MenuElem (_("Write"),
612 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
613 items.push_back (MenuElem (_("Touch"),
614 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
616 automation_menu->popup (1, gtk_get_current_event_time());
620 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
622 insert->set_port_automation_state (cui->port_index, state);
626 GenericPluginUI::control_adjustment_changed (ControlUI* cui)
628 if (cui->ignore_change) {
632 double value = cui->adjustment->get_value();
634 if (cui->logarithmic) {
638 insert->set_parameter (cui->port_index, (float) value);
642 GenericPluginUI::parameter_changed (uint32_t abs_port_id, float val, ControlUI* cui)
644 if (cui->port_index == abs_port_id) {
645 if (!cui->update_pending) {
646 cui->update_pending = true;
647 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &GenericPluginUI::update_control_display), cui));
653 GenericPluginUI::update_control_display (ControlUI* cui)
655 /* XXX how do we handle logarithmic stuff here ? */
657 cui->update_pending = false;
659 float val = plugin->get_parameter (cui->port_index);
661 cui->ignore_change++;
663 std::map<string,float>::iterator it;
664 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
665 if (it->second == val) {
666 cui->combo->set_active_text(it->first);
670 } else if (cui->adjustment == 0) {
673 cui->button->set_active (true);
675 cui->button->set_active (false);
679 if (cui->logarithmic) {
682 if (val != cui->adjustment->get_value()) {
683 cui->adjustment->set_value (val);
686 cui->ignore_change--;
690 GenericPluginUI::control_port_toggled (ControlUI* cui)
692 if (!cui->ignore_change) {
693 insert->set_parameter (cui->port_index, cui->button->get_active());
698 GenericPluginUI::control_combo_changed (ControlUI* cui)
700 if (!cui->ignore_change) {
701 string value = cui->combo->get_active_text();
702 std::map<string,float> mapping = *cui->combo_map;
703 insert->set_parameter (cui->port_index, mapping[value]);
709 GenericPluginUI::redirect_active_changed (Redirect* r, void* src)
711 ENSURE_GUI_THREAD(bind (mem_fun(*this, &GenericPluginUI::redirect_active_changed), r, src));
713 bypass_button.set_active (!r->active());
717 GenericPluginUI::start_updating (GdkEventAny* ignored)
719 if (output_controls.size() > 0 ) {
720 screen_update_connection.disconnect();
721 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
722 (mem_fun(*this, &GenericPluginUI::output_update));
728 GenericPluginUI::stop_updating (GdkEventAny* ignored)
730 if (output_controls.size() > 0 ) {
731 screen_update_connection.disconnect();
737 GenericPluginUI::output_update ()
739 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
740 float val = plugin->get_parameter ((*i)->port_index);
742 snprintf (buf, sizeof(buf), "%.2f", val);
743 (*i)->display_label->set_text (buf);
745 /* autoscaling for the meter */
746 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
748 if (val < (*i)->meterinfo->min) {
749 if ((*i)->meterinfo->min_unbound)
750 (*i)->meterinfo->min = val;
752 val = (*i)->meterinfo->min;
755 if (val > (*i)->meterinfo->max) {
756 if ((*i)->meterinfo->max_unbound)
757 (*i)->meterinfo->max = val;
759 val = (*i)->meterinfo->max;
762 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
763 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
764 (*i)->meterinfo->meter->set (lval );
771 GenericPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
773 vector<string> enums;
774 boost::shared_ptr<LadspaPlugin> lp;
776 boost::shared_ptr<LV2Plugin> lv2p;
779 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
780 // all LADPSA plugins have a numeric unique ID
781 uint32_t id = atol (lp->unique_id().c_str());
783 cui->combo_map = new std::map<string, float>;
784 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
786 for (uint32_t i = 0; i < defaults->count; ++i) {
787 enums.push_back(defaults->items[i].label);
788 pair<string, float> newpair;
789 newpair.first = defaults->items[i].label;
790 newpair.second = defaults->items[i].value;
791 cui->combo_map->insert(newpair);
794 lrdf_free_setting_values(defaults);
798 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
800 SLV2Port port = lv2p->slv2_port(port_index);
801 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
802 cui->combo_map = new std::map<string, float>;
804 for (unsigned i=0; i < slv2_scale_points_size(points); ++i) {
805 SLV2ScalePoint p = slv2_scale_points_get_at(points, i);
806 SLV2Value label = slv2_scale_point_get_label(p);
807 SLV2Value value = slv2_scale_point_get_value(p);
808 if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
809 enums.push_back(slv2_value_as_string(label));
810 pair<string, float> newpair;
811 newpair.first = slv2_value_as_string(label);
812 newpair.second = slv2_value_as_float(value);
813 cui->combo_map->insert(newpair);
817 slv2_scale_points_free(points);