lavfi/ebur128: add sample and true peak metering.
[ffmpeg.git] / libavfilter / f_ebur128.c
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
33 #include "libavutil/avassert.h"
34 #include "libavutil/avstring.h"
35 #include "libavutil/channel_layout.h"
36 #include "libavutil/dict.h"
37 #include "libavutil/xga_font_data.h"
38 #include "libavutil/opt.h"
39 #include "libavutil/timestamp.h"
40 #include "libswresample/swresample.h"
41 #include "audio.h"
42 #include "avfilter.h"
43 #include "formats.h"
44 #include "internal.h"
45
46 #define MAX_CHANNELS 63
47
48 /* pre-filter coefficients */
49 #define PRE_B0  1.53512485958697
50 #define PRE_B1 -2.69169618940638
51 #define PRE_B2  1.19839281085285
52 #define PRE_A1 -1.69065929318241
53 #define PRE_A2  0.73248077421585
54
55 /* RLB-filter coefficients */
56 #define RLB_B0  1.0
57 #define RLB_B1 -2.0
58 #define RLB_B2  1.0
59 #define RLB_A1 -1.99004745483398
60 #define RLB_A2  0.99007225036621
61
62 #define ABS_THRES    -70            ///< silence gate: we discard anything below this absolute (LUFS) threshold
63 #define ABS_UP_THRES  10            ///< upper loud limit to consider (ABS_THRES being the minimum)
64 #define HIST_GRAIN   100            ///< defines histogram precision
65 #define HIST_SIZE  ((ABS_UP_THRES - ABS_THRES) * HIST_GRAIN + 1)
66
67 /**
68  * A histogram is an array of HIST_SIZE hist_entry storing all the energies
69  * recorded (with an accuracy of 1/HIST_GRAIN) of the loudnesses from ABS_THRES
70  * (at 0) to ABS_UP_THRES (at HIST_SIZE-1).
71  * This fixed-size system avoids the need of a list of energies growing
72  * infinitely over the time and is thus more scalable.
73  */
74 struct hist_entry {
75     int count;                      ///< how many times the corresponding value occurred
76     double energy;                  ///< E = 10^((L + 0.691) / 10)
77     double loudness;                ///< L = -0.691 + 10 * log10(E)
78 };
79
80 struct integrator {
81     double *cache[MAX_CHANNELS];    ///< window of filtered samples (N ms)
82     int cache_pos;                  ///< focus on the last added bin in the cache array
83     double sum[MAX_CHANNELS];       ///< sum of the last N ms filtered samples (cache content)
84     int filled;                     ///< 1 if the cache is completely filled, 0 otherwise
85     double rel_threshold;           ///< relative threshold
86     double sum_kept_powers;         ///< sum of the powers (weighted sums) above absolute threshold
87     int nb_kept_powers;             ///< number of sum above absolute threshold
88     struct hist_entry *histogram;   ///< histogram of the powers, used to compute LRA and I
89 };
90
91 struct rect { int x, y, w, h; };
92
93 typedef struct {
94     const AVClass *class;           ///< AVClass context for log and options purpose
95
96     /* peak metering */
97     int peak_mode;                  ///< enabled peak modes
98     double *true_peaks;             ///< true peaks per channel
99     double *sample_peaks;           ///< sample peaks per channel
100 #if CONFIG_SWRESAMPLE
101     SwrContext *swr_ctx;            ///< over-sampling context for true peak metering
102     double *swr_buf;                ///< resampled audio data for true peak metering
103     int swr_linesize;
104 #endif
105
106     /* video  */
107     int do_video;                   ///< 1 if video output enabled, 0 otherwise
108     int w, h;                       ///< size of the video output
109     struct rect text;               ///< rectangle for the LU legend on the left
110     struct rect graph;              ///< rectangle for the main graph in the center
111     struct rect gauge;              ///< rectangle for the gauge on the right
112     AVFrame *outpicref;             ///< output picture reference, updated regularly
113     int meter;                      ///< select a EBU mode between +9 and +18
114     int scale_range;                ///< the range of LU values according to the meter
115     int y_zero_lu;                  ///< the y value (pixel position) for 0 LU
116     int *y_line_ref;                ///< y reference values for drawing the LU lines in the graph and the gauge
117
118     /* audio */
119     int nb_channels;                ///< number of channels in the input
120     double *ch_weighting;           ///< channel weighting mapping
121     int sample_count;               ///< sample count used for refresh frequency, reset at refresh
122
123     /* Filter caches.
124      * The mult by 3 in the following is for X[i], X[i-1] and X[i-2] */
125     double x[MAX_CHANNELS * 3];     ///< 3 input samples cache for each channel
126     double y[MAX_CHANNELS * 3];     ///< 3 pre-filter samples cache for each channel
127     double z[MAX_CHANNELS * 3];     ///< 3 RLB-filter samples cache for each channel
128
129 #define I400_BINS  (48000 * 4 / 10)
130 #define I3000_BINS (48000 * 3)
131     struct integrator i400;         ///< 400ms integrator, used for Momentary loudness  (M), and Integrated loudness (I)
132     struct integrator i3000;        ///<    3s integrator, used for Short term loudness (S), and Loudness Range      (LRA)
133
134     /* I and LRA specific */
135     double integrated_loudness;     ///< integrated loudness in LUFS (I)
136     double loudness_range;          ///< loudness range in LU (LRA)
137     double lra_low, lra_high;       ///< low and high LRA values
138
139     /* misc */
140     int loglevel;                   ///< log level for frame logging
141     int metadata;                   ///< whether or not to inject loudness results in frames
142 } EBUR128Context;
143
144 enum {
145     PEAK_MODE_NONE          = 0,
146     PEAK_MODE_SAMPLES_PEAKS = 1<<1,
147     PEAK_MODE_TRUE_PEAKS    = 1<<2,
148 };
149
150 #define OFFSET(x) offsetof(EBUR128Context, x)
151 #define A AV_OPT_FLAG_AUDIO_PARAM
152 #define V AV_OPT_FLAG_VIDEO_PARAM
153 #define F AV_OPT_FLAG_FILTERING_PARAM
154 static const AVOption ebur128_options[] = {
155     { "video", "set video output", OFFSET(do_video), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, V|F },
156     { "size",  "set video size",   OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x480"}, 0, 0, V|F },
157     { "meter", "set scale meter (+9 to +18)",  OFFSET(meter), AV_OPT_TYPE_INT, {.i64 = 9}, 9, 18, V|F },
158     { "framelog", "force frame logging level", OFFSET(loglevel), AV_OPT_TYPE_INT, {.i64 = -1},   INT_MIN, INT_MAX, A|V|F, "level" },
159         { "info",    "information logging level", 0, AV_OPT_TYPE_CONST, {.i64 = AV_LOG_INFO},    INT_MIN, INT_MAX, A|V|F, "level" },
160         { "verbose", "verbose logging level",     0, AV_OPT_TYPE_CONST, {.i64 = AV_LOG_VERBOSE}, INT_MIN, INT_MAX, A|V|F, "level" },
161     { "metadata", "inject metadata in the filtergraph", OFFSET(metadata), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, A|V|F },
162     { "peak", "set peak mode", OFFSET(peak_mode), AV_OPT_TYPE_FLAGS, {.i64 = PEAK_MODE_NONE}, 0, INT_MAX, A|F, "mode" },
163         { "none",   "disable any peak mode",   0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_NONE},          INT_MIN, INT_MAX, A|F, "mode" },
164         { "sample", "enable peak-sample mode", 0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_SAMPLES_PEAKS}, INT_MIN, INT_MAX, A|F, "mode" },
165         { "true",   "enable true-peak mode",   0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_TRUE_PEAKS},    INT_MIN, INT_MAX, A|F, "mode" },
166     { NULL },
167 };
168
169 AVFILTER_DEFINE_CLASS(ebur128);
170
171 static const uint8_t graph_colors[] = {
172     0xdd, 0x66, 0x66,   // value above 0LU non reached
173     0x66, 0x66, 0xdd,   // value below 0LU non reached
174     0x96, 0x33, 0x33,   // value above 0LU reached
175     0x33, 0x33, 0x96,   // value below 0LU reached
176     0xdd, 0x96, 0x96,   // value above 0LU line non reached
177     0x96, 0x96, 0xdd,   // value below 0LU line non reached
178     0xdd, 0x33, 0x33,   // value above 0LU line reached
179     0x33, 0x33, 0xdd,   // value below 0LU line reached
180 };
181
182 static const uint8_t *get_graph_color(const EBUR128Context *ebur128, int v, int y)
183 {
184     const int below0  = y > ebur128->y_zero_lu;
185     const int reached = y >= v;
186     const int line    = ebur128->y_line_ref[y] || y == ebur128->y_zero_lu;
187     const int colorid = 4*line + 2*reached + below0;
188     return graph_colors + 3*colorid;
189 }
190
191 static inline int lu_to_y(const EBUR128Context *ebur128, double v)
192 {
193     v += 2 * ebur128->meter;                            // make it in range [0;...]
194     v  = av_clipf(v, 0, ebur128->scale_range);          // make sure it's in the graph scale
195     v  = ebur128->scale_range - v;                      // invert value (y=0 is on top)
196     return v * ebur128->graph.h / ebur128->scale_range; // rescale from scale range to px height
197 }
198
199 #define FONT8   0
200 #define FONT16  1
201
202 static const uint8_t font_colors[] = {
203     0xdd, 0xdd, 0x00,
204     0x00, 0x96, 0x96,
205 };
206
207 static void drawtext(AVFrame *pic, int x, int y, int ftid, const uint8_t *color, const char *fmt, ...)
208 {
209     int i;
210     char buf[128] = {0};
211     const uint8_t *font;
212     int font_height;
213     va_list vl;
214
215     if      (ftid == FONT16) font = avpriv_vga16_font, font_height = 16;
216     else if (ftid == FONT8)  font = avpriv_cga_font,   font_height =  8;
217     else return;
218
219     va_start(vl, fmt);
220     vsnprintf(buf, sizeof(buf), fmt, vl);
221     va_end(vl);
222
223     for (i = 0; buf[i]; i++) {
224         int char_y, mask;
225         uint8_t *p = pic->data[0] + y*pic->linesize[0] + (x + i*8)*3;
226
227         for (char_y = 0; char_y < font_height; char_y++) {
228             for (mask = 0x80; mask; mask >>= 1) {
229                 if (font[buf[i] * font_height + char_y] & mask)
230                     memcpy(p, color, 3);
231                 else
232                     memcpy(p, "\x00\x00\x00", 3);
233                 p += 3;
234             }
235             p += pic->linesize[0] - 8*3;
236         }
237     }
238 }
239
240 static void drawline(AVFrame *pic, int x, int y, int len, int step)
241 {
242     int i;
243     uint8_t *p = pic->data[0] + y*pic->linesize[0] + x*3;
244
245     for (i = 0; i < len; i++) {
246         memcpy(p, "\x00\xff\x00", 3);
247         p += step;
248     }
249 }
250
251 static int config_video_output(AVFilterLink *outlink)
252 {
253     int i, x, y;
254     uint8_t *p;
255     AVFilterContext *ctx = outlink->src;
256     EBUR128Context *ebur128 = ctx->priv;
257     AVFrame *outpicref;
258
259     /* check if there is enough space to represent everything decently */
260     if (ebur128->w < 640 || ebur128->h < 480) {
261         av_log(ctx, AV_LOG_ERROR, "Video size %dx%d is too small, "
262                "minimum size is 640x480\n", ebur128->w, ebur128->h);
263         return AVERROR(EINVAL);
264     }
265     outlink->w = ebur128->w;
266     outlink->h = ebur128->h;
267
268 #define PAD 8
269
270     /* configure text area position and size */
271     ebur128->text.x  = PAD;
272     ebur128->text.y  = 40;
273     ebur128->text.w  = 3 * 8;   // 3 characters
274     ebur128->text.h  = ebur128->h - PAD - ebur128->text.y;
275
276     /* configure gauge position and size */
277     ebur128->gauge.w = 20;
278     ebur128->gauge.h = ebur128->text.h;
279     ebur128->gauge.x = ebur128->w - PAD - ebur128->gauge.w;
280     ebur128->gauge.y = ebur128->text.y;
281
282     /* configure graph position and size */
283     ebur128->graph.x = ebur128->text.x + ebur128->text.w + PAD;
284     ebur128->graph.y = ebur128->gauge.y;
285     ebur128->graph.w = ebur128->gauge.x - ebur128->graph.x - PAD;
286     ebur128->graph.h = ebur128->gauge.h;
287
288     /* graph and gauge share the LU-to-pixel code */
289     av_assert0(ebur128->graph.h == ebur128->gauge.h);
290
291     /* prepare the initial picref buffer */
292     av_frame_free(&ebur128->outpicref);
293     ebur128->outpicref = outpicref =
294         ff_get_video_buffer(outlink, outlink->w, outlink->h);
295     if (!outpicref)
296         return AVERROR(ENOMEM);
297     outlink->sample_aspect_ratio = (AVRational){1,1};
298
299     /* init y references values (to draw LU lines) */
300     ebur128->y_line_ref = av_calloc(ebur128->graph.h + 1, sizeof(*ebur128->y_line_ref));
301     if (!ebur128->y_line_ref)
302         return AVERROR(ENOMEM);
303
304     /* black background */
305     memset(outpicref->data[0], 0, ebur128->h * outpicref->linesize[0]);
306
307     /* draw LU legends */
308     drawtext(outpicref, PAD, PAD+16, FONT8, font_colors+3, " LU");
309     for (i = ebur128->meter; i >= -ebur128->meter * 2; i--) {
310         y = lu_to_y(ebur128, i);
311         x = PAD + (i < 10 && i > -10) * 8;
312         ebur128->y_line_ref[y] = i;
313         y -= 4; // -4 to center vertically
314         drawtext(outpicref, x, y + ebur128->graph.y, FONT8, font_colors+3,
315                  "%c%d", i < 0 ? '-' : i > 0 ? '+' : ' ', FFABS(i));
316     }
317
318     /* draw graph */
319     ebur128->y_zero_lu = lu_to_y(ebur128, 0);
320     p = outpicref->data[0] + ebur128->graph.y * outpicref->linesize[0]
321                            + ebur128->graph.x * 3;
322     for (y = 0; y < ebur128->graph.h; y++) {
323         const uint8_t *c = get_graph_color(ebur128, INT_MAX, y);
324
325         for (x = 0; x < ebur128->graph.w; x++)
326             memcpy(p + x*3, c, 3);
327         p += outpicref->linesize[0];
328     }
329
330     /* draw fancy rectangles around the graph and the gauge */
331 #define DRAW_RECT(r) do { \
332     drawline(outpicref, r.x,       r.y - 1,   r.w, 3); \
333     drawline(outpicref, r.x,       r.y + r.h, r.w, 3); \
334     drawline(outpicref, r.x - 1,   r.y,       r.h, outpicref->linesize[0]); \
335     drawline(outpicref, r.x + r.w, r.y,       r.h, outpicref->linesize[0]); \
336 } while (0)
337     DRAW_RECT(ebur128->graph);
338     DRAW_RECT(ebur128->gauge);
339
340     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
341
342     return 0;
343 }
344
345 static int config_audio_input(AVFilterLink *inlink)
346 {
347     AVFilterContext *ctx = inlink->dst;
348     EBUR128Context *ebur128 = ctx->priv;
349
350     /* Force 100ms framing in case of metadata injection: the frames must have
351      * a granularity of the window overlap to be accurately exploited.
352      * As for the true peaks mode, it just simplifies the resampling buffer
353      * allocation and the lookup in it (since sample buffers differ in size, it
354      * can be more complex to integrate in the one-sample loop of
355      * filter_frame()). */
356     if (ebur128->metadata || (ebur128->peak_mode & PEAK_MODE_TRUE_PEAKS))
357         inlink->min_samples =
358         inlink->max_samples =
359         inlink->partial_buf_size = inlink->sample_rate / 10;
360     return 0;
361 }
362
363 static int config_audio_output(AVFilterLink *outlink)
364 {
365     int i;
366     int idx_bitposn = 0;
367     AVFilterContext *ctx = outlink->src;
368     EBUR128Context *ebur128 = ctx->priv;
369     const int nb_channels = av_get_channel_layout_nb_channels(outlink->channel_layout);
370
371 #define BACK_MASK (AV_CH_BACK_LEFT    |AV_CH_BACK_CENTER    |AV_CH_BACK_RIGHT| \
372                    AV_CH_TOP_BACK_LEFT|AV_CH_TOP_BACK_CENTER|AV_CH_TOP_BACK_RIGHT| \
373                    AV_CH_SIDE_LEFT                          |AV_CH_SIDE_RIGHT| \
374                    AV_CH_SURROUND_DIRECT_LEFT               |AV_CH_SURROUND_DIRECT_RIGHT)
375
376     ebur128->nb_channels  = nb_channels;
377     ebur128->ch_weighting = av_calloc(nb_channels, sizeof(*ebur128->ch_weighting));
378     if (!ebur128->ch_weighting)
379         return AVERROR(ENOMEM);
380
381     for (i = 0; i < nb_channels; i++) {
382
383         /* find the next bit that is set starting from the right */
384         while ((outlink->channel_layout & 1ULL<<idx_bitposn) == 0 && idx_bitposn < 63)
385             idx_bitposn++;
386
387         /* channel weighting */
388         if ((1ULL<<idx_bitposn & AV_CH_LOW_FREQUENCY) ||
389             (1ULL<<idx_bitposn & AV_CH_LOW_FREQUENCY_2)) {
390             ebur128->ch_weighting[i] = 0;
391         } else if (1ULL<<idx_bitposn & BACK_MASK) {
392             ebur128->ch_weighting[i] = 1.41;
393         } else {
394             ebur128->ch_weighting[i] = 1.0;
395         }
396
397         idx_bitposn++;
398
399         if (!ebur128->ch_weighting[i])
400             continue;
401
402         /* bins buffer for the two integration window (400ms and 3s) */
403         ebur128->i400.cache[i]  = av_calloc(I400_BINS,  sizeof(*ebur128->i400.cache[0]));
404         ebur128->i3000.cache[i] = av_calloc(I3000_BINS, sizeof(*ebur128->i3000.cache[0]));
405         if (!ebur128->i400.cache[i] || !ebur128->i3000.cache[i])
406             return AVERROR(ENOMEM);
407     }
408
409     outlink->flags |= FF_LINK_FLAG_REQUEST_LOOP;
410
411 #if CONFIG_SWRESAMPLE
412     if (ebur128->peak_mode & PEAK_MODE_TRUE_PEAKS) {
413         int ret;
414
415         ebur128->swr_buf    = av_malloc(19200 * nb_channels * sizeof(double));
416         ebur128->true_peaks = av_calloc(nb_channels, sizeof(*ebur128->true_peaks));
417         ebur128->swr_ctx    = swr_alloc();
418         if (!ebur128->swr_buf || !ebur128->true_peaks || !ebur128->swr_ctx)
419             return AVERROR(ENOMEM);
420
421         av_opt_set_int(ebur128->swr_ctx, "in_channel_layout",    outlink->channel_layout, 0);
422         av_opt_set_int(ebur128->swr_ctx, "in_sample_rate",       outlink->sample_rate, 0);
423         av_opt_set_sample_fmt(ebur128->swr_ctx, "in_sample_fmt", outlink->format, 0);
424
425         av_opt_set_int(ebur128->swr_ctx, "out_channel_layout",    outlink->channel_layout, 0);
426         av_opt_set_int(ebur128->swr_ctx, "out_sample_rate",       192000, 0);
427         av_opt_set_sample_fmt(ebur128->swr_ctx, "out_sample_fmt", outlink->format, 0);
428
429         ret = swr_init(ebur128->swr_ctx);
430         if (ret < 0)
431             return ret;
432     }
433 #endif
434
435     if (ebur128->peak_mode & PEAK_MODE_SAMPLES_PEAKS) {
436         ebur128->sample_peaks = av_calloc(nb_channels, sizeof(*ebur128->sample_peaks));
437         if (!ebur128->sample_peaks)
438             return AVERROR(ENOMEM);
439     }
440
441     return 0;
442 }
443
444 #define ENERGY(loudness) (pow(10, ((loudness) + 0.691) / 10.))
445 #define LOUDNESS(energy) (-0.691 + 10 * log10(energy))
446
447 static struct hist_entry *get_histogram(void)
448 {
449     int i;
450     struct hist_entry *h = av_calloc(HIST_SIZE, sizeof(*h));
451
452     if (!h)
453         return NULL;
454     for (i = 0; i < HIST_SIZE; i++) {
455         h[i].loudness = i / (double)HIST_GRAIN + ABS_THRES;
456         h[i].energy   = ENERGY(h[i].loudness);
457     }
458     return h;
459 }
460
461 static av_cold int init(AVFilterContext *ctx)
462 {
463     EBUR128Context *ebur128 = ctx->priv;
464     AVFilterPad pad;
465
466     if (ebur128->loglevel != AV_LOG_INFO &&
467         ebur128->loglevel != AV_LOG_VERBOSE) {
468         if (ebur128->do_video || ebur128->metadata)
469             ebur128->loglevel = AV_LOG_VERBOSE;
470         else
471             ebur128->loglevel = AV_LOG_INFO;
472     }
473
474     if (!CONFIG_SWRESAMPLE && (ebur128->peak_mode & PEAK_MODE_TRUE_PEAKS)) {
475         av_log(ctx, AV_LOG_ERROR,
476                "True-peak mode requires libswresample to be performed\n");
477         return AVERROR(EINVAL);
478     }
479
480     // if meter is  +9 scale, scale range is from -18 LU to  +9 LU (or 3*9)
481     // if meter is +18 scale, scale range is from -36 LU to +18 LU (or 3*18)
482     ebur128->scale_range = 3 * ebur128->meter;
483
484     ebur128->i400.histogram  = get_histogram();
485     ebur128->i3000.histogram = get_histogram();
486     if (!ebur128->i400.histogram || !ebur128->i3000.histogram)
487         return AVERROR(ENOMEM);
488
489     ebur128->integrated_loudness = ABS_THRES;
490     ebur128->loudness_range = 0;
491
492     /* insert output pads */
493     if (ebur128->do_video) {
494         pad = (AVFilterPad){
495             .name         = av_strdup("out0"),
496             .type         = AVMEDIA_TYPE_VIDEO,
497             .config_props = config_video_output,
498         };
499         if (!pad.name)
500             return AVERROR(ENOMEM);
501         ff_insert_outpad(ctx, 0, &pad);
502     }
503     pad = (AVFilterPad){
504         .name         = av_asprintf("out%d", ebur128->do_video),
505         .type         = AVMEDIA_TYPE_AUDIO,
506         .config_props = config_audio_output,
507     };
508     if (!pad.name)
509         return AVERROR(ENOMEM);
510     ff_insert_outpad(ctx, ebur128->do_video, &pad);
511
512     /* summary */
513     av_log(ctx, AV_LOG_VERBOSE, "EBU +%d scale\n", ebur128->meter);
514
515     return 0;
516 }
517
518 #define HIST_POS(power) (int)(((power) - ABS_THRES) * HIST_GRAIN)
519
520 /* loudness and power should be set such as loudness = -0.691 +
521  * 10*log10(power), we just avoid doing that calculus two times */
522 static int gate_update(struct integrator *integ, double power,
523                        double loudness, int gate_thres)
524 {
525     int ipower;
526     double relative_threshold;
527     int gate_hist_pos;
528
529     /* update powers histograms by incrementing current power count */
530     ipower = av_clip(HIST_POS(loudness), 0, HIST_SIZE - 1);
531     integ->histogram[ipower].count++;
532
533     /* compute relative threshold and get its position in the histogram */
534     integ->sum_kept_powers += power;
535     integ->nb_kept_powers++;
536     relative_threshold = integ->sum_kept_powers / integ->nb_kept_powers;
537     if (!relative_threshold)
538         relative_threshold = 1e-12;
539     integ->rel_threshold = LOUDNESS(relative_threshold) + gate_thres;
540     gate_hist_pos = av_clip(HIST_POS(integ->rel_threshold), 0, HIST_SIZE - 1);
541
542     return gate_hist_pos;
543 }
544
545 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
546 {
547     int i, ch, idx_insample;
548     AVFilterContext *ctx = inlink->dst;
549     EBUR128Context *ebur128 = ctx->priv;
550     const int nb_channels = ebur128->nb_channels;
551     const int nb_samples  = insamples->nb_samples;
552     const double *samples = (double *)insamples->data[0];
553     AVFrame *pic = ebur128->outpicref;
554
555 #if CONFIG_SWRESAMPLE
556     if (ebur128->peak_mode & PEAK_MODE_TRUE_PEAKS) {
557         const double *swr_samples = ebur128->swr_buf;
558         int ret = swr_convert(ebur128->swr_ctx, (uint8_t**)&ebur128->swr_buf, 19200,
559                               (const uint8_t **)insamples->data, nb_samples);
560         if (ret < 0)
561             return ret;
562         for (idx_insample = 0; idx_insample < ret; idx_insample++) {
563             for (ch = 0; ch < nb_channels; ch++) {
564                 ebur128->true_peaks[ch] = FFMAX(ebur128->true_peaks[ch], FFABS(*swr_samples));
565                 swr_samples++;
566             }
567         }
568     }
569 #endif
570
571     for (idx_insample = 0; idx_insample < nb_samples; idx_insample++) {
572         const int bin_id_400  = ebur128->i400.cache_pos;
573         const int bin_id_3000 = ebur128->i3000.cache_pos;
574
575 #define MOVE_TO_NEXT_CACHED_ENTRY(time) do {                \
576     ebur128->i##time.cache_pos++;                           \
577     if (ebur128->i##time.cache_pos == I##time##_BINS) {     \
578         ebur128->i##time.filled    = 1;                     \
579         ebur128->i##time.cache_pos = 0;                     \
580     }                                                       \
581 } while (0)
582
583         MOVE_TO_NEXT_CACHED_ENTRY(400);
584         MOVE_TO_NEXT_CACHED_ENTRY(3000);
585
586         for (ch = 0; ch < nb_channels; ch++) {
587             double bin;
588
589             if (ebur128->peak_mode & PEAK_MODE_SAMPLES_PEAKS)
590                 ebur128->sample_peaks[ch] = FFMAX(ebur128->sample_peaks[ch], FFABS(*samples));
591
592             ebur128->x[ch * 3] = *samples++; // set X[i]
593
594             if (!ebur128->ch_weighting[ch])
595                 continue;
596
597             /* Y[i] = X[i]*b0 + X[i-1]*b1 + X[i-2]*b2 - Y[i-1]*a1 - Y[i-2]*a2 */
598 #define FILTER(Y, X, name) do {                                                 \
599             double *dst = ebur128->Y + ch*3;                                    \
600             double *src = ebur128->X + ch*3;                                    \
601             dst[2] = dst[1];                                                    \
602             dst[1] = dst[0];                                                    \
603             dst[0] = src[0]*name##_B0 + src[1]*name##_B1 + src[2]*name##_B2     \
604                                       - dst[1]*name##_A1 - dst[2]*name##_A2;    \
605 } while (0)
606
607             // TODO: merge both filters in one?
608             FILTER(y, x, PRE);  // apply pre-filter
609             ebur128->x[ch * 3 + 2] = ebur128->x[ch * 3 + 1];
610             ebur128->x[ch * 3 + 1] = ebur128->x[ch * 3    ];
611             FILTER(z, y, RLB);  // apply RLB-filter
612
613             bin = ebur128->z[ch * 3] * ebur128->z[ch * 3];
614
615             /* add the new value, and limit the sum to the cache size (400ms or 3s)
616              * by removing the oldest one */
617             ebur128->i400.sum [ch] = ebur128->i400.sum [ch] + bin - ebur128->i400.cache [ch][bin_id_400];
618             ebur128->i3000.sum[ch] = ebur128->i3000.sum[ch] + bin - ebur128->i3000.cache[ch][bin_id_3000];
619
620             /* override old cache entry with the new value */
621             ebur128->i400.cache [ch][bin_id_400 ] = bin;
622             ebur128->i3000.cache[ch][bin_id_3000] = bin;
623         }
624
625         /* For integrated loudness, gating blocks are 400ms long with 75%
626          * overlap (see BS.1770-2 p5), so a re-computation is needed each 100ms
627          * (4800 samples at 48kHz). */
628         if (++ebur128->sample_count == 4800) {
629             double loudness_400, loudness_3000;
630             double power_400 = 1e-12, power_3000 = 1e-12;
631             AVFilterLink *outlink = ctx->outputs[0];
632             const int64_t pts = insamples->pts +
633                 av_rescale_q(idx_insample, (AVRational){ 1, inlink->sample_rate },
634                              outlink->time_base);
635
636             ebur128->sample_count = 0;
637
638 #define COMPUTE_LOUDNESS(m, time) do {                                              \
639     if (ebur128->i##time.filled) {                                                  \
640         /* weighting sum of the last <time> ms */                                   \
641         for (ch = 0; ch < nb_channels; ch++)                                        \
642             power_##time += ebur128->ch_weighting[ch] * ebur128->i##time.sum[ch];   \
643         power_##time /= I##time##_BINS;                                             \
644     }                                                                               \
645     loudness_##time = LOUDNESS(power_##time);                                       \
646 } while (0)
647
648             COMPUTE_LOUDNESS(M,  400);
649             COMPUTE_LOUDNESS(S, 3000);
650
651             /* Integrated loudness */
652 #define I_GATE_THRES -10  // initially defined to -8 LU in the first EBU standard
653
654             if (loudness_400 >= ABS_THRES) {
655                 double integrated_sum = 0;
656                 int nb_integrated = 0;
657                 int gate_hist_pos = gate_update(&ebur128->i400, power_400,
658                                                 loudness_400, I_GATE_THRES);
659
660                 /* compute integrated loudness by summing the histogram values
661                  * above the relative threshold */
662                 for (i = gate_hist_pos; i < HIST_SIZE; i++) {
663                     const int nb_v = ebur128->i400.histogram[i].count;
664                     nb_integrated  += nb_v;
665                     integrated_sum += nb_v * ebur128->i400.histogram[i].energy;
666                 }
667                 if (nb_integrated)
668                     ebur128->integrated_loudness = LOUDNESS(integrated_sum / nb_integrated);
669             }
670
671             /* LRA */
672 #define LRA_GATE_THRES -20
673 #define LRA_LOWER_PRC   10
674 #define LRA_HIGHER_PRC  95
675
676             /* XXX: example code in EBU 3342 is ">=" but formula in BS.1770
677              * specs is ">" */
678             if (loudness_3000 >= ABS_THRES) {
679                 int nb_powers = 0;
680                 int gate_hist_pos = gate_update(&ebur128->i3000, power_3000,
681                                                 loudness_3000, LRA_GATE_THRES);
682
683                 for (i = gate_hist_pos; i < HIST_SIZE; i++)
684                     nb_powers += ebur128->i3000.histogram[i].count;
685                 if (nb_powers) {
686                     int n, nb_pow;
687
688                     /* get lower loudness to consider */
689                     n = 0;
690                     nb_pow = LRA_LOWER_PRC  * nb_powers / 100. + 0.5;
691                     for (i = gate_hist_pos; i < HIST_SIZE; i++) {
692                         n += ebur128->i3000.histogram[i].count;
693                         if (n >= nb_pow) {
694                             ebur128->lra_low = ebur128->i3000.histogram[i].loudness;
695                             break;
696                         }
697                     }
698
699                     /* get higher loudness to consider */
700                     n = nb_powers;
701                     nb_pow = LRA_HIGHER_PRC * nb_powers / 100. + 0.5;
702                     for (i = HIST_SIZE - 1; i >= 0; i--) {
703                         n -= ebur128->i3000.histogram[i].count;
704                         if (n < nb_pow) {
705                             ebur128->lra_high = ebur128->i3000.histogram[i].loudness;
706                             break;
707                         }
708                     }
709
710                     // XXX: show low & high on the graph?
711                     ebur128->loudness_range = ebur128->lra_high - ebur128->lra_low;
712                 }
713             }
714
715 #define LOG_FMT "M:%6.1f S:%6.1f     I:%6.1f LUFS     LRA:%6.1f LU"
716
717             /* push one video frame */
718             if (ebur128->do_video) {
719                 int x, y, ret;
720                 uint8_t *p;
721
722                 const int y_loudness_lu_graph = lu_to_y(ebur128, loudness_3000 + 23);
723                 const int y_loudness_lu_gauge = lu_to_y(ebur128, loudness_400  + 23);
724
725                 /* draw the graph using the short-term loudness */
726                 p = pic->data[0] + ebur128->graph.y*pic->linesize[0] + ebur128->graph.x*3;
727                 for (y = 0; y < ebur128->graph.h; y++) {
728                     const uint8_t *c = get_graph_color(ebur128, y_loudness_lu_graph, y);
729
730                     memmove(p, p + 3, (ebur128->graph.w - 1) * 3);
731                     memcpy(p + (ebur128->graph.w - 1) * 3, c, 3);
732                     p += pic->linesize[0];
733                 }
734
735                 /* draw the gauge using the momentary loudness */
736                 p = pic->data[0] + ebur128->gauge.y*pic->linesize[0] + ebur128->gauge.x*3;
737                 for (y = 0; y < ebur128->gauge.h; y++) {
738                     const uint8_t *c = get_graph_color(ebur128, y_loudness_lu_gauge, y);
739
740                     for (x = 0; x < ebur128->gauge.w; x++)
741                         memcpy(p + x*3, c, 3);
742                     p += pic->linesize[0];
743                 }
744
745                 /* draw textual info */
746                 drawtext(pic, PAD, PAD - PAD/2, FONT16, font_colors,
747                          LOG_FMT "     ", // padding to erase trailing characters
748                          loudness_400, loudness_3000,
749                          ebur128->integrated_loudness, ebur128->loudness_range);
750
751                 /* set pts and push frame */
752                 pic->pts = pts;
753                 ret = ff_filter_frame(outlink, av_frame_clone(pic));
754                 if (ret < 0)
755                     return ret;
756             }
757
758             if (ebur128->metadata) { /* happens only once per filter_frame call */
759                 char metabuf[128];
760 #define META_PREFIX "lavfi.r128."
761
762 #define SET_META(name, var) do {                                            \
763     snprintf(metabuf, sizeof(metabuf), "%.3f", var);                        \
764     av_dict_set(&insamples->metadata, name, metabuf, 0);                    \
765 } while (0)
766
767 #define SET_META_PEAK(name, ptype) do {                                     \
768     if (ebur128->peak_mode & PEAK_MODE_ ## ptype ## _PEAKS) {               \
769         char key[64];                                                       \
770         for (ch = 0; ch < nb_channels; ch++) {                              \
771             snprintf(key, sizeof(key),                                      \
772                      META_PREFIX AV_STRINGIFY(name) "_peaks_ch%d", ch);     \
773             SET_META(key, ebur128->name##_peaks[ch]);                       \
774         }                                                                   \
775     }                                                                       \
776 } while (0)
777
778                 SET_META(META_PREFIX "M",        loudness_400);
779                 SET_META(META_PREFIX "S",        loudness_3000);
780                 SET_META(META_PREFIX "I",        ebur128->integrated_loudness);
781                 SET_META(META_PREFIX "LRA",      ebur128->loudness_range);
782                 SET_META(META_PREFIX "LRA.low",  ebur128->lra_low);
783                 SET_META(META_PREFIX "LRA.high", ebur128->lra_high);
784
785                 SET_META_PEAK(sample, SAMPLES);
786                 SET_META_PEAK(true,   TRUE);
787             }
788
789             av_log(ctx, ebur128->loglevel, "t: %-10s " LOG_FMT,
790                    av_ts2timestr(pts, &outlink->time_base),
791                    loudness_400, loudness_3000,
792                    ebur128->integrated_loudness, ebur128->loudness_range);
793
794 #define PRINT_PEAKS(str, sp, ptype) do {                        \
795     if (ebur128->peak_mode & PEAK_MODE_ ## ptype ## _PEAKS) {   \
796         av_log(ctx, ebur128->loglevel, " [" str ":");           \
797         for (ch = 0; ch < nb_channels; ch++)                    \
798             av_log(ctx, ebur128->loglevel, " %.5f", sp[ch]);    \
799         av_log(ctx, ebur128->loglevel, "]");                    \
800     }                                                           \
801 } while (0)
802
803             PRINT_PEAKS("SPK", ebur128->sample_peaks, SAMPLES);
804             PRINT_PEAKS("TPK", ebur128->true_peaks,   TRUE);
805             av_log(ctx, ebur128->loglevel, "\n");
806         }
807     }
808
809     return ff_filter_frame(ctx->outputs[ebur128->do_video], insamples);
810 }
811
812 static int query_formats(AVFilterContext *ctx)
813 {
814     EBUR128Context *ebur128 = ctx->priv;
815     AVFilterFormats *formats;
816     AVFilterChannelLayouts *layouts;
817     AVFilterLink *inlink = ctx->inputs[0];
818     AVFilterLink *outlink = ctx->outputs[0];
819
820     static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_DBL, AV_SAMPLE_FMT_NONE };
821     static const int input_srate[] = {48000, -1}; // ITU-R BS.1770 provides coeff only for 48kHz
822     static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGB24, AV_PIX_FMT_NONE };
823
824     /* set optional output video format */
825     if (ebur128->do_video) {
826         formats = ff_make_format_list(pix_fmts);
827         if (!formats)
828             return AVERROR(ENOMEM);
829         ff_formats_ref(formats, &outlink->in_formats);
830         outlink = ctx->outputs[1];
831     }
832
833     /* set input and output audio formats
834      * Note: ff_set_common_* functions are not used because they affect all the
835      * links, and thus break the video format negotiation */
836     formats = ff_make_format_list(sample_fmts);
837     if (!formats)
838         return AVERROR(ENOMEM);
839     ff_formats_ref(formats, &inlink->out_formats);
840     ff_formats_ref(formats, &outlink->in_formats);
841
842     layouts = ff_all_channel_layouts();
843     if (!layouts)
844         return AVERROR(ENOMEM);
845     ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts);
846     ff_channel_layouts_ref(layouts, &outlink->in_channel_layouts);
847
848     formats = ff_make_format_list(input_srate);
849     if (!formats)
850         return AVERROR(ENOMEM);
851     ff_formats_ref(formats, &inlink->out_samplerates);
852     ff_formats_ref(formats, &outlink->in_samplerates);
853
854     return 0;
855 }
856
857 static av_cold void uninit(AVFilterContext *ctx)
858 {
859     int i;
860     EBUR128Context *ebur128 = ctx->priv;
861
862     av_log(ctx, AV_LOG_INFO, "Summary:\n\n"
863            "  Integrated loudness:\n"
864            "    I:         %5.1f LUFS\n"
865            "    Threshold: %5.1f LUFS\n\n"
866            "  Loudness range:\n"
867            "    LRA:       %5.1f LU\n"
868            "    Threshold: %5.1f LUFS\n"
869            "    LRA low:   %5.1f LUFS\n"
870            "    LRA high:  %5.1f LUFS\n",
871            ebur128->integrated_loudness, ebur128->i400.rel_threshold,
872            ebur128->loudness_range,      ebur128->i3000.rel_threshold,
873            ebur128->lra_low, ebur128->lra_high);
874
875     av_freep(&ebur128->y_line_ref);
876     av_freep(&ebur128->ch_weighting);
877     av_freep(&ebur128->true_peaks);
878     av_freep(&ebur128->sample_peaks);
879     av_freep(&ebur128->i400.histogram);
880     av_freep(&ebur128->i3000.histogram);
881     for (i = 0; i < ebur128->nb_channels; i++) {
882         av_freep(&ebur128->i400.cache[i]);
883         av_freep(&ebur128->i3000.cache[i]);
884     }
885     for (i = 0; i < ctx->nb_outputs; i++)
886         av_freep(&ctx->output_pads[i].name);
887     av_frame_free(&ebur128->outpicref);
888 #if CONFIG_SWRESAMPLE
889     av_freep(&ebur128->swr_buf);
890     swr_free(&ebur128->swr_ctx);
891 #endif
892 }
893
894 static const AVFilterPad ebur128_inputs[] = {
895     {
896         .name         = "default",
897         .type         = AVMEDIA_TYPE_AUDIO,
898         .filter_frame = filter_frame,
899         .config_props = config_audio_input,
900     },
901     { NULL }
902 };
903
904 AVFilter ff_af_ebur128 = {
905     .name          = "ebur128",
906     .description   = NULL_IF_CONFIG_SMALL("EBU R128 scanner."),
907     .priv_size     = sizeof(EBUR128Context),
908     .init          = init,
909     .uninit        = uninit,
910     .query_formats = query_formats,
911     .inputs        = ebur128_inputs,
912     .outputs       = NULL,
913     .priv_class    = &ebur128_class,
914     .flags         = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
915 };