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