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