enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / gtk2_ardour / level_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 */
19
20 #include <limits.h>
21
22 #include "ardour/meter.h"
23
24 #include <gtkmm2ext/utils.h>
25 #include "pbd/fastlog.h"
26
27 #include "level_meter.h"
28 #include "utils.h"
29 #include "logmeter.h"
30 #include "gui_thread.h"
31 #include "keyboard.h"
32 #include "public_editor.h"
33 #include "ui_config.h"
34
35 #include "pbd/i18n.h"
36
37 using namespace ARDOUR;
38 using namespace ARDOUR_UI_UTILS;
39 using namespace PBD;
40 using namespace Gtkmm2ext;
41 using namespace Gtk;
42 using namespace std;
43
44 LevelMeterBase::LevelMeterBase (Session* s, PBD::EventLoop::InvalidationRecord* ir, FastMeter::Orientation o)
45         : parent_invalidator(ir)
46         , _meter (0)
47         , _meter_orientation(o)
48         , regular_meter_width (6)
49         , meter_length (0)
50         , thin_meter_width(2)
51         , max_peak (minus_infinity())
52         , meter_type (MeterPeak)
53         , visible_meter_type (MeterType(0))
54         , meter_count (0)
55         , max_visible_meters (0)
56         , color_changed (false)
57 {
58         set_session (s);
59
60         Config->ParameterChanged.connect (_parameter_connection, parent_invalidator, boost::bind (&LevelMeterBase::parameter_changed, this, _1), gui_context());
61         UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun(*this, &LevelMeterBase::parameter_changed));
62         UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &LevelMeterBase::color_handler));
63 }
64
65 LevelMeterBase::~LevelMeterBase ()
66 {
67         _configuration_connection.disconnect();
68         _meter_type_connection.disconnect();
69         _parameter_connection.disconnect();
70         for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
71                 delete (*i).meter;
72         }
73         meters.clear();
74 }
75
76 void
77 LevelMeterBase::set_meter (PeakMeter* meter)
78 {
79         _configuration_connection.disconnect();
80         _meter_type_connection.disconnect();
81
82         _meter = meter;
83         color_changed = true; // force update
84
85         if (_meter) {
86                 _meter->ConfigurationChanged.connect (_configuration_connection, parent_invalidator, boost::bind (&LevelMeterBase::configuration_changed, this, _1, _2), gui_context());
87                 _meter->TypeChanged.connect (_meter_type_connection, parent_invalidator, boost::bind (&LevelMeterBase::meter_type_changed, this, _1), gui_context());
88         }
89 }
90
91 static float meter_lineup_cfg(MeterLineUp lul, float offset) {
92         switch (lul) {
93                 case MeteringLineUp24:
94                         return offset + 6.0;
95                 case MeteringLineUp20:
96                         return offset + 2.0;
97                 case MeteringLineUp18:
98                         return offset;
99                 case MeteringLineUp15:
100                         return offset - 3.0;
101                 default:
102                         break;
103         }
104         return offset;
105 }
106
107 static float meter_lineup(float offset) {
108         return meter_lineup_cfg (UIConfiguration::instance().get_meter_line_up_level(), offset);
109 }
110
111 static float vu_standard() {
112         // note - default meter config is +2dB (france)
113         switch (UIConfiguration::instance().get_meter_vu_standard()) {
114                 default:
115                 case MeteringVUfrench:   // 0VU = -2dBu
116                         return 0;
117                 case MeteringVUamerican: // 0VU =  0dBu
118                         return -2;
119                 case MeteringVUstandard: // 0VU = +4dBu
120                         return -6;
121                 case MeteringVUeight:    // 0VU = +8dBu
122                         return -10;
123         }
124 }
125
126 float
127 LevelMeterBase::update_meters ()
128 {
129         vector<MeterInfo>::iterator i;
130         uint32_t n;
131
132         if (!_meter) {
133                 return 0.0f;
134         }
135
136         uint32_t nmidi = _meter->input_streams().n_midi();
137
138         for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
139                 if ((*i).packed) {
140                         const float mpeak = _meter->meter_level(n, MeterMaxPeak);
141                         if (mpeak > (*i).max_peak) {
142                                 (*i).max_peak = mpeak;
143                                 (*i).meter->set_highlight(mpeak >= UIConfiguration::instance().get_meter_peak());
144                         }
145                         if (mpeak > max_peak) {
146                                 max_peak = mpeak;
147                         }
148
149                         if (n < nmidi) {
150                                 (*i).meter->set (_meter->meter_level (n, MeterPeak));
151                         } else {
152                                 const float peak = _meter->meter_level (n, meter_type);
153                                 if (meter_type == MeterPeak) {
154                                         (*i).meter->set (log_meter (peak));
155                                 } else if (meter_type == MeterPeak0dB) {
156                                         (*i).meter->set (log_meter0dB (peak));
157                                 } else if (meter_type == MeterIEC1NOR) {
158                                         (*i).meter->set (meter_deflect_nordic (peak + meter_lineup(0)));
159                                 } else if (meter_type == MeterIEC1DIN) {
160                                         (*i).meter->set (meter_deflect_din (peak + meter_lineup_cfg(UIConfiguration::instance().get_meter_line_up_din(), 3.0)));
161                                 } else if (meter_type == MeterIEC2BBC || meter_type == MeterIEC2EBU) {
162                                         (*i).meter->set (meter_deflect_ppm (peak + meter_lineup(0)));
163                                 } else if (meter_type == MeterVU) {
164                                         (*i).meter->set (meter_deflect_vu (peak + vu_standard() + meter_lineup(0)));
165                                 } else if (meter_type == MeterK12) {
166                                         (*i).meter->set (meter_deflect_k (peak, 12), meter_deflect_k(_meter->meter_level(n, MeterPeak), 12));
167                                 } else if (meter_type == MeterK14) {
168                                         (*i).meter->set (meter_deflect_k (peak, 14), meter_deflect_k(_meter->meter_level(n, MeterPeak), 14));
169                                 } else if (meter_type == MeterK20) {
170                                         (*i).meter->set (meter_deflect_k (peak, 20), meter_deflect_k(_meter->meter_level(n, MeterPeak), 20));
171                                 } else { // RMS
172                                         (*i).meter->set (log_meter (peak), log_meter(_meter->meter_level(n, MeterPeak)));
173                                 }
174                         }
175                 }
176         }
177         return max_peak;
178 }
179
180 void
181 LevelMeterBase::parameter_changed (string p)
182 {
183         ENSURE_GUI_THREAD (*this, &LevelMeterBase::parameter_changed, p)
184
185         if (p == "meter-hold") {
186                 vector<MeterInfo>::iterator i;
187                 uint32_t n;
188
189                 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
190                         (*i).meter->set_hold_count ((uint32_t) floor(UIConfiguration::instance().get_meter_hold()));
191                 }
192         }
193         else if (p == "meter-line-up-level") {
194                 color_changed = true;
195                 setup_meters (meter_length, regular_meter_width, thin_meter_width);
196         }
197         else if (p == "meter-style-led") {
198                 color_changed = true;
199                 setup_meters (meter_length, regular_meter_width, thin_meter_width);
200         }
201         else if (p == "meter-peak") {
202                 vector<MeterInfo>::iterator i;
203                 uint32_t n;
204
205                 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
206                         (*i).max_peak = minus_infinity();
207                 }
208         }
209 }
210
211 void
212 LevelMeterBase::configuration_changed (ChanCount /*in*/, ChanCount /*out*/)
213 {
214         setup_meters (meter_length, regular_meter_width, thin_meter_width);
215 }
216
217 void
218 LevelMeterBase::meter_type_changed (MeterType t)
219 {
220         meter_type = t;
221         setup_meters (meter_length, regular_meter_width, thin_meter_width);
222         MeterTypeChanged(t);
223 }
224
225 void
226 LevelMeterBase::hide_all_meters ()
227 {
228         for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); ++i) {
229                 if ((*i).packed) {
230                         mtr_remove (*((*i).meter));
231                         (*i).packed = false;
232                 }
233         }
234         meter_count = 0;
235 }
236
237 void
238 LevelMeterBase::set_max_audio_meter_count (uint32_t cnt)
239 {
240         if (cnt == max_visible_meters) {
241                 return;
242         }
243         color_changed = true; // force re-setup
244         max_visible_meters = cnt;
245         setup_meters (meter_length, regular_meter_width, thin_meter_width);
246 }
247
248 void
249 LevelMeterBase::setup_meters (int len, int initial_width, int thin_width)
250 {
251
252         if (!_meter) {
253                 hide_all_meters ();
254                 return; /* do it later or never */
255         }
256
257         int32_t nmidi = _meter->input_streams().n_midi();
258         uint32_t nmeters = _meter->input_streams().n_total();
259         regular_meter_width = initial_width;
260         thin_meter_width = thin_width;
261         meter_length = len;
262
263         guint16 width;
264
265         if (nmeters == 0) {
266                 hide_all_meters ();
267                 return;
268         }
269
270         if (nmeters <= 2) {
271                 width = regular_meter_width;
272         } else {
273                 width = thin_meter_width;
274         }
275
276         width = rint (width * UIConfiguration::instance().get_ui_scale());
277
278         if (   meters.size() > 0
279             && nmeters == meter_count
280             && meters[0].width == width
281             && meters[0].length == len
282             && !color_changed
283             && meter_type == visible_meter_type) {
284                 return;
285         }
286
287 #if 0
288         printf("Meter redraw: %s %s %s %s %s %s\n",
289                         (meters.size() > 0) ? "yes" : "no",
290                         (meters.size() > 0 &&  meters[0].width == width) ? "yes" : "no",
291                         (meters.size() > 0 &&  meters[0].length == len) ? "yes" : "no",
292                         (nmeters == meter_count) ? "yes" : "no",
293                         (meter_type == visible_meter_type) ? "yes" : "no",
294                         !color_changed ? "yes" : "no"
295                         );
296 #endif
297
298         hide_all_meters ();
299         while (meters.size() < nmeters) {
300                 meters.push_back (MeterInfo());
301         }
302
303         //cerr << "LevelMeterBase::setup_meters() called color_changed = " << color_changed << " colors: " << endl;//DEBUG
304
305         for (int32_t n = nmeters-1; nmeters && n >= 0 ; --n) {
306                 uint32_t c[10];
307                 uint32_t b[4];
308                 float stp[4];
309                 int styleflags = UIConfiguration::instance().get_meter_style_led() ? 3 : 1;
310                 b[0] = UIConfiguration::instance().color ("meter background bottom");
311                 b[1] = UIConfiguration::instance().color ("meter background top");
312                 b[2] = 0x991122ff; // red highlight gradient Bot
313                 b[3] = 0x551111ff; // red highlight gradient Top
314                 if (n < nmidi) {
315                         c[0] = UIConfiguration::instance().color ("midi meter color0");
316                         c[1] = UIConfiguration::instance().color ("midi meter color1");
317                         c[2] = UIConfiguration::instance().color ("midi meter color2");
318                         c[3] = UIConfiguration::instance().color ("midi meter color3");
319                         c[4] = UIConfiguration::instance().color ("midi meter color4");
320                         c[5] = UIConfiguration::instance().color ("midi meter color5");
321                         c[6] = UIConfiguration::instance().color ("midi meter color6");
322                         c[7] = UIConfiguration::instance().color ("midi meter color7");
323                         c[8] = UIConfiguration::instance().color ("midi meter color8");
324                         c[9] = UIConfiguration::instance().color ("midi meter color9");
325                         stp[0] = 115.0 *  32.0 / 128.0;
326                         stp[1] = 115.0 *  64.0 / 128.0;
327                         stp[2] = 115.0 * 100.0 / 128.0;
328                         stp[3] = 115.0 * 112.0 / 128.0;
329                 } else {
330                         c[0] = UIConfiguration::instance().color ("meter color0");
331                         c[1] = UIConfiguration::instance().color ("meter color1");
332                         c[2] = UIConfiguration::instance().color ("meter color2");
333                         c[3] = UIConfiguration::instance().color ("meter color3");
334                         c[4] = UIConfiguration::instance().color ("meter color4");
335                         c[5] = UIConfiguration::instance().color ("meter color5");
336                         c[6] = UIConfiguration::instance().color ("meter color6");
337                         c[7] = UIConfiguration::instance().color ("meter color7");
338                         c[8] = UIConfiguration::instance().color ("meter color8");
339                         c[9] = UIConfiguration::instance().color ("meter color9");
340
341                         switch (meter_type) {
342                                 case MeterK20:
343                                         stp[0] = 115.0 * meter_deflect_k(-40, 20);  //-20
344                                         stp[1] = 115.0 * meter_deflect_k(-20, 20);  //  0
345                                         stp[2] = 115.0 * meter_deflect_k(-18, 20);  // +2
346                                         stp[3] = 115.0 * meter_deflect_k(-16, 20);  // +4
347                                         c[0] = c[1] = 0x008800ff;
348                                         c[2] = c[3] = 0x00ff00ff;
349                                         c[4] = c[5] = 0xffff00ff;
350                                         c[6] = c[7] = 0xffff00ff;
351                                         c[8] = c[9] = 0xff0000ff;
352                                         break;
353                                 case MeterK14:
354                                         stp[0] = 115.0 * meter_deflect_k(-34, 14);  //-20
355                                         stp[1] = 115.0 * meter_deflect_k(-14, 14);  //  0
356                                         stp[2] = 115.0 * meter_deflect_k(-12, 14);  // +2
357                                         stp[3] = 115.0 * meter_deflect_k(-10, 14);  // +4
358                                         c[0] = c[1] = 0x008800ff;
359                                         c[2] = c[3] = 0x00ff00ff;
360                                         c[4] = c[5] = 0xffff00ff;
361                                         c[6] = c[7] = 0xffff00ff;
362                                         c[8] = c[9] = 0xff0000ff;
363                                         break;
364                                 case MeterK12:
365                                         stp[0] = 115.0 * meter_deflect_k(-32, 12);  //-20
366                                         stp[1] = 115.0 * meter_deflect_k(-12, 12);  //  0
367                                         stp[2] = 115.0 * meter_deflect_k(-10, 12);  // +2
368                                         stp[3] = 115.0 * meter_deflect_k( -8, 12);  // +4
369                                         c[0] = c[1] = 0x008800ff;
370                                         c[2] = c[3] = 0x00ff00ff;
371                                         c[4] = c[5] = 0xffff00ff;
372                                         c[6] = c[7] = 0xffff00ff;
373                                         c[8] = c[9] = 0xff0000ff;
374                                         break;
375                                 case MeterIEC2BBC:
376                                         c[0] = c[1] = c[2] = c[3] = c[4] = c[5] = c[6] = c[7] = c[8] = c[9] =
377                                                 UIConfiguration::instance().color ("meter color BBC");
378                                         stp[0] = stp[1] = stp[2] = stp[3] = 115.0;
379                                         break;
380                                 case MeterIEC2EBU:
381                                         stp[0] = 115.0 * meter_deflect_ppm(-24); // ignored
382                                         stp[1] = 115.0 * meter_deflect_ppm(-18);
383                                         stp[2] = 115.0 * meter_deflect_ppm( -9);
384                                         stp[3] = 115.0 * meter_deflect_ppm(  0); // ignored
385                                         c[3] = c[2] = c[1];
386                                         c[6] = c[7] = c[8] = c[9];
387                                         break;
388                                 case MeterIEC1NOR:
389                                         stp[0] = 115.0 * meter_deflect_nordic(-30); // ignored
390                                         stp[1] = 115.0 * meter_deflect_nordic(-18);
391                                         stp[2] = 115.0 * meter_deflect_nordic(-12);
392                                         stp[3] = 115.0 * meter_deflect_nordic( -9); // ignored
393                                         c[0] = c[1] = c[2]; // bright-green
394                                         c[6] = c[7] = c[8] = c[9];
395                                         break;
396                                 case MeterIEC1DIN:
397                                         stp[0] = 115.0 * meter_deflect_din(-29); // ignored
398                                         stp[1] = 115.0 * meter_deflect_din(-18);
399                                         stp[2] = 115.0 * meter_deflect_din(-15); // ignored
400                                         stp[3] = 115.0 * meter_deflect_din( -9);
401                                         c[0] = c[2] = c[3] = c[1];
402                                         c[4] = c[6];
403                                         c[5] = c[7];
404                                         break;
405                                 case MeterVU:
406                                         stp[0] = 115.0 * meter_deflect_vu(-26); // -6
407                                         stp[1] = 115.0 * meter_deflect_vu(-23); // -3
408                                         stp[2] = 115.0 * meter_deflect_vu(-20); // 0
409                                         stp[3] = 115.0 * meter_deflect_vu(-18); // +2
410                                         c[0] = c[2] = c[3] = c[4] = c[5] = c[1];
411                                         c[7] = c[8] = c[9] = c[6];
412                                         break;
413                                 case MeterPeak0dB:
414                                          stp[1] =  89.125; // 115.0 * log_meter0dB(-9);
415                                          stp[2] = 106.375; // 115.0 * log_meter0dB(-3);
416                                          stp[3] = 115.0;   // 115.0 * log_meter0dB(0);
417                                         switch (UIConfiguration::instance().get_meter_line_up_level()) {
418                                         case MeteringLineUp24:
419                                                 stp[0] = 115.0 * log_meter0dB(-24);
420                                                 break;
421                                         case MeteringLineUp20:
422                                                 stp[0] = 115.0 * log_meter0dB(-20);
423                                                 break;
424                                         default:
425                                         case MeteringLineUp18:
426                                                 stp[0] = 115.0 * log_meter0dB(-18);
427                                                 break;
428                                         case MeteringLineUp15:
429                                                 stp[0] = 115.0 * log_meter0dB(-15);
430                                         }
431                                         break;
432                                 default: // PEAK, RMS
433                                         stp[1] = 77.5;  // 115 * log_meter(-9)
434                                         stp[2] = 92.5;  // 115 * log_meter(-3)
435                                         stp[3] = 100.0; // 115 * log_meter(0)
436                                         switch (UIConfiguration::instance().get_meter_line_up_level()) {
437                                         case MeteringLineUp24:
438                                                 stp[0] = 42.0;
439                                                 break;
440                                         case MeteringLineUp20:
441                                                 stp[0] = 50.0;
442                                                 break;
443                                         default:
444                                         case MeteringLineUp18:
445                                                 stp[0] = 55.0;
446                                                 break;
447                                         case MeteringLineUp15:
448                                                 stp[0] = 62.5;
449                                                 break;
450                                 }
451                         }
452                 }
453                 if (meters[n].width != width || meters[n].length != len || color_changed || meter_type != visible_meter_type) {
454                         bool hl = meters[n].meter ? meters[n].meter->get_highlight() : false;
455                         meters[n].packed = false;
456                         delete meters[n].meter;
457                         meters[n].meter = new FastMeter ((uint32_t) floor (UIConfiguration::instance().get_meter_hold()), width, _meter_orientation, len,
458                                         c[0], c[1], c[2], c[3], c[4],
459                                         c[5], c[6], c[7], c[8], c[9],
460                                         b[0], b[1], b[2], b[3],
461                                         stp[0], stp[1], stp[2], stp[3],
462                                         styleflags
463                                         );
464                         meters[n].meter->set_highlight(hl);
465                         meters[n].width = width;
466                         meters[n].length = len;
467                         meters[n].meter->add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
468                         meters[n].meter->signal_button_press_event().connect (sigc::mem_fun (*this, &LevelMeterBase::meter_button_press), false);
469                         meters[n].meter->signal_button_release_event().connect (sigc::mem_fun (*this, &LevelMeterBase::meter_button_release), false);
470                 }
471
472                 //pack_end (*meters[n].meter, false, false);
473                 mtr_pack (*meters[n].meter);
474                 meters[n].packed = true;
475                 if (max_visible_meters == 0 || (uint32_t) n < max_visible_meters + nmidi) {
476                         meters[n].meter->show_all ();
477                 } else {
478                         meters[n].meter->hide ();
479                 }
480         }
481         //show();
482         color_changed = false;
483         visible_meter_type = meter_type;
484         meter_count = nmeters;
485 }
486
487 void
488 LevelMeterBase::set_type(MeterType t)
489 {
490         meter_type = t;
491         _meter->set_type(t);
492 }
493
494 bool
495 LevelMeterBase::meter_button_press (GdkEventButton* ev)
496 {
497         return static_cast<bool>(ButtonPress (ev)); /* EMIT SIGNAL */
498 }
499
500 bool
501 LevelMeterBase::meter_button_release (GdkEventButton* ev)
502 {
503         if (ev->button == 1) {
504                 clear_meters (false);
505         }
506         ButtonRelease(ev);
507
508         return true;
509 }
510
511
512 void LevelMeterBase::clear_meters (bool reset_highlight)
513 {
514         for (vector<MeterInfo>::iterator i = meters.begin(); i < meters.end(); i++) {
515                 (*i).meter->clear();
516                 (*i).max_peak = minus_infinity();
517                 if (reset_highlight)
518                         (*i).meter->set_highlight(false);
519         }
520         max_peak = minus_infinity();
521 }
522
523 void LevelMeterBase::hide_meters ()
524 {
525         hide_all_meters();
526 }
527
528 void
529 LevelMeterBase::color_handler ()
530 {
531         color_changed = true;
532         setup_meters (meter_length, regular_meter_width, thin_meter_width);
533 }
534
535 LevelMeterHBox::LevelMeterHBox(Session* s)
536         : LevelMeterBase(s, invalidator(*this))
537 {
538         set_spacing(1);
539         show();
540 }
541
542
543 LevelMeterHBox::~LevelMeterHBox() {}
544
545 void
546 LevelMeterHBox::mtr_pack(Gtk::Widget &w) {
547         pack_end (w, false, false);
548 }
549
550 void
551 LevelMeterHBox::mtr_remove(Gtk::Widget &w) {
552         remove (w);
553 }
554
555
556 LevelMeterVBox::LevelMeterVBox(Session* s)
557         : LevelMeterBase(s, invalidator(*this), FastMeter::Horizontal)
558 {
559         set_spacing(1);
560         show();
561 }
562 LevelMeterVBox::~LevelMeterVBox() {}
563
564 void
565 LevelMeterVBox::mtr_pack(Gtk::Widget &w) {
566         pack_end (w, false, false);
567 }
568
569 void
570 LevelMeterVBox::mtr_remove(Gtk::Widget &w) {
571         remove (w);
572 }