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)
81 , _plugin_pianokeyboard_expander (_("MIDI Keyboard"))
84 , _piano_velocity (*manage (new Adjustment (100, 1, 127, 1, 16)))
85 , _piano_channel (*manage (new Adjustment (0, 1, 16, 1, 1)))
87 set_name ("PluginEditor");
88 set_border_width (10);
89 //set_homogeneous (false);
91 pack_start (main_contents, true, true);
92 settings_box.set_homogeneous (false);
94 HBox* constraint_hbox = manage (new HBox);
95 HBox* smaller_hbox = manage (new HBox);
96 smaller_hbox->set_spacing (4);
97 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
98 combo_label->set_use_markup (true);
100 latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
101 set_latency_label ();
103 smaller_hbox->pack_start (latency_button, false, false, 4);
104 smaller_hbox->pack_start (pin_management_button, false, false, 4);
105 smaller_hbox->pack_start (_preset_combo, false, false);
106 smaller_hbox->pack_start (_preset_modified, false, false);
107 smaller_hbox->pack_start (add_button, false, false);
108 smaller_hbox->pack_start (save_button, false, false);
109 smaller_hbox->pack_start (delete_button, false, false);
110 if (pi->controls().size() > 0) {
111 smaller_hbox->pack_start (reset_button, false, false, 4);
113 smaller_hbox->pack_start (bypass_button, false, true, 4);
115 automation_manual_all_button.set_text(_("Manual"));
116 automation_manual_all_button.set_name (X_("generic button"));
117 automation_play_all_button.set_text(_("Play"));
118 automation_play_all_button.set_name (X_("generic button"));
119 automation_write_all_button.set_text(_("Write"));
120 automation_write_all_button.set_name (X_("generic button"));
121 automation_touch_all_button.set_text(_("Touch"));
122 automation_touch_all_button.set_name (X_("generic button"));
123 automation_latch_all_button.set_text(_("Touch"));
124 automation_latch_all_button.set_name (X_("generic button"));
126 constraint_hbox->set_spacing (5);
127 constraint_hbox->set_homogeneous (false);
129 VBox* v1_box = manage (new VBox);
130 VBox* v2_box = manage (new VBox);
131 if (pi->is_instrument ()) {
132 _piano = (PianoKeyboard*)piano_keyboard_new();
133 _pianomm = Glib::wrap((GtkWidget*)_piano);
134 _pianomm->set_flags(Gtk::CAN_FOCUS);
135 _pianomm->add_events(Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
137 g_signal_connect (G_OBJECT (_piano), "note-on", G_CALLBACK (GenericPluginUI::_note_on_event_handler), this);
138 g_signal_connect (G_OBJECT (_piano), "note-off", G_CALLBACK (GenericPluginUI::_note_off_event_handler), this);
140 HBox* box = manage (new HBox);
141 box->pack_start (*manage (new Label (_("Channel:"))), false, false);
142 box->pack_start (_piano_channel, false, false);
143 box->pack_start (*manage (new Label (_("Velocity:"))), false, false);
144 box->pack_start (_piano_velocity, false, false);
146 Box* box2 = manage (new HBox ());
147 box2->pack_start (*box, true, false);
149 _pianobox.set_spacing (4);
150 _pianobox.pack_start (*box2, true, true);
151 _pianobox.pack_start (*_pianomm, true, true);
153 _plugin_pianokeyboard_expander.set_expanded(false);
154 _plugin_pianokeyboard_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &GenericPluginUI::toggle_pianokeyboard));
156 pack_end (_plugin_pianokeyboard_expander, false, false);
158 pack_end (plugin_analysis_expander, false, false);
160 if (!plugin->get_docs().empty()) {
161 pack_end (description_expander, false, false);
164 v1_box->set_spacing (6);
165 v1_box->pack_start (*smaller_hbox, false, true);
166 if (pi->controls().size() > 0) {
167 HBox* automation_hbox = manage (new HBox);
168 automation_hbox->set_spacing (6);
169 Label* l = manage (new Label (_("All Automation")));
170 l->set_alignment (1.0, 0.5);
171 automation_hbox->pack_start (*l, true, true);
172 automation_hbox->pack_start (automation_manual_all_button, false, false);
173 automation_hbox->pack_start (automation_play_all_button, false, false);
174 automation_hbox->pack_start (automation_write_all_button, false, false);
175 automation_hbox->pack_start (automation_touch_all_button, false, false);
176 v1_box->pack_start (*automation_hbox, false, true);
178 v2_box->pack_start (focus_button, false, true);
180 main_contents.pack_start (settings_box, false, false);
182 constraint_hbox->pack_end (*v2_box, false, false);
183 constraint_hbox->pack_end (*v1_box, false, false);
185 main_contents.pack_start (*constraint_hbox, false, false);
187 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
189 bypass_button.set_active (!pi->enabled());
191 /* ScrolledWindow will wrap hpacker in a Viewport */
192 scroller.add (hpacker);
193 Viewport* view = static_cast<Viewport*>(scroller.get_child());
194 view->set_shadow_type(Gtk::SHADOW_NONE);
196 main_contents.pack_start (scroller, true, true);
201 if (insert->plugin()->has_midnam() && insert->plugin()->knows_bank_patch()) {
206 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
207 scroller.set_name ("PluginEditor");
209 scroller.signal_size_request().connect (sigc::mem_fun(*this, &GenericPluginUI::scroller_size_request));
210 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
213 main_contents.show ();
216 GenericPluginUI::~GenericPluginUI ()
218 if (output_controls.size() > 0) {
219 screen_update_connection.disconnect();
225 GenericPluginUI::scroller_size_request (Gtk::Requisition* a)
227 Glib::RefPtr<Gdk::Window> window (get_window());
228 Glib::RefPtr<Gdk::Screen> screen;
231 screen = get_screen();
234 int maximum_width = -1;
237 Gdk::Rectangle monitor;
238 const int monitor_num = screen->get_monitor_at_window (get_window ());
239 screen->get_monitor_geometry (
240 (monitor_num < 0) ? 0 : monitor_num,
243 maximum_width = monitor.get_width() * 0.9;
246 GtkRequisition request = hpacker.size_request();
248 if (request.width > maximum_width) {
249 for (vector<ControlUI*>::const_iterator cuip = input_controls.begin();
250 cuip != input_controls.end();
252 if (!(*cuip)->short_autostate)
253 set_short_autostate(*cuip, true);
255 request = hpacker.size_request();
258 a->width = min(request.width, maximum_width);
261 // Some functions for calculating the 'similarity' of two plugin
264 static int get_number(string label) {
265 static const char *digits = "0123456789";
268 std::size_t first_digit_pos = label.find_first_of(digits);
269 if (first_digit_pos != string::npos) {
270 // found some digits: there's a number in there somewhere
272 s << label.substr(first_digit_pos);
278 static int match_or_digit(char c1, char c2) {
279 return c1 == c2 || (isdigit(c1) && isdigit(c2));
282 static std::size_t matching_chars_at_head(const string s1, const string s2) {
283 std::size_t length, n = 0;
285 length = min(s1.length(), s2.length());
287 if (!match_or_digit(s1[n], s2[n]))
294 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
295 std::size_t s1pos, s2pos, n = 0;
299 while (s1pos-- > 0 && s2pos-- > 0) {
300 if (!match_or_digit(s1[s1pos], s2[s2pos]) )
307 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
308 static const float default_similarity_threshold = 0.3;
311 GenericPluginUI::build ()
313 std::vector<ControlUI *> control_uis;
314 bool grid = plugin->parameter_count() > 0;
316 // Build a ControlUI for each control port
317 for (size_t i = 0; i < plugin->parameter_count(); ++i) {
319 if (plugin->parameter_is_control (i)) {
321 /* Don't show latency control ports */
323 const Evoral::Parameter param(PluginAutomation, 0, i);
324 if (plugin->describe_parameter (param) == X_("latency")) {
328 if (plugin->describe_parameter (param) == X_("hidden")) {
332 const float value = plugin->get_parameter(i);
335 Plugin::UILayoutHint hint;
337 if (!plugin->get_layout(i, hint)) {
341 boost::shared_ptr<ARDOUR::AutomationControl> c
342 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
343 insert->control(param));
345 ParameterDescriptor desc;
346 plugin->get_parameter_descriptor(i, desc);
347 if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
348 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
359 const std::string param_docs = plugin->get_parameter_docs(i);
360 if (!param_docs.empty()) {
361 set_tooltip(cui, param_docs.c_str());
364 control_uis.push_back(cui);
368 // Build a ControlUI for each property
369 const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
370 for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
371 const ParameterDescriptor& desc = d->second;
372 const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key);
374 boost::shared_ptr<ARDOUR::AutomationControl> c
375 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
376 insert->control(param));
379 error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
383 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
385 error << string_compose(_("Plugin Editor: could not build control element for property %1"),
390 control_uis.push_back(cui);
392 if (!descs.empty()) {
393 /* Listen for property changes that are not notified normally because
394 * AutomationControl has only support for numeric values currently.
395 * The only case is Variant::PATH for now */
396 plugin->PropertyChanged.connect(*this, invalidator(*this),
397 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
400 /* and query current property value */
401 plugin->announce_property_values();
405 custom_layout (control_uis);
407 automatic_layout (control_uis);
412 automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
413 automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
414 automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
415 automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
416 automation_latch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Latch));
418 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
419 plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
424 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
428 static const int32_t initial_button_rows = 12;
429 static const int32_t initial_button_cols = 1;
430 static const int32_t initial_output_rows = 1;
431 static const int32_t initial_output_cols = 4;
433 Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
434 Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
439 int output_row, output_col;
440 int button_row, button_col;
441 int output_rows, output_cols;
442 int button_rows, button_cols;
444 hpacker.set_spacing (10);
445 hpacker.set_border_width (10);
447 output_rows = initial_output_rows;
448 output_cols = initial_output_cols;
449 button_rows = initial_button_rows;
450 button_cols = initial_button_cols;
456 button_table->set_homogeneous (false);
457 button_table->set_row_spacings (2);
458 button_table->set_col_spacings (2);
459 button_table->set_border_width (5);
461 output_table->set_homogeneous (true);
462 output_table->set_row_spacings (2);
463 output_table->set_col_spacings (2);
464 output_table->set_border_width (5);
467 bt_sample = manage (new Frame);
468 bt_sample->set_name ("BaseFrame");
469 bt_sample->set_label (_("Switches"));
470 bt_sample->add (*button_table);
471 hpacker.pack_start(*bt_sample, true, true);
473 box = manage (new VBox);
474 box->set_border_width (5);
475 box->set_spacing (1);
477 sample = manage (new Frame);
478 sample->set_name ("BaseFrame");
479 sample->set_label (_("Controls"));
481 hpacker.pack_start(*sample, true, true);
483 // Add special controls to UI, and build list of normal controls to be layed out later
484 std::vector<ControlUI *> cui_controls_list;
485 for (size_t i = 0; i < control_uis.size(); ++i) {
486 ControlUI* cui = control_uis[i];
488 if (cui->button || cui->file_button) {
490 if (!is_scrollable && button_row == button_rows) {
492 if (++button_col == button_cols) {
494 button_table->resize (button_rows, button_cols);
498 button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
502 } else if (cui->controller || cui->clickbox || cui->combo) {
503 // Get all of the controls into a list, so that
504 // we can lay them out a bit more nicely later.
505 cui_controls_list.push_back(cui);
507 } else if (cui->display) {
509 output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
512 // TODO: The meters should be divided into multiple rows
514 if (++output_col == output_cols) {
516 output_table->resize (output_rows, output_cols);
521 // Iterate over the list of controls to find which adjacent controls
522 // are similar enough to be grouped together.
524 string label, previous_label = "";
525 std::vector<int> numbers_in_labels(cui_controls_list.size());
527 std::vector<float> similarity_scores(cui_controls_list.size());
528 float most_similar = 0.0, least_similar = 1.0;
531 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
532 label = (*cuip)->label.get_text();
533 numbers_in_labels[i] = get_number(label);
536 // A hand-wavy calculation of how similar this control's
537 // label is to the previous.
538 similarity_scores[i] =
540 ( matching_chars_at_head(label, previous_label) +
541 matching_chars_at_tail(label, previous_label) +
544 ) / (label.length() + previous_label.length());
545 if (numbers_in_labels[i] >= 0) {
546 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
548 least_similar = min(least_similar, similarity_scores[i]);
549 most_similar = max(most_similar, similarity_scores[i]);
551 similarity_scores[0] = 1.0;
554 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
555 previous_label = label;
559 // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
560 float similarity_threshold;
562 if (most_similar > 1.0) {
563 similarity_threshold = default_similarity_threshold;
565 similarity_threshold = most_similar - (1 - default_similarity_threshold);
568 // Now iterate over the list of controls to display them, placing an
569 // HSeparator between controls of less than a certain similarity, and
570 // starting a new column when necessary.
573 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
575 ControlUI* cui = *cuip;
577 if (!is_scrollable) {
581 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
582 if (x > min_controls_per_column) {
583 sample = manage (new Frame);
584 sample->set_name ("BaseFrame");
585 sample->set_label (_("Controls"));
586 box = manage (new VBox);
587 box->set_border_width (5);
588 box->set_spacing (1);
590 hpacker.pack_start(*sample, true, true);
593 HSeparator *split = new HSeparator();
594 split->set_size_request(-1, 5);
595 box->pack_start(*split, false, false, 0);
599 box->pack_start (*cui, false, false);
606 if (box->children().empty()) {
607 hpacker.remove (*sample);
610 if (button_table->children().empty()) {
611 hpacker.remove (*bt_sample);
614 button_table->show_all ();
617 if (!output_table->children().empty()) {
618 sample = manage (new Frame);
619 sample->set_name ("BaseFrame");
620 sample->set_label(_("Meters"));
621 sample->add (*output_table);
622 hpacker.pack_end (*sample, true, true);
623 output_table->show_all ();
628 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
629 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
630 hpacker.pack_end (*pd, true, true);
637 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
639 Gtk::Table* layout = manage (new Gtk::Table ());
641 for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
643 if (cui->x0 < 0 || cui->y0 < 0) {
646 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
648 hpacker.pack_start (*layout, true, true);
650 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
651 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
652 hpacker.pack_end (*pd, true, true);
657 GenericPluginUI::build_midi_table ()
659 Gtk::Table* pgm_table = manage (new Gtk::Table (8, 5));
661 pgm_table->set_homogeneous (false);
662 pgm_table->set_row_spacings (2);
663 pgm_table->set_col_spacings (2);
664 pgm_table->set_border_width (5);
665 pgm_table->set_col_spacing (2, 10);
667 Frame* sample = manage (new Frame);
668 sample->set_name ("BaseFrame");
669 if (dynamic_cast<MidiTrack*> (insert->owner())) {
670 sample->set_label (_("MIDI Progams (sent to track)"));
672 sample->set_label (_("MIDI Progams (volatile)"));
674 sample->add (*pgm_table);
675 hpacker.pack_start (*sample, false, false);
677 for (uint8_t chn = 0; chn < 16; ++chn) {
678 int col = 3 * (chn / 8);
680 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
681 cui->set_sizing_text ("Stereo Grand Piano");
682 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
683 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
684 midi_pgmsel.push_back (cui);
685 pgm_table->attach (*manage (new Label (string_compose ("C%1:", (int)(chn + 1)), ALIGN_RIGHT)), col, col + 1, row, row+1, FILL, SHRINK);
686 pgm_table->attach (*cui, col + 1, col + 2, row, row+1, SHRINK, SHRINK);
689 insert->plugin ()->read_midnam();
691 midi_refill_patches ();
693 insert->plugin()->BankPatchChange.connect (
694 midi_connections, invalidator (*this),
695 boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
698 insert->plugin()->UpdatedMidnam.connect (
699 midi_connections, invalidator (*this),
700 boost::bind (&GenericPluginUI::midi_refill_patches, this),
705 GenericPluginUI::midi_refill_patches ()
707 assert (midi_pgmsel.size() == 16);
711 const std::string model = insert->plugin ()->midnam_model ();
713 const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
714 if (device_modes.size() > 0) {
715 mode = device_modes.front();
718 for (uint8_t chn = 0; chn < 16; ++chn) {
719 midi_pgmsel[chn]->clear_items ();
720 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
721 MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
724 using namespace Menu_Helpers;
725 using namespace Gtkmm2ext;
727 for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
728 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
729 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
730 const std::string pgm = (*j)->name ();
731 MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
732 assert ((*i)->number () == key.bank());
733 const uint32_t bp = (key.bank() << 7) | key.program();
734 midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
740 midi_bank_patch_change (chn);
745 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
747 assert (chn < 16 && midi_pgmsel.size() == 16);
748 uint32_t bankpgm = insert->plugin()->bank_patch (chn);
749 if (bankpgm == UINT32_MAX) {
750 midi_pgmsel[chn]->set_text (_("--Unset--"));
752 int bank = bankpgm >> 7;
753 int pgm = bankpgm & 127;
754 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
755 midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
757 midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
758 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
764 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
766 int bank = bankpgm >> 7;
767 int pgm = bankpgm & 127;
768 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
771 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
772 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
773 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
775 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
776 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
777 program->set_value (pgm, PBD::Controllable::NoGroup);
780 event[0] = (MIDI_CMD_CONTROL | chn);
782 event[2] = bank >> 7;
783 insert->write_immediate_event (3, event);
786 event[2] = bank & 127;
787 insert->write_immediate_event (3, event);
789 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
791 insert->write_immediate_event (2, event);
795 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
797 , automate_button (X_("")) // force creation of a label
808 automate_button.set_name ("plugin automation state button");
809 set_tooltip (automate_button, _("Automation control"));
811 ignore_change = false;
812 update_pending = false;
815 x0 = x1 = y0 = y1 = -1;
818 GenericPluginUI::ControlUI::~ControlUI()
821 delete meterinfo->meter;
827 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
829 cui->short_autostate = value;
831 cui->automate_button.set_sizing_text("M");
833 /* XXX translators: use a string here that will be at least as long
834 as the longest automation label (see ::automation_state_changed()
835 below). be sure to include a descender. */
836 cui->automate_button.set_sizing_text(_("Mgnual"));
838 automation_state_changed(cui);
842 GenericPluginUI::automation_state_changed (ControlUI* cui)
844 /* update button label */
846 // don't lock to avoid deadlock because we're triggered by
847 // AutomationControl::Changed() while the automation lock is taken
849 AutoState state = insert->get_parameter_automation_state (cui->parameter());
851 cui->automate_button.set_active((state != ARDOUR::Off));
853 if (cui->short_autostate) {
854 cui->automate_button.set_text (
855 GainMeterBase::astate_string (state));
859 switch (state & (ARDOUR::Off|Play|Touch|Write|Latch)) {
861 cui->automate_button.set_text (S_("Automation|Manual"));
864 cui->automate_button.set_text (_("Play"));
867 cui->automate_button.set_text (_("Write"));
870 cui->automate_button.set_text (_("Touch"));
873 cui->automate_button.set_text (_("Latch"));
876 cui->automate_button.set_text (_("???"));
882 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
884 float const v = cui->control->interface_to_internal(adj.get_value ());
885 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
886 const size_t len = str.copy(buf, 31);
892 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
894 float const v = cui->control->interface_to_internal(adj.get_value ());
895 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
896 const size_t len = str.copy(buf, 31);
902 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
904 plugin->print_parameter (param, buf, len);
907 /** Build a ControlUI for a parameter/property.
908 * Note that mcontrol may be NULL for outputs.
910 GenericPluginUI::ControlUI*
911 GenericPluginUI::build_control_ui (const Evoral::Parameter& param,
912 const ParameterDescriptor& desc,
913 boost::shared_ptr<AutomationControl> mcontrol,
918 ControlUI* control_ui = 0;
920 control_ui = manage (new ControlUI (param));
921 control_ui->combo = 0;
922 control_ui->control = mcontrol;
923 control_ui->label.set_text (desc.label);
924 control_ui->label.set_alignment (0.0, 0.5);
925 control_ui->label.set_name ("PluginParameterLabel");
926 control_ui->set_spacing (5);
927 set_short_autostate(control_ui, false);
931 if (desc.datatype == Variant::PATH) {
933 /* We shouldn't get that type for input ports */
934 assert(param.type() == PluginPropertyAutomation);
936 /* Build a file selector button */
938 // Create/add controller
939 control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
940 control_ui->file_button->set_title(desc.label);
943 control_ui->knobtable = manage (new Table());
944 control_ui->pack_start(*control_ui->knobtable, true, false);
945 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
946 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
948 control_ui->pack_start (control_ui->label, false, true);
949 control_ui->pack_start (*control_ui->file_button, true, true);
952 // Monitor changes from the user.
953 control_ui->file_button->signal_file_set().connect(
954 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
955 desc, control_ui->file_button));
957 /* Add the filebutton control to a map so that we can update it when
958 * the corresponding property changes. This doesn't go through the usual
959 * AutomationControls, because they don't support non-numeric values. */
960 _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
967 /* See if there any named values for our input value */
968 control_ui->scale_points = desc.scale_points;
970 /* If this parameter is an integer, work out the number of distinct values
971 it can take on (assuming that lower and upper values are allowed).
973 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
975 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
978 * a) There is a label for each possible value of this input, or
979 * b) This port is marked as being an enumeration.
982 control_ui->combo = new ArdourDropdown();
983 for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
984 i != control_ui->scale_points->end();
986 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
988 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
993 control_ui->combo->set_controllable (mcontrol);
995 update_control_display(control_ui);
999 /* create the controller */
1001 /* XXX memory leak: SliderController not destroyed by ControlUI
1002 * destructor, and manage() reports object hierarchy
1005 control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
1007 /* Control UI's don't need the rapid timer workaround */
1008 control_ui->controller->stop_updating ();
1010 /* XXX this code is not right yet, because it doesn't handle
1011 the absence of bounds in any sensible fashion.
1014 Adjustment* adj = control_ui->controller->adjustment();
1016 if (desc.integer_step && !desc.toggled) {
1017 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
1018 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
1019 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1020 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
1022 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
1024 control_ui->clickbox->set_controllable (mcontrol);
1025 } else if (desc.toggled) {
1026 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1028 but->set_tweaks(ArdourButton::Square);
1029 } else if (use_knob) {
1030 /* Delay size request so that styles are gotten right */
1031 control_ui->controller->widget()->signal_size_request().connect(
1032 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1034 control_ui->controller->set_size_request (200, -1);
1035 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1038 if (!desc.integer_step && !desc.toggled && use_knob) {
1039 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1042 adj->set_value (mcontrol->internal_to_interface(value));
1047 set_short_autostate(control_ui, true);
1049 control_ui->label.set_alignment (0.5, 0.5);
1050 control_ui->knobtable = manage (new Table());
1051 control_ui->pack_start(*control_ui->knobtable, true, true);
1053 if (control_ui->combo) {
1054 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1055 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1056 } else if (control_ui->clickbox) {
1057 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
1058 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1059 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1060 } else if (control_ui->spin_box) {
1061 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1062 knob->set_tooltip_prefix (desc.label + ": ");
1063 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1064 align->add (*control_ui->controller);
1065 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1066 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1067 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1068 } else if (desc.toggled) {
1069 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1070 align->add (*control_ui->controller);
1071 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1072 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1073 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1075 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1076 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1077 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1082 control_ui->pack_start (control_ui->label, true, true);
1083 if (control_ui->combo) {
1084 control_ui->pack_start(*control_ui->combo, false, true);
1085 } else if (control_ui->clickbox) {
1086 control_ui->pack_start (*control_ui->clickbox, false, false);
1087 } else if (control_ui->spin_box) {
1088 control_ui->pack_start (*control_ui->spin_box, false, false);
1089 control_ui->pack_start (*control_ui->controller, false, false);
1091 control_ui->pack_start (*control_ui->controller, false, false);
1093 control_ui->pack_start (control_ui->automate_button, false, false);
1097 if (mcontrol->flags () & Controllable::NotAutomatable) {
1098 control_ui->automate_button.set_sensitive (false);
1099 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1101 control_ui->automate_button.signal_button_press_event().connect (
1102 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1105 mcontrol->alist()->automation_state_changed.connect (
1106 control_connections,
1107 invalidator (*this),
1108 boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1110 input_controls_with_automation.push_back (control_ui);
1113 if (desc.toggled && !control_ui->combo) {
1114 control_ui->button = true;
1115 ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1117 but->set_name ("pluginui toggle");
1118 update_control_display(control_ui);
1121 automation_state_changed (control_ui);
1123 /* Add to the list of CUIs that need manual update to workaround
1124 * AutomationControl not knowing about preset loads */
1125 input_controls.push_back (control_ui);
1129 control_ui->display = manage (new EventBox);
1130 control_ui->display->set_name ("ParameterValueDisplay");
1132 control_ui->display_label = manage (new Label);
1134 control_ui->display_label->set_name ("ParameterValueDisplay");
1136 control_ui->display->add (*control_ui->display_label);
1137 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1139 control_ui->display->show_all ();
1141 control_ui->vbox = manage (new VBox);
1142 control_ui->vbox->set_spacing(3);
1144 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1145 control_ui->vbox->pack_end (*control_ui->display, false, false);
1146 control_ui->vbox->pack_end (control_ui->label, false, false);
1147 } else if (desc.integer_step || desc.enumeration) {
1148 control_ui->vbox->pack_end (*control_ui->display, false, false);
1149 control_ui->vbox->pack_end (control_ui->label, false, false);
1151 /* set up a meter for float ports */
1153 MeterInfo * info = new MeterInfo();
1154 control_ui->meterinfo = info;
1156 info->meter = new FastMeter (
1157 5, 5, FastMeter::Vertical, 0,
1159 0x008800ff, 0x008800ff,
1160 0x00ff00ff, 0x00ff00ff,
1161 0xcccc00ff, 0xcccc00ff,
1162 0xffaa00ff, 0xffaa00ff,
1164 UIConfiguration::instance().color ("meter background bottom"),
1165 UIConfiguration::instance().color ("meter background top")
1168 control_ui->label.set_angle(90);
1170 HBox* center = manage (new HBox);
1171 center->set_spacing(1);
1172 center->pack_start (control_ui->label, false, false);
1173 center->pack_start (*info->meter, false, false);
1175 control_ui->hbox = manage (new HBox);
1176 control_ui->hbox->pack_start (*center, true, false);
1178 // horizontally center this hbox in the vbox
1179 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1181 control_ui->meterinfo->meter->show_all();
1182 control_ui->meterinfo->packed = true;
1183 control_ui->vbox->pack_start (*control_ui->display, false, false);
1186 control_ui->pack_start (*control_ui->vbox);
1188 output_controls.push_back (control_ui);
1192 mcontrol->Changed.connect(control_connections, invalidator(*this),
1193 boost::bind(&GenericPluginUI::ui_parameter_changed,
1202 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1203 Gtk::Requisition astate_req (cui->automate_button.size_request());
1204 const int size = (int) (astate_req.height * 1.5);
1205 req->width = max(req->width, size);
1206 req->height = max(req->height, size);
1211 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1213 if (ev->button != 1) {
1217 using namespace Menu_Helpers;
1219 if (automation_menu == 0) {
1220 automation_menu = manage (new Menu);
1221 automation_menu->set_name ("ArdourContextMenu");
1222 automation_menu->set_reserve_toggle_size(false);
1225 MenuList& items (automation_menu->items());
1228 items.push_back (MenuElem (S_("Automation|Manual"),
1229 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1230 items.push_back (MenuElem (_("Play"),
1231 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1232 items.push_back (MenuElem (_("Write"),
1233 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1234 items.push_back (MenuElem (_("Touch"),
1235 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1236 items.push_back (MenuElem (_("Latch"),
1237 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Latch, cui)));
1239 anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1246 GenericPluginUI::set_all_automation (AutoState as)
1248 for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1249 set_automation_state (as, (*i));
1254 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1256 insert->set_parameter_automation_state (cui->parameter(), state);
1260 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1262 if (!cui->update_pending) {
1263 cui->update_pending = true;
1264 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1269 GenericPluginUI::update_control_display (ControlUI* cui)
1271 /* XXX how do we handle logarithmic stuff here ? */
1273 cui->update_pending = false;
1275 float val = cui->control->get_value();
1277 PBD::Unwinder<bool> (cui->ignore_change, true);
1279 if (cui->combo && cui->scale_points) {
1280 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1281 if (it->second == val) {
1282 cui->combo->set_text(it->first);
1286 } else if (cui->button) {
1287 // AutomationController handles this
1290 if( cui->controller ) {
1291 cui->controller->display_effective_value();
1296 if (cui->logarithmic) {
1299 if (val != cui->adjustment->get_value()) {
1300 cui->adjustment->set_value (val);
1306 GenericPluginUI::update_input_displays ()
1308 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1309 for (vector<ControlUI*>::iterator i = input_controls.begin();
1310 i != input_controls.end();
1312 update_control_display(*i);
1318 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1320 if (!cui->ignore_change) {
1321 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1326 GenericPluginUI::start_updating (GdkEventAny*)
1328 if (output_controls.size() > 0 ) {
1329 screen_update_connection.disconnect();
1330 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1336 GenericPluginUI::stop_updating (GdkEventAny*)
1338 if (output_controls.size() > 0 ) {
1339 screen_update_connection.disconnect();
1345 GenericPluginUI::output_update ()
1347 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1348 float val = plugin->get_parameter ((*i)->parameter().id());
1350 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1351 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1352 size_t len = str.copy(buf, 31);
1354 (*i)->display_label->set_text (buf);
1356 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1357 (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1363 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1364 Gtk::FileChooserButton* widget)
1366 plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1370 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1372 FilePathControls::iterator c = _filepath_controls.find(key);
1373 if (c != _filepath_controls.end()) {
1374 c->second->set_filename(value.get_path());
1376 std::cerr << "warning: property change for property with no control" << std::endl;
1381 GenericPluginUI::toggle_pianokeyboard ()
1383 if (_plugin_pianokeyboard_expander.get_expanded()) {
1384 _plugin_pianokeyboard_expander.add (_pianobox);
1385 _pianobox.show_all ();
1387 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1388 _plugin_pianokeyboard_expander.get_child ()->hide ();
1389 _plugin_pianokeyboard_expander.remove ();
1391 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1393 Gtk::Requisition wr;
1394 toplevel->get_size (wr.width, wr.height);
1395 wr.height -= child_height;
1396 toplevel->resize (wr.width, wr.height);
1402 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1404 ((GenericPluginUI*)arg)->note_on_event_handler(note);
1408 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1410 ((GenericPluginUI*)arg)->note_off_event_handler(note);
1414 GenericPluginUI::note_on_event_handler (int note)
1416 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1417 _pianomm->grab_focus ();
1418 uint8_t channel = _piano_channel.get_value_as_int () - 1;
1420 event[0] = (MIDI_CMD_NOTE_ON | channel);
1422 event[2] = _piano_velocity.get_value_as_int ();
1424 mt->write_immediate_event (3, event);
1426 insert->write_immediate_event (3, event);
1431 GenericPluginUI::note_off_event_handler (int note)
1433 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1434 uint8_t channel = _piano_channel.get_value_as_int () - 1;
1436 event[0] = (MIDI_CMD_NOTE_OFF | channel);
1440 mt->write_immediate_event (3, event);
1442 insert->write_immediate_event (3, event);