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