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/fastmeter.h"
55 #include "widgets/slider_controller.h"
56 #include "widgets/tooltips.h"
58 #include "plugin_ui.h"
59 #include "plugin_display.h"
60 #include "gui_thread.h"
61 #include "automation_controller.h"
62 #include "gain_meter.h"
64 #include "ui_config.h"
69 using namespace ARDOUR;
71 using namespace Gtkmm2ext;
72 using namespace ArdourWidgets;
74 using namespace ARDOUR_UI_UTILS;
76 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
79 , is_scrollable(scrollable)
80 , _plugin_pianokeyboard_expander (_("MIDI Keyboard"))
83 , _piano_velocity (*manage (new Adjustment (100, 1, 127, 1, 16)))
84 , _piano_channel (*manage (new Adjustment (0, 1, 16, 1, 1)))
86 set_name ("PluginEditor");
87 set_border_width (10);
88 //set_homogeneous (false);
90 pack_start (main_contents, true, true);
91 settings_box.set_homogeneous (false);
93 HBox* constraint_hbox = manage (new HBox);
94 HBox* smaller_hbox = manage (new HBox);
95 smaller_hbox->set_spacing (4);
96 Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
97 combo_label->set_use_markup (true);
99 latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
100 set_latency_label ();
102 smaller_hbox->pack_start (latency_button, false, false, 4);
103 smaller_hbox->pack_start (pin_management_button, false, false, 4);
104 smaller_hbox->pack_start (_preset_combo, false, false);
105 smaller_hbox->pack_start (_preset_modified, false, false);
106 smaller_hbox->pack_start (add_button, false, false);
107 smaller_hbox->pack_start (save_button, false, false);
108 smaller_hbox->pack_start (delete_button, false, false);
109 if (pi->controls().size() > 0) {
110 smaller_hbox->pack_start (reset_button, false, false, 4);
112 smaller_hbox->pack_start (bypass_button, false, true, 4);
114 automation_manual_all_button.set_text(_("Manual"));
115 automation_manual_all_button.set_name (X_("generic button"));
116 automation_play_all_button.set_text(_("Play"));
117 automation_play_all_button.set_name (X_("generic button"));
118 automation_write_all_button.set_text(_("Write"));
119 automation_write_all_button.set_name (X_("generic button"));
120 automation_touch_all_button.set_text(_("Touch"));
121 automation_touch_all_button.set_name (X_("generic button"));
122 automation_latch_all_button.set_text(_("Touch"));
123 automation_latch_all_button.set_name (X_("generic button"));
125 constraint_hbox->set_spacing (5);
126 constraint_hbox->set_homogeneous (false);
128 VBox* v1_box = manage (new VBox);
129 VBox* v2_box = manage (new VBox);
130 if (pi->is_instrument ()) {
131 _piano = (PianoKeyboard*)piano_keyboard_new();
132 _pianomm = Glib::wrap((GtkWidget*)_piano);
133 _pianomm->set_flags(Gtk::CAN_FOCUS);
134 _pianomm->add_events(Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
136 g_signal_connect (G_OBJECT (_piano), "note-on", G_CALLBACK (GenericPluginUI::_note_on_event_handler), this);
137 g_signal_connect (G_OBJECT (_piano), "note-off", G_CALLBACK (GenericPluginUI::_note_off_event_handler), this);
139 HBox* box = manage (new HBox);
140 box->pack_start (*manage (new Label (_("Channel:"))), false, false);
141 box->pack_start (_piano_channel, false, false);
142 box->pack_start (*manage (new Label (_("Velocity:"))), false, false);
143 box->pack_start (_piano_velocity, false, false);
145 Box* box2 = manage (new HBox ());
146 box2->pack_start (*box, true, false);
148 _pianobox.set_spacing (4);
149 _pianobox.pack_start (*box2, true, true);
150 _pianobox.pack_start (*_pianomm, true, true);
152 _plugin_pianokeyboard_expander.set_expanded(false);
153 _plugin_pianokeyboard_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &GenericPluginUI::toggle_pianokeyboard));
155 pack_end (_plugin_pianokeyboard_expander, false, false);
157 pack_end (plugin_analysis_expander, false, false);
160 pack_end (cpuload_expander, false, false);
162 if (!plugin->get_docs().empty()) {
163 pack_end (description_expander, false, false);
166 v1_box->set_spacing (6);
167 v1_box->pack_start (*smaller_hbox, false, true);
168 if (pi->controls().size() > 0) {
169 HBox* automation_hbox = manage (new HBox);
170 automation_hbox->set_spacing (6);
171 Label* l = manage (new Label (_("All Automation")));
172 l->set_alignment (1.0, 0.5);
173 automation_hbox->pack_start (*l, true, true);
174 automation_hbox->pack_start (automation_manual_all_button, false, false);
175 automation_hbox->pack_start (automation_play_all_button, false, false);
176 automation_hbox->pack_start (automation_write_all_button, false, false);
177 automation_hbox->pack_start (automation_touch_all_button, false, false);
178 v1_box->pack_start (*automation_hbox, false, true);
180 v2_box->pack_start (focus_button, false, true);
182 main_contents.pack_start (settings_box, false, false);
184 constraint_hbox->pack_end (*v2_box, false, false);
185 constraint_hbox->pack_end (*v1_box, false, false);
187 main_contents.pack_start (*constraint_hbox, false, false);
189 pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
191 bypass_button.set_active (!pi->enabled());
193 /* ScrolledWindow will wrap hpacker in a Viewport */
194 scroller.add (hpacker);
195 Viewport* view = static_cast<Viewport*>(scroller.get_child());
196 view->set_shadow_type(Gtk::SHADOW_NONE);
198 main_contents.pack_start (scroller, true, true);
203 if (insert->plugin()->has_midnam() && insert->plugin()->knows_bank_patch()) {
208 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
209 scroller.set_name ("PluginEditor");
211 scroller.signal_size_request().connect (sigc::mem_fun(*this, &GenericPluginUI::scroller_size_request));
212 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
215 main_contents.show ();
218 GenericPluginUI::~GenericPluginUI ()
220 if (output_controls.size() > 0) {
221 screen_update_connection.disconnect();
227 GenericPluginUI::scroller_size_request (Gtk::Requisition* a)
229 GtkRequisition request = hpacker.size_request();
231 Glib::RefPtr<Gdk::Window> window (get_window());
232 Glib::RefPtr<Gdk::Screen> screen;
235 screen = get_screen();
239 a->width = request.width;
243 Gdk::Rectangle monitor;
244 const int monitor_num = screen->get_monitor_at_window (window);
245 screen->get_monitor_geometry (
246 (monitor_num < 0) ? 0 : monitor_num,
249 const int maximum_width = monitor.get_width() * 0.9;
251 if (request.width > maximum_width) {
252 for (vector<ControlUI*>::const_iterator cuip = input_controls.begin();
253 cuip != input_controls.end();
255 if (!(*cuip)->short_autostate)
256 set_short_autostate(*cuip, true);
258 request = hpacker.size_request();
261 a->width = min(request.width, maximum_width);
264 // Some functions for calculating the 'similarity' of two plugin
267 static int get_number(string label) {
268 static const char *digits = "0123456789";
271 std::size_t first_digit_pos = label.find_first_of(digits);
272 if (first_digit_pos != string::npos) {
273 // found some digits: there's a number in there somewhere
275 s << label.substr(first_digit_pos);
281 static int match_or_digit(char c1, char c2) {
282 return c1 == c2 || (isdigit(c1) && isdigit(c2));
285 static std::size_t matching_chars_at_head(const string s1, const string s2) {
286 std::size_t length, n = 0;
288 length = min(s1.length(), s2.length());
290 if (!match_or_digit(s1[n], s2[n]))
297 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
298 std::size_t s1pos, s2pos, n = 0;
302 while (s1pos-- > 0 && s2pos-- > 0) {
303 if (!match_or_digit(s1[s1pos], s2[s2pos]) )
310 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
311 static const float default_similarity_threshold = 0.3;
314 GenericPluginUI::build ()
316 std::vector<ControlUI *> control_uis;
317 bool grid = plugin->parameter_count() > 0;
319 // Build a ControlUI for each control port
320 for (size_t i = 0; i < plugin->parameter_count(); ++i) {
322 if (plugin->parameter_is_control (i)) {
324 /* Don't show latency control ports */
326 const Evoral::Parameter param(PluginAutomation, 0, i);
327 if (plugin->describe_parameter (param) == X_("latency")) {
331 if (plugin->describe_parameter (param) == X_("hidden")) {
335 const float value = plugin->get_parameter(i);
338 Plugin::UILayoutHint hint;
340 if (!plugin->get_layout(i, hint)) {
344 boost::shared_ptr<ARDOUR::AutomationControl> c
345 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
346 insert->control(param));
348 ParameterDescriptor desc;
349 plugin->get_parameter_descriptor(i, desc);
350 if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
351 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
362 const std::string param_docs = plugin->get_parameter_docs(i);
363 if (!param_docs.empty()) {
364 set_tooltip(cui, param_docs.c_str());
367 control_uis.push_back(cui);
371 // Build a ControlUI for each property
372 const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
373 for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
374 const ParameterDescriptor& desc = d->second;
375 const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key);
377 boost::shared_ptr<ARDOUR::AutomationControl> c
378 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
379 insert->control(param));
382 error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
386 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
388 error << string_compose(_("Plugin Editor: could not build control element for property %1"),
393 control_uis.push_back(cui);
395 if (!descs.empty()) {
396 /* Listen for property changes that are not notified normally because
397 * AutomationControl has only support for numeric values currently.
398 * The only case is Variant::PATH for now */
399 plugin->PropertyChanged.connect(*this, invalidator(*this),
400 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
403 /* and query current property value */
404 plugin->announce_property_values();
408 custom_layout (control_uis);
410 automatic_layout (control_uis);
415 automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
416 automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
417 automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
418 automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
419 automation_latch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Latch));
421 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
422 plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
427 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
431 static const int32_t initial_button_rows = 12;
432 static const int32_t initial_button_cols = 1;
433 static const int32_t initial_output_rows = 1;
434 static const int32_t initial_output_cols = 4;
436 Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
437 Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
442 int output_row, output_col;
443 int button_row, button_col;
444 int output_rows, output_cols;
445 int button_rows, button_cols;
447 hpacker.set_spacing (10);
448 hpacker.set_border_width (10);
450 output_rows = initial_output_rows;
451 output_cols = initial_output_cols;
452 button_rows = initial_button_rows;
453 button_cols = initial_button_cols;
459 button_table->set_homogeneous (false);
460 button_table->set_row_spacings (2);
461 button_table->set_col_spacings (2);
462 button_table->set_border_width (5);
464 output_table->set_homogeneous (true);
465 output_table->set_row_spacings (2);
466 output_table->set_col_spacings (2);
467 output_table->set_border_width (5);
470 bt_frame = manage (new Frame);
471 bt_frame->set_name ("BaseFrame");
472 bt_frame->set_label (_("Switches"));
473 bt_frame->add (*button_table);
474 hpacker.pack_start(*bt_frame, true, true);
476 box = manage (new VBox);
477 box->set_border_width (5);
478 box->set_spacing (1);
480 frame = manage (new Frame);
481 frame->set_name ("BaseFrame");
482 frame->set_label (_("Controls"));
484 hpacker.pack_start(*frame, true, true);
486 // Add special controls to UI, and build list of normal controls to be layed out later
487 std::vector<ControlUI *> cui_controls_list;
488 for (size_t i = 0; i < control_uis.size(); ++i) {
489 ControlUI* cui = control_uis[i];
491 if (cui->button || cui->file_button) {
493 if (!is_scrollable && button_row == button_rows) {
495 if (++button_col == button_cols) {
497 button_table->resize (button_rows, button_cols);
501 button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
505 } else if (cui->controller || cui->combo) {
506 // Get all of the controls into a list, so that
507 // we can lay them out a bit more nicely later.
508 cui_controls_list.push_back(cui);
510 } else if (cui->display) {
512 output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
515 // TODO: The meters should be divided into multiple rows
517 if (++output_col == output_cols) {
519 output_table->resize (output_rows, output_cols);
524 // Iterate over the list of controls to find which adjacent controls
525 // are similar enough to be grouped together.
527 string label, previous_label = "";
528 std::vector<int> numbers_in_labels(cui_controls_list.size());
530 std::vector<float> similarity_scores(cui_controls_list.size());
531 float most_similar = 0.0, least_similar = 1.0;
534 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
535 label = (*cuip)->label.get_text();
536 numbers_in_labels[i] = get_number(label);
539 // A hand-wavy calculation of how similar this control's
540 // label is to the previous.
541 similarity_scores[i] =
543 ( matching_chars_at_head(label, previous_label) +
544 matching_chars_at_tail(label, previous_label) +
547 ) / (label.length() + previous_label.length());
548 if (numbers_in_labels[i] >= 0) {
549 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
551 least_similar = min(least_similar, similarity_scores[i]);
552 most_similar = max(most_similar, similarity_scores[i]);
554 similarity_scores[0] = 1.0;
557 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
558 previous_label = label;
562 // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
563 float similarity_threshold;
565 if (most_similar > 1.0) {
566 similarity_threshold = default_similarity_threshold;
568 similarity_threshold = most_similar - (1 - default_similarity_threshold);
571 // Now iterate over the list of controls to display them, placing an
572 // HSeparator between controls of less than a certain similarity, and
573 // starting a new column when necessary.
576 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
578 ControlUI* cui = *cuip;
580 if (!is_scrollable) {
584 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
585 if (x > min_controls_per_column) {
586 frame = manage (new Frame);
587 frame->set_name ("BaseFrame");
588 frame->set_label (_("Controls"));
589 box = manage (new VBox);
590 box->set_border_width (5);
591 box->set_spacing (1);
593 hpacker.pack_start(*frame, true, true);
596 HSeparator *split = new HSeparator();
597 split->set_size_request(-1, 5);
598 box->pack_start(*split, false, false, 0);
602 box->pack_start (*cui, false, false);
609 if (box->children().empty()) {
610 hpacker.remove (*frame);
613 if (button_table->children().empty()) {
614 hpacker.remove (*bt_frame);
617 button_table->show_all ();
620 if (!output_table->children().empty()) {
621 frame = manage (new Frame);
622 frame->set_name ("BaseFrame");
623 frame->set_label(_("Meters"));
624 frame->add (*output_table);
625 hpacker.pack_end (*frame, true, true);
626 output_table->show_all ();
631 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
632 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
633 hpacker.pack_end (*pd, true, true);
640 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
642 Gtk::Table* layout = manage (new Gtk::Table ());
644 for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
646 if (cui->x0 < 0 || cui->y0 < 0) {
649 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
651 hpacker.pack_start (*layout, true, true);
653 if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
654 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
655 hpacker.pack_end (*pd, true, true);
660 GenericPluginUI::build_midi_table ()
662 Gtk::Table* pgm_table = manage (new Gtk::Table (8, 5));
664 pgm_table->set_homogeneous (false);
665 pgm_table->set_row_spacings (2);
666 pgm_table->set_col_spacings (2);
667 pgm_table->set_border_width (5);
668 pgm_table->set_col_spacing (2, 10);
670 Frame* frame = manage (new Frame);
671 frame->set_name ("BaseFrame");
672 if (dynamic_cast<MidiTrack*> (insert->owner())) {
673 frame->set_label (_("MIDI Programs (sent to track)"));
675 frame->set_label (_("MIDI Programs (volatile)"));
677 frame->add (*pgm_table);
678 hpacker.pack_start (*frame, false, false);
680 for (uint8_t chn = 0; chn < 16; ++chn) {
681 int col = 3 * (chn / 8);
683 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
684 cui->set_sizing_text ("Stereo Grand Piano");
685 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
686 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
687 midi_pgmsel.push_back (cui);
688 pgm_table->attach (*manage (new Label (string_compose ("C%1:", (int)(chn + 1)), ALIGN_RIGHT)), col, col + 1, row, row+1, FILL, SHRINK);
689 pgm_table->attach (*cui, col + 1, col + 2, row, row+1, SHRINK, SHRINK);
692 insert->plugin ()->read_midnam();
694 midi_refill_patches ();
696 insert->plugin()->BankPatchChange.connect (
697 midi_connections, invalidator (*this),
698 boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
701 insert->plugin()->UpdatedMidnam.connect (
702 midi_connections, invalidator (*this),
703 boost::bind (&GenericPluginUI::midi_refill_patches, this),
708 GenericPluginUI::midi_refill_patches ()
710 assert (midi_pgmsel.size() == 16);
714 const std::string model = insert->plugin ()->midnam_model ();
716 const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
717 if (device_modes.size() > 0) {
718 mode = device_modes.front();
721 for (uint8_t chn = 0; chn < 16; ++chn) {
722 midi_pgmsel[chn]->clear_items ();
723 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
724 MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
727 using namespace Menu_Helpers;
728 using namespace Gtkmm2ext;
730 for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
731 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
732 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
733 const std::string pgm = (*j)->name ();
734 MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
735 assert ((*i)->number () == key.bank());
736 const uint32_t bp = (key.bank() << 7) | key.program();
737 midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
743 midi_bank_patch_change (chn);
748 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
750 assert (chn < 16 && midi_pgmsel.size() == 16);
751 uint32_t bankpgm = insert->plugin()->bank_patch (chn);
752 if (bankpgm == UINT32_MAX) {
753 midi_pgmsel[chn]->set_text (_("--Unset--"));
755 int bank = bankpgm >> 7;
756 int pgm = bankpgm & 127;
757 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
758 midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
760 midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
761 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
767 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
769 int bank = bankpgm >> 7;
770 int pgm = bankpgm & 127;
771 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
774 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
775 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
776 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
778 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
779 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
780 program->set_value (pgm, PBD::Controllable::NoGroup);
783 event[0] = (MIDI_CMD_CONTROL | chn);
785 event[2] = bank >> 7;
786 insert->write_immediate_event (3, event);
789 event[2] = bank & 127;
790 insert->write_immediate_event (3, event);
792 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
794 insert->write_immediate_event (2, event);
798 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
800 , automate_button (X_("")) // force creation of a label
810 automate_button.set_name ("plugin automation state button");
811 set_tooltip (automate_button, _("Automation control"));
813 ignore_change = false;
814 update_pending = false;
817 x0 = x1 = y0 = y1 = -1;
820 GenericPluginUI::ControlUI::~ControlUI()
823 delete meterinfo->meter;
829 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
831 cui->short_autostate = value;
833 cui->automate_button.set_sizing_text("M");
835 /* XXX translators: use a string here that will be at least as long
836 as the longest automation label (see ::automation_state_changed()
837 below). be sure to include a descender. */
838 cui->automate_button.set_sizing_text(_("Mgnual"));
840 automation_state_changed(cui);
844 GenericPluginUI::automation_state_changed (ControlUI* cui)
846 /* update button label */
848 // don't lock to avoid deadlock because we're triggered by
849 // AutomationControl::Changed() while the automation lock is taken
851 AutoState state = insert->get_parameter_automation_state (cui->parameter());
853 cui->automate_button.set_active((state != ARDOUR::Off));
855 if (cui->short_autostate) {
856 cui->automate_button.set_text (
857 GainMeterBase::astate_string (state));
861 switch (state & (ARDOUR::Off|Play|Touch|Write|Latch)) {
863 cui->automate_button.set_text (S_("Automation|Manual"));
866 cui->automate_button.set_text (_("Play"));
869 cui->automate_button.set_text (_("Write"));
872 cui->automate_button.set_text (_("Touch"));
875 cui->automate_button.set_text (_("Latch"));
878 cui->automate_button.set_text (_("???"));
884 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
886 float const v = cui->control->interface_to_internal(adj.get_value ());
887 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
888 const size_t len = str.copy(buf, 31);
894 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
896 float const v = cui->control->interface_to_internal(adj.get_value ());
897 const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
898 const size_t len = str.copy(buf, 31);
904 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
906 plugin->print_parameter (param, buf, len);
909 /** Build a ControlUI for a parameter/property.
910 * Note that mcontrol may be NULL for outputs.
912 GenericPluginUI::ControlUI*
913 GenericPluginUI::build_control_ui (const Evoral::Parameter& param,
914 const ParameterDescriptor& desc,
915 boost::shared_ptr<AutomationControl> mcontrol,
920 ControlUI* control_ui = 0;
922 control_ui = manage (new ControlUI (param));
923 control_ui->combo = 0;
924 control_ui->control = mcontrol;
925 control_ui->label.set_text (desc.label);
926 control_ui->label.set_alignment (0.0, 0.5);
927 control_ui->label.set_name ("PluginParameterLabel");
928 control_ui->set_spacing (5);
929 set_short_autostate(control_ui, false);
933 if (desc.datatype == Variant::PATH) {
935 /* We shouldn't get that type for input ports */
936 assert(param.type() == PluginPropertyAutomation);
938 /* Build a file selector button */
940 // Create/add controller
941 control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
942 control_ui->file_button->set_title(desc.label);
945 control_ui->knobtable = manage (new Table());
946 control_ui->pack_start(*control_ui->knobtable, true, false);
947 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
948 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
950 control_ui->pack_start (control_ui->label, false, true);
951 control_ui->pack_start (*control_ui->file_button, true, true);
954 // Monitor changes from the user.
955 control_ui->file_button->signal_file_set().connect(
956 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
957 desc, control_ui->file_button));
959 /* Add the filebutton control to a map so that we can update it when
960 * the corresponding property changes. This doesn't go through the usual
961 * AutomationControls, because they don't support non-numeric values. */
962 _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
969 /* See if there any named values for our input value */
970 control_ui->scale_points = desc.scale_points;
972 /* If this parameter is an integer, work out the number of distinct values
973 it can take on (assuming that lower and upper values are allowed).
975 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
977 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
980 * a) There is a label for each possible value of this input, or
981 * b) This port is marked as being an enumeration.
984 control_ui->combo = new ArdourDropdown();
985 for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
986 i != control_ui->scale_points->end();
988 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
990 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
995 control_ui->combo->set_controllable (mcontrol);
997 update_control_display(control_ui);
1001 /* create the controller */
1003 /* XXX memory leak: SliderController not destroyed by ControlUI
1004 * destructor, and manage() reports object hierarchy
1007 control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
1009 /* Control UI's don't need the rapid timer workaround */
1010 control_ui->controller->stop_updating ();
1012 /* XXX this code is not right yet, because it doesn't handle
1013 the absence of bounds in any sensible fashion.
1016 Adjustment* adj = control_ui->controller->adjustment();
1019 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1021 but->set_tweaks(ArdourButton::Square);
1022 } else if (use_knob) {
1023 /* Delay size request so that styles are gotten right */
1024 control_ui->controller->widget()->signal_size_request().connect(
1025 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1027 control_ui->controller->set_size_request (200, -1);
1028 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1029 if (desc.integer_step) {
1030 AutomationBarController* abc = dynamic_cast <AutomationBarController*> (control_ui->controller->widget ());
1032 abc->set_digits (0);
1036 if (!desc.integer_step && !desc.toggled && use_knob) {
1037 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1040 adj->set_value (mcontrol->internal_to_interface(value));
1045 set_short_autostate(control_ui, true);
1047 control_ui->label.set_alignment (0.5, 0.5);
1048 control_ui->knobtable = manage (new Table());
1049 control_ui->pack_start(*control_ui->knobtable, true, true);
1051 if (control_ui->combo) {
1052 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1053 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1054 } else if (control_ui->spin_box) {
1055 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1056 knob->set_tooltip_prefix (desc.label + ": ");
1057 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1058 align->add (*control_ui->controller);
1059 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1060 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1061 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1062 } else if (desc.toggled) {
1063 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1064 align->add (*control_ui->controller);
1065 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1066 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1067 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1069 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1070 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1071 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1076 control_ui->pack_start (control_ui->label, true, true);
1077 if (control_ui->combo) {
1078 control_ui->pack_start(*control_ui->combo, false, true);
1079 } else if (control_ui->spin_box) {
1080 control_ui->pack_start (*control_ui->spin_box, false, false);
1081 control_ui->pack_start (*control_ui->controller, false, false);
1083 control_ui->pack_start (*control_ui->controller, false, false);
1085 control_ui->pack_start (control_ui->automate_button, false, false);
1089 if (mcontrol->flags () & Controllable::NotAutomatable) {
1090 control_ui->automate_button.set_sensitive (false);
1091 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1093 control_ui->automate_button.signal_button_press_event().connect (
1094 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1097 mcontrol->alist()->automation_state_changed.connect (
1098 control_connections,
1099 invalidator (*this),
1100 boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1102 input_controls_with_automation.push_back (control_ui);
1105 if (desc.toggled && !control_ui->combo) {
1106 control_ui->button = true;
1107 ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1109 but->set_name ("pluginui toggle");
1110 update_control_display(control_ui);
1113 automation_state_changed (control_ui);
1115 /* Add to the list of CUIs that need manual update to workaround
1116 * AutomationControl not knowing about preset loads */
1117 input_controls.push_back (control_ui);
1121 control_ui->display = manage (new EventBox);
1122 control_ui->display->set_name ("ParameterValueDisplay");
1124 control_ui->display_label = manage (new Label);
1126 control_ui->display_label->set_name ("ParameterValueDisplay");
1128 control_ui->display->add (*control_ui->display_label);
1129 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1131 control_ui->display->show_all ();
1133 control_ui->vbox = manage (new VBox);
1134 control_ui->vbox->set_spacing(3);
1136 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1137 control_ui->vbox->pack_end (*control_ui->display, false, false);
1138 control_ui->vbox->pack_end (control_ui->label, false, false);
1139 } else if (desc.integer_step || desc.enumeration) {
1140 control_ui->vbox->pack_end (*control_ui->display, false, false);
1141 control_ui->vbox->pack_end (control_ui->label, false, false);
1143 /* set up a meter for float ports */
1145 MeterInfo * info = new MeterInfo();
1146 control_ui->meterinfo = info;
1148 info->meter = new FastMeter (
1149 5, 5, FastMeter::Vertical, 0,
1151 0x008800ff, 0x008800ff,
1152 0x00ff00ff, 0x00ff00ff,
1153 0xcccc00ff, 0xcccc00ff,
1154 0xffaa00ff, 0xffaa00ff,
1156 UIConfiguration::instance().color ("meter background bottom"),
1157 UIConfiguration::instance().color ("meter background top")
1160 control_ui->label.set_angle(90);
1162 HBox* center = manage (new HBox);
1163 center->set_spacing(1);
1164 center->pack_start (control_ui->label, false, false);
1165 center->pack_start (*info->meter, false, false);
1167 control_ui->hbox = manage (new HBox);
1168 control_ui->hbox->pack_start (*center, true, false);
1170 // horizontally center this hbox in the vbox
1171 control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1173 control_ui->meterinfo->meter->show_all();
1174 control_ui->meterinfo->packed = true;
1175 control_ui->vbox->pack_start (*control_ui->display, false, false);
1178 control_ui->pack_start (*control_ui->vbox);
1180 output_controls.push_back (control_ui);
1184 mcontrol->Changed.connect(control_connections, invalidator(*this),
1185 boost::bind(&GenericPluginUI::ui_parameter_changed,
1194 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1195 Gtk::Requisition astate_req (cui->automate_button.size_request());
1196 const int size = (int) (astate_req.height * 1.5);
1197 req->width = max(req->width, size);
1198 req->height = max(req->height, size);
1203 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1205 if (ev->button != 1) {
1209 using namespace Menu_Helpers;
1211 if (automation_menu == 0) {
1212 automation_menu = manage (new Menu);
1213 automation_menu->set_name ("ArdourContextMenu");
1214 automation_menu->set_reserve_toggle_size(false);
1217 MenuList& items (automation_menu->items());
1220 items.push_back (MenuElem (S_("Automation|Manual"),
1221 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1222 items.push_back (MenuElem (_("Play"),
1223 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1224 items.push_back (MenuElem (_("Write"),
1225 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1226 items.push_back (MenuElem (_("Touch"),
1227 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1228 items.push_back (MenuElem (_("Latch"),
1229 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Latch, cui)));
1231 anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1238 GenericPluginUI::set_all_automation (AutoState as)
1240 for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1241 set_automation_state (as, (*i));
1246 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1248 insert->set_parameter_automation_state (cui->parameter(), state);
1252 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1254 if (!cui->update_pending) {
1255 cui->update_pending = true;
1256 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1261 GenericPluginUI::update_control_display (ControlUI* cui)
1263 /* XXX how do we handle logarithmic stuff here ? */
1265 cui->update_pending = false;
1267 float val = cui->control->get_value();
1269 PBD::Unwinder<bool> (cui->ignore_change, true);
1271 if (cui->combo && cui->scale_points) {
1272 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1273 if (it->second == val) {
1274 cui->combo->set_text(it->first);
1278 } else if (cui->button) {
1279 // AutomationController handles this
1282 if( cui->controller ) {
1283 cui->controller->display_effective_value();
1288 if (cui->logarithmic) {
1291 if (val != cui->adjustment->get_value()) {
1292 cui->adjustment->set_value (val);
1298 GenericPluginUI::update_input_displays ()
1300 /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1301 for (vector<ControlUI*>::iterator i = input_controls.begin();
1302 i != input_controls.end();
1304 update_control_display(*i);
1310 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1312 if (!cui->ignore_change) {
1313 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1318 GenericPluginUI::start_updating (GdkEventAny*)
1320 if (output_controls.size() > 0 ) {
1321 screen_update_connection.disconnect();
1322 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1328 GenericPluginUI::stop_updating (GdkEventAny*)
1330 if (output_controls.size() > 0 ) {
1331 screen_update_connection.disconnect();
1337 GenericPluginUI::output_update ()
1339 for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1340 float val = plugin->get_parameter ((*i)->parameter().id());
1342 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1343 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1344 size_t len = str.copy(buf, 31);
1346 (*i)->display_label->set_text (buf);
1348 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1349 (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1355 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1356 Gtk::FileChooserButton* widget)
1358 plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1362 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1364 FilePathControls::iterator c = _filepath_controls.find(key);
1365 if (c != _filepath_controls.end()) {
1366 c->second->set_filename(value.get_path());
1368 std::cerr << "warning: property change for property with no control" << std::endl;
1373 GenericPluginUI::toggle_pianokeyboard ()
1375 if (_plugin_pianokeyboard_expander.get_expanded()) {
1376 _plugin_pianokeyboard_expander.add (_pianobox);
1377 _pianobox.show_all ();
1379 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1380 _plugin_pianokeyboard_expander.get_child ()->hide ();
1381 _plugin_pianokeyboard_expander.remove ();
1383 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1385 Gtk::Requisition wr;
1386 toplevel->get_size (wr.width, wr.height);
1387 wr.height -= child_height;
1388 toplevel->resize (wr.width, wr.height);
1394 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1396 ((GenericPluginUI*)arg)->note_on_event_handler(note);
1400 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1402 ((GenericPluginUI*)arg)->note_off_event_handler(note);
1406 GenericPluginUI::note_on_event_handler (int note)
1408 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1409 _pianomm->grab_focus ();
1410 uint8_t channel = _piano_channel.get_value_as_int () - 1;
1412 event[0] = (MIDI_CMD_NOTE_ON | channel);
1414 event[2] = _piano_velocity.get_value_as_int ();
1416 mt->write_immediate_event (3, event);
1418 insert->write_immediate_event (3, event);
1423 GenericPluginUI::note_off_event_handler (int note)
1425 MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1426 uint8_t channel = _piano_channel.get_value_as_int () - 1;
1428 event[0] = (MIDI_CMD_NOTE_OFF | channel);
1432 mt->write_immediate_event (3, event);
1434 insert->write_immediate_event (3, event);