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