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