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