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 "pbd/stl_delete.h"
31 #include "pbd/unwind.h"
32 #include "pbd/xml++.h"
33 #include "pbd/failed_constructor.h"
35 #include <gtkmm2ext/click_box.h>
36 #include <gtkmm2ext/fastmeter.h>
37 #include <gtkmm2ext/barcontroller.h>
38 #include <gtkmm2ext/utils.h>
39 #include <gtkmm2ext/doi.h>
40 #include <gtkmm2ext/slider_controller.h>
42 #include "ardour/plugin.h"
43 #include "ardour/plugin_insert.h"
44 #include "ardour/session.h"
45 #include "ardour/value_as_string.h"
48 #include "plugin_ui.h"
49 #include "gui_thread.h"
50 #include "automation_controller.h"
51 #include "ardour_knob.h"
52 #include "gain_meter.h"
55 #include "ui_config.h"
60 using namespace ARDOUR;
62 using namespace Gtkmm2ext;
64 using namespace ARDOUR_UI_UTILS;
66 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
69 , is_scrollable(scrollable)
71 set_name ("PluginEditor");
72 set_border_width (10);
73 //set_homogeneous (false);
75 pack_start (main_contents, true, true);
76 settings_box.set_homogeneous (false);
78 HBox* constraint_hbox = manage (new HBox);
79 HBox* smaller_hbox = manage (new HBox);
80 HBox* automation_hbox = manage (new HBox);
81 smaller_hbox->set_spacing (4);
82 automation_hbox->set_spacing (6);
83 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
84 combo_label->set_use_markup (true);
86 latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
89 smaller_hbox->pack_start (latency_button, false, false, 4);
90 smaller_hbox->pack_start (_preset_combo, false, false);
91 smaller_hbox->pack_start (_preset_modified, false, false);
92 smaller_hbox->pack_start (add_button, false, false);
93 smaller_hbox->pack_start (save_button, false, false);
94 smaller_hbox->pack_start (delete_button, false, false);
95 smaller_hbox->pack_start (reset_button, false, false, 4);
96 smaller_hbox->pack_start (bypass_button, false, true, 4);
98 automation_manual_all_button.set_text(_("Manual"));
99 automation_manual_all_button.set_name (X_("generic button"));
100 automation_play_all_button.set_text(_("Play"));
101 automation_play_all_button.set_name (X_("generic button"));
102 automation_write_all_button.set_text(_("Write"));
103 automation_write_all_button.set_name (X_("generic button"));
104 automation_touch_all_button.set_text(_("Touch"));
105 automation_touch_all_button.set_name (X_("generic button"));
107 Label* l = manage (new Label (_("All Automation")));
108 l->set_alignment (1.0, 0.5);
109 automation_hbox->pack_start (*l, true, true);
110 automation_hbox->pack_start (automation_manual_all_button, false, false);
111 automation_hbox->pack_start (automation_play_all_button, false, false);
112 automation_hbox->pack_start (automation_write_all_button, false, false);
113 automation_hbox->pack_start (automation_touch_all_button, false, false);
115 constraint_hbox->set_spacing (5);
116 constraint_hbox->set_homogeneous (false);
118 VBox* v1_box = manage (new VBox);
119 VBox* v2_box = manage (new VBox);
120 pack_end (plugin_analysis_expander, false, false);
121 if (!plugin->get_docs().empty()) {
122 pack_end (description_expander, false, false);
125 v1_box->set_spacing (6);
126 v1_box->pack_start (*smaller_hbox, false, true);
127 v1_box->pack_start (*automation_hbox, false, true);
128 v2_box->pack_start (focus_button, false, true);
130 main_contents.pack_start (settings_box, false, false);
132 constraint_hbox->pack_end (*v2_box, false, false);
133 constraint_hbox->pack_end (*v1_box, false, false);
135 main_contents.pack_start (*constraint_hbox, false, false);
138 Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow());
139 scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
140 scroller->set_name ("PluginEditor");
141 scroller->add (hpacker);
142 main_contents.pack_start (*scroller, true, true);
144 main_contents.pack_start (hpacker, false, false);
147 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
149 bypass_button.set_active (!pi->enabled());
153 main_contents.show ();
156 GenericPluginUI::~GenericPluginUI ()
158 if (output_controls.size() > 0) {
159 screen_update_connection.disconnect();
163 // Some functions for calculating the 'similarity' of two plugin
166 static int get_number(string label) {
167 static const char *digits = "0123456789";
170 std::size_t first_digit_pos = label.find_first_of(digits);
171 if (first_digit_pos != string::npos) {
172 // found some digits: there's a number in there somewhere
174 s << label.substr(first_digit_pos);
180 static int match_or_digit(char c1, char c2) {
181 return c1 == c2 || (isdigit(c1) && isdigit(c2));
184 static std::size_t matching_chars_at_head(const string s1, const string s2) {
185 std::size_t length, n = 0;
187 length = min(s1.length(), s2.length());
189 if (!match_or_digit(s1[n], s2[n]))
196 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
197 std::size_t s1pos, s2pos, n = 0;
201 while (s1pos-- > 0 && s2pos-- > 0) {
202 if (!match_or_digit(s1[s1pos], s2[s2pos]) )
209 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
210 static const float default_similarity_threshold = 0.3;
213 GenericPluginUI::build ()
215 std::vector<ControlUI *> control_uis;
218 // Build a ControlUI for each control port
219 for (size_t i = 0; i < plugin->parameter_count(); ++i) {
221 if (plugin->parameter_is_control (i)) {
223 /* Don't show latency control ports */
225 const Evoral::Parameter param(PluginAutomation, 0, i);
226 if (plugin->describe_parameter (param) == X_("latency")) {
230 if (plugin->describe_parameter (param) == X_("hidden")) {
234 const float value = plugin->get_parameter(i);
237 Plugin::UILayoutHint hint;
239 if (!plugin->get_layout(i, hint)) {
243 boost::shared_ptr<ARDOUR::AutomationControl> c
244 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
245 insert->control(param));
247 ParameterDescriptor desc;
248 plugin->get_parameter_descriptor(i, desc);
249 if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
250 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
261 const std::string param_docs = plugin->get_parameter_docs(i);
262 if (!param_docs.empty()) {
263 set_tooltip(cui, param_docs.c_str());
266 control_uis.push_back(cui);
267 input_controls_with_automation.push_back (cui);
271 // Build a ControlUI for each property
272 const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
273 for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
274 const ParameterDescriptor& desc = d->second;
275 const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key);
277 boost::shared_ptr<ARDOUR::AutomationControl> c
278 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
279 insert->control(param));
282 error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
286 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
288 error << string_compose(_("Plugin Editor: could not build control element for property %1"),
293 control_uis.push_back(cui);
295 if (!descs.empty()) {
296 plugin->announce_property_values();
300 custom_layout (control_uis);
302 automatic_layout (control_uis);
307 automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
308 automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
309 automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
310 automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
315 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
319 static const int32_t initial_button_rows = 12;
320 static const int32_t initial_button_cols = 1;
321 static const int32_t initial_output_rows = 1;
322 static const int32_t initial_output_cols = 4;
324 Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
325 Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
330 int output_row, output_col;
331 int button_row, button_col;
332 int output_rows, output_cols;
333 int button_rows, button_cols;
335 hpacker.set_spacing (10);
336 hpacker.set_border_width (10);
338 output_rows = initial_output_rows;
339 output_cols = initial_output_cols;
340 button_rows = initial_button_rows;
341 button_cols = initial_button_cols;
347 button_table->set_homogeneous (false);
348 button_table->set_row_spacings (2);
349 button_table->set_col_spacings (2);
350 output_table->set_homogeneous (true);
351 output_table->set_row_spacings (2);
352 output_table->set_col_spacings (2);
353 button_table->set_border_width (5);
354 output_table->set_border_width (5);
357 bt_frame = manage (new Frame);
358 bt_frame->set_name ("BaseFrame");
359 bt_frame->set_label (_("Switches"));
360 bt_frame->add (*button_table);
361 hpacker.pack_start(*bt_frame, true, true);
363 box = manage (new VBox);
364 box->set_border_width (5);
365 box->set_spacing (1);
367 frame = manage (new Frame);
368 frame->set_name ("BaseFrame");
369 frame->set_label (_("Controls"));
371 hpacker.pack_start(*frame, true, true);
373 // Add special controls to UI, and build list of normal controls to be layed out later
374 std::vector<ControlUI *> cui_controls_list;
375 for (size_t i = 0; i < control_uis.size(); ++i) {
376 ControlUI* cui = control_uis[i];
378 if (cui->button || cui->file_button) {
380 if (!is_scrollable && button_row == button_rows) {
382 if (++button_col == button_cols) {
384 button_table->resize (button_rows, button_cols);
388 button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
392 } else if (cui->controller || cui->clickbox || cui->combo) {
393 // Get all of the controls into a list, so that
394 // we can lay them out a bit more nicely later.
395 cui_controls_list.push_back(cui);
397 } else if (cui->display) {
399 output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
402 // TODO: The meters should be divided into multiple rows
404 if (++output_col == output_cols) {
406 output_table->resize (output_rows, output_cols);
411 // Iterate over the list of controls to find which adjacent controls
412 // are similar enough to be grouped together.
414 string label, previous_label = "";
415 std::vector<int> numbers_in_labels(cui_controls_list.size());
417 std::vector<float> similarity_scores(cui_controls_list.size());
418 float most_similar = 0.0, least_similar = 1.0;
421 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
422 label = (*cuip)->label.get_text();
423 numbers_in_labels[i] = get_number(label);
426 // A hand-wavy calculation of how similar this control's
427 // label is to the previous.
428 similarity_scores[i] =
430 ( matching_chars_at_head(label, previous_label) +
431 matching_chars_at_tail(label, previous_label) +
434 ) / (label.length() + previous_label.length());
435 if (numbers_in_labels[i] >= 0) {
436 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
438 least_similar = min(least_similar, similarity_scores[i]);
439 most_similar = max(most_similar, similarity_scores[i]);
441 similarity_scores[0] = 1.0;
444 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
445 previous_label = label;
449 // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
450 float similarity_threshold;
452 if (most_similar > 1.0) {
453 similarity_threshold = default_similarity_threshold;
455 similarity_threshold = most_similar - (1 - default_similarity_threshold);
458 // Now iterate over the list of controls to display them, placing an
459 // HSeparator between controls of less than a certain similarity, and
460 // starting a new column when necessary.
463 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
465 ControlUI* cui = *cuip;
467 if (!is_scrollable) {
471 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
472 if (x > min_controls_per_column) {
473 frame = manage (new Frame);
474 frame->set_name ("BaseFrame");
475 frame->set_label (_("Controls"));
476 box = manage (new VBox);
477 box->set_border_width (5);
478 box->set_spacing (1);
480 hpacker.pack_start(*frame, true, true);
483 HSeparator *split = new HSeparator();
484 split->set_size_request(-1, 5);
485 box->pack_start(*split, false, false, 0);
489 box->pack_start (*cui, false, false);
496 if (box->children().empty()) {
497 hpacker.remove (*frame);
500 if (button_table->children().empty()) {
501 hpacker.remove (*bt_frame);
504 button_table->show_all ();
507 if (!output_table->children().empty()) {
508 frame = manage (new Frame);
509 frame->set_name ("BaseFrame");
510 frame->set_label(_("Meters"));
511 frame->add (*output_table);
512 hpacker.pack_end (*frame, true, true);
513 output_table->show_all ();
520 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
522 Gtk::Table* layout = manage (new Gtk::Table ());
524 for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
526 if (cui->x0 < 0 || cui->y0 < 0) {
529 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
531 hpacker.pack_start (*layout, true, true);
534 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
536 , automate_button (X_("")) // force creation of a label
547 automate_button.set_name ("PluginAutomateButton");
548 set_tooltip (automate_button, _("Automation control"));
550 /* XXX translators: use a string here that will be at least as long
551 as the longest automation label (see ::automation_state_changed()
552 below). be sure to include a descender.
555 set_size_request_to_display_given_text (automate_button, _("Mgnual"), 12, 6);
557 ignore_change = false;
558 update_pending = false;
561 x0 = x1 = y0 = y1 = -1;
564 GenericPluginUI::ControlUI::~ControlUI()
567 delete meterinfo->meter;
573 GenericPluginUI::automation_state_changed (ControlUI* cui)
575 /* update button label */
577 // don't lock to avoid deadlock because we're triggered by
578 // AutomationControl::Changed() while the automation lock is taken
580 if (cui->knobtable) {
581 cui->automate_button.set_text (
582 GainMeterBase::astate_string (
583 insert->get_parameter_automation_state (cui->parameter()))
588 switch (insert->get_parameter_automation_state (cui->parameter()) & (ARDOUR::Off|Play|Touch|Write)) {
590 cui->automate_button.set_text (S_("Automation|Manual"));
593 cui->automate_button.set_text (_("Play"));
596 cui->automate_button.set_text (_("Write"));
599 cui->automate_button.set_text (_("Touch"));
602 cui->automate_button.set_text (_("???"));
608 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
610 float const v = cui->control->interface_to_internal(adj.get_value ());
611 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
612 const size_t len = str.copy(buf, 31);
618 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
620 float const v = cui->control->interface_to_internal(adj.get_value ());
621 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
622 const size_t len = str.copy(buf, 31);
628 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
630 plugin->print_parameter (param, buf, len);
633 /** Build a ControlUI for a parameter/property.
634 * Note that mcontrol may be NULL for outputs.
636 GenericPluginUI::ControlUI*
637 GenericPluginUI::build_control_ui (const Evoral::Parameter& param,
638 const ParameterDescriptor& desc,
639 boost::shared_ptr<AutomationControl> mcontrol,
644 ControlUI* control_ui = 0;
646 control_ui = manage (new ControlUI (param));
647 control_ui->combo = 0;
648 control_ui->control = mcontrol;
649 control_ui->label.set_text (desc.label);
650 control_ui->label.set_alignment (0.0, 0.5);
651 control_ui->label.set_name ("PluginParameterLabel");
652 control_ui->set_spacing (5);
654 Gtk::Requisition req (control_ui->automate_button.size_request());
658 /* See if there any named values for our input value */
659 control_ui->scale_points = desc.scale_points;
661 /* If this parameter is an integer, work out the number of distinct values
662 it can take on (assuming that lower and upper values are allowed).
664 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
666 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
669 * a) There is a label for each possible value of this input, or
670 * b) This port is marked as being an enumeration.
673 std::vector<std::string> labels;
675 ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
676 i != control_ui->scale_points->end();
679 labels.push_back(i->first);
682 // TODO use ArdourDropDown
683 control_ui->combo = new Gtk::ComboBoxText();
684 set_popdown_strings(*control_ui->combo, labels);
685 control_ui->combo->signal_changed().connect(
686 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
688 mcontrol->Changed.connect(control_connections, invalidator(*this),
689 boost::bind(&GenericPluginUI::ui_parameter_changed,
694 control_ui->knobtable = manage (new Table());
695 control_ui->pack_start(*control_ui->knobtable, true, false);
696 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
697 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
699 control_ui->pack_start(control_ui->label, true, true);
700 control_ui->pack_start(*control_ui->combo, false, true);
703 update_control_display(control_ui);
708 if (desc.datatype == Variant::PATH) {
710 /* Build a file selector button */
712 // Create/add controller
713 control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
714 control_ui->file_button->set_title(desc.label);
717 control_ui->knobtable = manage (new Table());
718 control_ui->pack_start(*control_ui->knobtable, true, false);
719 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
720 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
722 control_ui->pack_start (control_ui->label, false, true);
723 control_ui->pack_start (*control_ui->file_button, true, true);
726 // Connect signals (TODO: do this via the Control)
727 control_ui->file_button->signal_file_set().connect(
728 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_property),
729 desc, control_ui->file_button));
730 plugin->PropertyChanged.connect(*this, invalidator(*this),
731 boost::bind(&GenericPluginUI::property_changed, this, _1, _2),
734 _property_controls.insert(std::make_pair(desc.key, control_ui->file_button));
735 control_ui->file_button = control_ui->file_button;
740 /* create the controller */
742 /* XXX memory leak: SliderController not destroyed by ControlUI
743 * destructor, and manage() reports object hierarchy
747 control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol, use_knob);
750 /* XXX this code is not right yet, because it doesn't handle
751 the absence of bounds in any sensible fashion.
754 Adjustment* adj = control_ui->controller->adjustment();
756 if (desc.integer_step && !desc.toggled) {
757 control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
758 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
759 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
760 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
762 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
764 } else if (desc.toggled) {
765 control_ui->controller->set_size_request (req.height, req.height);
766 } else if (use_knob) {
767 control_ui->controller->set_size_request (req.height * 1.5, req.height * 1.5);
769 control_ui->controller->set_size_request (200, req.height);
770 control_ui->controller->set_name (X_("ProcessorControlSlider"));
773 if (!desc.integer_step && !desc.toggled && use_knob) {
774 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj, insert));
777 adj->set_value (mcontrol->internal_to_interface(value));
780 set_size_request_to_display_given_text (control_ui->automate_button, "M", 2, 2);
782 control_ui->label.set_alignment (0.5, 0.5);
783 control_ui->knobtable = manage (new Table());
784 control_ui->pack_start(*control_ui->knobtable, true, true);
786 if (control_ui->clickbox) {
787 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
788 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
789 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
790 } else if (control_ui->spin_box) {
791 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
792 knob->set_tooltip_prefix (desc.label + ": ");
793 knob->set_printer (insert);
794 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
795 align->add (*control_ui->controller);
796 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
797 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
798 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
799 } else if (desc.toggled) {
800 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
801 align->add (*control_ui->controller);
802 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
803 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
804 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
806 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
807 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
808 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
813 control_ui->pack_start (control_ui->label, true, true);
814 if (control_ui->clickbox) {
815 control_ui->pack_start (*control_ui->clickbox, false, false);
816 } else if (control_ui->spin_box) {
817 control_ui->pack_start (*control_ui->spin_box, false, false);
818 control_ui->pack_start (*control_ui->controller, false, false);
820 control_ui->pack_start (*control_ui->controller, false, false);
822 control_ui->pack_start (control_ui->automate_button, false, false);
826 if (mcontrol->flags () & Controllable::NotAutomatable) {
827 control_ui->automate_button.set_sensitive (false);
828 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
830 control_ui->automate_button.signal_clicked.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
831 mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
835 control_ui->button = true;
836 ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
838 but->set_name ("pluginui toggle");
839 update_control_display(control_ui);
842 automation_state_changed (control_ui);
844 input_controls.push_back (control_ui);
845 input_controls_with_automation.push_back (control_ui);
847 } else if (!is_input) {
849 control_ui->display = manage (new EventBox);
850 control_ui->display->set_name ("ParameterValueDisplay");
852 control_ui->display_label = manage (new Label);
854 control_ui->display_label->set_name ("ParameterValueDisplay");
856 control_ui->display->add (*control_ui->display_label);
857 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
859 control_ui->display->show_all ();
861 control_ui->vbox = manage (new VBox);
862 control_ui->vbox->set_spacing(3);
864 if (desc.integer_step || desc.enumeration) {
865 control_ui->vbox->pack_end (*control_ui->display, false, false);
866 control_ui->vbox->pack_end (control_ui->label, false, false);
868 /* set up a meter for float ports */
870 MeterInfo * info = new MeterInfo();
871 control_ui->meterinfo = info;
873 info->meter = new FastMeter (
874 5, 5, FastMeter::Vertical, 0,
876 0x008800ff, 0x008800ff,
877 0x00ff00ff, 0x00ff00ff,
878 0xcccc00ff, 0xcccc00ff,
879 0xffaa00ff, 0xffaa00ff,
881 UIConfiguration::instance().color ("meter background bottom"),
882 UIConfiguration::instance().color ("meter background top")
885 info->min_unbound = desc.min_unbound;
886 info->max_unbound = desc.max_unbound;
888 info->min = desc.lower;
889 info->max = desc.upper;
891 control_ui->label.set_angle(90);
893 HBox* center = manage (new HBox);
894 center->set_spacing(1);
895 center->pack_start (control_ui->label, false, false);
896 center->pack_start (*info->meter, false, false);
898 control_ui->hbox = manage (new HBox);
899 control_ui->hbox->pack_start (*center, true, false);
901 // horizontally center this hbox in the vbox
902 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
904 control_ui->meterinfo->meter->show_all();
905 control_ui->meterinfo->packed = true;
906 control_ui->vbox->pack_start (*control_ui->display, false, false);
909 control_ui->pack_start (*control_ui->vbox);
911 output_controls.push_back (control_ui);
915 mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context());
922 GenericPluginUI::astate_clicked (ControlUI* cui)
924 using namespace Menu_Helpers;
926 if (automation_menu == 0) {
927 automation_menu = manage (new Menu);
928 automation_menu->set_name ("ArdourContextMenu");
931 MenuList& items (automation_menu->items());
934 items.push_back (MenuElem (S_("Automation|Manual"),
935 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
936 items.push_back (MenuElem (_("Play"),
937 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
938 items.push_back (MenuElem (_("Write"),
939 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
940 items.push_back (MenuElem (_("Touch"),
941 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
943 automation_menu->popup (1, gtk_get_current_event_time());
947 GenericPluginUI::set_all_automation (AutoState as)
949 for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
950 if ((*i)->controller || (*i)->button) {
951 set_automation_state (as, (*i));
957 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
959 insert->set_parameter_automation_state (cui->parameter(), state);
963 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
965 if (!cui->update_pending) {
966 cui->update_pending = true;
967 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
972 GenericPluginUI::update_control_display (ControlUI* cui)
974 /* XXX how do we handle logarithmic stuff here ? */
976 cui->update_pending = false;
978 float val = cui->control->get_value();
980 PBD::Unwinder<bool> (cui->ignore_change, true);
982 if (cui->combo && cui->scale_points) {
983 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
984 if (it->second == val) {
985 cui->combo->set_active_text(it->first);
989 } else if (cui->button) {
990 // AutomationController handles this
993 if( cui->controller ) {
994 cui->controller->display_effective_value();
999 if (cui->logarithmic) {
1002 if (val != cui->adjustment->get_value()) {
1003 cui->adjustment->set_value (val);
1009 GenericPluginUI::control_combo_changed (ControlUI* cui)
1011 if (!cui->ignore_change && cui->scale_points) {
1012 string value = cui->combo->get_active_text();
1013 insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value], Controllable::NoGroup);
1018 GenericPluginUI::start_updating (GdkEventAny*)
1020 if (output_controls.size() > 0 ) {
1021 screen_update_connection.disconnect();
1022 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1028 GenericPluginUI::stop_updating (GdkEventAny*)
1030 for (vector<ControlUI*>::iterator i = input_controls.begin(); i != input_controls.end(); ++i) {
1031 (*i)->controller->stop_updating ();
1034 if (output_controls.size() > 0 ) {
1035 screen_update_connection.disconnect();
1042 GenericPluginUI::output_update ()
1044 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1045 float val = plugin->get_parameter ((*i)->parameter().id());
1047 snprintf (buf, sizeof(buf), "%.2f", val);
1048 (*i)->display_label->set_text (buf);
1050 /* autoscaling for the meter */
1051 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1053 if (val < (*i)->meterinfo->min) {
1054 if ((*i)->meterinfo->min_unbound)
1055 (*i)->meterinfo->min = val;
1057 val = (*i)->meterinfo->min;
1060 if (val > (*i)->meterinfo->max) {
1061 if ((*i)->meterinfo->max_unbound)
1062 (*i)->meterinfo->max = val;
1064 val = (*i)->meterinfo->max;
1067 if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
1068 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
1069 (*i)->meterinfo->meter->set (lval );
1076 GenericPluginUI::set_property (const ParameterDescriptor& desc,
1077 Gtk::FileChooserButton* widget)
1079 plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1083 GenericPluginUI::property_changed (uint32_t key, const Variant& value)
1085 PropertyControls::iterator c = _property_controls.find(key);
1086 if (c != _property_controls.end()) {
1087 c->second->set_filename(value.get_path());
1089 std::cerr << "warning: property change for property with no control" << std::endl;