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