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 <gtkmm/separator.h>
  31
  32 #include "pbd/stl_delete.h"
  33 #include "pbd/unwind.h"
  34 #include "pbd/xml++.h"
  35 #include "pbd/failed_constructor.h"
  36
  37 #include "ardour/plugin.h"
  38 #include "ardour/plugin_insert.h"
  39 #include "ardour/session.h"
  40 #include "ardour/value_as_string.h"
  41
  42 #include "gtkmm2ext/utils.h"
  43 #include "gtkmm2ext/doi.h"
  44
  45 #include "widgets/ardour_knob.h"
  46 #include "widgets/click_box.h"
  47 #include "widgets/fastmeter.h"
  48 #include "widgets/slider_controller.h"
  49 #include "widgets/tooltips.h"
  50
  51 #include "plugin_ui.h"
  52 #include "plugin_display.h"
  53 #include "gui_thread.h"
  54 #include "automation_controller.h"
  55 #include "gain_meter.h"
  56 #include "timers.h"
  57 #include "ui_config.h"
  58
  59 #include "pbd/i18n.h"
  60
  61 using namespace std;
  62 using namespace ARDOUR;
  63 using namespace PBD;
  64 using namespace Gtkmm2ext;
  65 using namespace ArdourWidgets;
  66 using namespace Gtk;
  67 using namespace ARDOUR_UI_UTILS;
  68
  69 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
  70         : PlugUIBase (pi)
  71         , automation_menu (0)
  72         , is_scrollable(scrollable)
  73 {
  74         set_name ("PluginEditor");
  75         set_border_width (10);
  76         //set_homogeneous (false);
  77
  78         pack_start (main_contents, true, true);
  79         settings_box.set_homogeneous (false);
  80
  81         HBox* constraint_hbox = manage (new HBox);
  82         HBox* smaller_hbox = manage (new HBox);
  83         HBox* automation_hbox = manage (new HBox);
  84         smaller_hbox->set_spacing (4);
  85         automation_hbox->set_spacing (6);
  86         Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
  87         combo_label->set_use_markup (true);
  88
  89         latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
  90         set_latency_label ();
  91
  92         smaller_hbox->pack_start (latency_button, false, false, 4);
  93         smaller_hbox->pack_start (pin_management_button, false, false, 4);
  94         smaller_hbox->pack_start (_preset_combo, false, false);
  95         smaller_hbox->pack_start (_preset_modified, false, false);
  96         smaller_hbox->pack_start (add_button, false, false);
  97         smaller_hbox->pack_start (save_button, false, false);
  98         smaller_hbox->pack_start (delete_button, false, false);
  99         smaller_hbox->pack_start (reset_button, false, false, 4);
 100         smaller_hbox->pack_start (bypass_button, false, true, 4);
 101
 102         automation_manual_all_button.set_text(_("Manual"));
 103         automation_manual_all_button.set_name (X_("generic button"));
 104         automation_play_all_button.set_text(_("Play"));
 105         automation_play_all_button.set_name (X_("generic button"));
 106         automation_write_all_button.set_text(_("Write"));
 107         automation_write_all_button.set_name (X_("generic button"));
 108         automation_touch_all_button.set_text(_("Touch"));
 109         automation_touch_all_button.set_name (X_("generic button"));
 110
 111         Label* l = manage (new Label (_("All Automation")));
 112         l->set_alignment (1.0, 0.5);
 113         automation_hbox->pack_start (*l, true, true);
 114         automation_hbox->pack_start (automation_manual_all_button, false, false);
 115         automation_hbox->pack_start (automation_play_all_button, false, false);
 116         automation_hbox->pack_start (automation_write_all_button, false, false);
 117         automation_hbox->pack_start (automation_touch_all_button, false, false);
 118
 119         constraint_hbox->set_spacing (5);
 120         constraint_hbox->set_homogeneous (false);
 121
 122         VBox* v1_box = manage (new VBox);
 123         VBox* v2_box = manage (new VBox);
 124         pack_end (plugin_analysis_expander, false, false);
 125         if (!plugin->get_docs().empty()) {
 126                 pack_end (description_expander, false, false);
 127         }
 128
 129         v1_box->set_spacing (6);
 130         v1_box->pack_start (*smaller_hbox, false, true);
 131         v1_box->pack_start (*automation_hbox, false, true);
 132         v2_box->pack_start (focus_button, false, true);
 133
 134         main_contents.pack_start (settings_box, false, false);
 135
 136         constraint_hbox->pack_end (*v2_box, false, false);
 137         constraint_hbox->pack_end (*v1_box, false, false);
 138
 139         main_contents.pack_start (*constraint_hbox, false, false);
 140
 141         if (is_scrollable) {
 142                 Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow());
 143                 scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 144                 scroller->set_name ("PluginEditor");
 145                 scroller->add (hpacker);
 146                 main_contents.pack_start (*scroller, true, true);
 147         } else {
 148                 main_contents.pack_start (hpacker, false, false);
 149         }
 150
 151         pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
 152
 153         bypass_button.set_active (!pi->enabled());
 154
 155         prefheight = 0;
 156         build ();
 157
 158         /* Listen for property changes that are not notified normally because
 159          * AutomationControl has only support for numeric values currently.
 160          * The only case is Variant::PATH for now */
 161         plugin->PropertyChanged.connect(*this, invalidator(*this),
 162                                         boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
 163                                         gui_context());
 164
 165         main_contents.show ();
 166 }
 167
 168 GenericPluginUI::~GenericPluginUI ()
 169 {
 170         if (output_controls.size() > 0) {
 171                 screen_update_connection.disconnect();
 172         }
 173 }
 174
 175 // Some functions for calculating the 'similarity' of two plugin
 176 // control labels.
 177
 178 static int get_number(string label) {
 179 static const char *digits = "0123456789";
 180 int value = -1;
 181
 182         std::size_t first_digit_pos = label.find_first_of(digits);
 183         if (first_digit_pos != string::npos) {
 184                 // found some digits: there's a number in there somewhere
 185                 stringstream s;
 186                 s << label.substr(first_digit_pos);
 187                 s >> value;
 188         }
 189         return value;
 190 }
 191
 192 static int match_or_digit(char c1, char c2) {
 193         return c1 == c2 || (isdigit(c1) && isdigit(c2));
 194 }
 195
 196 static std::size_t matching_chars_at_head(const string s1, const string s2) {
 197 std::size_t length, n = 0;
 198
 199         length = min(s1.length(), s2.length());
 200         while (n < length) {
 201                 if (!match_or_digit(s1[n], s2[n]))
 202                         break;
 203                 n++;
 204         }
 205         return n;
 206 }
 207
 208 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
 209 std::size_t s1pos, s2pos, n = 0;
 210
 211         s1pos = s1.length();
 212         s2pos = s2.length();
 213         while (s1pos-- > 0 && s2pos-- > 0) {
 214                 if (!match_or_digit(s1[s1pos], s2[s2pos])       )
 215                         break;
 216                 n++;
 217         }
 218         return n;
 219 }
 220
 221 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
 222 static const float default_similarity_threshold = 0.3;
 223 static const guint32 max_columns_for_big_autostate = 2;
 224
 225 void
 226 GenericPluginUI::build ()
 227 {
 228         std::vector<ControlUI *> control_uis;
 229         bool grid = plugin->parameter_count() > 0;
 230
 231         // Build a ControlUI for each control port
 232         for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 233
 234                 if (plugin->parameter_is_control (i)) {
 235
 236                         /* Don't show latency control ports */
 237
 238                         const Evoral::Parameter param(PluginAutomation, 0, i);
 239                         if (plugin->describe_parameter (param) == X_("latency")) {
 240                                 continue;
 241                         }
 242
 243                         if (plugin->describe_parameter (param) == X_("hidden")) {
 244                                 continue;
 245                         }
 246
 247                         const float value = plugin->get_parameter(i);
 248
 249                         ControlUI* cui;
 250                         Plugin::UILayoutHint hint;
 251
 252                         if (!plugin->get_layout(i, hint)) {
 253                                 grid = false;
 254                         }
 255
 256                         boost::shared_ptr<ARDOUR::AutomationControl> c
 257                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 258                                         insert->control(param));
 259
 260                         ParameterDescriptor desc;
 261                         plugin->get_parameter_descriptor(i, desc);
 262                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
 263                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
 264                                 continue;
 265                         }
 266
 267                         if (grid) {
 268                                 cui->x0 = hint.x0;
 269                                 cui->x1 = hint.x1;
 270                                 cui->y0 = hint.y0;
 271                                 cui->y1 = hint.y1;
 272                         }
 273
 274                         const std::string param_docs = plugin->get_parameter_docs(i);
 275                         if (!param_docs.empty()) {
 276                                 set_tooltip(cui, param_docs.c_str());
 277                         }
 278
 279                         control_uis.push_back(cui);
 280                 }
 281         }
 282
 283         // Build a ControlUI for each property
 284         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
 285         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
 286                 const ParameterDescriptor& desc = d->second;
 287                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 288
 289                 boost::shared_ptr<ARDOUR::AutomationControl> c
 290                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 291                                 insert->control(param));
 292
 293                 if (!c) {
 294                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
 295                         continue;
 296                 }
 297
 298                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
 299                 if (!cui) {
 300                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
 301                                                 desc.key) << endmsg;
 302                         continue;
 303                 }
 304
 305                 control_uis.push_back(cui);
 306         }
 307         if (!descs.empty()) {
 308                 plugin->announce_property_values();
 309         }
 310
 311         if (grid) {
 312                 custom_layout (control_uis);
 313         } else {
 314                 automatic_layout (control_uis);
 315         }
 316
 317         output_update ();
 318
 319         automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
 320         automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
 321         automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
 322         automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 323
 324         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
 325         plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
 326 }
 327
 328
 329 void
 330 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
 331 {
 332         guint32 x = 0;
 333
 334         static const int32_t initial_button_rows = 12;
 335         static const int32_t initial_button_cols = 1;
 336         static const int32_t initial_output_rows = 1;
 337         static const int32_t initial_output_cols = 4;
 338
 339         Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
 340         Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
 341
 342         Frame* frame;
 343         Frame* bt_frame;
 344         VBox* box;
 345         int output_row, output_col;
 346         int button_row, button_col;
 347         int output_rows, output_cols;
 348         int button_rows, button_cols;
 349
 350         hpacker.set_spacing (10);
 351         hpacker.set_border_width (10);
 352
 353         output_rows = initial_output_rows;
 354         output_cols = initial_output_cols;
 355         button_rows = initial_button_rows;
 356         button_cols = initial_button_cols;
 357         output_row = 0;
 358         button_row = 0;
 359         output_col = 0;
 360         button_col = 0;
 361
 362         button_table->set_homogeneous (false);
 363         button_table->set_row_spacings (2);
 364         button_table->set_col_spacings (2);
 365         output_table->set_homogeneous (true);
 366         output_table->set_row_spacings (2);
 367         output_table->set_col_spacings (2);
 368         button_table->set_border_width (5);
 369         output_table->set_border_width (5);
 370
 371
 372         bt_frame = manage (new Frame);
 373         bt_frame->set_name ("BaseFrame");
 374         bt_frame->set_label (_("Switches"));
 375         bt_frame->add (*button_table);
 376         hpacker.pack_start(*bt_frame, true, true);
 377
 378         box = manage (new VBox);
 379         box->set_border_width (5);
 380         box->set_spacing (1);
 381
 382         frame = manage (new Frame);
 383         frame->set_name ("BaseFrame");
 384         frame->set_label (_("Controls"));
 385         frame->add (*box);
 386         hpacker.pack_start(*frame, true, true);
 387
 388         // Add special controls to UI, and build list of normal controls to be layed out later
 389         std::vector<ControlUI *> cui_controls_list;
 390         for (size_t i = 0; i < control_uis.size(); ++i) {
 391                 ControlUI* cui = control_uis[i];
 392
 393                 if (cui->button || cui->file_button) {
 394
 395                         if (!is_scrollable && button_row == button_rows) {
 396                                 button_row = 0;
 397                                 if (++button_col == button_cols) {
 398                                         button_cols += 2;
 399                                         button_table->resize (button_rows, button_cols);
 400                                 }
 401                         }
 402
 403                         button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
 404                                              FILL|EXPAND, FILL);
 405                         button_row++;
 406
 407                 } else if (cui->controller || cui->clickbox || cui->combo) {
 408                         // Get all of the controls into a list, so that
 409                         // we can lay them out a bit more nicely later.
 410                         cui_controls_list.push_back(cui);
 411
 412                 } else if (cui->display) {
 413
 414                         output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
 415                                              FILL|EXPAND, FILL);
 416
 417                         // TODO: The meters should be divided into multiple rows
 418
 419                         if (++output_col == output_cols) {
 420                                 output_cols ++;
 421                                 output_table->resize (output_rows, output_cols);
 422                         }
 423                 }
 424         }
 425
 426         // Iterate over the list of controls to find which adjacent controls
 427         // are similar enough to be grouped together.
 428
 429         string label, previous_label = "";
 430         std::vector<int> numbers_in_labels(cui_controls_list.size());
 431
 432         std::vector<float> similarity_scores(cui_controls_list.size());
 433         float most_similar = 0.0, least_similar = 1.0;
 434
 435         size_t i = 0;
 436         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 437                 label = (*cuip)->label.get_text();
 438                 numbers_in_labels[i] = get_number(label);
 439
 440                 if (i > 0) {
 441                         // A hand-wavy calculation of how similar this control's
 442                         // label is to the previous.
 443                         similarity_scores[i] =
 444                                 (float) (
 445                                         ( matching_chars_at_head(label, previous_label) +
 446                                           matching_chars_at_tail(label, previous_label) +
 447                                           1
 448                                         )
 449                                 ) / (label.length() + previous_label.length());
 450                         if (numbers_in_labels[i] >= 0) {
 451                                 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
 452                         }
 453                         least_similar = min(least_similar, similarity_scores[i]);
 454                         most_similar  = max(most_similar, similarity_scores[i]);
 455                 } else {
 456                         similarity_scores[0] = 1.0;
 457                 }
 458
 459                 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
 460                 previous_label = label;
 461         }
 462
 463
 464         // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
 465         float similarity_threshold;
 466
 467         if (most_similar > 1.0) {
 468                 similarity_threshold = default_similarity_threshold;
 469         } else {
 470                 similarity_threshold = most_similar - (1 - default_similarity_threshold);
 471         }
 472
 473         // Now iterate over the list of controls to display them, placing an
 474         // HSeparator between controls of less than a certain similarity, and
 475         // starting a new column when necessary.
 476
 477         i = 0;
 478         size_t columns = 1;
 479         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 480
 481                 ControlUI* cui = *cuip;
 482
 483                 if (!is_scrollable) {
 484                         x++;
 485                 }
 486
 487                 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
 488                         if (x > min_controls_per_column) {
 489                                 frame = manage (new Frame);
 490                                 frame->set_name ("BaseFrame");
 491                                 frame->set_label (_("Controls"));
 492                                 box = manage (new VBox);
 493                                 box->set_border_width (5);
 494                                 box->set_spacing (1);
 495                                 frame->add (*box);
 496                                 hpacker.pack_start(*frame, true, true);
 497                                 x = 0;
 498                                 ++columns;
 499                         } else {
 500                                 HSeparator *split = new HSeparator();
 501                                 split->set_size_request(-1, 5);
 502                                 box->pack_start(*split, false, false, 0);
 503                         }
 504
 505                 }
 506                 box->pack_start (*cui, false, false);
 507         }
 508
 509         if (columns > max_columns_for_big_autostate) {
 510                 for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin();
 511                                                   cuip != cui_controls_list.end();
 512                                                   ++cuip) {
 513                         set_short_autostate(*cuip, true);
 514                 }
 515         }
 516
 517         if (is_scrollable) {
 518                 prefheight = 30 * i;
 519         }
 520
 521         if (box->children().empty()) {
 522                 hpacker.remove (*frame);
 523         }
 524
 525         if (button_table->children().empty()) {
 526                 hpacker.remove (*bt_frame);
 527                 delete button_table;
 528         } else {
 529                 button_table->show_all ();
 530         }
 531
 532         if (!output_table->children().empty()) {
 533                 frame = manage (new Frame);
 534                 frame->set_name ("BaseFrame");
 535                 frame->set_label(_("Meters"));
 536                 frame->add (*output_table);
 537                 hpacker.pack_end (*frame, true, true);
 538                 output_table->show_all ();
 539         } else {
 540                 delete output_table;
 541         }
 542
 543         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 544                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 545                 hpacker.pack_end (*pd, true, true);
 546         }
 547         show_all();
 548
 549 }
 550
 551 void
 552 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
 553 {
 554         Gtk::Table* layout = manage (new Gtk::Table ());
 555
 556         for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
 557                 ControlUI* cui = *i;
 558                 if (cui->x0 < 0 || cui->y0 < 0) {
 559                         continue;
 560                 }
 561                 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
 562         }
 563         hpacker.pack_start (*layout, true, true);
 564
 565         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 566                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 567                 hpacker.pack_end (*pd, true, true);
 568         }
 569 }
 570
 571 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 572         : param(p)
 573         , automate_button (X_("")) // force creation of a label
 574         , combo (0)
 575         , clickbox (0)
 576         , file_button (0)
 577         , spin_box (0)
 578         , display (0)
 579         , hbox (0)
 580         , vbox (0)
 581         , meterinfo (0)
 582         , knobtable (0)
 583 {
 584         automate_button.set_name ("plugin automation state button");
 585         set_tooltip (automate_button, _("Automation control"));
 586
 587         ignore_change = false;
 588         update_pending = false;
 589         button = false;
 590
 591         x0 = x1 = y0 = y1 = -1;
 592 }
 593
 594 GenericPluginUI::ControlUI::~ControlUI()
 595 {
 596         if (meterinfo) {
 597                 delete meterinfo->meter;
 598                 delete meterinfo;
 599         }
 600 }
 601
 602 void
 603 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
 604 {
 605         cui->short_autostate = value;
 606         if (value) {
 607                 cui->automate_button.set_sizing_text("M");
 608         } else {
 609                 /* XXX translators: use a string here that will be at least as long
 610                    as the longest automation label (see ::automation_state_changed()
 611                    below). be sure to include a descender. */
 612                 cui->automate_button.set_sizing_text(_("Mgnual"));
 613         }
 614         automation_state_changed(cui);
 615 }
 616
 617 void
 618 GenericPluginUI::automation_state_changed (ControlUI* cui)
 619 {
 620         /* update button label */
 621
 622         // don't lock to avoid deadlock because we're triggered by
 623         // AutomationControl::Changed() while the automation lock is taken
 624
 625         AutoState state = insert->get_parameter_automation_state (cui->parameter());
 626
 627         cui->automate_button.set_active((state != ARDOUR::Off));
 628
 629         if (cui->short_autostate) {
 630                 cui->automate_button.set_text (
 631                                 GainMeterBase::astate_string (state));
 632                 return;
 633         }
 634
 635         switch (state & (ARDOUR::Off|Play|Touch|Write)) {
 636         case ARDOUR::Off:
 637                 cui->automate_button.set_text (S_("Automation|Manual"));
 638                 break;
 639         case Play:
 640                 cui->automate_button.set_text (_("Play"));
 641                 break;
 642         case Write:
 643                 cui->automate_button.set_text (_("Write"));
 644                 break;
 645         case Touch:
 646                 cui->automate_button.set_text (_("Touch"));
 647                 break;
 648         default:
 649                 cui->automate_button.set_text (_("???"));
 650                 break;
 651         }
 652 }
 653
 654 bool
 655 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 656 {
 657         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 658         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 659         const size_t       len = str.copy(buf, 31);
 660         buf[len] = '\0';
 661         return true;
 662 }
 663
 664 bool
 665 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 666 {
 667         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 668         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 669         const size_t       len = str.copy(buf, 31);
 670         buf[len] = '\0';
 671         return true;
 672 }
 673
 674 void
 675 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
 676 {
 677         plugin->print_parameter (param, buf, len);
 678 }
 679
 680 /** Build a ControlUI for a parameter/property.
 681  * Note that mcontrol may be NULL for outputs.
 682  */
 683 GenericPluginUI::ControlUI*
 684 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 685                                    const ParameterDescriptor&           desc,
 686                                    boost::shared_ptr<AutomationControl> mcontrol,
 687                                    float                                value,
 688                                    bool                                 is_input,
 689                                    bool                                 use_knob)
 690 {
 691         ControlUI* control_ui = 0;
 692
 693         control_ui = manage (new ControlUI (param));
 694         control_ui->combo = 0;
 695         control_ui->control = mcontrol;
 696         control_ui->label.set_text (desc.label);
 697         control_ui->label.set_alignment (0.0, 0.5);
 698         control_ui->label.set_name ("PluginParameterLabel");
 699         control_ui->set_spacing (5);
 700         set_short_autostate(control_ui, false);
 701
 702         if (is_input) {
 703
 704                 if (desc.datatype == Variant::PATH) {
 705
 706                         /* We shouldn't get that type for input ports */
 707                         assert(param.type() == PluginPropertyAutomation);
 708
 709                         /* Build a file selector button */
 710
 711                         // Create/add controller
 712                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 713                         control_ui->file_button->set_title(desc.label);
 714
 715                         if (use_knob) {
 716                                 control_ui->knobtable = manage (new Table());
 717                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 718                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 719                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 720                         } else {
 721                                 control_ui->pack_start (control_ui->label, false, true);
 722                                 control_ui->pack_start (*control_ui->file_button, true, true);
 723                         }
 724
 725                         // Monitor changes from the user.
 726                         control_ui->file_button->signal_file_set().connect(
 727                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 728                                            desc, control_ui->file_button));
 729
 730                         /* Add the filebutton control to a map so that we can update it when
 731                          * the corresponding property changes. This doesn't go through the usual
 732                          * AutomationControls, because they don't support non-numeric values. */
 733                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 734
 735                         return control_ui;
 736                 }
 737
 738                 assert(mcontrol);
 739
 740                 /* See if there any named values for our input value */
 741                 control_ui->scale_points = desc.scale_points;
 742
 743                 /* If this parameter is an integer, work out the number of distinct values
 744                    it can take on (assuming that lower and upper values are allowed).
 745                 */
 746                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 747
 748                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 749
 750                         /* Either:
 751                          *   a) There is a label for each possible value of this input, or
 752                          *   b) This port is marked as being an enumeration.
 753                          */
 754
 755                         control_ui->combo = new ArdourDropdown();
 756                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 757                              i != control_ui->scale_points->end();
 758                              ++i) {
 759                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 760                                                 i->first,
 761                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 762                                                            control_ui,
 763                                                            i->second)));
 764                         }
 765
 766                         control_ui->combo->set_controllable (mcontrol);
 767
 768                         update_control_display(control_ui);
 769
 770                 } else {
 771
 772                         /* create the controller */
 773
 774                         /* XXX memory leak: SliderController not destroyed by ControlUI
 775                          * destructor, and manage() reports object hierarchy
 776                          * ambiguity.
 777                          */
 778                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
 779
 780                         /* Control UI's don't need the rapid timer workaround */
 781                         control_ui->controller->stop_updating ();
 782
 783                         /* XXX this code is not right yet, because it doesn't handle
 784                            the absence of bounds in any sensible fashion.
 785                         */
 786
 787                         Adjustment* adj = control_ui->controller->adjustment();
 788
 789                         if (desc.integer_step && !desc.toggled) {
 790                                 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
 791                                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
 792                                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
 793                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
 794                                 } else {
 795                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
 796                                 }
 797                                 control_ui->clickbox->set_controllable (mcontrol);
 798                         } else if (desc.toggled) {
 799                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
 800                                 assert(but);
 801                                 but->set_tweaks(ArdourButton::Square);
 802                         } else if (use_knob) {
 803                                 /* Delay size request so that styles are gotten right */
 804                                 control_ui->controller->widget()->signal_size_request().connect(
 805                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
 806                         } else {
 807                                 control_ui->controller->set_size_request (200, -1);
 808                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
 809                         }
 810
 811                         if (!desc.integer_step && !desc.toggled && use_knob) {
 812                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
 813                         }
 814
 815                         adj->set_value (mcontrol->internal_to_interface(value));
 816
 817                 }
 818
 819                 if (use_knob) {
 820                         set_short_autostate(control_ui, true);
 821
 822                         control_ui->label.set_alignment (0.5, 0.5);
 823                         control_ui->knobtable = manage (new Table());
 824                         control_ui->pack_start(*control_ui->knobtable, true, true);
 825
 826                         if (control_ui->combo) {
 827                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 828                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
 829                         } else if (control_ui->clickbox) {
 830                                 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
 831                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 832                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 833                         } else if (control_ui->spin_box) {
 834                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
 835                                 knob->set_tooltip_prefix (desc.label + ": ");
 836                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
 837                                 align->add (*control_ui->controller);
 838                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
 839                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
 840                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
 841                         } else if (desc.toggled) {
 842                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
 843                                 align->add (*control_ui->controller);
 844                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
 845                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 846                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 847                         } else {
 848                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
 849                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
 850                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
 851                         }
 852
 853                 } else {
 854
 855                         control_ui->pack_start (control_ui->label, true, true);
 856                         if (control_ui->combo) {
 857                                 control_ui->pack_start(*control_ui->combo, false, true);
 858                         } else if (control_ui->clickbox) {
 859                                 control_ui->pack_start (*control_ui->clickbox, false, false);
 860                         } else if (control_ui->spin_box) {
 861                                 control_ui->pack_start (*control_ui->spin_box, false, false);
 862                                 control_ui->pack_start (*control_ui->controller, false, false);
 863                         } else {
 864                                 control_ui->pack_start (*control_ui->controller, false, false);
 865                         }
 866                         control_ui->pack_start (control_ui->automate_button, false, false);
 867                 }
 868
 869
 870                 if (mcontrol->flags () & Controllable::NotAutomatable) {
 871                         control_ui->automate_button.set_sensitive (false);
 872                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
 873                 } else {
 874                         control_ui->automate_button.signal_button_press_event().connect (
 875                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
 876                                                     control_ui),
 877                                         false);
 878                         mcontrol->alist()->automation_state_changed.connect (
 879                                         control_connections,
 880                                         invalidator (*this),
 881                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
 882                                         gui_context());
 883                         input_controls_with_automation.push_back (control_ui);
 884                 }
 885
 886                 if (desc.toggled && !control_ui->combo) {
 887                         control_ui->button = true;
 888                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
 889                         assert (but);
 890                         but->set_name ("pluginui toggle");
 891                         update_control_display(control_ui);
 892                 }
 893
 894                 automation_state_changed (control_ui);
 895
 896                 /* Add to the list of CUIs that need manual update to workaround
 897                  * AutomationControl not knowing about preset loads */
 898                 input_controls.push_back (control_ui);
 899
 900         } else {
 901
 902                 control_ui->display = manage (new EventBox);
 903                 control_ui->display->set_name ("ParameterValueDisplay");
 904
 905                 control_ui->display_label = manage (new Label);
 906
 907                 control_ui->display_label->set_name ("ParameterValueDisplay");
 908
 909                 control_ui->display->add (*control_ui->display_label);
 910                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
 911
 912                 control_ui->display->show_all ();
 913
 914                 control_ui->vbox = manage (new VBox);
 915                 control_ui->vbox->set_spacing(3);
 916
 917                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
 918                         control_ui->vbox->pack_end (*control_ui->display, false, false);
 919                         control_ui->vbox->pack_end (control_ui->label, false, false);
 920                 } else if (desc.integer_step || desc.enumeration) {
 921                         control_ui->vbox->pack_end (*control_ui->display, false, false);
 922                         control_ui->vbox->pack_end (control_ui->label, false, false);
 923                 } else {
 924                         /* set up a meter for float ports */
 925
 926                         MeterInfo * info = new MeterInfo();
 927                         control_ui->meterinfo = info;
 928
 929                         info->meter = new FastMeter (
 930                                         5, 5, FastMeter::Vertical, 0,
 931                                         0x0000aaff,
 932                                         0x008800ff, 0x008800ff,
 933                                         0x00ff00ff, 0x00ff00ff,
 934                                         0xcccc00ff, 0xcccc00ff,
 935                                         0xffaa00ff, 0xffaa00ff,
 936                                         0xff0000ff,
 937                                         UIConfiguration::instance().color ("meter background bottom"),
 938                                         UIConfiguration::instance().color ("meter background top")
 939                                         );
 940
 941                         control_ui->label.set_angle(90);
 942
 943                         HBox* center =  manage (new HBox);
 944                         center->set_spacing(1);
 945                         center->pack_start (control_ui->label, false, false);
 946                         center->pack_start (*info->meter, false, false);
 947
 948                         control_ui->hbox = manage (new HBox);
 949                         control_ui->hbox->pack_start (*center, true, false);
 950
 951                         // horizontally center this hbox in the vbox
 952                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
 953
 954                         control_ui->meterinfo->meter->show_all();
 955                         control_ui->meterinfo->packed = true;
 956                         control_ui->vbox->pack_start (*control_ui->display, false, false);
 957                 }
 958
 959                 control_ui->pack_start (*control_ui->vbox);
 960
 961                 output_controls.push_back (control_ui);
 962         }
 963
 964         if (mcontrol) {
 965                 mcontrol->Changed.connect(control_connections, invalidator(*this),
 966                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
 967                                                       this, control_ui),
 968                                           gui_context());
 969         }
 970
 971         return control_ui;
 972 }
 973
 974 void
 975 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
 976         Gtk::Requisition astate_req (cui->automate_button.size_request());
 977         const int size = (int) (astate_req.height * 1.5);
 978         req->width = max(req->width, size);
 979         req->height = max(req->height, size);
 980 }
 981
 982
 983 bool
 984 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
 985 {
 986         if (ev->button != 1) {
 987                 return true;
 988         }
 989
 990         using namespace Menu_Helpers;
 991
 992         if (automation_menu == 0) {
 993                 automation_menu = manage (new Menu);
 994                 automation_menu->set_name ("ArdourContextMenu");
 995                 automation_menu->set_reserve_toggle_size(false);
 996         }
 997
 998         MenuList& items (automation_menu->items());
 999
1000         items.clear ();
1001         items.push_back (MenuElem (S_("Automation|Manual"),
1002                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1003         items.push_back (MenuElem (_("Play"),
1004                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1005         items.push_back (MenuElem (_("Write"),
1006                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1007         items.push_back (MenuElem (_("Touch"),
1008                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1009
1010         anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1011                             1, ev->time);
1012
1013         return true;
1014 }
1015
1016 void
1017 GenericPluginUI::set_all_automation (AutoState as)
1018 {
1019         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1020                 set_automation_state (as, (*i));
1021         }
1022 }
1023
1024 void
1025 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1026 {
1027         insert->set_parameter_automation_state (cui->parameter(), state);
1028 }
1029
1030 void
1031 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1032 {
1033         if (!cui->update_pending) {
1034                 cui->update_pending = true;
1035                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1036         }
1037 }
1038
1039 void
1040 GenericPluginUI::update_control_display (ControlUI* cui)
1041 {
1042         /* XXX how do we handle logarithmic stuff here ? */
1043
1044         cui->update_pending = false;
1045
1046         float val = cui->control->get_value();
1047
1048         PBD::Unwinder<bool> (cui->ignore_change, true);
1049
1050         if (cui->combo && cui->scale_points) {
1051                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1052                         if (it->second == val) {
1053                                 cui->combo->set_text(it->first);
1054                                 break;
1055                         }
1056                 }
1057         } else if (cui->button) {
1058                 // AutomationController handles this
1059         }
1060
1061         if( cui->controller ) {
1062             cui->controller->display_effective_value();
1063         }
1064
1065
1066         /*} else {
1067                 if (cui->logarithmic) {
1068                         val = log(val);
1069                 }
1070                 if (val != cui->adjustment->get_value()) {
1071                         cui->adjustment->set_value (val);
1072                 }
1073         }*/
1074 }
1075
1076 void
1077 GenericPluginUI::update_input_displays ()
1078 {
1079         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1080         for (vector<ControlUI*>::iterator i = input_controls.begin();
1081              i != input_controls.end();
1082              ++i) {
1083                 update_control_display(*i);
1084         }
1085         return;
1086 }
1087
1088 void
1089 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1090 {
1091         if (!cui->ignore_change) {
1092                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1093         }
1094 }
1095
1096 bool
1097 GenericPluginUI::start_updating (GdkEventAny*)
1098 {
1099         if (output_controls.size() > 0 ) {
1100                 screen_update_connection.disconnect();
1101                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1102         }
1103         return false;
1104 }
1105
1106 bool
1107 GenericPluginUI::stop_updating (GdkEventAny*)
1108 {
1109         if (output_controls.size() > 0 ) {
1110                 screen_update_connection.disconnect();
1111         }
1112         return false;
1113 }
1114
1115 void
1116 GenericPluginUI::output_update ()
1117 {
1118         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1119                 float val = plugin->get_parameter ((*i)->parameter().id());
1120                 char buf[32];
1121                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1122                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1123                 size_t len = str.copy(buf, 31);
1124                 buf[len] = '\0';
1125                 (*i)->display_label->set_text (buf);
1126
1127                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1128                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1129                 }
1130         }
1131 }
1132
1133 void
1134 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1135                                     Gtk::FileChooserButton*    widget)
1136 {
1137         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1138 }
1139
1140 void
1141 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1142 {
1143         FilePathControls::iterator c = _filepath_controls.find(key);
1144         if (c != _filepath_controls.end()) {
1145                 c->second->set_filename(value.get_path());
1146         } else {
1147                 std::cerr << "warning: property change for property with no control" << std::endl;
1148         }
1149 }