gtk2_ardour/generic_pluginui.cc

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifdef WAF_BUILD
  21 #include "gtk2ardour-config.h"
  22 #endif
  23
  24 #include <climits>
  25 #include <cerrno>
  26 #include <cmath>
  27 #include <string>
  28 #include <vector>
  29
  30 #include "pbd/stl_delete.h"
  31 #include "pbd/unwind.h"
  32 #include "pbd/xml++.h"
  33 #include "pbd/failed_constructor.h"
  34
  35 #include <gtkmm2ext/click_box.h>
  36 #include <gtkmm2ext/fastmeter.h>
  37 #include <gtkmm2ext/barcontroller.h>
  38 #include <gtkmm2ext/utils.h>
  39 #include <gtkmm2ext/doi.h>
  40 #include <gtkmm2ext/slider_controller.h>
  41
  42 #include "ardour/plugin.h"
  43 #include "ardour/plugin_insert.h"
  44 #include "ardour/session.h"
  45 #include "ardour/value_as_string.h"
  46
  47 #include "prompter.h"
  48 #include "plugin_ui.h"
  49 #include "gui_thread.h"
  50 #include "automation_controller.h"
  51 #include "ardour_knob.h"
  52 #include "gain_meter.h"
  53 #include "timers.h"
  54 #include "tooltips.h"
  55 #include "ui_config.h"
  56
  57 #include "pbd/i18n.h"
  58
  59 using namespace std;
  60 using namespace ARDOUR;
  61 using namespace PBD;
  62 using namespace Gtkmm2ext;
  63 using namespace Gtk;
  64 using namespace ARDOUR_UI_UTILS;
  65
  66 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
  67         : PlugUIBase (pi)
  68         , automation_menu (0)
  69         , is_scrollable(scrollable)
  70 {
  71         set_name ("PluginEditor");
  72         set_border_width (10);
  73         //set_homogeneous (false);
  74
  75         pack_start (main_contents, true, true);
  76         settings_box.set_homogeneous (false);
  77
  78         HBox* constraint_hbox = manage (new HBox);
  79         HBox* smaller_hbox = manage (new HBox);
  80         HBox* automation_hbox = manage (new HBox);
  81         smaller_hbox->set_spacing (4);
  82         automation_hbox->set_spacing (6);
  83         Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
  84         combo_label->set_use_markup (true);
  85
  86         latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
  87         set_latency_label ();
  88
  89         smaller_hbox->pack_start (latency_button, false, false, 4);
  90         smaller_hbox->pack_start (_preset_combo, false, false);
  91         smaller_hbox->pack_start (_preset_modified, false, false);
  92         smaller_hbox->pack_start (add_button, false, false);
  93         smaller_hbox->pack_start (save_button, false, false);
  94         smaller_hbox->pack_start (delete_button, false, false);
  95         smaller_hbox->pack_start (reset_button, false, false, 4);
  96         smaller_hbox->pack_start (bypass_button, false, true, 4);
  97
  98         automation_manual_all_button.set_text(_("Manual"));
  99         automation_manual_all_button.set_name (X_("generic button"));
 100         automation_play_all_button.set_text(_("Play"));
 101         automation_play_all_button.set_name (X_("generic button"));
 102         automation_write_all_button.set_text(_("Write"));
 103         automation_write_all_button.set_name (X_("generic button"));
 104         automation_touch_all_button.set_text(_("Touch"));
 105         automation_touch_all_button.set_name (X_("generic button"));
 106
 107         Label* l = manage (new Label (_("All Automation")));
 108         l->set_alignment (1.0, 0.5);
 109         automation_hbox->pack_start (*l, true, true);
 110         automation_hbox->pack_start (automation_manual_all_button, false, false);
 111         automation_hbox->pack_start (automation_play_all_button, false, false);
 112         automation_hbox->pack_start (automation_write_all_button, false, false);
 113         automation_hbox->pack_start (automation_touch_all_button, false, false);
 114
 115         constraint_hbox->set_spacing (5);
 116         constraint_hbox->set_homogeneous (false);
 117
 118         VBox* v1_box = manage (new VBox);
 119         VBox* v2_box = manage (new VBox);
 120         pack_end (plugin_analysis_expander, false, false);
 121         if (!plugin->get_docs().empty()) {
 122                 pack_end (description_expander, false, false);
 123         }
 124
 125         v1_box->set_spacing (6);
 126         v1_box->pack_start (*smaller_hbox, false, true);
 127         v1_box->pack_start (*automation_hbox, false, true);
 128         v2_box->pack_start (focus_button, false, true);
 129
 130         main_contents.pack_start (settings_box, false, false);
 131
 132         constraint_hbox->pack_end (*v2_box, false, false);
 133         constraint_hbox->pack_end (*v1_box, false, false);
 134
 135         main_contents.pack_start (*constraint_hbox, false, false);
 136
 137         if (is_scrollable) {
 138                 Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow());
 139                 scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 140                 scroller->set_name ("PluginEditor");
 141                 scroller->add (hpacker);
 142                 main_contents.pack_start (*scroller, true, true);
 143         } else {
 144                 main_contents.pack_start (hpacker, false, false);
 145         }
 146
 147         pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
 148
 149         bypass_button.set_active (!pi->enabled());
 150
 151         prefheight = 0;
 152         build ();
 153
 154         /* Listen for property changes that are not notified normally because
 155          * AutomationControl has only support for numeric values currently.
 156          * The only case is Variant::PATH for now */
 157         plugin->PropertyChanged.connect(*this, invalidator(*this),
 158                                         boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
 159                                         gui_context());
 160
 161         main_contents.show ();
 162 }
 163
 164 GenericPluginUI::~GenericPluginUI ()
 165 {
 166         if (output_controls.size() > 0) {
 167                 screen_update_connection.disconnect();
 168         }
 169 }
 170
 171 // Some functions for calculating the 'similarity' of two plugin
 172 // control labels.
 173
 174 static int get_number(string label) {
 175 static const char *digits = "0123456789";
 176 int value = -1;
 177
 178         std::size_t first_digit_pos = label.find_first_of(digits);
 179         if (first_digit_pos != string::npos) {
 180                 // found some digits: there's a number in there somewhere
 181                 stringstream s;
 182                 s << label.substr(first_digit_pos);
 183                 s >> value;
 184         }
 185         return value;
 186 }
 187
 188 static int match_or_digit(char c1, char c2) {
 189         return c1 == c2 || (isdigit(c1) && isdigit(c2));
 190 }
 191
 192 static std::size_t matching_chars_at_head(const string s1, const string s2) {
 193 std::size_t length, n = 0;
 194
 195         length = min(s1.length(), s2.length());
 196         while (n < length) {
 197                 if (!match_or_digit(s1[n], s2[n]))
 198                         break;
 199                 n++;
 200         }
 201         return n;
 202 }
 203
 204 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
 205 std::size_t s1pos, s2pos, n = 0;
 206
 207         s1pos = s1.length();
 208         s2pos = s2.length();
 209         while (s1pos-- > 0 && s2pos-- > 0) {
 210                 if (!match_or_digit(s1[s1pos], s2[s2pos])       )
 211                         break;
 212                 n++;
 213         }
 214         return n;
 215 }
 216
 217 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
 218 static const float default_similarity_threshold = 0.3;
 219
 220 void
 221 GenericPluginUI::build ()
 222 {
 223         std::vector<ControlUI *> control_uis;
 224         bool grid = true;
 225
 226         // Build a ControlUI for each control port
 227         for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 228
 229                 if (plugin->parameter_is_control (i)) {
 230
 231                         /* Don't show latency control ports */
 232
 233                         const Evoral::Parameter param(PluginAutomation, 0, i);
 234                         if (plugin->describe_parameter (param) == X_("latency")) {
 235                                 continue;
 236                         }
 237
 238                         if (plugin->describe_parameter (param) == X_("hidden")) {
 239                                 continue;
 240                         }
 241
 242                         const float value = plugin->get_parameter(i);
 243
 244                         ControlUI* cui;
 245                         Plugin::UILayoutHint hint;
 246
 247                         if (!plugin->get_layout(i, hint)) {
 248                                 grid = false;
 249                         }
 250
 251                         boost::shared_ptr<ARDOUR::AutomationControl> c
 252                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 253                                         insert->control(param));
 254
 255                         ParameterDescriptor desc;
 256                         plugin->get_parameter_descriptor(i, desc);
 257                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
 258                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
 259                                 continue;
 260                         }
 261
 262                         if (grid) {
 263                                 cui->x0 = hint.x0;
 264                                 cui->x1 = hint.x1;
 265                                 cui->y0 = hint.y0;
 266                                 cui->y1 = hint.y1;
 267                         }
 268
 269                         const std::string param_docs = plugin->get_parameter_docs(i);
 270                         if (!param_docs.empty()) {
 271                                 set_tooltip(cui, param_docs.c_str());
 272                         }
 273
 274                         control_uis.push_back(cui);
 275                 }
 276         }
 277
 278         // Build a ControlUI for each property
 279         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
 280         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
 281                 const ParameterDescriptor& desc = d->second;
 282                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 283
 284                 boost::shared_ptr<ARDOUR::AutomationControl> c
 285                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 286                                 insert->control(param));
 287
 288                 if (!c) {
 289                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
 290                         continue;
 291                 }
 292
 293                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
 294                 if (!cui) {
 295                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
 296                                                 desc.key) << endmsg;
 297                         continue;
 298                 }
 299
 300                 control_uis.push_back(cui);
 301         }
 302         if (!descs.empty()) {
 303                 plugin->announce_property_values();
 304         }
 305
 306         if (grid) {
 307                 custom_layout (control_uis);
 308         } else {
 309                 automatic_layout (control_uis);
 310         }
 311
 312         output_update ();
 313
 314         automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
 315         automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
 316         automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
 317         automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 318
 319         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
 320         plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
 321 }
 322
 323
 324 void
 325 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
 326 {
 327         guint32 x = 0;
 328
 329         static const int32_t initial_button_rows = 12;
 330         static const int32_t initial_button_cols = 1;
 331         static const int32_t initial_output_rows = 1;
 332         static const int32_t initial_output_cols = 4;
 333
 334         Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
 335         Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
 336
 337         Frame* frame;
 338         Frame* bt_frame;
 339         VBox* box;
 340         int output_row, output_col;
 341         int button_row, button_col;
 342         int output_rows, output_cols;
 343         int button_rows, button_cols;
 344
 345         hpacker.set_spacing (10);
 346         hpacker.set_border_width (10);
 347
 348         output_rows = initial_output_rows;
 349         output_cols = initial_output_cols;
 350         button_rows = initial_button_rows;
 351         button_cols = initial_button_cols;
 352         output_row = 0;
 353         button_row = 0;
 354         output_col = 0;
 355         button_col = 0;
 356
 357         button_table->set_homogeneous (false);
 358         button_table->set_row_spacings (2);
 359         button_table->set_col_spacings (2);
 360         output_table->set_homogeneous (true);
 361         output_table->set_row_spacings (2);
 362         output_table->set_col_spacings (2);
 363         button_table->set_border_width (5);
 364         output_table->set_border_width (5);
 365
 366
 367         bt_frame = manage (new Frame);
 368         bt_frame->set_name ("BaseFrame");
 369         bt_frame->set_label (_("Switches"));
 370         bt_frame->add (*button_table);
 371         hpacker.pack_start(*bt_frame, true, true);
 372
 373         box = manage (new VBox);
 374         box->set_border_width (5);
 375         box->set_spacing (1);
 376
 377         frame = manage (new Frame);
 378         frame->set_name ("BaseFrame");
 379         frame->set_label (_("Controls"));
 380         frame->add (*box);
 381         hpacker.pack_start(*frame, true, true);
 382
 383         // Add special controls to UI, and build list of normal controls to be layed out later
 384         std::vector<ControlUI *> cui_controls_list;
 385         for (size_t i = 0; i < control_uis.size(); ++i) {
 386                 ControlUI* cui = control_uis[i];
 387
 388                 if (cui->button || cui->file_button) {
 389
 390                         if (!is_scrollable && button_row == button_rows) {
 391                                 button_row = 0;
 392                                 if (++button_col == button_cols) {
 393                                         button_cols += 2;
 394                                         button_table->resize (button_rows, button_cols);
 395                                 }
 396                         }
 397
 398                         button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
 399                                              FILL|EXPAND, FILL);
 400                         button_row++;
 401
 402                 } else if (cui->controller || cui->clickbox || cui->combo) {
 403                         // Get all of the controls into a list, so that
 404                         // we can lay them out a bit more nicely later.
 405                         cui_controls_list.push_back(cui);
 406
 407                 } else if (cui->display) {
 408
 409                         output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
 410                                              FILL|EXPAND, FILL);
 411
 412                         // TODO: The meters should be divided into multiple rows
 413
 414                         if (++output_col == output_cols) {
 415                                 output_cols ++;
 416                                 output_table->resize (output_rows, output_cols);
 417                         }
 418                 }
 419         }
 420
 421         // Iterate over the list of controls to find which adjacent controls
 422         // are similar enough to be grouped together.
 423
 424         string label, previous_label = "";
 425         std::vector<int> numbers_in_labels(cui_controls_list.size());
 426
 427         std::vector<float> similarity_scores(cui_controls_list.size());
 428         float most_similar = 0.0, least_similar = 1.0;
 429
 430         size_t i = 0;
 431         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 432                 label = (*cuip)->label.get_text();
 433                 numbers_in_labels[i] = get_number(label);
 434
 435                 if (i > 0) {
 436                         // A hand-wavy calculation of how similar this control's
 437                         // label is to the previous.
 438                         similarity_scores[i] =
 439                                 (float) (
 440                                         ( matching_chars_at_head(label, previous_label) +
 441                                           matching_chars_at_tail(label, previous_label) +
 442                                           1
 443                                         )
 444                                 ) / (label.length() + previous_label.length());
 445                         if (numbers_in_labels[i] >= 0) {
 446                                 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
 447                         }
 448                         least_similar = min(least_similar, similarity_scores[i]);
 449                         most_similar  = max(most_similar, similarity_scores[i]);
 450                 } else {
 451                         similarity_scores[0] = 1.0;
 452                 }
 453
 454                 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
 455                 previous_label = label;
 456         }
 457
 458
 459         // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
 460         float similarity_threshold;
 461
 462         if (most_similar > 1.0) {
 463                 similarity_threshold = default_similarity_threshold;
 464         } else {
 465                 similarity_threshold = most_similar - (1 - default_similarity_threshold);
 466         }
 467
 468         // Now iterate over the list of controls to display them, placing an
 469         // HSeparator between controls of less than a certain similarity, and
 470         // starting a new column when necessary.
 471
 472         i = 0;
 473         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 474
 475                 ControlUI* cui = *cuip;
 476
 477                 if (!is_scrollable) {
 478                         x++;
 479                 }
 480
 481                 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
 482                         if (x > min_controls_per_column) {
 483                                 frame = manage (new Frame);
 484                                 frame->set_name ("BaseFrame");
 485                                 frame->set_label (_("Controls"));
 486                                 box = manage (new VBox);
 487                                 box->set_border_width (5);
 488                                 box->set_spacing (1);
 489                                 frame->add (*box);
 490                                 hpacker.pack_start(*frame, true, true);
 491                                 x = 0;
 492                         } else {
 493                                 HSeparator *split = new HSeparator();
 494                                 split->set_size_request(-1, 5);
 495                                 box->pack_start(*split, false, false, 0);
 496                         }
 497
 498                 }
 499                 box->pack_start (*cui, false, false);
 500         }
 501
 502         if (is_scrollable) {
 503                 prefheight = 30 * i;
 504         }
 505
 506         if (box->children().empty()) {
 507                 hpacker.remove (*frame);
 508         }
 509
 510         if (button_table->children().empty()) {
 511                 hpacker.remove (*bt_frame);
 512                 delete button_table;
 513         } else {
 514                 button_table->show_all ();
 515         }
 516
 517         if (!output_table->children().empty()) {
 518                 frame = manage (new Frame);
 519                 frame->set_name ("BaseFrame");
 520                 frame->set_label(_("Meters"));
 521                 frame->add (*output_table);
 522                 hpacker.pack_end (*frame, true, true);
 523                 output_table->show_all ();
 524         } else {
 525                 delete output_table;
 526         }
 527 }
 528
 529 void
 530 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
 531 {
 532         Gtk::Table* layout = manage (new Gtk::Table ());
 533
 534         for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
 535                 ControlUI* cui = *i;
 536                 if (cui->x0 < 0 || cui->y0 < 0) {
 537                         continue;
 538                 }
 539                 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
 540         }
 541         hpacker.pack_start (*layout, true, true);
 542 }
 543
 544 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 545         : param(p)
 546         , automate_button (X_("")) // force creation of a label
 547         , combo (0)
 548         , clickbox (0)
 549         , file_button (0)
 550         , spin_box (0)
 551         , display (0)
 552         , hbox (0)
 553         , vbox (0)
 554         , meterinfo (0)
 555         , knobtable (0)
 556 {
 557         automate_button.set_name ("PluginAutomateButton");
 558         set_tooltip (automate_button, _("Automation control"));
 559
 560         /* XXX translators: use a string here that will be at least as long
 561            as the longest automation label (see ::automation_state_changed()
 562            below). be sure to include a descender.
 563         */
 564
 565         set_size_request_to_display_given_text (automate_button, _("Mgnual"), 12, 6);
 566
 567         ignore_change = false;
 568         update_pending = false;
 569         button = false;
 570
 571         x0 = x1 = y0 = y1 = -1;
 572 }
 573
 574 GenericPluginUI::ControlUI::~ControlUI()
 575 {
 576         if (meterinfo) {
 577                 delete meterinfo->meter;
 578                 delete meterinfo;
 579         }
 580 }
 581
 582 void
 583 GenericPluginUI::automation_state_changed (ControlUI* cui)
 584 {
 585         /* update button label */
 586
 587         // don't lock to avoid deadlock because we're triggered by
 588         // AutomationControl::Changed() while the automation lock is taken
 589
 590         if (cui->knobtable) {
 591                 cui->automate_button.set_text (
 592                                 GainMeterBase::astate_string (
 593                                         insert->get_parameter_automation_state (cui->parameter()))
 594                                 );
 595                 return;
 596         }
 597
 598         switch (insert->get_parameter_automation_state (cui->parameter()) & (ARDOUR::Off|Play|Touch|Write)) {
 599         case ARDOUR::Off:
 600                 cui->automate_button.set_text (S_("Automation|Manual"));
 601                 break;
 602         case Play:
 603                 cui->automate_button.set_text (_("Play"));
 604                 break;
 605         case Write:
 606                 cui->automate_button.set_text (_("Write"));
 607                 break;
 608         case Touch:
 609                 cui->automate_button.set_text (_("Touch"));
 610                 break;
 611         default:
 612                 cui->automate_button.set_text (_("???"));
 613                 break;
 614         }
 615 }
 616
 617 bool
 618 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 619 {
 620         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 621         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 622         const size_t       len = str.copy(buf, 31);
 623         buf[len] = '\0';
 624         return true;
 625 }
 626
 627 bool
 628 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 629 {
 630         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 631         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 632         const size_t       len = str.copy(buf, 31);
 633         buf[len] = '\0';
 634         return true;
 635 }
 636
 637 void
 638 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
 639 {
 640         plugin->print_parameter (param, buf, len);
 641 }
 642
 643 /** Build a ControlUI for a parameter/property.
 644  * Note that mcontrol may be NULL for outputs.
 645  */
 646 GenericPluginUI::ControlUI*
 647 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 648                                    const ParameterDescriptor&           desc,
 649                                    boost::shared_ptr<AutomationControl> mcontrol,
 650                                    float                                value,
 651                                    bool                                 is_input,
 652                                    bool                                 use_knob)
 653 {
 654         ControlUI* control_ui = 0;
 655
 656         control_ui = manage (new ControlUI (param));
 657         control_ui->combo = 0;
 658         control_ui->control = mcontrol;
 659         control_ui->label.set_text (desc.label);
 660         control_ui->label.set_alignment (0.0, 0.5);
 661         control_ui->label.set_name ("PluginParameterLabel");
 662         control_ui->set_spacing (5);
 663
 664         Gtk::Requisition req (control_ui->automate_button.size_request());
 665
 666         if (is_input) {
 667
 668                 if (desc.datatype == Variant::PATH) {
 669
 670                         /* We shouldn't get that type for input ports */
 671                         assert(param.type() == PluginPropertyAutomation);
 672
 673                         /* Build a file selector button */
 674
 675                         // Create/add controller
 676                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 677                         control_ui->file_button->set_title(desc.label);
 678
 679                         if (use_knob) {
 680                                 control_ui->knobtable = manage (new Table());
 681                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 682                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 683                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 684                         } else {
 685                                 control_ui->pack_start (control_ui->label, false, true);
 686                                 control_ui->pack_start (*control_ui->file_button, true, true);
 687                         }
 688
 689                         // Monitor changes from the user.
 690                         control_ui->file_button->signal_file_set().connect(
 691                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 692                                            desc, control_ui->file_button));
 693
 694                         /* Add the filebutton control to a map so that we can update it when
 695                          * the corresponding property changes. This doesn't go through the usual
 696                          * AutomationControls, because they don't support non-numeric values. */
 697                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 698
 699                         return control_ui;
 700                 }
 701
 702                 assert(mcontrol);
 703
 704                 /* See if there any named values for our input value */
 705                 control_ui->scale_points = desc.scale_points;
 706
 707                 /* If this parameter is an integer, work out the number of distinct values
 708                    it can take on (assuming that lower and upper values are allowed).
 709                 */
 710                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 711
 712                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 713
 714                         /* Either:
 715                          *   a) There is a label for each possible value of this input, or
 716                          *   b) This port is marked as being an enumeration.
 717                          */
 718
 719                         control_ui->combo = new ArdourDropdown();
 720                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 721                              i != control_ui->scale_points->end();
 722                              ++i) {
 723                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 724                                                 i->first,
 725                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 726                                                            control_ui,
 727                                                            i->second)));
 728                         }
 729
 730                         update_control_display(control_ui);
 731
 732                 } else {
 733
 734                         /* create the controller */
 735
 736                         /* XXX memory leak: SliderController not destroyed by ControlUI
 737                          * destructor, and manage() reports object hierarchy
 738                          * ambiguity.
 739                          */
 740                         control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol, use_knob);
 741
 742                         /* Control UI's don't need the rapid timer workaround */
 743                         control_ui->controller->stop_updating ();
 744
 745                         /* XXX this code is not right yet, because it doesn't handle
 746                            the absence of bounds in any sensible fashion.
 747                         */
 748
 749                         Adjustment* adj = control_ui->controller->adjustment();
 750
 751                         if (desc.integer_step && !desc.toggled) {
 752                                 control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
 753                                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
 754                                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
 755                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
 756                                 } else {
 757                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
 758                                 }
 759                         } else if (desc.toggled) {
 760                                 control_ui->controller->set_size_request (req.height, req.height);
 761                         } else if (use_knob) {
 762                                 control_ui->controller->set_size_request (req.height * 1.5, req.height * 1.5);
 763                         } else {
 764                                 control_ui->controller->set_size_request (200, req.height);
 765                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
 766                         }
 767
 768                         if (!desc.integer_step && !desc.toggled && use_knob) {
 769                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj, insert));
 770                         }
 771
 772                         adj->set_value (mcontrol->internal_to_interface(value));
 773
 774                 }
 775
 776                 if (use_knob) {
 777                         set_size_request_to_display_given_text (control_ui->automate_button, "M", 2, 2);
 778
 779                         control_ui->label.set_alignment (0.5, 0.5);
 780                         control_ui->knobtable = manage (new Table());
 781                         control_ui->pack_start(*control_ui->knobtable, true, true);
 782
 783                         if (control_ui->combo) {
 784                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 785                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
 786                         } else if (control_ui->clickbox) {
 787                                 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
 788                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 789                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 790                         } else if (control_ui->spin_box) {
 791                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
 792                                 knob->set_tooltip_prefix (desc.label + ": ");
 793                                 knob->set_printer (insert);
 794                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
 795                                 align->add (*control_ui->controller);
 796                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
 797                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
 798                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
 799                         } else if (desc.toggled) {
 800                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
 801                                 align->add (*control_ui->controller);
 802                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
 803                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 804                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 805                         } else {
 806                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
 807                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 808                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 809                         }
 810
 811                 } else {
 812
 813                         control_ui->pack_start (control_ui->label, true, true);
 814                         if (control_ui->combo) {
 815                                 control_ui->pack_start(*control_ui->combo, false, true);
 816                         } else if (control_ui->clickbox) {
 817                                 control_ui->pack_start (*control_ui->clickbox, false, false);
 818                         } else if (control_ui->spin_box) {
 819                                 control_ui->pack_start (*control_ui->spin_box, false, false);
 820                                 control_ui->pack_start (*control_ui->controller, false, false);
 821                         } else {
 822                                 control_ui->pack_start (*control_ui->controller, false, false);
 823                         }
 824                         control_ui->pack_start (control_ui->automate_button, false, false);
 825                 }
 826
 827
 828                 if (mcontrol->flags () & Controllable::NotAutomatable) {
 829                         control_ui->automate_button.set_sensitive (false);
 830                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
 831                 } else {
 832                         control_ui->automate_button.signal_clicked.connect (sigc::bind (
 833                                                 sigc::mem_fun(*this, &GenericPluginUI::astate_clicked),
 834                                                 control_ui));
 835                         mcontrol->alist()->automation_state_changed.connect (
 836                                         control_connections,
 837                                         invalidator (*this),
 838                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
 839                                         gui_context());
 840                         input_controls_with_automation.push_back (control_ui);
 841                 }
 842
 843                 if (desc.toggled) {
 844                         control_ui->button = true;
 845                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
 846                         assert (but);
 847                         but->set_name ("pluginui toggle");
 848                         update_control_display(control_ui);
 849                 }
 850
 851                 automation_state_changed (control_ui);
 852
 853                 /* Add to the list of CUIs that need manual update to workaround
 854                  * AutomationControl not knowing about preset loads */
 855                 input_controls.push_back (control_ui);
 856
 857         } else {
 858
 859                 control_ui->display = manage (new EventBox);
 860                 control_ui->display->set_name ("ParameterValueDisplay");
 861
 862                 control_ui->display_label = manage (new Label);
 863
 864                 control_ui->display_label->set_name ("ParameterValueDisplay");
 865
 866                 control_ui->display->add (*control_ui->display_label);
 867                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
 868
 869                 control_ui->display->show_all ();
 870
 871                 control_ui->vbox = manage (new VBox);
 872                 control_ui->vbox->set_spacing(3);
 873
 874                 if (desc.integer_step || desc.enumeration) {
 875                         control_ui->vbox->pack_end (*control_ui->display, false, false);
 876                         control_ui->vbox->pack_end (control_ui->label, false, false);
 877                 } else {
 878                         /* set up a meter for float ports */
 879
 880                         MeterInfo * info = new MeterInfo();
 881                         control_ui->meterinfo = info;
 882
 883                         info->meter = new FastMeter (
 884                                         5, 5, FastMeter::Vertical, 0,
 885                                         0x0000aaff,
 886                                         0x008800ff, 0x008800ff,
 887                                         0x00ff00ff, 0x00ff00ff,
 888                                         0xcccc00ff, 0xcccc00ff,
 889                                         0xffaa00ff, 0xffaa00ff,
 890                                         0xff0000ff,
 891                                         UIConfiguration::instance().color ("meter background bottom"),
 892                                         UIConfiguration::instance().color ("meter background top")
 893                                         );
 894
 895                         info->min_unbound = desc.min_unbound;
 896                         info->max_unbound = desc.max_unbound;
 897
 898                         info->min = desc.lower;
 899                         info->max = desc.upper;
 900
 901                         control_ui->label.set_angle(90);
 902
 903                         HBox* center =  manage (new HBox);
 904                         center->set_spacing(1);
 905                         center->pack_start (control_ui->label, false, false);
 906                         center->pack_start (*info->meter, false, false);
 907
 908                         control_ui->hbox = manage (new HBox);
 909                         control_ui->hbox->pack_start (*center, true, false);
 910
 911                         // horizontally center this hbox in the vbox
 912                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
 913
 914                         control_ui->meterinfo->meter->show_all();
 915                         control_ui->meterinfo->packed = true;
 916                         control_ui->vbox->pack_start (*control_ui->display, false, false);
 917                 }
 918
 919                 control_ui->pack_start (*control_ui->vbox);
 920
 921                 output_controls.push_back (control_ui);
 922         }
 923
 924         if (mcontrol) {
 925                 mcontrol->Changed.connect(control_connections, invalidator(*this),
 926                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
 927                                                       this, control_ui),
 928                                           gui_context());
 929         }
 930
 931         return control_ui;
 932 }
 933
 934 void
 935 GenericPluginUI::astate_clicked (ControlUI* cui)
 936 {
 937         using namespace Menu_Helpers;
 938
 939         if (automation_menu == 0) {
 940                 automation_menu = manage (new Menu);
 941                 automation_menu->set_name ("ArdourContextMenu");
 942         }
 943
 944         MenuList& items (automation_menu->items());
 945
 946         items.clear ();
 947         items.push_back (MenuElem (S_("Automation|Manual"),
 948                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
 949         items.push_back (MenuElem (_("Play"),
 950                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
 951         items.push_back (MenuElem (_("Write"),
 952                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
 953         items.push_back (MenuElem (_("Touch"),
 954                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
 955
 956         automation_menu->popup (1, gtk_get_current_event_time());
 957 }
 958
 959 void
 960 GenericPluginUI::set_all_automation (AutoState as)
 961 {
 962         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
 963                 if ((*i)->controller || (*i)->button) {
 964                         set_automation_state (as, (*i));
 965                 }
 966         }
 967 }
 968
 969 void
 970 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
 971 {
 972         insert->set_parameter_automation_state (cui->parameter(), state);
 973 }
 974
 975 void
 976 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
 977 {
 978         if (!cui->update_pending) {
 979                 cui->update_pending = true;
 980                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
 981         }
 982 }
 983
 984 void
 985 GenericPluginUI::update_control_display (ControlUI* cui)
 986 {
 987         /* XXX how do we handle logarithmic stuff here ? */
 988
 989         cui->update_pending = false;
 990
 991         float val = cui->control->get_value();
 992
 993         PBD::Unwinder<bool> (cui->ignore_change, true);
 994
 995         if (cui->combo && cui->scale_points) {
 996                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
 997                         if (it->second == val) {
 998                                 cui->combo->set_text(it->first);
 999                                 break;
1000                         }
1001                 }
1002         } else if (cui->button) {
1003                 // AutomationController handles this
1004         }
1005
1006         if( cui->controller ) {
1007             cui->controller->display_effective_value();
1008         }
1009
1010
1011         /*} else {
1012                 if (cui->logarithmic) {
1013                         val = log(val);
1014                 }
1015                 if (val != cui->adjustment->get_value()) {
1016                         cui->adjustment->set_value (val);
1017                 }
1018         }*/
1019 }
1020
1021 void
1022 GenericPluginUI::update_input_displays ()
1023 {
1024         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1025         for (vector<ControlUI*>::iterator i = input_controls.begin();
1026              i != input_controls.end();
1027              ++i) {
1028                 update_control_display(*i);
1029         }
1030         return;
1031 }
1032
1033 void
1034 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1035 {
1036         if (!cui->ignore_change) {
1037                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1038         }
1039 }
1040
1041 bool
1042 GenericPluginUI::start_updating (GdkEventAny*)
1043 {
1044         if (output_controls.size() > 0 ) {
1045                 screen_update_connection.disconnect();
1046                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1047         }
1048         return false;
1049 }
1050
1051 bool
1052 GenericPluginUI::stop_updating (GdkEventAny*)
1053 {
1054         if (output_controls.size() > 0 ) {
1055                 screen_update_connection.disconnect();
1056         }
1057         return false;
1058 }
1059
1060 void
1061 GenericPluginUI::output_update ()
1062 {
1063         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1064                 float val = plugin->get_parameter ((*i)->parameter().id());
1065                 char buf[32];
1066                 snprintf (buf, sizeof(buf), "%.2f", val);
1067                 (*i)->display_label->set_text (buf);
1068
1069                 /* autoscaling for the meter */
1070                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1071
1072                         if (val < (*i)->meterinfo->min) {
1073                                 if ((*i)->meterinfo->min_unbound)
1074                                         (*i)->meterinfo->min = val;
1075                                 else
1076                                         val = (*i)->meterinfo->min;
1077                         }
1078
1079                         if (val > (*i)->meterinfo->max) {
1080                                 if ((*i)->meterinfo->max_unbound)
1081                                         (*i)->meterinfo->max = val;
1082                                 else
1083                                         val = (*i)->meterinfo->max;
1084                         }
1085
1086                         if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
1087                                 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
1088                                 (*i)->meterinfo->meter->set (lval );
1089                         }
1090                 }
1091         }
1092 }
1093
1094 void
1095 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1096                                     Gtk::FileChooserButton*    widget)
1097 {
1098         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1099 }
1100
1101 void
1102 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1103 {
1104         FilePathControls::iterator c = _filepath_controls.find(key);
1105         if (c != _filepath_controls.end()) {
1106                 c->second->set_filename(value.get_path());
1107         } else {
1108                 std::cerr << "warning: property change for property with no control" << std::endl;
1109         }
1110 }