gtk2_ardour/generic_pluginui.cc

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