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