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