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, 5));
 653
 654         pgm_table->set_homogeneous (false);
 655         pgm_table->set_row_spacings (2);
 656         pgm_table->set_col_spacings (2);
 657         pgm_table->set_border_width (5);
 658         pgm_table->set_col_spacing (2, 10);
 659
 660         Frame* frame = manage (new Frame);
 661         frame->set_name ("BaseFrame");
 662         if (dynamic_cast<MidiTrack*> (insert->owner())) {
 663                 frame->set_label (_("MIDI Progams (sent to track)"));
 664         } else {
 665                 frame->set_label (_("MIDI Progams (volatile)"));
 666         }
 667         frame->add (*pgm_table);
 668         hpacker.pack_start (*frame, false, false);
 669
 670         for (uint8_t chn = 0; chn < 16; ++chn) {
 671                 int col = 3 * (chn / 8);
 672                 int row = chn % 8;
 673                 ArdourDropdown* cui = manage (new ArdourWidgets::ArdourDropdown ());
 674                 cui->set_sizing_text ("Stereo Grand Piano");
 675                 cui->set_text_ellipsize (Pango::ELLIPSIZE_END);
 676                 cui->set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
 677                 midi_pgmsel.push_back (cui);
 678                 pgm_table->attach (*manage (new Label (string_compose ("C%1:", (int)(chn + 1)), ALIGN_RIGHT)), col, col + 1, row, row+1, FILL, SHRINK);
 679                 pgm_table->attach (*cui, col + 1, col + 2, row, row+1, SHRINK, SHRINK);
 680         }
 681
 682         insert->plugin ()->read_midnam();
 683
 684         midi_refill_patches ();
 685
 686         insert->plugin()->BankPatchChange.connect (
 687                         midi_connections, invalidator (*this),
 688                         boost::bind (&GenericPluginUI::midi_bank_patch_change, this, _1),
 689                         gui_context());
 690
 691         insert->plugin()->UpdatedMidnam.connect (
 692                         midi_connections, invalidator (*this),
 693                         boost::bind (&GenericPluginUI::midi_refill_patches, this),
 694                         gui_context());
 695 }
 696
 697 void
 698 GenericPluginUI::midi_refill_patches ()
 699 {
 700         assert (midi_pgmsel.size() == 16);
 701
 702         pgm_names.clear ();
 703
 704         const std::string model = insert->plugin ()->midnam_model ();
 705         std::string mode;
 706         const std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance().custom_device_mode_names_by_model (model);
 707         if (device_modes.size() > 0) {
 708                 mode = device_modes.front();
 709         }
 710
 711         for (uint8_t chn = 0; chn < 16; ++chn) {
 712                 midi_pgmsel[chn]->clear_items ();
 713                 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns =
 714                         MIDI::Name::MidiPatchManager::instance().find_channel_name_set (model, mode, chn);
 715
 716                 if (cns) {
 717                         using namespace Menu_Helpers;
 718                         using namespace Gtkmm2ext;
 719
 720                         for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
 721                                 const MIDI::Name::PatchNameList& patches = (*i)->patch_name_list ();
 722                                 for (MIDI::Name::PatchNameList::const_iterator j = patches.begin(); j != patches.end(); ++j) {
 723                                         const std::string pgm = (*j)->name ();
 724                                         MIDI::Name::PatchPrimaryKey const& key = (*j)->patch_primary_key ();
 725                                         assert ((*i)->number () == key.bank());
 726                                         const uint32_t bp = (key.bank() << 7) | key.program();
 727                                         midi_pgmsel[chn]->AddMenuElem (MenuElemNoMnemonic (pgm, sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midi_bank_patch_select), chn, bp)));
 728                                         pgm_names[bp] = pgm;
 729                                 }
 730                         }
 731                 }
 732
 733                 midi_bank_patch_change (chn);
 734         }
 735 }
 736
 737 void
 738 GenericPluginUI::midi_bank_patch_change (uint8_t chn)
 739 {
 740         assert (chn < 16 && midi_pgmsel.size() == 16);
 741         uint32_t bankpgm = insert->plugin()->bank_patch (chn);
 742         if (bankpgm == UINT32_MAX) {
 743                 midi_pgmsel[chn]->set_text (_("--Unset--"));
 744         } else {
 745                 int bank = bankpgm >> 7;
 746                 int pgm = bankpgm & 127;
 747                 if (pgm_names.find (bankpgm) != pgm_names.end ()) {
 748                         midi_pgmsel[chn]->set_text (pgm_names[bankpgm]);
 749                 } else {
 750                         midi_pgmsel[chn]->set_text (string_compose ("Bank %1,%2 Pgm %3",
 751                                                 (bank >> 7) + 1, (bank & 127) + 1, pgm +1));
 752                 }
 753         }
 754 }
 755
 756 void
 757 GenericPluginUI::midi_bank_patch_select (uint8_t chn, uint32_t bankpgm)
 758 {
 759         int bank = bankpgm >> 7;
 760         int pgm = bankpgm & 127;
 761         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
 762         if (mt) {
 763                 /* send to track */
 764                 boost::shared_ptr<AutomationControl> bank_msb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
 765                 boost::shared_ptr<AutomationControl> bank_lsb = mt->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
 766                 boost::shared_ptr<AutomationControl> program = mt->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
 767
 768                 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
 769                 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
 770                 program->set_value (pgm, PBD::Controllable::NoGroup);
 771         } else {
 772                 uint8_t event[3];
 773                 event[0] = (MIDI_CMD_CONTROL | chn);
 774                 event[1] = 0x00;
 775                 event[2] = bank >> 7;
 776                 insert->write_immediate_event (3, event);
 777
 778                 event[1] = 0x20;
 779                 event[2] = bank & 127;
 780                 insert->write_immediate_event (3, event);
 781
 782                 event[0] = (MIDI_CMD_PGM_CHANGE | chn);
 783                 event[1] = pgm;
 784                 insert->write_immediate_event (2, event);
 785         }
 786 }
 787
 788 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 789         : param(p)
 790         , automate_button (X_("")) // force creation of a label
 791         , combo (0)
 792         , clickbox (0)
 793         , file_button (0)
 794         , spin_box (0)
 795         , display (0)
 796         , hbox (0)
 797         , vbox (0)
 798         , meterinfo (0)
 799         , knobtable (0)
 800 {
 801         automate_button.set_name ("plugin automation state button");
 802         set_tooltip (automate_button, _("Automation control"));
 803
 804         ignore_change = false;
 805         update_pending = false;
 806         button = false;
 807
 808         x0 = x1 = y0 = y1 = -1;
 809 }
 810
 811 GenericPluginUI::ControlUI::~ControlUI()
 812 {
 813         if (meterinfo) {
 814                 delete meterinfo->meter;
 815                 delete meterinfo;
 816         }
 817 }
 818
 819 void
 820 GenericPluginUI::set_short_autostate (ControlUI* cui, bool value)
 821 {
 822         cui->short_autostate = value;
 823         if (value) {
 824                 cui->automate_button.set_sizing_text("M");
 825         } else {
 826                 /* XXX translators: use a string here that will be at least as long
 827                    as the longest automation label (see ::automation_state_changed()
 828                    below). be sure to include a descender. */
 829                 cui->automate_button.set_sizing_text(_("Mgnual"));
 830         }
 831         automation_state_changed(cui);
 832 }
 833
 834 void
 835 GenericPluginUI::automation_state_changed (ControlUI* cui)
 836 {
 837         /* update button label */
 838
 839         // don't lock to avoid deadlock because we're triggered by
 840         // AutomationControl::Changed() while the automation lock is taken
 841
 842         AutoState state = insert->get_parameter_automation_state (cui->parameter());
 843
 844         cui->automate_button.set_active((state != ARDOUR::Off));
 845
 846         if (cui->short_autostate) {
 847                 cui->automate_button.set_text (
 848                                 GainMeterBase::astate_string (state));
 849                 return;
 850         }
 851
 852         switch (state & (ARDOUR::Off|Play|Touch|Write)) {
 853         case ARDOUR::Off:
 854                 cui->automate_button.set_text (S_("Automation|Manual"));
 855                 break;
 856         case Play:
 857                 cui->automate_button.set_text (_("Play"));
 858                 break;
 859         case Write:
 860                 cui->automate_button.set_text (_("Write"));
 861                 break;
 862         case Touch:
 863                 cui->automate_button.set_text (_("Touch"));
 864                 break;
 865         default:
 866                 cui->automate_button.set_text (_("???"));
 867                 break;
 868         }
 869 }
 870
 871 bool
 872 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 873 {
 874         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 875         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 876         const size_t       len = str.copy(buf, 31);
 877         buf[len] = '\0';
 878         return true;
 879 }
 880
 881 bool
 882 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
 883 {
 884         float const        v   = cui->control->interface_to_internal(adj.get_value ());
 885         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
 886         const size_t       len = str.copy(buf, 31);
 887         buf[len] = '\0';
 888         return true;
 889 }
 890
 891 void
 892 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
 893 {
 894         plugin->print_parameter (param, buf, len);
 895 }
 896
 897 /** Build a ControlUI for a parameter/property.
 898  * Note that mcontrol may be NULL for outputs.
 899  */
 900 GenericPluginUI::ControlUI*
 901 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 902                                    const ParameterDescriptor&           desc,
 903                                    boost::shared_ptr<AutomationControl> mcontrol,
 904                                    float                                value,
 905                                    bool                                 is_input,
 906                                    bool                                 use_knob)
 907 {
 908         ControlUI* control_ui = 0;
 909
 910         control_ui = manage (new ControlUI (param));
 911         control_ui->combo = 0;
 912         control_ui->control = mcontrol;
 913         control_ui->label.set_text (desc.label);
 914         control_ui->label.set_alignment (0.0, 0.5);
 915         control_ui->label.set_name ("PluginParameterLabel");
 916         control_ui->set_spacing (5);
 917         set_short_autostate(control_ui, false);
 918
 919         if (is_input) {
 920
 921                 if (desc.datatype == Variant::PATH) {
 922
 923                         /* We shouldn't get that type for input ports */
 924                         assert(param.type() == PluginPropertyAutomation);
 925
 926                         /* Build a file selector button */
 927
 928                         // Create/add controller
 929                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
 930                         control_ui->file_button->set_title(desc.label);
 931
 932                         if (use_knob) {
 933                                 control_ui->knobtable = manage (new Table());
 934                                 control_ui->pack_start(*control_ui->knobtable, true, false);
 935                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
 936                                 control_ui->knobtable->attach (*control_ui->file_button, 0, 1, 1, 2);
 937                         } else {
 938                                 control_ui->pack_start (control_ui->label, false, true);
 939                                 control_ui->pack_start (*control_ui->file_button, true, true);
 940                         }
 941
 942                         // Monitor changes from the user.
 943                         control_ui->file_button->signal_file_set().connect(
 944                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_path_property),
 945                                            desc, control_ui->file_button));
 946
 947                         /* Add the filebutton control to a map so that we can update it when
 948                          * the corresponding property changes. This doesn't go through the usual
 949                          * AutomationControls, because they don't support non-numeric values. */
 950                         _filepath_controls.insert(std::make_pair(desc.key, control_ui->file_button));
 951
 952                         return control_ui;
 953                 }
 954
 955                 assert(mcontrol);
 956
 957                 /* See if there any named values for our input value */
 958                 control_ui->scale_points = desc.scale_points;
 959
 960                 /* If this parameter is an integer, work out the number of distinct values
 961                    it can take on (assuming that lower and upper values are allowed).
 962                 */
 963                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
 964
 965                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
 966
 967                         /* Either:
 968                          *   a) There is a label for each possible value of this input, or
 969                          *   b) This port is marked as being an enumeration.
 970                          */
 971
 972                         control_ui->combo = new ArdourDropdown();
 973                         for (ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
 974                              i != control_ui->scale_points->end();
 975                              ++i) {
 976                                 control_ui->combo->AddMenuElem(Menu_Helpers::MenuElem(
 977                                                 i->first,
 978                                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
 979                                                            control_ui,
 980                                                            i->second)));
 981                         }
 982
 983                         control_ui->combo->set_controllable (mcontrol);
 984
 985                         update_control_display(control_ui);
 986
 987                 } else {
 988
 989                         /* create the controller */
 990
 991                         /* XXX memory leak: SliderController not destroyed by ControlUI
 992                          * destructor, and manage() reports object hierarchy
 993                          * ambiguity.
 994                          */
 995                         control_ui->controller = AutomationController::create(mcontrol->parameter(), desc, mcontrol, use_knob);
 996
 997                         /* Control UI's don't need the rapid timer workaround */
 998                         control_ui->controller->stop_updating ();
 999
1000                         /* XXX this code is not right yet, because it doesn't handle
1001                            the absence of bounds in any sensible fashion.
1002                         */
1003
1004                         Adjustment* adj = control_ui->controller->adjustment();
1005
1006                         if (desc.integer_step && !desc.toggled) {
1007                                 control_ui->clickbox = new ArdourWidgets::ClickBox (adj, "PluginUIClickBox", true);
1008                                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
1009                                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1010                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
1011                                 } else {
1012                                         control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
1013                                 }
1014                                 control_ui->clickbox->set_controllable (mcontrol);
1015                         } else if (desc.toggled) {
1016                                 ArdourButton* but = dynamic_cast<ArdourButton*> (control_ui->controller->widget());
1017                                 assert(but);
1018                                 but->set_tweaks(ArdourButton::Square);
1019                         } else if (use_knob) {
1020                                 /* Delay size request so that styles are gotten right */
1021                                 control_ui->controller->widget()->signal_size_request().connect(
1022                                                 sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::knob_size_request), control_ui));
1023                         } else {
1024                                 control_ui->controller->set_size_request (200, -1);
1025                                 control_ui->controller->set_name (X_("ProcessorControlSlider"));
1026                         }
1027
1028                         if (!desc.integer_step && !desc.toggled && use_knob) {
1029                                 control_ui->spin_box = manage (new ArdourSpinner (mcontrol, adj));
1030                         }
1031
1032                         adj->set_value (mcontrol->internal_to_interface(value));
1033
1034                 }
1035
1036                 if (use_knob) {
1037                         set_short_autostate(control_ui, true);
1038
1039                         control_ui->label.set_alignment (0.5, 0.5);
1040                         control_ui->knobtable = manage (new Table());
1041                         control_ui->pack_start(*control_ui->knobtable, true, true);
1042
1043                         if (control_ui->combo) {
1044                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 0, 1);
1045                                 control_ui->knobtable->attach (*control_ui->combo, 0, 1, 1, 2);
1046                         } else if (control_ui->clickbox) {
1047                                 control_ui->knobtable->attach (*control_ui->clickbox, 0, 2, 0, 1);
1048                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1049                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1050                         } else if (control_ui->spin_box) {
1051                                 ArdourKnob* knob = dynamic_cast<ArdourKnob*>(control_ui->controller->widget ());
1052                                 knob->set_tooltip_prefix (desc.label + ": ");
1053                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1054                                 align->add (*control_ui->controller);
1055                                 control_ui->knobtable->attach (*align, 0, 1, 0, 1, EXPAND, SHRINK, 1, 2);
1056                                 control_ui->knobtable->attach (*control_ui->spin_box, 0, 2, 1, 2);
1057                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 0, 1, SHRINK, SHRINK, 2, 0);
1058                         } else if (desc.toggled) {
1059                                 Alignment *align = manage (new Alignment (.5, .5, 0, 0));
1060                                 align->add (*control_ui->controller);
1061                                 control_ui->knobtable->attach (*align, 0, 2, 0, 1, EXPAND, SHRINK, 2, 2);
1062                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1063                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1064                         } else {
1065                                 control_ui->knobtable->attach (*control_ui->controller, 0, 2, 0, 1);
1066                                 control_ui->knobtable->attach (control_ui->label, 0, 1, 1, 2, FILL, SHRINK);
1067                                 control_ui->knobtable->attach (control_ui->automate_button, 1, 2, 1, 2, SHRINK, SHRINK, 2, 0);
1068                         }
1069
1070                 } else {
1071
1072                         control_ui->pack_start (control_ui->label, true, true);
1073                         if (control_ui->combo) {
1074                                 control_ui->pack_start(*control_ui->combo, false, true);
1075                         } else if (control_ui->clickbox) {
1076                                 control_ui->pack_start (*control_ui->clickbox, false, false);
1077                         } else if (control_ui->spin_box) {
1078                                 control_ui->pack_start (*control_ui->spin_box, false, false);
1079                                 control_ui->pack_start (*control_ui->controller, false, false);
1080                         } else {
1081                                 control_ui->pack_start (*control_ui->controller, false, false);
1082                         }
1083                         control_ui->pack_start (control_ui->automate_button, false, false);
1084                 }
1085
1086
1087                 if (mcontrol->flags () & Controllable::NotAutomatable) {
1088                         control_ui->automate_button.set_sensitive (false);
1089                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
1090                 } else {
1091                         control_ui->automate_button.signal_button_press_event().connect (
1092                                         sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_button_event),
1093                                                     control_ui),
1094                                         false);
1095                         mcontrol->alist()->automation_state_changed.connect (
1096                                         control_connections,
1097                                         invalidator (*this),
1098                                         boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui),
1099                                         gui_context());
1100                         input_controls_with_automation.push_back (control_ui);
1101                 }
1102
1103                 if (desc.toggled && !control_ui->combo) {
1104                         control_ui->button = true;
1105                         ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
1106                         assert (but);
1107                         but->set_name ("pluginui toggle");
1108                         update_control_display(control_ui);
1109                 }
1110
1111                 automation_state_changed (control_ui);
1112
1113                 /* Add to the list of CUIs that need manual update to workaround
1114                  * AutomationControl not knowing about preset loads */
1115                 input_controls.push_back (control_ui);
1116
1117         } else {
1118
1119                 control_ui->display = manage (new EventBox);
1120                 control_ui->display->set_name ("ParameterValueDisplay");
1121
1122                 control_ui->display_label = manage (new Label);
1123
1124                 control_ui->display_label->set_name ("ParameterValueDisplay");
1125
1126                 control_ui->display->add (*control_ui->display_label);
1127                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
1128
1129                 control_ui->display->show_all ();
1130
1131                 control_ui->vbox = manage (new VBox);
1132                 control_ui->vbox->set_spacing(3);
1133
1134                 if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
1135                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1136                         control_ui->vbox->pack_end (control_ui->label, false, false);
1137                 } else if (desc.integer_step || desc.enumeration) {
1138                         control_ui->vbox->pack_end (*control_ui->display, false, false);
1139                         control_ui->vbox->pack_end (control_ui->label, false, false);
1140                 } else {
1141                         /* set up a meter for float ports */
1142
1143                         MeterInfo * info = new MeterInfo();
1144                         control_ui->meterinfo = info;
1145
1146                         info->meter = new FastMeter (
1147                                         5, 5, FastMeter::Vertical, 0,
1148                                         0x0000aaff,
1149                                         0x008800ff, 0x008800ff,
1150                                         0x00ff00ff, 0x00ff00ff,
1151                                         0xcccc00ff, 0xcccc00ff,
1152                                         0xffaa00ff, 0xffaa00ff,
1153                                         0xff0000ff,
1154                                         UIConfiguration::instance().color ("meter background bottom"),
1155                                         UIConfiguration::instance().color ("meter background top")
1156                                         );
1157
1158                         control_ui->label.set_angle(90);
1159
1160                         HBox* center =  manage (new HBox);
1161                         center->set_spacing(1);
1162                         center->pack_start (control_ui->label, false, false);
1163                         center->pack_start (*info->meter, false, false);
1164
1165                         control_ui->hbox = manage (new HBox);
1166                         control_ui->hbox->pack_start (*center, true, false);
1167
1168                         // horizontally center this hbox in the vbox
1169                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
1170
1171                         control_ui->meterinfo->meter->show_all();
1172                         control_ui->meterinfo->packed = true;
1173                         control_ui->vbox->pack_start (*control_ui->display, false, false);
1174                 }
1175
1176                 control_ui->pack_start (*control_ui->vbox);
1177
1178                 output_controls.push_back (control_ui);
1179         }
1180
1181         if (mcontrol) {
1182                 mcontrol->Changed.connect(control_connections, invalidator(*this),
1183                                           boost::bind(&GenericPluginUI::ui_parameter_changed,
1184                                                       this, control_ui),
1185                                           gui_context());
1186         }
1187
1188         return control_ui;
1189 }
1190
1191 void
1192 GenericPluginUI::knob_size_request(Gtk::Requisition* req, ControlUI* cui) {
1193         Gtk::Requisition astate_req (cui->automate_button.size_request());
1194         const int size = (int) (astate_req.height * 1.5);
1195         req->width = max(req->width, size);
1196         req->height = max(req->height, size);
1197 }
1198
1199
1200 bool
1201 GenericPluginUI::astate_button_event (GdkEventButton* ev, ControlUI* cui)
1202 {
1203         if (ev->button != 1) {
1204                 return true;
1205         }
1206
1207         using namespace Menu_Helpers;
1208
1209         if (automation_menu == 0) {
1210                 automation_menu = manage (new Menu);
1211                 automation_menu->set_name ("ArdourContextMenu");
1212                 automation_menu->set_reserve_toggle_size(false);
1213         }
1214
1215         MenuList& items (automation_menu->items());
1216
1217         items.clear ();
1218         items.push_back (MenuElem (S_("Automation|Manual"),
1219                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
1220         items.push_back (MenuElem (_("Play"),
1221                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
1222         items.push_back (MenuElem (_("Write"),
1223                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
1224         items.push_back (MenuElem (_("Touch"),
1225                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
1226
1227         anchored_menu_popup(automation_menu, &cui->automate_button, cui->automate_button.get_text(),
1228                             1, ev->time);
1229
1230         return true;
1231 }
1232
1233 void
1234 GenericPluginUI::set_all_automation (AutoState as)
1235 {
1236         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
1237                 set_automation_state (as, (*i));
1238         }
1239 }
1240
1241 void
1242 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
1243 {
1244         insert->set_parameter_automation_state (cui->parameter(), state);
1245 }
1246
1247 void
1248 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
1249 {
1250         if (!cui->update_pending) {
1251                 cui->update_pending = true;
1252                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
1253         }
1254 }
1255
1256 void
1257 GenericPluginUI::update_control_display (ControlUI* cui)
1258 {
1259         /* XXX how do we handle logarithmic stuff here ? */
1260
1261         cui->update_pending = false;
1262
1263         float val = cui->control->get_value();
1264
1265         PBD::Unwinder<bool> (cui->ignore_change, true);
1266
1267         if (cui->combo && cui->scale_points) {
1268                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
1269                         if (it->second == val) {
1270                                 cui->combo->set_text(it->first);
1271                                 break;
1272                         }
1273                 }
1274         } else if (cui->button) {
1275                 // AutomationController handles this
1276         }
1277
1278         if( cui->controller ) {
1279             cui->controller->display_effective_value();
1280         }
1281
1282
1283         /*} else {
1284                 if (cui->logarithmic) {
1285                         val = log(val);
1286                 }
1287                 if (val != cui->adjustment->get_value()) {
1288                         cui->adjustment->set_value (val);
1289                 }
1290         }*/
1291 }
1292
1293 void
1294 GenericPluginUI::update_input_displays ()
1295 {
1296         /* XXX This is a workaround for AutomationControl not knowing about preset loads */
1297         for (vector<ControlUI*>::iterator i = input_controls.begin();
1298              i != input_controls.end();
1299              ++i) {
1300                 update_control_display(*i);
1301         }
1302         return;
1303 }
1304
1305 void
1306 GenericPluginUI::control_combo_changed (ControlUI* cui, float value)
1307 {
1308         if (!cui->ignore_change) {
1309                 insert->automation_control (cui->parameter())->set_value (value, Controllable::NoGroup);
1310         }
1311 }
1312
1313 bool
1314 GenericPluginUI::start_updating (GdkEventAny*)
1315 {
1316         if (output_controls.size() > 0 ) {
1317                 screen_update_connection.disconnect();
1318                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
1319         }
1320         return false;
1321 }
1322
1323 bool
1324 GenericPluginUI::stop_updating (GdkEventAny*)
1325 {
1326         if (output_controls.size() > 0 ) {
1327                 screen_update_connection.disconnect();
1328         }
1329         return false;
1330 }
1331
1332 void
1333 GenericPluginUI::output_update ()
1334 {
1335         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
1336                 float val = plugin->get_parameter ((*i)->parameter().id());
1337                 char buf[32];
1338                 boost::shared_ptr<ReadOnlyControl> c = insert->control_output ((*i)->parameter().id());
1339                 const std::string& str = ARDOUR::value_as_string(c->desc(), Variant(val));
1340                 size_t len = str.copy(buf, 31);
1341                 buf[len] = '\0';
1342                 (*i)->display_label->set_text (buf);
1343
1344                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
1345                         (*i)->meterinfo->meter->set (c->desc().to_interface (val));
1346                 }
1347         }
1348 }
1349
1350 void
1351 GenericPluginUI::set_path_property (const ParameterDescriptor& desc,
1352                                     Gtk::FileChooserButton*    widget)
1353 {
1354         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1355 }
1356
1357 void
1358 GenericPluginUI::path_property_changed (uint32_t key, const Variant& value)
1359 {
1360         FilePathControls::iterator c = _filepath_controls.find(key);
1361         if (c != _filepath_controls.end()) {
1362                 c->second->set_filename(value.get_path());
1363         } else {
1364                 std::cerr << "warning: property change for property with no control" << std::endl;
1365         }
1366 }
1367
1368 void
1369 GenericPluginUI::toggle_pianokeyboard ()
1370 {
1371         if (_plugin_pianokeyboard_expander.get_expanded()) {
1372                 _plugin_pianokeyboard_expander.add (_pianobox);
1373                 _pianobox.show_all ();
1374         } else {
1375                 const int child_height = _plugin_pianokeyboard_expander.get_child ()->get_height ();
1376                 _plugin_pianokeyboard_expander.get_child ()->hide ();
1377                 _plugin_pianokeyboard_expander.remove ();
1378
1379                 Gtk::Window *toplevel = (Gtk::Window*) _plugin_pianokeyboard_expander.get_ancestor (GTK_TYPE_WINDOW);
1380                 if (toplevel) {
1381                         Gtk::Requisition wr;
1382                         toplevel->get_size (wr.width, wr.height);
1383                         wr.height -= child_height;
1384                         toplevel->resize (wr.width, wr.height);
1385                 }
1386         }
1387 }
1388
1389 void
1390 GenericPluginUI::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
1391 {
1392         ((GenericPluginUI*)arg)->note_on_event_handler(note);
1393 }
1394
1395 void
1396 GenericPluginUI::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
1397 {
1398         ((GenericPluginUI*)arg)->note_off_event_handler(note);
1399 }
1400
1401 void
1402 GenericPluginUI::note_on_event_handler (int note)
1403 {
1404         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1405         _pianomm->grab_focus ();
1406         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1407         uint8_t event[3];
1408         event[0] = (MIDI_CMD_NOTE_ON | channel);
1409         event[1] = note;
1410         event[2] = _piano_velocity.get_value_as_int ();
1411         if (mt) {
1412                 mt->write_immediate_event (3, event);
1413         } else {
1414                 insert->write_immediate_event (3, event);
1415         }
1416 }
1417
1418 void
1419 GenericPluginUI::note_off_event_handler (int note)
1420 {
1421         MidiTrack* mt = dynamic_cast<MidiTrack*> (insert->owner());
1422         uint8_t channel = _piano_channel.get_value_as_int () - 1;
1423         uint8_t event[3];
1424         event[0] = (MIDI_CMD_NOTE_OFF | channel);
1425         event[1] = note;
1426         event[2] = 0;
1427         if (mt) {
1428                 mt->write_immediate_event (3, event);
1429         } else {
1430                 insert->write_immediate_event (3, event);
1431         }
1432 }