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