rename all GTK signals
[ardour.git] / gtk2_ardour / gain_meter.cc
1 /*
2   Copyright (C) 2002 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   $Id$
19 */
20
21 #include <limits.h>
22
23 #include <ardour/io.h>
24 #include <ardour/route.h>
25 #include <ardour/route_group.h>
26 #include <ardour/session.h>
27 #include <ardour/session_route.h>
28 #include <ardour/dB.h>
29
30 #include <gtkmm2ext/utils.h>
31 #include <gtkmm2ext/pix.h>
32 #include <gtkmm2ext/fastmeter.h>
33 #include <gtkmm2ext/stop_signal.h>
34 #include <gtkmm2ext/barcontroller.h>
35 #include <midi++/manager.h>
36 #include <pbd/fastlog.h>
37
38 #include "ardour_ui.h"
39 #include "gain_meter.h"
40 #include "utils.h"
41 #include "logmeter.h"
42 #include "gui_thread.h"
43
44 #include <ardour/session.h>
45 #include <ardour/route.h>
46
47 #include "i18n.h"
48 #include "misc_xpms"
49
50 using namespace ARDOUR;
51 using namespace Gtkmm2ext;
52 using namespace Gtk;
53 using namespace sigc;
54
55 Signal0<void> GainMeter::ResetAllPeakDisplays;
56 Signal1<void,RouteGroup*> GainMeter::ResetGroupPeakDisplays;
57 Pix* GainMeter::slider_pix = 0;
58
59 int
60 GainMeter::setup_slider_pix ()
61 {
62         vector<const char **> xpms;
63
64         xpms.push_back (vslider_rail_xpm);
65         xpms.push_back (vslider_slider_xpm);
66
67         if ((slider_pix = get_pix ("sliders", xpms, false)) == 0) {
68                 error << _("Cannot create slider pixmaps") << endmsg;
69                 return -1;
70         }
71
72         slider_pix->ref ();
73         return 0;
74 }
75
76 GainMeter::GainMeter (IO& io, Session& s)
77         : _io (io),
78           _session (s),
79           gain_slider (0),
80           // 0.781787 is the value needed for gain to be set to 0.
81           gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
82           gain_display (&gain_adjustment, "MixerStripGainDisplay"),
83           gain_unit_label (_("dbFS")),
84           meter_point_label (_("pre")),
85           top_table (1, 2)
86         
87 {
88         if (slider_pix == 0) {
89                 setup_slider_pix ();
90         }
91
92         ignore_toggle = false;
93         meter_menu = 0;
94         
95         gain_slider = manage (new VSliderController (slider_pix,
96                                                      &gain_adjustment,
97                                                      & _io.midi_gain_control(),
98                                                      false));
99
100         gain_slider->signal_button_press_event.connect (mem_fun(*this, &GainMeter::start_gain_touch));
101         gain_slider->signal_button_release_event.connect (mem_fun(*this, &GainMeter::end_gain_touch));
102         gain_slider->set_name ("MixerGainMeter");
103
104         if (_session.midi_port()) {
105                 _io.set_midi_to_gain_function (slider_position_to_gain);
106                 _io.set_gain_to_midi_function (gain_to_slider_position);
107         }
108
109         gain_display.set_print_func (_gain_printer, this);
110         set_size_request_to_display_given_text (gain_display, "-86.0", 2, 2);
111
112         gain_unit_button.add (gain_unit_label);
113         gain_unit_button.set_name ("MixerStripGainUnitButton");
114         gain_unit_label.set_name ("MixerStripGainUnitButton");
115
116         top_table.set_col_spacings (2);
117         top_table.set_homogeneous (true);
118         top_table.attach (gain_unit_button, 0, 1, 0, 1);
119
120         Route* r;
121
122         if ((r = dynamic_cast<Route*> (&_io)) != 0) {
123                 r->meter_change.connect (mem_fun(*this, &GainMeter::meter_changed));
124                 meter_point_button.add (meter_point_label);
125                 meter_point_button.set_name ("MixerStripMeterPreButton");
126                 meter_point_label.set_name ("MixerStripMeterPreButton");
127                 
128                 switch (r->meter_point()) {
129                 case MeterInput:
130                         meter_point_label.set_text (_("input"));
131                         break;
132                         
133                 case MeterPreFader:
134                         meter_point_label.set_text (_("pre"));
135                         break;
136                         
137                 case MeterPostFader:
138                         meter_point_label.set_text (_("post"));
139                         break;
140                 }
141                 
142                 /* TRANSLATORS: this string should be longest of the strings
143                    used to describe meter points. In english, its "input".
144                 */
145                 
146                 set_size_request_to_display_given_text (meter_point_button, _("tupni"), 2, 2);
147
148                 meter_point_button.signal_button_press_event.connect (mem_fun(*this, &GainMeter::meter_press));
149                 meter_point_button.signal_button_release_event.connect (mem_fun(*this, &GainMeter::meter_release));
150
151                 top_table.attach (meter_point_button, 1, 2, 0, 1);
152         }
153
154         gain_display_box.set_spacing (2);
155         gain_display_frame.set_shadow_type (Gtk::SHADOW_IN);
156         gain_display_frame.set_name ("BaseFrame");
157         gain_display_frame.add (gain_display);
158         gain_display_box.pack_start (gain_display_frame, false, false);
159
160         peak_display.set_name ("MixerStripPeakDisplay");
161         set_size_request_to_display_given_text (peak_display, "-86.0", 2, 2);
162         peak_display.add (peak_display_label);
163         peak_display_frame.set_shadow_type (Gtk::SHADOW_IN);
164         peak_display_frame.set_name ("BaseFrame");
165         peak_display_frame.add (peak_display);
166         max_peak = minus_infinity();
167         peak_display_label.set_text (_("-inf"));
168         
169         gain_display_box.pack_start (peak_display_frame, false, false);
170
171
172         meter_metric_area.set_size_request (18, -1);
173         meter_metric_area.set_name ("MeterMetricsStrip");
174
175         meter_packer.show ();
176         gain_slider->show_all ();
177
178         meter_packer.set_spacing (2);
179         fader_box.set_spacing (2);
180
181         fader_box.pack_start (*gain_slider, false, false);
182
183         hbox.set_spacing (4);
184         hbox.pack_start (fader_box, false, false);
185         hbox.pack_start (meter_packer, false, false);
186
187         set_spacing (4);
188         pack_start (top_table, false, false);
189         pack_start (gain_display_box, false, false);
190         pack_start (hbox, false, false);
191
192         show_all ();
193
194         _io.gain_changed.connect (mem_fun(*this, &GainMeter::gain_changed));
195
196         meter_metric_area.signal_expose_event.connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
197         gain_adjustment.value_changed.connect (mem_fun(*this, &GainMeter::gain_adjusted));
198         peak_display.signal_button_release_event.connect (mem_fun(*this, &GainMeter::peak_button_release));
199
200         _session.MeterHoldChanged.connect (mem_fun(*this, &GainMeter::meter_hold_changed));
201         
202         gain_changed (0);
203         update_gain_sensitive ();
204
205         ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_peak_display));
206         ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_group_peak_display));
207 }
208
209 void
210 GainMeter::set_width (Width w)
211 {
212         switch (w) {
213         case Wide:
214                 peak_display_frame.show_all();
215                 break;
216         case Narrow:
217                 peak_display_frame.hide_all();
218                 break;
219         }
220
221         _width = w;
222         setup_meters ();
223 }
224
225 gint
226 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
227 {
228         /* XXX optimize this so that it doesn't do it all everytime */
229
230         double fraction;
231
232         Gdk_Window win (meter_metric_area.get_window());
233         Gdk_GC fg_gc (meter_metric_area.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
234         Gdk_GC bg_gc (meter_metric_area.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
235         Gdk_Font font (meter_metric_area.get_style()->get_font());
236         gint x, y, width, height, depth;
237         gint pos;
238         int  db_points[] = { -50, -10, -3, 0, 6 };
239         uint32_t i;
240         char buf[32];
241         GdkRectangle base_rect;
242         GdkRectangle draw_rect;
243
244         win.get_geometry (x, y, width, height, depth);
245         
246         base_rect.width = width;
247         base_rect.height = height;
248         base_rect.x = 0;
249         base_rect.y = 0;
250
251         gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
252         win.draw_rectangle (bg_gc, true, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
253
254         for (i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
255                 fraction = log_meter (db_points[i]);
256                 pos = height - (gint) floor (height * fraction);
257
258                 snprintf (buf, sizeof (buf), "%d", db_points[i]);
259
260                 gint twidth;
261                 gint lbearing;
262                 gint rbearing;
263                 gint ascent;
264                 gint descent;
265
266                 gdk_string_extents (font,
267                                     buf,
268                                     &lbearing,
269                                     &rbearing,
270                                     &twidth,
271                                     &ascent,
272                                     &descent);
273
274                 win.draw_text (font, fg_gc, width - twidth, pos + ascent, buf, strlen (buf));
275         }
276
277         return TRUE;
278 }
279
280 GainMeter::~GainMeter ()
281 {
282
283         if (meter_menu) {
284                 delete meter_menu;
285         }
286
287         for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
288                 if ((*i).meter) {
289                         delete (*i).meter;
290                 }
291         }
292 }
293
294 void
295 GainMeter::update_meters ()
296 {
297         vector<MeterInfo>::iterator i;
298         uint32_t n;
299         float peak;
300         char buf[32];
301
302         
303         for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
304                 if ((*i).packed) {
305                         peak = _io.peak_input_power (n);
306
307                         if (_session.meter_falloff() == 0.0f || peak > (*i).meter->get_user_level()) {
308                                 (*i).meter->set (log_meter (peak), peak);
309                         }
310
311                         if (peak > max_peak) {
312                                 max_peak = peak;
313                                 /* set peak display */
314                                 snprintf (buf, sizeof(buf), "%.1f", max_peak);
315                                 peak_display_label.set_text (buf);
316
317                                 if (max_peak >= 0.0f) {
318                                         peak_display.set_name ("MixerStripPeakDisplayPeak");
319                                 }
320                         }
321                 }
322         }
323
324 }
325
326 void
327 GainMeter::update_meters_falloff ()
328 {
329         vector<MeterInfo>::iterator i;
330         uint32_t n;
331         float dbpeak;
332         
333         for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
334                 if ((*i).packed) {
335                         // just do falloff
336                         //peak = (*i).meter->get_level() * _falloff_rate;
337                         dbpeak = (*i).meter->get_user_level() - _session.meter_falloff();
338
339                         dbpeak = std::max(dbpeak, -200.0f);
340                         
341                         // cerr << "tmplevel: " << tmplevel << endl;
342                         (*i).meter->set (log_meter (dbpeak), dbpeak);
343                 }
344         }
345         
346 }
347
348
349 void
350 GainMeter::meter_hold_changed()
351 {
352         ENSURE_GUI_THREAD(mem_fun(*this, &GainMeter::meter_hold_changed));
353         
354         vector<MeterInfo>::iterator i;
355         uint32_t n;
356         
357         for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
358                 
359                 (*i).meter->set_hold_count ((uint32_t) floor(_session.meter_hold()));
360         }
361 }
362
363 void
364 GainMeter::hide_all_meters ()
365 {
366         bool remove_metric_area = false;
367
368         for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); ++i) {
369                 if ((*i).packed) {
370                         remove_metric_area = true;
371                         meter_packer.remove (*((*i).meter));
372                         (*i).packed = false;
373                 }
374         }
375
376         if (remove_metric_area) {
377                 if (meter_metric_area.get_parent()) {
378                         meter_packer.remove (meter_metric_area);
379                 }
380         }
381 }
382
383 void
384 GainMeter::setup_meters ()
385 {
386         uint32_t nmeters = _io.n_outputs();
387         guint16 width;
388
389         hide_all_meters ();
390
391         Route* r;
392
393         if ((r = dynamic_cast<Route*> (&_io)) != 0) {
394
395                 switch (r->meter_point()) {
396                 case MeterPreFader:
397                 case MeterInput:
398                         nmeters = r->n_inputs();
399                         break;
400                 case MeterPostFader:
401                         nmeters = r->n_outputs();
402                         break;
403                 }
404
405         } else {
406
407                 nmeters = _io.n_outputs();
408
409         }
410
411         if (nmeters == 0) {
412                 return;
413         }
414
415         if (_width == Wide) {
416                 meter_packer.pack_start (meter_metric_area, false, false);
417                 meter_metric_area.show_all ();
418         }
419
420         if (nmeters <= 2) {
421                 width = regular_meter_width;
422         } else {
423                 width = thin_meter_width;
424         }
425
426         while (meters.size() < nmeters) {
427                 meters.push_back (MeterInfo());
428         }
429
430         for (uint32_t n = 0; n < nmeters; ++n) {
431                 if (meters[n].width != width) {
432                         delete meters[n].meter;
433                         meters[n].meter = new FastMeter ((uint32_t) floor (_session.meter_hold()), width, FastMeter::Vertical);
434                         meters[n].width = width;
435
436                         meters[n].meter->signal_add_events (Gdk::BUTTON_RELEASE_MASK);
437                         meters[n].meter->signal_button_release_event.connect
438                                 (bind (mem_fun(*this, &GainMeter::meter_button_release), n));
439                         meters[n].meter->signal_button_release_event.connect_after (ptr_fun (do_not_propagate));
440                 }
441
442                 meter_packer.pack_start (*meters[n].meter, false, false);
443                 meters[n].meter->show_all ();
444                 meters[n].packed = true;
445         }
446 }       
447
448 gint
449 GainMeter::peak_button_release (GdkEventButton* ev)
450 {
451         /* reset peak label */
452
453         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control|Keyboard::Shift)) {
454                 ResetAllPeakDisplays ();
455         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
456                 Route* r;
457                 if ((r = dynamic_cast<Route*> (&_io)) != 0) {
458                         ResetGroupPeakDisplays (r->mix_group());
459                 }
460         } else {
461                 reset_peak_display ();
462         }
463         return TRUE;
464 }
465
466 void
467 GainMeter::reset_peak_display ()
468 {
469         max_peak = minus_infinity();
470         peak_display_label.set_text (_("-inf"));
471         peak_display.set_name ("MixerStripPeakDisplay");
472 }
473
474 void
475 GainMeter::reset_group_peak_display (RouteGroup* group)
476 {
477         Route* r;
478         if ((r = dynamic_cast<Route*> (&_io)) != 0) {
479                 if (group == r->mix_group()) {
480                         reset_peak_display ();
481                 }
482         }
483 }
484
485 gint
486 GainMeter::meter_button_release (GdkEventButton* ev, uint32_t which)
487 {
488         switch (ev->button) {
489         case 1:
490                 meters[which].meter->clear();
491                 max_peak = minus_infinity();
492                 peak_display_label.set_text (_("-inf"));
493                 peak_display.set_name ("MixerStripPeakDisplay");
494                 break;
495
496         case 3:
497                 // popup_meter_menu (ev);
498                 break;
499         };
500
501         return TRUE;
502 }
503
504 void
505 GainMeter::popup_meter_menu (GdkEventButton *ev)
506 {
507         using namespace Menu_Helpers;
508
509         if (meter_menu == 0) {
510                 meter_menu = new Gtk::Menu;
511                 MenuList& items = meter_menu->items();
512
513                 items.push_back (MenuElem ("-inf .. +0dBFS"));
514                 items.push_back (MenuElem ("-10dB .. +0dBFS"));
515                 items.push_back (MenuElem ("-4 .. +0dBFS"));
516                 items.push_back (SeparatorElem());
517                 items.push_back (MenuElem ("-inf .. -2dBFS"));
518                 items.push_back (MenuElem ("-10dB .. -2dBFS"));
519                 items.push_back (MenuElem ("-4 .. -2dBFS"));
520         }
521
522         meter_menu->popup (1, ev->time);
523 }
524
525 void
526 GainMeter::_gain_printer (char buf[32], Gtk::Adjustment& adj, void *arg)
527 {
528         static_cast<GainMeter *>(arg)->gain_printer (buf, adj);
529 }
530
531 void
532 GainMeter::gain_printer (char buf[32], Gtk::Adjustment& adj)
533 {
534         float v = adj.get_value();
535
536         if (v == 0.0) {
537                 strcpy (buf, _("-inf"));
538         } else {
539                 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
540         }
541 }
542
543 void
544 GainMeter::gain_adjusted ()
545 {
546         if (!ignore_toggle) {
547                 _io.set_gain (slider_position_to_gain (gain_adjustment.get_value()), this);
548         }
549 }
550
551 void
552 GainMeter::effective_gain_display ()
553 {
554         gfloat value = gain_to_slider_position (_io.effective_gain());
555         
556         if (gain_adjustment.get_value() != value) {
557                 ignore_toggle = true;
558                 gain_adjustment.set_value (value);
559                 ignore_toggle = false;
560         }
561 }
562
563 void
564 GainMeter::gain_changed (void *src)
565 {
566         Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeter::effective_gain_display));
567 }
568
569 gint
570 GainMeter::entry_focus_event (GdkEventFocus* ev)
571 {
572         if (ev->in) {
573                 ARDOUR_UI::instance()->allow_focus (true);
574         } else {
575                 ARDOUR_UI::instance()->allow_focus (false);
576         }
577         return TRUE;
578 }
579
580
581 void
582 GainMeter::set_meter_strip_name (string name)
583 {
584         meter_metric_area.set_name (name);
585 }
586
587 void
588 GainMeter::set_fader_name (string name)
589 {
590         gain_slider->set_name (name);
591 }
592
593 void
594 GainMeter::update_gain_sensitive ()
595 {
596         static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (!(_io.gain_automation_state() & Play));
597 }
598
599
600 static MeterPoint
601 next_meter_point (MeterPoint mp)
602 {
603         switch (mp) {
604         case MeterInput:
605                 return MeterPreFader;
606                 break;
607                 
608         case MeterPreFader:
609                 return MeterPostFader;
610                 break;
611                 
612         case MeterPostFader:
613                 return MeterInput;
614                 break;
615         }
616         /*NOTREACHED*/
617         return MeterInput;
618 }
619
620 gint
621 GainMeter::meter_press(GdkEventButton* ev)
622 {
623         Route* _route;
624
625         wait_for_release = false;
626
627         if ((_route = dynamic_cast<Route*>(&_io)) == 0) {
628                 return FALSE;
629         }
630
631         if (!ignore_toggle) {
632
633                 if (Keyboard::is_context_menu_event (ev)) {
634                         
635                         // no menu at this time.
636
637                 } else {
638
639                         if (ev->button == 2) {
640
641                                 // ctrl-button2 click is the midi binding click
642                                 // button2-click is "momentary"
643                                 
644                                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control))) {
645                                         wait_for_release = true;
646                                         old_meter_point = _route->meter_point ();
647                                 }
648                         }
649
650                         if (ev->button == 1 || ev->button == 2) {
651
652                                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control|Keyboard::Shift))) {
653
654                                         /* ctrl-shift-click applies change to all routes */
655
656                                         _session.foreach_route (this, &GainMeter::set_meter_point, next_meter_point (_route->meter_point()));
657                                         
658                                 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
659
660                                         /* ctrl-click: solo mix group.
661                                            ctrl-button2 is MIDI learn.
662                                         */
663                                         
664                                         if (ev->button == 1) {
665                                                 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
666                                         }
667                                         
668                                 } else {
669                                         
670                                         /* click: solo this route */
671                                         
672                                         _route->set_meter_point (next_meter_point (_route->meter_point()), this);
673                                 }
674                         }
675                 }
676         }
677
678         return stop_signal (meter_point_button, "button-press-event");
679
680 }
681
682 gint
683 GainMeter::meter_release(GdkEventButton* ev)
684 {
685         if(!ignore_toggle){
686                 if (wait_for_release){
687                         wait_for_release = false;
688                         set_meter_point (*(dynamic_cast<Route*>(&_io)), old_meter_point);
689                         stop_signal (meter_point_button, "button-release-event");
690                 }
691         }
692         return TRUE;
693 }
694
695 void
696 GainMeter::set_meter_point (Route& route, MeterPoint mp)
697 {
698         route.set_meter_point (mp, this);
699 }
700
701 void
702 GainMeter::set_mix_group_meter_point (Route& route, MeterPoint mp)
703 {
704         RouteGroup* mix_group;
705
706         if((mix_group = route.mix_group()) != 0){
707                 mix_group->apply (&Route::set_meter_point, mp, this);
708         } else {
709                 route.set_meter_point (mp, this);
710         }
711 }
712
713 void
714 GainMeter::meter_changed (void *src)
715 {
716         Route* r;
717
718         ENSURE_GUI_THREAD (bind (mem_fun(*this, &GainMeter::meter_changed), src));
719
720         if ((r = dynamic_cast<Route*> (&_io)) != 0) {
721
722                 switch (r->meter_point()) {
723                 case MeterInput:
724                         meter_point_label.set_text (_("input"));
725                         break;
726                         
727                 case MeterPreFader:
728                         meter_point_label.set_text (_("pre"));
729                         break;
730                         
731                 case MeterPostFader:
732                         meter_point_label.set_text (_("post"));
733                         break;
734                 }
735
736                 setup_meters ();
737         }
738 }
739
740 void
741 GainMeter::meter_point_clicked ()
742 {
743         Route* r;
744
745         if ((r = dynamic_cast<Route*> (&_io)) != 0) {
746
747         }
748 }
749
750 gint
751 GainMeter::start_gain_touch (GdkEventButton* ev)
752 {
753         _io.start_gain_touch ();
754         return FALSE;
755 }
756
757 gint
758 GainMeter::end_gain_touch (GdkEventButton* ev)
759 {
760         _io.end_gain_touch ();
761         return FALSE;
762 }