gtk2_ardour/generic_pluginui.cc

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