move utility functions into a dedicated namespace
[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 <gtkmm2ext/barcontroller.h>
26 #include "pbd/fastlog.h"
27
28 #include "ardour_ui.h"
29 #include "global_signals.h"
30 #include "level_meter.h"
31 #include "utils.h"
32 #include "logmeter.h"
33 #include "gui_thread.h"
34 #include "keyboard.h"
35 #include "public_editor.h"
36
37 #include "i18n.h"
38
39 using namespace ARDOUR;
40 using namespace ARDOUR_UI_UTILS;
41 using namespace PBD;
42 using namespace Gtkmm2ext;
43 using namespace Gtk;
44 using namespace std;
45
46 LevelMeterBase::LevelMeterBase (Session* s, PBD::EventLoop::InvalidationRecord* ir, FastMeter::Orientation o)
47         : parent_invalidator(ir)
48         , _meter (0)
49         , _meter_orientation(o)
50         , regular_meter_width (6)
51         , meter_length (0)
52         , thin_meter_width(2)
53 {
54         set_session (s);
55         Config->ParameterChanged.connect (_parameter_connection, parent_invalidator, boost::bind (&LevelMeterBase::parameter_changed, this, _1), gui_context());
56         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &LevelMeterBase::on_theme_changed));
57         ColorsChanged.connect (sigc::mem_fun (*this, &LevelMeterBase::color_handler));
58         max_peak = minus_infinity();
59         meter_type = MeterPeak;
60 }
61
62 void
63 LevelMeterBase::on_theme_changed()
64 {
65         style_changed = true;
66 }
67
68 LevelMeterBase::~LevelMeterBase ()
69 {
70         for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
71                 delete (*i).meter;
72         }
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;
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(Config->get_meter_line_up_level(), offset);
108 }
109
110 static float vu_standard() {
111         // note - default meter config is +2dB (france)
112         switch (Config->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 >= Config->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 == MeterIEC1NOR) {
155                                         (*i).meter->set (meter_deflect_nordic (peak + meter_lineup(0)));
156                                 } else if (meter_type == MeterIEC1DIN) {
157                                         (*i).meter->set (meter_deflect_din (peak + meter_lineup_cfg(Config->get_meter_line_up_din(), 3.0)));
158                                 } else if (meter_type == MeterIEC2BBC || meter_type == MeterIEC2EBU) {
159                                         (*i).meter->set (meter_deflect_ppm (peak + meter_lineup(0)));
160                                 } else if (meter_type == MeterVU) {
161                                         (*i).meter->set (meter_deflect_vu (peak + vu_standard() + meter_lineup(0)));
162                                 } else if (meter_type == MeterK12) {
163                                         (*i).meter->set (meter_deflect_k (peak, 12), meter_deflect_k(_meter->meter_level(n, MeterPeak), 12));
164                                 } else if (meter_type == MeterK14) {
165                                         (*i).meter->set (meter_deflect_k (peak, 14), meter_deflect_k(_meter->meter_level(n, MeterPeak), 14));
166                                 } else if (meter_type == MeterK20) {
167                                         (*i).meter->set (meter_deflect_k (peak, 20), meter_deflect_k(_meter->meter_level(n, MeterPeak), 20));
168                                 } else { // RMS
169                                         (*i).meter->set (log_meter (peak), log_meter(_meter->meter_level(n, MeterPeak)));
170                                 }
171                         }
172                 }
173         }
174         return max_peak;
175 }
176
177 void
178 LevelMeterBase::parameter_changed (string p)
179 {
180         ENSURE_GUI_THREAD (*this, &LevelMeterBase::parameter_changed, p)
181
182         if (p == "meter-hold") {
183                 vector<MeterInfo>::iterator i;
184                 uint32_t n;
185
186                 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
187                         (*i).meter->set_hold_count ((uint32_t) floor(Config->get_meter_hold()));
188                 }
189         }
190         else if (p == "meter-line-up-level") {
191                 color_changed = true;
192                 setup_meters (meter_length, regular_meter_width, thin_meter_width);
193         }
194         else if (p == "meter-style-led") {
195                 color_changed = true;
196                 setup_meters (meter_length, regular_meter_width, thin_meter_width);
197         }
198         else if (p == "meter-peak") {
199                 vector<MeterInfo>::iterator i;
200                 uint32_t n;
201
202                 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
203                         (*i).max_peak = minus_infinity();
204                 }
205         }
206 }
207
208 void
209 LevelMeterBase::configuration_changed (ChanCount /*in*/, ChanCount /*out*/)
210 {
211         color_changed = true;
212         setup_meters (meter_length, regular_meter_width, thin_meter_width);
213 }
214
215 void
216 LevelMeterBase::meter_type_changed (MeterType t)
217 {
218         meter_type = t;
219         color_changed = true;
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 }
234
235 void
236 LevelMeterBase::setup_meters (int len, int initial_width, int thin_width)
237 {
238         hide_all_meters ();
239
240         if (!_meter) {
241                 return; /* do it later or never */
242         }
243
244         int32_t nmidi = _meter->input_streams().n_midi();
245         uint32_t nmeters = _meter->input_streams().n_total();
246         regular_meter_width = initial_width;
247         thin_meter_width = thin_width;
248         meter_length = len;
249
250         guint16 width;
251
252         if (nmeters == 0) {
253                 return;
254         }
255
256         if (nmeters <= 2) {
257                 width = regular_meter_width;
258         } else {
259                 width = thin_meter_width;
260         }
261
262         while (meters.size() < nmeters) {
263                 meters.push_back (MeterInfo());
264         }
265
266         //cerr << "LevelMeterBase::setup_meters() called color_changed = " << color_changed << " colors: " << endl;//DEBUG
267
268         for (int32_t n = nmeters-1; nmeters && n >= 0 ; --n) {
269                 uint32_t c[10];
270                 uint32_t b[4];
271                 float stp[4];
272                 int styleflags = Config->get_meter_style_led() ? 3 : 1;
273                 b[0] = ARDOUR_UI::config()->get_canvasvar_MeterBackgroundBot();
274                 b[1] = ARDOUR_UI::config()->get_canvasvar_MeterBackgroundTop();
275                 b[2] = 0x991122ff; // red highlight gradient Bot
276                 b[3] = 0x551111ff; // red highlight gradient Top
277                 if (n < nmidi) {
278                         c[0] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor0();
279                         c[1] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor1();
280                         c[2] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor2();
281                         c[3] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor3();
282                         c[4] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor4();
283                         c[5] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor5();
284                         c[6] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor6();
285                         c[7] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor7();
286                         c[8] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor8();
287                         c[9] = ARDOUR_UI::config()->get_canvasvar_MidiMeterColor9();
288                         stp[0] = 115.0 *  32.0 / 128.0;
289                         stp[1] = 115.0 *  64.0 / 128.0;
290                         stp[2] = 115.0 * 100.0 / 128.0;
291                         stp[3] = 115.0 * 112.0 / 128.0;
292                 } else {
293                         c[0] = ARDOUR_UI::config()->get_canvasvar_MeterColor0();
294                         c[1] = ARDOUR_UI::config()->get_canvasvar_MeterColor1();
295                         c[2] = ARDOUR_UI::config()->get_canvasvar_MeterColor2();
296                         c[3] = ARDOUR_UI::config()->get_canvasvar_MeterColor3();
297                         c[4] = ARDOUR_UI::config()->get_canvasvar_MeterColor4();
298                         c[5] = ARDOUR_UI::config()->get_canvasvar_MeterColor5();
299                         c[6] = ARDOUR_UI::config()->get_canvasvar_MeterColor6();
300                         c[7] = ARDOUR_UI::config()->get_canvasvar_MeterColor7();
301                         c[8] = ARDOUR_UI::config()->get_canvasvar_MeterColor8();
302                         c[9] = ARDOUR_UI::config()->get_canvasvar_MeterColor9();
303
304                         switch (meter_type) {
305                                 case MeterK20:
306                                         stp[0] = 115.0 * meter_deflect_k(-40, 20);  //-20
307                                         stp[1] = 115.0 * meter_deflect_k(-20, 20);  //  0
308                                         stp[2] = 115.0 * meter_deflect_k(-18, 20);  // +2
309                                         stp[3] = 115.0 * meter_deflect_k(-16, 20);  // +4
310                                         c[0] = c[1] = 0x008800ff;
311                                         c[2] = c[3] = 0x00ff00ff;
312                                         c[4] = c[5] = 0xffff00ff;
313                                         c[6] = c[7] = 0xffff00ff;
314                                         c[8] = c[9] = 0xff0000ff;
315                                         break;
316                                 case MeterK14:
317                                         stp[0] = 115.0 * meter_deflect_k(-34, 14);  //-20
318                                         stp[1] = 115.0 * meter_deflect_k(-14, 14);  //  0
319                                         stp[2] = 115.0 * meter_deflect_k(-12, 14);  // +2
320                                         stp[3] = 115.0 * meter_deflect_k(-10, 14);  // +4
321                                         c[0] = c[1] = 0x008800ff;
322                                         c[2] = c[3] = 0x00ff00ff;
323                                         c[4] = c[5] = 0xffff00ff;
324                                         c[6] = c[7] = 0xffff00ff;
325                                         c[8] = c[9] = 0xff0000ff;
326                                         break;
327                                 case MeterK12:
328                                         stp[0] = 115.0 * meter_deflect_k(-32, 12);  //-20
329                                         stp[1] = 115.0 * meter_deflect_k(-12, 12);  //  0
330                                         stp[2] = 115.0 * meter_deflect_k(-10, 12);  // +2
331                                         stp[3] = 115.0 * meter_deflect_k( -8, 12);  // +4
332                                         c[0] = c[1] = 0x008800ff;
333                                         c[2] = c[3] = 0x00ff00ff;
334                                         c[4] = c[5] = 0xffff00ff;
335                                         c[6] = c[7] = 0xffff00ff;
336                                         c[8] = c[9] = 0xff0000ff;
337                                         break;
338                                 case MeterIEC2BBC:
339                                         c[0] = c[1] = c[2] = c[3] = c[4] = c[5] = c[6] = c[7] = c[8] = c[9] =
340                                                 ARDOUR_UI::config()->color_by_name ("meter color BBC");
341                                         stp[0] = stp[1] = stp[2] = stp[3] = 115.0;
342                                         break;
343                                 case MeterIEC2EBU:
344                                         stp[0] = 115.0 * meter_deflect_ppm(-24); // ignored
345                                         stp[1] = 115.0 * meter_deflect_ppm(-18);
346                                         stp[2] = 115.0 * meter_deflect_ppm( -9);
347                                         stp[3] = 115.0 * meter_deflect_ppm(  0); // ignored
348                                         c[3] = c[2] = c[1];
349                                         c[6] = c[7] = c[8] = c[9];
350                                         break;
351                                 case MeterIEC1NOR:
352                                         stp[0] = 115.0 * meter_deflect_nordic(-30); // ignored
353                                         stp[1] = 115.0 * meter_deflect_nordic(-18);
354                                         stp[2] = 115.0 * meter_deflect_nordic(-12);
355                                         stp[3] = 115.0 * meter_deflect_nordic( -9); // ignored
356                                         //c[2] = c[3] = c[1]; // dark-green
357                                         c[0] = c[1] = c[2]; // bright-green
358                                         c[6] = c[7] = c[8] = c[9];
359                                         break;
360                                 case MeterIEC1DIN:
361                                         stp[0] = 115.0 * meter_deflect_din(-29); // ignored
362                                         stp[1] = 115.0 * meter_deflect_din(-18);
363                                         stp[2] = 115.0 * meter_deflect_din(-15); // ignored
364                                         stp[3] = 115.0 * meter_deflect_din( -9);
365                                         c[0] = c[1] = c[2] = c[3] = 0x00aa00ff;
366                                         c[4] = c[6];
367                                         c[5] = c[7];
368                                         break;
369                                 case MeterVU:
370                                         stp[0] = 115.0 * meter_deflect_vu(-26); // -6
371                                         stp[1] = 115.0 * meter_deflect_vu(-23); // -3
372                                         stp[2] = 115.0 * meter_deflect_vu(-20); // 0
373                                         stp[3] = 115.0 * meter_deflect_vu(-18); // +2
374                                         c[0] = c[1] = c[2] = c[3] = c[4] = c[5] = 0x00aa00ff;
375                                         c[6] = c[7] = c[8] = c[9] = 0xff8800ff;
376                                         break;
377                                 default: // PEAK, RMS
378                                         stp[1] = 77.5;  // 115 * log_meter(-10)
379                                         stp[2] = 92.5;  // 115 * log_meter(-3)
380                                         stp[3] = 100.0; // 115 * log_meter(0)
381                                 switch (Config->get_meter_line_up_level()) {
382                                         case MeteringLineUp24:
383                                                 stp[0] = 42.0;
384                                                 break;
385                                         case MeteringLineUp20:
386                                                 stp[0] = 50.0;
387                                                 break;
388                                         default:
389                                         case MeteringLineUp18:
390                                                 stp[0] = 55.0;
391                                                 break;
392                                         case MeteringLineUp15:
393                                                 stp[0] = 62.5;
394                                                 break;
395                                 }
396                         }
397                 }
398                 if (meters[n].width != width || meters[n].length != len || color_changed || meter_type != visible_meter_type) {
399                         bool hl = meters[n].meter ? meters[n].meter->get_highlight() : false;
400                         meters[n].packed = false;
401                         delete meters[n].meter;
402                         meters[n].meter = new FastMeter ((uint32_t) floor (Config->get_meter_hold()), width, _meter_orientation, len,
403                                         c[0], c[1], c[2], c[3], c[4],
404                                         c[5], c[6], c[7], c[8], c[9],
405                                         b[0], b[1], b[2], b[3],
406                                         stp[0], stp[1], stp[2], stp[3],
407                                         styleflags
408                                         );
409                         meters[n].meter->set_highlight(hl);
410                         meters[n].width = width;
411                         meters[n].length = len;
412                         meters[n].meter->add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK);
413                         meters[n].meter->signal_button_press_event().connect (sigc::mem_fun (*this, &LevelMeterBase::meter_button_press));
414                         meters[n].meter->signal_button_release_event().connect (sigc::mem_fun (*this, &LevelMeterBase::meter_button_release));
415                 }
416
417                 //pack_end (*meters[n].meter, false, false);
418                 mtr_pack (*meters[n].meter);
419                 meters[n].meter->show_all ();
420                 meters[n].packed = true;
421         }
422         //show();
423         color_changed = false;
424         visible_meter_type = meter_type;
425 }
426
427 void
428 LevelMeterBase::set_type(MeterType t)
429 {
430         meter_type = t;
431         _meter->set_type(t);
432 }
433
434 bool
435 LevelMeterBase::meter_button_press (GdkEventButton* ev)
436 {
437         return ButtonPress (ev); /* EMIT SIGNAL */
438 }
439
440 bool
441 LevelMeterBase::meter_button_release (GdkEventButton* ev)
442 {
443         if (ev->button == 1) {
444                 clear_meters (false);
445         }
446         ButtonRelease(ev);
447
448         return true;
449 }
450
451
452 void LevelMeterBase::clear_meters (bool reset_highlight)
453 {
454         for (vector<MeterInfo>::iterator i = meters.begin(); i < meters.end(); i++) {
455                 (*i).meter->clear();
456                 (*i).max_peak = minus_infinity();
457                 if (reset_highlight)
458                         (*i).meter->set_highlight(false);
459         }
460         max_peak = minus_infinity();
461 }
462
463 void LevelMeterBase::hide_meters ()
464 {
465         hide_all_meters();
466 }
467
468 void
469 LevelMeterBase::color_handler ()
470 {
471         color_changed = true;
472         setup_meters (meter_length, regular_meter_width, thin_meter_width);
473 }
474
475 LevelMeterHBox::LevelMeterHBox(Session* s)
476         : LevelMeterBase(s, invalidator(*this))
477 {
478         set_spacing(1);
479         show();
480 }
481
482
483 LevelMeterHBox::~LevelMeterHBox() {}
484
485 void
486 LevelMeterHBox::mtr_pack(Gtk::Widget &w) {
487         pack_end (w, false, false);
488 }
489
490 void
491 LevelMeterHBox::mtr_remove(Gtk::Widget &w) {
492         remove (w);
493 }
494
495
496 LevelMeterVBox::LevelMeterVBox(Session* s)
497         : LevelMeterBase(s, invalidator(*this), FastMeter::Horizontal)
498 {
499         set_spacing(1);
500         show();
501 }
502 LevelMeterVBox::~LevelMeterVBox() {}
503
504 void
505 LevelMeterVBox::mtr_pack(Gtk::Widget &w) {
506         pack_end (w, false, false);
507 }
508
509 void
510 LevelMeterVBox::mtr_remove(Gtk::Widget &w) {
511         remove (w);
512 }