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.h"
  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         , _piano_velocity (*manage (new Adjustment (100, 1, 127, 1, 16)))
  92         , _piano_channel (*manage (new Adjustment (0, 1, 16, 1, 1)))
  93 {
  94         set_name ("PluginEditor");
  95         set_border_width (10);
  96         //set_homogeneous (false);
  97
  98         pack_start (main_contents, true, true);
  99         settings_box.set_homogeneous (false);
 100
 101         HBox* constraint_hbox = manage (new HBox);
 102         HBox* smaller_hbox = manage (new HBox);
 103         smaller_hbox->set_spacing (4);
 104         Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
 105         combo_label->set_use_markup (true);
 106
 107         latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
 108         set_latency_label ();
 109
 110         smaller_hbox->pack_start (latency_button, false, false, 4);
 111         smaller_hbox->pack_start (pin_management_button, false, false, 4);
 112         smaller_hbox->pack_start (_preset_modified, false, false);
 113         smaller_hbox->pack_start (_preset_combo, false, false);
 114         smaller_hbox->pack_start (add_button, false, false);
 115         smaller_hbox->pack_start (save_button, false, false);
 116         smaller_hbox->pack_start (delete_button, false, false);
 117         if (pi->controls().size() > 0 && has_descriptive_presets ()) {
 118                 smaller_hbox->pack_start (preset_browser_button, false, false);
 119         }
 120         if (pi->controls().size() > 0) {
 121                 smaller_hbox->pack_start (reset_button, false, false, 4);
 122         }
 123         smaller_hbox->pack_start (bypass_button, false, true, 4);
 124
 125         automation_manual_all_button.set_text (GainMeterBase::astate_string (ARDOUR::Off));
 126         automation_manual_all_button.set_name (X_("generic button"));
 127         automation_play_all_button.set_text (GainMeterBase::astate_string (ARDOUR::Play));
 128         automation_play_all_button.set_name (X_("generic button"));
 129         automation_write_all_button.set_text (GainMeterBase::astate_string (ARDOUR::Write));
 130         automation_write_all_button.set_name (X_("generic button"));
 131         automation_touch_all_button.set_text (GainMeterBase::astate_string (ARDOUR::Touch));
 132         automation_touch_all_button.set_name (X_("generic button"));
 133         automation_latch_all_button.set_text (GainMeterBase::astate_string (ARDOUR::Latch));
 134         automation_latch_all_button.set_name (X_("generic button"));
 135
 136         constraint_hbox->set_spacing (5);
 137         constraint_hbox->set_homogeneous (false);
 138
 139         VBox* v1_box = manage (new VBox);
 140         VBox* v2_box = manage (new VBox);
 141         if (pi->is_instrument ()) {
 142                 _piano = new APianoKeyboard ();
 143                 _piano->set_flags(Gtk::CAN_FOCUS);
 144
 145                 _piano->NoteOn.connect (sigc::mem_fun (*this, &GenericPluginUI::note_on_event_handler));
 146                 _piano->NoteOff.connect (sigc::mem_fun (*this, &GenericPluginUI::note_off_event_handler));
 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 (*_piano, 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 _piano;
 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                 if (has_descriptive_presets ()) {
 428                         preset_gui = new PluginPresetsUI (insert);
 429                         hpacker.pack_start (*preset_gui, true, true);
 430                 }
 431         } else if (grid) {
 432                 custom_layout (control_uis);
 433         } else {
 434                 automatic_layout (control_uis);
 435         }
 436
 437         output_update ();
 438
 439         automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
 440         automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
 441         automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
 442         automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 443         automation_latch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Latch));
 444
 445         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
 446         plugin->PresetLoaded.connect (*this, invalidator (*this), boost::bind (&GenericPluginUI::update_input_displays, this), gui_context ());
 447 }
 448
 449
 450 void
 451 GenericPluginUI::automatic_layout (const std::vector<ControlUI*>& control_uis)
 452 {
 453         guint32 x = 0;
 454
 455         static const int32_t initial_button_rows = 12;
 456         static const int32_t initial_button_cols = 1;
 457         static const int32_t initial_output_rows = 1;
 458         static const int32_t initial_output_cols = 4;
 459
 460         Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
 461         Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
 462
 463         Frame* frame;
 464         Frame* bt_frame;
 465         VBox* box;
 466         int output_row, output_col;
 467         int button_row, button_col;
 468         int output_rows, output_cols;
 469         int button_rows, button_cols;
 470
 471         hpacker.set_spacing (10);
 472         hpacker.set_border_width (10);
 473
 474         output_rows = initial_output_rows;
 475         output_cols = initial_output_cols;
 476         button_rows = initial_button_rows;
 477         button_cols = initial_button_cols;
 478         output_row = 0;
 479         button_row = 0;
 480         output_col = 0;
 481         button_col = 0;
 482
 483         button_table->set_homogeneous (false);
 484         button_table->set_row_spacings (2);
 485         button_table->set_col_spacings (2);
 486         button_table->set_border_width (5);
 487
 488         output_table->set_homogeneous (true);
 489         output_table->set_row_spacings (2);
 490         output_table->set_col_spacings (2);
 491         output_table->set_border_width (5);
 492
 493
 494         bt_frame = manage (new Frame);
 495         bt_frame->set_name ("BaseFrame");
 496         bt_frame->set_label (_("Switches"));
 497         bt_frame->add (*button_table);
 498         hpacker.pack_start(*bt_frame, true, true);
 499
 500         box = manage (new VBox);
 501         box->set_border_width (5);
 502         box->set_spacing (1);
 503
 504         frame = manage (new Frame);
 505         frame->set_name ("BaseFrame");
 506         frame->set_label (_("Controls"));
 507         frame->add (*box);
 508         hpacker.pack_start(*frame, true, true);
 509
 510         // Add special controls to UI, and build list of normal controls to be layed out later
 511         std::vector<ControlUI *> cui_controls_list;
 512         for (size_t i = 0; i < control_uis.size(); ++i) {
 513                 ControlUI* cui = control_uis[i];
 514
 515                 if (cui->button || cui->file_button) {
 516
 517                         if (!is_scrollable && button_row == button_rows) {
 518                                 button_row = 0;
 519                                 if (++button_col == button_cols) {
 520                                         button_cols += 2;
 521                                         button_table->resize (button_rows, button_cols);
 522                                 }
 523                         }
 524
 525                         button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
 526                                              FILL|EXPAND, FILL);
 527                         button_row++;
 528
 529                 } else if (cui->controller || cui->combo) {
 530                         // Get all of the controls into a list, so that
 531                         // we can lay them out a bit more nicely later.
 532                         cui_controls_list.push_back(cui);
 533
 534                 } else if (cui->display) {
 535
 536                         output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
 537                                              FILL|EXPAND, FILL);
 538
 539                         // TODO: The meters should be divided into multiple rows
 540
 541                         if (++output_col == output_cols) {
 542                                 output_cols ++;
 543                                 output_table->resize (output_rows, output_cols);
 544                         }
 545                 }
 546         }
 547
 548         // Iterate over the list of controls to find which adjacent controls
 549         // are similar enough to be grouped together.
 550
 551         string label, previous_label = "";
 552         std::vector<int> numbers_in_labels(cui_controls_list.size());
 553
 554         std::vector<float> similarity_scores(cui_controls_list.size());
 555         float most_similar = 0.0, least_similar = 1.0;
 556
 557         size_t i = 0;
 558         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 559                 label = (*cuip)->label.get_text();
 560                 numbers_in_labels[i] = get_number(label);
 561
 562                 if (i > 0) {
 563                         // A hand-wavy calculation of how similar this control's
 564                         // label is to the previous.
 565                         similarity_scores[i] =
 566                                 (float) (
 567                                         ( matching_chars_at_head(label, previous_label) +
 568                                           matching_chars_at_tail(label, previous_label) +
 569                                           1
 570                                         )
 571                                 ) / (label.length() + previous_label.length());
 572                         if (numbers_in_labels[i] >= 0) {
 573                                 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
 574                         }
 575                         least_similar = min(least_similar, similarity_scores[i]);
 576                         most_similar  = max(most_similar, similarity_scores[i]);
 577                 } else {
 578                         similarity_scores[0] = 1.0;
 579                 }
 580
 581                 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
 582                 previous_label = label;
 583         }
 584
 585
 586         // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
 587         float similarity_threshold;
 588
 589         if (most_similar > 1.0) {
 590                 similarity_threshold = default_similarity_threshold;
 591         } else {
 592                 similarity_threshold = most_similar - (1 - default_similarity_threshold);
 593         }
 594
 595         // Now iterate over the list of controls to display them, placing an
 596         // HSeparator between controls of less than a certain similarity, and
 597         // starting a new column when necessary.
 598
 599         i = 0;
 600         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
 601
 602                 ControlUI* cui = *cuip;
 603
 604                 if (!is_scrollable) {
 605                         x++;
 606                 }
 607
 608                 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
 609                         if (x > min_controls_per_column) {
 610                                 frame = manage (new Frame);
 611                                 frame->set_name ("BaseFrame");
 612                                 frame->set_label (_("Controls"));
 613                                 box = manage (new VBox);
 614                                 box->set_border_width (5);
 615                                 box->set_spacing (1);
 616                                 frame->add (*box);
 617                                 hpacker.pack_start(*frame, true, true);
 618                                 x = 0;
 619                         } else {
 620                                 HSeparator *split = new HSeparator();
 621                                 split->set_size_request(-1, 5);
 622                                 box->pack_start(*split, false, false, 0);
 623                         }
 624
 625                 }
 626                 box->pack_start (*cui, false, false);
 627         }
 628
 629         if (is_scrollable && i > 0) {
 630                 prefheight = 30 * i;
 631         }
 632
 633         if (box->children().empty()) {
 634                 hpacker.remove (*frame);
 635         }
 636
 637         if (button_table->children().empty()) {
 638                 hpacker.remove (*bt_frame);
 639                 delete button_table;
 640         } else {
 641                 button_table->show_all ();
 642         }
 643
 644         if (!output_table->children().empty()) {
 645                 frame = manage (new Frame);
 646                 frame->set_name ("BaseFrame");
 647                 frame->set_label(_("Meters"));
 648                 frame->add (*output_table);
 649                 hpacker.pack_end (*frame, true, true);
 650                 output_table->show_all ();
 651         } else {
 652                 delete output_table;
 653         }
 654
 655         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 656                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 657                 hpacker.pack_end (*pd, true, true);
 658         }
 659         show_all();
 660
 661 }
 662
 663 void
 664 GenericPluginUI::custom_layout (const std::vector<ControlUI*>& control_uis)
 665 {
 666         Gtk::Table* layout = manage (new Gtk::Table ());
 667
 668         for (vector<ControlUI*>::const_iterator i = control_uis.begin(); i != control_uis.end(); ++i) {
 669                 ControlUI* cui = *i;
 670                 if (cui->x0 < 0 || cui->y0 < 0) {
 671                         continue;
 672                 }
 673                 layout->attach (*cui, cui->x0, cui->x1, cui->y0, cui->y1, FILL, SHRINK, 2, 2);
 674         }
 675         hpacker.pack_start (*layout, true, true);
 676
 677         if (plugin->has_inline_display () && plugin->inline_display_in_gui ()) {
 678                 PluginDisplay* pd = manage (new PluginDisplay (plugin, 300));
 679                 hpacker.pack_end (*pd, true, true);
 680         }
 681 }
 682
 683 void
 684 GenericPluginUI::build_midi_table ()
 685 {
 686         Gtk::Table* pgm_table = manage (new Gtk::Table (8, 5));
 687
 688         pgm_table->set_homogeneous (false);
 689         pgm_table->set_row_spacings (2);
 690         pgm_table->set_col_spacings (2);
 691         pgm_table->set_border_width (5);
 692         pgm_table->set_col_spacing (2, 10);
 693
 694         Frame* frame = manage (new Frame);
 695         frame->set_name ("BaseFrame");
 696         if (dynamic_cast<MidiTrack*> (insert->owner())) {
 697                 frame->set_label (_("MIDI Programs (sent to track)"));
 698         } else {
 699                 frame->set_label (_("MIDI Programs (volatile)"));
 700         }
 701         frame->add (*pgm_table);
 702         hpacker.pack_start (*frame, false, false);
 703
 704         for (uint8_t chn = 0; chn < 16; ++chn) {
 705                 int col = 3 * (chn / 8);
 706                 int row = chn % 8;
 707                 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
 708                 cui->set_sizing_text ("Stereo Grand Piano");
 709                 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
 710                 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
 711                 midi_pgmsel.push_back (cui);
 712                 pgm_table->attach (*manage (new Label (string_compose ("C%1:", (int)(chn + 1)), ALIGN_RIGHT)), col, col + 1, row, row+1, FILL, SHRINK);
 713                 pgm_table->attach (*cui, col + 1, col + 2, row, row+1, SHRINK, SHRINK);
 714         }
 715
 716         insert->plugin ()->read_midnam();
 717
 718         midi_refill_patches ();
 719
 720         insert->plugin()->BankPatchChange.connect (
 721                         midi_connections, invalidator (*this),
 722                         boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
 723                         gui_context());
 724
 725         insert->plugin()->UpdatedMidnam.connect (
 726                         midi_connections, invalidator (*this),
 727                         boost::bind (&GenericPluginUI::midi_refill_patches, this),
 728                         gui_context());
 729 }
 730
 731 void
 732 GenericPluginUI::midi_refill_patches ()
 733 {
 734         assert (midi_pgmsel.size() == 16);
 735
 736         pgm_names.clear ();
 737
 738         const std::string model = insert->plugin ()->midnam_model ();
 739         std::string mode;
 740         const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
 741         if (device_modes.size() > 0) {
 742                 mode = device_modes.front();
 743         }
 744
 745         for (uint8_t chn = 0; chn < 16; ++chn) {
 746                 midi_pgmsel[chn]->clear_items ();
 747                 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
 748                         MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
 749
 750                 if (cns) {
 751                         using namespace Menu_Helpers;
 752                         using namespace Gtkmm2ext;
 753
 754                         for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
 755                                 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
 756                                 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
 757                                         const std::string pgm = (*j)->name ();
 758                                         MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
 759                                         const uint32_t bp = (key.bank() << 7) | key.program();
 760                                         midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
 761                                         pgm_names[bp] = pgm;
 762                                 }
 763                         }
 764                 }
 765
 766                 midi_bank_patch_change (chn);
 767         }
 768 }
 769
 770 void
 771 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
 772 {
 773         assert (chn < 16 && midi_pgmsel.size() == 16);
 774         uint32_t bankpgm = insert->plugin()->bank_patch (chn);
 775         if (bankpgm == UINT32_MAX) {
 776                 midi_pgmsel[chn]->set_text (_("--Unset--"));
 777         } else {
 778                 int bank = bankpgm >> 7;
 779                 int pgm = bankpgm & 127;
 780                 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
 781                         midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
 782                 } else {
 783                         midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
 784                                                 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
 785                 }
 786         }
 787 }
 788
 789 void
 790 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
 791 {
 792         int bank = bankpgm >> 7;
 793         int pgm = bankpgm & 127;
 794         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
 795         if (mt) {
 796                 /* send to track */
 797                 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
 798                 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
 799                 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
 800
 801                 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
 802                 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
 803                 program->set_value (pgm, PBD::Controllable::NoGroup);
 804         } else {
 805                 uint8_t event[3];
 806                 event[0] = (MIDI_CMD_CONTROL | chn);
 807                 event[1] = 0x00;
 808                 event[2] = bank >> 7;
 809                 insert->write_immediate_event (3, event);
 810
 811                 event[1] = 0x20;
 812                 event[2] = bank & 127;
 813                 insert->write_immediate_event (3, event);
 814
 815                 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
 816                 event[1] = pgm;
 817                 insert->write_immediate_event (2, event);
 818         }
 819 }
 820
 821 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 822         : param(p)
 823         , automate_button (X_("")) // force creation of a label
 824         , combo (0)
 825         , file_button (0)
 826         , spin_box (0)
 827         , display (0)
 828         , hbox (0)
 829         , vbox (0)
 830         , meterinfo (0)
 831         , knobtable (0)
 832 {
 833         automate_button.set_name ("plugin automation state button");
 834         set_tooltip (automate_button, _("Automation control"));
 835
 836         ignore_change = false;
 837         update_pending = false;
 838         button = false;
 839
 840         x0 = x1 = y0 = y1 = -1;
 841 }
 842
 843 GenericPluginUI::ControlUI::~ControlUI()
 844 {
 845         if (meterinfo) {
 846                 delete meterinfo->meter;
 847                 delete meterinfo;
 848         }
 849 }
 850
 851 void
 852 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
 853 {
 854         cui->short_autostate = value;
 855         if (value) {
 856                 cui->automate_button.set_sizing_text("M");
 857         } else {
 858                 /* XXX translators: use a string here that will be at least as long
 859                    as the longest automation label (see ::automation_state_changed()
 860                    below). be sure to include a descender. */
 861                 cui->automate_button.set_sizing_text(_("Mgnual"));
 862         }
 863         automation_state_changed(cui);
 864 }
 865
 866 void
 867 GenericPluginUI::automation_state_changed (ControlUI* cui)
 868 {
 869         /* update button label */
 870
 871         // don't lock to avoid deadlock because we're triggered by
 872         // AutomationControl::Changed() while the automation lock is taken
 873
 874         AutoState state = insert->get_parameter_automation_state (cui->parameter());
 875
 876         cui->automate_button.set_active((state != ARDOUR::Off));
 877
 878         if (cui->short_autostate) {
 879                 cui->automate_button.set_text (GainMeterBase::short_astate_string (state));
 880         } else {
 881                 cui->automate_button.set_text (GainMeterBase::astate_string (state));
 882         }
 883 }
 884
 885 /** Build a ControlUI for a parameter/property.
 886  * Note that mcontrol may be NULL for outputs.
 887  */
 888 GenericPluginUI::ControlUI*
 889 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 890                                    const ParameterDescriptor&           desc,
 891                                    boost::shared_ptr<AutomationControl> mcontrol,
 892                                    float                                value,
 893                                    bool                                 is_input,
 894                                    bool                                 use_knob)
 895 {
 896         ControlUI* control_ui = 0;
 897
 898         control_ui = manage (new ControlUI (param));
 899         control_ui->combo = 0;
 900         control_ui->control = mcontrol;
 901         control_ui->label.set_text (desc.label);
 902         control_ui->label.set_alignment (0.0, 0.5);
 903         control_ui->label.set_name ("PluginParameterLabel");
 904         control_ui->set_spacing (5);
 905         set_short_autostate(control_ui, false);
 906
 907         if (is_input) {
 908
 909                 if (desc.datatype == Variant::PATH) {
 910
 911                         /* We shouldn't get that type for input ports */
 912                         assert(param.type() == PluginPropertyAutomation);
 913
 914                         /* Build a file selector button */
 915
 916                         // Create/add controller
 917                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 918                         control_ui->file_button->set_title(desc.label);
 919                         Gtkmm2ext::add_volume_shortcuts (*control_ui->file_button);
 920
 921                         if (use_knob) {
 922                                 control_ui->knobtable = manage (new Table());
 923                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 924                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 925                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 926                         } else {
 927                                 control_ui->pack_start (control_ui->label, false, true);
 928                                 control_ui->pack_start (*control_ui->file_button, true, true);
 929                         }
 930
 931                         // Monitor changes from the user.
 932                         control_ui->file_button->signal_file_set().connect(
 933                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 934                                            desc, control_ui->file_button));
 935
 936                         /* Add the filebutton control to a map so that we can update it when
 937                          * the corresponding property changes. This doesn't go through the usual
 938                          * AutomationControls, because they don't support non-numeric values. */
 939                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 940
 941                         return control_ui;
 942                 }
 943
 944                 assert(mcontrol);
 945
 946                 /* See if there any named values for our input value */
 947                 control_ui->scale_points = desc.scale_points;
 948
 949                 /* If this parameter is an integer, work out the number of distinct values
 950                    it can take on (assuming that lower and upper values are allowed).
 951                 */
 952                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 953
 954                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 955
 956                         /* Either:
 957                          *   a) There is a label for each possible value of this input, or
 958                          *   b) This port is marked as being an enumeration.
 959                          */
 960
 961                         control_ui->combo = new ArdourDropdown();
 962                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 963                              i != control_ui->scale_points->end();
 964                              ++i) {
 965                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 966                                                 i->first,
 967                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 968                                                            control_ui,
 969                                                            i->second)));
 970                         }
 971
 972                         control_ui->combo->set_controllable (mcontrol);
 973
 974                         update_control_display(control_ui);
 975
 976                 } else {
 977
 978                         /* create the controller */
 979
 980                         /* XXX memory leak: SliderController not destroyed by ControlUI
 981                          * destructor, and manage() reports object hierarchy
 982                          * ambiguity.
 983                          */
 984                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
 985
 986                         /* Control UI's don't need the rapid timer workaround */
 987                         control_ui->controller->stop_updating ();
 988
 989                         /* XXX this code is not right yet, because it doesn't handle
 990                            the absence of bounds in any sensible fashion.
 991                         */
 992
 993                         Adjustment* adj = control_ui->controller->adjustment();
 994
 995                         if (desc.toggled) {
 996                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
 997                                 assert(but);
 998                                 but->set_tweaks(ArdourButton::Square);
 999                         } else if (use_knob) {
1000                                 /* Delay size request so that styles are gotten right */
1001                                 control_ui->controller->widget()->signal_size_request().connect(
1002                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1003                         } else {
1004                                 control_ui->controller->set_size_request (200, -1);
1005                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1006                                 if (desc.integer_step) {
1007                                         AutomationBarController* abc = dynamic_cast <AutomationBarController*> (control_ui->controller->widget ());
1008                                         assert (abc);
1009                                         abc->set_digits (0);
1010                                 }
1011                         }
1012
1013                         if (!desc.integer_step && !desc.toggled && use_knob) {
1014                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1015                         }
1016
1017                         adj->set_value (mcontrol->internal_to_interface(value));
1018
1019                 }
1020
1021                 if (use_knob) {
1022                         set_short_autostate(control_ui, true);
1023
1024                         control_ui->label.set_alignment (0.5, 0.5);
1025                         control_ui->knobtable = manage (new Table());
1026                         control_ui->pack_start(*control_ui->knobtable, true, true);
1027
1028                         if (control_ui->combo) {
1029                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1030                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1031                         } else if (control_ui->spin_box) {
1032                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1033                                 knob->set_tooltip_prefix (desc.label + ": ");
1034                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1035                                 align->add (*control_ui->controller);
1036                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1037                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1038                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1039                         } else if (desc.toggled) {
1040                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1041                                 align->add (*control_ui->controller);
1042                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1043                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1044                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1045                         } else {
1046                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1047                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1048                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1049                         }
1050
1051                 } else {
1052
1053                         control_ui->pack_start (control_ui->label, true, true);
1054                         if (control_ui->combo) {
1055                                 control_ui->pack_start(*control_ui->combo, false, true);
1056                         } else if (control_ui->spin_box) {
1057                                 control_ui->pack_start (*control_ui->spin_box, false, false);
1058                                 control_ui->pack_start (*control_ui->controller, false, false);
1059                         } else {
1060                                 control_ui->pack_start (*control_ui->controller, false, false);
1061                         }
1062                         control_ui->pack_start (control_ui->automate_button, false, false);
1063                 }
1064
1065
1066                 if (mcontrol->flags () & Controllable::NotAutomatable) {
1067                         control_ui->automate_button.set_sensitive (false);
1068                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1069                 } else {
1070                         control_ui->automate_button.signal_button_press_event().connect (
1071                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1072                                                     control_ui),
1073                                         false);
1074                         mcontrol->alist()->automation_state_changed.connect (
1075                                         control_connections,
1076                                         invalidator (*this),
1077                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1078                                         gui_context());
1079                         input_controls_with_automation.push_back (control_ui);
1080                 }
1081
1082                 if (desc.toggled && !control_ui->combo) {
1083                         control_ui->button = true;
1084                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1085                         assert (but);
1086                         but->set_name ("pluginui toggle");
1087                         update_control_display(control_ui);
1088                 }
1089
1090                 automation_state_changed (control_ui);
1091
1092                 /* Add to the list of CUIs that need manual update to workaround
1093                  * AutomationControl not knowing about preset loads */
1094                 input_controls.push_back (control_ui);
1095
1096         } else {
1097
1098                 control_ui->display = manage (new EventBox);
1099                 control_ui->display->set_name ("ParameterValueDisplay");
1100
1101                 control_ui->display_label = manage (new Label);
1102
1103                 control_ui->display_label->set_name ("ParameterValueDisplay");
1104
1105                 control_ui->display->add (*control_ui->display_label);
1106                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1107
1108                 control_ui->display->show_all ();
1109
1110                 control_ui->vbox = manage (new VBox);
1111                 control_ui->vbox->set_spacing(3);
1112
1113                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1114                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1115                         control_ui->vbox->pack_end (control_ui->label, false, false);
1116                 } else if (desc.integer_step || desc.enumeration) {
1117                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1118                         control_ui->vbox->pack_end (control_ui->label, false, false);
1119                 } else {
1120                         /* set up a meter for float ports */
1121
1122                         MeterInfo * info = new MeterInfo();
1123                         control_ui->meterinfo = info;
1124
1125                         info->meter = new FastMeter (
1126                                         5, 5, FastMeter::Vertical, 0,
1127                                         0x0000aaff,
1128                                         0x008800ff, 0x008800ff,
1129                                         0x00ff00ff, 0x00ff00ff,
1130                                         0xcccc00ff, 0xcccc00ff,
1131                                         0xffaa00ff, 0xffaa00ff,
1132                                         0xff0000ff,
1133                                         UIConfiguration::instance().color ("meter background bottom"),
1134                                         UIConfiguration::instance().color ("meter background top")
1135                                         );
1136
1137                         control_ui->label.set_angle(90);
1138
1139                         HBox* center =  manage (new HBox);
1140                         center->set_spacing(1);
1141                         center->pack_start (control_ui->label, false, false);
1142                         center->pack_start (*info->meter, false, false);
1143
1144                         control_ui->hbox = manage (new HBox);
1145                         control_ui->hbox->pack_start (*center, true, false);
1146
1147                         // horizontally center this hbox in the vbox
1148                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1149
1150                         control_ui->meterinfo->meter->show_all();
1151                         control_ui->meterinfo->packed = true;
1152                         control_ui->vbox->pack_start (*control_ui->display, false, false);
1153                 }
1154
1155                 control_ui->pack_start (*control_ui->vbox);
1156
1157                 output_controls.push_back (control_ui);
1158         }
1159
1160         if (mcontrol) {
1161                 mcontrol->Changed.connect(control_connections, invalidator(*this),
1162                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
1163                                                       this, control_ui),
1164                                           gui_context());
1165         }
1166
1167         return control_ui;
1168 }
1169
1170 void
1171 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1172         Gtk::Requisition astate_req (cui->automate_button.size_request());
1173         const int size = (int) (astate_req.height * 1.5);
1174         req->width = max(req->width, size);
1175         req->height = max(req->height, size);
1176 }
1177
1178
1179 bool
1180 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1181 {
1182         if (ev->button != 1) {
1183                 return true;
1184         }
1185
1186         using namespace Menu_Helpers;
1187
1188         if (automation_menu == 0) {
1189                 automation_menu = manage (new Menu);
1190                 automation_menu->set_name ("ArdourContextMenu");
1191                 automation_menu->set_reserve_toggle_size(false);
1192         }
1193
1194         MenuList& items (automation_menu->items());
1195
1196         items.clear ();
1197         items.push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Off),
1198                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1199         items.push_back (MenuElem (GainMeterBase::astate_string (Play),
1200                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1201         items.push_back (MenuElem (GainMeterBase::astate_string (Write),
1202                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1203         items.push_back (MenuElem (GainMeterBase::astate_string (Touch),
1204                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1205         items.push_back (MenuElem (GainMeterBase::astate_string (Latch),
1206                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Latch, cui)));
1207
1208         anchored_menu_popup (automation_menu, &cui->automate_button,
1209                              GainMeterBase::astate_string (insert->get_parameter_automation_state (cui->parameter())),
1210                              1, ev->time);
1211
1212         return true;
1213 }
1214
1215 void
1216 GenericPluginUI::set_all_automation (AutoState as)
1217 {
1218         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1219                 set_automation_state (as, (*i));
1220         }
1221 }
1222
1223 void
1224 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1225 {
1226         insert->set_parameter_automation_state (cui->parameter(), state);
1227 }
1228
1229 void
1230 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1231 {
1232         if (!cui->update_pending) {
1233                 cui->update_pending = true;
1234                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1235         }
1236 }
1237
1238 void
1239 GenericPluginUI::update_control_display (ControlUI* cui)
1240 {
1241         /* XXX how do we handle logarithmic stuff here ? */
1242
1243         cui->update_pending = false;
1244
1245         float val = cui->control->get_value();
1246
1247         PBD::Unwinder<bool> (cui->ignore_change, true);
1248
1249         if (cui->combo && cui->scale_points) {
1250                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1251                         if (it->second == val) {
1252                                 cui->combo->set_text(it->first);
1253                                 break;
1254                         }
1255                 }
1256         } else if (cui->button) {
1257                 // AutomationController handles this
1258         }
1259
1260         if( cui->controller ) {
1261             cui->controller->display_effective_value();
1262         }
1263
1264
1265         /*} else {
1266                 if (cui->logarithmic) {
1267                         val = log(val);
1268                 }
1269                 if (val != cui->adjustment->get_value()) {
1270                         cui->adjustment->set_value (val);
1271                 }
1272         }*/
1273 }
1274
1275 void
1276 GenericPluginUI::update_input_displays ()
1277 {
1278         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1279         for (vector<ControlUI*>::iterator i = input_controls.begin();
1280              i != input_controls.end();
1281              ++i) {
1282                 update_control_display(*i);
1283         }
1284         return;
1285 }
1286
1287 void
1288 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1289 {
1290         if (!cui->ignore_change) {
1291                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1292         }
1293 }
1294
1295 bool
1296 GenericPluginUI::start_updating (GdkEventAny*)
1297 {
1298         if (output_controls.size() > 0 ) {
1299                 screen_update_connection.disconnect();
1300                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1301         }
1302         return false;
1303 }
1304
1305 bool
1306 GenericPluginUI::stop_updating (GdkEventAny*)
1307 {
1308         if (output_controls.size() > 0 ) {
1309                 screen_update_connection.disconnect();
1310         }
1311         return false;
1312 }
1313
1314 void
1315 GenericPluginUI::output_update ()
1316 {
1317         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1318                 float val = plugin->get_parameter ((*i)->parameter().id());
1319                 char buf[32];
1320                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1321                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1322                 size_t len = str.copy(buf, 31);
1323                 buf[len] = '\0';
1324                 (*i)->display_label->set_text (buf);
1325
1326                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1327                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1328                 }
1329         }
1330 }
1331
1332 void
1333 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1334                                     Gtk::FileChooserButton*    widget)
1335 {
1336         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1337 }
1338
1339 void
1340 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1341 {
1342         FilePathControls::iterator c = _filepath_controls.find(key);
1343         if (c != _filepath_controls.end()) {
1344                 c->second->set_filename(value.get_path());
1345         } else {
1346                 std::cerr << "warning: property change for property with no control" << std::endl;
1347         }
1348 }
1349
1350 void
1351 GenericPluginUI::toggle_pianokeyboard ()
1352 {
1353         if (_plugin_pianokeyboard_expander.get_expanded()) {
1354                 _plugin_pianokeyboard_expander.add (_pianobox);
1355                 _pianobox.show_all ();
1356         } else {
1357                 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1358                 _plugin_pianokeyboard_expander.get_child ()->hide ();
1359                 _plugin_pianokeyboard_expander.remove ();
1360
1361                 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1362                 if (toplevel) {
1363                         Gtk::Requisition wr;
1364                         toplevel->get_size (wr.width, wr.height);
1365                         wr.height -= child_height;
1366                         toplevel->resize (wr.width, wr.height);
1367                 }
1368         }
1369 }
1370
1371 void
1372 GenericPluginUI::note_on_event_handler (int note, int)
1373 {
1374         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1375         _piano->grab_focus ();
1376         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1377         uint8_t event[3];
1378         event[0] = (MIDI_CMD_NOTE_ON | channel);
1379         event[1] = note;
1380         event[2] = _piano_velocity.get_value_as_int ();
1381         if (mt) {
1382                 mt->write_immediate_event (3, event);
1383         } else {
1384                 insert->write_immediate_event (3, event);
1385         }
1386 }
1387
1388 void
1389 GenericPluginUI::note_off_event_handler (int note)
1390 {
1391         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1392         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1393         uint8_t event[3];
1394         event[0] = (MIDI_CMD_NOTE_OFF | channel);
1395         event[1] = note;
1396         event[2] = 0;
1397         if (mt) {
1398                 mt->write_immediate_event (3, event);
1399         } else {
1400                 insert->write_immediate_event (3, event);
1401         }
1402 }