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