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