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                 }
 311                 n++;
 312         }
 313         return n;
 314 }
 315
 316 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
 317 static const float default_similarity_threshold = 0.3;
 318
 319 void
 320 GenericPluginUI::build ()
 321 {
 322         std::vector<ControlUI *> control_uis;
 323         bool grid_avail = false;
 324         bool grid_veto = false;
 325
 326         // Build a ControlUI for each control port
 327         for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 328
 329                 if (plugin->parameter_is_control (i)) {
 330
 331                         /* Don't show latency control ports */
 332
 333                         const Evoral::Parameter param(PluginAutomation, 0, i);
 334                         if (plugin->describe_parameter (param) == X_("latency")) {
 335                                 continue;
 336                         }
 337
 338                         if (plugin->describe_parameter (param) == X_("hidden")) {
 339                                 continue;
 340                         }
 341
 342                         const float value = plugin->get_parameter(i);
 343
 344                         ControlUI* cui;
 345                         Plugin::UILayoutHint hint;
 346
 347                         if (plugin->get_layout(i, hint)) {
 348                                 grid_avail = true;
 349                         } else {
 350                                 grid_veto = true;
 351                         }
 352
 353                         boost::shared_ptr<ARDOUR::AutomationControl> c
 354                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 355                                         insert->control(param));
 356
 357                         ParameterDescriptor desc;
 358                         plugin->get_parameter_descriptor(i, desc);
 359                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
 360                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
 361                                 continue;
 362                         }
 363
 364                         if (grid_avail && !grid_veto) {
 365                                 cui->x0 = hint.x0;
 366                                 cui->x1 = hint.x1;
 367                                 cui->y0 = hint.y0;
 368                                 cui->y1 = hint.y1;
 369                         }
 370
 371                         const std::string param_docs = plugin->get_parameter_docs(i);
 372                         if (!param_docs.empty()) {
 373                                 set_tooltip(cui, param_docs.c_str());
 374                         }
 375
 376                         control_uis.push_back(cui);
 377                 }
 378         }
 379
 380         bool grid = grid_avail && !grid_veto;
 381
 382         // Build a ControlUI for each property
 383         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
 384         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
 385                 const ParameterDescriptor& desc = d->second;
 386                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 387
 388                 boost::shared_ptr<ARDOUR::AutomationControl> c
 389                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 390                                 insert->control(param));
 391
 392                 if (!c) {
 393                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
 394                         continue;
 395                 }
 396
 397                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
 398                 if (!cui) {
 399                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
 400                                                 desc.key) << endmsg;
 401                         continue;
 402                 }
 403
 404                 control_uis.push_back(cui);
 405         }
 406         if (!descs.empty()) {
 407                 /* Listen for property changes that are not notified normally because
 408                  * AutomationControl has only support for numeric values currently.
 409                  * The only case is Variant::PATH for now */
 410                 plugin->PropertyChanged.connect(*this, invalidator(*this),
 411                                 boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
 412                                 gui_context());
 413
 414                 /* and query current property value */
 415                 plugin->announce_property_values();
 416         }
 417
 418         if (control_uis.empty ()) {
 419                 std::vector<Plugin::PresetRecord> presets = insert->plugin()->get_presets();
 420                 bool show_preset_browser = false;
 421                 for (std::vector<Plugin::PresetRecord>::const_iterator i = presets.begin(); i != presets.end(); ++i) {
 422                         if (i->valid && !i->description.empty()) {
 423                                 show_preset_browser = true;
 424                                 break;
 425                         }
 426                 }
 427                 if (show_preset_browser) {
 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 (
 880                                 GainMeterBase::astate_string (state));
 881                 return;
 882         }
 883
 884         switch (state & (ARDOUR::Off|Play|Touch|Write|Latch)) {
 885         case ARDOUR::Off:
 886                 cui->automate_button.set_text (S_("Automation|Manual"));
 887                 break;
 888         case Play:
 889                 cui->automate_button.set_text (_("Play"));
 890                 break;
 891         case Write:
 892                 cui->automate_button.set_text (_("Write"));
 893                 break;
 894         case Touch:
 895                 cui->automate_button.set_text (_("Touch"));
 896                 break;
 897         case Latch:
 898                 cui->automate_button.set_text (_("Latch"));
 899                 break;
 900         default:
 901                 cui->automate_button.set_text (_("???"));
 902                 break;
 903         }
 904 }
 905
 906 /** Build a ControlUI for a parameter/property.
 907  * Note that mcontrol may be NULL for outputs.
 908  */
 909 GenericPluginUI::ControlUI*
 910 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 911                                    const ParameterDescriptor&           desc,
 912                                    boost::shared_ptr<AutomationControl> mcontrol,
 913                                    float                                value,
 914                                    bool                                 is_input,
 915                                    bool                                 use_knob)
 916 {
 917         ControlUI* control_ui = 0;
 918
 919         control_ui = manage (new ControlUI (param));
 920         control_ui->combo = 0;
 921         control_ui->control = mcontrol;
 922         control_ui->label.set_text (desc.label);
 923         control_ui->label.set_alignment (0.0, 0.5);
 924         control_ui->label.set_name ("PluginParameterLabel");
 925         control_ui->set_spacing (5);
 926         set_short_autostate(control_ui, false);
 927
 928         if (is_input) {
 929
 930                 if (desc.datatype == Variant::PATH) {
 931
 932                         /* We shouldn't get that type for input ports */
 933                         assert(param.type() == PluginPropertyAutomation);
 934
 935                         /* Build a file selector button */
 936
 937                         // Create/add controller
 938                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 939                         control_ui->file_button->set_title(desc.label);
 940                         Gtkmm2ext::add_volume_shortcuts (*control_ui->file_button);
 941
 942                         if (use_knob) {
 943                                 control_ui->knobtable = manage (new Table());
 944                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 945                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 946                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 947                         } else {
 948                                 control_ui->pack_start (control_ui->label, false, true);
 949                                 control_ui->pack_start (*control_ui->file_button, true, true);
 950                         }
 951
 952                         // Monitor changes from the user.
 953                         control_ui->file_button->signal_file_set().connect(
 954                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 955                                            desc, control_ui->file_button));
 956
 957                         /* Add the filebutton control to a map so that we can update it when
 958                          * the corresponding property changes. This doesn't go through the usual
 959                          * AutomationControls, because they don't support non-numeric values. */
 960                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 961
 962                         return control_ui;
 963                 }
 964
 965                 assert(mcontrol);
 966
 967                 /* See if there any named values for our input value */
 968                 control_ui->scale_points = desc.scale_points;
 969
 970                 /* If this parameter is an integer, work out the number of distinct values
 971                    it can take on (assuming that lower and upper values are allowed).
 972                 */
 973                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 974
 975                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 976
 977                         /* Either:
 978                          *   a) There is a label for each possible value of this input, or
 979                          *   b) This port is marked as being an enumeration.
 980                          */
 981
 982                         control_ui->combo = new ArdourDropdown();
 983                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 984                              i != control_ui->scale_points->end();
 985                              ++i) {
 986                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 987                                                 i->first,
 988                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 989                                                            control_ui,
 990                                                            i->second)));
 991                         }
 992
 993                         control_ui->combo->set_controllable (mcontrol);
 994
 995                         update_control_display(control_ui);
 996
 997                 } else {
 998
 999                         /* create the controller */
1000
1001                         /* XXX memory leak: SliderController not destroyed by ControlUI
1002                          * destructor, and manage() reports object hierarchy
1003                          * ambiguity.
1004                          */
1005                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
1006
1007                         /* Control UI's don't need the rapid timer workaround */
1008                         control_ui->controller->stop_updating ();
1009
1010                         /* XXX this code is not right yet, because it doesn't handle
1011                            the absence of bounds in any sensible fashion.
1012                         */
1013
1014                         Adjustment* adj = control_ui->controller->adjustment();
1015
1016                         if (desc.toggled) {
1017                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1018                                 assert(but);
1019                                 but->set_tweaks(ArdourButton::Square);
1020                         } else if (use_knob) {
1021                                 /* Delay size request so that styles are gotten right */
1022                                 control_ui->controller->widget()->signal_size_request().connect(
1023                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1024                         } else {
1025                                 control_ui->controller->set_size_request (200, -1);
1026                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1027                                 if (desc.integer_step) {
1028                                         AutomationBarController* abc = dynamic_cast <AutomationBarController*> (control_ui->controller->widget ());
1029                                         assert (abc);
1030                                         abc->set_digits (0);
1031                                 }
1032                         }
1033
1034                         if (!desc.integer_step && !desc.toggled && use_knob) {
1035                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1036                         }
1037
1038                         adj->set_value (mcontrol->internal_to_interface(value));
1039
1040                 }
1041
1042                 if (use_knob) {
1043                         set_short_autostate(control_ui, true);
1044
1045                         control_ui->label.set_alignment (0.5, 0.5);
1046                         control_ui->knobtable = manage (new Table());
1047                         control_ui->pack_start(*control_ui->knobtable, true, true);
1048
1049                         if (control_ui->combo) {
1050                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1051                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1052                         } else if (control_ui->spin_box) {
1053                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1054                                 knob->set_tooltip_prefix (desc.label + ": ");
1055                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1056                                 align->add (*control_ui->controller);
1057                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1058                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1059                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1060                         } else if (desc.toggled) {
1061                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1062                                 align->add (*control_ui->controller);
1063                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1064                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1065                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1066                         } else {
1067                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1068                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1069                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1070                         }
1071
1072                 } else {
1073
1074                         control_ui->pack_start (control_ui->label, true, true);
1075                         if (control_ui->combo) {
1076                                 control_ui->pack_start(*control_ui->combo, false, true);
1077                         } else if (control_ui->spin_box) {
1078                                 control_ui->pack_start (*control_ui->spin_box, false, false);
1079                                 control_ui->pack_start (*control_ui->controller, false, false);
1080                         } else {
1081                                 control_ui->pack_start (*control_ui->controller, false, false);
1082                         }
1083                         control_ui->pack_start (control_ui->automate_button, false, false);
1084                 }
1085
1086
1087                 if (mcontrol->flags () & Controllable::NotAutomatable) {
1088                         control_ui->automate_button.set_sensitive (false);
1089                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1090                 } else {
1091                         control_ui->automate_button.signal_button_press_event().connect (
1092                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1093                                                     control_ui),
1094                                         false);
1095                         mcontrol->alist()->automation_state_changed.connect (
1096                                         control_connections,
1097                                         invalidator (*this),
1098                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1099                                         gui_context());
1100                         input_controls_with_automation.push_back (control_ui);
1101                 }
1102
1103                 if (desc.toggled && !control_ui->combo) {
1104                         control_ui->button = true;
1105                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1106                         assert (but);
1107                         but->set_name ("pluginui toggle");
1108                         update_control_display(control_ui);
1109                 }
1110
1111                 automation_state_changed (control_ui);
1112
1113                 /* Add to the list of CUIs that need manual update to workaround
1114                  * AutomationControl not knowing about preset loads */
1115                 input_controls.push_back (control_ui);
1116
1117         } else {
1118
1119                 control_ui->display = manage (new EventBox);
1120                 control_ui->display->set_name ("ParameterValueDisplay");
1121
1122                 control_ui->display_label = manage (new Label);
1123
1124                 control_ui->display_label->set_name ("ParameterValueDisplay");
1125
1126                 control_ui->display->add (*control_ui->display_label);
1127                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1128
1129                 control_ui->display->show_all ();
1130
1131                 control_ui->vbox = manage (new VBox);
1132                 control_ui->vbox->set_spacing(3);
1133
1134                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1135                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1136                         control_ui->vbox->pack_end (control_ui->label, false, false);
1137                 } else if (desc.integer_step || desc.enumeration) {
1138                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1139                         control_ui->vbox->pack_end (control_ui->label, false, false);
1140                 } else {
1141                         /* set up a meter for float ports */
1142
1143                         MeterInfo * info = new MeterInfo();
1144                         control_ui->meterinfo = info;
1145
1146                         info->meter = new FastMeter (
1147                                         5, 5, FastMeter::Vertical, 0,
1148                                         0x0000aaff,
1149                                         0x008800ff, 0x008800ff,
1150                                         0x00ff00ff, 0x00ff00ff,
1151                                         0xcccc00ff, 0xcccc00ff,
1152                                         0xffaa00ff, 0xffaa00ff,
1153                                         0xff0000ff,
1154                                         UIConfiguration::instance().color ("meter background bottom"),
1155                                         UIConfiguration::instance().color ("meter background top")
1156                                         );
1157
1158                         control_ui->label.set_angle(90);
1159
1160                         HBox* center =  manage (new HBox);
1161                         center->set_spacing(1);
1162                         center->pack_start (control_ui->label, false, false);
1163                         center->pack_start (*info->meter, false, false);
1164
1165                         control_ui->hbox = manage (new HBox);
1166                         control_ui->hbox->pack_start (*center, true, false);
1167
1168                         // horizontally center this hbox in the vbox
1169                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1170
1171                         control_ui->meterinfo->meter->show_all();
1172                         control_ui->meterinfo->packed = true;
1173                         control_ui->vbox->pack_start (*control_ui->display, false, false);
1174                 }
1175
1176                 control_ui->pack_start (*control_ui->vbox);
1177
1178                 output_controls.push_back (control_ui);
1179         }
1180
1181         if (mcontrol) {
1182                 mcontrol->Changed.connect(control_connections, invalidator(*this),
1183                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
1184                                                       this, control_ui),
1185                                           gui_context());
1186         }
1187
1188         return control_ui;
1189 }
1190
1191 void
1192 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1193         Gtk::Requisition astate_req (cui->automate_button.size_request());
1194         const int size = (int) (astate_req.height * 1.5);
1195         req->width = max(req->width, size);
1196         req->height = max(req->height, size);
1197 }
1198
1199
1200 bool
1201 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1202 {
1203         if (ev->button != 1) {
1204                 return true;
1205         }
1206
1207         using namespace Menu_Helpers;
1208
1209         if (automation_menu == 0) {
1210                 automation_menu = manage (new Menu);
1211                 automation_menu->set_name ("ArdourContextMenu");
1212                 automation_menu->set_reserve_toggle_size(false);
1213         }
1214
1215         MenuList& items (automation_menu->items());
1216
1217         items.clear ();
1218         items.push_back (MenuElem (S_("Automation|Manual"),
1219                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1220         items.push_back (MenuElem (_("Play"),
1221                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1222         items.push_back (MenuElem (_("Write"),
1223                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1224         items.push_back (MenuElem (_("Touch"),
1225                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1226         items.push_back (MenuElem (_("Latch"),
1227                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Latch, cui)));
1228
1229         anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1230                             1, ev->time);
1231
1232         return true;
1233 }
1234
1235 void
1236 GenericPluginUI::set_all_automation (AutoState as)
1237 {
1238         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1239                 set_automation_state (as, (*i));
1240         }
1241 }
1242
1243 void
1244 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1245 {
1246         insert->set_parameter_automation_state (cui->parameter(), state);
1247 }
1248
1249 void
1250 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1251 {
1252         if (!cui->update_pending) {
1253                 cui->update_pending = true;
1254                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1255         }
1256 }
1257
1258 void
1259 GenericPluginUI::update_control_display (ControlUI* cui)
1260 {
1261         /* XXX how do we handle logarithmic stuff here ? */
1262
1263         cui->update_pending = false;
1264
1265         float val = cui->control->get_value();
1266
1267         PBD::Unwinder<bool> (cui->ignore_change, true);
1268
1269         if (cui->combo && cui->scale_points) {
1270                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1271                         if (it->second == val) {
1272                                 cui->combo->set_text(it->first);
1273                                 break;
1274                         }
1275                 }
1276         } else if (cui->button) {
1277                 // AutomationController handles this
1278         }
1279
1280         if( cui->controller ) {
1281             cui->controller->display_effective_value();
1282         }
1283
1284
1285         /*} else {
1286                 if (cui->logarithmic) {
1287                         val = log(val);
1288                 }
1289                 if (val != cui->adjustment->get_value()) {
1290                         cui->adjustment->set_value (val);
1291                 }
1292         }*/
1293 }
1294
1295 void
1296 GenericPluginUI::update_input_displays ()
1297 {
1298         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1299         for (vector<ControlUI*>::iterator i = input_controls.begin();
1300              i != input_controls.end();
1301              ++i) {
1302                 update_control_display(*i);
1303         }
1304         return;
1305 }
1306
1307 void
1308 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1309 {
1310         if (!cui->ignore_change) {
1311                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1312         }
1313 }
1314
1315 bool
1316 GenericPluginUI::start_updating (GdkEventAny*)
1317 {
1318         if (output_controls.size() > 0 ) {
1319                 screen_update_connection.disconnect();
1320                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1321         }
1322         return false;
1323 }
1324
1325 bool
1326 GenericPluginUI::stop_updating (GdkEventAny*)
1327 {
1328         if (output_controls.size() > 0 ) {
1329                 screen_update_connection.disconnect();
1330         }
1331         return false;
1332 }
1333
1334 void
1335 GenericPluginUI::output_update ()
1336 {
1337         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1338                 float val = plugin->get_parameter ((*i)->parameter().id());
1339                 char buf[32];
1340                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1341                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1342                 size_t len = str.copy(buf, 31);
1343                 buf[len] = '\0';
1344                 (*i)->display_label->set_text (buf);
1345
1346                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1347                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1348                 }
1349         }
1350 }
1351
1352 void
1353 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1354                                     Gtk::FileChooserButton*    widget)
1355 {
1356         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1357 }
1358
1359 void
1360 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1361 {
1362         FilePathControls::iterator c = _filepath_controls.find(key);
1363         if (c != _filepath_controls.end()) {
1364                 c->second->set_filename(value.get_path());
1365         } else {
1366                 std::cerr << "warning: property change for property with no control" << std::endl;
1367         }
1368 }
1369
1370 void
1371 GenericPluginUI::toggle_pianokeyboard ()
1372 {
1373         if (_plugin_pianokeyboard_expander.get_expanded()) {
1374                 _plugin_pianokeyboard_expander.add (_pianobox);
1375                 _pianobox.show_all ();
1376         } else {
1377                 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1378                 _plugin_pianokeyboard_expander.get_child ()->hide ();
1379                 _plugin_pianokeyboard_expander.remove ();
1380
1381                 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1382                 if (toplevel) {
1383                         Gtk::Requisition wr;
1384                         toplevel->get_size (wr.width, wr.height);
1385                         wr.height -= child_height;
1386                         toplevel->resize (wr.width, wr.height);
1387                 }
1388         }
1389 }
1390
1391 void
1392 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1393 {
1394         ((GenericPluginUI*)arg)->note_on_event_handler(note);
1395 }
1396
1397 void
1398 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1399 {
1400         ((GenericPluginUI*)arg)->note_off_event_handler(note);
1401 }
1402
1403 void
1404 GenericPluginUI::note_on_event_handler (int note)
1405 {
1406         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1407         _pianomm->grab_focus ();
1408         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1409         uint8_t event[3];
1410         event[0] = (MIDI_CMD_NOTE_ON | channel);
1411         event[1] = note;
1412         event[2] = _piano_velocity.get_value_as_int ();
1413         if (mt) {
1414                 mt->write_immediate_event (3, event);
1415         } else {
1416                 insert->write_immediate_event (3, event);
1417         }
1418 }
1419
1420 void
1421 GenericPluginUI::note_off_event_handler (int note)
1422 {
1423         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1424         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1425         uint8_t event[3];
1426         event[0] = (MIDI_CMD_NOTE_OFF | channel);
1427         event[1] = note;
1428         event[2] = 0;
1429         if (mt) {
1430                 mt->write_immediate_event (3, event);
1431         } else {
1432                 insert->write_immediate_event (3, event);
1433         }
1434 }