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/plugin_insert.h>
40 #include <ardour/ladspa_plugin.h>
44 #include "ardour_ui.h"
46 #include "plugin_ui.h"
48 #include "gui_thread.h"
53 using namespace ARDOUR;
55 using namespace Gtkmm2ext;
59 LadspaPluginUI::LadspaPluginUI (boost::shared_ptr<PluginInsert> pi, nframes64_t sample_rate, nframes64_t period_size, bool scrollable)
60 : PlugUIBase (pi, sample_rate, period_size),
61 button_table (initial_button_rows, initial_button_cols),
62 output_table (initial_output_rows, initial_output_cols),
63 hAdjustment(0.0, 0.0, 0.0),
64 vAdjustment(0.0, 0.0, 0.0),
65 scroller_view(hAdjustment, vAdjustment),
67 is_scrollable(scrollable)
69 set_name ("PluginEditor");
70 set_border_width (10);
71 set_homogeneous (false);
73 settings_box.set_homogeneous (false);
75 HBox* constraint_hbox = manage (new HBox);
76 HBox* smaller_hbox = manage (new HBox);
77 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
78 combo_label->set_use_markup (true);
80 Label* latency_label = manage (new Label (_("<span size=\"large\">Latency</span>")));
81 latency_label->set_use_markup (true);
83 smaller_hbox->pack_start (*latency_label, false, false, 10);
84 smaller_hbox->pack_start (latency_gui, false, false, 10);
85 smaller_hbox->pack_start (combo, false, false);
86 smaller_hbox->pack_start (save_button, false, false);
88 constraint_hbox->set_spacing (5);
89 constraint_hbox->pack_start (*smaller_hbox, true, 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 pi->ActiveChanged.connect (bind(mem_fun(*this, &LadspaPluginUI::processor_active_changed),
111 boost::weak_ptr<Processor>(pi)));
112 bypass_button.set_active (!pi->active());
117 LadspaPluginUI::~LadspaPluginUI ()
119 if (output_controls.size() > 0) {
120 screen_update_connection.disconnect();
125 LadspaPluginUI::build ()
133 int output_row, output_col;
134 int button_row, button_col;
135 int output_rows, output_cols;
136 int button_rows, button_cols;
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 (ParamID(PluginAutomation, 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 if (box->children().empty()) {
272 hpacker.remove (*frame);
275 if (button_table.children().empty()) {
276 hpacker.remove (*bt_frame);
279 if (!output_table.children().empty()) {
280 frame = manage (new Frame);
281 frame->set_name ("BaseFrame");
282 frame->add (output_table);
283 hpacker.pack_end (*frame, true, true);
288 output_table.show_all ();
289 button_table.show_all ();
292 LadspaPluginUI::ControlUI::ControlUI ()
293 : automate_button (X_("")) // force creation of a label
295 automate_button.set_name ("PluginAutomateButton");
296 ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("Automation control"));
298 /* XXX translators: use a string here that will be at least as long
299 as the longest automation label (see ::automation_state_changed()
300 below). be sure to include a descender.
303 set_size_request_to_display_given_text (*automate_button.get_child(), _("Mgnual"), 5, 5);
314 LadspaPluginUI::ControlUI::~ControlUI()
321 delete meterinfo->meter;
327 LadspaPluginUI::automation_state_changed (ControlUI* cui)
329 /* update button label */
331 switch (insert->get_parameter_automation_state (ParamID(PluginAutomation, cui->port_index))
332 & (Off|Play|Touch|Write)) {
334 cui->automate_button.set_label (_("Manual"));
337 cui->automate_button.set_label (_("Play"));
340 cui->automate_button.set_label (_("Write"));
343 cui->automate_button.set_label (_("Touch"));
346 cui->automate_button.set_label (_("???"));
352 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
354 snprintf (buf, 32, "%.0f", adj.get_value());
358 LadspaPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
360 plugin->print_parameter (param, buf, len);
363 LadspaPluginUI::ControlUI*
364 LadspaPluginUI::build_control_ui (guint32 port_index, PBD::Controllable* mcontrol)
367 ControlUI* control_ui;
368 Plugin::ParameterDescriptor desc;
370 plugin->get_parameter_descriptor (port_index, desc);
372 control_ui = manage (new ControlUI ());
373 control_ui->adjustment = 0;
374 control_ui->combo = 0;
375 control_ui->combo_map = 0;
376 control_ui->port_index = port_index;
377 control_ui->update_pending = false;
378 control_ui->label.set_text (desc.label);
379 control_ui->label.set_alignment (0.0, 0.5);
380 control_ui->label.set_name ("PluginParameterLabel");
382 control_ui->set_spacing (5);
384 Gtk::Requisition req (control_ui->automate_button.size_request());
386 if (plugin->parameter_is_input (port_index)) {
388 boost::shared_ptr<LadspaPlugin> lp;
390 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
392 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
394 if (defaults && defaults->count > 0) {
396 control_ui->combo = new Gtk::ComboBoxText;
397 //control_ui->combo->set_value_in_list(true, false);
398 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
399 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &LadspaPluginUI::control_combo_changed), control_ui));
400 plugin->ParameterChanged.connect (bind (mem_fun (*this, &LadspaPluginUI::parameter_changed), control_ui));
401 control_ui->pack_start(control_ui->label, true, true);
402 control_ui->pack_start(*control_ui->combo, false, true);
404 update_control_display(control_ui);
406 lrdf_free_setting_values(defaults);
415 control_ui->button = manage (new ToggleButton ());
416 control_ui->button->set_name ("PluginEditorButton");
417 control_ui->button->set_size_request (20, 20);
419 control_ui->pack_start (control_ui->label, true, true);
420 control_ui->pack_start (*control_ui->button, false, true);
421 control_ui->pack_start (control_ui->automate_button, false, false);
423 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::control_port_toggled), control_ui));
425 if(plugin->get_parameter (port_index) == 1){
426 control_ui->button->set_active(true);
432 control_ui->adjustment = new Adjustment (0, 0, 0, 0, 0);
434 /* XXX this code is not right yet, because it doesn't handle
435 the absence of bounds in any sensible fashion.
438 control_ui->adjustment->set_lower (desc.lower);
439 control_ui->adjustment->set_upper (desc.upper);
441 control_ui->logarithmic = desc.logarithmic;
442 if (control_ui->logarithmic) {
443 if (control_ui->adjustment->get_lower() == 0.0) {
444 control_ui->adjustment->set_lower (control_ui->adjustment->get_upper()/10000);
446 control_ui->adjustment->set_upper (log(control_ui->adjustment->get_upper()));
447 control_ui->adjustment->set_lower (log(control_ui->adjustment->get_lower()));
450 float delta = desc.upper - desc.lower;
452 control_ui->adjustment->set_page_size (delta/100.0);
453 control_ui->adjustment->set_step_increment (desc.step);
454 control_ui->adjustment->set_page_increment (desc.largestep);
456 if (desc.integer_step) {
457 control_ui->clickbox = new ClickBox (control_ui->adjustment, "PluginUIClickBox");
458 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
459 control_ui->clickbox->set_print_func (integer_printer, 0);
461 sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &LadspaPluginUI::print_parameter), (uint32_t) port_index);
463 control_ui->control = new BarController (*control_ui->adjustment, *mcontrol, pslot);
464 control_ui->control->set_size_request (200, req.height);
465 control_ui->control->set_name (X_("PluginSlider"));
466 control_ui->control->set_style (BarController::LeftToRight);
467 control_ui->control->set_use_parent (true);
469 control_ui->control->StartGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::start_touch), control_ui));
470 control_ui->control->StopGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::stop_touch), control_ui));
474 if (control_ui->logarithmic) {
475 control_ui->adjustment->set_value(log(plugin->get_parameter(port_index)));
477 control_ui->adjustment->set_value(plugin->get_parameter(port_index));
480 /* XXX memory leak: SliderController not destroyed by ControlUI
481 destructor, and manage() reports object hierarchy
485 control_ui->pack_start (control_ui->label, true, true);
486 if (desc.integer_step) {
487 control_ui->pack_start (*control_ui->clickbox, false, false);
489 control_ui->pack_start (*control_ui->control, false, false);
492 control_ui->pack_start (control_ui->automate_button, false, false);
493 control_ui->adjustment->signal_value_changed().connect (bind (mem_fun(*this, &LadspaPluginUI::control_adjustment_changed), control_ui));
494 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
496 automation_state_changed (control_ui);
498 plugin->ParameterChanged.connect (bind (mem_fun(*this, &LadspaPluginUI::parameter_changed), control_ui));
499 insert->automation_list (ParamID(PluginAutomation, port_index))->automation_state_changed.connect
500 (bind (mem_fun(*this, &LadspaPluginUI::automation_state_changed), control_ui));
502 } else if (plugin->parameter_is_output (port_index)) {
504 control_ui->display = manage (new EventBox);
505 control_ui->display->set_name ("ParameterValueDisplay");
507 control_ui->display_label = manage (new Label);
509 control_ui->display_label->set_name ("ParameterValueDisplay");
511 control_ui->display->add (*control_ui->display_label);
512 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
514 control_ui->display->show_all ();
517 /* TODO: only make a meter if the port is Hinted for it */
519 MeterInfo * info = new MeterInfo(port_index);
520 control_ui->meterinfo = info;
522 info->meter = new FastMeter (5, 100, FastMeter::Vertical);
524 info->min_unbound = desc.min_unbound;
525 info->max_unbound = desc.max_unbound;
527 info->min = desc.lower;
528 info->max = desc.upper;
530 control_ui->vbox = manage (new VBox);
531 control_ui->hbox = manage (new HBox);
533 control_ui->label.set_angle(90);
534 control_ui->hbox->pack_start (control_ui->label, false, false);
535 control_ui->hbox->pack_start (*info->meter, false, false);
537 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
539 control_ui->vbox->pack_start (*control_ui->display, false, false);
541 control_ui->pack_start (*control_ui->vbox);
543 control_ui->meterinfo->meter->show_all();
544 control_ui->meterinfo->packed = true;
546 output_controls.push_back (control_ui);
549 plugin->ParameterChanged.connect (bind (mem_fun(*this, &LadspaPluginUI::parameter_changed), control_ui));
554 LadspaPluginUI::start_touch (LadspaPluginUI::ControlUI* cui)
556 insert->automation_list (ParamID(PluginAutomation, cui->port_index))->start_touch ();
560 LadspaPluginUI::stop_touch (LadspaPluginUI::ControlUI* cui)
562 insert->automation_list (ParamID(PluginAutomation, cui->port_index))->stop_touch ();
566 LadspaPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
568 using namespace Menu_Helpers;
570 if (automation_menu == 0) {
571 automation_menu = manage (new Menu);
572 automation_menu->set_name ("ArdourContextMenu");
575 MenuList& items (automation_menu->items());
578 items.push_back (MenuElem (_("Manual"),
579 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Off, cui)));
580 items.push_back (MenuElem (_("Play"),
581 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Play, cui)));
582 items.push_back (MenuElem (_("Write"),
583 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Write, cui)));
584 items.push_back (MenuElem (_("Touch"),
585 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Touch, cui)));
587 automation_menu->popup (1, gtk_get_current_event_time());
591 LadspaPluginUI::set_automation_state (AutoState state, ControlUI* cui)
593 insert->set_parameter_automation_state (ParamID(PluginAutomation, cui->port_index), state);
597 LadspaPluginUI::control_adjustment_changed (ControlUI* cui)
599 if (cui->ignore_change) {
603 double value = cui->adjustment->get_value();
605 if (cui->logarithmic) {
609 insert->set_parameter (ParamID(PluginAutomation, cui->port_index), (float) value);
613 LadspaPluginUI::parameter_changed (uint32_t abs_port_id, float val, ControlUI* cui)
615 if (cui->port_index == abs_port_id) {
616 if (!cui->update_pending) {
617 cui->update_pending = true;
618 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &LadspaPluginUI::update_control_display), cui));
624 LadspaPluginUI::update_control_display (ControlUI* cui)
626 /* XXX how do we handle logarithmic stuff here ? */
628 cui->update_pending = false;
630 float val = plugin->get_parameter (cui->port_index);
632 cui->ignore_change++;
634 std::map<string,float>::iterator it;
635 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
636 if (it->second == val) {
637 cui->combo->set_active_text(it->first);
641 } else if (cui->adjustment == 0) {
644 cui->button->set_active (true);
646 cui->button->set_active (false);
650 if (cui->logarithmic) {
653 if (val != cui->adjustment->get_value()) {
654 cui->adjustment->set_value (val);
657 cui->ignore_change--;
661 LadspaPluginUI::control_port_toggled (ControlUI* cui)
663 if (!cui->ignore_change) {
664 insert->set_parameter (ParamID(PluginAutomation, cui->port_index), cui->button->get_active());
669 LadspaPluginUI::control_combo_changed (ControlUI* cui)
671 if (!cui->ignore_change) {
672 string value = cui->combo->get_active_text();
673 std::map<string,float> mapping = *cui->combo_map;
674 insert->set_parameter (ParamID(PluginAutomation, cui->port_index), mapping[value]);
680 LadspaPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
682 ENSURE_GUI_THREAD(bind (mem_fun(*this, &LadspaPluginUI::processor_active_changed), weak_processor));
684 boost::shared_ptr<Processor> processor = weak_processor.lock();
686 bypass_button.set_active (!processor || !processor->active());
690 LadspaPluginUI::start_updating (GdkEventAny* ignored)
692 if (output_controls.size() > 0 ) {
693 screen_update_connection.disconnect();
694 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
695 (mem_fun(*this, &LadspaPluginUI::output_update));
701 LadspaPluginUI::stop_updating (GdkEventAny* ignored)
703 if (output_controls.size() > 0 ) {
704 screen_update_connection.disconnect();
710 LadspaPluginUI::output_update ()
712 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
713 float val = plugin->get_parameter ((*i)->port_index);
715 snprintf (buf, sizeof(buf), "%.2f", val);
716 (*i)->display_label->set_text (buf);
718 /* autoscaling for the meter */
719 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
721 if (val < (*i)->meterinfo->min) {
722 if ((*i)->meterinfo->min_unbound)
723 (*i)->meterinfo->min = val;
725 val = (*i)->meterinfo->min;
728 if (val > (*i)->meterinfo->max) {
729 if ((*i)->meterinfo->max_unbound)
730 (*i)->meterinfo->max = val;
732 val = (*i)->meterinfo->max;
735 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
736 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
737 (*i)->meterinfo->meter->set (lval );
744 LadspaPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
746 vector<string> enums;
747 boost::shared_ptr<LadspaPlugin> lp = boost::dynamic_pointer_cast<LadspaPlugin> (plugin);
749 cui->combo_map = new std::map<string, float>;
750 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
752 for (uint32_t i = 0; i < defaults->count; ++i) {
753 enums.push_back(defaults->items[i].label);
754 pair<string, float> newpair;
755 newpair.first = defaults->items[i].label;
756 newpair.second = defaults->items[i].value;
757 cui->combo_map->insert(newpair);
760 lrdf_free_setting_values(defaults);