use running_from_source_tree()
[ardour.git] / 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 "pbd/stl_delete.h"
31 #include "pbd/xml++.h"
32 #include "pbd/failed_constructor.h"
33
34 #include <gtkmm2ext/click_box.h>
35 #include <gtkmm2ext/fastmeter.h>
36 #include <gtkmm2ext/barcontroller.h>
37 #include <gtkmm2ext/utils.h>
38 #include <gtkmm2ext/doi.h>
39 #include <gtkmm2ext/slider_controller.h>
40
41 #include "ardour/plugin.h"
42 #include "ardour/plugin_insert.h"
43 #include "ardour/session.h"
44 #include "ardour/value_as_string.h"
45
46 #include "prompter.h"
47 #include "plugin_ui.h"
48 #include "gui_thread.h"
49 #include "automation_controller.h"
50 #include "timers.h"
51 #include "tooltips.h"
52 #include "ui_config.h"
53
54 #include "i18n.h"
55
56 using namespace std;
57 using namespace ARDOUR;
58 using namespace PBD;
59 using namespace Gtkmm2ext;
60 using namespace Gtk;
61 using namespace ARDOUR_UI_UTILS;
62
63 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
64         : PlugUIBase (pi)
65         , button_table (initial_button_rows, initial_button_cols)
66         , output_table (initial_output_rows, initial_output_cols)
67         , hAdjustment(0.0, 0.0, 0.0)
68         , vAdjustment(0.0, 0.0, 0.0)
69         , scroller_view(hAdjustment, vAdjustment)
70         , automation_menu (0)
71         , is_scrollable(scrollable)
72 {
73         set_name ("PluginEditor");
74         set_border_width (10);
75         //set_homogeneous (false);
76
77         pack_start (main_contents, true, true);
78         settings_box.set_homogeneous (false);
79
80         HBox* constraint_hbox = manage (new HBox);
81         HBox* smaller_hbox = manage (new HBox);
82         HBox* automation_hbox = manage (new HBox);
83         smaller_hbox->set_spacing (4);
84         automation_hbox->set_spacing (6);
85         Label* combo_label = manage (new Label (_("<span size=\"large\">Presets</span>")));
86         combo_label->set_use_markup (true);
87
88         latency_button.signal_clicked.connect (sigc::mem_fun (*this, &PlugUIBase::latency_button_clicked));
89         set_latency_label ();
90
91         smaller_hbox->pack_start (latency_button, false, false, 4);
92         smaller_hbox->pack_start (_preset_combo, false, false);
93         smaller_hbox->pack_start (_preset_modified, false, false);
94         smaller_hbox->pack_start (add_button, false, false);
95         smaller_hbox->pack_start (save_button, false, false);
96         smaller_hbox->pack_start (delete_button, false, false);
97         smaller_hbox->pack_start (reset_button, false, false, 4);
98         smaller_hbox->pack_start (bypass_button, false, true, 4);
99
100         automation_manual_all_button.set_text(_("Manual"));
101         automation_manual_all_button.set_name (X_("generic button"));
102         automation_play_all_button.set_text(_("Play"));
103         automation_play_all_button.set_name (X_("generic button"));
104         automation_write_all_button.set_text(_("Write"));
105         automation_write_all_button.set_name (X_("generic button"));
106         automation_touch_all_button.set_text(_("Touch"));
107         automation_touch_all_button.set_name (X_("generic button"));
108
109         Label* l = manage (new Label (_("All Automation")));
110         l->set_alignment (1.0, 0.5);
111         automation_hbox->pack_start (*l, true, true);
112         automation_hbox->pack_start (automation_manual_all_button, false, false);
113         automation_hbox->pack_start (automation_play_all_button, false, false);
114         automation_hbox->pack_start (automation_write_all_button, false, false);
115         automation_hbox->pack_start (automation_touch_all_button, false, false);
116
117         constraint_hbox->set_spacing (5);
118         constraint_hbox->set_homogeneous (false);
119
120         VBox* v1_box = manage (new VBox);
121         VBox* v2_box = manage (new VBox);
122         pack_end (plugin_analysis_expander, false, false);
123         if (!plugin->get_docs().empty()) {
124                 pack_end (description_expander, false, false);
125         }
126
127         v1_box->set_spacing (6);
128         v1_box->pack_start (*smaller_hbox, false, true);
129         v1_box->pack_start (*automation_hbox, false, true);
130         v2_box->pack_start (focus_button, false, true);
131
132         main_contents.pack_start (settings_box, false, false);
133
134         constraint_hbox->pack_end (*v2_box, false, false);
135         constraint_hbox->pack_end (*v1_box, false, false);
136
137         main_contents.pack_start (*constraint_hbox, false, false);
138
139         if (is_scrollable ) {
140                 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
141                 scroller.set_name ("PluginEditor");
142                 scroller_view.set_name("PluginEditor");
143                 scroller_view.add (hpacker);
144                 scroller.add (scroller_view);
145
146                 main_contents.pack_start (scroller, true, true);
147
148         } else {
149                 main_contents.pack_start (hpacker, false, false);
150         }
151
152         pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
153
154         bypass_button.set_active (!pi->active());
155
156         prefheight = 0;
157         build ();
158 }
159
160 GenericPluginUI::~GenericPluginUI ()
161 {
162         if (output_controls.size() > 0) {
163                 screen_update_connection.disconnect();
164         }
165 }
166
167 // Some functions for calculating the 'similarity' of two plugin
168 // control labels.
169
170 static int get_number(string label) {
171 static const char *digits = "0123456789";
172 int value = -1;
173
174         std::size_t first_digit_pos = label.find_first_of(digits);
175         if (first_digit_pos != string::npos) {
176                 // found some digits: there's a number in there somewhere
177                 stringstream s;
178                 s << label.substr(first_digit_pos);
179                 s >> value;
180         }
181         return value;
182 }
183
184 static int match_or_digit(char c1, char c2) {
185         return c1 == c2 || (isdigit(c1) && isdigit(c2));
186 }
187
188 static std::size_t matching_chars_at_head(const string s1, const string s2) {
189 std::size_t length, n = 0;
190
191         length = min(s1.length(), s2.length());
192         while (n < length) {
193                 if (!match_or_digit(s1[n], s2[n]))
194                         break;
195                 n++;
196         }
197         return n;
198 }
199
200 static std::size_t matching_chars_at_tail(const string s1, const string s2) {
201 std::size_t s1pos, s2pos, n = 0;
202
203         s1pos = s1.length();
204         s2pos = s2.length();
205         while (s1pos-- > 0 && s2pos-- > 0) {
206                 if (!match_or_digit(s1[s1pos], s2[s2pos])       )
207                         break;
208                 n++;
209         }
210         return n;
211 }
212
213 static const guint32 min_controls_per_column = 17, max_controls_per_column = 24;
214 static const float default_similarity_threshold = 0.3;
215
216 void
217 GenericPluginUI::build ()
218 {
219         guint32 i = 0;
220         guint32 x = 0;
221         Frame* frame;
222         Frame* bt_frame;
223         VBox* box;
224         int output_row, output_col;
225         int button_row, button_col;
226         int output_rows, output_cols;
227         int button_rows, button_cols;
228
229         hpacker.set_spacing (10);
230
231         output_rows = initial_output_rows;
232         output_cols = initial_output_cols;
233         button_rows = initial_button_rows;
234         button_cols = initial_button_cols;
235         output_row = 0;
236         button_row = 0;
237         output_col = 0;
238         button_col = 0;
239
240         button_table.set_homogeneous (false);
241         button_table.set_row_spacings (2);
242         button_table.set_col_spacings (2);
243         output_table.set_homogeneous (true);
244         output_table.set_row_spacings (2);
245         output_table.set_col_spacings (2);
246         button_table.set_border_width (5);
247         output_table.set_border_width (5);
248
249         hpacker.set_border_width (10);
250
251         bt_frame = manage (new Frame);
252         bt_frame->set_name ("BaseFrame");
253         bt_frame->set_label (_("Switches"));
254         bt_frame->add (button_table);
255         hpacker.pack_start(*bt_frame, true, true);
256
257         box = manage (new VBox);
258         box->set_border_width (5);
259         box->set_spacing (1);
260
261         frame = manage (new Frame);
262         frame->set_name ("BaseFrame");
263         frame->set_label (_("Controls"));
264         frame->add (*box);
265         hpacker.pack_start(*frame, true, true);
266
267         std::vector<ControlUI *> control_uis;
268
269         // Build a ControlUI for each control port
270         for (i = 0; i < plugin->parameter_count(); ++i) {
271
272                 if (plugin->parameter_is_control (i)) {
273
274                         /* Don't show latency control ports */
275
276                         const Evoral::Parameter param(PluginAutomation, 0, i);
277                         if (plugin->describe_parameter (param) == X_("latency")) {
278                                 continue;
279                         }
280
281                         if (plugin->describe_parameter (param) == X_("hidden")) {
282                                 continue;
283                         }
284
285                         const float value = plugin->get_parameter(i);
286
287                         ControlUI* cui;
288
289                         boost::shared_ptr<ARDOUR::AutomationControl> c
290                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
291                                         insert->control(param));
292
293                         ParameterDescriptor desc;
294                         plugin->get_parameter_descriptor(i, desc);
295                         if ((cui = build_control_ui (param, desc, c, value, plugin->parameter_is_input(i))) == 0) {
296                                 error << string_compose(_("Plugin Editor: could not build control element for port %1"), i) << endmsg;
297                                 continue;
298                         }
299
300                         const std::string param_docs = plugin->get_parameter_docs(i);
301                         if (!param_docs.empty()) {
302                                 set_tooltip(cui, param_docs.c_str());
303                         }
304
305                         control_uis.push_back(cui);
306                         input_controls_with_automation.push_back (cui);
307                 }
308         }
309
310         // Build a ControlUI for each property
311         const Plugin::PropertyDescriptors& descs = plugin->get_supported_properties();
312         for (Plugin::PropertyDescriptors::const_iterator d = descs.begin(); d != descs.end(); ++d) {
313                 const ParameterDescriptor& desc = d->second;
314                 const Evoral::Parameter    param(PluginPropertyAutomation, 0, desc.key);
315
316                 boost::shared_ptr<ARDOUR::AutomationControl> c
317                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
318                                 insert->control(param));
319
320                 if (!c) {
321                         error << string_compose(_("Plugin Editor: no control for property %1"), desc.key) << endmsg;
322                         continue;
323                 }
324
325                 ControlUI* cui = build_control_ui(param, desc, c, c->get_value(), true);
326                 if (!cui) {
327                         error << string_compose(_("Plugin Editor: could not build control element for property %1"),
328                                                 desc.key) << endmsg;
329                         continue;
330                 }
331
332                 control_uis.push_back(cui);
333         }
334         if (!descs.empty()) {
335                 plugin->announce_property_values();
336         }
337
338         // Add special controls to UI, and build list of normal controls to be layed out later
339         std::vector<ControlUI *> cui_controls_list;
340         for (i = 0; i < control_uis.size(); ++i) {
341                 ControlUI* cui = control_uis[i];
342
343                 if (cui->controller || cui->clickbox || cui->combo) {
344                         // Get all of the controls into a list, so that
345                         // we can lay them out a bit more nicely later.
346                         cui_controls_list.push_back(cui);
347                 } else if (cui->button || cui->file_button) {
348
349                         if (!is_scrollable && button_row == button_rows) {
350                                 button_row = 0;
351                                 if (++button_col == button_cols) {
352                                         button_cols += 2;
353                                         button_table.resize (button_rows, button_cols);
354                                 }
355                         }
356
357                         button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
358                                              FILL|EXPAND, FILL);
359                         button_row++;
360
361                 } else if (cui->display) {
362
363                         output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
364                                              FILL|EXPAND, FILL);
365
366                         // TODO: The meters should be divided into multiple rows
367
368                         if (++output_col == output_cols) {
369                                 output_cols ++;
370                                 output_table.resize (output_rows, output_cols);
371                         }
372                 }
373         }
374
375         // Iterate over the list of controls to find which adjacent controls
376         // are similar enough to be grouped together.
377
378         string label, previous_label = "";
379         std::vector<int> numbers_in_labels(cui_controls_list.size());
380
381         std::vector<float> similarity_scores(cui_controls_list.size());
382         float most_similar = 0.0, least_similar = 1.0;
383
384         i = 0;
385         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
386                 label = (*cuip)->label.get_text();
387                 numbers_in_labels[i] = get_number(label);
388
389                 if (i > 0) {
390                         // A hand-wavy calculation of how similar this control's
391                         // label is to the previous.
392                         similarity_scores[i] =
393                                 (float) (
394                                         ( matching_chars_at_head(label, previous_label) +
395                                           matching_chars_at_tail(label, previous_label) +
396                                           1
397                                         )
398                                 ) / (label.length() + previous_label.length());
399                         if (numbers_in_labels[i] >= 0) {
400                                 similarity_scores[i] += (numbers_in_labels[i] == numbers_in_labels[i-1]);
401                         }
402                         least_similar = min(least_similar, similarity_scores[i]);
403                         most_similar  = max(most_similar, similarity_scores[i]);
404                 } else {
405                         similarity_scores[0] = 1.0;
406                 }
407
408                 // cerr << "label: " << label << " sim: " << fixed << setprecision(3) << similarity_scores[i] << " num: " << numbers_in_labels[i] << endl;
409                 previous_label = label;
410         }
411
412
413         // cerr << "most similar: " << most_similar << ", least similar: " << least_similar << endl;
414         float similarity_threshold;
415
416         if (most_similar > 1.0) {
417                 similarity_threshold = default_similarity_threshold;
418         } else {
419                 similarity_threshold = most_similar - (1 - default_similarity_threshold);
420         }
421
422         // Now iterate over the list of controls to display them, placing an
423         // HSeparator between controls of less than a certain similarity, and
424         // starting a new column when necessary.
425
426         i = 0;
427         for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
428
429                 ControlUI* cui = *cuip;
430
431                 if (!is_scrollable) {
432                         x++;
433                 }
434
435                 if (x > max_controls_per_column || similarity_scores[i] <= similarity_threshold) {
436                         if (x > min_controls_per_column) {
437                                 frame = manage (new Frame);
438                                 frame->set_name ("BaseFrame");
439                                 frame->set_label (_("Controls"));
440                                 box = manage (new VBox);
441                                 box->set_border_width (5);
442                                 box->set_spacing (1);
443                                 frame->add (*box);
444                                 hpacker.pack_start(*frame, true, true);
445                                 x = 0;
446                         } else {
447                                 HSeparator *split = new HSeparator();
448                                 split->set_size_request(-1, 5);
449                                 box->pack_start(*split, false, false, 0);
450                         }
451
452                 }
453                 box->pack_start (*cui, false, false);
454         }
455
456         if (is_scrollable) {
457                 prefheight = 30 * i;
458         }
459
460         if (box->children().empty()) {
461                 hpacker.remove (*frame);
462         }
463
464         if (button_table.children().empty()) {
465                 hpacker.remove (*bt_frame);
466         }
467
468         if (!output_table.children().empty()) {
469                 frame = manage (new Frame);
470                 frame->set_name ("BaseFrame");
471                 frame->set_label(_("Meters"));
472                 frame->add (output_table);
473                 hpacker.pack_end (*frame, true, true);
474         }
475
476         output_update ();
477
478         output_table.show_all ();
479         button_table.show_all ();
480
481         automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
482         automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
483         automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
484         automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
485 }
486
487 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
488         : param(p)
489         , automate_button (X_("")) // force creation of a label
490         , file_button(NULL)
491 {
492         automate_button.set_name ("PluginAutomateButton");
493         set_tooltip (automate_button, _("Automation control"));
494
495         /* XXX translators: use a string here that will be at least as long
496            as the longest automation label (see ::automation_state_changed()
497            below). be sure to include a descender.
498         */
499
500         set_size_request_to_display_given_text (automate_button, _("Mgnual"), 15, 10);
501
502         ignore_change = 0;
503         display = 0;
504         button = 0;
505         clickbox = 0;
506         meterinfo = 0;
507 }
508
509 GenericPluginUI::ControlUI::~ControlUI()
510 {
511         if (meterinfo) {
512                 delete meterinfo->meter;
513                 delete meterinfo;
514         }
515 }
516
517 void
518 GenericPluginUI::automation_state_changed (ControlUI* cui)
519 {
520         /* update button label */
521
522         // don't lock to avoid deadlock because we're triggered by
523         // AutomationControl::Changed() while the automation lock is taken
524         switch (insert->get_parameter_automation_state (cui->parameter()) & (ARDOUR::Off|Play|Touch|Write)) {
525         case ARDOUR::Off:
526                 cui->automate_button.set_label (S_("Automation|Manual"));
527                 break;
528         case Play:
529                 cui->automate_button.set_label (_("Play"));
530                 break;
531         case Write:
532                 cui->automate_button.set_label (_("Write"));
533                 break;
534         case Touch:
535                 cui->automate_button.set_label (_("Touch"));
536                 break;
537         default:
538                 cui->automate_button.set_label (_("???"));
539                 break;
540         }
541 }
542
543 bool
544 GenericPluginUI::integer_printer (char buf[32], Adjustment &adj, ControlUI* cui)
545 {
546         float const        v   = cui->control->interface_to_internal(adj.get_value ());
547         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
548         const size_t       len = str.copy(buf, 31);
549         buf[len] = '\0';
550         return true;
551 }
552
553 bool
554 GenericPluginUI::midinote_printer (char buf[32], Adjustment &adj, ControlUI* cui)
555 {
556         float const        v   = cui->control->interface_to_internal(adj.get_value ());
557         const std::string& str = ARDOUR::value_as_string(cui->control->desc(), Variant(v));
558         const size_t       len = str.copy(buf, 31);
559         buf[len] = '\0';
560         return true;
561 }
562
563 void
564 GenericPluginUI::print_parameter (char *buf, uint32_t len, uint32_t param)
565 {
566         plugin->print_parameter (param, buf, len);
567 }
568
569 /** Build a ControlUI for a parameter/property.
570  * Note that mcontrol may be NULL for outputs.
571  */
572 GenericPluginUI::ControlUI*
573 GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
574                                    const ParameterDescriptor&           desc,
575                                    boost::shared_ptr<AutomationControl> mcontrol,
576                                    float                                value,
577                                    bool                                 is_input)
578 {
579         ControlUI* control_ui = 0;
580
581         control_ui = manage (new ControlUI (param));
582         control_ui->combo = 0;
583         control_ui->control = mcontrol;
584         control_ui->update_pending = false;
585         control_ui->label.set_text (desc.label);
586         control_ui->label.set_alignment (0.0, 0.5);
587         control_ui->label.set_name ("PluginParameterLabel");
588
589         control_ui->set_spacing (5);
590
591         Gtk::Requisition req (control_ui->automate_button.size_request());
592
593         if (is_input) {
594
595                 /* See if there any named values for our input value */
596                 control_ui->scale_points = desc.scale_points;
597
598                 /* If this parameter is an integer, work out the number of distinct values
599                    it can take on (assuming that lower and upper values are allowed).
600                 */
601                 int const steps = desc.integer_step ? (desc.upper - desc.lower + 1) / desc.step : 0;
602
603                 if (control_ui->scale_points && ((steps && int (control_ui->scale_points->size()) == steps) || desc.enumeration)) {
604
605                         /* Either:
606                          *   a) There is a label for each possible value of this input, or
607                          *   b) This port is marked as being an enumeration.
608                          */
609
610                         std::vector<std::string> labels;
611                         for (
612                                 ARDOUR::ScalePoints::const_iterator i = control_ui->scale_points->begin();
613                                 i != control_ui->scale_points->end();
614                                 ++i) {
615
616                                 labels.push_back(i->first);
617                         }
618
619                         control_ui->combo = new Gtk::ComboBoxText();
620                         set_popdown_strings(*control_ui->combo, labels);
621                         control_ui->combo->signal_changed().connect(
622                                 sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_combo_changed),
623                                             control_ui));
624                         mcontrol->Changed.connect(control_connections, invalidator(*this),
625                                                   boost::bind(&GenericPluginUI::ui_parameter_changed,
626                                                               this, control_ui),
627                                                   gui_context());
628                         control_ui->pack_start(control_ui->label, true, true);
629                         control_ui->pack_start(*control_ui->combo, false, true);
630
631                         update_control_display(control_ui);
632
633                         return control_ui;
634                 }
635
636                 if (desc.toggled) {
637
638                         /* Build a button */
639
640                         control_ui->button = manage (new ToggleButton ());
641                         control_ui->button->set_name ("PluginEditorButton");
642                         control_ui->button->set_size_request (20, 20);
643
644                         control_ui->pack_start (control_ui->label, true, true);
645                         control_ui->pack_start (*control_ui->button, false, true);
646                         control_ui->pack_start (control_ui->automate_button, false, false);
647
648                         if (mcontrol->flags () & Controllable::NotAutomatable) {
649                                 control_ui->automate_button.set_sensitive (false);
650                                 set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
651                         } else {
652                                 control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
653                                 mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
654                         }
655
656                         control_ui->button->signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
657
658                         mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::toggle_parameter_changed, this, control_ui), gui_context());
659
660                         if (value > 0.5){
661                                 control_ui->button->set_active(true);
662                         }
663
664                         automation_state_changed (control_ui);
665
666                         return control_ui;
667                 }
668
669                 if (desc.datatype == Variant::PATH) {
670
671                         /* Build a file selector button */
672
673                         // Create/add controller
674                         control_ui->file_button = manage(new Gtk::FileChooserButton(Gtk::FILE_CHOOSER_ACTION_OPEN));
675                         control_ui->file_button->set_title(desc.label);
676
677                         control_ui->pack_start (control_ui->label, false, true);
678                         control_ui->pack_start (*control_ui->file_button, true, true);
679
680                         // Connect signals (TODO: do this via the Control)
681                         control_ui->file_button->signal_file_set().connect(
682                                 sigc::bind(sigc::mem_fun(*this, &GenericPluginUI::set_property),
683                                            desc, control_ui->file_button));
684                         plugin->PropertyChanged.connect(*this, invalidator(*this),
685                                                         boost::bind(&GenericPluginUI::property_changed, this, _1, _2),
686                                                         gui_context());
687
688                         _property_controls.insert(std::make_pair(desc.key, control_ui->file_button));
689                         control_ui->file_button = control_ui->file_button;
690
691                         return control_ui;
692                 }
693
694                 /* create the controller */
695
696                 if (mcontrol) {
697                         control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol);
698                 }
699
700                 /* XXX this code is not right yet, because it doesn't handle
701                    the absence of bounds in any sensible fashion.
702                 */
703
704                 Adjustment* adj = control_ui->controller->adjustment();
705
706                 if (desc.integer_step) {
707                         control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
708                         Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
709                         if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
710                                 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::midinote_printer), control_ui));
711                         } else {
712                                 control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
713                         }
714                 } else {
715                         //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
716
717                         control_ui->controller->set_size_request (200, req.height);
718                         control_ui->controller->set_name (X_("ProcessorControlSlider"));
719
720                 }
721
722                 adj->set_value (mcontrol->internal_to_interface(value));
723
724                 /* XXX memory leak: SliderController not destroyed by ControlUI
725                    destructor, and manage() reports object hierarchy
726                    ambiguity.
727                 */
728
729                 control_ui->pack_start (control_ui->label, true, true);
730                 if (desc.integer_step) {
731                         control_ui->pack_start (*control_ui->clickbox, false, false);
732                 } else {
733                         control_ui->pack_start (*control_ui->controller, false, false);
734                 }
735
736                 control_ui->pack_start (control_ui->automate_button, false, false);
737
738                 if (mcontrol->flags () & Controllable::NotAutomatable) {
739                         control_ui->automate_button.set_sensitive (false);
740                         set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
741                 } else {
742                         control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
743                         mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
744                 }
745
746                 automation_state_changed (control_ui);
747
748                 input_controls.push_back (control_ui);
749                 input_controls_with_automation.push_back (control_ui);
750
751         } else if (!is_input) {
752
753                 control_ui->display = manage (new EventBox);
754                 control_ui->display->set_name ("ParameterValueDisplay");
755
756                 control_ui->display_label = manage (new Label);
757
758                 control_ui->display_label->set_name ("ParameterValueDisplay");
759
760                 control_ui->display->add (*control_ui->display_label);
761                 Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->display, "-888.8g", 2, 6);
762
763                 control_ui->display->show_all ();
764
765                 control_ui->vbox = manage (new VBox);
766                 control_ui->vbox->set_spacing(3);
767
768                 if (desc.integer_step || desc.enumeration) {
769                         control_ui->vbox->pack_end (*control_ui->display, false, false);
770                         control_ui->vbox->pack_end (control_ui->label, false, false);
771                 } else {
772                         /* set up a meter for float ports */
773
774                         MeterInfo * info = new MeterInfo();
775                         control_ui->meterinfo = info;
776
777                         info->meter = new FastMeter (
778                                         5, 5, FastMeter::Vertical, 0,
779                                         0x0000aaff,
780                                         0x008800ff, 0x008800ff,
781                                         0x00ff00ff, 0x00ff00ff,
782                                         0xcccc00ff, 0xcccc00ff,
783                                         0xffaa00ff, 0xffaa00ff,
784                                         0xff0000ff,
785                                         UIConfiguration::instance().color ("meter background bottom"),
786                                         UIConfiguration::instance().color ("meter background top")
787                                         );
788
789                         info->min_unbound = desc.min_unbound;
790                         info->max_unbound = desc.max_unbound;
791
792                         info->min = desc.lower;
793                         info->max = desc.upper;
794
795                         control_ui->label.set_angle(90);
796
797                         HBox* center =  manage (new HBox);
798                         center->set_spacing(1);
799                         center->pack_start (control_ui->label, false, false);
800                         center->pack_start (*info->meter, false, false);
801
802                         control_ui->hbox = manage (new HBox);
803                         control_ui->hbox->pack_start (*center, true, false);
804
805                         // horizontally center this hbox in the vbox
806                         control_ui->vbox->pack_start (*control_ui->hbox, false, false);
807
808                         control_ui->meterinfo->meter->show_all();
809                         control_ui->meterinfo->packed = true;
810                         control_ui->vbox->pack_start (*control_ui->display, false, false);
811                 }
812
813                 control_ui->pack_start (*control_ui->vbox);
814
815                 output_controls.push_back (control_ui);
816         }
817
818         if (mcontrol) {
819                 mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::ui_parameter_changed, this, control_ui), gui_context());
820         }
821
822         return control_ui;
823 }
824
825 void
826 GenericPluginUI::astate_clicked (ControlUI* cui)
827 {
828         using namespace Menu_Helpers;
829
830         if (automation_menu == 0) {
831                 automation_menu = manage (new Menu);
832                 automation_menu->set_name ("ArdourContextMenu");
833         }
834
835         MenuList& items (automation_menu->items());
836
837         items.clear ();
838         items.push_back (MenuElem (S_("Automation|Manual"),
839                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) ARDOUR::Off, cui)));
840         items.push_back (MenuElem (_("Play"),
841                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Play, cui)));
842         items.push_back (MenuElem (_("Write"),
843                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Write, cui)));
844         items.push_back (MenuElem (_("Touch"),
845                                    sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::set_automation_state), (AutoState) Touch, cui)));
846
847         automation_menu->popup (1, gtk_get_current_event_time());
848 }
849
850 void
851 GenericPluginUI::set_all_automation (AutoState as)
852 {
853         for (vector<ControlUI*>::iterator i = input_controls_with_automation.begin(); i != input_controls_with_automation.end(); ++i) {
854                 if ((*i)->controller || (*i)->button) {
855                         set_automation_state (as, (*i));
856                 }
857         }
858 }
859
860 void
861 GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
862 {
863         insert->set_parameter_automation_state (cui->parameter(), state);
864 }
865
866 void
867 GenericPluginUI::toggle_parameter_changed (ControlUI* cui)
868 {
869         float val = cui->control->get_value();
870
871         if (!cui->ignore_change) {
872                 if (val > 0.5) {
873                         cui->button->set_active (true);
874                         cui->button->set_name ("PluginEditorButton-active");
875                 } else {
876                         cui->button->set_active (false);
877                         cui->button->set_name ("PluginEditorButton");
878                 }
879         }
880 }
881
882 void
883 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
884 {
885         if (!cui->update_pending) {
886                 cui->update_pending = true;
887                 Gtkmm2ext::UI::instance()->call_slot (MISSING_INVALIDATOR, boost::bind (&GenericPluginUI::update_control_display, this, cui));
888         }
889 }
890
891 void
892 GenericPluginUI::update_control_display (ControlUI* cui)
893 {
894         /* XXX how do we handle logarithmic stuff here ? */
895
896         cui->update_pending = false;
897
898         float val = cui->control->get_value();
899
900         cui->ignore_change++;
901
902         if (cui->combo && cui->scale_points) {
903                 for (ARDOUR::ScalePoints::iterator it = cui->scale_points->begin(); it != cui->scale_points->end(); ++it) {
904                         if (it->second == val) {
905                                 cui->combo->set_active_text(it->first);
906                                 break;
907                         }
908                 }
909         } else if (cui->button) {
910
911                 if (val > 0.5) {
912                         cui->button->set_active (true);
913                 } else {
914                         cui->button->set_active (false);
915                 }
916         }
917
918         if( cui->controller ) {
919             cui->controller->display_effective_value();
920         }
921
922
923         /*} else {
924                 if (cui->logarithmic) {
925                         val = log(val);
926                 }
927                 if (val != cui->adjustment->get_value()) {
928                         cui->adjustment->set_value (val);
929                 }
930         }*/
931         cui->ignore_change--;
932 }
933
934 void
935 GenericPluginUI::control_port_toggled (ControlUI* cui)
936 {
937         cui->ignore_change++;
938         const bool active = cui->button->get_active();
939         if (active) {
940                 cui->button->set_name ("PluginEditorButton-active");
941         } else {
942                 cui->button->set_name ("PluginEditorButton");
943         }
944         insert->automation_control (cui->parameter())->set_value (active, Controllable::NoGroup);
945         cui->ignore_change--;
946 }
947
948 void
949 GenericPluginUI::control_combo_changed (ControlUI* cui)
950 {
951         if (!cui->ignore_change && cui->scale_points) {
952                 string value = cui->combo->get_active_text();
953                 insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value], Controllable::NoGroup);
954         }
955 }
956
957 bool
958 GenericPluginUI::start_updating (GdkEventAny*)
959 {
960         if (output_controls.size() > 0 ) {
961                 screen_update_connection.disconnect();
962                 screen_update_connection = Timers::super_rapid_connect (sigc::mem_fun(*this, &GenericPluginUI::output_update));
963         }
964         return false;
965 }
966
967 bool
968 GenericPluginUI::stop_updating (GdkEventAny*)
969 {
970         for (vector<ControlUI*>::iterator i = input_controls.begin(); i != input_controls.end(); ++i) {
971                 (*i)->controller->stop_updating ();
972         }
973
974         if (output_controls.size() > 0 ) {
975                 screen_update_connection.disconnect();
976         }
977
978         return false;
979 }
980
981 void
982 GenericPluginUI::output_update ()
983 {
984         for (vector<ControlUI*>::iterator i = output_controls.begin(); i != output_controls.end(); ++i) {
985                 float val = plugin->get_parameter ((*i)->parameter().id());
986                 char buf[32];
987                 snprintf (buf, sizeof(buf), "%.2f", val);
988                 (*i)->display_label->set_text (buf);
989
990                 /* autoscaling for the meter */
991                 if ((*i)->meterinfo && (*i)->meterinfo->packed) {
992
993                         if (val < (*i)->meterinfo->min) {
994                                 if ((*i)->meterinfo->min_unbound)
995                                         (*i)->meterinfo->min = val;
996                                 else
997                                         val = (*i)->meterinfo->min;
998                         }
999
1000                         if (val > (*i)->meterinfo->max) {
1001                                 if ((*i)->meterinfo->max_unbound)
1002                                         (*i)->meterinfo->max = val;
1003                                 else
1004                                         val = (*i)->meterinfo->max;
1005                         }
1006
1007                         if ((*i)->meterinfo->max > (*i)->meterinfo->min ) {
1008                                 float lval = (val - (*i)->meterinfo->min) / ((*i)->meterinfo->max - (*i)->meterinfo->min) ;
1009                                 (*i)->meterinfo->meter->set (lval );
1010                         }
1011                 }
1012         }
1013 }
1014
1015 void
1016 GenericPluginUI::set_property (const ParameterDescriptor& desc,
1017                                Gtk::FileChooserButton*    widget)
1018 {
1019         plugin->set_property(desc.key, Variant(Variant::PATH, widget->get_filename()));
1020 }
1021
1022 void
1023 GenericPluginUI::property_changed (uint32_t key, const Variant& value)
1024 {
1025         PropertyControls::iterator c = _property_controls.find(key);
1026         if (c != _property_controls.end()) {
1027                 c->second->set_filename(value.get_path());
1028         } else {
1029                 std::cerr << "warning: property change for property with no control" << std::endl;
1030         }
1031 }