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