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 "evoral/midi_events.h"
  38 #include "evoral/PatchChange.hpp"
  39
  40 #include "midi++/midnam_patch.h"
  41
  42 #include "ardour/midi_patch_manager.h"
  43 #include "ardour/midi_track.h"
  44 #include "ardour/plugin.h"
  45 #include "ardour/plugin_insert.h"
  46 #include "ardour/session.h"
  47 #include "ardour/value_as_string.h"
  48
  49 #include "gtkmm2ext/menu_elems.h"
  50 #include "gtkmm2ext/utils.h"
  51 #include "gtkmm2ext/doi.h"
  52
  53 #include "widgets/ardour_knob.h"
  54 #include "widgets/click_box.h"
  55 #include "widgets/fastmeter.h"
  56 #include "widgets/slider_controller.h"
  57 #include "widgets/tooltips.h"
  58
  59 #include "plugin_ui.h"
  60 #include "plugin_display.h"
  61 #include "gui_thread.h"
  62 #include "automation_controller.h"
  63 #include "gain_meter.h"
  64 #include "timers.h"
  65 #include "ui_config.h"
  66
  67 #include "pbd/i18n.h"
  68
  69 using namespace std;
  70 using namespace ARDOUR;
  71 using namespace PBD;
  72 using namespace Gtkmm2ext;
  73 using namespace ArdourWidgets;
  74 using namespace Gtk;
  75 using namespace ARDOUR_UI_UTILS;
  76
  77 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
  78         : PlugUIBase (pi)
  79         , automation_menu (0)
  80         , is_scrollable(scrollable)
  81         , _plugin_pianokeyboard_expander (_("MIDI Keyboard"))
  82         , _piano (0)
  83         , _pianomm (0)
  84         , _piano_velocity (*manage (new Adjustment (100, 1, 127, 1, 16)))
  85         , _piano_channel (*manage (new Adjustment (0, 1, 16, 1, 1)))
  86 {
  87         set_name ("PluginEditor");
  88         set_border_width (10);
  89         //set_homogeneous (false);
  90
  91         pack_start (main_contents, true, true);
  92         settings_box.set_homogeneous (false);
  93
  94         HBox* constraint_hbox = manage (new HBox);
  95         HBox* smaller_hbox = manage (new HBox);
  96         smaller_hbox->set_spacing (4);
  97         Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
  98         combo_label->set_use_markup (true);
  99
 100         latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
 101         set_latency_label ();
 102
 103         smaller_hbox->pack_start (latency_button, false, false, 4);
 104         smaller_hbox->pack_start (pin_management_button, false, false, 4);
 105         smaller_hbox->pack_start (_preset_combo, false, false);
 106         smaller_hbox->pack_start (_preset_modified, false, false);
 107         smaller_hbox->pack_start (add_button, false, false);
 108         smaller_hbox->pack_start (save_button, false, false);
 109         smaller_hbox->pack_start (delete_button, false, false);
 110         if (pi->controls().size() > 0) {
 111                 smaller_hbox->pack_start (reset_button, false, false, 4);
 112         }
 113         smaller_hbox->pack_start (bypass_button, false, true, 4);
 114
 115         automation_manual_all_button.set_text(_("Manual"));
 116         automation_manual_all_button.set_name (X_("generic button"));
 117         automation_play_all_button.set_text(_("Play"));
 118         automation_play_all_button.set_name (X_("generic button"));
 119         automation_write_all_button.set_text(_("Write"));
 120         automation_write_all_button.set_name (X_("generic button"));
 121         automation_touch_all_button.set_text(_("Touch"));
 122         automation_touch_all_button.set_name (X_("generic button"));
 123         automation_latch_all_button.set_text(_("Touch"));
 124         automation_latch_all_button.set_name (X_("generic button"));
 125
 126         constraint_hbox->set_spacing (5);
 127         constraint_hbox->set_homogeneous (false);
 128
 129         VBox* v1_box = manage (new VBox);
 130         VBox* v2_box = manage (new VBox);
 131         if (pi->is_instrument ()) {
 132                 _piano = (PianoKeyboard*)piano_keyboard_new();
 133                 _pianomm = Glib::wrap((GtkWidget*)_piano);
 134                 _pianomm->set_flags(Gtk::CAN_FOCUS);
 135                 _pianomm->add_events(Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
 136
 137                 g_signal_connect (G_OBJECT (_piano), "note-on", G_CALLBACK (GenericPluginUI::_note_on_event_handler), this);
 138                 g_signal_connect (G_OBJECT (_piano), "note-off", G_CALLBACK (GenericPluginUI::_note_off_event_handler), this);
 139
 140                 HBox* box = manage (new HBox);
 141                 box->pack_start (*manage (new Label (_("Channel:"))), false, false);
 142                 box->pack_start (_piano_channel, false, false);
 143                 box->pack_start (*manage (new Label (_("Velocity:"))), false, false);
 144                 box->pack_start (_piano_velocity, false, false);
 145
 146                 Box* box2 = manage (new HBox ());
 147                 box2->pack_start (*box, true, false);
 148
 149                 _pianobox.set_spacing (4);
 150                 _pianobox.pack_start (*box2, true, true);
 151                 _pianobox.pack_start (*_pianomm, true, true);
 152
 153                 _plugin_pianokeyboard_expander.set_expanded(false);
 154                 _plugin_pianokeyboard_expander.property_expanded().signal_changed().connect( sigc::mem_fun(*this, &GenericPluginUI::toggle_pianokeyboard));
 155
 156                 pack_end (_plugin_pianokeyboard_expander, false, false);
 157         } else {
 158                 pack_end (plugin_analysis_expander, false, false);
 159         }
 160         if (!plugin->get_docs().empty()) {
 161                 pack_end (description_expander, false, false);
 162         }
 163
 164         v1_box->set_spacing (6);
 165         v1_box->pack_start (*smaller_hbox, false, true);
 166         if (pi->controls().size() > 0) {
 167                 HBox* automation_hbox = manage (new HBox);
 168                 automation_hbox->set_spacing (6);
 169                 Label* l = manage (new Label (_("All Automation")));
 170                 l->set_alignment (1.0, 0.5);
 171                 automation_hbox->pack_start (*l, true, true);
 172                 automation_hbox->pack_start (automation_manual_all_button, false, false);
 173                 automation_hbox->pack_start (automation_play_all_button, false, false);
 174                 automation_hbox->pack_start (automation_write_all_button, false, false);
 175                 automation_hbox->pack_start (automation_touch_all_button, false, false);
 176                 v1_box->pack_start (*automation_hbox, false, true);
 177         }
 178         v2_box->pack_start (focus_button, false, true);
 179
 180         main_contents.pack_start (settings_box, false, false);
 181
 182         constraint_hbox->pack_end (*v2_box, false, false);
 183         constraint_hbox->pack_end (*v1_box, false, false);
 184
 185         main_contents.pack_start (*constraint_hbox, false, false);
 186
 187         pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
 188
 189         bypass_button.set_active (!pi->enabled());
 190
 191         /* ScrolledWindow will wrap hpacker in a Viewport */
 192         scroller.add (hpacker);
 193         Viewport* view = static_cast<Viewport*>(scroller.get_child());
 194         view->set_shadow_type(Gtk::SHADOW_NONE);
 195
 196         main_contents.pack_start (scroller, true, true);
 197
 198         prefheight = 0;
 199         build ();
 200
 201         if (insert->plugin()->has_midnam() && insert->plugin()->knows_bank_patch()) {
 202                 build_midi_table ();
 203         }
 204
 205         if (is_scrollable) {
 206                 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 207                 scroller.set_name ("PluginEditor");
 208         } else {
 209                 scroller.signal_size_request().connect (sigc::mem_fun(*this, &GenericPluginUI::scroller_size_request));
 210                 scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
 211         }
 212
 213         main_contents.show ();
 214 }
 215
 216 GenericPluginUI::~GenericPluginUI ()
 217 {
 218         if (output_controls.size() > 0) {
 219                 screen_update_connection.disconnect();
 220         }
 221         delete _pianomm;
 222 }
 223
 224 void
 225 GenericPluginUI::scroller_size_request (Gtk::Requisition* a)
 226 {
 227         GtkRequisition request = hpacker.size_request();
 228
 229         Glib::RefPtr<Gdk::Window> window (get_window());
 230         Glib::RefPtr<Gdk::Screen> screen;
 231
 232         if (window) {
 233                 screen = get_screen();
 234         }
 235
 236         if (!screen) {
 237                 a->width = request.width;
 238                 return;
 239         }
 240
 241         Gdk::Rectangle monitor;
 242         const int monitor_num = screen->get_monitor_at_window (window);
 243         screen->get_monitor_geometry (
 244                         (monitor_num < 0) ? 0 : monitor_num,
 245                         monitor);
 246
 247         const int maximum_width = monitor.get_width() * 0.9;
 248
 249         if (request.width > maximum_width) {
 250                 for (vector<ControlUI*>::const_iterator cuip = input_controls.begin();
 251                                                         cuip != input_controls.end();
 252                                                         ++cuip) {
 253                         if (!(*cuip)->short_autostate)
 254                                 set_short_autostate(*cuip, true);
 255                 }
 256                 request = hpacker.size_request();
 257         }
 258
 259         a->width = min(request.width, maximum_width);
 260 }
 261
 262 // Some functions for calculating the 'similarity' of two plugin
 263 // control labels.
 264
 265 static int get_number(string label) {
 266 static const char *digits = "0123456789";
 267 int value = -1;
 268
 269         std::size_t first_digit_pos = label.find_first_of(digits);
 270         if (first_digit_pos != string::npos) {
 271                 // found some digits: there's a number in there somewhere
 272                 stringstream s;
 273                 s << label.substr(first_digit_pos);
 274                 s >> value;
 275         }
 276         return value;
 277 }
 278
 279 static int match_or_digit(char c1, char c2) {
 280         return c1 == c2 || (isdigit(c1) && isdigit(c2));
 281 }
 282
 283 static std::size_t matching_chars_at_head(const string s1, const string s2) {
 284 std::size_t length, n = 0;
 285
 286         length = min(s1.length(), s2.length());
 287         while (n < length) {
 288                 if (!match_or_digit(s1[n], s2[n]))
 289                         break;
 290                 n++;
 291         }
 292         return n;
 293 }
 294
 295 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
 296 std::size_t s1pos, s2pos, n = 0;
 297
 298         s1pos = s1.length();
 299         s2pos = s2.length();
 300         while (s1pos-- > 0 && s2pos-- > 0) {
 301                 if (!match_or_digit(s1[s1pos], s2[s2pos])       )
 302                         break;
 303                 n++;
 304         }
 305         return n;
 306 }
 307
 308 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
 309 static const float default_similarity_threshold = 0.3;
 310
 311 void
 312 GenericPluginUI::build ()
 313 {
 314         std::vector<ControlUI *> control_uis;
 315         bool grid = plugin->parameter_count() > 0;
 316
 317         // Build a ControlUI for each control port
 318         for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 319
 320                 if (plugin->parameter_is_control (i)) {
 321
 322                         /* Don't show latency control ports */
 323
 324                         const Evoral::Parameter param(PluginAutomation, 0, i);
 325                         if (plugin->describe_parameter (param) == X_("latency")) {
 326                                 continue;
 327                         }
 328
 329                         if (plugin->describe_parameter (param) == X_("hidden")) {
 330                                 continue;
 331                         }
 332
 333                         const float value = plugin->get_parameter(i);
 334
 335                         ControlUI* cui;
 336                         Plugin::UILayoutHint hint;
 337
 338                         if (!plugin->get_layout(i, hint)) {
 339                                 grid = false;
 340                         }
 341
 342                         boost::shared_ptr<ARDOUR::AutomationControl> c
 343                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 344                                         insert->control(param));
 345
 346                         ParameterDescriptor desc;
 347                         plugin->get_parameter_descriptor(i, desc);
 348                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
 349                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
 350                                 continue;
 351                         }
 352
 353                         if (grid) {
 354                                 cui->x0 = hint.x0;
 355                                 cui->x1 = hint.x1;
 356                                 cui->y0 = hint.y0;
 357                                 cui->y1 = hint.y1;
 358                         }
 359
 360                         const std::string param_docs = plugin->get_parameter_docs(i);
 361                         if (!param_docs.empty()) {
 362                                 set_tooltip(cui, param_docs.c_str());
 363                         }
 364
 365                         control_uis.push_back(cui);
 366                 }
 367         }
 368
 369         // Build a ControlUI for each property
 370         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
 371         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
 372                 const ParameterDescriptor& desc = d->second;
 373                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 374
 375                 boost::shared_ptr<ARDOUR::AutomationControl> c
 376                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 377                                 insert->control(param));
 378
 379                 if (!c) {
 380                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
 381                         continue;
 382                 }
 383
 384                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
 385                 if (!cui) {
 386                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
 387                                                 desc.key) << endmsg;
 388                         continue;
 389                 }
 390
 391                 control_uis.push_back(cui);
 392         }
 393         if (!descs.empty()) {
 394                 /* Listen for property changes that are not notified normally because
 395                  * AutomationControl has only support for numeric values currently.
 396                  * The only case is Variant::PATH for now */
 397                 plugin->PropertyChanged.connect(*this, invalidator(*this),
 398                                 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
 399                                 gui_context());
 400
 401                 /* and query current property value */
 402                 plugin->announce_property_values();
 403         }
 404
 405         if (grid) {
 406                 custom_layout (control_uis);
 407         } else {
 408                 automatic_layout (control_uis);
 409         }
 410
 411         output_update ();
 412
 413         automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
 414         automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
 415         automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
 416         automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 417         automation_latch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Latch));
 418
 419         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
 420         plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
 421 }
 422
 423
 424 void
 425 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
 426 {
 427         guint32 x = 0;
 428
 429         static const int32_t initial_button_rows = 12;
 430         static const int32_t initial_button_cols = 1;
 431         static const int32_t initial_output_rows = 1;
 432         static const int32_t initial_output_cols = 4;
 433
 434         Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
 435         Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
 436
 437         Frame* sample;
 438         Frame* bt_sample;
 439         VBox* box;
 440         int output_row, output_col;
 441         int button_row, button_col;
 442         int output_rows, output_cols;
 443         int button_rows, button_cols;
 444
 445         hpacker.set_spacing (10);
 446         hpacker.set_border_width (10);
 447
 448         output_rows = initial_output_rows;
 449         output_cols = initial_output_cols;
 450         button_rows = initial_button_rows;
 451         button_cols = initial_button_cols;
 452         output_row = 0;
 453         button_row = 0;
 454         output_col = 0;
 455         button_col = 0;
 456
 457         button_table->set_homogeneous (false);
 458         button_table->set_row_spacings (2);
 459         button_table->set_col_spacings (2);
 460         button_table->set_border_width (5);
 461
 462         output_table->set_homogeneous (true);
 463         output_table->set_row_spacings (2);
 464         output_table->set_col_spacings (2);
 465         output_table->set_border_width (5);
 466
 467
 468         bt_sample = manage (new Frame);
 469         bt_sample->set_name ("BaseFrame");
 470         bt_sample->set_label (_("Switches"));
 471         bt_sample->add (*button_table);
 472         hpacker.pack_start(*bt_sample, true, true);
 473
 474         box = manage (new VBox);
 475         box->set_border_width (5);
 476         box->set_spacing (1);
 477
 478         sample = manage (new Frame);
 479         sample->set_name ("BaseFrame");
 480         sample->set_label (_("Controls"));
 481         sample->add (*box);
 482         hpacker.pack_start(*sample, true, true);
 483
 484         // Add special controls to UI, and build list of normal controls to be layed out later
 485         std::vector<ControlUI *> cui_controls_list;
 486         for (size_t i = 0; i < control_uis.size(); ++i) {
 487                 ControlUI* cui = control_uis[i];
 488
 489                 if (cui->button || cui->file_button) {
 490
 491                         if (!is_scrollable && button_row == button_rows) {
 492                                 button_row = 0;
 493                                 if (++button_col == button_cols) {
 494                                         button_cols += 2;
 495                                         button_table->resize (button_rows, button_cols);
 496                                 }
 497                         }
 498
 499                         button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
 500                                              FILL|EXPAND, FILL);
 501                         button_row++;
 502
 503                 } else if (cui->controller || cui->clickbox || cui->combo) {
 504                         // Get all of the controls into a list, so that
 505                         // we can lay them out a bit more nicely later.
 506                         cui_controls_list.push_back(cui);
 507
 508                 } else if (cui->display) {
 509
 510                         output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
 511                                              FILL|EXPAND, FILL);
 512
 513                         // TODO: The meters should be divided into multiple rows
 514
 515                         if (++output_col == output_cols) {
 516                                 output_cols ++;
 517                                 output_table->resize (output_rows, output_cols);
 518                         }
 519                 }
 520         }
 521
 522         // Iterate over the list of controls to find which adjacent controls
 523         // are similar enough to be grouped together.
 524
 525         string label, previous_label = "";
 526         std::vector<int> numbers_in_labels(cui_controls_list.size());
 527
 528         std::vector<float> similarity_scores(cui_controls_list.size());
 529         float most_similar = 0.0, least_similar = 1.0;
 530
 531         size_t i = 0;
 532         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 533                 label = (*cuip)->label.get_text();
 534                 numbers_in_labels[i] = get_number(label);
 535
 536                 if (i > 0) {
 537                         // A hand-wavy calculation of how similar this control's
 538                         // label is to the previous.
 539                         similarity_scores[i] =
 540                                 (float) (
 541                                         ( matching_chars_at_head(label, previous_label) +
 542                                           matching_chars_at_tail(label, previous_label) +
 543                                           1
 544                                         )
 545                                 ) / (label.length() + previous_label.length());
 546                         if (numbers_in_labels[i] >= 0) {
 547                                 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
 548                         }
 549                         least_similar = min(least_similar, similarity_scores[i]);
 550                         most_similar  = max(most_similar, similarity_scores[i]);
 551                 } else {
 552                         similarity_scores[0] = 1.0;
 553                 }
 554
 555                 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
 556                 previous_label = label;
 557         }
 558
 559
 560         // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
 561         float similarity_threshold;
 562
 563         if (most_similar > 1.0) {
 564                 similarity_threshold = default_similarity_threshold;
 565         } else {
 566                 similarity_threshold = most_similar - (1 - default_similarity_threshold);
 567         }
 568
 569         // Now iterate over the list of controls to display them, placing an
 570         // HSeparator between controls of less than a certain similarity, and
 571         // starting a new column when necessary.
 572
 573         i = 0;
 574         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 575
 576                 ControlUI* cui = *cuip;
 577
 578                 if (!is_scrollable) {
 579                         x++;
 580                 }
 581
 582                 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
 583                         if (x > min_controls_per_column) {
 584                                 sample = manage (new Frame);
 585                                 sample->set_name ("BaseFrame");
 586                                 sample->set_label (_("Controls"));
 587                                 box = manage (new VBox);
 588                                 box->set_border_width (5);
 589                                 box->set_spacing (1);
 590                                 sample->add (*box);
 591                                 hpacker.pack_start(*sample, true, true);
 592                                 x = 0;
 593                         } else {
 594                                 HSeparator *split = new HSeparator();
 595                                 split->set_size_request(-1, 5);
 596                                 box->pack_start(*split, false, false, 0);
 597                         }
 598
 599                 }
 600                 box->pack_start (*cui, false, false);
 601         }
 602
 603         if (is_scrollable) {
 604                 prefheight = 30 * i;
 605         }
 606
 607         if (box->children().empty()) {
 608                 hpacker.remove (*sample);
 609         }
 610
 611         if (button_table->children().empty()) {
 612                 hpacker.remove (*bt_sample);
 613                 delete button_table;
 614         } else {
 615                 button_table->show_all ();
 616         }
 617
 618         if (!output_table->children().empty()) {
 619                 sample = manage (new Frame);
 620                 sample->set_name ("BaseFrame");
 621                 sample->set_label(_("Meters"));
 622                 sample->add (*output_table);
 623                 hpacker.pack_end (*sample, true, true);
 624                 output_table->show_all ();
 625         } else {
 626                 delete output_table;
 627         }
 628
 629         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 630                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 631                 hpacker.pack_end (*pd, true, true);
 632         }
 633         show_all();
 634
 635 }
 636
 637 void
 638 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
 639 {
 640         Gtk::Table* layout = manage (new Gtk::Table ());
 641
 642         for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
 643                 ControlUI* cui = *i;
 644                 if (cui->x0 < 0 || cui->y0 < 0) {
 645                         continue;
 646                 }
 647                 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
 648         }
 649         hpacker.pack_start (*layout, true, true);
 650
 651         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 652                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 653                 hpacker.pack_end (*pd, true, true);
 654         }
 655 }
 656
 657 void
 658 GenericPluginUI::build_midi_table ()
 659 {
 660         Gtk::Table* pgm_table = manage (new Gtk::Table (8, 5));
 661
 662         pgm_table->set_homogeneous (false);
 663         pgm_table->set_row_spacings (2);
 664         pgm_table->set_col_spacings (2);
 665         pgm_table->set_border_width (5);
 666         pgm_table->set_col_spacing (2, 10);
 667
 668         Frame* sample = manage (new Frame);
 669         sample->set_name ("BaseFrame");
 670         if (dynamic_cast<MidiTrack*> (insert->owner())) {
 671                 sample->set_label (_("MIDI Progams (sent to track)"));
 672         } else {
 673                 sample->set_label (_("MIDI Progams (volatile)"));
 674         }
 675         sample->add (*pgm_table);
 676         hpacker.pack_start (*sample, false, false);
 677
 678         for (uint8_t chn = 0; chn < 16; ++chn) {
 679                 int col = 3 * (chn / 8);
 680                 int row = chn % 8;
 681                 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
 682                 cui->set_sizing_text ("Stereo Grand Piano");
 683                 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
 684                 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
 685                 midi_pgmsel.push_back (cui);
 686                 pgm_table->attach (*manage (new Label (string_compose ("C%1:", (int)(chn + 1)), ALIGN_RIGHT)), col, col + 1, row, row+1, FILL, SHRINK);
 687                 pgm_table->attach (*cui, col + 1, col + 2, row, row+1, SHRINK, SHRINK);
 688         }
 689
 690         insert->plugin ()->read_midnam();
 691
 692         midi_refill_patches ();
 693
 694         insert->plugin()->BankPatchChange.connect (
 695                         midi_connections, invalidator (*this),
 696                         boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
 697                         gui_context());
 698
 699         insert->plugin()->UpdatedMidnam.connect (
 700                         midi_connections, invalidator (*this),
 701                         boost::bind (&GenericPluginUI::midi_refill_patches, this),
 702                         gui_context());
 703 }
 704
 705 void
 706 GenericPluginUI::midi_refill_patches ()
 707 {
 708         assert (midi_pgmsel.size() == 16);
 709
 710         pgm_names.clear ();
 711
 712         const std::string model = insert->plugin ()->midnam_model ();
 713         std::string mode;
 714         const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
 715         if (device_modes.size() > 0) {
 716                 mode = device_modes.front();
 717         }
 718
 719         for (uint8_t chn = 0; chn < 16; ++chn) {
 720                 midi_pgmsel[chn]->clear_items ();
 721                 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
 722                         MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
 723
 724                 if (cns) {
 725                         using namespace Menu_Helpers;
 726                         using namespace Gtkmm2ext;
 727
 728                         for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
 729                                 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
 730                                 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
 731                                         const std::string pgm = (*j)->name ();
 732                                         MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
 733                                         assert ((*i)->number () == key.bank());
 734                                         const uint32_t bp = (key.bank() << 7) | key.program();
 735                                         midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
 736                                         pgm_names[bp] = pgm;
 737                                 }
 738                         }
 739                 }
 740
 741                 midi_bank_patch_change (chn);
 742         }
 743 }
 744
 745 void
 746 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
 747 {
 748         assert (chn < 16 && midi_pgmsel.size() == 16);
 749         uint32_t bankpgm = insert->plugin()->bank_patch (chn);
 750         if (bankpgm == UINT32_MAX) {
 751                 midi_pgmsel[chn]->set_text (_("--Unset--"));
 752         } else {
 753                 int bank = bankpgm >> 7;
 754                 int pgm = bankpgm & 127;
 755                 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
 756                         midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
 757                 } else {
 758                         midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
 759                                                 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
 760                 }
 761         }
 762 }
 763
 764 void
 765 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
 766 {
 767         int bank = bankpgm >> 7;
 768         int pgm = bankpgm & 127;
 769         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
 770         if (mt) {
 771                 /* send to track */
 772                 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
 773                 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
 774                 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
 775
 776                 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
 777                 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
 778                 program->set_value (pgm, PBD::Controllable::NoGroup);
 779         } else {
 780                 uint8_t event[3];
 781                 event[0] = (MIDI_CMD_CONTROL | chn);
 782                 event[1] = 0x00;
 783                 event[2] = bank >> 7;
 784                 insert->write_immediate_event (3, event);
 785
 786                 event[1] = 0x20;
 787                 event[2] = bank & 127;
 788                 insert->write_immediate_event (3, event);
 789
 790                 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
 791                 event[1] = pgm;
 792                 insert->write_immediate_event (2, event);
 793         }
 794 }
 795
 796 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 797         : param(p)
 798         , automate_button (X_("")) // force creation of a label
 799         , combo (0)
 800         , clickbox (0)
 801         , file_button (0)
 802         , spin_box (0)
 803         , display (0)
 804         , hbox (0)
 805         , vbox (0)
 806         , meterinfo (0)
 807         , knobtable (0)
 808 {
 809         automate_button.set_name ("plugin automation state button");
 810         set_tooltip (automate_button, _("Automation control"));
 811
 812         ignore_change = false;
 813         update_pending = false;
 814         button = false;
 815
 816         x0 = x1 = y0 = y1 = -1;
 817 }
 818
 819 GenericPluginUI::ControlUI::~ControlUI()
 820 {
 821         if (meterinfo) {
 822                 delete meterinfo->meter;
 823                 delete meterinfo;
 824         }
 825 }
 826
 827 void
 828 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
 829 {
 830         cui->short_autostate = value;
 831         if (value) {
 832                 cui->automate_button.set_sizing_text("M");
 833         } else {
 834                 /* XXX translators: use a string here that will be at least as long
 835                    as the longest automation label (see ::automation_state_changed()
 836                    below). be sure to include a descender. */
 837                 cui->automate_button.set_sizing_text(_("Mgnual"));
 838         }
 839         automation_state_changed(cui);
 840 }
 841
 842 void
 843 GenericPluginUI::automation_state_changed (ControlUI* cui)
 844 {
 845         /* update button label */
 846
 847         // don't lock to avoid deadlock because we're triggered by
 848         // AutomationControl::Changed() while the automation lock is taken
 849
 850         AutoState state = insert->get_parameter_automation_state (cui->parameter());
 851
 852         cui->automate_button.set_active((state != ARDOUR::Off));
 853
 854         if (cui->short_autostate) {
 855                 cui->automate_button.set_text (
 856                                 GainMeterBase::astate_string (state));
 857                 return;
 858         }
 859
 860         switch (state & (ARDOUR::Off|Play|Touch|Write|Latch)) {
 861         case ARDOUR::Off:
 862                 cui->automate_button.set_text (S_("Automation|Manual"));
 863                 break;
 864         case Play:
 865                 cui->automate_button.set_text (_("Play"));
 866                 break;
 867         case Write:
 868                 cui->automate_button.set_text (_("Write"));
 869                 break;
 870         case Touch:
 871                 cui->automate_button.set_text (_("Touch"));
 872                 break;
 873         case Latch:
 874                 cui->automate_button.set_text (_("Latch"));
 875                 break;
 876         default:
 877                 cui->automate_button.set_text (_("???"));
 878                 break;
 879         }
 880 }
 881
 882 bool
 883 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 884 {
 885         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 886         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 887         const size_t       len = str.copy(buf, 31);
 888         buf[len] = '\0';
 889         return true;
 890 }
 891
 892 bool
 893 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 894 {
 895         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 896         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 897         const size_t       len = str.copy(buf, 31);
 898         buf[len] = '\0';
 899         return true;
 900 }
 901
 902 void
 903 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
 904 {
 905         plugin->print_parameter (param, buf, len);
 906 }
 907
 908 /** Build a ControlUI for a parameter/property.
 909  * Note that mcontrol may be NULL for outputs.
 910  */
 911 GenericPluginUI::ControlUI*
 912 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 913                                    const ParameterDescriptor&           desc,
 914                                    boost::shared_ptr<AutomationControl> mcontrol,
 915                                    float                                value,
 916                                    bool                                 is_input,
 917                                    bool                                 use_knob)
 918 {
 919         ControlUI* control_ui = 0;
 920
 921         control_ui = manage (new ControlUI (param));
 922         control_ui->combo = 0;
 923         control_ui->control = mcontrol;
 924         control_ui->label.set_text (desc.label);
 925         control_ui->label.set_alignment (0.0, 0.5);
 926         control_ui->label.set_name ("PluginParameterLabel");
 927         control_ui->set_spacing (5);
 928         set_short_autostate(control_ui, false);
 929
 930         if (is_input) {
 931
 932                 if (desc.datatype == Variant::PATH) {
 933
 934                         /* We shouldn't get that type for input ports */
 935                         assert(param.type() == PluginPropertyAutomation);
 936
 937                         /* Build a file selector button */
 938
 939                         // Create/add controller
 940                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 941                         control_ui->file_button->set_title(desc.label);
 942
 943                         if (use_knob) {
 944                                 control_ui->knobtable = manage (new Table());
 945                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 946                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 947                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 948                         } else {
 949                                 control_ui->pack_start (control_ui->label, false, true);
 950                                 control_ui->pack_start (*control_ui->file_button, true, true);
 951                         }
 952
 953                         // Monitor changes from the user.
 954                         control_ui->file_button->signal_file_set().connect(
 955                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 956                                            desc, control_ui->file_button));
 957
 958                         /* Add the filebutton control to a map so that we can update it when
 959                          * the corresponding property changes. This doesn't go through the usual
 960                          * AutomationControls, because they don't support non-numeric values. */
 961                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 962
 963                         return control_ui;
 964                 }
 965
 966                 assert(mcontrol);
 967
 968                 /* See if there any named values for our input value */
 969                 control_ui->scale_points = desc.scale_points;
 970
 971                 /* If this parameter is an integer, work out the number of distinct values
 972                    it can take on (assuming that lower and upper values are allowed).
 973                 */
 974                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 975
 976                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 977
 978                         /* Either:
 979                          *   a) There is a label for each possible value of this input, or
 980                          *   b) This port is marked as being an enumeration.
 981                          */
 982
 983                         control_ui->combo = new ArdourDropdown();
 984                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 985                              i != control_ui->scale_points->end();
 986                              ++i) {
 987                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 988                                                 i->first,
 989                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 990                                                            control_ui,
 991                                                            i->second)));
 992                         }
 993
 994                         control_ui->combo->set_controllable (mcontrol);
 995
 996                         update_control_display(control_ui);
 997
 998                 } else {
 999
1000                         /* create the controller */
1001
1002                         /* XXX memory leak: SliderController not destroyed by ControlUI
1003                          * destructor, and manage() reports object hierarchy
1004                          * ambiguity.
1005                          */
1006                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
1007
1008                         /* Control UI's don't need the rapid timer workaround */
1009                         control_ui->controller->stop_updating ();
1010
1011                         /* XXX this code is not right yet, because it doesn't handle
1012                            the absence of bounds in any sensible fashion.
1013                         */
1014
1015                         Adjustment* adj = control_ui->controller->adjustment();
1016
1017                         if (false /* desc.integer_step && !desc.toggled */) {
1018                                 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
1019                                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
1020                                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1021                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
1022                                 } else {
1023                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
1024                                 }
1025                                 control_ui->clickbox->set_controllable (mcontrol);
1026                         } else if (desc.toggled) {
1027                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1028                                 assert(but);
1029                                 but->set_tweaks(ArdourButton::Square);
1030                         } else if (use_knob) {
1031                                 /* Delay size request so that styles are gotten right */
1032                                 control_ui->controller->widget()->signal_size_request().connect(
1033                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1034                         } else {
1035                                 control_ui->controller->set_size_request (200, -1);
1036                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1037                                 if (desc.integer_step) {
1038                                         AutomationBarController* abc = dynamic_cast <AutomationBarController*> (control_ui->controller->widget ());
1039                                         assert (abc);
1040                                         abc->set_digits (0);
1041                                 }
1042                         }
1043
1044                         if (!desc.integer_step && !desc.toggled && use_knob) {
1045                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1046                         }
1047
1048                         adj->set_value (mcontrol->internal_to_interface(value));
1049
1050                 }
1051
1052                 if (use_knob) {
1053                         set_short_autostate(control_ui, true);
1054
1055                         control_ui->label.set_alignment (0.5, 0.5);
1056                         control_ui->knobtable = manage (new Table());
1057                         control_ui->pack_start(*control_ui->knobtable, true, true);
1058
1059                         if (control_ui->combo) {
1060                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1061                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1062                         } else if (control_ui->clickbox) {
1063                                 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
1064                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1065                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1066                         } else if (control_ui->spin_box) {
1067                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1068                                 knob->set_tooltip_prefix (desc.label + ": ");
1069                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1070                                 align->add (*control_ui->controller);
1071                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1072                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1073                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1074                         } else if (desc.toggled) {
1075                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1076                                 align->add (*control_ui->controller);
1077                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1078                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1079                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1080                         } else {
1081                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1082                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1083                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1084                         }
1085
1086                 } else {
1087
1088                         control_ui->pack_start (control_ui->label, true, true);
1089                         if (control_ui->combo) {
1090                                 control_ui->pack_start(*control_ui->combo, false, true);
1091                         } else if (control_ui->clickbox) {
1092                                 control_ui->pack_start (*control_ui->clickbox, false, false);
1093                         } else if (control_ui->spin_box) {
1094                                 control_ui->pack_start (*control_ui->spin_box, false, false);
1095                                 control_ui->pack_start (*control_ui->controller, false, false);
1096                         } else {
1097                                 control_ui->pack_start (*control_ui->controller, false, false);
1098                         }
1099                         control_ui->pack_start (control_ui->automate_button, false, false);
1100                 }
1101
1102
1103                 if (mcontrol->flags () & Controllable::NotAutomatable) {
1104                         control_ui->automate_button.set_sensitive (false);
1105                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1106                 } else {
1107                         control_ui->automate_button.signal_button_press_event().connect (
1108                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1109                                                     control_ui),
1110                                         false);
1111                         mcontrol->alist()->automation_state_changed.connect (
1112                                         control_connections,
1113                                         invalidator (*this),
1114                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1115                                         gui_context());
1116                         input_controls_with_automation.push_back (control_ui);
1117                 }
1118
1119                 if (desc.toggled && !control_ui->combo) {
1120                         control_ui->button = true;
1121                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1122                         assert (but);
1123                         but->set_name ("pluginui toggle");
1124                         update_control_display(control_ui);
1125                 }
1126
1127                 automation_state_changed (control_ui);
1128
1129                 /* Add to the list of CUIs that need manual update to workaround
1130                  * AutomationControl not knowing about preset loads */
1131                 input_controls.push_back (control_ui);
1132
1133         } else {
1134
1135                 control_ui->display = manage (new EventBox);
1136                 control_ui->display->set_name ("ParameterValueDisplay");
1137
1138                 control_ui->display_label = manage (new Label);
1139
1140                 control_ui->display_label->set_name ("ParameterValueDisplay");
1141
1142                 control_ui->display->add (*control_ui->display_label);
1143                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1144
1145                 control_ui->display->show_all ();
1146
1147                 control_ui->vbox = manage (new VBox);
1148                 control_ui->vbox->set_spacing(3);
1149
1150                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1151                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1152                         control_ui->vbox->pack_end (control_ui->label, false, false);
1153                 } else if (desc.integer_step || desc.enumeration) {
1154                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1155                         control_ui->vbox->pack_end (control_ui->label, false, false);
1156                 } else {
1157                         /* set up a meter for float ports */
1158
1159                         MeterInfo * info = new MeterInfo();
1160                         control_ui->meterinfo = info;
1161
1162                         info->meter = new FastMeter (
1163                                         5, 5, FastMeter::Vertical, 0,
1164                                         0x0000aaff,
1165                                         0x008800ff, 0x008800ff,
1166                                         0x00ff00ff, 0x00ff00ff,
1167                                         0xcccc00ff, 0xcccc00ff,
1168                                         0xffaa00ff, 0xffaa00ff,
1169                                         0xff0000ff,
1170                                         UIConfiguration::instance().color ("meter background bottom"),
1171                                         UIConfiguration::instance().color ("meter background top")
1172                                         );
1173
1174                         control_ui->label.set_angle(90);
1175
1176                         HBox* center =  manage (new HBox);
1177                         center->set_spacing(1);
1178                         center->pack_start (control_ui->label, false, false);
1179                         center->pack_start (*info->meter, false, false);
1180
1181                         control_ui->hbox = manage (new HBox);
1182                         control_ui->hbox->pack_start (*center, true, false);
1183
1184                         // horizontally center this hbox in the vbox
1185                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1186
1187                         control_ui->meterinfo->meter->show_all();
1188                         control_ui->meterinfo->packed = true;
1189                         control_ui->vbox->pack_start (*control_ui->display, false, false);
1190                 }
1191
1192                 control_ui->pack_start (*control_ui->vbox);
1193
1194                 output_controls.push_back (control_ui);
1195         }
1196
1197         if (mcontrol) {
1198                 mcontrol->Changed.connect(control_connections, invalidator(*this),
1199                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
1200                                                       this, control_ui),
1201                                           gui_context());
1202         }
1203
1204         return control_ui;
1205 }
1206
1207 void
1208 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1209         Gtk::Requisition astate_req (cui->automate_button.size_request());
1210         const int size = (int) (astate_req.height * 1.5);
1211         req->width = max(req->width, size);
1212         req->height = max(req->height, size);
1213 }
1214
1215
1216 bool
1217 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1218 {
1219         if (ev->button != 1) {
1220                 return true;
1221         }
1222
1223         using namespace Menu_Helpers;
1224
1225         if (automation_menu == 0) {
1226                 automation_menu = manage (new Menu);
1227                 automation_menu->set_name ("ArdourContextMenu");
1228                 automation_menu->set_reserve_toggle_size(false);
1229         }
1230
1231         MenuList& items (automation_menu->items());
1232
1233         items.clear ();
1234         items.push_back (MenuElem (S_("Automation|Manual"),
1235                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1236         items.push_back (MenuElem (_("Play"),
1237                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1238         items.push_back (MenuElem (_("Write"),
1239                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1240         items.push_back (MenuElem (_("Touch"),
1241                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1242         items.push_back (MenuElem (_("Latch"),
1243                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Latch, cui)));
1244
1245         anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1246                             1, ev->time);
1247
1248         return true;
1249 }
1250
1251 void
1252 GenericPluginUI::set_all_automation (AutoState as)
1253 {
1254         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1255                 set_automation_state (as, (*i));
1256         }
1257 }
1258
1259 void
1260 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1261 {
1262         insert->set_parameter_automation_state (cui->parameter(), state);
1263 }
1264
1265 void
1266 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1267 {
1268         if (!cui->update_pending) {
1269                 cui->update_pending = true;
1270                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1271         }
1272 }
1273
1274 void
1275 GenericPluginUI::update_control_display (ControlUI* cui)
1276 {
1277         /* XXX how do we handle logarithmic stuff here ? */
1278
1279         cui->update_pending = false;
1280
1281         float val = cui->control->get_value();
1282
1283         PBD::Unwinder<bool> (cui->ignore_change, true);
1284
1285         if (cui->combo && cui->scale_points) {
1286                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1287                         if (it->second == val) {
1288                                 cui->combo->set_text(it->first);
1289                                 break;
1290                         }
1291                 }
1292         } else if (cui->button) {
1293                 // AutomationController handles this
1294         }
1295
1296         if( cui->controller ) {
1297             cui->controller->display_effective_value();
1298         }
1299
1300
1301         /*} else {
1302                 if (cui->logarithmic) {
1303                         val = log(val);
1304                 }
1305                 if (val != cui->adjustment->get_value()) {
1306                         cui->adjustment->set_value (val);
1307                 }
1308         }*/
1309 }
1310
1311 void
1312 GenericPluginUI::update_input_displays ()
1313 {
1314         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1315         for (vector<ControlUI*>::iterator i = input_controls.begin();
1316              i != input_controls.end();
1317              ++i) {
1318                 update_control_display(*i);
1319         }
1320         return;
1321 }
1322
1323 void
1324 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1325 {
1326         if (!cui->ignore_change) {
1327                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1328         }
1329 }
1330
1331 bool
1332 GenericPluginUI::start_updating (GdkEventAny*)
1333 {
1334         if (output_controls.size() > 0 ) {
1335                 screen_update_connection.disconnect();
1336                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1337         }
1338         return false;
1339 }
1340
1341 bool
1342 GenericPluginUI::stop_updating (GdkEventAny*)
1343 {
1344         if (output_controls.size() > 0 ) {
1345                 screen_update_connection.disconnect();
1346         }
1347         return false;
1348 }
1349
1350 void
1351 GenericPluginUI::output_update ()
1352 {
1353         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1354                 float val = plugin->get_parameter ((*i)->parameter().id());
1355                 char buf[32];
1356                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1357                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1358                 size_t len = str.copy(buf, 31);
1359                 buf[len] = '\0';
1360                 (*i)->display_label->set_text (buf);
1361
1362                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1363                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1364                 }
1365         }
1366 }
1367
1368 void
1369 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1370                                     Gtk::FileChooserButton*    widget)
1371 {
1372         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1373 }
1374
1375 void
1376 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1377 {
1378         FilePathControls::iterator c = _filepath_controls.find(key);
1379         if (c != _filepath_controls.end()) {
1380                 c->second->set_filename(value.get_path());
1381         } else {
1382                 std::cerr << "warning: property change for property with no control" << std::endl;
1383         }
1384 }
1385
1386 void
1387 GenericPluginUI::toggle_pianokeyboard ()
1388 {
1389         if (_plugin_pianokeyboard_expander.get_expanded()) {
1390                 _plugin_pianokeyboard_expander.add (_pianobox);
1391                 _pianobox.show_all ();
1392         } else {
1393                 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1394                 _plugin_pianokeyboard_expander.get_child ()->hide ();
1395                 _plugin_pianokeyboard_expander.remove ();
1396
1397                 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1398                 if (toplevel) {
1399                         Gtk::Requisition wr;
1400                         toplevel->get_size (wr.width, wr.height);
1401                         wr.height -= child_height;
1402                         toplevel->resize (wr.width, wr.height);
1403                 }
1404         }
1405 }
1406
1407 void
1408 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1409 {
1410         ((GenericPluginUI*)arg)->note_on_event_handler(note);
1411 }
1412
1413 void
1414 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1415 {
1416         ((GenericPluginUI*)arg)->note_off_event_handler(note);
1417 }
1418
1419 void
1420 GenericPluginUI::note_on_event_handler (int note)
1421 {
1422         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1423         _pianomm->grab_focus ();
1424         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1425         uint8_t event[3];
1426         event[0] = (MIDI_CMD_NOTE_ON | channel);
1427         event[1] = note;
1428         event[2] = _piano_velocity.get_value_as_int ();
1429         if (mt) {
1430                 mt->write_immediate_event (3, event);
1431         } else {
1432                 insert->write_immediate_event (3, event);
1433         }
1434 }
1435
1436 void
1437 GenericPluginUI::note_off_event_handler (int note)
1438 {
1439         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1440         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1441         uint8_t event[3];
1442         event[0] = (MIDI_CMD_NOTE_OFF | channel);
1443         event[1] = note;
1444         event[2] = 0;
1445         if (mt) {
1446                 mt->write_immediate_event (3, event);
1447         } else {
1448                 insert->write_immediate_event (3, event);
1449         }
1450 }