gtk2_ardour/generic_pluginui.cc

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