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