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
 212         /* Listen for property changes that are not notified normally because
 213          * AutomationControl has only support for numeric values currently.
 214          * The only case is Variant::PATH for now */
 215         plugin->PropertyChanged.connect(*this, invalidator(*this),
 216                                         boost::bind(&GenericPluginUI::path_property_changed, this, _1, _2),
 217                                         gui_context());
 218
 219         main_contents.show ();
 220 }
 221
 222 GenericPluginUI::~GenericPluginUI ()
 223 {
 224         if (output_controls.size() > 0) {
 225                 screen_update_connection.disconnect();
 226         }
 227         delete _pianomm;
 228 }
 229
 230 void
 231 GenericPluginUI::scroller_size_request (Gtk::Requisition* a)
 232 {
 233         Glib::RefPtr<Gdk::Screen> screen = get_screen();
 234         if (!screen)
 235                 screen = Gdk::Screen::get_default();
 236
 237         int maximum_width;
 238         {
 239                 Gdk::Rectangle monitor;
 240                 const int monitor_num = screen->get_monitor_at_window (get_window ());
 241                 screen->get_monitor_geometry (
 242                                 (monitor_num < 0) ? 0 : monitor_num,
 243                                 monitor);
 244
 245                 maximum_width = monitor.get_width() * 0.9;
 246         }
 247
 248         GtkRequisition request = hpacker.size_request();
 249
 250         if (request.width > maximum_width) {
 251                 for (vector<ControlUI*>::const_iterator cuip = input_controls.begin();
 252                                                         cuip != input_controls.end();
 253                                                         ++cuip) {
 254                         if (!(*cuip)->short_autostate)
 255                                 set_short_autostate(*cuip, true);
 256                 }
 257                 request = hpacker.size_request();
 258         }
 259
 260         a->width = min(request.width, maximum_width);
 261 }
 262
 263 // Some functions for calculating the 'similarity' of two plugin
 264 // control labels.
 265
 266 static int get_number(string label) {
 267 static const char *digits = "0123456789";
 268 int value = -1;
 269
 270         std::size_t first_digit_pos = label.find_first_of(digits);
 271         if (first_digit_pos != string::npos) {
 272                 // found some digits: there's a number in there somewhere
 273                 stringstream s;
 274                 s << label.substr(first_digit_pos);
 275                 s >> value;
 276         }
 277         return value;
 278 }
 279
 280 static int match_or_digit(char c1, char c2) {
 281         return c1 == c2 || (isdigit(c1) && isdigit(c2));
 282 }
 283
 284 static std::size_t matching_chars_at_head(const string s1, const string s2) {
 285 std::size_t length, n = 0;
 286
 287         length = min(s1.length(), s2.length());
 288         while (n < length) {
 289                 if (!match_or_digit(s1[n], s2[n]))
 290                         break;
 291                 n++;
 292         }
 293         return n;
 294 }
 295
 296 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
 297 std::size_t s1pos, s2pos, n = 0;
 298
 299         s1pos = s1.length();
 300         s2pos = s2.length();
 301         while (s1pos-- > 0 && s2pos-- > 0) {
 302                 if (!match_or_digit(s1[s1pos], s2[s2pos])       )
 303                         break;
 304                 n++;
 305         }
 306         return n;
 307 }
 308
 309 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
 310 static const float default_similarity_threshold = 0.3;
 311
 312 void
 313 GenericPluginUI::build ()
 314 {
 315         std::vector<ControlUI *> control_uis;
 316         bool grid = plugin->parameter_count() > 0;
 317
 318         // Build a ControlUI for each control port
 319         for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 320
 321                 if (plugin->parameter_is_control (i)) {
 322
 323                         /* Don't show latency control ports */
 324
 325                         const Evoral::Parameter param(PluginAutomation, 0, i);
 326                         if (plugin->describe_parameter (param) == X_("latency")) {
 327                                 continue;
 328                         }
 329
 330                         if (plugin->describe_parameter (param) == X_("hidden")) {
 331                                 continue;
 332                         }
 333
 334                         const float value = plugin->get_parameter(i);
 335
 336                         ControlUI* cui;
 337                         Plugin::UILayoutHint hint;
 338
 339                         if (!plugin->get_layout(i, hint)) {
 340                                 grid = false;
 341                         }
 342
 343                         boost::shared_ptr<ARDOUR::AutomationControl> c
 344                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 345                                         insert->control(param));
 346
 347                         ParameterDescriptor desc;
 348                         plugin->get_parameter_descriptor(i, desc);
 349                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i), hint.knob)) == 0) {
 350                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
 351                                 continue;
 352                         }
 353
 354                         if (grid) {
 355                                 cui->x0 = hint.x0;
 356                                 cui->x1 = hint.x1;
 357                                 cui->y0 = hint.y0;
 358                                 cui->y1 = hint.y1;
 359                         }
 360
 361                         const std::string param_docs = plugin->get_parameter_docs(i);
 362                         if (!param_docs.empty()) {
 363                                 set_tooltip(cui, param_docs.c_str());
 364                         }
 365
 366                         control_uis.push_back(cui);
 367                 }
 368         }
 369
 370         // Build a ControlUI for each property
 371         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
 372         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
 373                 const ParameterDescriptor& desc = d->second;
 374                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
 375
 376                 boost::shared_ptr<ARDOUR::AutomationControl> c
 377                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
 378                                 insert->control(param));
 379
 380                 if (!c) {
 381                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
 382                         continue;
 383                 }
 384
 385                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
 386                 if (!cui) {
 387                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
 388                                                 desc.key) << endmsg;
 389                         continue;
 390                 }
 391
 392                 control_uis.push_back(cui);
 393         }
 394         if (!descs.empty()) {
 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         midi_refill_patches ();
 681
 682         insert->plugin()->BankPatchChange.connect (
 683                         midi_connections, invalidator (*this),
 684                         boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
 685                         gui_context());
 686
 687         /* Note: possible race with MidiTimeAxisView::update_patch_selector()
 688          * which uses this signal to update/re-register the midnam (also in gui context).
 689          * MTAV does register before us, so the midnam should already be updated when
 690          * we're notified.
 691          */
 692         insert->plugin()->UpdateMidnam.connect (
 693                         midi_connections, invalidator (*this),
 694                         boost::bind (&GenericPluginUI::midi_refill_patches, this),
 695                         gui_context());
 696 }
 697
 698 void
 699 GenericPluginUI::midi_refill_patches ()
 700 {
 701         assert (midi_pgmsel.size() == 16);
 702
 703         pgm_names.clear ();
 704
 705         const std::string model = insert->plugin ()->midnam_model ();
 706         std::string mode;
 707         const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
 708         if (device_modes.size() > 0) {
 709                 mode = device_modes.front();
 710         }
 711
 712         for (uint8_t chn = 0; chn < 16; ++chn) {
 713                 midi_pgmsel[chn]->clear_items ();
 714                 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
 715                         MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
 716
 717                 if (cns) {
 718                         using namespace Menu_Helpers;
 719                         using namespace Gtkmm2ext;
 720
 721                         for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
 722                                 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
 723                                 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
 724                                         const std::string pgm = (*j)->name ();
 725                                         MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
 726                                         assert ((*i)->number () == key.bank());
 727                                         const uint32_t bp = (key.bank() << 7) | key.program();
 728                                         midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
 729                                         pgm_names[bp] = pgm;
 730                                 }
 731                         }
 732                 }
 733
 734                 midi_bank_patch_change (chn);
 735         }
 736 }
 737
 738 void
 739 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
 740 {
 741         assert (chn < 16 && midi_pgmsel.size() == 16);
 742         uint32_t bankpgm = insert->plugin()->bank_patch (chn);
 743         if (bankpgm == UINT32_MAX) {
 744                 midi_pgmsel[chn]->set_text (_("--Unset--"));
 745         } else {
 746                 int bank = bankpgm >> 7;
 747                 int pgm = bankpgm & 127;
 748                 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
 749                         midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
 750                 } else {
 751                         midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
 752                                                 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
 753                 }
 754         }
 755 }
 756
 757 void
 758 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
 759 {
 760         int bank = bankpgm >> 7;
 761         int pgm = bankpgm & 127;
 762         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
 763         if (mt) {
 764                 /* send to track */
 765                 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
 766                 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
 767                 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
 768
 769                 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
 770                 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
 771                 program->set_value (pgm, PBD::Controllable::NoGroup);
 772         } else {
 773                 uint8_t event[3];
 774                 event[0] = (MIDI_CMD_CONTROL | chn);
 775                 event[1] = 0x00;
 776                 event[2] = bank >> 7;
 777                 insert->write_immediate_event (3, event);
 778
 779                 event[1] = 0x20;
 780                 event[2] = bank & 127;
 781                 insert->write_immediate_event (3, event);
 782
 783                 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
 784                 event[1] = pgm;
 785                 insert->write_immediate_event (2, event);
 786         }
 787 }
 788
 789 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 790         : param(p)
 791         , automate_button (X_("")) // force creation of a label
 792         , combo (0)
 793         , clickbox (0)
 794         , file_button (0)
 795         , spin_box (0)
 796         , display (0)
 797         , hbox (0)
 798         , vbox (0)
 799         , meterinfo (0)
 800         , knobtable (0)
 801 {
 802         automate_button.set_name ("plugin automation state button");
 803         set_tooltip (automate_button, _("Automation control"));
 804
 805         ignore_change = false;
 806         update_pending = false;
 807         button = false;
 808
 809         x0 = x1 = y0 = y1 = -1;
 810 }
 811
 812 GenericPluginUI::ControlUI::~ControlUI()
 813 {
 814         if (meterinfo) {
 815                 delete meterinfo->meter;
 816                 delete meterinfo;
 817         }
 818 }
 819
 820 void
 821 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
 822 {
 823         cui->short_autostate = value;
 824         if (value) {
 825                 cui->automate_button.set_sizing_text("M");
 826         } else {
 827                 /* XXX translators: use a string here that will be at least as long
 828                    as the longest automation label (see ::automation_state_changed()
 829                    below). be sure to include a descender. */
 830                 cui->automate_button.set_sizing_text(_("Mgnual"));
 831         }
 832         automation_state_changed(cui);
 833 }
 834
 835 void
 836 GenericPluginUI::automation_state_changed (ControlUI* cui)
 837 {
 838         /* update button label */
 839
 840         // don't lock to avoid deadlock because we're triggered by
 841         // AutomationControl::Changed() while the automation lock is taken
 842
 843         AutoState state = insert->get_parameter_automation_state (cui->parameter());
 844
 845         cui->automate_button.set_active((state != ARDOUR::Off));
 846
 847         if (cui->short_autostate) {
 848                 cui->automate_button.set_text (
 849                                 GainMeterBase::astate_string (state));
 850                 return;
 851         }
 852
 853         switch (state & (ARDOUR::Off|Play|Touch|Write)) {
 854         case ARDOUR::Off:
 855                 cui->automate_button.set_text (S_("Automation|Manual"));
 856                 break;
 857         case Play:
 858                 cui->automate_button.set_text (_("Play"));
 859                 break;
 860         case Write:
 861                 cui->automate_button.set_text (_("Write"));
 862                 break;
 863         case Touch:
 864                 cui->automate_button.set_text (_("Touch"));
 865                 break;
 866         default:
 867                 cui->automate_button.set_text (_("???"));
 868                 break;
 869         }
 870 }
 871
 872 bool
 873 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 874 {
 875         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 876         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 877         const size_t       len = str.copy(buf, 31);
 878         buf[len] = '\0';
 879         return true;
 880 }
 881
 882 bool
 883 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 884 {
 885         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 886         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 887         const size_t       len = str.copy(buf, 31);
 888         buf[len] = '\0';
 889         return true;
 890 }
 891
 892 void
 893 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
 894 {
 895         plugin->print_parameter (param, buf, len);
 896 }
 897
 898 /** Build a ControlUI for a parameter/property.
 899  * Note that mcontrol may be NULL for outputs.
 900  */
 901 GenericPluginUI::ControlUI*
 902 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 903                                    const ParameterDescriptor&           desc,
 904                                    boost::shared_ptr<AutomationControl> mcontrol,
 905                                    float                                value,
 906                                    bool                                 is_input,
 907                                    bool                                 use_knob)
 908 {
 909         ControlUI* control_ui = 0;
 910
 911         control_ui = manage (new ControlUI (param));
 912         control_ui->combo = 0;
 913         control_ui->control = mcontrol;
 914         control_ui->label.set_text (desc.label);
 915         control_ui->label.set_alignment (0.0, 0.5);
 916         control_ui->label.set_name ("PluginParameterLabel");
 917         control_ui->set_spacing (5);
 918         set_short_autostate(control_ui, false);
 919
 920         if (is_input) {
 921
 922                 if (desc.datatype == Variant::PATH) {
 923
 924                         /* We shouldn't get that type for input ports */
 925                         assert(param.type() == PluginPropertyAutomation);
 926
 927                         /* Build a file selector button */
 928
 929                         // Create/add controller
 930                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 931                         control_ui->file_button->set_title(desc.label);
 932
 933                         if (use_knob) {
 934                                 control_ui->knobtable = manage (new Table());
 935                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 936                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 937                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 938                         } else {
 939                                 control_ui->pack_start (control_ui->label, false, true);
 940                                 control_ui->pack_start (*control_ui->file_button, true, true);
 941                         }
 942
 943                         // Monitor changes from the user.
 944                         control_ui->file_button->signal_file_set().connect(
 945                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 946                                            desc, control_ui->file_button));
 947
 948                         /* Add the filebutton control to a map so that we can update it when
 949                          * the corresponding property changes. This doesn't go through the usual
 950                          * AutomationControls, because they don't support non-numeric values. */
 951                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 952
 953                         return control_ui;
 954                 }
 955
 956                 assert(mcontrol);
 957
 958                 /* See if there any named values for our input value */
 959                 control_ui->scale_points = desc.scale_points;
 960
 961                 /* If this parameter is an integer, work out the number of distinct values
 962                    it can take on (assuming that lower and upper values are allowed).
 963                 */
 964                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 965
 966                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 967
 968                         /* Either:
 969                          *   a) There is a label for each possible value of this input, or
 970                          *   b) This port is marked as being an enumeration.
 971                          */
 972
 973                         control_ui->combo = new ArdourDropdown();
 974                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 975                              i != control_ui->scale_points->end();
 976                              ++i) {
 977                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 978                                                 i->first,
 979                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 980                                                            control_ui,
 981                                                            i->second)));
 982                         }
 983
 984                         control_ui->combo->set_controllable (mcontrol);
 985
 986                         update_control_display(control_ui);
 987
 988                 } else {
 989
 990                         /* create the controller */
 991
 992                         /* XXX memory leak: SliderController not destroyed by ControlUI
 993                          * destructor, and manage() reports object hierarchy
 994                          * ambiguity.
 995                          */
 996                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
 997
 998                         /* Control UI's don't need the rapid timer workaround */
 999                         control_ui->controller->stop_updating ();
1000
1001                         /* XXX this code is not right yet, because it doesn't handle
1002                            the absence of bounds in any sensible fashion.
1003                         */
1004
1005                         Adjustment* adj = control_ui->controller->adjustment();
1006
1007                         if (desc.integer_step && !desc.toggled) {
1008                                 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
1009                                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
1010                                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1011                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
1012                                 } else {
1013                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
1014                                 }
1015                                 control_ui->clickbox->set_controllable (mcontrol);
1016                         } else if (desc.toggled) {
1017                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1018                                 assert(but);
1019                                 but->set_tweaks(ArdourButton::Square);
1020                         } else if (use_knob) {
1021                                 /* Delay size request so that styles are gotten right */
1022                                 control_ui->controller->widget()->signal_size_request().connect(
1023                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1024                         } else {
1025                                 control_ui->controller->set_size_request (200, -1);
1026                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1027                         }
1028
1029                         if (!desc.integer_step && !desc.toggled && use_knob) {
1030                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1031                         }
1032
1033                         adj->set_value (mcontrol->internal_to_interface(value));
1034
1035                 }
1036
1037                 if (use_knob) {
1038                         set_short_autostate(control_ui, true);
1039
1040                         control_ui->label.set_alignment (0.5, 0.5);
1041                         control_ui->knobtable = manage (new Table());
1042                         control_ui->pack_start(*control_ui->knobtable, true, true);
1043
1044                         if (control_ui->combo) {
1045                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1046                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1047                         } else if (control_ui->clickbox) {
1048                                 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
1049                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1050                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1051                         } else if (control_ui->spin_box) {
1052                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1053                                 knob->set_tooltip_prefix (desc.label + ": ");
1054                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1055                                 align->add (*control_ui->controller);
1056                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1057                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1058                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1059                         } else if (desc.toggled) {
1060                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1061                                 align->add (*control_ui->controller);
1062                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1063                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1064                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1065                         } else {
1066                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1067                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1068                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1069                         }
1070
1071                 } else {
1072
1073                         control_ui->pack_start (control_ui->label, true, true);
1074                         if (control_ui->combo) {
1075                                 control_ui->pack_start(*control_ui->combo, false, true);
1076                         } else if (control_ui->clickbox) {
1077                                 control_ui->pack_start (*control_ui->clickbox, false, false);
1078                         } else if (control_ui->spin_box) {
1079                                 control_ui->pack_start (*control_ui->spin_box, false, false);
1080                                 control_ui->pack_start (*control_ui->controller, false, false);
1081                         } else {
1082                                 control_ui->pack_start (*control_ui->controller, false, false);
1083                         }
1084                         control_ui->pack_start (control_ui->automate_button, false, false);
1085                 }
1086
1087
1088                 if (mcontrol->flags () & Controllable::NotAutomatable) {
1089                         control_ui->automate_button.set_sensitive (false);
1090                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1091                 } else {
1092                         control_ui->automate_button.signal_button_press_event().connect (
1093                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1094                                                     control_ui),
1095                                         false);
1096                         mcontrol->alist()->automation_state_changed.connect (
1097                                         control_connections,
1098                                         invalidator (*this),
1099                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1100                                         gui_context());
1101                         input_controls_with_automation.push_back (control_ui);
1102                 }
1103
1104                 if (desc.toggled && !control_ui->combo) {
1105                         control_ui->button = true;
1106                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1107                         assert (but);
1108                         but->set_name ("pluginui toggle");
1109                         update_control_display(control_ui);
1110                 }
1111
1112                 automation_state_changed (control_ui);
1113
1114                 /* Add to the list of CUIs that need manual update to workaround
1115                  * AutomationControl not knowing about preset loads */
1116                 input_controls.push_back (control_ui);
1117
1118         } else {
1119
1120                 control_ui->display = manage (new EventBox);
1121                 control_ui->display->set_name ("ParameterValueDisplay");
1122
1123                 control_ui->display_label = manage (new Label);
1124
1125                 control_ui->display_label->set_name ("ParameterValueDisplay");
1126
1127                 control_ui->display->add (*control_ui->display_label);
1128                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1129
1130                 control_ui->display->show_all ();
1131
1132                 control_ui->vbox = manage (new VBox);
1133                 control_ui->vbox->set_spacing(3);
1134
1135                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1136                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1137                         control_ui->vbox->pack_end (control_ui->label, false, false);
1138                 } else if (desc.integer_step || desc.enumeration) {
1139                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1140                         control_ui->vbox->pack_end (control_ui->label, false, false);
1141                 } else {
1142                         /* set up a meter for float ports */
1143
1144                         MeterInfo * info = new MeterInfo();
1145                         control_ui->meterinfo = info;
1146
1147                         info->meter = new FastMeter (
1148                                         5, 5, FastMeter::Vertical, 0,
1149                                         0x0000aaff,
1150                                         0x008800ff, 0x008800ff,
1151                                         0x00ff00ff, 0x00ff00ff,
1152                                         0xcccc00ff, 0xcccc00ff,
1153                                         0xffaa00ff, 0xffaa00ff,
1154                                         0xff0000ff,
1155                                         UIConfiguration::instance().color ("meter background bottom"),
1156                                         UIConfiguration::instance().color ("meter background top")
1157                                         );
1158
1159                         control_ui->label.set_angle(90);
1160
1161                         HBox* center =  manage (new HBox);
1162                         center->set_spacing(1);
1163                         center->pack_start (control_ui->label, false, false);
1164                         center->pack_start (*info->meter, false, false);
1165
1166                         control_ui->hbox = manage (new HBox);
1167                         control_ui->hbox->pack_start (*center, true, false);
1168
1169                         // horizontally center this hbox in the vbox
1170                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1171
1172                         control_ui->meterinfo->meter->show_all();
1173                         control_ui->meterinfo->packed = true;
1174                         control_ui->vbox->pack_start (*control_ui->display, false, false);
1175                 }
1176
1177                 control_ui->pack_start (*control_ui->vbox);
1178
1179                 output_controls.push_back (control_ui);
1180         }
1181
1182         if (mcontrol) {
1183                 mcontrol->Changed.connect(control_connections, invalidator(*this),
1184                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
1185                                                       this, control_ui),
1186                                           gui_context());
1187         }
1188
1189         return control_ui;
1190 }
1191
1192 void
1193 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1194         Gtk::Requisition astate_req (cui->automate_button.size_request());
1195         const int size = (int) (astate_req.height * 1.5);
1196         req->width = max(req->width, size);
1197         req->height = max(req->height, size);
1198 }
1199
1200
1201 bool
1202 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1203 {
1204         if (ev->button != 1) {
1205                 return true;
1206         }
1207
1208         using namespace Menu_Helpers;
1209
1210         if (automation_menu == 0) {
1211                 automation_menu = manage (new Menu);
1212                 automation_menu->set_name ("ArdourContextMenu");
1213                 automation_menu->set_reserve_toggle_size(false);
1214         }
1215
1216         MenuList& items (automation_menu->items());
1217
1218         items.clear ();
1219         items.push_back (MenuElem (S_("Automation|Manual"),
1220                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1221         items.push_back (MenuElem (_("Play"),
1222                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1223         items.push_back (MenuElem (_("Write"),
1224                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1225         items.push_back (MenuElem (_("Touch"),
1226                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1227
1228         anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1229                             1, ev->time);
1230
1231         return true;
1232 }
1233
1234 void
1235 GenericPluginUI::set_all_automation (AutoState as)
1236 {
1237         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1238                 set_automation_state (as, (*i));
1239         }
1240 }
1241
1242 void
1243 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1244 {
1245         insert->set_parameter_automation_state (cui->parameter(), state);
1246 }
1247
1248 void
1249 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1250 {
1251         if (!cui->update_pending) {
1252                 cui->update_pending = true;
1253                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1254         }
1255 }
1256
1257 void
1258 GenericPluginUI::update_control_display (ControlUI* cui)
1259 {
1260         /* XXX how do we handle logarithmic stuff here ? */
1261
1262         cui->update_pending = false;
1263
1264         float val = cui->control->get_value();
1265
1266         PBD::Unwinder<bool> (cui->ignore_change, true);
1267
1268         if (cui->combo && cui->scale_points) {
1269                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1270                         if (it->second == val) {
1271                                 cui->combo->set_text(it->first);
1272                                 break;
1273                         }
1274                 }
1275         } else if (cui->button) {
1276                 // AutomationController handles this
1277         }
1278
1279         if( cui->controller ) {
1280             cui->controller->display_effective_value();
1281         }
1282
1283
1284         /*} else {
1285                 if (cui->logarithmic) {
1286                         val = log(val);
1287                 }
1288                 if (val != cui->adjustment->get_value()) {
1289                         cui->adjustment->set_value (val);
1290                 }
1291         }*/
1292 }
1293
1294 void
1295 GenericPluginUI::update_input_displays ()
1296 {
1297         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1298         for (vector<ControlUI*>::iterator i = input_controls.begin();
1299              i != input_controls.end();
1300              ++i) {
1301                 update_control_display(*i);
1302         }
1303         return;
1304 }
1305
1306 void
1307 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1308 {
1309         if (!cui->ignore_change) {
1310                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1311         }
1312 }
1313
1314 bool
1315 GenericPluginUI::start_updating (GdkEventAny*)
1316 {
1317         if (output_controls.size() > 0 ) {
1318                 screen_update_connection.disconnect();
1319                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1320         }
1321         return false;
1322 }
1323
1324 bool
1325 GenericPluginUI::stop_updating (GdkEventAny*)
1326 {
1327         if (output_controls.size() > 0 ) {
1328                 screen_update_connection.disconnect();
1329         }
1330         return false;
1331 }
1332
1333 void
1334 GenericPluginUI::output_update ()
1335 {
1336         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1337                 float val = plugin->get_parameter ((*i)->parameter().id());
1338                 char buf[32];
1339                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1340                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1341                 size_t len = str.copy(buf, 31);
1342                 buf[len] = '\0';
1343                 (*i)->display_label->set_text (buf);
1344
1345                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1346                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1347                 }
1348         }
1349 }
1350
1351 void
1352 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1353                                     Gtk::FileChooserButton*    widget)
1354 {
1355         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1356 }
1357
1358 void
1359 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1360 {
1361         FilePathControls::iterator c = _filepath_controls.find(key);
1362         if (c != _filepath_controls.end()) {
1363                 c->second->set_filename(value.get_path());
1364         } else {
1365                 std::cerr << "warning: property change for property with no control" << std::endl;
1366         }
1367 }
1368
1369 void
1370 GenericPluginUI::toggle_pianokeyboard ()
1371 {
1372         if (_plugin_pianokeyboard_expander.get_expanded()) {
1373                 _plugin_pianokeyboard_expander.add (_pianobox);
1374                 _pianobox.show_all ();
1375         } else {
1376                 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1377                 _plugin_pianokeyboard_expander.get_child ()->hide ();
1378                 _plugin_pianokeyboard_expander.remove ();
1379
1380                 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1381                 if (toplevel) {
1382                         Gtk::Requisition wr;
1383                         toplevel->get_size (wr.width, wr.height);
1384                         wr.height -= child_height;
1385                         toplevel->resize (wr.width, wr.height);
1386                 }
1387         }
1388 }
1389
1390 void
1391 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1392 {
1393         ((GenericPluginUI*)arg)->note_on_event_handler(note);
1394 }
1395
1396 void
1397 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1398 {
1399         ((GenericPluginUI*)arg)->note_off_event_handler(note);
1400 }
1401
1402 void
1403 GenericPluginUI::note_on_event_handler (int note)
1404 {
1405         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1406         _pianomm->grab_focus ();
1407         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1408         uint8_t event[3];
1409         event[0] = (MIDI_CMD_NOTE_ON | channel);
1410         event[1] = note;
1411         event[2] = _piano_velocity.get_value_as_int ();
1412         if (mt) {
1413                 mt->write_immediate_event (3, event);
1414         } else {
1415                 insert->write_immediate_event (3, event);
1416         }
1417 }
1418
1419 void
1420 GenericPluginUI::note_off_event_handler (int note)
1421 {
1422         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1423         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1424         uint8_t event[3];
1425         event[0] = (MIDI_CMD_NOTE_OFF | channel);
1426         event[1] = note;
1427         event[2] = 0;
1428         if (mt) {
1429                 mt->write_immediate_event (3, event);
1430         } else {
1431                 insert->write_immediate_event (3, event);
1432         }
1433 }