X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fgeneric_pluginui.cc;h=0f665d78917f753ce0bcbd2bfb102ea980a5c43c;hb=eb1e423b7521d4c277c11a884113f40e7406ade8;hp=faec8fb4ae109f56d864844073e58b4a425d5a03;hpb=86343b6c15a3a43f082802484d2bc813d34db821;p=ardour.git diff --git a/gtk2_ardour/generic_pluginui.cc b/gtk2_ardour/generic_pluginui.cc index faec8fb4ae..0f665d7891 100644 --- a/gtk2_ardour/generic_pluginui.cc +++ b/gtk2_ardour/generic_pluginui.cc @@ -27,45 +27,49 @@ #include #include +#include + #include "pbd/stl_delete.h" +#include "pbd/unwind.h" #include "pbd/xml++.h" #include "pbd/failed_constructor.h" -#include -#include -#include -#include -#include -#include - #include "ardour/plugin.h" #include "ardour/plugin_insert.h" #include "ardour/session.h" +#include "ardour/value_as_string.h" + +#include "gtkmm2ext/utils.h" +#include "gtkmm2ext/doi.h" + +#include "widgets/ardour_knob.h" +#include "widgets/click_box.h" +#include "widgets/fastmeter.h" +#include "widgets/slider_controller.h" +#include "widgets/tooltips.h" -#include "ardour_ui.h" #include "prompter.h" #include "plugin_ui.h" -#include "utils.h" #include "gui_thread.h" #include "automation_controller.h" +#include "gain_meter.h" +#include "timers.h" +#include "ui_config.h" -#include "i18n.h" +#include "pbd/i18n.h" using namespace std; using namespace ARDOUR; using namespace PBD; using namespace Gtkmm2ext; +using namespace ArdourWidgets; using namespace Gtk; +using namespace ARDOUR_UI_UTILS; GenericPluginUI::GenericPluginUI (boost::shared_ptr pi, bool scrollable) - : PlugUIBase (pi), - button_table (initial_button_rows, initial_button_cols), - output_table (initial_output_rows, initial_output_cols), - hAdjustment(0.0, 0.0, 0.0), - vAdjustment(0.0, 0.0, 0.0), - scroller_view(hAdjustment, vAdjustment), - automation_menu (0), - is_scrollable(scrollable) + : PlugUIBase (pi) + , automation_menu (0) + , is_scrollable(scrollable) { set_name ("PluginEditor"); set_border_width (10); @@ -76,21 +80,41 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr pi, bool scrol HBox* constraint_hbox = manage (new HBox); HBox* smaller_hbox = manage (new HBox); + HBox* automation_hbox = manage (new HBox); smaller_hbox->set_spacing (4); + automation_hbox->set_spacing (6); Label* combo_label = manage (new Label (_("Presets"))); combo_label->set_use_markup (true); - latency_button.add (latency_label); - latency_button.signal_clicked().connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked)); + latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked)); set_latency_label (); - smaller_hbox->pack_start (latency_button, false, false, 10); + smaller_hbox->pack_start (latency_button, false, false, 4); + smaller_hbox->pack_start (pin_management_button, false, false, 4); smaller_hbox->pack_start (_preset_combo, false, false); smaller_hbox->pack_start (_preset_modified, false, false); smaller_hbox->pack_start (add_button, false, false); smaller_hbox->pack_start (save_button, false, false); smaller_hbox->pack_start (delete_button, false, false); - smaller_hbox->pack_start (bypass_button, false, true); + smaller_hbox->pack_start (reset_button, false, false, 4); + smaller_hbox->pack_start (bypass_button, false, true, 4); + + automation_manual_all_button.set_text(_("Manual")); + automation_manual_all_button.set_name (X_("generic button")); + automation_play_all_button.set_text(_("Play")); + automation_play_all_button.set_name (X_("generic button")); + automation_write_all_button.set_text(_("Write")); + automation_write_all_button.set_name (X_("generic button")); + automation_touch_all_button.set_text(_("Touch")); + automation_touch_all_button.set_name (X_("generic button")); + + Label* l = manage (new Label (_("All Automation"))); + l->set_alignment (1.0, 0.5); + automation_hbox->pack_start (*l, true, true); + automation_hbox->pack_start (automation_manual_all_button, false, false); + automation_hbox->pack_start (automation_play_all_button, false, false); + automation_hbox->pack_start (automation_write_all_button, false, false); + automation_hbox->pack_start (automation_touch_all_button, false, false); constraint_hbox->set_spacing (5); constraint_hbox->set_homogeneous (false); @@ -102,7 +126,9 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr pi, bool scrol pack_end (description_expander, false, false); } + v1_box->set_spacing (6); v1_box->pack_start (*smaller_hbox, false, true); + v1_box->pack_start (*automation_hbox, false, true); v2_box->pack_start (focus_button, false, true); main_contents.pack_start (settings_box, false, false); @@ -112,25 +138,31 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr pi, bool scrol main_contents.pack_start (*constraint_hbox, false, false); - if (is_scrollable ) { - scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC); - scroller.set_name ("PluginEditor"); - scroller_view.set_name("PluginEditor"); - scroller_view.add (hpacker); - scroller.add (scroller_view); - - main_contents.pack_start (scroller, true, true); - + if (is_scrollable) { + Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow()); + scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC); + scroller->set_name ("PluginEditor"); + scroller->add (hpacker); + main_contents.pack_start (*scroller, true, true); } else { main_contents.pack_start (hpacker, false, false); } pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr(pi)), gui_context()); - bypass_button.set_active (!pi->active()); + bypass_button.set_active (!pi->enabled()); prefheight = 0; build (); + + /* Listen for property changes that are not notified normally because + * AutomationControl has only support for numeric values currently. + * The only case is Variant::PATH for now */ + plugin->PropertyChanged.connect(*this, invalidator(*this), + boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2), + gui_context()); + + main_contents.show (); } GenericPluginUI::~GenericPluginUI () @@ -159,7 +191,7 @@ int value = -1; static int match_or_digit(char c1, char c2) { return c1 == c2 || (isdigit(c1) && isdigit(c2)); -} +} static std::size_t matching_chars_at_head(const string s1, const string s2) { std::size_t length, n = 0; @@ -169,7 +201,7 @@ std::size_t length, n = 0; if (!match_or_digit(s1[n], s2[n])) break; n++; - } + } return n; } @@ -182,7 +214,7 @@ std::size_t s1pos, s2pos, n = 0; if (!match_or_digit(s1[s1pos], s2[s2pos]) ) break; n++; - } + } return n; } @@ -192,8 +224,120 @@ static const float default_similarity_threshold = 0.3; void GenericPluginUI::build () { - guint32 i = 0; + std::vector control_uis; + bool grid = plugin->parameter_count() > 0; + + // Build a ControlUI for each control port + for (size_t i = 0; i < plugin->parameter_count(); ++i) { + + if (plugin->parameter_is_control (i)) { + + /* Don't show latency control ports */ + + const Evoral::Parameter param(PluginAutomation, 0, i); + if (plugin->describe_parameter (param) == X_("latency")) { + continue; + } + + if (plugin->describe_parameter (param) == X_("hidden")) { + continue; + } + + const float value = plugin->get_parameter(i); + + ControlUI* cui; + Plugin::UILayoutHint hint; + + if (!plugin->get_layout(i, hint)) { + grid = false; + } + + boost::shared_ptr c + = boost::dynamic_pointer_cast( + insert->control(param)); + + ParameterDescriptor desc; + plugin->get_parameter_descriptor(i, desc); + if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) { + error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg; + continue; + } + + if (grid) { + cui->x0 = hint.x0; + cui->x1 = hint.x1; + cui->y0 = hint.y0; + cui->y1 = hint.y1; + } + + const std::string param_docs = plugin->get_parameter_docs(i); + if (!param_docs.empty()) { + set_tooltip(cui, param_docs.c_str()); + } + + control_uis.push_back(cui); + } + } + + // Build a ControlUI for each property + const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties(); + for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) { + const ParameterDescriptor& desc = d->second; + const Evoral::Parameter param(PluginPropertyAutomation, 0, desc.key); + + boost::shared_ptr c + = boost::dynamic_pointer_cast( + insert->control(param)); + + if (!c) { + error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg; + continue; + } + + ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true); + if (!cui) { + error << string_compose(_("Plugin Editor: could not build control element for property %1"), + desc.key) << endmsg; + continue; + } + + control_uis.push_back(cui); + } + if (!descs.empty()) { + plugin->announce_property_values(); + } + + if (grid) { + custom_layout (control_uis); + } else { + automatic_layout (control_uis); + } + + output_update (); + + automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off)); + automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play)); + automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write)); + automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch)); + + /* XXX This is a workaround for AutomationControl not knowing about preset loads */ + plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ()); +} + + +void +GenericPluginUI::automatic_layout (const std::vector& control_uis) +{ guint32 x = 0; + + static const int32_t initial_button_rows = 12; + static const int32_t initial_button_cols = 1; + static const int32_t initial_output_rows = 1; + static const int32_t initial_output_cols = 4; + + Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols)); + Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols)); + Frame* frame; Frame* bt_frame; VBox* box; @@ -203,6 +347,7 @@ GenericPluginUI::build () int button_rows, button_cols; hpacker.set_spacing (10); + hpacker.set_border_width (10); output_rows = initial_output_rows; output_cols = initial_output_cols; @@ -213,21 +358,20 @@ GenericPluginUI::build () output_col = 0; button_col = 0; - button_table.set_homogeneous (false); - button_table.set_row_spacings (2); - button_table.set_col_spacings (2); - output_table.set_homogeneous (true); - output_table.set_row_spacings (2); - output_table.set_col_spacings (2); - button_table.set_border_width (5); - output_table.set_border_width (5); + button_table->set_homogeneous (false); + button_table->set_row_spacings (2); + button_table->set_col_spacings (2); + output_table->set_homogeneous (true); + output_table->set_row_spacings (2); + output_table->set_col_spacings (2); + button_table->set_border_width (5); + output_table->set_border_width (5); - hpacker.set_border_width (10); bt_frame = manage (new Frame); bt_frame->set_name ("BaseFrame"); bt_frame->set_label (_("Switches")); - bt_frame->add (button_table); + bt_frame->add (*button_table); hpacker.pack_start(*bt_frame, true, true); box = manage (new VBox); @@ -240,82 +384,54 @@ GenericPluginUI::build () frame->add (*box); hpacker.pack_start(*frame, true, true); - /* find all ports. build control elements for all appropriate control ports */ + // Add special controls to UI, and build list of normal controls to be layed out later std::vector cui_controls_list; + for (size_t i = 0; i < control_uis.size(); ++i) { + ControlUI* cui = control_uis[i]; - for (i = 0; i < plugin->parameter_count(); ++i) { - - if (plugin->parameter_is_control (i)) { - - /* Don't show latency control ports */ - - if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("latency")) { - continue; - } - - if (plugin->describe_parameter (Evoral::Parameter(PluginAutomation, 0, i)) == X_("hidden")) { - continue; - } - - ControlUI* cui; - - boost::shared_ptr c - = boost::dynamic_pointer_cast( - insert->control(Evoral::Parameter(PluginAutomation, 0, i))); - - if ((cui = build_control_ui (i, c)) == 0) { - error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg; - continue; - } + if (cui->button || cui->file_button) { - const std::string param_docs = plugin->get_parameter_docs(i); - if (!param_docs.empty()) { - ARDOUR_UI::instance()->set_tip(cui, param_docs.c_str()); + if (!is_scrollable && button_row == button_rows) { + button_row = 0; + if (++button_col == button_cols) { + button_cols += 2; + button_table->resize (button_rows, button_cols); + } } - if (cui->controller || cui->clickbox || cui->combo) { - // Get all of the controls into a list, so that - // we can lay them out a bit more nicely later. - cui_controls_list.push_back(cui); - } else if (cui->button) { - - if (!is_scrollable && button_row == button_rows) { - button_row = 0; - if (++button_col == button_cols) { - button_cols += 2; - button_table.resize (button_rows, button_cols); - } - } + button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1, + FILL|EXPAND, FILL); + button_row++; - button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1, - FILL|EXPAND, FILL); - button_row++; + } else if (cui->controller || cui->clickbox || cui->combo) { + // Get all of the controls into a list, so that + // we can lay them out a bit more nicely later. + cui_controls_list.push_back(cui); - } else if (cui->display) { + } else if (cui->display) { - output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1, - FILL|EXPAND, FILL); + output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1, + FILL|EXPAND, FILL); - // TODO: The meters should be divided into multiple rows + // TODO: The meters should be divided into multiple rows - if (++output_col == output_cols) { - output_cols ++; - output_table.resize (output_rows, output_cols); - } + if (++output_col == output_cols) { + output_cols ++; + output_table->resize (output_rows, output_cols); } - } + } } // Iterate over the list of controls to find which adjacent controls // are similar enough to be grouped together. - + string label, previous_label = ""; std::vector numbers_in_labels(cui_controls_list.size()); - + std::vector similarity_scores(cui_controls_list.size()); float most_similar = 0.0, least_similar = 1.0; - - i = 0; + + size_t i = 0; for (vector::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) { label = (*cuip)->label.get_text(); numbers_in_labels[i] = get_number(label); @@ -323,12 +439,12 @@ GenericPluginUI::build () if (i > 0) { // A hand-wavy calculation of how similar this control's // label is to the previous. - similarity_scores[i] = - (float) ( - ( matching_chars_at_head(label, previous_label) + + similarity_scores[i] = + (float) ( + ( matching_chars_at_head(label, previous_label) + matching_chars_at_tail(label, previous_label) + - 1 - ) + 1 + ) ) / (label.length() + previous_label.length()); if (numbers_in_labels[i] >= 0) { similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]); @@ -340,32 +456,32 @@ GenericPluginUI::build () } // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl; - previous_label = label; + previous_label = label; } - + // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl; float similarity_threshold; - + if (most_similar > 1.0) { similarity_threshold = default_similarity_threshold; } else { similarity_threshold = most_similar - (1 - default_similarity_threshold); } - + // Now iterate over the list of controls to display them, placing an - // HSeparator between controls of less than a certain similarity, and + // HSeparator between controls of less than a certain similarity, and // starting a new column when necessary. - + i = 0; for (vector::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) { ControlUI* cui = *cuip; - + if (!is_scrollable) { x++; } - + if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) { if (x > min_controls_per_column) { frame = manage (new Frame); @@ -395,42 +511,70 @@ GenericPluginUI::build () hpacker.remove (*frame); } - if (button_table.children().empty()) { + if (button_table->children().empty()) { hpacker.remove (*bt_frame); + delete button_table; + } else { + button_table->show_all (); } - if (!output_table.children().empty()) { + if (!output_table->children().empty()) { frame = manage (new Frame); frame->set_name ("BaseFrame"); frame->set_label(_("Meters")); - frame->add (output_table); + frame->add (*output_table); hpacker.pack_end (*frame, true, true); + output_table->show_all (); + } else { + delete output_table; } + show_all(); - output_update (); +} + +void +GenericPluginUI::custom_layout (const std::vector& control_uis) +{ + Gtk::Table* layout = manage (new Gtk::Table ()); - output_table.show_all (); - button_table.show_all (); + for (vector::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) { + ControlUI* cui = *i; + if (cui->x0 < 0 || cui->y0 < 0) { + continue; + } + layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2); + } + hpacker.pack_start (*layout, true, true); } -GenericPluginUI::ControlUI::ControlUI () - : automate_button (X_("")) // force creation of a label +GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p) + : param(p) + , automate_button (X_("")) // force creation of a label + , combo (0) + , clickbox (0) + , file_button (0) + , spin_box (0) + , display (0) + , hbox (0) + , vbox (0) + , meterinfo (0) + , knobtable (0) { - automate_button.set_name ("PluginAutomateButton"); - ARDOUR_UI::instance()->set_tip (automate_button, _("Automation control")); + automate_button.set_name ("plugin automation state button"); + set_tooltip (automate_button, _("Automation control")); /* XXX translators: use a string here that will be at least as long as the longest automation label (see ::automation_state_changed() below). be sure to include a descender. */ - set_size_request_to_display_given_text (automate_button, _("Mgnual"), 15, 10); + automate_button.set_sizing_text(_("Mgnual")); - ignore_change = 0; - display = 0; - button = 0; - clickbox = 0; - meterinfo = 0; + ignore_change = false; + update_pending = false; + button = false; + + x0 = x1 = y0 = y1 = -1; } GenericPluginUI::ControlUI::~ControlUI() @@ -448,70 +592,53 @@ GenericPluginUI::automation_state_changed (ControlUI* cui) // don't lock to avoid deadlock because we're triggered by // AutomationControl::Changed() while the automation lock is taken - switch (insert->get_parameter_automation_state (cui->parameter()) & (ARDOUR::Off|Play|Touch|Write)) { + + AutoState state = insert->get_parameter_automation_state (cui->parameter()); + + cui->automate_button.set_active((state != ARDOUR::Off)); + + if (cui->knobtable) { + cui->automate_button.set_text ( + GainMeterBase::astate_string (state)); + return; + } + + switch (state & (ARDOUR::Off|Play|Touch|Write)) { case ARDOUR::Off: - cui->automate_button.set_label (S_("Automation|Manual")); + cui->automate_button.set_text (S_("Automation|Manual")); break; case Play: - cui->automate_button.set_label (_("Play")); + cui->automate_button.set_text (_("Play")); break; case Write: - cui->automate_button.set_label (_("Write")); + cui->automate_button.set_text (_("Write")); break; case Touch: - cui->automate_button.set_label (_("Touch")); + cui->automate_button.set_text (_("Touch")); break; default: - cui->automate_button.set_label (_("???")); + cui->automate_button.set_text (_("???")); break; } } - bool GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui) { - float const v = adj.get_value (); - - if (cui->scale_points) { - Plugin::ScalePoints::const_iterator i = cui->scale_points->begin (); - while (i != cui->scale_points->end() && i->second != v) { - ++i; - } - - if (i != cui->scale_points->end ()) { - snprintf (buf, 32, "%s", i->first.c_str()); - return true; - } - } - - snprintf (buf, 32, "%.0f", v); + float const v = cui->control->interface_to_internal(adj.get_value ()); + const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v)); + const size_t len = str.copy(buf, 31); + buf[len] = '\0'; return true; } bool GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui) { - float const v = adj.get_value (); - - if (cui->scale_points) { - Plugin::ScalePoints::const_iterator i = cui->scale_points->begin (); - while (i != cui->scale_points->end() && i->second != v) { - ++i; - } - - if (i != cui->scale_points->end ()) { - snprintf (buf, 32, "%s", i->first.c_str()); - return true; - } - } - if (v >= 0 && v <= 127) { - int mn = rint(v); - const char notename[12][3] = { "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" }; - snprintf (buf, 32, "%s %d", notename[mn%12], (mn/12)-2); - } else { - snprintf (buf, 32, "%.0f", v); - } + float const v = cui->control->interface_to_internal(adj.get_value ()); + const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v)); + const size_t len = str.copy(buf, 31); + buf[len] = '\0'; return true; } @@ -521,32 +648,67 @@ GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param) plugin->print_parameter (param, buf, len); } +/** Build a ControlUI for a parameter/property. + * Note that mcontrol may be NULL for outputs. + */ GenericPluginUI::ControlUI* -GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptr mcontrol) +GenericPluginUI::build_control_ui (const Evoral::Parameter& param, + const ParameterDescriptor& desc, + boost::shared_ptr mcontrol, + float value, + bool is_input, + bool use_knob) { ControlUI* control_ui = 0; - Plugin::ParameterDescriptor desc; - - plugin->get_parameter_descriptor (port_index, desc); - - control_ui = manage (new ControlUI ()); + control_ui = manage (new ControlUI (param)); control_ui->combo = 0; control_ui->control = mcontrol; - control_ui->update_pending = false; control_ui->label.set_text (desc.label); control_ui->label.set_alignment (0.0, 0.5); control_ui->label.set_name ("PluginParameterLabel"); - control_ui->port_index = port_index; - control_ui->set_spacing (5); - Gtk::Requisition req (control_ui->automate_button.size_request()); + if (is_input) { + + if (desc.datatype == Variant::PATH) { + + /* We shouldn't get that type for input ports */ + assert(param.type() == PluginPropertyAutomation); + + /* Build a file selector button */ + + // Create/add controller + control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN)); + control_ui->file_button->set_title(desc.label); + + if (use_knob) { + control_ui->knobtable = manage (new Table()); + control_ui->pack_start(*control_ui->knobtable, true, false); + control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1); + control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2); + } else { + control_ui->pack_start (control_ui->label, false, true); + control_ui->pack_start (*control_ui->file_button, true, true); + } + + // Monitor changes from the user. + control_ui->file_button->signal_file_set().connect( + sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property), + desc, control_ui->file_button)); + + /* Add the filebutton control to a map so that we can update it when + * the corresponding property changes. This doesn't go through the usual + * AutomationControls, because they don't support non-numeric values. */ + _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button)); + + return control_ui; + } - if (plugin->parameter_is_input(port_index)) { + assert(mcontrol); /* See if there any named values for our input value */ - control_ui->scale_points = plugin->get_scale_points (port_index); + control_ui->scale_points = desc.scale_points; /* If this parameter is an integer, work out the number of distinct values it can take on (assuming that lower and upper values are allowed). @@ -554,132 +716,158 @@ GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptrscale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) { - + /* Either: * a) There is a label for each possible value of this input, or * b) This port is marked as being an enumeration. */ - std::vector labels; - for ( - ARDOUR::Plugin::ScalePoints::const_iterator i = control_ui->scale_points->begin(); - i != control_ui->scale_points->end(); - ++i) { - - labels.push_back(i->first); + control_ui->combo = new ArdourDropdown(); + for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin(); + i != control_ui->scale_points->end(); + ++i) { + control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem( + i->first, + sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed), + control_ui, + i->second))); } - control_ui->combo = new Gtk::ComboBoxText(); - set_popdown_strings(*control_ui->combo, labels); - control_ui->combo->signal_changed().connect( - sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed), - control_ui)); - mcontrol->Changed.connect(control_connections, invalidator(*this), - boost::bind(&GenericPluginUI::ui_parameter_changed, - this, control_ui), - gui_context()); - control_ui->pack_start(control_ui->label, true, true); - control_ui->pack_start(*control_ui->combo, false, true); + control_ui->combo->set_controllable (mcontrol); update_control_display(control_ui); - return control_ui; - } + } else { - if (desc.toggled) { + /* create the controller */ - /* Build a button */ + /* XXX memory leak: SliderController not destroyed by ControlUI + * destructor, and manage() reports object hierarchy + * ambiguity. + */ + control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob); - control_ui->button = manage (new ToggleButton ()); - control_ui->button->set_name ("PluginEditorButton"); - control_ui->button->set_size_request (20, 20); + /* Control UI's don't need the rapid timer workaround */ + control_ui->controller->stop_updating (); - control_ui->pack_start (control_ui->label, true, true); - control_ui->pack_start (*control_ui->button, false, true); - control_ui->pack_start (control_ui->automate_button, false, false); + /* XXX this code is not right yet, because it doesn't handle + the absence of bounds in any sensible fashion. + */ - control_ui->button->signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui)); - control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index)); + Adjustment* adj = control_ui->controller->adjustment(); - mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::toggle_parameter_changed, this, control_ui), gui_context()); - mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context()); - - if (plugin->get_parameter (port_index) > 0.5){ - control_ui->button->set_active(true); + if (desc.integer_step && !desc.toggled) { + control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true); + Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2); + if (desc.unit == ParameterDescriptor::MIDI_NOTE) { + control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui)); + } else { + control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui)); + } + control_ui->clickbox->set_controllable (mcontrol); + } else if (desc.toggled) { + ArdourButton* but = dynamic_cast (control_ui->controller->widget()); + assert(but); + but->set_tweaks(ArdourButton::Square); + } else if (use_knob) { + /* Delay size request so that styles are gotten right */ + control_ui->controller->widget()->signal_size_request().connect( + sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui)); + } else { + control_ui->controller->set_size_request (200, -1); + control_ui->controller->set_name (X_("ProcessorControlSlider")); } - automation_state_changed (control_ui); - - return control_ui; - } + if (!desc.integer_step && !desc.toggled && use_knob) { + control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj)); + } - /* create the controller */ + adj->set_value (mcontrol->internal_to_interface(value)); - if (mcontrol) { - control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), mcontrol); } - /* XXX this code is not right yet, because it doesn't handle - the absence of bounds in any sensible fashion. - */ - - Adjustment* adj = control_ui->controller->adjustment(); - boost::shared_ptr pc = boost::dynamic_pointer_cast (control_ui->control); - - adj->set_lower (pc->internal_to_interface (desc.lower)); - adj->set_upper (pc->internal_to_interface (desc.upper)); - - adj->set_step_increment (desc.step); - adj->set_page_increment (desc.largestep); - - if (desc.integer_step) { - control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox"); - Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2); - if (desc.midinote) { - printf("MIDI NOTE\n"); - control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui)); + if (use_knob) { + control_ui->automate_button.set_sizing_text("M"); + + control_ui->label.set_alignment (0.5, 0.5); + control_ui->knobtable = manage (new Table()); + control_ui->pack_start(*control_ui->knobtable, true, true); + + if (control_ui->combo) { + control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1); + control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2); + } else if (control_ui->clickbox) { + control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1); + control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK); + control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0); + } else if (control_ui->spin_box) { + ArdourKnob* knob = dynamic_cast(control_ui->controller->widget ()); + knob->set_tooltip_prefix (desc.label + ": "); + Alignment *align = manage (new Alignment (.5, .5, 0, 0)); + align->add (*control_ui->controller); + control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2); + control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2); + control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0); + } else if (desc.toggled) { + Alignment *align = manage (new Alignment (.5, .5, 0, 0)); + align->add (*control_ui->controller); + control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2); + control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK); + control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0); } else { - control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui)); + control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1); + control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK); + control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0); } - } else { - //sigc::slot pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index); - - control_ui->controller->set_size_request (200, req.height); - control_ui->controller->set_name (X_("PluginSlider")); - control_ui->controller->set_style (BarController::LeftToRight); - control_ui->controller->set_use_parent (true); - control_ui->controller->set_logarithmic (desc.logarithmic); - control_ui->controller->StartGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::start_touch), control_ui)); - control_ui->controller->StopGesture.connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::stop_touch), control_ui)); + } else { + control_ui->pack_start (control_ui->label, true, true); + if (control_ui->combo) { + control_ui->pack_start(*control_ui->combo, false, true); + } else if (control_ui->clickbox) { + control_ui->pack_start (*control_ui->clickbox, false, false); + } else if (control_ui->spin_box) { + control_ui->pack_start (*control_ui->spin_box, false, false); + control_ui->pack_start (*control_ui->controller, false, false); + } else { + control_ui->pack_start (*control_ui->controller, false, false); + } + control_ui->pack_start (control_ui->automate_button, false, false); } - adj->set_value (pc->internal_to_interface (plugin->get_parameter (port_index))); - - /* XXX memory leak: SliderController not destroyed by ControlUI - destructor, and manage() reports object hierarchy - ambiguity. - */ - control_ui->pack_start (control_ui->label, true, true); - if (desc.integer_step) { - control_ui->pack_start (*control_ui->clickbox, false, false); + if (mcontrol->flags () & Controllable::NotAutomatable) { + control_ui->automate_button.set_sensitive (false); + set_tooltip(control_ui->automate_button, _("This control cannot be automated")); } else { - control_ui->pack_start (*control_ui->controller, false, false); + control_ui->automate_button.signal_button_press_event().connect ( + sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event), + control_ui), + false); + mcontrol->alist()->automation_state_changed.connect ( + control_connections, + invalidator (*this), + boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), + gui_context()); + input_controls_with_automation.push_back (control_ui); } - control_ui->pack_start (control_ui->automate_button, false, false); - control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui, (uint32_t) port_index)); + if (desc.toggled && !control_ui->combo) { + control_ui->button = true; + ArdourButton* but = dynamic_cast(control_ui->controller->widget ()); + assert (but); + but->set_name ("pluginui toggle"); + update_control_display(control_ui); + } automation_state_changed (control_ui); - mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context()); - mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context()); - + /* Add to the list of CUIs that need manual update to workaround + * AutomationControl not knowing about preset loads */ input_controls.push_back (control_ui); - } else if (plugin->parameter_is_output (port_index)) { + } else { control_ui->display = manage (new EventBox); control_ui->display->set_name ("ParameterValueDisplay"); @@ -693,79 +881,88 @@ GenericPluginUI::build_control_ui (guint32 port_index, boost::shared_ptrdisplay->show_all (); - /* set up a meter */ - /* TODO: only make a meter if the port is Hinted for it */ - - MeterInfo * info = new MeterInfo(port_index); - control_ui->meterinfo = info; - - info->meter = new FastMeter ( - 5, 5, FastMeter::Vertical, 0, - 0x0000aaff, - 0x008800ff, 0x008800ff, - 0x00ff00ff, 0x00ff00ff, - 0xcccc00ff, 0xcccc00ff, - 0xffaa00ff, 0xffaa00ff, - 0xff0000ff, - ARDOUR_UI::config()->get_canvasvar_MeterBackgroundBot(), - ARDOUR_UI::config()->get_canvasvar_MeterBackgroundTop() - ); - - info->min_unbound = desc.min_unbound; - info->max_unbound = desc.max_unbound; - - info->min = desc.lower; - info->max = desc.upper; - control_ui->vbox = manage (new VBox); - control_ui->hbox = manage (new HBox); - - control_ui->hbox->set_spacing(1); control_ui->vbox->set_spacing(3); - control_ui->label.set_angle(90); - control_ui->hbox->pack_start (control_ui->label, false, false); - control_ui->hbox->pack_start (*info->meter, false, false); - - control_ui->vbox->pack_start (*control_ui->hbox, false, false); - - control_ui->vbox->pack_start (*control_ui->display, false, false); + if (desc.unit == ParameterDescriptor::MIDI_NOTE) { + control_ui->vbox->pack_end (*control_ui->display, false, false); + control_ui->vbox->pack_end (control_ui->label, false, false); + } else if (desc.integer_step || desc.enumeration) { + control_ui->vbox->pack_end (*control_ui->display, false, false); + control_ui->vbox->pack_end (control_ui->label, false, false); + } else { + /* set up a meter for float ports */ + + MeterInfo * info = new MeterInfo(); + control_ui->meterinfo = info; + + info->meter = new FastMeter ( + 5, 5, FastMeter::Vertical, 0, + 0x0000aaff, + 0x008800ff, 0x008800ff, + 0x00ff00ff, 0x00ff00ff, + 0xcccc00ff, 0xcccc00ff, + 0xffaa00ff, 0xffaa00ff, + 0xff0000ff, + UIConfiguration::instance().color ("meter background bottom"), + UIConfiguration::instance().color ("meter background top") + ); + + control_ui->label.set_angle(90); + + HBox* center = manage (new HBox); + center->set_spacing(1); + center->pack_start (control_ui->label, false, false); + center->pack_start (*info->meter, false, false); + + control_ui->hbox = manage (new HBox); + control_ui->hbox->pack_start (*center, true, false); + + // horizontally center this hbox in the vbox + control_ui->vbox->pack_start (*control_ui->hbox, false, false); + + control_ui->meterinfo->meter->show_all(); + control_ui->meterinfo->packed = true; + control_ui->vbox->pack_start (*control_ui->display, false, false); + } control_ui->pack_start (*control_ui->vbox); - control_ui->meterinfo->meter->show_all(); - control_ui->meterinfo->packed = true; - output_controls.push_back (control_ui); } if (mcontrol) { - mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context()); + mcontrol->Changed.connect(control_connections, invalidator(*this), + boost::bind(&GenericPluginUI::ui_parameter_changed, + this, control_ui), + gui_context()); } return control_ui; } void -GenericPluginUI::start_touch (GenericPluginUI::ControlUI* cui) -{ - cui->control->start_touch (cui->control->session().transport_frame()); +GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) { + Gtk::Requisition astate_req (cui->automate_button.size_request()); + const int size = (int) (astate_req.height * 1.5); + req->width = max(req->width, size); + req->height = max(req->height, size); } -void -GenericPluginUI::stop_touch (GenericPluginUI::ControlUI* cui) -{ - cui->control->stop_touch (false, cui->control->session().transport_frame()); -} -void -GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t /*port*/) +bool +GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui) { + if (ev->button != 1) { + return true; + } + using namespace Menu_Helpers; if (automation_menu == 0) { automation_menu = manage (new Menu); automation_menu->set_name ("ArdourContextMenu"); + automation_menu->set_reserve_toggle_size(false); } MenuList& items (automation_menu->items()); @@ -780,27 +977,24 @@ GenericPluginUI::astate_clicked (ControlUI* cui, uint32_t /*port*/) items.push_back (MenuElem (_("Touch"), sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui))); - automation_menu->popup (1, gtk_get_current_event_time()); + anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(), + 1, ev->time); + + return true; } void -GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui) +GenericPluginUI::set_all_automation (AutoState as) { - insert->set_parameter_automation_state (cui->parameter(), state); + for (vector::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) { + set_automation_state (as, (*i)); + } } void -GenericPluginUI::toggle_parameter_changed (ControlUI* cui) +GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui) { - float val = cui->control->get_value(); - - if (!cui->ignore_change) { - if (val > 0.5) { - cui->button->set_active (true); - } else { - cui->button->set_active (false); - } - } + insert->set_parameter_automation_state (cui->parameter(), state); } void @@ -821,22 +1015,17 @@ GenericPluginUI::update_control_display (ControlUI* cui) float val = cui->control->get_value(); - cui->ignore_change++; + PBD::Unwinder (cui->ignore_change, true); if (cui->combo && cui->scale_points) { - for (ARDOUR::Plugin::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) { + for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) { if (it->second == val) { - cui->combo->set_active_text(it->first); + cui->combo->set_text(it->first); break; } } } else if (cui->button) { - - if (val > 0.5) { - cui->button->set_active (true); - } else { - cui->button->set_active (false); - } + // AutomationController handles this } if( cui->controller ) { @@ -852,23 +1041,25 @@ GenericPluginUI::update_control_display (ControlUI* cui) cui->adjustment->set_value (val); } }*/ - cui->ignore_change--; } void -GenericPluginUI::control_port_toggled (ControlUI* cui) +GenericPluginUI::update_input_displays () { - cui->ignore_change++; - insert->automation_control (cui->parameter())->set_value (cui->button->get_active()); - cui->ignore_change--; + /* XXX This is a workaround for AutomationControl not knowing about preset loads */ + for (vector::iterator i = input_controls.begin(); + i != input_controls.end(); + ++i) { + update_control_display(*i); + } + return; } void -GenericPluginUI::control_combo_changed (ControlUI* cui) +GenericPluginUI::control_combo_changed (ControlUI* cui, float value) { - if (!cui->ignore_change && cui->scale_points) { - string value = cui->combo->get_active_text(); - insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value]); + if (!cui->ignore_change) { + insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup); } } @@ -877,8 +1068,7 @@ GenericPluginUI::start_updating (GdkEventAny*) { if (output_controls.size() > 0 ) { screen_update_connection.disconnect(); - screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect - (sigc::mem_fun(*this, &GenericPluginUI::output_update)); + screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update)); } return false; } @@ -886,14 +1076,9 @@ GenericPluginUI::start_updating (GdkEventAny*) bool GenericPluginUI::stop_updating (GdkEventAny*) { - for (vector::iterator i = input_controls.begin(); i != input_controls.end(); ++i) { - (*i)->controller->stop_updating (); - } - if (output_controls.size() > 0 ) { screen_update_connection.disconnect(); } - return false; } @@ -901,34 +1086,34 @@ void GenericPluginUI::output_update () { for (vector::iterator i = output_controls.begin(); i != output_controls.end(); ++i) { - float val = plugin->get_parameter ((*i)->port_index); + float val = plugin->get_parameter ((*i)->parameter().id()); char buf[32]; - snprintf (buf, sizeof(buf), "%.2f", val); + boost::shared_ptr c = insert->control_output ((*i)->parameter().id()); + const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val)); + size_t len = str.copy(buf, 31); + buf[len] = '\0'; (*i)->display_label->set_text (buf); - /* autoscaling for the meter */ if ((*i)->meterinfo && (*i)->meterinfo->packed) { - - if (val < (*i)->meterinfo->min) { - if ((*i)->meterinfo->min_unbound) - (*i)->meterinfo->min = val; - else - val = (*i)->meterinfo->min; - } - - if (val > (*i)->meterinfo->max) { - if ((*i)->meterinfo->max_unbound) - (*i)->meterinfo->max = val; - else - val = (*i)->meterinfo->max; - } - - if ((*i)->meterinfo->max > (*i)->meterinfo->min ) { - float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ; - (*i)->meterinfo->meter->set (lval ); - } + (*i)->meterinfo->meter->set (c->desc().to_interface (val)); } } } +void +GenericPluginUI::set_path_property (const ParameterDescriptor& desc, + Gtk::FileChooserButton* widget) +{ + plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename())); +} +void +GenericPluginUI::path_property_changed (uint32_t key, const Variant& value) +{ + FilePathControls::iterator c = _filepath_controls.find(key); + if (c != _filepath_controls.end()) { + c->second->set_filename(value.get_path()); + } else { + std::cerr << "warning: property change for property with no control" << std::endl; + } +}