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"
49 #include "automation_controller.h"
54 using namespace ARDOUR;
56 using namespace Gtkmm2ext;
60 LadspaPluginUI::LadspaPluginUI (boost::shared_ptr<PluginInsert> pi, nframes64_t sample_rate, nframes64_t period_size, bool scrollable)
61 : PlugUIBase (pi, sample_rate, period_size),
62 button_table (initial_button_rows, initial_button_cols),
63 output_table (initial_output_rows, initial_output_cols),
64 hAdjustment(0.0, 0.0, 0.0),
65 vAdjustment(0.0, 0.0, 0.0),
66 scroller_view(hAdjustment, vAdjustment),
68 is_scrollable(scrollable)
70 set_name ("PluginEditor");
71 set_border_width (10);
72 set_homogeneous (false);
74 settings_box.set_homogeneous (false);
76 HBox* constraint_hbox = manage (new HBox);
77 HBox* smaller_hbox = manage (new HBox);
78 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
79 combo_label->set_use_markup (true);
81 Label* latency_label = manage (new Label (_("<span size=\"large\">Latency</span>")));
82 latency_label->set_use_markup (true);
84 smaller_hbox->pack_start (*latency_label, false, false, 10);
85 smaller_hbox->pack_start (latency_gui, false, false, 10);
86 smaller_hbox->pack_start (combo, false, false);
87 smaller_hbox->pack_start (save_button, false, false);
89 constraint_hbox->set_spacing (5);
90 constraint_hbox->pack_start (*smaller_hbox, true, false);
91 constraint_hbox->pack_end (bypass_button, false, false);
93 settings_box.pack_end (*constraint_hbox, false, false);
95 pack_start (settings_box, false, false);
97 if ( is_scrollable ) {
98 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
99 scroller.set_name ("PluginEditor");
100 scroller_view.set_name("PluginEditor");
101 scroller_view.add (hpacker);
102 scroller.add (scroller_view);
104 pack_start (scroller, true, true);
108 pack_start (hpacker, false, false);
111 pi->ActiveChanged.connect (bind(mem_fun(*this, &LadspaPluginUI::processor_active_changed),
112 boost::weak_ptr<Processor>(pi)));
113 bypass_button.set_active (!pi->active());
118 LadspaPluginUI::~LadspaPluginUI ()
120 if (output_controls.size() > 0) {
121 screen_update_connection.disconnect();
126 LadspaPluginUI::build ()
134 int output_row, output_col;
135 int button_row, button_col;
136 int output_rows, output_cols;
137 int button_rows, button_cols;
140 hpacker.set_spacing (10);
142 output_rows = initial_output_rows;
143 output_cols = initial_output_cols;
144 button_rows = initial_button_rows;
145 button_cols = initial_button_cols;
151 button_table.set_homogeneous (false);
152 button_table.set_row_spacings (2);
153 button_table.set_col_spacings (2);
154 output_table.set_homogeneous (true);
155 output_table.set_row_spacings (2);
156 output_table.set_col_spacings (2);
157 button_table.set_border_width (5);
158 output_table.set_border_width (5);
160 hpacker.set_border_width (10);
162 bt_frame = manage (new Frame);
163 bt_frame->set_name ("BaseFrame");
164 bt_frame->add (button_table);
165 hpacker.pack_start(*bt_frame, true, true);
167 box = manage (new VBox);
168 box->set_border_width (5);
169 box->set_spacing (1);
171 frame = manage (new Frame);
172 frame->set_name ("BaseFrame");
173 frame->set_label (_("Controls"));
175 hpacker.pack_start(*frame, true, true);
177 /* find all ports. build control elements for all appropriate control ports */
179 for (i = 0; i < plugin->parameter_count(); ++i) {
181 if (plugin->parameter_is_control (i)) {
183 /* Don't show latency control ports */
185 if (plugin->describe_parameter (Parameter(PluginAutomation, i)) == X_("latency")) {
191 /* if we are scrollable, just use one long column */
193 if (!is_scrollable) {
195 frame = manage (new Frame);
196 frame->set_name ("BaseFrame");
197 box = manage (new VBox);
199 box->set_border_width (5);
200 box->set_spacing (1);
203 hpacker.pack_start(*frame,true,true);
209 if ((cui = build_control_ui (i, insert->control(Parameter(PluginAutomation, i)))) == 0) {
210 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
214 if (cui->control || cui->clickbox || cui->combo) {
216 box->pack_start (*cui, false, false);
218 } else if (cui->button) {
220 if (button_row == button_rows) {
222 if (++button_col == button_cols) {
224 button_table.resize (button_rows, button_cols);
228 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
232 } else if (cui->display) {
234 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
237 // TODO: The meters should be divided into multiple rows
239 if (++output_col == output_cols) {
241 output_table.resize (output_rows, output_cols);
244 /* old code, which divides meters into
245 * columns first, rows later. New code divides into one row
247 if (output_row == output_rows) {
249 if (++output_col == output_cols) {
251 output_table.resize (output_rows, output_cols);
255 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
262 /* HACK: ideally the preferred height would be queried from
263 the complete hpacker, but I can't seem to get that
264 information in time, so this is an estimation
272 if (box->children().empty()) {
273 hpacker.remove (*frame);
276 if (button_table.children().empty()) {
277 hpacker.remove (*bt_frame);
280 if (!output_table.children().empty()) {
281 frame = manage (new Frame);
282 frame->set_name ("BaseFrame");
283 frame->add (output_table);
284 hpacker.pack_end (*frame, true, true);
289 output_table.show_all ();
290 button_table.show_all ();
293 LadspaPluginUI::ControlUI::ControlUI ()
294 : automate_button (X_("")) // force creation of a label
296 automate_button.set_name ("PluginAutomateButton");
297 ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("Automation control"));
299 /* XXX translators: use a string here that will be at least as long
300 as the longest automation label (see ::automation_state_changed()
301 below). be sure to include a descender.
304 set_size_request_to_display_given_text (*automate_button.get_child(), _("Mgnual"), 5, 5);
313 LadspaPluginUI::ControlUI::~ControlUI()
316 delete meterinfo->meter;
322 LadspaPluginUI::automation_state_changed (ControlUI* cui)
324 /* update button label */
326 // don't lock to avoid deadlock because we're triggered by
327 // AutomationControl::Changed() while the automation lock is taken
328 switch (insert->get_parameter_automation_state (cui->parameter(), false)
329 & (Off|Play|Touch|Write)) {
331 cui->automate_button.set_label (_("Manual"));
334 cui->automate_button.set_label (_("Play"));
337 cui->automate_button.set_label (_("Write"));
340 cui->automate_button.set_label (_("Touch"));
343 cui->automate_button.set_label (_("???"));
349 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
351 snprintf (buf, 32, "%.0f", adj.get_value());
355 LadspaPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
357 plugin->print_parameter (param, buf, len);
360 LadspaPluginUI::ControlUI*
361 LadspaPluginUI::build_control_ui (guint32 port_index, boost::shared_ptr<AutomationControl> 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->combo = 0;
370 control_ui->combo_map = 0;
371 control_ui->control = mcontrol;
372 control_ui->update_pending = false;
373 control_ui->label.set_text (desc.label);
374 control_ui->label.set_alignment (0.0, 0.5);
375 control_ui->label.set_name ("PluginParameterLabel");
377 control_ui->set_spacing (5);
379 Gtk::Requisition req (control_ui->automate_button.size_request());
381 if (plugin->parameter_is_input (port_index)) {
383 boost::shared_ptr<LadspaPlugin> lp;
385 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
387 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
389 if (defaults && defaults->count > 0) {
391 control_ui->combo = new Gtk::ComboBoxText;
392 //control_ui->combo->set_value_in_list(true, false);
393 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
394 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &LadspaPluginUI::control_combo_changed), control_ui));
395 mcontrol->Changed.connect (bind (mem_fun (*this, &LadspaPluginUI::parameter_changed), control_ui));
396 control_ui->pack_start(control_ui->label, true, true);
397 control_ui->pack_start(*control_ui->combo, false, true);
399 update_control_display(control_ui);
401 lrdf_free_setting_values(defaults);
410 control_ui->button = manage (new ToggleButton ());
411 control_ui->button->set_name ("PluginEditorButton");
412 control_ui->button->set_size_request (20, 20);
414 control_ui->pack_start (control_ui->label, true, true);
415 control_ui->pack_start (*control_ui->button, false, true);
416 control_ui->pack_start (control_ui->automate_button, false, false);
418 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::control_port_toggled), control_ui));
420 if(plugin->get_parameter (port_index) == 1){
421 control_ui->button->set_active(true);
427 /* create the controller */
429 control_ui->controller = AutomationController::create(insert, mcontrol->list(), mcontrol);
431 /* XXX this code is not right yet, because it doesn't handle
432 the absence of bounds in any sensible fashion.
436 control_ui->controller->adjustment()->set_lower (desc.lower);
437 control_ui->controller->adjustment()->set_upper (desc.upper);
439 control_ui->logarithmic = desc.logarithmic;
440 if (control_ui->logarithmic) {
441 if (control_ui->controller->adjustment()->get_lower() == 0.0) {
442 control_ui->controller->adjustment()->set_lower (control_ui->controller->adjustment()->get_upper()/10000);
444 control_ui->controller->adjustment()->set_upper (log(control_ui->controller->adjustment()->get_upper()));
445 control_ui->controller->adjustment()->set_lower (log(control_ui->controller->adjustment()->get_lower()));
449 float delta = desc.upper - desc.lower;
451 control_ui->controller->adjustment()->set_page_size (delta/100.0);
452 control_ui->controller->adjustment()->set_step_increment (desc.step);
453 control_ui->controller->adjustment()->set_page_increment (desc.largestep);
456 if (desc.integer_step) {
457 control_ui->clickbox = new ClickBox (control_ui->controller->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->controller->set_size_request (200, req.height);
464 control_ui->controller->set_name (X_("PluginSlider"));
465 control_ui->controller->set_style (BarController::LeftToRight);
466 control_ui->controller->set_use_parent (true);
468 control_ui->controller->StartGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::start_touch), control_ui));
469 control_ui->controller->StopGesture.connect (bind (mem_fun(*this, &LadspaPluginUI::stop_touch), control_ui));
473 if (control_ui->logarithmic) {
474 control_ui->controller->adjustment()->set_value(log(plugin->get_parameter(port_index)));
476 control_ui->controller->adjustment()->set_value(plugin->get_parameter(port_index));
479 /* XXX memory leak: SliderController not destroyed by ControlUI
480 destructor, and manage() reports object hierarchy
484 control_ui->pack_start (control_ui->label, true, true);
485 if (desc.integer_step) {
486 control_ui->pack_start (*control_ui->clickbox, false, false);
488 control_ui->pack_start (*control_ui->controller, false, false);
491 control_ui->pack_start (control_ui->automate_button, false, false);
492 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &LadspaPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
494 automation_state_changed (control_ui);
496 mcontrol->Changed.connect (bind (mem_fun (*this, &LadspaPluginUI::parameter_changed), control_ui));
497 mcontrol->list()->automation_state_changed.connect
498 (bind (mem_fun(*this, &LadspaPluginUI::automation_state_changed), control_ui));
500 } else if (plugin->parameter_is_output (port_index)) {
502 control_ui->display = manage (new EventBox);
503 control_ui->display->set_name ("ParameterValueDisplay");
505 control_ui->display_label = manage (new Label);
507 control_ui->display_label->set_name ("ParameterValueDisplay");
509 control_ui->display->add (*control_ui->display_label);
510 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
512 control_ui->display->show_all ();
515 /* TODO: only make a meter if the port is Hinted for it */
517 MeterInfo * info = new MeterInfo(port_index);
518 control_ui->meterinfo = info;
520 info->meter = new FastMeter (5, 100, FastMeter::Vertical);
522 info->min_unbound = desc.min_unbound;
523 info->max_unbound = desc.max_unbound;
525 info->min = desc.lower;
526 info->max = desc.upper;
528 control_ui->vbox = manage (new VBox);
529 control_ui->hbox = manage (new HBox);
531 control_ui->label.set_angle(90);
532 control_ui->hbox->pack_start (control_ui->label, false, false);
533 control_ui->hbox->pack_start (*info->meter, false, false);
535 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
537 control_ui->vbox->pack_start (*control_ui->display, false, false);
539 control_ui->pack_start (*control_ui->vbox);
541 control_ui->meterinfo->meter->show_all();
542 control_ui->meterinfo->packed = true;
544 output_controls.push_back (control_ui);
547 mcontrol->Changed.connect (bind (mem_fun (*this, &LadspaPluginUI::parameter_changed), control_ui));
553 LadspaPluginUI::start_touch (LadspaPluginUI::ControlUI* cui)
555 cui->control->list()->start_touch ();
559 LadspaPluginUI::stop_touch (LadspaPluginUI::ControlUI* cui)
561 cui->control->list()->stop_touch ();
565 LadspaPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
567 using namespace Menu_Helpers;
569 if (automation_menu == 0) {
570 automation_menu = manage (new Menu);
571 automation_menu->set_name ("ArdourContextMenu");
574 MenuList& items (automation_menu->items());
577 items.push_back (MenuElem (_("Manual"),
578 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Off, cui)));
579 items.push_back (MenuElem (_("Play"),
580 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Play, cui)));
581 items.push_back (MenuElem (_("Write"),
582 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Write, cui)));
583 items.push_back (MenuElem (_("Touch"),
584 bind (mem_fun(*this, &LadspaPluginUI::set_automation_state), (AutoState) Touch, cui)));
586 automation_menu->popup (1, gtk_get_current_event_time());
590 LadspaPluginUI::set_automation_state (AutoState state, ControlUI* cui)
592 insert->set_parameter_automation_state (cui->parameter(), state);
596 LadspaPluginUI::parameter_changed (ControlUI* cui)
598 if (!cui->update_pending) {
599 cui->update_pending = true;
600 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &LadspaPluginUI::update_control_display), cui));
605 LadspaPluginUI::update_control_display (ControlUI* cui)
607 /* XXX how do we handle logarithmic stuff here ? */
609 cui->update_pending = false;
611 float val = cui->control->get_value();
613 cui->ignore_change++;
615 std::map<string,float>::iterator it;
616 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
617 if (it->second == val) {
618 cui->combo->set_active_text(it->first);
622 } else if (cui->button) {
625 cui->button->set_active (true);
627 cui->button->set_active (false);
631 cui->controller->display_effective_value();
635 if (cui->logarithmic) {
638 if (val != cui->adjustment->get_value()) {
639 cui->adjustment->set_value (val);
642 cui->ignore_change--;
646 LadspaPluginUI::control_port_toggled (ControlUI* cui)
648 if (!cui->ignore_change) {
649 insert->set_parameter (cui->parameter(), cui->button->get_active());
654 LadspaPluginUI::control_combo_changed (ControlUI* cui)
656 if (!cui->ignore_change) {
657 string value = cui->combo->get_active_text();
658 std::map<string,float> mapping = *cui->combo_map;
659 insert->set_parameter (cui->parameter(), mapping[value]);
665 LadspaPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
667 ENSURE_GUI_THREAD(bind (mem_fun(*this, &LadspaPluginUI::processor_active_changed), weak_processor));
669 boost::shared_ptr<Processor> processor = weak_processor.lock();
671 bypass_button.set_active (!processor || !processor->active());
675 LadspaPluginUI::start_updating (GdkEventAny* ignored)
677 if (output_controls.size() > 0 ) {
678 screen_update_connection.disconnect();
679 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
680 (mem_fun(*this, &LadspaPluginUI::output_update));
686 LadspaPluginUI::stop_updating (GdkEventAny* ignored)
688 if (output_controls.size() > 0 ) {
689 screen_update_connection.disconnect();
695 LadspaPluginUI::output_update ()
697 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
698 float val = plugin->get_parameter ((*i)->parameter().id());
700 snprintf (buf, sizeof(buf), "%.2f", val);
701 (*i)->display_label->set_text (buf);
703 /* autoscaling for the meter */
704 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
706 if (val < (*i)->meterinfo->min) {
707 if ((*i)->meterinfo->min_unbound)
708 (*i)->meterinfo->min = val;
710 val = (*i)->meterinfo->min;
713 if (val > (*i)->meterinfo->max) {
714 if ((*i)->meterinfo->max_unbound)
715 (*i)->meterinfo->max = val;
717 val = (*i)->meterinfo->max;
720 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
721 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
722 (*i)->meterinfo->meter->set (lval );
729 LadspaPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
731 vector<string> enums;
732 boost::shared_ptr<LadspaPlugin> lp = boost::dynamic_pointer_cast<LadspaPlugin> (plugin);
734 cui->combo_map = new std::map<string, float>;
735 lrdf_defaults* defaults = lrdf_get_scale_values(lp->unique_id(), port_index);
737 for (uint32_t i = 0; i < defaults->count; ++i) {
738 enums.push_back(defaults->items[i].label);
739 pair<string, float> newpair;
740 newpair.first = defaults->items[i].label;
741 newpair.second = defaults->items[i].value;
742 cui->combo_map->insert(newpair);
745 lrdf_free_setting_values(defaults);