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