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