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