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