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"
30 #include <gtkmm/separator.h>
32 #include "pbd/stl_delete.h"
33 #include "pbd/unwind.h"
34 #include "pbd/xml++.h"
35 #include "pbd/failed_constructor.h"
37 #include "ardour/plugin.h"
38 #include "ardour/plugin_insert.h"
39 #include "ardour/session.h"
40 #include "ardour/value_as_string.h"
42 #include "gtkmm2ext/utils.h"
43 #include "gtkmm2ext/doi.h"
45 #include "widgets/ardour_knob.h"
46 #include "widgets/click_box.h"
47 #include "widgets/fastmeter.h"
48 #include "widgets/slider_controller.h"
49 #include "widgets/tooltips.h"
51 #include "plugin_ui.h"
52 #include "plugin_display.h"
53 #include "gui_thread.h"
54 #include "automation_controller.h"
55 #include "gain_meter.h"
57 #include "ui_config.h"
62 using namespace ARDOUR;
64 using namespace Gtkmm2ext;
65 using namespace ArdourWidgets;
67 using namespace ARDOUR_UI_UTILS;
69 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
72 , is_scrollable(scrollable)
74 set_name ("PluginEditor");
75 set_border_width (10);
76 //set_homogeneous (false);
78 pack_start (main_contents, true, true);
79 settings_box.set_homogeneous (false);
81 HBox* constraint_hbox = manage (new HBox);
82 HBox* smaller_hbox = manage (new HBox);
83 HBox* automation_hbox = manage (new HBox);
84 smaller_hbox->set_spacing (4);
85 automation_hbox->set_spacing (6);
86 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
87 combo_label->set_use_markup (true);
89 latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
92 smaller_hbox->pack_start (latency_button, false, false, 4);
93 smaller_hbox->pack_start (pin_management_button, false, false, 4);
94 smaller_hbox->pack_start (_preset_combo, false, false);
95 smaller_hbox->pack_start (_preset_modified, false, false);
96 smaller_hbox->pack_start (add_button, false, false);
97 smaller_hbox->pack_start (save_button, false, false);
98 smaller_hbox->pack_start (delete_button, false, false);
99 smaller_hbox->pack_start (reset_button, false, false, 4);
100 smaller_hbox->pack_start (bypass_button, false, true, 4);
102 automation_manual_all_button.set_text(_("Manual"));
103 automation_manual_all_button.set_name (X_("generic button"));
104 automation_play_all_button.set_text(_("Play"));
105 automation_play_all_button.set_name (X_("generic button"));
106 automation_write_all_button.set_text(_("Write"));
107 automation_write_all_button.set_name (X_("generic button"));
108 automation_touch_all_button.set_text(_("Touch"));
109 automation_touch_all_button.set_name (X_("generic button"));
111 Label* l = manage (new Label (_("All Automation")));
112 l->set_alignment (1.0, 0.5);
113 automation_hbox->pack_start (*l, true, true);
114 automation_hbox->pack_start (automation_manual_all_button, false, false);
115 automation_hbox->pack_start (automation_play_all_button, false, false);
116 automation_hbox->pack_start (automation_write_all_button, false, false);
117 automation_hbox->pack_start (automation_touch_all_button, false, false);
119 constraint_hbox->set_spacing (5);
120 constraint_hbox->set_homogeneous (false);
122 VBox* v1_box = manage (new VBox);
123 VBox* v2_box = manage (new VBox);
124 pack_end (plugin_analysis_expander, false, false);
125 if (!plugin->get_docs().empty()) {
126 pack_end (description_expander, false, false);
129 v1_box->set_spacing (6);
130 v1_box->pack_start (*smaller_hbox, false, true);
131 v1_box->pack_start (*automation_hbox, false, true);
132 v2_box->pack_start (focus_button, false, true);
134 main_contents.pack_start (settings_box, false, false);
136 constraint_hbox->pack_end (*v2_box, false, false);
137 constraint_hbox->pack_end (*v1_box, false, false);
139 main_contents.pack_start (*constraint_hbox, false, false);
142 Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow());
143 scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
144 scroller->set_name ("PluginEditor");
145 scroller->add (hpacker);
146 main_contents.pack_start (*scroller, true, true);
148 main_contents.pack_start (hpacker, false, false);
151 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
153 bypass_button.set_active (!pi->enabled());
158 /* Listen for property changes that are not notified normally because
159 * AutomationControl has only support for numeric values currently.
160 * The only case is Variant::PATH for now */
161 plugin->PropertyChanged.connect(*this, invalidator(*this),
162 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
165 main_contents.show ();
168 GenericPluginUI::~GenericPluginUI ()
170 if (output_controls.size() > 0) {
171 screen_update_connection.disconnect();
175 // Some functions for calculating the 'similarity' of two plugin
178 static int get_number(string label) {
179 static const char *digits = "0123456789";
182 std::size_t first_digit_pos = label.find_first_of(digits);
183 if (first_digit_pos != string::npos) {
184 // found some digits: there's a number in there somewhere
186 s << label.substr(first_digit_pos);
192 static int match_or_digit(char c1, char c2) {
193 return c1 == c2 || (isdigit(c1) && isdigit(c2));
196 static std::size_t matching_chars_at_head(const string s1, const string s2) {
197 std::size_t length, n = 0;
199 length = min(s1.length(), s2.length());
201 if (!match_or_digit(s1[n], s2[n]))
208 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
209 std::size_t s1pos, s2pos, n = 0;
213 while (s1pos-- > 0 && s2pos-- > 0) {
214 if (!match_or_digit(s1[s1pos], s2[s2pos]) )
221 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
222 static const float default_similarity_threshold = 0.3;
225 GenericPluginUI::build ()
227 std::vector<ControlUI *> control_uis;
228 bool grid = plugin->parameter_count() > 0;
230 // Build a ControlUI for each control port
231 for (size_t i = 0; i < plugin->parameter_count(); ++i) {
233 if (plugin->parameter_is_control (i)) {
235 /* Don't show latency control ports */
237 const Evoral::Parameter param(PluginAutomation, 0, i);
238 if (plugin->describe_parameter (param) == X_("latency")) {
242 if (plugin->describe_parameter (param) == X_("hidden")) {
246 const float value = plugin->get_parameter(i);
249 Plugin::UILayoutHint hint;
251 if (!plugin->get_layout(i, hint)) {
255 boost::shared_ptr<ARDOUR::AutomationControl> c
256 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
257 insert->control(param));
259 ParameterDescriptor desc;
260 plugin->get_parameter_descriptor(i, desc);
261 if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
262 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
273 const std::string param_docs = plugin->get_parameter_docs(i);
274 if (!param_docs.empty()) {
275 set_tooltip(cui, param_docs.c_str());
278 control_uis.push_back(cui);
282 // Build a ControlUI for each property
283 const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
284 for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
285 const ParameterDescriptor& desc = d->second;
286 const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key);
288 boost::shared_ptr<ARDOUR::AutomationControl> c
289 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
290 insert->control(param));
293 error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
297 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
299 error << string_compose(_("Plugin Editor: could not build control element for property %1"),
304 control_uis.push_back(cui);
306 if (!descs.empty()) {
307 plugin->announce_property_values();
311 custom_layout (control_uis);
313 automatic_layout (control_uis);
318 automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
319 automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
320 automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
321 automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
323 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
324 plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
329 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
333 static const int32_t initial_button_rows = 12;
334 static const int32_t initial_button_cols = 1;
335 static const int32_t initial_output_rows = 1;
336 static const int32_t initial_output_cols = 4;
338 Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
339 Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
344 int output_row, output_col;
345 int button_row, button_col;
346 int output_rows, output_cols;
347 int button_rows, button_cols;
349 hpacker.set_spacing (10);
350 hpacker.set_border_width (10);
352 output_rows = initial_output_rows;
353 output_cols = initial_output_cols;
354 button_rows = initial_button_rows;
355 button_cols = initial_button_cols;
361 button_table->set_homogeneous (false);
362 button_table->set_row_spacings (2);
363 button_table->set_col_spacings (2);
364 output_table->set_homogeneous (true);
365 output_table->set_row_spacings (2);
366 output_table->set_col_spacings (2);
367 button_table->set_border_width (5);
368 output_table->set_border_width (5);
371 bt_frame = manage (new Frame);
372 bt_frame->set_name ("BaseFrame");
373 bt_frame->set_label (_("Switches"));
374 bt_frame->add (*button_table);
375 hpacker.pack_start(*bt_frame, true, true);
377 box = manage (new VBox);
378 box->set_border_width (5);
379 box->set_spacing (1);
381 frame = manage (new Frame);
382 frame->set_name ("BaseFrame");
383 frame->set_label (_("Controls"));
385 hpacker.pack_start(*frame, true, true);
387 // Add special controls to UI, and build list of normal controls to be layed out later
388 std::vector<ControlUI *> cui_controls_list;
389 for (size_t i = 0; i < control_uis.size(); ++i) {
390 ControlUI* cui = control_uis[i];
392 if (cui->button || cui->file_button) {
394 if (!is_scrollable && button_row == button_rows) {
396 if (++button_col == button_cols) {
398 button_table->resize (button_rows, button_cols);
402 button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
406 } else if (cui->controller || cui->clickbox || cui->combo) {
407 // Get all of the controls into a list, so that
408 // we can lay them out a bit more nicely later.
409 cui_controls_list.push_back(cui);
411 } else if (cui->display) {
413 output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
416 // TODO: The meters should be divided into multiple rows
418 if (++output_col == output_cols) {
420 output_table->resize (output_rows, output_cols);
425 // Iterate over the list of controls to find which adjacent controls
426 // are similar enough to be grouped together.
428 string label, previous_label = "";
429 std::vector<int> numbers_in_labels(cui_controls_list.size());
431 std::vector<float> similarity_scores(cui_controls_list.size());
432 float most_similar = 0.0, least_similar = 1.0;
435 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
436 label = (*cuip)->label.get_text();
437 numbers_in_labels[i] = get_number(label);
440 // A hand-wavy calculation of how similar this control's
441 // label is to the previous.
442 similarity_scores[i] =
444 ( matching_chars_at_head(label, previous_label) +
445 matching_chars_at_tail(label, previous_label) +
448 ) / (label.length() + previous_label.length());
449 if (numbers_in_labels[i] >= 0) {
450 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
452 least_similar = min(least_similar, similarity_scores[i]);
453 most_similar = max(most_similar, similarity_scores[i]);
455 similarity_scores[0] = 1.0;
458 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
459 previous_label = label;
463 // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
464 float similarity_threshold;
466 if (most_similar > 1.0) {
467 similarity_threshold = default_similarity_threshold;
469 similarity_threshold = most_similar - (1 - default_similarity_threshold);
472 // Now iterate over the list of controls to display them, placing an
473 // HSeparator between controls of less than a certain similarity, and
474 // starting a new column when necessary.
477 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
479 ControlUI* cui = *cuip;
481 if (!is_scrollable) {
485 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
486 if (x > min_controls_per_column) {
487 frame = manage (new Frame);
488 frame->set_name ("BaseFrame");
489 frame->set_label (_("Controls"));
490 box = manage (new VBox);
491 box->set_border_width (5);
492 box->set_spacing (1);
494 hpacker.pack_start(*frame, true, true);
497 HSeparator *split = new HSeparator();
498 split->set_size_request(-1, 5);
499 box->pack_start(*split, false, false, 0);
503 box->pack_start (*cui, false, false);
510 if (box->children().empty()) {
511 hpacker.remove (*frame);
514 if (button_table->children().empty()) {
515 hpacker.remove (*bt_frame);
518 button_table->show_all ();
521 if (!output_table->children().empty()) {
522 frame = manage (new Frame);
523 frame->set_name ("BaseFrame");
524 frame->set_label(_("Meters"));
525 frame->add (*output_table);
526 hpacker.pack_end (*frame, true, true);
527 output_table->show_all ();
532 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
533 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
534 hpacker.pack_end (*pd, true, true);
541 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
543 Gtk::Table* layout = manage (new Gtk::Table ());
545 for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
547 if (cui->x0 < 0 || cui->y0 < 0) {
550 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
552 hpacker.pack_start (*layout, true, true);
554 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
555 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
556 hpacker.pack_end (*pd, true, true);
560 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
562 , automate_button (X_("")) // force creation of a label
573 automate_button.set_name ("plugin automation state button");
574 set_tooltip (automate_button, _("Automation control"));
576 /* XXX translators: use a string here that will be at least as long
577 as the longest automation label (see ::automation_state_changed()
578 below). be sure to include a descender.
581 automate_button.set_sizing_text(_("Mgnual"));
583 ignore_change = false;
584 update_pending = false;
587 x0 = x1 = y0 = y1 = -1;
590 GenericPluginUI::ControlUI::~ControlUI()
593 delete meterinfo->meter;
599 GenericPluginUI::automation_state_changed (ControlUI* cui)
601 /* update button label */
603 // don't lock to avoid deadlock because we're triggered by
604 // AutomationControl::Changed() while the automation lock is taken
606 AutoState state = insert->get_parameter_automation_state (cui->parameter());
608 cui->automate_button.set_active((state != ARDOUR::Off));
610 if (cui->knobtable) {
611 cui->automate_button.set_text (
612 GainMeterBase::astate_string (state));
616 switch (state & (ARDOUR::Off|Play|Touch|Write)) {
618 cui->automate_button.set_text (S_("Automation|Manual"));
621 cui->automate_button.set_text (_("Play"));
624 cui->automate_button.set_text (_("Write"));
627 cui->automate_button.set_text (_("Touch"));
630 cui->automate_button.set_text (_("???"));
636 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
638 float const v = cui->control->interface_to_internal(adj.get_value ());
639 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
640 const size_t len = str.copy(buf, 31);
646 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
648 float const v = cui->control->interface_to_internal(adj.get_value ());
649 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
650 const size_t len = str.copy(buf, 31);
656 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
658 plugin->print_parameter (param, buf, len);
661 /** Build a ControlUI for a parameter/property.
662 * Note that mcontrol may be NULL for outputs.
664 GenericPluginUI::ControlUI*
665 GenericPluginUI::build_control_ui (const Evoral::Parameter& param,
666 const ParameterDescriptor& desc,
667 boost::shared_ptr<AutomationControl> mcontrol,
672 ControlUI* control_ui = 0;
674 control_ui = manage (new ControlUI (param));
675 control_ui->combo = 0;
676 control_ui->control = mcontrol;
677 control_ui->label.set_text (desc.label);
678 control_ui->label.set_alignment (0.0, 0.5);
679 control_ui->label.set_name ("PluginParameterLabel");
680 control_ui->set_spacing (5);
684 if (desc.datatype == Variant::PATH) {
686 /* We shouldn't get that type for input ports */
687 assert(param.type() == PluginPropertyAutomation);
689 /* Build a file selector button */
691 // Create/add controller
692 control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
693 control_ui->file_button->set_title(desc.label);
696 control_ui->knobtable = manage (new Table());
697 control_ui->pack_start(*control_ui->knobtable, true, false);
698 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
699 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
701 control_ui->pack_start (control_ui->label, false, true);
702 control_ui->pack_start (*control_ui->file_button, true, true);
705 // Monitor changes from the user.
706 control_ui->file_button->signal_file_set().connect(
707 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
708 desc, control_ui->file_button));
710 /* Add the filebutton control to a map so that we can update it when
711 * the corresponding property changes. This doesn't go through the usual
712 * AutomationControls, because they don't support non-numeric values. */
713 _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
720 /* See if there any named values for our input value */
721 control_ui->scale_points = desc.scale_points;
723 /* If this parameter is an integer, work out the number of distinct values
724 it can take on (assuming that lower and upper values are allowed).
726 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
728 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
731 * a) There is a label for each possible value of this input, or
732 * b) This port is marked as being an enumeration.
735 control_ui->combo = new ArdourDropdown();
736 for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
737 i != control_ui->scale_points->end();
739 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
741 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
746 control_ui->combo->set_controllable (mcontrol);
748 update_control_display(control_ui);
752 /* create the controller */
754 /* XXX memory leak: SliderController not destroyed by ControlUI
755 * destructor, and manage() reports object hierarchy
758 control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
760 /* Control UI's don't need the rapid timer workaround */
761 control_ui->controller->stop_updating ();
763 /* XXX this code is not right yet, because it doesn't handle
764 the absence of bounds in any sensible fashion.
767 Adjustment* adj = control_ui->controller->adjustment();
769 if (desc.integer_step && !desc.toggled) {
770 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
771 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
772 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
773 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
775 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
777 control_ui->clickbox->set_controllable (mcontrol);
778 } else if (desc.toggled) {
779 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
781 but->set_tweaks(ArdourButton::Square);
782 } else if (use_knob) {
783 /* Delay size request so that styles are gotten right */
784 control_ui->controller->widget()->signal_size_request().connect(
785 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
787 control_ui->controller->set_size_request (200, -1);
788 control_ui->controller->set_name (X_("ProcessorControlSlider"));
791 if (!desc.integer_step && !desc.toggled && use_knob) {
792 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
795 adj->set_value (mcontrol->internal_to_interface(value));
800 control_ui->automate_button.set_sizing_text("M");
802 control_ui->label.set_alignment (0.5, 0.5);
803 control_ui->knobtable = manage (new Table());
804 control_ui->pack_start(*control_ui->knobtable, true, true);
806 if (control_ui->combo) {
807 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
808 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
809 } else if (control_ui->clickbox) {
810 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
811 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
812 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
813 } else if (control_ui->spin_box) {
814 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
815 knob->set_tooltip_prefix (desc.label + ": ");
816 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
817 align->add (*control_ui->controller);
818 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
819 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
820 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
821 } else if (desc.toggled) {
822 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
823 align->add (*control_ui->controller);
824 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
825 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
826 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
828 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
829 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
830 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
835 control_ui->pack_start (control_ui->label, true, true);
836 if (control_ui->combo) {
837 control_ui->pack_start(*control_ui->combo, false, true);
838 } else if (control_ui->clickbox) {
839 control_ui->pack_start (*control_ui->clickbox, false, false);
840 } else if (control_ui->spin_box) {
841 control_ui->pack_start (*control_ui->spin_box, false, false);
842 control_ui->pack_start (*control_ui->controller, false, false);
844 control_ui->pack_start (*control_ui->controller, false, false);
846 control_ui->pack_start (control_ui->automate_button, false, false);
850 if (mcontrol->flags () & Controllable::NotAutomatable) {
851 control_ui->automate_button.set_sensitive (false);
852 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
854 control_ui->automate_button.signal_button_press_event().connect (
855 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
858 mcontrol->alist()->automation_state_changed.connect (
861 boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
863 input_controls_with_automation.push_back (control_ui);
866 if (desc.toggled && !control_ui->combo) {
867 control_ui->button = true;
868 ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
870 but->set_name ("pluginui toggle");
871 update_control_display(control_ui);
874 automation_state_changed (control_ui);
876 /* Add to the list of CUIs that need manual update to workaround
877 * AutomationControl not knowing about preset loads */
878 input_controls.push_back (control_ui);
882 control_ui->display = manage (new EventBox);
883 control_ui->display->set_name ("ParameterValueDisplay");
885 control_ui->display_label = manage (new Label);
887 control_ui->display_label->set_name ("ParameterValueDisplay");
889 control_ui->display->add (*control_ui->display_label);
890 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
892 control_ui->display->show_all ();
894 control_ui->vbox = manage (new VBox);
895 control_ui->vbox->set_spacing(3);
897 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
898 control_ui->vbox->pack_end (*control_ui->display, false, false);
899 control_ui->vbox->pack_end (control_ui->label, false, false);
900 } else if (desc.integer_step || desc.enumeration) {
901 control_ui->vbox->pack_end (*control_ui->display, false, false);
902 control_ui->vbox->pack_end (control_ui->label, false, false);
904 /* set up a meter for float ports */
906 MeterInfo * info = new MeterInfo();
907 control_ui->meterinfo = info;
909 info->meter = new FastMeter (
910 5, 5, FastMeter::Vertical, 0,
912 0x008800ff, 0x008800ff,
913 0x00ff00ff, 0x00ff00ff,
914 0xcccc00ff, 0xcccc00ff,
915 0xffaa00ff, 0xffaa00ff,
917 UIConfiguration::instance().color ("meter background bottom"),
918 UIConfiguration::instance().color ("meter background top")
921 control_ui->label.set_angle(90);
923 HBox* center = manage (new HBox);
924 center->set_spacing(1);
925 center->pack_start (control_ui->label, false, false);
926 center->pack_start (*info->meter, false, false);
928 control_ui->hbox = manage (new HBox);
929 control_ui->hbox->pack_start (*center, true, false);
931 // horizontally center this hbox in the vbox
932 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
934 control_ui->meterinfo->meter->show_all();
935 control_ui->meterinfo->packed = true;
936 control_ui->vbox->pack_start (*control_ui->display, false, false);
939 control_ui->pack_start (*control_ui->vbox);
941 output_controls.push_back (control_ui);
945 mcontrol->Changed.connect(control_connections, invalidator(*this),
946 boost::bind(&GenericPluginUI::ui_parameter_changed,
955 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
956 Gtk::Requisition astate_req (cui->automate_button.size_request());
957 const int size = (int) (astate_req.height * 1.5);
958 req->width = max(req->width, size);
959 req->height = max(req->height, size);
964 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
966 if (ev->button != 1) {
970 using namespace Menu_Helpers;
972 if (automation_menu == 0) {
973 automation_menu = manage (new Menu);
974 automation_menu->set_name ("ArdourContextMenu");
975 automation_menu->set_reserve_toggle_size(false);
978 MenuList& items (automation_menu->items());
981 items.push_back (MenuElem (S_("Automation|Manual"),
982 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
983 items.push_back (MenuElem (_("Play"),
984 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
985 items.push_back (MenuElem (_("Write"),
986 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
987 items.push_back (MenuElem (_("Touch"),
988 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
990 anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
997 GenericPluginUI::set_all_automation (AutoState as)
999 for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1000 set_automation_state (as, (*i));
1005 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1007 insert->set_parameter_automation_state (cui->parameter(), state);
1011 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1013 if (!cui->update_pending) {
1014 cui->update_pending = true;
1015 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1020 GenericPluginUI::update_control_display (ControlUI* cui)
1022 /* XXX how do we handle logarithmic stuff here ? */
1024 cui->update_pending = false;
1026 float val = cui->control->get_value();
1028 PBD::Unwinder<bool> (cui->ignore_change, true);
1030 if (cui->combo && cui->scale_points) {
1031 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1032 if (it->second == val) {
1033 cui->combo->set_text(it->first);
1037 } else if (cui->button) {
1038 // AutomationController handles this
1041 if( cui->controller ) {
1042 cui->controller->display_effective_value();
1047 if (cui->logarithmic) {
1050 if (val != cui->adjustment->get_value()) {
1051 cui->adjustment->set_value (val);
1057 GenericPluginUI::update_input_displays ()
1059 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1060 for (vector<ControlUI*>::iterator i = input_controls.begin();
1061 i != input_controls.end();
1063 update_control_display(*i);
1069 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1071 if (!cui->ignore_change) {
1072 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1077 GenericPluginUI::start_updating (GdkEventAny*)
1079 if (output_controls.size() > 0 ) {
1080 screen_update_connection.disconnect();
1081 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1087 GenericPluginUI::stop_updating (GdkEventAny*)
1089 if (output_controls.size() > 0 ) {
1090 screen_update_connection.disconnect();
1096 GenericPluginUI::output_update ()
1098 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1099 float val = plugin->get_parameter ((*i)->parameter().id());
1101 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1102 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1103 size_t len = str.copy(buf, 31);
1105 (*i)->display_label->set_text (buf);
1107 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1108 (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1114 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1115 Gtk::FileChooserButton* widget)
1117 plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1121 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1123 FilePathControls::iterator c = _filepath_controls.find(key);
1124 if (c != _filepath_controls.end()) {
1125 c->second->set_filename(value.get_path());
1127 std::cerr << "warning: property change for property with no control" << std::endl;