1 /*
2 * Copyright (c) 2012 Clément Bœsch
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 /**
22 * @file
23 * EBU R.128 implementation
24 * @see http://tech.ebu.ch/loudness
25 * @see https://www.youtube.com/watch?v=iuEtQqC-Sqo "EBU R128 Introduction - Florian Camerer"
26 * @todo True Peak
27 * @todo implement start/stop/reset through filter command injection
28 * @todo support other frequencies to avoid resampling
29 */
30
31 #include <math.h>
32
44
45 #define MAX_CHANNELS 63
46
47 /* pre-filter coefficients */
48 #define PRE_B0 1.53512485958697
49 #define PRE_B1 -2.69169618940638
50 #define PRE_B2 1.19839281085285
51 #define PRE_A1 -1.69065929318241
52 #define PRE_A2 0.73248077421585
53
54 /* RLB-filter coefficients */
58 #define RLB_A1 -1.99004745483398
59 #define RLB_A2 0.99007225036621
60
61 #define ABS_THRES -70 ///< silence gate: we discard anything below this absolute (LUFS) threshold
62 #define ABS_UP_THRES 10
///< upper loud limit to consider (ABS_THRES being the minimum)
63 #define HIST_GRAIN 100
///< defines histogram precision
64 #define HIST_SIZE ((ABS_UP_THRES - ABS_THRES) * HIST_GRAIN + 1)
65
66 /**
67 * A histogram is an array of HIST_SIZE hist_entry storing all the energies
68 * recorded (with an accuracy of 1/HIST_GRAIN) of the loudnesses from ABS_THRES
69 * (at 0) to ABS_UP_THRES (at HIST_SIZE-1).
70 * This fixed-size system avoids the need of a list of energies growing
71 * infinitely over the time and is thus more scalable.
72 */
74 int count;
///< how many times the corresponding value occurred
75 double energy;
///< E = 10^((L + 0.691) / 10)
76 double loudness;
///< L = -0.691 + 10 * log10(E)
77 };
78
81 int cache_pos;
///< focus on the last added bin in the cache array
82 double sum[
MAX_CHANNELS];
///< sum of the last N ms filtered samples (cache content)
83 int filled;
///< 1 if the cache is completely filled, 0 otherwise
85 double sum_kept_powers;
///< sum of the powers (weighted sums) above absolute threshold
88 };
89
91
93 const AVClass *
class;
///< AVClass context for log and options purpose
94
95 /* video */
96 int do_video;
///< 1 if video output enabled, 0 otherwise
97 int w, h;
///< size of the video output
98 struct rect text;
///< rectangle for the LU legend on the left
99 struct rect graph;
///< rectangle for the main graph in the center
100 struct rect gauge;
///< rectangle for the gauge on the right
102 int meter;
///< select a EBU mode between +9 and +18
103 int scale_range;
///< the range of LU values according to the meter
104 int y_zero_lu;
///< the y value (pixel position) for 0 LU
105 int *
y_line_ref;
///< y reference values for drawing the LU lines in the graph and the gauge
106
107 /* audio */
110 int sample_count;
///< sample count used for refresh frequency, reset at refresh
111
112 /* Filter caches.
113 * The mult by 3 in the following is for X[i], X[i-1] and X[i-2] */
115 double y[
MAX_CHANNELS * 3];
///< 3 pre-filter samples cache for each channel
116 double z[
MAX_CHANNELS * 3];
///< 3 RLB-filter samples cache for each channel
117
118 #define I400_BINS (48000 * 4 / 10)
119 #define I3000_BINS (48000 * 3)
120 struct integrator i400;
///< 400ms integrator, used for Momentary loudness (M), and Integrated loudness (I)
121 struct integrator i3000;
///< 3s integrator, used for Short term loudness (S), and Loudness Range (LRA)
122
123 /* I and LRA specific */
126 double lra_low, lra_high;
///< low and high LRA values
127
128 /* misc */
130 int metadata;
///< whether or not to inject loudness results in frames
132
133 #define OFFSET(x) offsetof(EBUR128Context, x)
134 #define A AV_OPT_FLAG_AUDIO_PARAM
135 #define V AV_OPT_FLAG_VIDEO_PARAM
136 #define F AV_OPT_FLAG_FILTERING_PARAM
141 {
"framelog",
"force frame logging level",
OFFSET(loglevel),
AV_OPT_TYPE_INT, {.i64 = -1}, INT_MIN, INT_MAX,
A|
V|
F,
"level" },
145 { NULL }
146 };
147
149
151 0xdd, 0x66, 0x66, // value above 0LU non reached
152 0x66, 0x66, 0xdd, // value below 0LU non reached
153 0x96, 0x33, 0x33, // value above 0LU reached
154 0x33, 0x33, 0x96, // value below 0LU reached
155 0xdd, 0x96, 0x96, // value above 0LU line non reached
156 0x96, 0x96, 0xdd, // value below 0LU line non reached
157 0xdd, 0x33, 0x33, // value above 0LU line reached
158 0x33, 0x33, 0xdd, // value below 0LU line reached
159 };
160
162 {
163 const int below0 = y > ebur128->
y_zero_lu;
164 const int reached = y >=
v;
166 const int colorid = 4*line + 2*reached + below0;
168 }
169
171 {
172 v += 2 * ebur128->
meter;
// make it in range [0;...]
173 v = av_clipf(v, 0, ebur128->
scale_range);
// make sure it's in the graph scale
174 v = ebur128->
scale_range -
v;
// invert value (y=0 is on top)
175 return v * ebur128->
graph.
h / ebur128->
scale_range;
// rescale from scale range to px height
176 }
177
180
182 0xdd, 0xdd, 0x00,
183 0x00, 0x96, 0x96,
184 };
185
187 {
188 int i;
191 int font_height;
192 va_list vl;
193
196 else return;
197
198 va_start(vl, fmt);
200 va_end(vl);
201
202 for (i = 0; buf[i]; i++) {
205
206 for (char_y = 0; char_y < font_height; char_y++) {
207 for (mask = 0x80;
mask; mask >>= 1) {
208 if (font[buf[i] * font_height + char_y] & mask)
209 memcpy(p, color, 3);
210 else
211 memcpy(p, "\x00\x00\x00", 3);
212 p += 3;
213 }
215 }
216 }
217 }
218
220 {
221 int i;
223
224 for (i = 0; i <
len; i++) {
225 memcpy(p, "\x00\xff\x00", 3);
226 p += step;
227 }
228 }
229
231 {
237
238 /* check if there is enough space to represent everything decently */
239 if (ebur128->
w < 640 || ebur128->
h < 480) {
241 "minimum size is 640x480\n", ebur128->
w, ebur128->
h);
243 }
244 outlink->
w = ebur128->
w;
245 outlink->
h = ebur128->
h;
246
247 #define PAD 8
248
249 /* configure text area position and size */
251 ebur128->
text.
y = 40;
252 ebur128->
text.
w = 3 * 8;
// 3 characters
254
255 /* configure gauge position and size */
260
261 /* configure graph position and size */
266
267 /* graph and gauge share the LU-to-pixel code */
269
270 /* prepare the initial picref buffer */
274 if (!outpicref)
277
278 /* init y references values (to draw LU lines) */
282
283 /* black background */
284 memset(outpicref->
data[0], 0, ebur128->
h * outpicref->
linesize[0]);
285
286 /* draw LU legends */
288 for (i = ebur128->
meter; i >= -ebur128->
meter * 2; i--) {
290 x =
PAD + (i < 10 && i > -10) * 8;
292 y -= 4; // -4 to center vertically
294 "%c%d", i < 0 ? '-' : i > 0 ?
'+' :
' ',
FFABS(i));
295 }
296
297 /* draw graph */
301 for (y = 0; y < ebur128->
graph.
h; y++) {
303
304 for (x = 0; x < ebur128->
graph.
w; x++)
305 memcpy(p + x*3, c, 3);
307 }
308
309 /* draw fancy rectangles around the graph and the gauge */
310 #define DRAW_RECT(r) do { \
311 drawline(outpicref, r.x, r.y - 1, r.w, 3); \
312 drawline(outpicref, r.x, r.y + r.h, r.w, 3); \
313 drawline(outpicref, r.x - 1, r.y, r.h, outpicref->linesize[0]); \
314 drawline(outpicref, r.x + r.w, r.y, r.h, outpicref->linesize[0]); \
315 } while (0)
318
320
321 return 0;
322 }
323
325 {
328
329 /* force 100ms framing in case of metadata injection: the frames must have
330 * a granularity of the window overlap to be accurately exploited */
335 return 0;
336 }
337
339 {
340 int i;
341 int idx_bitposn = 0;
345
346 #define BACK_MASK (AV_CH_BACK_LEFT |AV_CH_BACK_CENTER |AV_CH_BACK_RIGHT| \
347 AV_CH_TOP_BACK_LEFT|AV_CH_TOP_BACK_CENTER|AV_CH_TOP_BACK_RIGHT| \
348 AV_CH_SIDE_LEFT |AV_CH_SIDE_RIGHT| \
349 AV_CH_SURROUND_DIRECT_LEFT |AV_CH_SURROUND_DIRECT_RIGHT)
350
355
357
358 /* find the next bit that is set starting from the right */
359 while ((outlink->
channel_layout & 1ULL<<idx_bitposn) == 0 && idx_bitposn < 63)
360 idx_bitposn++;
361
362 /* channel weighting */
366 }
else if (1ULL<<idx_bitposn &
BACK_MASK) {
368 } else {
370 }
371
372 idx_bitposn++;
373
375 continue;
376
377 /* bins buffer for the two integration window (400ms and 3s) */
382 }
383
385
386 return 0;
387 }
388
389 #define ENERGY(loudness) (pow(10, ((loudness) + 0.691) / 10.))
390 #define LOUDNESS(energy) (-0.691 + 10 * log10(energy))
391
393 {
394 int i;
396
397 if (!h)
398 return NULL;
402 }
403 return h;
404 }
405
407 {
410
415 else
417 }
418
419 // if meter is +9 scale, scale range is from -18 LU to +9 LU (or 3*9)
420 // if meter is +18 scale, scale range is from -36 LU to +18 LU (or 3*18)
422
427
430
431 /* insert output pads */
437 };
441 }
446 };
450
451 /* summary */
453
454 return 0;
455 }
456
457 #define HIST_POS(power) (int)(((power) - ABS_THRES) * HIST_GRAIN)
458
459 /* loudness and power should be set such as loudness = -0.691 +
460 * 10*log10(power), we just avoid doing that calculus two times */
463 {
464 int ipower;
465 double relative_threshold;
466 int gate_hist_pos;
467
468 /* update powers histograms by incrementing current power count */
471
472 /* compute relative threshold and get its position in the histogram */
476 if (!relative_threshold)
477 relative_threshold = 1e-12;
480
481 return gate_hist_pos;
482 }
483
485 {
486 int i, ch, idx_insample;
491 const double *samples = (
double *)insamples->
data[0];
493
494 for (idx_insample = 0; idx_insample < nb_samples; idx_insample++) {
497
498 #define MOVE_TO_NEXT_CACHED_ENTRY(time) do { \
499 ebur128->i##time.cache_pos++; \
500 if (ebur128->i##time.cache_pos == I##time##_BINS) { \
501 ebur128->i##time.filled = 1; \
502 ebur128->i##time.cache_pos = 0; \
503 } \
504 } while (0)
505
508
510 double bin;
511
512 ebur128->
x[ch * 3] = *samples++;
// set X[i]
513
515 continue;
516
517 /* Y[i] = X[i]*b0 + X[i-1]*b1 + X[i-2]*b2 - Y[i-1]*a1 - Y[i-2]*a2 */
518 #define FILTER(Y, X, name) do { \
519 double *dst = ebur128->Y + ch*3; \
520 double *src = ebur128->X + ch*3; \
521 dst[2] = dst[1]; \
522 dst[1] = dst[0]; \
523 dst[0] = src[0]*name##_B0 + src[1]*name##_B1 + src[2]*name##_B2 \
524 - dst[1]*name##_A1 - dst[2]*name##_A2; \
525 } while (0)
526
527 // TODO: merge both filters in one?
528 FILTER(
y, x, PRE);
// apply pre-filter
529 ebur128->
x[ch * 3 + 2] = ebur128->
x[ch * 3 + 1];
530 ebur128->
x[ch * 3 + 1] = ebur128->
x[ch * 3 ];
531 FILTER(z,
y, RLB);
// apply RLB-filter
532
533 bin = ebur128->
z[ch * 3] * ebur128->
z[ch * 3];
534
535 /* add the new value, and limit the sum to the cache size (400ms or 3s)
536 * by removing the oldest one */
539
540 /* override old cache entry with the new value */
541 ebur128->
i400.
cache [ch][bin_id_400 ] = bin;
543 }
544
545 /* For integrated loudness, gating blocks are 400ms long with 75%
546 * overlap (see BS.1770-2 p5), so a re-computation is needed each 100ms
547 * (4800 samples at 48kHz). */
549 double loudness_400, loudness_3000;
550 double power_400 = 1e-12, power_3000 = 1e-12;
552 const int64_t pts = insamples->
pts +
555
557
558 #define COMPUTE_LOUDNESS(m, time) do { \
559 if (ebur128->i##time.filled) { \
560 /* weighting sum of the last <time> ms */ \
561 for (ch = 0; ch < nb_channels; ch++) \
562 power_##time += ebur128->ch_weighting[ch] * ebur128->i##time.sum[ch]; \
563 power_##time /= I##time##_BINS; \
564 } \
565 loudness_##time = LOUDNESS(power_##time); \
566 } while (0)
567
570
571 /* Integrated loudness */
572 #define I_GATE_THRES -10 // initially defined to -8 LU in the first EBU standard
573
575 double integrated_sum = 0;
576 int nb_integrated = 0;
579
580 /* compute integrated loudness by summing the histogram values
581 * above the relative threshold */
582 for (i = gate_hist_pos; i <
HIST_SIZE; i++) {
584 nb_integrated += nb_v;
586 }
587 if (nb_integrated)
589 }
590
591 /* LRA */
592 #define LRA_GATE_THRES -20
593 #define LRA_LOWER_PRC 10
594 #define LRA_HIGHER_PRC 95
595
596 /* XXX: example code in EBU 3342 is ">=" but formula in BS.1770
597 * specs is ">" */
599 int nb_powers = 0;
602
603 for (i = gate_hist_pos; i <
HIST_SIZE; i++)
607
608 /* get lower loudness to consider */
609 n = 0;
611 for (i = gate_hist_pos; i <
HIST_SIZE; i++) {
613 if (n >= nb_pow) {
615 break;
616 }
617 }
618
619 /* get higher loudness to consider */
620 n = nb_powers;
622 for (i = HIST_SIZE - 1; i >= 0; i--) {
624 if (n < nb_pow) {
626 break;
627 }
628 }
629
630 // XXX: show low & high on the graph?
632 }
633 }
634
635 #define LOG_FMT "M:%6.1f S:%6.1f I:%6.1f LUFS LRA:%6.1f LU"
636
637 /* push one video frame */
641
642 const int y_loudness_lu_graph =
lu_to_y(ebur128, loudness_3000 + 23);
643 const int y_loudness_lu_gauge =
lu_to_y(ebur128, loudness_400 + 23);
644
645 /* draw the graph using the short-term loudness */
646 p = pic->data[0] + ebur128->
graph.
y*pic->linesize[0] + ebur128->
graph.
x*3;
647 for (y = 0; y < ebur128->
graph.
h; y++) {
649
650 memmove(p, p + 3, (ebur128->
graph.
w - 1) * 3);
651 memcpy(p + (ebur128->
graph.
w - 1) * 3, c, 3);
652 p += pic->linesize[0];
653 }
654
655 /* draw the gauge using the momentary loudness */
656 p = pic->data[0] + ebur128->
gauge.
y*pic->linesize[0] + ebur128->
gauge.
x*3;
657 for (y = 0; y < ebur128->
gauge.
h; y++) {
659
660 for (x = 0; x < ebur128->
gauge.
w; x++)
661 memcpy(p + x*3, c, 3);
662 p += pic->linesize[0];
663 }
664
665 /* draw textual info */
667 LOG_FMT " ",
// padding to erase trailing characters
668 loudness_400, loudness_3000,
670
671 /* set pts and push frame */
672 pic->pts = pts;
674 if (ret < 0)
676 }
677
678 if (ebur128->
metadata) {
/* happens only once per filter_frame call */
679 char metabuf[128];
680 #define SET_META(name, var) do { \
681 snprintf(metabuf, sizeof(metabuf), "%.3f", var); \
682 av_dict_set(&insamples->metadata, "lavfi.r128." name, metabuf, 0); \
683 } while (0)
690 }
691
694 loudness_400, loudness_3000,
696 }
697 }
698
700 }
701
703 {
709
711 static const int input_srate[] = {48000, -1}; // ITU-R BS.1770 provides coeff only for 48kHz
713
714 /* set optional output video format */
717 if (!formats)
721 }
722
723 /* set input and output audio formats
724 * Note: ff_set_common_* functions are not used because they affect all the
725 * links, and thus break the video format negotiation */
727 if (!formats)
731
733 if (!layouts)
737
739 if (!formats)
743
744 return 0;
745 }
746
748 {
749 int i;
751
753 " Integrated loudness:\n"
754 " I: %5.1f LUFS\n"
755 " Threshold: %5.1f LUFS\n\n"
756 " Loudness range:\n"
757 " LRA: %5.1f LU\n"
758 " Threshold: %5.1f LUFS\n"
759 " LRA low: %5.1f LUFS\n"
760 " LRA high: %5.1f LUFS\n",
764
772 }
776 }
777
779 {
784 },
785 { NULL }
786 };
787
797 .priv_class = &ebur128_class,
799 };