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