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