gtk2_ardour/generic_pluginui.cc

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