FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
f_ebur128.c
Go to the documentation of this file.
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"
37 #include "libavutil/opt.h"
38 #include "libavutil/timestamp.h"
39 #include "audio.h"
40 #include "avfilter.h"
41 #include "formats.h"
42 #include "internal.h"
43 
44 #define MAX_CHANNELS 63
45 
46 /* pre-filter coefficients */
47 #define PRE_B0 1.53512485958697
48 #define PRE_B1 -2.69169618940638
49 #define PRE_B2 1.19839281085285
50 #define PRE_A1 -1.69065929318241
51 #define PRE_A2 0.73248077421585
52 
53 /* RLB-filter coefficients */
54 #define RLB_B0 1.0
55 #define RLB_B1 -2.0
56 #define RLB_B2 1.0
57 #define RLB_A1 -1.99004745483398
58 #define RLB_A2 0.99007225036621
59 
60 #define ABS_THRES -70 ///< silence gate: we discard anything below this absolute (LUFS) threshold
61 #define ABS_UP_THRES 10 ///< upper loud limit to consider (ABS_THRES being the minimum)
62 #define HIST_GRAIN 100 ///< defines histogram precision
63 #define HIST_SIZE ((ABS_UP_THRES - ABS_THRES) * HIST_GRAIN + 1)
64 
65 /**
66  * An histogram is an array of HIST_SIZE hist_entry storing all the energies
67  * recorded (with an accuracy of 1/HIST_GRAIN) of the loudnesses from ABS_THRES
68  * (at 0) to ABS_UP_THRES (at HIST_SIZE-1).
69  * This fixed-size system avoids the need of a list of energies growing
70  * infinitely over the time and is thus more scalable.
71  */
72 struct hist_entry {
73  int count; ///< how many times the corresponding value occurred
74  double energy; ///< E = 10^((L + 0.691) / 10)
75  double loudness; ///< L = -0.691 + 10 * log10(E)
76 };
77 
78 struct integrator {
79  double *cache[MAX_CHANNELS]; ///< window of filtered samples (N ms)
80  int cache_pos; ///< focus on the last added bin in the cache array
81  double sum[MAX_CHANNELS]; ///< sum of the last N ms filtered samples (cache content)
82  int filled; ///< 1 if the cache is completely filled, 0 otherwise
83  double rel_threshold; ///< relative threshold
84  double sum_kept_powers; ///< sum of the powers (weighted sums) above absolute threshold
85  int nb_kept_powers; ///< number of sum above absolute threshold
86  struct hist_entry *histogram; ///< histogram of the powers, used to compute LRA and I
87 };
88 
89 struct rect { int x, y, w, h; };
90 
91 typedef struct {
92  const AVClass *class; ///< AVClass context for log and options purpose
93 
94  /* video */
95  int do_video; ///< 1 if video output enabled, 0 otherwise
96  int w, h; ///< size of the video output
97  struct rect text; ///< rectangle for the LU legend on the left
98  struct rect graph; ///< rectangle for the main graph in the center
99  struct rect gauge; ///< rectangle for the gauge on the right
100  AVFilterBufferRef *outpicref; ///< output picture reference, updated regularly
101  int meter; ///< select a EBU mode between +9 and +18
102  int scale_range; ///< the range of LU values according to the meter
103  int y_zero_lu; ///< the y value (pixel position) for 0 LU
104  int *y_line_ref; ///< y reference values for drawing the LU lines in the graph and the gauge
105 
106  /* audio */
107  int nb_channels; ///< number of channels in the input
108  double *ch_weighting; ///< channel weighting mapping
109  int sample_count; ///< sample count used for refresh frequency, reset at refresh
110 
111  /* Filter caches.
112  * The mult by 3 in the following is for X[i], X[i-1] and X[i-2] */
113  double x[MAX_CHANNELS * 3]; ///< 3 input samples cache for each channel
114  double y[MAX_CHANNELS * 3]; ///< 3 pre-filter samples cache for each channel
115  double z[MAX_CHANNELS * 3]; ///< 3 RLB-filter samples cache for each channel
116 
117 #define I400_BINS (48000 * 4 / 10)
118 #define I3000_BINS (48000 * 3)
119  struct integrator i400; ///< 400ms integrator, used for Momentary loudness (M), and Integrated loudness (I)
120  struct integrator i3000; ///< 3s integrator, used for Short term loudness (S), and Loudness Range (LRA)
121 
122  /* I and LRA specific */
123  double integrated_loudness; ///< integrated loudness in LUFS (I)
124  double loudness_range; ///< loudness range in LU (LRA)
125  double lra_low, lra_high; ///< low and high LRA values
127 
128 #define OFFSET(x) offsetof(EBUR128Context, x)
129 #define A AV_OPT_FLAG_AUDIO_PARAM
130 #define V AV_OPT_FLAG_VIDEO_PARAM
131 #define F AV_OPT_FLAG_FILTERING_PARAM
132 static const AVOption ebur128_options[] = {
133  { "video", "set video output", OFFSET(do_video), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, V|F },
134  { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x480"}, 0, 0, V|F },
135  { "meter", "set scale meter (+9 to +18)", OFFSET(meter), AV_OPT_TYPE_INT, {.i64 = 9}, 9, 18, V|F },
136  { NULL },
137 };
138 
139 AVFILTER_DEFINE_CLASS(ebur128);
140 
141 static const uint8_t graph_colors[] = {
142  0xdd, 0x66, 0x66, // value above 0LU non reached
143  0x66, 0x66, 0xdd, // value below 0LU non reached
144  0x96, 0x33, 0x33, // value above 0LU reached
145  0x33, 0x33, 0x96, // value below 0LU reached
146  0xdd, 0x96, 0x96, // value above 0LU line non reached
147  0x96, 0x96, 0xdd, // value below 0LU line non reached
148  0xdd, 0x33, 0x33, // value above 0LU line reached
149  0x33, 0x33, 0xdd, // value below 0LU line reached
150 };
151 
152 static const uint8_t *get_graph_color(const EBUR128Context *ebur128, int v, int y)
153 {
154  const int below0 = y > ebur128->y_zero_lu;
155  const int reached = y >= v;
156  const int line = ebur128->y_line_ref[y] || y == ebur128->y_zero_lu;
157  const int colorid = 4*line + 2*reached + below0;
158  return graph_colors + 3*colorid;
159 }
160 
161 static inline int lu_to_y(const EBUR128Context *ebur128, double v)
162 {
163  v += 2 * ebur128->meter; // make it in range [0;...]
164  v = av_clipf(v, 0, ebur128->scale_range); // make sure it's in the graph scale
165  v = ebur128->scale_range - v; // invert value (y=0 is on top)
166  return v * ebur128->graph.h / ebur128->scale_range; // rescale from scale range to px height
167 }
168 
169 #define FONT8 0
170 #define FONT16 1
171 
172 static const uint8_t font_colors[] = {
173  0xdd, 0xdd, 0x00,
174  0x00, 0x96, 0x96,
175 };
176 
177 static void drawtext(AVFilterBufferRef *pic, int x, int y, int ftid, const uint8_t *color, const char *fmt, ...)
178 {
179  int i;
180  char buf[128] = {0};
181  const uint8_t *font;
182  int font_height;
183  va_list vl;
184 
185  if (ftid == FONT16) font = avpriv_vga16_font, font_height = 16;
186  else if (ftid == FONT8) font = avpriv_cga_font, font_height = 8;
187  else return;
188 
189  va_start(vl, fmt);
190  vsnprintf(buf, sizeof(buf), fmt, vl);
191  va_end(vl);
192 
193  for (i = 0; buf[i]; i++) {
194  int char_y, mask;
195  uint8_t *p = pic->data[0] + y*pic->linesize[0] + (x + i*8)*3;
196 
197  for (char_y = 0; char_y < font_height; char_y++) {
198  for (mask = 0x80; mask; mask >>= 1) {
199  if (font[buf[i] * font_height + char_y] & mask)
200  memcpy(p, color, 3);
201  else
202  memcpy(p, "\x00\x00\x00", 3);
203  p += 3;
204  }
205  p += pic->linesize[0] - 8*3;
206  }
207  }
208 }
209 
210 static void drawline(AVFilterBufferRef *pic, int x, int y, int len, int step)
211 {
212  int i;
213  uint8_t *p = pic->data[0] + y*pic->linesize[0] + x*3;
214 
215  for (i = 0; i < len; i++) {
216  memcpy(p, "\x00\xff\x00", 3);
217  p += step;
218  }
219 }
220 
221 static int config_video_output(AVFilterLink *outlink)
222 {
223  int i, x, y;
224  uint8_t *p;
225  AVFilterContext *ctx = outlink->src;
226  EBUR128Context *ebur128 = ctx->priv;
227  AVFilterBufferRef *outpicref;
228 
229  /* check if there is enough space to represent everything decently */
230  if (ebur128->w < 640 || ebur128->h < 480) {
231  av_log(ctx, AV_LOG_ERROR, "Video size %dx%d is too small, "
232  "minimum size is 640x480\n", ebur128->w, ebur128->h);
233  return AVERROR(EINVAL);
234  }
235  outlink->w = ebur128->w;
236  outlink->h = ebur128->h;
237 
238 #define PAD 8
239 
240  /* configure text area position and size */
241  ebur128->text.x = PAD;
242  ebur128->text.y = 40;
243  ebur128->text.w = 3 * 8; // 3 characters
244  ebur128->text.h = ebur128->h - PAD - ebur128->text.y;
245 
246  /* configure gauge position and size */
247  ebur128->gauge.w = 20;
248  ebur128->gauge.h = ebur128->text.h;
249  ebur128->gauge.x = ebur128->w - PAD - ebur128->gauge.w;
250  ebur128->gauge.y = ebur128->text.y;
251 
252  /* configure graph position and size */
253  ebur128->graph.x = ebur128->text.x + ebur128->text.w + PAD;
254  ebur128->graph.y = ebur128->gauge.y;
255  ebur128->graph.w = ebur128->gauge.x - ebur128->graph.x - PAD;
256  ebur128->graph.h = ebur128->gauge.h;
257 
258  /* graph and gauge share the LU-to-pixel code */
259  av_assert0(ebur128->graph.h == ebur128->gauge.h);
260 
261  /* prepare the initial picref buffer */
263  ebur128->outpicref = outpicref =
265  outlink->w, outlink->h);
266  if (!outpicref)
267  return AVERROR(ENOMEM);
268  outlink->sample_aspect_ratio = (AVRational){1,1};
269 
270  /* init y references values (to draw LU lines) */
271  ebur128->y_line_ref = av_calloc(ebur128->graph.h + 1, sizeof(*ebur128->y_line_ref));
272  if (!ebur128->y_line_ref)
273  return AVERROR(ENOMEM);
274 
275  /* black background */
276  memset(outpicref->data[0], 0, ebur128->h * outpicref->linesize[0]);
277 
278  /* draw LU legends */
279  drawtext(outpicref, PAD, PAD+16, FONT8, font_colors+3, " LU");
280  for (i = ebur128->meter; i >= -ebur128->meter * 2; i--) {
281  y = lu_to_y(ebur128, i);
282  x = PAD + (i < 10 && i > -10) * 8;
283  ebur128->y_line_ref[y] = i;
284  y -= 4; // -4 to center vertically
285  drawtext(outpicref, x, y + ebur128->graph.y, FONT8, font_colors+3,
286  "%c%d", i < 0 ? '-' : i > 0 ? '+' : ' ', FFABS(i));
287  }
288 
289  /* draw graph */
290  ebur128->y_zero_lu = lu_to_y(ebur128, 0);
291  p = outpicref->data[0] + ebur128->graph.y * outpicref->linesize[0]
292  + ebur128->graph.x * 3;
293  for (y = 0; y < ebur128->graph.h; y++) {
294  const uint8_t *c = get_graph_color(ebur128, INT_MAX, y);
295 
296  for (x = 0; x < ebur128->graph.w; x++)
297  memcpy(p + x*3, c, 3);
298  p += outpicref->linesize[0];
299  }
300 
301  /* draw fancy rectangles around the graph and the gauge */
302 #define DRAW_RECT(r) do { \
303  drawline(outpicref, r.x, r.y - 1, r.w, 3); \
304  drawline(outpicref, r.x, r.y + r.h, r.w, 3); \
305  drawline(outpicref, r.x - 1, r.y, r.h, outpicref->linesize[0]); \
306  drawline(outpicref, r.x + r.w, r.y, r.h, outpicref->linesize[0]); \
307 } while (0)
308  DRAW_RECT(ebur128->graph);
309  DRAW_RECT(ebur128->gauge);
310 
311  return 0;
312 }
313 
314 static int config_audio_output(AVFilterLink *outlink)
315 {
316  int i;
317  int idx_bitposn = 0;
318  AVFilterContext *ctx = outlink->src;
319  EBUR128Context *ebur128 = ctx->priv;
321 
322 #define BACK_MASK (AV_CH_BACK_LEFT |AV_CH_BACK_CENTER |AV_CH_BACK_RIGHT| \
323  AV_CH_TOP_BACK_LEFT|AV_CH_TOP_BACK_CENTER|AV_CH_TOP_BACK_RIGHT| \
324  AV_CH_SIDE_LEFT |AV_CH_SIDE_RIGHT| \
325  AV_CH_SURROUND_DIRECT_LEFT |AV_CH_SURROUND_DIRECT_RIGHT)
326 
327  ebur128->nb_channels = nb_channels;
328  ebur128->ch_weighting = av_calloc(nb_channels, sizeof(*ebur128->ch_weighting));
329  if (!ebur128->ch_weighting)
330  return AVERROR(ENOMEM);
331 
332  for (i = 0; i < nb_channels; i++) {
333 
334  /* find the next bit that is set starting from the right */
335  while ((outlink->channel_layout & 1ULL<<idx_bitposn) == 0 && idx_bitposn < 63)
336  idx_bitposn++;
337 
338  /* channel weighting */
339  if ((1ULL<<idx_bitposn & AV_CH_LOW_FREQUENCY) ||
340  (1ULL<<idx_bitposn & AV_CH_LOW_FREQUENCY_2)) {
341  ebur128->ch_weighting[i] = 0;
342  } else if (1ULL<<idx_bitposn & BACK_MASK) {
343  ebur128->ch_weighting[i] = 1.41;
344  } else {
345  ebur128->ch_weighting[i] = 1.0;
346  }
347 
348  idx_bitposn++;
349 
350  if (!ebur128->ch_weighting[i])
351  continue;
352 
353  /* bins buffer for the two integration window (400ms and 3s) */
354  ebur128->i400.cache[i] = av_calloc(I400_BINS, sizeof(*ebur128->i400.cache[0]));
355  ebur128->i3000.cache[i] = av_calloc(I3000_BINS, sizeof(*ebur128->i3000.cache[0]));
356  if (!ebur128->i400.cache[i] || !ebur128->i3000.cache[i])
357  return AVERROR(ENOMEM);
358  }
359 
360  return 0;
361 }
362 
363 #define ENERGY(loudness) (pow(10, ((loudness) + 0.691) / 10.))
364 #define LOUDNESS(energy) (-0.691 + 10 * log10(energy))
365 
366 static struct hist_entry *get_histogram(void)
367 {
368  int i;
369  struct hist_entry *h = av_calloc(HIST_SIZE, sizeof(*h));
370 
371  for (i = 0; i < HIST_SIZE; i++) {
372  h[i].loudness = i / (double)HIST_GRAIN + ABS_THRES;
373  h[i].energy = ENERGY(h[i].loudness);
374  }
375  return h;
376 }
377 
378 static av_cold int init(AVFilterContext *ctx, const char *args)
379 {
380  int ret;
381  EBUR128Context *ebur128 = ctx->priv;
382  AVFilterPad pad;
383 
384  ebur128->class = &ebur128_class;
385  av_opt_set_defaults(ebur128);
386 
387  if ((ret = av_set_options_string(ebur128, args, "=", ":")) < 0)
388  return ret;
389 
390  // if meter is +9 scale, scale range is from -18 LU to +9 LU (or 3*9)
391  // if meter is +18 scale, scale range is from -36 LU to +18 LU (or 3*18)
392  ebur128->scale_range = 3 * ebur128->meter;
393 
394  ebur128->i400.histogram = get_histogram();
395  ebur128->i3000.histogram = get_histogram();
396 
397  ebur128->integrated_loudness = ABS_THRES;
398  ebur128->loudness_range = 0;
399 
400  /* insert output pads */
401  if (ebur128->do_video) {
402  pad = (AVFilterPad){
403  .name = av_strdup("out0"),
404  .type = AVMEDIA_TYPE_VIDEO,
405  .config_props = config_video_output,
406  };
407  if (!pad.name)
408  return AVERROR(ENOMEM);
409  ff_insert_outpad(ctx, 0, &pad);
410  }
411  pad = (AVFilterPad){
412  .name = av_asprintf("out%d", ebur128->do_video),
413  .type = AVMEDIA_TYPE_AUDIO,
414  .config_props = config_audio_output,
415  };
416  if (!pad.name)
417  return AVERROR(ENOMEM);
418  ff_insert_outpad(ctx, ebur128->do_video, &pad);
419 
420  /* summary */
421  av_log(ctx, AV_LOG_VERBOSE, "EBU +%d scale\n", ebur128->meter);
422 
423  return 0;
424 }
425 
426 #define HIST_POS(power) (int)(((power) - ABS_THRES) * HIST_GRAIN)
427 
428 /* loudness and power should be set such as loudness = -0.691 +
429  * 10*log10(power), we just avoid doing that calculus two times */
430 static int gate_update(struct integrator *integ, double power,
431  double loudness, int gate_thres)
432 {
433  int ipower;
434  double relative_threshold;
435  int gate_hist_pos;
436 
437  /* update powers histograms by incrementing current power count */
438  ipower = av_clip(HIST_POS(loudness), 0, HIST_SIZE - 1);
439  integ->histogram[ipower].count++;
440 
441  /* compute relative threshold and get its position in the histogram */
442  integ->sum_kept_powers += power;
443  integ->nb_kept_powers++;
444  relative_threshold = integ->sum_kept_powers / integ->nb_kept_powers;
445  if (!relative_threshold)
446  relative_threshold = 1e-12;
447  integ->rel_threshold = LOUDNESS(relative_threshold) + gate_thres;
448  gate_hist_pos = av_clip(HIST_POS(integ->rel_threshold), 0, HIST_SIZE - 1);
449 
450  return gate_hist_pos;
451 }
452 
453 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *insamples)
454 {
455  int i, ch, idx_insample;
456  AVFilterContext *ctx = inlink->dst;
457  EBUR128Context *ebur128 = ctx->priv;
458  const int nb_channels = ebur128->nb_channels;
459  const int nb_samples = insamples->audio->nb_samples;
460  const double *samples = (double *)insamples->data[0];
461  AVFilterBufferRef *pic = ebur128->outpicref;
462 
463  for (idx_insample = 0; idx_insample < nb_samples; idx_insample++) {
464  const int bin_id_400 = ebur128->i400.cache_pos;
465  const int bin_id_3000 = ebur128->i3000.cache_pos;
466 
467 #define MOVE_TO_NEXT_CACHED_ENTRY(time) do { \
468  ebur128->i##time.cache_pos++; \
469  if (ebur128->i##time.cache_pos == I##time##_BINS) { \
470  ebur128->i##time.filled = 1; \
471  ebur128->i##time.cache_pos = 0; \
472  } \
473 } while (0)
474 
477 
478  for (ch = 0; ch < nb_channels; ch++) {
479  double bin;
480 
481  ebur128->x[ch * 3] = *samples++; // set X[i]
482 
483  if (!ebur128->ch_weighting[ch])
484  continue;
485 
486  /* Y[i] = X[i]*b0 + X[i-1]*b1 + X[i-2]*b2 - Y[i-1]*a1 - Y[i-2]*a2 */
487 #define FILTER(Y, X, name) do { \
488  double *dst = ebur128->Y + ch*3; \
489  double *src = ebur128->X + ch*3; \
490  dst[2] = dst[1]; \
491  dst[1] = dst[0]; \
492  dst[0] = src[0]*name##_B0 + src[1]*name##_B1 + src[2]*name##_B2 \
493  - dst[1]*name##_A1 - dst[2]*name##_A2; \
494 } while (0)
495 
496  // TODO: merge both filters in one?
497  FILTER(y, x, PRE); // apply pre-filter
498  ebur128->x[ch * 3 + 2] = ebur128->x[ch * 3 + 1];
499  ebur128->x[ch * 3 + 1] = ebur128->x[ch * 3 ];
500  FILTER(z, y, RLB); // apply RLB-filter
501 
502  bin = ebur128->z[ch * 3] * ebur128->z[ch * 3];
503 
504  /* add the new value, and limit the sum to the cache size (400ms or 3s)
505  * by removing the oldest one */
506  ebur128->i400.sum [ch] = ebur128->i400.sum [ch] + bin - ebur128->i400.cache [ch][bin_id_400];
507  ebur128->i3000.sum[ch] = ebur128->i3000.sum[ch] + bin - ebur128->i3000.cache[ch][bin_id_3000];
508 
509  /* override old cache entry with the new value */
510  ebur128->i400.cache [ch][bin_id_400 ] = bin;
511  ebur128->i3000.cache[ch][bin_id_3000] = bin;
512  }
513 
514  /* For integrated loudness, gating blocks are 400ms long with 75%
515  * overlap (see BS.1770-2 p5), so a re-computation is needed each 100ms
516  * (4800 samples at 48kHz). */
517  if (++ebur128->sample_count == 4800) {
518  double loudness_400, loudness_3000;
519  double power_400 = 1e-12, power_3000 = 1e-12;
520  AVFilterLink *outlink = ctx->outputs[0];
521  const int64_t pts = insamples->pts +
522  av_rescale_q(idx_insample, (AVRational){ 1, inlink->sample_rate },
523  outlink->time_base);
524 
525  ebur128->sample_count = 0;
526 
527 #define COMPUTE_LOUDNESS(m, time) do { \
528  if (ebur128->i##time.filled) { \
529  /* weighting sum of the last <time> ms */ \
530  for (ch = 0; ch < nb_channels; ch++) \
531  power_##time += ebur128->ch_weighting[ch] * ebur128->i##time.sum[ch]; \
532  power_##time /= I##time##_BINS; \
533  } \
534  loudness_##time = LOUDNESS(power_##time); \
535 } while (0)
536 
537  COMPUTE_LOUDNESS(M, 400);
538  COMPUTE_LOUDNESS(S, 3000);
539 
540  /* Integrated loudness */
541 #define I_GATE_THRES -10 // initially defined to -8 LU in the first EBU standard
542 
543  if (loudness_400 >= ABS_THRES) {
544  double integrated_sum = 0;
545  int nb_integrated = 0;
546  int gate_hist_pos = gate_update(&ebur128->i400, power_400,
547  loudness_400, I_GATE_THRES);
548 
549  /* compute integrated loudness by summing the histogram values
550  * above the relative threshold */
551  for (i = gate_hist_pos; i < HIST_SIZE; i++) {
552  const int nb_v = ebur128->i400.histogram[i].count;
553  nb_integrated += nb_v;
554  integrated_sum += nb_v * ebur128->i400.histogram[i].energy;
555  }
556  if (nb_integrated)
557  ebur128->integrated_loudness = LOUDNESS(integrated_sum / nb_integrated);
558  }
559 
560  /* LRA */
561 #define LRA_GATE_THRES -20
562 #define LRA_LOWER_PRC 10
563 #define LRA_HIGHER_PRC 95
564 
565  /* XXX: example code in EBU 3342 is ">=" but formula in BS.1770
566  * specs is ">" */
567  if (loudness_3000 >= ABS_THRES) {
568  int nb_powers = 0;
569  int gate_hist_pos = gate_update(&ebur128->i3000, power_3000,
570  loudness_3000, LRA_GATE_THRES);
571 
572  for (i = gate_hist_pos; i < HIST_SIZE; i++)
573  nb_powers += ebur128->i3000.histogram[i].count;
574  if (nb_powers) {
575  int n, nb_pow;
576 
577  /* get lower loudness to consider */
578  n = 0;
579  nb_pow = LRA_LOWER_PRC * nb_powers / 100. + 0.5;
580  for (i = gate_hist_pos; i < HIST_SIZE; i++) {
581  n += ebur128->i3000.histogram[i].count;
582  if (n >= nb_pow) {
583  ebur128->lra_low = ebur128->i3000.histogram[i].loudness;
584  break;
585  }
586  }
587 
588  /* get higher loudness to consider */
589  n = nb_powers;
590  nb_pow = LRA_HIGHER_PRC * nb_powers / 100. + 0.5;
591  for (i = HIST_SIZE - 1; i >= 0; i--) {
592  n -= ebur128->i3000.histogram[i].count;
593  if (n < nb_pow) {
594  ebur128->lra_high = ebur128->i3000.histogram[i].loudness;
595  break;
596  }
597  }
598 
599  // XXX: show low & high on the graph?
600  ebur128->loudness_range = ebur128->lra_high - ebur128->lra_low;
601  }
602  }
603 
604 #define LOG_FMT "M:%6.1f S:%6.1f I:%6.1f LUFS LRA:%6.1f LU"
605 
606  /* push one video frame */
607  if (ebur128->do_video) {
608  int x, y, ret;
609  uint8_t *p;
610 
611  const int y_loudness_lu_graph = lu_to_y(ebur128, loudness_3000 + 23);
612  const int y_loudness_lu_gauge = lu_to_y(ebur128, loudness_400 + 23);
613 
614  /* draw the graph using the short-term loudness */
615  p = pic->data[0] + ebur128->graph.y*pic->linesize[0] + ebur128->graph.x*3;
616  for (y = 0; y < ebur128->graph.h; y++) {
617  const uint8_t *c = get_graph_color(ebur128, y_loudness_lu_graph, y);
618 
619  memmove(p, p + 3, (ebur128->graph.w - 1) * 3);
620  memcpy(p + (ebur128->graph.w - 1) * 3, c, 3);
621  p += pic->linesize[0];
622  }
623 
624  /* draw the gauge using the momentary loudness */
625  p = pic->data[0] + ebur128->gauge.y*pic->linesize[0] + ebur128->gauge.x*3;
626  for (y = 0; y < ebur128->gauge.h; y++) {
627  const uint8_t *c = get_graph_color(ebur128, y_loudness_lu_gauge, y);
628 
629  for (x = 0; x < ebur128->gauge.w; x++)
630  memcpy(p + x*3, c, 3);
631  p += pic->linesize[0];
632  }
633 
634  /* draw textual info */
635  drawtext(pic, PAD, PAD - PAD/2, FONT16, font_colors,
636  LOG_FMT " ", // padding to erase trailing characters
637  loudness_400, loudness_3000,
638  ebur128->integrated_loudness, ebur128->loudness_range);
639 
640  /* set pts and push frame */
641  pic->pts = pts;
642  ret = ff_filter_frame(outlink, avfilter_ref_buffer(pic, ~AV_PERM_WRITE));
643  if (ret < 0)
644  return ret;
645  }
646 
647  av_log(ctx, ebur128->do_video ? AV_LOG_VERBOSE : AV_LOG_INFO,
648  "t: %-10s " LOG_FMT "\n", av_ts2timestr(pts, &outlink->time_base),
649  loudness_400, loudness_3000,
650  ebur128->integrated_loudness, ebur128->loudness_range);
651  }
652  }
653 
654  return ff_filter_frame(ctx->outputs[ebur128->do_video], insamples);
655 }
656 
658 {
659  EBUR128Context *ebur128 = ctx->priv;
662  AVFilterLink *inlink = ctx->inputs[0];
663  AVFilterLink *outlink = ctx->outputs[0];
664 
666  static const int input_srate[] = {48000, -1}; // ITU-R BS.1770 provides coeff only for 48kHz
667  static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGB24, AV_PIX_FMT_NONE };
668 
669  /* set input audio formats */
670  formats = ff_make_format_list(sample_fmts);
671  if (!formats)
672  return AVERROR(ENOMEM);
673  ff_formats_ref(formats, &inlink->out_formats);
674 
675  layouts = ff_all_channel_layouts();
676  if (!layouts)
677  return AVERROR(ENOMEM);
678  ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts);
679 
680  formats = ff_make_format_list(input_srate);
681  if (!formats)
682  return AVERROR(ENOMEM);
683  ff_formats_ref(formats, &inlink->out_samplerates);
684 
685  /* set optional output video format */
686  if (ebur128->do_video) {
687  formats = ff_make_format_list(pix_fmts);
688  if (!formats)
689  return AVERROR(ENOMEM);
690  ff_formats_ref(formats, &outlink->in_formats);
691  outlink = ctx->outputs[1];
692  }
693 
694  /* set audio output formats (same as input since it's just a passthrough) */
695  formats = ff_make_format_list(sample_fmts);
696  if (!formats)
697  return AVERROR(ENOMEM);
698  ff_formats_ref(formats, &outlink->in_formats);
699 
700  layouts = ff_all_channel_layouts();
701  if (!layouts)
702  return AVERROR(ENOMEM);
703  ff_channel_layouts_ref(layouts, &outlink->in_channel_layouts);
704 
705  formats = ff_make_format_list(input_srate);
706  if (!formats)
707  return AVERROR(ENOMEM);
708  ff_formats_ref(formats, &outlink->in_samplerates);
709 
710  return 0;
711 }
712 
713 static av_cold void uninit(AVFilterContext *ctx)
714 {
715  int i;
716  EBUR128Context *ebur128 = ctx->priv;
717 
718  av_log(ctx, AV_LOG_INFO, "Summary:\n\n"
719  " Integrated loudness:\n"
720  " I: %5.1f LUFS\n"
721  " Threshold: %5.1f LUFS\n\n"
722  " Loudness range:\n"
723  " LRA: %5.1f LU\n"
724  " Threshold: %5.1f LUFS\n"
725  " LRA low: %5.1f LUFS\n"
726  " LRA high: %5.1f LUFS\n",
727  ebur128->integrated_loudness, ebur128->i400.rel_threshold,
728  ebur128->loudness_range, ebur128->i3000.rel_threshold,
729  ebur128->lra_low, ebur128->lra_high);
730 
731  av_freep(&ebur128->y_line_ref);
732  av_freep(&ebur128->ch_weighting);
733  av_freep(&ebur128->i400.histogram);
734  av_freep(&ebur128->i3000.histogram);
735  for (i = 0; i < ebur128->nb_channels; i++) {
736  av_freep(&ebur128->i400.cache[i]);
737  av_freep(&ebur128->i3000.cache[i]);
738  }
739  for (i = 0; i < ctx->nb_outputs; i++)
740  av_freep(&ctx->output_pads[i].name);
742 }
743 
744 static const AVFilterPad ebur128_inputs[] = {
745  {
746  .name = "default",
747  .type = AVMEDIA_TYPE_AUDIO,
748  .get_audio_buffer = ff_null_get_audio_buffer,
749  .filter_frame = filter_frame,
750  },
751  { NULL }
752 };
753 
755  .name = "ebur128",
756  .description = NULL_IF_CONFIG_SMALL("EBU R128 scanner."),
757  .priv_size = sizeof(EBUR128Context),
758  .init = init,
759  .uninit = uninit,
761  .inputs = ebur128_inputs,
762  .outputs = NULL,
763  .priv_class = &ebur128_class,
764 };