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.
21 #include "gtk2ardour-config.h"
29 #include "pbd/stl_delete.h"
30 #include "pbd/xml++.h"
31 #include "pbd/failed_constructor.h"
33 #include <gtkmm2ext/click_box.h>
34 #include <gtkmm2ext/fastmeter.h>
35 #include <gtkmm2ext/barcontroller.h>
36 #include <gtkmm2ext/utils.h>
37 #include <gtkmm2ext/doi.h>
38 #include <gtkmm2ext/slider_controller.h>
40 #include "midi++/manager.h"
42 #include "ardour/plugin.h"
43 #include "ardour/plugin_insert.h"
44 #include "ardour/ladspa_plugin.h"
46 #include "ardour/lv2_plugin.h"
51 #include "ardour_ui.h"
53 #include "plugin_ui.h"
55 #include "gui_thread.h"
56 #include "automation_controller.h"
61 using namespace ARDOUR;
63 using namespace Gtkmm2ext;
67 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
69 button_table (initial_button_rows, initial_button_cols),
70 output_table (initial_output_rows, initial_output_cols),
71 hAdjustment(0.0, 0.0, 0.0),
72 vAdjustment(0.0, 0.0, 0.0),
73 scroller_view(hAdjustment, vAdjustment),
75 is_scrollable(scrollable)
77 set_name ("PluginEditor");
78 set_border_width (10);
79 //set_homogeneous (false);
81 pack_start(main_contents);
82 settings_box.set_homogeneous (false);
84 HBox* constraint_hbox = manage (new HBox);
85 HBox* smaller_hbox = manage (new HBox);
86 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
87 combo_label->set_use_markup (true);
89 latency_button.add (latency_label);
90 latency_button.signal_clicked().connect (mem_fun (*this, &PlugUIBase::latency_button_clicked));
93 smaller_hbox->pack_start (latency_button, false, false, 10);
94 smaller_hbox->pack_start (preset_combo, false, false);
95 smaller_hbox->pack_start (save_button, false, false);
96 smaller_hbox->pack_start (bypass_button, false, true);
98 constraint_hbox->set_spacing (5);
99 constraint_hbox->set_homogeneous (false);
101 VBox* v1_box = manage (new VBox);
102 VBox* v2_box = manage (new VBox);
103 pack_end(plugin_analysis_expander);
105 v1_box->pack_start (*smaller_hbox, false, true);
106 v2_box->pack_start (focus_button, false, true);
108 main_contents.pack_start (settings_box, false, false);
110 constraint_hbox->pack_end (*v2_box, false, false);
111 constraint_hbox->pack_end (*v1_box, false, false);
113 main_contents.pack_start (*constraint_hbox, false, false);
115 if ( is_scrollable ) {
116 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
117 scroller.set_name ("PluginEditor");
118 scroller_view.set_name("PluginEditor");
119 scroller_view.add (hpacker);
120 scroller.add (scroller_view);
122 main_contents.pack_start (scroller, true, true);
126 main_contents.pack_start (hpacker, false, false);
129 pi->ActiveChanged.connect (bind(mem_fun(*this, &GenericPluginUI::processor_active_changed),
130 boost::weak_ptr<Processor>(pi)));
132 bypass_button.set_active (!pi->active());
137 GenericPluginUI::~GenericPluginUI ()
139 if (output_controls.size() > 0) {
140 screen_update_connection.disconnect();
145 GenericPluginUI::build ()
153 int output_row, output_col;
154 int button_row, button_col;
155 int output_rows, output_cols;
156 int button_rows, button_cols;
159 hpacker.set_spacing (10);
161 output_rows = initial_output_rows;
162 output_cols = initial_output_cols;
163 button_rows = initial_button_rows;
164 button_cols = initial_button_cols;
170 button_table.set_homogeneous (false);
171 button_table.set_row_spacings (2);
172 button_table.set_col_spacings (2);
173 output_table.set_homogeneous (true);
174 output_table.set_row_spacings (2);
175 output_table.set_col_spacings (2);
176 button_table.set_border_width (5);
177 output_table.set_border_width (5);
179 hpacker.set_border_width (10);
181 bt_frame = manage (new Frame);
182 bt_frame->set_name ("BaseFrame");
183 bt_frame->add (button_table);
184 hpacker.pack_start(*bt_frame, true, true);
186 box = manage (new VBox);
187 box->set_border_width (5);
188 box->set_spacing (1);
190 frame = manage (new Frame);
191 frame->set_name ("BaseFrame");
192 frame->set_label (_("Controls"));
194 hpacker.pack_start(*frame, true, true);
196 /* find all ports. build control elements for all appropriate control ports */
198 for (i = 0; i < plugin->parameter_count(); ++i) {
200 if (plugin->parameter_is_control (i)) {
202 /* Don't show latency control ports */
204 if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("latency")) {
210 /* if we are scrollable, just use one long column */
212 if (!is_scrollable) {
214 frame = manage (new Frame);
215 frame->set_name ("BaseFrame");
216 box = manage (new VBox);
218 box->set_border_width (5);
219 box->set_spacing (1);
222 hpacker.pack_start(*frame,true,true);
228 boost::shared_ptr<ARDOUR::AutomationControl> c
229 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
230 insert->data().control(Evoral::Parameter(PluginAutomation, 0, i)));
232 if ((cui = build_control_ui (i, c)) == 0) {
233 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
237 if (cui->controller || cui->clickbox || cui->combo) {
239 box->pack_start (*cui, false, false);
241 } else if (cui->button) {
243 if (button_row == button_rows) {
245 if (++button_col == button_cols) {
247 button_table.resize (button_rows, button_cols);
251 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
255 } else if (cui->display) {
257 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
260 // TODO: The meters should be divided into multiple rows
262 if (++output_col == output_cols) {
264 output_table.resize (output_rows, output_cols);
267 /* old code, which divides meters into
268 * columns first, rows later. New code divides into one row
270 if (output_row == output_rows) {
272 if (++output_col == output_cols) {
274 output_table.resize (output_rows, output_cols);
278 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
285 /* HACK: ideally the preferred height would be queried from
286 the complete hpacker, but I can't seem to get that
287 information in time, so this is an estimation
295 if (box->children().empty()) {
296 hpacker.remove (*frame);
299 if (button_table.children().empty()) {
300 hpacker.remove (*bt_frame);
303 if (!output_table.children().empty()) {
304 frame = manage (new Frame);
305 frame->set_name ("BaseFrame");
306 frame->add (output_table);
307 hpacker.pack_end (*frame, true, true);
312 output_table.show_all ();
313 button_table.show_all ();
316 GenericPluginUI::ControlUI::ControlUI ()
317 : automate_button (X_("")) // force creation of a label
319 automate_button.set_name ("PluginAutomateButton");
320 ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("Automation control"));
322 /* XXX translators: use a string here that will be at least as long
323 as the longest automation label (see ::automation_state_changed()
324 below). be sure to include a descender.
327 set_size_request_to_display_given_text (*automate_button.get_child(), _("Mgnual"), 5, 5);
336 GenericPluginUI::ControlUI::~ControlUI()
339 delete meterinfo->meter;
345 GenericPluginUI::automation_state_changed (ControlUI* cui)
347 /* update button label */
349 // don't lock to avoid deadlock because we're triggered by
350 // AutomationControl::Changed() while the automation lock is taken
351 switch (insert->get_parameter_automation_state (cui->parameter(), false)
352 & (Off|Play|Touch|Write)) {
354 cui->automate_button.set_label (_("Manual"));
357 cui->automate_button.set_label (_("Play"));
360 cui->automate_button.set_label (_("Write"));
363 cui->automate_button.set_label (_("Touch"));
366 cui->automate_button.set_label (_("???"));
372 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
374 snprintf (buf, 32, "%.0f", adj.get_value());
378 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
380 plugin->print_parameter (param, buf, len);
383 GenericPluginUI::ControlUI*
384 GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptr<AutomationControl> mcontrol)
386 ControlUI* control_ui = NULL;
390 Plugin::ParameterDescriptor desc;
392 plugin->get_parameter_descriptor (port_index, desc);
394 control_ui = manage (new ControlUI ());
395 control_ui->combo = 0;
396 control_ui->combo_map = 0;
397 control_ui->control = mcontrol;
398 control_ui->update_pending = false;
399 control_ui->label.set_text (desc.label);
400 control_ui->label.set_alignment (0.0, 0.5);
401 control_ui->label.set_name ("PluginParameterLabel");
403 control_ui->set_spacing (5);
405 Gtk::Requisition req (control_ui->automate_button.size_request());
407 if (plugin->parameter_is_input (port_index)) {
409 boost::shared_ptr<LadspaPlugin> lp;
411 boost::shared_ptr<LV2Plugin> lv2p;
413 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
415 // FIXME: not all plugins have a numeric unique ID
416 uint32_t id = atol (lp->unique_id().c_str());
417 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
419 if (defaults && defaults->count > 0) {
421 control_ui->combo = new Gtk::ComboBoxText;
422 //control_ui->combo->set_value_in_list(true, false);
423 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
424 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
425 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
426 control_ui->pack_start(control_ui->label, true, true);
427 control_ui->pack_start(*control_ui->combo, false, true);
429 update_control_display(control_ui);
431 lrdf_free_setting_values(defaults);
436 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
438 SLV2Port port = lv2p->slv2_port(port_index);
439 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
442 control_ui->combo = new Gtk::ComboBoxText;
443 //control_ui->combo->set_value_in_list(true, false);
444 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
445 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
446 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
447 control_ui->pack_start(control_ui->label, true, true);
448 control_ui->pack_start(*control_ui->combo, false, true);
450 update_control_display(control_ui);
452 slv2_scale_points_free(points);
462 control_ui->button = manage (new ToggleButton ());
463 control_ui->button->set_name ("PluginEditorButton");
464 control_ui->button->set_size_request (20, 20);
466 control_ui->pack_start (control_ui->label, true, true);
467 control_ui->pack_start (*control_ui->button, false, true);
468 // control_ui->pack_start (control_ui->automate_button, false, false);
470 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
471 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::toggle_parameter_changed), control_ui));
473 if (plugin->get_parameter (port_index) > 0.5){
474 control_ui->button->set_active(true);
480 /* create the controller */
482 control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), mcontrol);
483 /* XXX this code is not right yet, because it doesn't handle
484 the absence of bounds in any sensible fashion.
488 control_ui->controller->adjustment()->set_lower (desc.lower);
489 control_ui->controller->adjustment()->set_upper (desc.upper);
491 control_ui->logarithmic = false; // just disable it for now
493 control_ui->logarithmic = desc.logarithmic;
494 if (control_ui->logarithmic) {
495 if (control_ui->controller->adjustment()->get_lower() == 0.0) {
496 control_ui->controller->adjustment()->set_lower (control_ui->controller->adjustment()->get_upper()/10000);
498 control_ui->controller->adjustment()->set_upper (log(control_ui->controller->adjustment()->get_upper()));
499 control_ui->controller->adjustment()->set_lower (log(control_ui->controller->adjustment()->get_lower()));
503 control_ui->controller->adjustment()->set_step_increment (desc.step);
504 control_ui->controller->adjustment()->set_page_increment (desc.largestep);
507 if (desc.integer_step) {
508 control_ui->clickbox = new ClickBox (control_ui->controller->adjustment(), "PluginUIClickBox");
509 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
510 control_ui->clickbox->set_print_func (integer_printer, 0);
512 //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
514 control_ui->controller->set_size_request (200, req.height);
515 control_ui->controller->set_name (X_("PluginSlider"));
516 control_ui->controller->set_style (BarController::LeftToRight);
517 control_ui->controller->set_use_parent (true);
519 control_ui->controller->StartGesture.connect (bind (mem_fun(*this, &GenericPluginUI::start_touch), control_ui));
520 control_ui->controller->StopGesture.connect (bind (mem_fun(*this, &GenericPluginUI::stop_touch), control_ui));
524 if (control_ui->logarithmic) {
525 control_ui->controller->adjustment()->set_value(log(plugin->get_parameter(port_index)));
527 control_ui->controller->adjustment()->set_value(plugin->get_parameter(port_index));
530 /* XXX memory leak: SliderController not destroyed by ControlUI
531 destructor, and manage() reports object hierarchy
535 control_ui->pack_start (control_ui->label, true, true);
536 if (desc.integer_step) {
537 control_ui->pack_start (*control_ui->clickbox, false, false);
539 control_ui->pack_start (*control_ui->controller, false, false);
542 control_ui->pack_start (control_ui->automate_button, false, false);
543 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
545 automation_state_changed (control_ui);
547 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
548 mcontrol->alist()->automation_state_changed.connect
549 (bind (mem_fun(*this, &GenericPluginUI::automation_state_changed), control_ui));
551 } else if (plugin->parameter_is_output (port_index)) {
553 control_ui->display = manage (new EventBox);
554 control_ui->display->set_name ("ParameterValueDisplay");
556 control_ui->display_label = manage (new Label);
558 control_ui->display_label->set_name ("ParameterValueDisplay");
560 control_ui->display->add (*control_ui->display_label);
561 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
563 control_ui->display->show_all ();
566 /* TODO: only make a meter if the port is Hinted for it */
568 MeterInfo * info = new MeterInfo(port_index);
569 control_ui->meterinfo = info;
571 info->meter = new FastMeter (5, 5, FastMeter::Vertical);
573 info->min_unbound = desc.min_unbound;
574 info->max_unbound = desc.max_unbound;
576 info->min = desc.lower;
577 info->max = desc.upper;
579 control_ui->vbox = manage (new VBox);
580 control_ui->hbox = manage (new HBox);
582 control_ui->label.set_angle(90);
583 control_ui->hbox->pack_start (control_ui->label, false, false);
584 control_ui->hbox->pack_start (*info->meter, false, false);
586 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
588 control_ui->vbox->pack_start (*control_ui->display, false, false);
590 control_ui->pack_start (*control_ui->vbox);
592 control_ui->meterinfo->meter->show_all();
593 control_ui->meterinfo->packed = true;
595 output_controls.push_back (control_ui);
598 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
604 GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui)
606 cui->control->start_touch ();
610 GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui)
612 cui->control->stop_touch ();
616 GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
618 using namespace Menu_Helpers;
620 if (automation_menu == 0) {
621 automation_menu = manage (new Menu);
622 automation_menu->set_name ("ArdourContextMenu");
625 MenuList& items (automation_menu->items());
628 items.push_back (MenuElem (_("Manual"),
629 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Off, cui)));
630 items.push_back (MenuElem (_("Play"),
631 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
632 items.push_back (MenuElem (_("Write"),
633 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
634 items.push_back (MenuElem (_("Touch"),
635 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
637 automation_menu->popup (1, gtk_get_current_event_time());
641 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
643 insert->set_parameter_automation_state (cui->parameter(), state);
647 GenericPluginUI::toggle_parameter_changed (ControlUI* cui)
649 float val = cui->control->get_value();
651 if (!cui->ignore_change) {
653 cui->button->set_active (true);
655 cui->button->set_active (false);
661 GenericPluginUI::parameter_changed (ControlUI* cui)
663 if (!cui->update_pending) {
664 cui->update_pending = true;
665 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &GenericPluginUI::update_control_display), cui));
670 GenericPluginUI::update_control_display (ControlUI* cui)
672 /* XXX how do we handle logarithmic stuff here ? */
674 cui->update_pending = false;
676 float val = cui->control->get_value();
678 cui->ignore_change++;
681 std::map<string,float>::iterator it;
682 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
683 if (it->second == val) {
684 cui->combo->set_active_text(it->first);
688 } else if (cui->button) {
691 cui->button->set_active (true);
693 cui->button->set_active (false);
697 if( cui->controller ) {
698 cui->controller->display_effective_value();
703 if (cui->logarithmic) {
706 if (val != cui->adjustment->get_value()) {
707 cui->adjustment->set_value (val);
710 cui->ignore_change--;
714 GenericPluginUI::control_port_toggled (ControlUI* cui)
716 cui->ignore_change++;
717 insert->automation_control (cui->parameter())->set_value (cui->button->get_active());
718 cui->ignore_change--;
722 GenericPluginUI::control_combo_changed (ControlUI* cui)
724 if (!cui->ignore_change) {
725 string value = cui->combo->get_active_text();
726 std::map<string,float> mapping = *cui->combo_map;
727 insert->automation_control(cui->parameter())->set_value(mapping[value]);
732 GenericPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
734 ENSURE_GUI_THREAD(bind (mem_fun(*this, &GenericPluginUI::processor_active_changed), weak_processor));
736 boost::shared_ptr<Processor> processor = weak_processor.lock();
738 bypass_button.set_active (!processor || !processor->active());
742 GenericPluginUI::start_updating (GdkEventAny* ignored)
744 if (output_controls.size() > 0 ) {
745 screen_update_connection.disconnect();
746 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
747 (mem_fun(*this, &GenericPluginUI::output_update));
753 GenericPluginUI::stop_updating (GdkEventAny* ignored)
755 if (output_controls.size() > 0 ) {
756 screen_update_connection.disconnect();
762 GenericPluginUI::output_update ()
764 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
765 float val = plugin->get_parameter ((*i)->parameter().id());
767 snprintf (buf, sizeof(buf), "%.2f", val);
768 (*i)->display_label->set_text (buf);
770 /* autoscaling for the meter */
771 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
773 if (val < (*i)->meterinfo->min) {
774 if ((*i)->meterinfo->min_unbound)
775 (*i)->meterinfo->min = val;
777 val = (*i)->meterinfo->min;
780 if (val > (*i)->meterinfo->max) {
781 if ((*i)->meterinfo->max_unbound)
782 (*i)->meterinfo->max = val;
784 val = (*i)->meterinfo->max;
787 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
788 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
789 (*i)->meterinfo->meter->set (lval );
796 GenericPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
798 vector<string> enums;
799 boost::shared_ptr<LadspaPlugin> lp;
801 boost::shared_ptr<LV2Plugin> lv2p;
804 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
805 // all LADPSA plugins have a numeric unique ID
806 uint32_t id = atol (lp->unique_id().c_str());
808 cui->combo_map = new std::map<string, float>;
809 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
811 for (uint32_t i = 0; i < defaults->count; ++i) {
812 enums.push_back(defaults->items[i].label);
813 pair<string, float> newpair;
814 newpair.first = defaults->items[i].label;
815 newpair.second = defaults->items[i].value;
816 cui->combo_map->insert(newpair);
819 lrdf_free_setting_values(defaults);
823 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
825 SLV2Port port = lv2p->slv2_port(port_index);
826 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
827 cui->combo_map = new std::map<string, float>;
829 for (unsigned i=0; i < slv2_scale_points_size(points); ++i) {
830 SLV2ScalePoint p = slv2_scale_points_get_at(points, i);
831 SLV2Value label = slv2_scale_point_get_label(p);
832 SLV2Value value = slv2_scale_point_get_value(p);
833 if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
834 enums.push_back(slv2_value_as_string(label));
835 pair<string, float> newpair;
836 newpair.first = slv2_value_as_string(label);
837 newpair.second = slv2_value_as_float(value);
838 cui->combo_map->insert(newpair);
842 slv2_scale_points_free(points);