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