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