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 "evoral/midi_events.h"
38 #include "evoral/PatchChange.hpp"
40 #include "midi++/midnam_patch.h"
42 #include "ardour/midi_patch_manager.h"
43 #include "ardour/midi_track.h"
44 #include "ardour/plugin.h"
45 #include "ardour/plugin_insert.h"
46 #include "ardour/session.h"
47 #include "ardour/value_as_string.h"
49 #include "gtkmm2ext/menu_elems.h"
50 #include "gtkmm2ext/utils.h"
51 #include "gtkmm2ext/doi.h"
53 #include "widgets/ardour_knob.h"
54 #include "widgets/click_box.h"
55 #include "widgets/fastmeter.h"
56 #include "widgets/slider_controller.h"
57 #include "widgets/tooltips.h"
59 #include "plugin_ui.h"
60 #include "plugin_display.h"
61 #include "gui_thread.h"
62 #include "automation_controller.h"
63 #include "gain_meter.h"
65 #include "ui_config.h"
70 using namespace ARDOUR;
72 using namespace Gtkmm2ext;
73 using namespace ArdourWidgets;
75 using namespace ARDOUR_UI_UTILS;
77 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
80 , is_scrollable(scrollable)
82 set_name ("PluginEditor");
83 set_border_width (10);
84 //set_homogeneous (false);
86 pack_start (main_contents, true, true);
87 settings_box.set_homogeneous (false);
89 HBox* constraint_hbox = manage (new HBox);
90 HBox* smaller_hbox = manage (new HBox);
91 HBox* automation_hbox = manage (new HBox);
92 smaller_hbox->set_spacing (4);
93 automation_hbox->set_spacing (6);
94 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
95 combo_label->set_use_markup (true);
97 latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
100 smaller_hbox->pack_start (latency_button, false, false, 4);
101 smaller_hbox->pack_start (pin_management_button, false, false, 4);
102 smaller_hbox->pack_start (_preset_combo, false, false);
103 smaller_hbox->pack_start (_preset_modified, false, false);
104 smaller_hbox->pack_start (add_button, false, false);
105 smaller_hbox->pack_start (save_button, false, false);
106 smaller_hbox->pack_start (delete_button, false, false);
107 smaller_hbox->pack_start (reset_button, false, false, 4);
108 smaller_hbox->pack_start (bypass_button, false, true, 4);
110 automation_manual_all_button.set_text(_("Manual"));
111 automation_manual_all_button.set_name (X_("generic button"));
112 automation_play_all_button.set_text(_("Play"));
113 automation_play_all_button.set_name (X_("generic button"));
114 automation_write_all_button.set_text(_("Write"));
115 automation_write_all_button.set_name (X_("generic button"));
116 automation_touch_all_button.set_text(_("Touch"));
117 automation_touch_all_button.set_name (X_("generic button"));
119 Label* l = manage (new Label (_("All Automation")));
120 l->set_alignment (1.0, 0.5);
121 automation_hbox->pack_start (*l, true, true);
122 automation_hbox->pack_start (automation_manual_all_button, false, false);
123 automation_hbox->pack_start (automation_play_all_button, false, false);
124 automation_hbox->pack_start (automation_write_all_button, false, false);
125 automation_hbox->pack_start (automation_touch_all_button, false, false);
127 constraint_hbox->set_spacing (5);
128 constraint_hbox->set_homogeneous (false);
130 VBox* v1_box = manage (new VBox);
131 VBox* v2_box = manage (new VBox);
132 pack_end (plugin_analysis_expander, false, false);
133 if (!plugin->get_docs().empty()) {
134 pack_end (description_expander, false, false);
137 v1_box->set_spacing (6);
138 v1_box->pack_start (*smaller_hbox, false, true);
139 v1_box->pack_start (*automation_hbox, false, true);
140 v2_box->pack_start (focus_button, false, true);
142 main_contents.pack_start (settings_box, false, false);
144 constraint_hbox->pack_end (*v2_box, false, false);
145 constraint_hbox->pack_end (*v1_box, false, false);
147 main_contents.pack_start (*constraint_hbox, false, false);
149 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
151 bypass_button.set_active (!pi->enabled());
153 /* ScrolledWindow will wrap hpacker in a Viewport */
154 scroller.add (hpacker);
155 Viewport* view = static_cast<Viewport*>(scroller.get_child());
156 view->set_shadow_type(Gtk::SHADOW_NONE);
158 main_contents.pack_start (scroller, true, true);
163 if (insert->plugin()->has_midnam() && insert->plugin()->knows_bank_patch()) {
164 /* right now PC are sent via MIDI Track controls only */
165 if (dynamic_cast<MidiTrack*> (insert->owner())) {
171 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
172 scroller.set_name ("PluginEditor");
174 scroller.signal_size_request().connect (sigc::mem_fun(*this, &GenericPluginUI::scroller_size_request));
175 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
179 /* Listen for property changes that are not notified normally because
180 * AutomationControl has only support for numeric values currently.
181 * The only case is Variant::PATH for now */
182 plugin->PropertyChanged.connect(*this, invalidator(*this),
183 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
186 main_contents.show ();
189 GenericPluginUI::~GenericPluginUI ()
191 if (output_controls.size() > 0) {
192 screen_update_connection.disconnect();
197 GenericPluginUI::scroller_size_request (Gtk::Requisition* a)
199 Glib::RefPtr<Gdk::Screen> screen = get_screen();
201 screen = Gdk::Screen::get_default();
205 Gdk::Rectangle monitor;
206 const int monitor_num = screen->get_monitor_at_window (get_window ());
207 screen->get_monitor_geometry (
208 (monitor_num < 0) ? 0 : monitor_num,
211 maximum_width = monitor.get_width() * 0.9;
214 GtkRequisition request = hpacker.size_request();
216 if (request.width > maximum_width) {
217 for (vector<ControlUI*>::const_iterator cuip = input_controls.begin();
218 cuip != input_controls.end();
220 if (!(*cuip)->short_autostate)
221 set_short_autostate(*cuip, true);
223 request = hpacker.size_request();
226 a->width = min(request.width, maximum_width);
229 // Some functions for calculating the 'similarity' of two plugin
232 static int get_number(string label) {
233 static const char *digits = "0123456789";
236 std::size_t first_digit_pos = label.find_first_of(digits);
237 if (first_digit_pos != string::npos) {
238 // found some digits: there's a number in there somewhere
240 s << label.substr(first_digit_pos);
246 static int match_or_digit(char c1, char c2) {
247 return c1 == c2 || (isdigit(c1) && isdigit(c2));
250 static std::size_t matching_chars_at_head(const string s1, const string s2) {
251 std::size_t length, n = 0;
253 length = min(s1.length(), s2.length());
255 if (!match_or_digit(s1[n], s2[n]))
262 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
263 std::size_t s1pos, s2pos, n = 0;
267 while (s1pos-- > 0 && s2pos-- > 0) {
268 if (!match_or_digit(s1[s1pos], s2[s2pos]) )
275 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
276 static const float default_similarity_threshold = 0.3;
279 GenericPluginUI::build ()
281 std::vector<ControlUI *> control_uis;
282 bool grid = plugin->parameter_count() > 0;
284 // Build a ControlUI for each control port
285 for (size_t i = 0; i < plugin->parameter_count(); ++i) {
287 if (plugin->parameter_is_control (i)) {
289 /* Don't show latency control ports */
291 const Evoral::Parameter param(PluginAutomation, 0, i);
292 if (plugin->describe_parameter (param) == X_("latency")) {
296 if (plugin->describe_parameter (param) == X_("hidden")) {
300 const float value = plugin->get_parameter(i);
303 Plugin::UILayoutHint hint;
305 if (!plugin->get_layout(i, hint)) {
309 boost::shared_ptr<ARDOUR::AutomationControl> c
310 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
311 insert->control(param));
313 ParameterDescriptor desc;
314 plugin->get_parameter_descriptor(i, desc);
315 if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
316 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
327 const std::string param_docs = plugin->get_parameter_docs(i);
328 if (!param_docs.empty()) {
329 set_tooltip(cui, param_docs.c_str());
332 control_uis.push_back(cui);
336 // Build a ControlUI for each property
337 const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
338 for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
339 const ParameterDescriptor& desc = d->second;
340 const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key);
342 boost::shared_ptr<ARDOUR::AutomationControl> c
343 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
344 insert->control(param));
347 error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
351 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
353 error << string_compose(_("Plugin Editor: could not build control element for property %1"),
358 control_uis.push_back(cui);
360 if (!descs.empty()) {
361 plugin->announce_property_values();
365 custom_layout (control_uis);
367 automatic_layout (control_uis);
372 automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
373 automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
374 automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
375 automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
377 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
378 plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
383 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
387 static const int32_t initial_button_rows = 12;
388 static const int32_t initial_button_cols = 1;
389 static const int32_t initial_output_rows = 1;
390 static const int32_t initial_output_cols = 4;
392 Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
393 Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
398 int output_row, output_col;
399 int button_row, button_col;
400 int output_rows, output_cols;
401 int button_rows, button_cols;
403 hpacker.set_spacing (10);
404 hpacker.set_border_width (10);
406 output_rows = initial_output_rows;
407 output_cols = initial_output_cols;
408 button_rows = initial_button_rows;
409 button_cols = initial_button_cols;
415 button_table->set_homogeneous (false);
416 button_table->set_row_spacings (2);
417 button_table->set_col_spacings (2);
418 button_table->set_border_width (5);
420 output_table->set_homogeneous (true);
421 output_table->set_row_spacings (2);
422 output_table->set_col_spacings (2);
423 output_table->set_border_width (5);
426 bt_frame = manage (new Frame);
427 bt_frame->set_name ("BaseFrame");
428 bt_frame->set_label (_("Switches"));
429 bt_frame->add (*button_table);
430 hpacker.pack_start(*bt_frame, true, true);
432 box = manage (new VBox);
433 box->set_border_width (5);
434 box->set_spacing (1);
436 frame = manage (new Frame);
437 frame->set_name ("BaseFrame");
438 frame->set_label (_("Controls"));
440 hpacker.pack_start(*frame, true, true);
442 // Add special controls to UI, and build list of normal controls to be layed out later
443 std::vector<ControlUI *> cui_controls_list;
444 for (size_t i = 0; i < control_uis.size(); ++i) {
445 ControlUI* cui = control_uis[i];
447 if (cui->button || cui->file_button) {
449 if (!is_scrollable && button_row == button_rows) {
451 if (++button_col == button_cols) {
453 button_table->resize (button_rows, button_cols);
457 button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
461 } else if (cui->controller || cui->clickbox || cui->combo) {
462 // Get all of the controls into a list, so that
463 // we can lay them out a bit more nicely later.
464 cui_controls_list.push_back(cui);
466 } else if (cui->display) {
468 output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
471 // TODO: The meters should be divided into multiple rows
473 if (++output_col == output_cols) {
475 output_table->resize (output_rows, output_cols);
480 // Iterate over the list of controls to find which adjacent controls
481 // are similar enough to be grouped together.
483 string label, previous_label = "";
484 std::vector<int> numbers_in_labels(cui_controls_list.size());
486 std::vector<float> similarity_scores(cui_controls_list.size());
487 float most_similar = 0.0, least_similar = 1.0;
490 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
491 label = (*cuip)->label.get_text();
492 numbers_in_labels[i] = get_number(label);
495 // A hand-wavy calculation of how similar this control's
496 // label is to the previous.
497 similarity_scores[i] =
499 ( matching_chars_at_head(label, previous_label) +
500 matching_chars_at_tail(label, previous_label) +
503 ) / (label.length() + previous_label.length());
504 if (numbers_in_labels[i] >= 0) {
505 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
507 least_similar = min(least_similar, similarity_scores[i]);
508 most_similar = max(most_similar, similarity_scores[i]);
510 similarity_scores[0] = 1.0;
513 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
514 previous_label = label;
518 // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
519 float similarity_threshold;
521 if (most_similar > 1.0) {
522 similarity_threshold = default_similarity_threshold;
524 similarity_threshold = most_similar - (1 - default_similarity_threshold);
527 // Now iterate over the list of controls to display them, placing an
528 // HSeparator between controls of less than a certain similarity, and
529 // starting a new column when necessary.
532 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
534 ControlUI* cui = *cuip;
536 if (!is_scrollable) {
540 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
541 if (x > min_controls_per_column) {
542 frame = manage (new Frame);
543 frame->set_name ("BaseFrame");
544 frame->set_label (_("Controls"));
545 box = manage (new VBox);
546 box->set_border_width (5);
547 box->set_spacing (1);
549 hpacker.pack_start(*frame, true, true);
552 HSeparator *split = new HSeparator();
553 split->set_size_request(-1, 5);
554 box->pack_start(*split, false, false, 0);
558 box->pack_start (*cui, false, false);
565 if (box->children().empty()) {
566 hpacker.remove (*frame);
569 if (button_table->children().empty()) {
570 hpacker.remove (*bt_frame);
573 button_table->show_all ();
576 if (!output_table->children().empty()) {
577 frame = manage (new Frame);
578 frame->set_name ("BaseFrame");
579 frame->set_label(_("Meters"));
580 frame->add (*output_table);
581 hpacker.pack_end (*frame, true, true);
582 output_table->show_all ();
587 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
588 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
589 hpacker.pack_end (*pd, true, true);
596 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
598 Gtk::Table* layout = manage (new Gtk::Table ());
600 for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
602 if (cui->x0 < 0 || cui->y0 < 0) {
605 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
607 hpacker.pack_start (*layout, true, true);
609 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
610 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
611 hpacker.pack_end (*pd, true, true);
616 GenericPluginUI::build_midi_table ()
618 Gtk::Table* pgm_table = manage (new Gtk::Table (8, 2));
620 pgm_table->set_homogeneous (true);
621 pgm_table->set_row_spacings (2);
622 pgm_table->set_col_spacings (2);
623 pgm_table->set_border_width (5);
625 Frame* frame = manage (new Frame);
626 frame->set_name ("BaseFrame");
627 frame->set_label (_("MIDI Progams (sent to track)"));
628 //frame->set_label (_("MIDI Progams (volatile)"));
629 frame->add (*pgm_table);
630 hpacker.pack_start (*frame, true, true);
632 for (uint8_t chn = 0; chn < 16; ++chn) {
635 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
636 // TODO set size_request
637 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
638 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
639 midi_pgmsel.push_back (cui);
640 pgm_table->attach (*cui, col, col + 1, row, row+1, FILL|EXPAND, FILL);
643 midi_refill_patches ();
645 insert->plugin()->BankPatchChange.connect (
646 midi_connections, invalidator (*this),
647 boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
650 /* Note: possible race with MidiTimeAxisView::update_patch_selector()
651 * which uses this signal to update/re-register the midnam (also in gui context).
652 * MTAV does register before us, so the midnam should already be updated when
655 insert->plugin()->UpdateMidnam.connect (
656 midi_connections, invalidator (*this),
657 boost::bind (&GenericPluginUI::midi_refill_patches, this),
662 GenericPluginUI::midi_refill_patches ()
664 assert (midi_pgmsel.size() == 16);
668 const std::string model = insert->plugin ()->midnam_model ();
670 const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
671 if (device_modes.size() > 0) {
672 mode = device_modes.front();
675 for (uint8_t chn = 0; chn < 16; ++chn) {
676 midi_pgmsel[chn]->clear_items ();
677 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
678 MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
681 using namespace Menu_Helpers;
682 using namespace Gtkmm2ext;
684 for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
685 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
686 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
687 const std::string pgm = (*j)->name ();
688 MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
689 assert ((*i)->number () == key.bank());
690 const uint32_t bp = (key.bank() << 7) | key.program();
691 midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
697 midi_bank_patch_change (chn);
702 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
704 assert (chn < 16 && midi_pgmsel.size() == 16);
705 uint32_t bankpgm = insert->plugin()->bank_patch (chn);
706 if (bankpgm == UINT32_MAX) {
707 midi_pgmsel[chn]->set_text (_("--Unset--"));
709 int bank = bankpgm >> 7;
710 int pgm = bankpgm & 127;
711 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
712 midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
714 midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
715 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
721 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
723 int bank = bankpgm >> 7;
724 int pgm = bankpgm & 127;
727 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
732 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
733 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
734 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
736 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
737 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
738 program->set_value (pgm, PBD::Controllable::NoGroup);
741 #if 0 // TODO inject directly to plugin..
742 const int cnt = insert->get_count();
743 for (int i=0; i < cnt; i++ ) {
744 boost::shared_ptr<LV2Plugin> lv2i = boost::dynamic_pointer_cast<LV2Plugin> (insert->plugin(i));
745 //lv2i->write_from_ui(port_index, format, buffer_size, (const uint8_t*)buffer);
752 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
754 , automate_button (X_("")) // force creation of a label
765 automate_button.set_name ("plugin automation state button");
766 set_tooltip (automate_button, _("Automation control"));
768 ignore_change = false;
769 update_pending = false;
772 x0 = x1 = y0 = y1 = -1;
775 GenericPluginUI::ControlUI::~ControlUI()
778 delete meterinfo->meter;
784 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
786 cui->short_autostate = value;
788 cui->automate_button.set_sizing_text("M");
790 /* XXX translators: use a string here that will be at least as long
791 as the longest automation label (see ::automation_state_changed()
792 below). be sure to include a descender. */
793 cui->automate_button.set_sizing_text(_("Mgnual"));
795 automation_state_changed(cui);
799 GenericPluginUI::automation_state_changed (ControlUI* cui)
801 /* update button label */
803 // don't lock to avoid deadlock because we're triggered by
804 // AutomationControl::Changed() while the automation lock is taken
806 AutoState state = insert->get_parameter_automation_state (cui->parameter());
808 cui->automate_button.set_active((state != ARDOUR::Off));
810 if (cui->short_autostate) {
811 cui->automate_button.set_text (
812 GainMeterBase::astate_string (state));
816 switch (state & (ARDOUR::Off|Play|Touch|Write)) {
818 cui->automate_button.set_text (S_("Automation|Manual"));
821 cui->automate_button.set_text (_("Play"));
824 cui->automate_button.set_text (_("Write"));
827 cui->automate_button.set_text (_("Touch"));
830 cui->automate_button.set_text (_("???"));
836 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
838 float const v = cui->control->interface_to_internal(adj.get_value ());
839 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
840 const size_t len = str.copy(buf, 31);
846 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
848 float const v = cui->control->interface_to_internal(adj.get_value ());
849 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
850 const size_t len = str.copy(buf, 31);
856 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
858 plugin->print_parameter (param, buf, len);
861 /** Build a ControlUI for a parameter/property.
862 * Note that mcontrol may be NULL for outputs.
864 GenericPluginUI::ControlUI*
865 GenericPluginUI::build_control_ui (const Evoral::Parameter& param,
866 const ParameterDescriptor& desc,
867 boost::shared_ptr<AutomationControl> mcontrol,
872 ControlUI* control_ui = 0;
874 control_ui = manage (new ControlUI (param));
875 control_ui->combo = 0;
876 control_ui->control = mcontrol;
877 control_ui->label.set_text (desc.label);
878 control_ui->label.set_alignment (0.0, 0.5);
879 control_ui->label.set_name ("PluginParameterLabel");
880 control_ui->set_spacing (5);
881 set_short_autostate(control_ui, false);
885 if (desc.datatype == Variant::PATH) {
887 /* We shouldn't get that type for input ports */
888 assert(param.type() == PluginPropertyAutomation);
890 /* Build a file selector button */
892 // Create/add controller
893 control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
894 control_ui->file_button->set_title(desc.label);
897 control_ui->knobtable = manage (new Table());
898 control_ui->pack_start(*control_ui->knobtable, true, false);
899 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
900 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
902 control_ui->pack_start (control_ui->label, false, true);
903 control_ui->pack_start (*control_ui->file_button, true, true);
906 // Monitor changes from the user.
907 control_ui->file_button->signal_file_set().connect(
908 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
909 desc, control_ui->file_button));
911 /* Add the filebutton control to a map so that we can update it when
912 * the corresponding property changes. This doesn't go through the usual
913 * AutomationControls, because they don't support non-numeric values. */
914 _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
921 /* See if there any named values for our input value */
922 control_ui->scale_points = desc.scale_points;
924 /* If this parameter is an integer, work out the number of distinct values
925 it can take on (assuming that lower and upper values are allowed).
927 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
929 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
932 * a) There is a label for each possible value of this input, or
933 * b) This port is marked as being an enumeration.
936 control_ui->combo = new ArdourDropdown();
937 for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
938 i != control_ui->scale_points->end();
940 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
942 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
947 control_ui->combo->set_controllable (mcontrol);
949 update_control_display(control_ui);
953 /* create the controller */
955 /* XXX memory leak: SliderController not destroyed by ControlUI
956 * destructor, and manage() reports object hierarchy
959 control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
961 /* Control UI's don't need the rapid timer workaround */
962 control_ui->controller->stop_updating ();
964 /* XXX this code is not right yet, because it doesn't handle
965 the absence of bounds in any sensible fashion.
968 Adjustment* adj = control_ui->controller->adjustment();
970 if (desc.integer_step && !desc.toggled) {
971 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
972 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
973 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
974 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
976 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
978 control_ui->clickbox->set_controllable (mcontrol);
979 } else if (desc.toggled) {
980 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
982 but->set_tweaks(ArdourButton::Square);
983 } else if (use_knob) {
984 /* Delay size request so that styles are gotten right */
985 control_ui->controller->widget()->signal_size_request().connect(
986 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
988 control_ui->controller->set_size_request (200, -1);
989 control_ui->controller->set_name (X_("ProcessorControlSlider"));
992 if (!desc.integer_step && !desc.toggled && use_knob) {
993 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
996 adj->set_value (mcontrol->internal_to_interface(value));
1001 set_short_autostate(control_ui, true);
1003 control_ui->label.set_alignment (0.5, 0.5);
1004 control_ui->knobtable = manage (new Table());
1005 control_ui->pack_start(*control_ui->knobtable, true, true);
1007 if (control_ui->combo) {
1008 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1009 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1010 } else if (control_ui->clickbox) {
1011 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
1012 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1013 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1014 } else if (control_ui->spin_box) {
1015 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1016 knob->set_tooltip_prefix (desc.label + ": ");
1017 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1018 align->add (*control_ui->controller);
1019 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1020 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1021 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1022 } else if (desc.toggled) {
1023 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1024 align->add (*control_ui->controller);
1025 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1026 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1027 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1029 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1030 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1031 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1036 control_ui->pack_start (control_ui->label, true, true);
1037 if (control_ui->combo) {
1038 control_ui->pack_start(*control_ui->combo, false, true);
1039 } else if (control_ui->clickbox) {
1040 control_ui->pack_start (*control_ui->clickbox, false, false);
1041 } else if (control_ui->spin_box) {
1042 control_ui->pack_start (*control_ui->spin_box, false, false);
1043 control_ui->pack_start (*control_ui->controller, false, false);
1045 control_ui->pack_start (*control_ui->controller, false, false);
1047 control_ui->pack_start (control_ui->automate_button, false, false);
1051 if (mcontrol->flags () & Controllable::NotAutomatable) {
1052 control_ui->automate_button.set_sensitive (false);
1053 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1055 control_ui->automate_button.signal_button_press_event().connect (
1056 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1059 mcontrol->alist()->automation_state_changed.connect (
1060 control_connections,
1061 invalidator (*this),
1062 boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1064 input_controls_with_automation.push_back (control_ui);
1067 if (desc.toggled && !control_ui->combo) {
1068 control_ui->button = true;
1069 ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1071 but->set_name ("pluginui toggle");
1072 update_control_display(control_ui);
1075 automation_state_changed (control_ui);
1077 /* Add to the list of CUIs that need manual update to workaround
1078 * AutomationControl not knowing about preset loads */
1079 input_controls.push_back (control_ui);
1083 control_ui->display = manage (new EventBox);
1084 control_ui->display->set_name ("ParameterValueDisplay");
1086 control_ui->display_label = manage (new Label);
1088 control_ui->display_label->set_name ("ParameterValueDisplay");
1090 control_ui->display->add (*control_ui->display_label);
1091 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1093 control_ui->display->show_all ();
1095 control_ui->vbox = manage (new VBox);
1096 control_ui->vbox->set_spacing(3);
1098 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1099 control_ui->vbox->pack_end (*control_ui->display, false, false);
1100 control_ui->vbox->pack_end (control_ui->label, false, false);
1101 } else if (desc.integer_step || desc.enumeration) {
1102 control_ui->vbox->pack_end (*control_ui->display, false, false);
1103 control_ui->vbox->pack_end (control_ui->label, false, false);
1105 /* set up a meter for float ports */
1107 MeterInfo * info = new MeterInfo();
1108 control_ui->meterinfo = info;
1110 info->meter = new FastMeter (
1111 5, 5, FastMeter::Vertical, 0,
1113 0x008800ff, 0x008800ff,
1114 0x00ff00ff, 0x00ff00ff,
1115 0xcccc00ff, 0xcccc00ff,
1116 0xffaa00ff, 0xffaa00ff,
1118 UIConfiguration::instance().color ("meter background bottom"),
1119 UIConfiguration::instance().color ("meter background top")
1122 control_ui->label.set_angle(90);
1124 HBox* center = manage (new HBox);
1125 center->set_spacing(1);
1126 center->pack_start (control_ui->label, false, false);
1127 center->pack_start (*info->meter, false, false);
1129 control_ui->hbox = manage (new HBox);
1130 control_ui->hbox->pack_start (*center, true, false);
1132 // horizontally center this hbox in the vbox
1133 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1135 control_ui->meterinfo->meter->show_all();
1136 control_ui->meterinfo->packed = true;
1137 control_ui->vbox->pack_start (*control_ui->display, false, false);
1140 control_ui->pack_start (*control_ui->vbox);
1142 output_controls.push_back (control_ui);
1146 mcontrol->Changed.connect(control_connections, invalidator(*this),
1147 boost::bind(&GenericPluginUI::ui_parameter_changed,
1156 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1157 Gtk::Requisition astate_req (cui->automate_button.size_request());
1158 const int size = (int) (astate_req.height * 1.5);
1159 req->width = max(req->width, size);
1160 req->height = max(req->height, size);
1165 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1167 if (ev->button != 1) {
1171 using namespace Menu_Helpers;
1173 if (automation_menu == 0) {
1174 automation_menu = manage (new Menu);
1175 automation_menu->set_name ("ArdourContextMenu");
1176 automation_menu->set_reserve_toggle_size(false);
1179 MenuList& items (automation_menu->items());
1182 items.push_back (MenuElem (S_("Automation|Manual"),
1183 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1184 items.push_back (MenuElem (_("Play"),
1185 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1186 items.push_back (MenuElem (_("Write"),
1187 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1188 items.push_back (MenuElem (_("Touch"),
1189 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1191 anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1198 GenericPluginUI::set_all_automation (AutoState as)
1200 for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1201 set_automation_state (as, (*i));
1206 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1208 insert->set_parameter_automation_state (cui->parameter(), state);
1212 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1214 if (!cui->update_pending) {
1215 cui->update_pending = true;
1216 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1221 GenericPluginUI::update_control_display (ControlUI* cui)
1223 /* XXX how do we handle logarithmic stuff here ? */
1225 cui->update_pending = false;
1227 float val = cui->control->get_value();
1229 PBD::Unwinder<bool> (cui->ignore_change, true);
1231 if (cui->combo && cui->scale_points) {
1232 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1233 if (it->second == val) {
1234 cui->combo->set_text(it->first);
1238 } else if (cui->button) {
1239 // AutomationController handles this
1242 if( cui->controller ) {
1243 cui->controller->display_effective_value();
1248 if (cui->logarithmic) {
1251 if (val != cui->adjustment->get_value()) {
1252 cui->adjustment->set_value (val);
1258 GenericPluginUI::update_input_displays ()
1260 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1261 for (vector<ControlUI*>::iterator i = input_controls.begin();
1262 i != input_controls.end();
1264 update_control_display(*i);
1270 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1272 if (!cui->ignore_change) {
1273 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1278 GenericPluginUI::start_updating (GdkEventAny*)
1280 if (output_controls.size() > 0 ) {
1281 screen_update_connection.disconnect();
1282 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1288 GenericPluginUI::stop_updating (GdkEventAny*)
1290 if (output_controls.size() > 0 ) {
1291 screen_update_connection.disconnect();
1297 GenericPluginUI::output_update ()
1299 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1300 float val = plugin->get_parameter ((*i)->parameter().id());
1302 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1303 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1304 size_t len = str.copy(buf, 31);
1306 (*i)->display_label->set_text (buf);
1308 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1309 (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1315 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1316 Gtk::FileChooserButton* widget)
1318 plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1322 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1324 FilePathControls::iterator c = _filepath_controls.find(key);
1325 if (c != _filepath_controls.end()) {
1326 c->second->set_filename(value.get_path());
1328 std::cerr << "warning: property change for property with no control" << std::endl;