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