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