gtk2_ardour/generic_pluginui.cc

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