set_latency_label ();
smaller_hbox->pack_start (latency_button, false, false, 10);
- smaller_hbox->pack_start (_preset_box, false, false);
+ 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);
VBox* v1_box = manage (new VBox);
VBox* v2_box = manage (new VBox);
pack_end (plugin_analysis_expander, false, false);
+ if (!plugin->get_docs().empty()) {
+ pack_end (description_expander, false, false);
+ }
v1_box->pack_start (*smaller_hbox, false, true);
v2_box->pack_start (focus_button, false, true);
main_contents.pack_start (*constraint_hbox, false, false);
if (is_scrollable ) {
- scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
+ scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
scroller.set_name ("PluginEditor");
scroller_view.set_name("PluginEditor");
scroller_view.add (hpacker);
bypass_button.set_active (!pi->active());
+ prefheight = 0;
build ();
}
}
}
+// Some functions for calculating the 'similarity' of two plugin
+// control labels.
+
+static int get_number(string label) {
+static const char *digits = "0123456789";
+int value = -1;
+
+ std::size_t first_digit_pos = label.find_first_of(digits);
+ if (first_digit_pos != string::npos) {
+ // found some digits: there's a number in there somewhere
+ stringstream s;
+ s << label.substr(first_digit_pos);
+ s >> value;
+ }
+ return value;
+}
+
+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;
+
+ length = min(s1.length(), s2.length());
+ while (n < length) {
+ if (!match_or_digit(s1[n], s2[n]))
+ break;
+ n++;
+ }
+ return n;
+}
+
+static std::size_t matching_chars_at_tail(const string s1, const string s2) {
+std::size_t s1pos, s2pos, n = 0;
+
+ s1pos = s1.length();
+ s2pos = s2.length();
+ while (s1pos-- > 0 && s2pos-- > 0) {
+ if (!match_or_digit(s1[s1pos], s2[s2pos]) )
+ break;
+ n++;
+ }
+ return n;
+}
+
+static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
+static const float default_similarity_threshold = 0.3;
+
void
GenericPluginUI::build ()
{
int output_rows, output_cols;
int button_rows, button_cols;
- prefheight = 30;
hpacker.set_spacing (10);
output_rows = initial_output_rows;
bt_frame = manage (new Frame);
bt_frame->set_name ("BaseFrame");
+ bt_frame->set_label (_("Switches"));
bt_frame->add (button_table);
hpacker.pack_start(*bt_frame, true, true);
hpacker.pack_start(*frame, true, true);
/* find all ports. build control elements for all appropriate control ports */
+ std::vector<ControlUI *> cui_controls_list;
for (i = 0; i < plugin->parameter_count(); ++i) {
ControlUI* cui;
- /* if we are scrollable, just use one long column */
-
- if (!is_scrollable) {
- if (x++ > 20){
- frame = manage (new Frame);
- frame->set_name ("BaseFrame");
- box = manage (new VBox);
-
- box->set_border_width (5);
- box->set_spacing (1);
-
- frame->add (*box);
- hpacker.pack_start(*frame, true, true);
-
- x = 1;
- }
- }
-
boost::shared_ptr<ARDOUR::AutomationControl> c
= boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
insert->control(Evoral::Parameter(PluginAutomation, 0, i)));
continue;
}
- if (cui->controller || cui->clickbox || cui->combo) {
-
- box->pack_start (*cui, false, false);
+ 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 (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 (button_row == button_rows) {
+ if (!is_scrollable && button_row == button_rows) {
button_row = 0;
if (++button_col == button_cols) {
button_cols += 2;
output_cols ++;
output_table.resize (output_rows, output_cols);
}
+ }
+ }
+ }
- /* old code, which divides meters into
- * columns first, rows later. New code divides into one row
-
- if (output_row == output_rows) {
- output_row = 0;
- if (++output_col == output_cols) {
- output_cols += 2;
- output_table.resize (output_rows, output_cols);
- }
- }
-
- output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
- FILL|EXPAND, FILL);
-
- output_row++;
- */
+ // Iterate over the list of controls to find which adjacent controls
+ // are similar enough to be grouped together.
+
+ string label, previous_label = "";
+ int numbers_in_labels[cui_controls_list.size()];
+
+ float similarity_scores[cui_controls_list.size()];
+ float most_similar = 0.0, least_similar = 1.0;
+
+ i = 0;
+ for (vector<ControlUI*>::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);
+
+ 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) +
+ matching_chars_at_tail(label, previous_label) +
+ 1
+ )
+ ) / (label.length() + previous_label.length());
+ if (numbers_in_labels[i] >= 0) {
+ similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
}
+ least_similar = min(least_similar, similarity_scores[i]);
+ most_similar = max(most_similar, similarity_scores[i]);
+ } else {
+ similarity_scores[0] = 1.0;
+ }
- /* HACK: ideally the preferred height would be queried from
- the complete hpacker, but I can't seem to get that
- information in time, so this is an estimation
- */
+ // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
+ previous_label = label;
+ }
- prefheight += 30;
+
+ // 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
+ // starting a new column when necessary.
+
+ i = 0;
+ for (vector<ControlUI*>::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);
+ frame->set_name ("BaseFrame");
+ frame->set_label (_("Controls"));
+ box = manage (new VBox);
+ box->set_border_width (5);
+ box->set_spacing (1);
+ frame->add (*box);
+ hpacker.pack_start(*frame, true, true);
+ x = 0;
+ } else {
+ HSeparator *split = new HSeparator();
+ split->set_size_request(-1, 5);
+ box->pack_start(*split, false, false, 0);
+ }
}
+ box->pack_start (*cui, false, false);
+ }
+
+ if (is_scrollable) {
+ prefheight = 30 * i;
}
if (box->children().empty()) {
if (!output_table.children().empty()) {
frame = manage (new Frame);
frame->set_name ("BaseFrame");
+ frame->set_label(_("Meters"));
frame->add (output_table);
hpacker.pack_end (*frame, true, true);
}
// 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())
- & (Off|Play|Touch|Write)) {
- case Off:
- cui->automate_button.set_label (_("Manual"));
+ switch (insert->get_parameter_automation_state (cui->parameter()) & (ARDOUR::Off|Play|Touch|Write)) {
+ case ARDOUR::Off:
+ cui->automate_button.set_label (S_("Automation|Manual"));
break;
case Play:
cui->automate_button.set_label (_("Play"));
}
-static void integer_printer (char buf[32], Adjustment &adj, void */*arg*/)
+bool
+GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
{
- snprintf (buf, 32, "%.0f", adj.get_value());
+ 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);
+ return true;
}
void
control_ui = manage (new ControlUI ());
control_ui->combo = 0;
- control_ui->combo_map = 0;
control_ui->control = mcontrol;
control_ui->update_pending = false;
control_ui->label.set_text (desc.label);
if (plugin->parameter_is_input(port_index)) {
- /* Build a combo box */
+ /* See if there any named values for our input value */
+ control_ui->scale_points = plugin->get_scale_points (port_index);
+
+ /* 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).
+ */
+ int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
- boost::shared_ptr<ARDOUR::Plugin::ScalePoints> points
- = plugin->get_scale_points(port_index);
+ if (control_ui->scale_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.
+ */
- if (points) {
std::vector<std::string> labels;
- for (ARDOUR::Plugin::ScalePoints::const_iterator i = points->begin();
- i != points->end(); ++i) {
+ for (
+ ARDOUR::Plugin::ScalePoints::const_iterator i = control_ui->scale_points->begin();
+ i != control_ui->scale_points->end();
+ ++i) {
+
labels.push_back(i->first);
}
Adjustment* adj = control_ui->controller->adjustment();
boost::shared_ptr<PluginInsert::PluginControl> pc = boost::dynamic_pointer_cast<PluginInsert::PluginControl> (control_ui->control);
- adj->set_lower (pc->user_to_ui (desc.lower));
- adj->set_upper (pc->user_to_ui (desc.upper));
+ 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);
- control_ui->clickbox->set_print_func (integer_printer, 0);
+ control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
} else {
//sigc::slot<void,char*,uint32_t> pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
}
- adj->set_value (pc->plugin_to_ui (plugin->get_parameter (port_index)));
+ 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
MenuList& items (automation_menu->items());
items.clear ();
- items.push_back (MenuElem (_("Manual"),
- sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Off, cui)));
+ items.push_back (MenuElem (S_("Automation|Manual"),
+ sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
items.push_back (MenuElem (_("Play"),
sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
items.push_back (MenuElem (_("Write"),
cui->ignore_change++;
- if (cui->combo && cui->combo_map) {
- std::map<string,float>::iterator it;
- for (it = cui->combo_map->begin(); it != cui->combo_map->end(); ++it) {
+ if (cui->combo && cui->scale_points) {
+ for (ARDOUR::Plugin::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
if (it->second == val) {
cui->combo->set_active_text(it->first);
break;
void
GenericPluginUI::control_combo_changed (ControlUI* cui)
{
- if (!cui->ignore_change && cui->combo_map) {
+ if (!cui->ignore_change && cui->scale_points) {
string value = cui->combo->get_active_text();
- std::map<string,float> mapping = *cui->combo_map;
- insert->automation_control(cui->parameter())->set_value(mapping[value]);
+ insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value]);
}
}
-void
-GenericPluginUI::processor_active_changed (boost::weak_ptr<Processor> weak_processor)
-{
- ENSURE_GUI_THREAD (*this, &GenericPluginUI::processor_active_changed, weak_processor)
-
- boost::shared_ptr<Processor> processor = weak_processor.lock();
-
- bypass_button.set_active (!processor || !processor->active());
-}
-
bool
GenericPluginUI::start_updating (GdkEventAny*)
{
projects / ardour.git / blobdiff