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