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"
42 #include "ardour/lv2_plugin.h"
47 #include "ardour_ui.h"
49 #include "plugin_ui.h"
51 #include "gui_thread.h"
52 #include "automation_controller.h"
57 using namespace ARDOUR;
59 using namespace Gtkmm2ext;
63 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
65 button_table (initial_button_rows, initial_button_cols),
66 output_table (initial_output_rows, initial_output_cols),
67 hAdjustment(0.0, 0.0, 0.0),
68 vAdjustment(0.0, 0.0, 0.0),
69 scroller_view(hAdjustment, vAdjustment),
71 is_scrollable(scrollable)
73 set_name ("PluginEditor");
74 set_border_width (10);
75 //set_homogeneous (false);
78 settings_box.set_homogeneous (false);
80 HBox* constraint_hbox = manage (new HBox);
81 HBox* smaller_hbox = manage (new HBox);
82 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
83 combo_label->set_use_markup (true);
85 Label* latency_label = manage (new Label (_("<span size=\"large\">Latency</span>")));
86 latency_label->set_use_markup (true);
88 smaller_hbox->pack_start (*latency_label, false, false, 10);
89 smaller_hbox->pack_start (latency_gui, false, false, 10);
90 smaller_hbox->pack_start (preset_combo, false, false);
91 smaller_hbox->pack_start (save_button, false, false);
92 smaller_hbox->pack_start (bypass_button, false, true);
94 constraint_hbox->set_spacing (5);
95 constraint_hbox->set_homogeneous (false);
97 VBox* v1_box = manage (new VBox);
98 VBox* v2_box = manage (new VBox);
99 constraint_hbox->pack_start (eqgui_toggle, false, false);
102 v1_box->pack_start (*smaller_hbox, false, true);
103 v2_box->pack_start (focus_button, false, true);
105 main_contents.pack_start (settings_box, false, false);
107 constraint_hbox->pack_end (*v2_box, false, false);
108 constraint_hbox->pack_end (*v1_box, false, false);
110 main_contents.pack_start (*constraint_hbox, false, false);
112 if ( is_scrollable ) {
113 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
114 scroller.set_name ("PluginEditor");
115 scroller_view.set_name("PluginEditor");
116 scroller_view.add (hpacker);
117 scroller.add (scroller_view);
119 main_contents.pack_start (scroller, true, true);
123 main_contents.pack_start (hpacker, false, false);
126 pi->ActiveChanged.connect (bind(mem_fun(*this, &GenericPluginUI::processor_active_changed),
127 boost::weak_ptr<Processor>(pi)));
129 bypass_button.set_active (!pi->active());
134 GenericPluginUI::~GenericPluginUI ()
136 if (output_controls.size() > 0) {
137 screen_update_connection.disconnect();
142 GenericPluginUI::build ()
150 int output_row, output_col;
151 int button_row, button_col;
152 int output_rows, output_cols;
153 int button_rows, button_cols;
156 hpacker.set_spacing (10);
158 output_rows = initial_output_rows;
159 output_cols = initial_output_cols;
160 button_rows = initial_button_rows;
161 button_cols = initial_button_cols;
167 button_table.set_homogeneous (false);
168 button_table.set_row_spacings (2);
169 button_table.set_col_spacings (2);
170 output_table.set_homogeneous (true);
171 output_table.set_row_spacings (2);
172 output_table.set_col_spacings (2);
173 button_table.set_border_width (5);
174 output_table.set_border_width (5);
176 hpacker.set_border_width (10);
178 bt_frame = manage (new Frame);
179 bt_frame->set_name ("BaseFrame");
180 bt_frame->add (button_table);
181 hpacker.pack_start(*bt_frame, true, true);
183 box = manage (new VBox);
184 box->set_border_width (5);
185 box->set_spacing (1);
187 frame = manage (new Frame);
188 frame->set_name ("BaseFrame");
189 frame->set_label (_("Controls"));
191 hpacker.pack_start(*frame, true, true);
193 /* find all ports. build control elements for all appropriate control ports */
195 for (i = 0; i < plugin->parameter_count(); ++i) {
197 if (plugin->parameter_is_control (i)) {
199 /* Don't show latency control ports */
201 if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("latency")) {
207 /* if we are scrollable, just use one long column */
209 if (!is_scrollable) {
211 frame = manage (new Frame);
212 frame->set_name ("BaseFrame");
213 box = manage (new VBox);
215 box->set_border_width (5);
216 box->set_spacing (1);
219 hpacker.pack_start(*frame,true,true);
225 boost::shared_ptr<ARDOUR::AutomationControl> c
226 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
227 insert->data().control(Evoral::Parameter(PluginAutomation, 0, i)));
229 if ((cui = build_control_ui (i, c)) == 0) {
230 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
234 if (cui->controller || cui->clickbox || cui->combo) {
236 box->pack_start (*cui, false, false);
238 } else if (cui->button) {
240 if (button_row == button_rows) {
242 if (++button_col == button_cols) {
244 button_table.resize (button_rows, button_cols);
248 button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
252 } else if (cui->display) {
254 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
257 // TODO: The meters should be divided into multiple rows
259 if (++output_col == output_cols) {
261 output_table.resize (output_rows, output_cols);
264 /* old code, which divides meters into
265 * columns first, rows later. New code divides into one row
267 if (output_row == output_rows) {
269 if (++output_col == output_cols) {
271 output_table.resize (output_rows, output_cols);
275 output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
282 /* HACK: ideally the preferred height would be queried from
283 the complete hpacker, but I can't seem to get that
284 information in time, so this is an estimation
292 if (box->children().empty()) {
293 hpacker.remove (*frame);
296 if (button_table.children().empty()) {
297 hpacker.remove (*bt_frame);
300 if (!output_table.children().empty()) {
301 frame = manage (new Frame);
302 frame->set_name ("BaseFrame");
303 frame->add (output_table);
304 hpacker.pack_end (*frame, true, true);
309 output_table.show_all ();
310 button_table.show_all ();
313 GenericPluginUI::ControlUI::ControlUI ()
314 : automate_button (X_("")) // force creation of a label
316 automate_button.set_name ("PluginAutomateButton");
317 ARDOUR_UI::instance()->tooltips().set_tip (automate_button, _("Automation control"));
319 /* XXX translators: use a string here that will be at least as long
320 as the longest automation label (see ::automation_state_changed()
321 below). be sure to include a descender.
324 set_size_request_to_display_given_text (*automate_button.get_child(), _("Mgnual"), 5, 5);
333 GenericPluginUI::ControlUI::~ControlUI()
336 delete meterinfo->meter;
342 GenericPluginUI::automation_state_changed (ControlUI* cui)
344 /* update button label */
346 // don't lock to avoid deadlock because we're triggered by
347 // AutomationControl::Changed() while the automation lock is taken
348 switch (insert->get_parameter_automation_state (cui->parameter(), false)
349 & (Off|Play|Touch|Write)) {
351 cui->automate_button.set_label (_("Manual"));
354 cui->automate_button.set_label (_("Play"));
357 cui->automate_button.set_label (_("Write"));
360 cui->automate_button.set_label (_("Touch"));
363 cui->automate_button.set_label (_("???"));
369 static void integer_printer (char buf[32], Adjustment &adj, void *arg)
371 snprintf (buf, 32, "%.0f", adj.get_value());
375 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
377 plugin->print_parameter (param, buf, len);
380 GenericPluginUI::ControlUI*
381 GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptr<AutomationControl> mcontrol)
383 ControlUI* control_ui = NULL;
387 Plugin::ParameterDescriptor desc;
389 plugin->get_parameter_descriptor (port_index, desc);
391 control_ui = manage (new ControlUI ());
392 control_ui->combo = 0;
393 control_ui->combo_map = 0;
394 control_ui->control = mcontrol;
395 control_ui->update_pending = false;
396 control_ui->label.set_text (desc.label);
397 control_ui->label.set_alignment (0.0, 0.5);
398 control_ui->label.set_name ("PluginParameterLabel");
400 control_ui->set_spacing (5);
402 Gtk::Requisition req (control_ui->automate_button.size_request());
404 if (plugin->parameter_is_input (port_index)) {
406 boost::shared_ptr<LadspaPlugin> lp;
408 boost::shared_ptr<LV2Plugin> lv2p;
410 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
412 // FIXME: not all plugins have a numeric unique ID
413 uint32_t id = atol (lp->unique_id().c_str());
414 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
416 if (defaults && defaults->count > 0) {
418 control_ui->combo = new Gtk::ComboBoxText;
419 //control_ui->combo->set_value_in_list(true, false);
420 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
421 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
422 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
423 control_ui->pack_start(control_ui->label, true, true);
424 control_ui->pack_start(*control_ui->combo, false, true);
426 update_control_display(control_ui);
428 lrdf_free_setting_values(defaults);
433 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
435 SLV2Port port = lv2p->slv2_port(port_index);
436 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
439 control_ui->combo = new Gtk::ComboBoxText;
440 //control_ui->combo->set_value_in_list(true, false);
441 set_popdown_strings (*control_ui->combo, setup_scale_values(port_index, control_ui));
442 control_ui->combo->signal_changed().connect (bind (mem_fun(*this, &GenericPluginUI::control_combo_changed), control_ui));
443 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
444 control_ui->pack_start(control_ui->label, true, true);
445 control_ui->pack_start(*control_ui->combo, false, true);
447 update_control_display(control_ui);
449 slv2_scale_points_free(points);
459 control_ui->button = manage (new ToggleButton ());
460 control_ui->button->set_name ("PluginEditorButton");
461 control_ui->button->set_size_request (20, 20);
463 control_ui->pack_start (control_ui->label, true, true);
464 control_ui->pack_start (*control_ui->button, false, true);
465 control_ui->pack_start (control_ui->automate_button, false, false);
467 control_ui->button->signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
469 if(plugin->get_parameter (port_index) == 1){
470 control_ui->button->set_active(true);
476 /* create the controller */
478 control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), mcontrol);
479 /* XXX this code is not right yet, because it doesn't handle
480 the absence of bounds in any sensible fashion.
484 control_ui->controller->adjustment()->set_lower (desc.lower);
485 control_ui->controller->adjustment()->set_upper (desc.upper);
487 control_ui->logarithmic = false; // just disable it for now
489 control_ui->logarithmic = desc.logarithmic;
490 if (control_ui->logarithmic) {
491 if (control_ui->controller->adjustment()->get_lower() == 0.0) {
492 control_ui->controller->adjustment()->set_lower (control_ui->controller->adjustment()->get_upper()/10000);
494 control_ui->controller->adjustment()->set_upper (log(control_ui->controller->adjustment()->get_upper()));
495 control_ui->controller->adjustment()->set_lower (log(control_ui->controller->adjustment()->get_lower()));
499 float delta = desc.upper - desc.lower;
501 control_ui->controller->adjustment()->set_page_size (delta/100.0);
502 control_ui->controller->adjustment()->set_step_increment (desc.step);
503 control_ui->controller->adjustment()->set_page_increment (desc.largestep);
506 if (desc.integer_step) {
507 control_ui->clickbox = new ClickBox (control_ui->controller->adjustment(), "PluginUIClickBox");
508 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
509 control_ui->clickbox->set_print_func (integer_printer, 0);
511 //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
513 control_ui->controller->set_size_request (200, req.height);
514 control_ui->controller->set_name (X_("PluginSlider"));
515 control_ui->controller->set_style (BarController::LeftToRight);
516 control_ui->controller->set_use_parent (true);
518 control_ui->controller->StartGesture.connect (bind (mem_fun(*this, &GenericPluginUI::start_touch), control_ui));
519 control_ui->controller->StopGesture.connect (bind (mem_fun(*this, &GenericPluginUI::stop_touch), control_ui));
523 if (control_ui->logarithmic) {
524 control_ui->controller->adjustment()->set_value(log(plugin->get_parameter(port_index)));
526 control_ui->controller->adjustment()->set_value(plugin->get_parameter(port_index));
529 /* XXX memory leak: SliderController not destroyed by ControlUI
530 destructor, and manage() reports object hierarchy
534 control_ui->pack_start (control_ui->label, true, true);
535 if (desc.integer_step) {
536 control_ui->pack_start (*control_ui->clickbox, false, false);
538 control_ui->pack_start (*control_ui->controller, false, false);
541 control_ui->pack_start (control_ui->automate_button, false, false);
542 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index));
544 automation_state_changed (control_ui);
546 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
547 mcontrol->alist()->automation_state_changed.connect
548 (bind (mem_fun(*this, &GenericPluginUI::automation_state_changed), control_ui));
550 } else if (plugin->parameter_is_output (port_index)) {
552 control_ui->display = manage (new EventBox);
553 control_ui->display->set_name ("ParameterValueDisplay");
555 control_ui->display_label = manage (new Label);
557 control_ui->display_label->set_name ("ParameterValueDisplay");
559 control_ui->display->add (*control_ui->display_label);
560 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-99,99", 2, 2);
562 control_ui->display->show_all ();
565 /* TODO: only make a meter if the port is Hinted for it */
567 MeterInfo * info = new MeterInfo(port_index);
568 control_ui->meterinfo = info;
570 info->meter = new FastMeter (5, 5, FastMeter::Vertical);
572 info->min_unbound = desc.min_unbound;
573 info->max_unbound = desc.max_unbound;
575 info->min = desc.lower;
576 info->max = desc.upper;
578 control_ui->vbox = manage (new VBox);
579 control_ui->hbox = manage (new HBox);
581 control_ui->label.set_angle(90);
582 control_ui->hbox->pack_start (control_ui->label, false, false);
583 control_ui->hbox->pack_start (*info->meter, false, false);
585 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
587 control_ui->vbox->pack_start (*control_ui->display, false, false);
589 control_ui->pack_start (*control_ui->vbox);
591 control_ui->meterinfo->meter->show_all();
592 control_ui->meterinfo->packed = true;
594 output_controls.push_back (control_ui);
597 mcontrol->Changed.connect (bind (mem_fun (*this, &GenericPluginUI::parameter_changed), control_ui));
603 GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui)
605 cui->control->start_touch ();
609 GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui)
611 cui->control->stop_touch ();
615 GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t port)
617 using namespace Menu_Helpers;
619 if (automation_menu == 0) {
620 automation_menu = manage (new Menu);
621 automation_menu->set_name ("ArdourContextMenu");
624 MenuList& items (automation_menu->items());
627 items.push_back (MenuElem (_("Manual"),
628 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Off, cui)));
629 items.push_back (MenuElem (_("Play"),
630 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
631 items.push_back (MenuElem (_("Write"),
632 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
633 items.push_back (MenuElem (_("Touch"),
634 bind (mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
636 automation_menu->popup (1, gtk_get_current_event_time());
640 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
642 insert->set_parameter_automation_state (cui->parameter(), state);
646 GenericPluginUI::parameter_changed (ControlUI* cui)
648 if (!cui->update_pending) {
649 cui->update_pending = true;
650 Gtkmm2ext::UI::instance()->call_slot (bind (mem_fun(*this, &GenericPluginUI::update_control_display), cui));
655 GenericPluginUI::update_control_display (ControlUI* cui)
657 /* XXX how do we handle logarithmic stuff here ? */
659 cui->update_pending = false;
661 float val = cui->control->get_value();
663 cui->ignore_change++;
665 std::map<string,float>::iterator it;
666 for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
667 if (it->second == val) {
668 cui->combo->set_active_text(it->first);
672 } else if (cui->button) {
675 cui->button->set_active (true);
677 cui->button->set_active (false);
681 if( cui->controller ) {
682 cui->controller->display_effective_value();
687 if (cui->logarithmic) {
690 if (val != cui->adjustment->get_value()) {
691 cui->adjustment->set_value (val);
694 cui->ignore_change--;
698 GenericPluginUI::control_port_toggled (ControlUI* cui)
700 if (!cui->ignore_change) {
701 insert->automation_control(cui->parameter())->set_value(cui->button->get_active());
706 GenericPluginUI::control_combo_changed (ControlUI* cui)
708 if (!cui->ignore_change) {
709 string value = cui->combo->get_active_text();
710 std::map<string,float> mapping = *cui->combo_map;
711 insert->automation_control(cui->parameter())->set_value(mapping[value]);
716 GenericPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
718 ENSURE_GUI_THREAD(bind (mem_fun(*this, &GenericPluginUI::processor_active_changed), weak_processor));
720 boost::shared_ptr<Processor> processor = weak_processor.lock();
722 bypass_button.set_active (!processor || !processor->active());
726 GenericPluginUI::start_updating (GdkEventAny* ignored)
728 if (output_controls.size() > 0 ) {
729 screen_update_connection.disconnect();
730 screen_update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect
731 (mem_fun(*this, &GenericPluginUI::output_update));
737 GenericPluginUI::stop_updating (GdkEventAny* ignored)
739 if (output_controls.size() > 0 ) {
740 screen_update_connection.disconnect();
746 GenericPluginUI::output_update ()
748 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
749 float val = plugin->get_parameter ((*i)->parameter().id());
751 snprintf (buf, sizeof(buf), "%.2f", val);
752 (*i)->display_label->set_text (buf);
754 /* autoscaling for the meter */
755 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
757 if (val < (*i)->meterinfo->min) {
758 if ((*i)->meterinfo->min_unbound)
759 (*i)->meterinfo->min = val;
761 val = (*i)->meterinfo->min;
764 if (val > (*i)->meterinfo->max) {
765 if ((*i)->meterinfo->max_unbound)
766 (*i)->meterinfo->max = val;
768 val = (*i)->meterinfo->max;
771 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
772 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
773 (*i)->meterinfo->meter->set (lval );
780 GenericPluginUI::setup_scale_values(guint32 port_index, ControlUI* cui)
782 vector<string> enums;
783 boost::shared_ptr<LadspaPlugin> lp;
785 boost::shared_ptr<LV2Plugin> lv2p;
788 if ((lp = boost::dynamic_pointer_cast<LadspaPlugin>(plugin)) != 0) {
789 // all LADPSA plugins have a numeric unique ID
790 uint32_t id = atol (lp->unique_id().c_str());
792 cui->combo_map = new std::map<string, float>;
793 lrdf_defaults* defaults = lrdf_get_scale_values(id, port_index);
795 for (uint32_t i = 0; i < defaults->count; ++i) {
796 enums.push_back(defaults->items[i].label);
797 pair<string, float> newpair;
798 newpair.first = defaults->items[i].label;
799 newpair.second = defaults->items[i].value;
800 cui->combo_map->insert(newpair);
803 lrdf_free_setting_values(defaults);
807 } else if ((lv2p = boost::dynamic_pointer_cast<LV2Plugin>(plugin)) != 0) {
809 SLV2Port port = lv2p->slv2_port(port_index);
810 SLV2ScalePoints points = slv2_port_get_scale_points(lv2p->slv2_plugin(), port);
811 cui->combo_map = new std::map<string, float>;
813 for (unsigned i=0; i < slv2_scale_points_size(points); ++i) {
814 SLV2ScalePoint p = slv2_scale_points_get_at(points, i);
815 SLV2Value label = slv2_scale_point_get_label(p);
816 SLV2Value value = slv2_scale_point_get_value(p);
817 if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
818 enums.push_back(slv2_value_as_string(label));
819 pair<string, float> newpair;
820 newpair.first = slv2_value_as_string(label);
821 newpair.second = slv2_value_as_float(value);
822 cui->combo_map->insert(newpair);
826 slv2_scale_points_free(points);