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