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>
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, bool scrollable)
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 smaller_hbox->pack_start (*combo_label, false, false, 10);
81 smaller_hbox->pack_start (combo, false, false);
82 smaller_hbox->pack_start (save_button, false, false);
84 constraint_hbox->set_spacing (5);
85 constraint_hbox->pack_start (*smaller_hbox, true, false);
86 constraint_hbox->pack_end (bypass_button, false, false);
88 settings_box.pack_end (*constraint_hbox, false, false);
90 pack_start (settings_box, false, false);
92 if ( is_scrollable ) {
93 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
94 scroller.set_name ("PluginEditor");
95 scroller_view.set_name("PluginEditor");
96 scroller_view.add (hpacker);
97 scroller.add (scroller_view);
99 pack_start (scroller, true, true);
103 pack_start (hpacker, false, false);
106 insert->active_changed.connect (mem_fun(*this, &LadspaPluginUI::redirect_active_changed));
107 bypass_button.set_active (!insert->active());
112 LadspaPluginUI::~LadspaPluginUI ()
114 if (output_controls.size() > 0) {
115 screen_update_connection.disconnect();
120 LadspaPluginUI::build ()
128 int output_row, output_col;
129 int button_row, button_col;
130 int output_rows, output_cols;
131 int button_rows, button_cols;
132 guint32 n_ins=0, n_outs = 0;
135 hpacker.set_spacing (10);
137 output_rows = initial_output_rows;
138 output_cols = initial_output_cols;
139 button_rows = initial_button_rows;
140 button_cols = initial_button_cols;
146 button_table.set_homogeneous (false);
147 button_table.set_row_spacings (2);
148 button_table.set_col_spacings (2);
149 output_table.set_homogeneous (true);
150 output_table.set_row_spacings (2);
151 output_table.set_col_spacings (2);
152 button_table.set_border_width (5);
153 output_table.set_border_width (5);
155 hpacker.set_border_width (10);
157 bt_frame = manage (new Frame);
158 bt_frame->set_name ("BaseFrame");
159 bt_frame->add (button_table);
160 hpacker.pack_start(*bt_frame, true, true);
162 box = manage (new VBox);
163 box->set_border_width (5);
164 box->set_spacing (1);
166 frame = manage (new Frame);
167 frame->set_name ("BaseFrame");
168 frame->set_label (_("Controls"));
170 hpacker.pack_start(*frame, true, true);
172 /* find all ports. build control elements for all appropriate control ports */
174 for (i = 0; i < plugin->parameter_count(); ++i) {
176 if (plugin->parameter_is_control (i)) {
178 /* Don't show latency control ports */
180 if (plugin->describe_parameter (i) == X_("latency")) {
186 /* if we are scrollable, just use one long column */
188 if (!is_scrollable) {
190 frame = manage (new Frame);
191 frame->set_name ("BaseFrame");
192 box = manage (new VBox);
194 box->set_border_width (5);
195 box->set_spacing (1);
198 hpacker.pack_start(*frame,true,true);
204 if ((cui = build_control_ui (i, plugin->get_nth_control (i))) == 0) {
205 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
209 if (cui->control || cui->clickbox || cui->combo) {
211 box->pack_start (*cui, false, false);
213 } else if (cui->button) {
215 if (button_row == button_rows) {
217 if (++button_col == button_cols) {
219 button_table.resize (button_rows, button_cols);
223 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
227 } else if (cui->display) {
229 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
232 // TODO: The meters should be divided into multiple rows
234 if (++output_col == output_cols) {
236 output_table.resize (output_rows, output_cols);
239 /* old code, which divides meters into
240 * columns first, rows later. New code divides into one row
242 if (output_row == output_rows) {
244 if (++output_col == output_cols) {
246 output_table.resize (output_rows, output_cols);
250 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
257 /* HACK: ideally the preferred height would be queried from
258 the complete hpacker, but I can't seem to get that
259 information in time, so this is an estimation
267 n_ins = plugin->get_info()->n_inputs;
268 n_outs = plugin->get_info()->n_outputs;
270 if (box->children().empty()) {
271 hpacker.remove (*frame);
274 if (button_table.children().empty()) {
275 hpacker.remove (*bt_frame);
278 if (!output_table.children().empty()) {
279 frame = manage (new Frame);
280 frame->set_name ("BaseFrame");
281 frame->add (output_table);
282 hpacker.pack_end (*frame, true, true);
287 output_table.show_all ();
288 button_table.show_all ();
291 LadspaPluginUI::ControlUI::ControlUI ()
292 : automate_button (X_("")) // force creation of a label
294 automate_button.set_name ("PluginAutomateButton");
295 ARDOUR_UI::instance()->tooltips().set_tip (automate_button,
296 _("Automation control"));
298 /* don't fix the height, it messes up the bar controllers */
300 set_size_request_to_display_given_text (automate_button, X_("lngnuf"), 2, 2);
311 LadspaPluginUI::ControlUI::~ControlUI()
318 delete meterinfo->meter;
324 LadspaPluginUI::automation_state_changed (ControlUI* cui)
326 /* update button label */
328 switch (insert->get_port_automation_state (cui->port_index) & (Off|Play|Touch|Write)) {
330 cui->automate_button.set_label (_("Off"));
333 cui->automate_button.set_label (_("Play"));
336 cui->automate_button.set_label (_("Write"));
339 cui->automate_button.set_label (_("Touch"));
342 cui->automate_button.set_label (_("???"));
348 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
350 snprintf (buf, 32, "%.0f", adj.get_value());
354 LadspaPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
356 plugin->print_parameter (param, buf, len);
359 LadspaPluginUI::ControlUI*
360 LadspaPluginUI::build_control_ui (guint32 port_index, PBD::Controllable* mcontrol)
363 ControlUI* control_ui;
364 Plugin::ParameterDescriptor desc;
366 plugin->get_parameter_descriptor (port_index, desc);
368 control_ui = manage (new ControlUI ());
369 control_ui->adjustment = 0;
370 control_ui->combo = 0;
371 control_ui->combo_map = 0;
372 control_ui->port_index = port_index;
373 control_ui->update_pending = false;
374 control_ui->label.set_text (desc.label);
375 control_ui->label.set_alignment (0.0, 0.5);
376 control_ui->label.set_name ("PluginParameterLabel");
378 control_ui->set_spacing (5);
380 if (plugin->parameter_is_input (port_index)) {
382 boost::shared_ptr<LadspaPlugin> lp;
384 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
386 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
388 if (defaults && defaults->count > 0) {
390 control_ui->combo = new Gtk::ComboBoxText;
391 //control_ui->combo->set_value_in_list(true, false);
392 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
393 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &LadspaPluginUI::control_combo_changed), control_ui));
394 plugin->ParameterChanged.connect (bind (mem_fun (*this, &LadspaPluginUI::parameter_changed), control_ui));
395 control_ui->pack_start(control_ui->label, true, true);
396 control_ui->pack_start(*control_ui->combo, false, true);
398 update_control_display(control_ui);
400 lrdf_free_setting_values(defaults);
409 control_ui->button = manage (new ToggleButton ());
410 control_ui->button->set_name ("PluginEditorButton");
411 control_ui->button->set_size_request (20, 20);
413 control_ui->pack_start (control_ui->label, true, true);
414 control_ui->pack_start (*control_ui->button, false, true);
415 control_ui->pack_start (control_ui->automate_button, false, false);
417 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::control_port_toggled), control_ui));
419 if(plugin->get_parameter (port_index) == 1){
420 control_ui->button->set_active(true);
426 control_ui->adjustment = new Adjustment (0, 0, 0, 0, 0);
428 /* XXX this code is not right yet, because it doesn't handle
429 the absence of bounds in any sensible fashion.
432 control_ui->adjustment->set_lower (desc.lower);
433 control_ui->adjustment->set_upper (desc.upper);
435 control_ui->logarithmic = desc.logarithmic;
436 if (control_ui->logarithmic) {
437 if (control_ui->adjustment->get_lower() == 0.0) {
438 control_ui->adjustment->set_lower (control_ui->adjustment->get_upper()/10000);
440 control_ui->adjustment->set_upper (log(control_ui->adjustment->get_upper()));
441 control_ui->adjustment->set_lower (log(control_ui->adjustment->get_lower()));
444 float delta = desc.upper - desc.lower;
446 control_ui->adjustment->set_page_size (delta/100.0);
447 control_ui->adjustment->set_step_increment (desc.step);
448 control_ui->adjustment->set_page_increment (desc.largestep);
450 if (desc.integer_step) {
451 control_ui->clickbox = new ClickBox (control_ui->adjustment, "PluginUIClickBox");
452 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
453 control_ui->clickbox->set_print_func (integer_printer, 0);
455 sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &LadspaPluginUI::print_parameter), (uint32_t) port_index);
457 control_ui->control = new BarController (*control_ui->adjustment, *mcontrol, pslot);
458 // should really match the height of the text in the automation button+label
459 control_ui->control->set_size_request (200, 22);
460 control_ui->control->set_name (X_("PluginSlider"));
461 control_ui->control->set_style (BarController::LeftToRight);
462 control_ui->control->set_use_parent (true);
464 control_ui->control->StartGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::start_touch), control_ui));
465 control_ui->control->StopGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::stop_touch), control_ui));
469 if (control_ui->logarithmic) {
470 control_ui->adjustment->set_value(log(plugin->get_parameter(port_index)));
472 control_ui->adjustment->set_value(plugin->get_parameter(port_index));
475 /* XXX memory leak: SliderController not destroyed by ControlUI
476 destructor, and manage() reports object hierarchy
480 control_ui->pack_start (control_ui->label, true, true);
481 if (desc.integer_step) {
482 control_ui->pack_start (*control_ui->clickbox, false, false);
484 control_ui->pack_start (*control_ui->control, false, false);
487 control_ui->pack_start (control_ui->automate_button, false, false);
488 control_ui->adjustment->signal_value_changed().connect (bind (mem_fun(*this, &LadspaPluginUI::control_adjustment_changed), control_ui));
489 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
491 automation_state_changed (control_ui);
493 plugin->ParameterChanged.connect (bind (mem_fun(*this, &LadspaPluginUI::parameter_changed), control_ui));
494 insert->automation_list (port_index).automation_state_changed.connect
495 (bind (mem_fun(*this, &LadspaPluginUI::automation_state_changed), control_ui));
497 } else if (plugin->parameter_is_output (port_index)) {
499 control_ui->display = manage (new EventBox);
500 control_ui->display->set_name ("ParameterValueDisplay");
502 control_ui->display_label = manage (new Label);
504 control_ui->display_label->set_name ("ParameterValueDisplay");
506 control_ui->display->add (*control_ui->display_label);
507 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
509 control_ui->display->show_all ();
512 /* TODO: only make a meter if the port is Hinted for it */
514 MeterInfo * info = new MeterInfo(port_index);
515 control_ui->meterinfo = info;
517 info->meter = new FastMeter (5, 100, FastMeter::Vertical);
519 info->min_unbound = desc.min_unbound;
520 info->max_unbound = desc.max_unbound;
522 info->min = desc.lower;
523 info->max = desc.upper;
525 control_ui->vbox = manage (new VBox);
526 control_ui->hbox = manage (new HBox);
528 control_ui->label.set_angle(90);
529 control_ui->hbox->pack_start (control_ui->label, false, false);
530 control_ui->hbox->pack_start (*info->meter, false, false);
532 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
534 control_ui->vbox->pack_start (*control_ui->display, false, false);
536 control_ui->pack_start (*control_ui->vbox);
538 control_ui->meterinfo->meter->show_all();
539 control_ui->meterinfo->packed = true;
541 output_controls.push_back (control_ui);
544 plugin->ParameterChanged.connect (bind (mem_fun(*this, &LadspaPluginUI::parameter_changed), control_ui));
549 LadspaPluginUI::start_touch (LadspaPluginUI::ControlUI* cui)
551 insert->automation_list (cui->port_index).start_touch ();
555 LadspaPluginUI::stop_touch (LadspaPluginUI::ControlUI* cui)
557 insert->automation_list (cui->port_index).stop_touch ();
561 LadspaPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
563 using namespace Menu_Helpers;
565 if (automation_menu == 0) {
566 automation_menu = manage (new Menu);
567 automation_menu->set_name ("ArdourContextMenu");
570 MenuList& items (automation_menu->items());
573 items.push_back (MenuElem (_("Off"),
574 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Off, cui)));
575 items.push_back (MenuElem (_("Play"),
576 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Play, cui)));
577 items.push_back (MenuElem (_("Write"),
578 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Write, cui)));
579 items.push_back (MenuElem (_("Touch"),
580 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Touch, cui)));
582 automation_menu->popup (1, gtk_get_current_event_time());
586 LadspaPluginUI::set_automation_state (AutoState state, ControlUI* cui)
588 insert->set_port_automation_state (cui->port_index, state);
592 LadspaPluginUI::control_adjustment_changed (ControlUI* cui)
594 if (cui->ignore_change) {
598 double value = cui->adjustment->get_value();
600 if (cui->logarithmic) {
604 insert->set_parameter (cui->port_index, (float) value);
608 LadspaPluginUI::parameter_changed (uint32_t abs_port_id, float val, ControlUI* cui)
610 if (cui->port_index == abs_port_id) {
611 if (!cui->update_pending) {
612 cui->update_pending = true;
613 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &LadspaPluginUI::update_control_display), cui));
619 LadspaPluginUI::update_control_display (ControlUI* cui)
621 /* XXX how do we handle logarithmic stuff here ? */
623 cui->update_pending = false;
625 float val = plugin->get_parameter (cui->port_index);
627 cui->ignore_change++;
629 std::map<string,float>::iterator it;
630 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
631 if (it->second == val) {
632 cui->combo->set_active_text(it->first);
636 } else if (cui->adjustment == 0) {
639 cui->button->set_active (true);
641 cui->button->set_active (false);
645 if (cui->logarithmic) {
648 if (val != cui->adjustment->get_value()) {
649 cui->adjustment->set_value (val);
652 cui->ignore_change--;
656 LadspaPluginUI::control_port_toggled (ControlUI* cui)
658 if (!cui->ignore_change) {
659 insert->set_parameter (cui->port_index, cui->button->get_active());
664 LadspaPluginUI::control_combo_changed (ControlUI* cui)
666 if (!cui->ignore_change) {
667 string value = cui->combo->get_active_text();
668 std::map<string,float> mapping = *cui->combo_map;
669 insert->set_parameter (cui->port_index, mapping[value]);
675 LadspaPluginUI::redirect_active_changed (Redirect* r, void* src)
677 ENSURE_GUI_THREAD(bind (mem_fun(*this, &LadspaPluginUI::redirect_active_changed), r, src));
679 bypass_button.set_active (!r->active());
683 LadspaPluginUI::start_updating (GdkEventAny* ignored)
685 if (output_controls.size() > 0 ) {
686 screen_update_connection.disconnect();
687 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
688 (mem_fun(*this, &LadspaPluginUI::output_update));
694 LadspaPluginUI::stop_updating (GdkEventAny* ignored)
696 if (output_controls.size() > 0 ) {
697 screen_update_connection.disconnect();
703 LadspaPluginUI::output_update ()
705 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
706 float val = plugin->get_parameter ((*i)->port_index);
708 snprintf (buf, sizeof(buf), "%.2f", val);
709 (*i)->display_label->set_text (buf);
711 /* autoscaling for the meter */
712 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
714 if (val < (*i)->meterinfo->min) {
715 if ((*i)->meterinfo->min_unbound)
716 (*i)->meterinfo->min = val;
718 val = (*i)->meterinfo->min;
721 if (val > (*i)->meterinfo->max) {
722 if ((*i)->meterinfo->max_unbound)
723 (*i)->meterinfo->max = val;
725 val = (*i)->meterinfo->max;
728 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
729 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
730 (*i)->meterinfo->meter->set (lval );
737 LadspaPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
739 vector<string> enums;
740 boost::shared_ptr<LadspaPlugin> lp = boost::dynamic_pointer_cast<LadspaPlugin> (plugin);
742 cui->combo_map = new std::map<string, float>;
743 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
745 for (uint32_t i = 0; i < defaults->count; ++i) {
746 enums.push_back(defaults->items[i].label);
747 pair<string, float> newpair;
748 newpair.first = defaults->items[i].label;
749 newpair.second = defaults->items[i].value;
750 cui->combo_map->insert(newpair);
753 lrdf_free_setting_values(defaults);