gtk2_ardour/generic_pluginui.cc

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