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