#include <math.h>
#include "libavutil/avassert.h"
#include "libavutil/avstring.h"
#include "libavutil/channel_layout.h"
#include "libavutil/dict.h"
#include "libavutil/ffmath.h"
#include "libavutil/xga_font_data.h"
#include "libavutil/opt.h"
#include "libavutil/timestamp.h"
#include "libswresample/swresample.h"
#include "audio.h"
#include "avfilter.h"
#include "filters.h"
#include "formats.h"
#include "internal.h"

Data Structures
struct	hist_entry
	A histogram is an array of HIST_SIZE hist_entry storing all the energies recorded (with an accuracy of 1/HIST_GRAIN) of the loudnesses from ABS_THRES (at 0) to ABS_UP_THRES (at HIST_SIZE-1). More...

struct	integrator

struct	rect

struct	EBUR128Context

Macros
#define	ABS_THRES -70
	silence gate: we discard anything below this absolute (LUFS) threshold More...

#define	ABS_UP_THRES 10
	upper loud limit to consider (ABS_THRES being the minimum) More...

#define	HIST_GRAIN 100
	defines histogram precision More...

#define	HIST_SIZE ((ABS_UP_THRES - ABS_THRES) * HIST_GRAIN + 1)

#define	OFFSET(x) offsetof(EBUR128Context, x)

#define	A AV_OPT_FLAG_AUDIO_PARAM

#define	V AV_OPT_FLAG_VIDEO_PARAM

#define	F AV_OPT_FLAG_FILTERING_PARAM

#define	FONT8 0

#define	FONT16 1

#define	PAD 8

#define	DRAW_RECT(r)

#define	BACK_MASK

#define	I400_BINS(x) ((x) * 4 / 10)

#define	I3000_BINS(x) ((x) * 3)

#define	ENERGY(loudness) (ff_exp10(((loudness) + 0.691) / 10.))

#define	LOUDNESS(energy) (-0.691 + 10 * log10(energy))

#define	DBFS(energy) (20 * log10(energy))

#define	HIST_POS(power) (int)(((power) - ABS_THRES) * HIST_GRAIN)

#define	MOVE_TO_NEXT_CACHED_ENTRY(time)

#define	FILTER(Y, X, NUM, DEN)

#define	COMPUTE_LOUDNESS(m, time)

#define	I_GATE_THRES -10

#define	LRA_GATE_THRES -20

#define	LRA_LOWER_PRC 10

#define	LRA_HIGHER_PRC 95

#define	LOG_FMT "TARGET:%d LUFS M:%6.1f S:%6.1f I:%6.1f %s LRA:%6.1f LU"

#define	META_PREFIX "lavfi.r128."

#define	SET_META(name, var)

#define	SET_META_PEAK(name, ptype)

#define	PRINT_PEAKS(str, sp, ptype)

#define	PRINT_PEAK_SUMMARY(str, sp, ptype)

Enumerations
enum	{ PEAK_MODE_NONE = 0, PEAK_MODE_SAMPLES_PEAKS = 1<<1, PEAK_MODE_TRUE_PEAKS = 1<<2 }

enum	{ GAUGE_TYPE_MOMENTARY = 0, GAUGE_TYPE_SHORTTERM = 1 }

enum	{ SCALE_TYPE_ABSOLUTE = 0, SCALE_TYPE_RELATIVE = 1 }

Functions
	AVFILTER_DEFINE_CLASS (ebur128)

static const uint8_t *	get_graph_color (const EBUR128Context *ebur128, int v, int y)

static int	lu_to_y (const EBUR128Context *ebur128, double v)

static void	drawtext (AVFrame pic, int x, int y, int ftid, const uint8_t color, const char *fmt,...)

static void	drawline (AVFrame *pic, int x, int y, int len, int step)

static int	config_video_output (AVFilterLink *outlink)

static int	config_audio_input (AVFilterLink *inlink)

static int	config_audio_output (AVFilterLink *outlink)

static struct hist_entry *	get_histogram (void)

static av_cold int	init (AVFilterContext *ctx)

static int	gate_update (struct integrator *integ, double power, double loudness, int gate_thres)

static int	filter_frame (AVFilterLink inlink, AVFrame insamples)

static int	activate (AVFilterContext *ctx)

static int	query_formats (AVFilterContext *ctx)

static av_cold void	uninit (AVFilterContext *ctx)

Variables
static const AVOption	ebur128_options []

static const uint8_t	graph_colors []

static const uint8_t	font_colors []

static const AVFilterPad	ebur128_inputs []

const AVFilter	ff_af_ebur128

Detailed Description

EBU R.128 implementation

See also: http://tech.ebu.ch/loudness; https://www.youtube.com/watch?v=iuEtQqC-Sqo "EBU R128 Introduction - Florian Camerer"

Todo:: implement start/stop/reset through filter command injection

Definition in file f_ebur128.c.

Macro Definition Documentation

◆ ABS_THRES

#define ABS_THRES -70

silence gate: we discard anything below this absolute (LUFS) threshold

Definition at line 46 of file f_ebur128.c.

◆ ABS_UP_THRES

#define ABS_UP_THRES 10

upper loud limit to consider (ABS_THRES being the minimum)

Definition at line 47 of file f_ebur128.c.

◆ HIST_GRAIN

#define HIST_GRAIN 100

defines histogram precision

Definition at line 48 of file f_ebur128.c.

◆ HIST_SIZE

#define HIST_SIZE ((ABS_UP_THRES - ABS_THRES) * HIST_GRAIN + 1)

Definition at line 49 of file f_ebur128.c.

◆ OFFSET

#define OFFSET ( x ) offsetof(EBUR128Context, x)

Definition at line 158 of file f_ebur128.c.

◆ A

#define A AV_OPT_FLAG_AUDIO_PARAM

Definition at line 159 of file f_ebur128.c.

◆ V

#define V AV_OPT_FLAG_VIDEO_PARAM

Definition at line 160 of file f_ebur128.c.

◆ F

#define F AV_OPT_FLAG_FILTERING_PARAM

Definition at line 161 of file f_ebur128.c.

◆ FONT8

#define FONT8 0

Definition at line 230 of file f_ebur128.c.

◆ FONT16

#define FONT16 1

Definition at line 231 of file f_ebur128.c.

◆ PAD

#define PAD 8

◆ DRAW_RECT

#define DRAW_RECT ( r )

Value:

    do { \
    drawline(outpicref, r.x,       r.y - 1,   r.w, 3); \
    drawline(outpicref, r.x,       r.y + r.h, r.w, 3); \
    drawline(outpicref, r.x - 1,   r.y,       r.h, outpicref->linesize[0]); \
    drawline(outpicref, r.x + r.w, r.y,       r.h, outpicref->linesize[0]); \
} while (0)

◆ BACK_MASK

#define BACK_MASK

Value:

                   (AV_CH_BACK_LEFT    |AV_CH_BACK_CENTER    |AV_CH_BACK_RIGHT| \
                   AV_CH_TOP_BACK_LEFT|AV_CH_TOP_BACK_CENTER|AV_CH_TOP_BACK_RIGHT| \
                   AV_CH_SIDE_LEFT                          |AV_CH_SIDE_RIGHT| \
                   AV_CH_SURROUND_DIRECT_LEFT               |AV_CH_SURROUND_DIRECT_RIGHT)

◆ I400_BINS

#define I400_BINS ( x ) ((x) * 4 / 10)

◆ I3000_BINS

#define I3000_BINS ( x ) ((x) * 3)

◆ ENERGY

#define ENERGY ( loudness ) (ff_exp10(((loudness) + 0.691) / 10.))

Definition at line 515 of file f_ebur128.c.

◆ LOUDNESS

#define LOUDNESS ( energy ) (-0.691 + 10 * log10(energy))

Definition at line 516 of file f_ebur128.c.

◆ DBFS

#define DBFS ( energy ) (20 * log10(energy))

Definition at line 517 of file f_ebur128.c.

◆ HIST_POS

#define HIST_POS ( power ) (int)(((power) - ABS_THRES) * HIST_GRAIN)

Definition at line 592 of file f_ebur128.c.

◆ MOVE_TO_NEXT_CACHED_ENTRY

#define MOVE_TO_NEXT_CACHED_ENTRY ( time )

Value:

    do {                \
    ebur128->i##time.cache_pos++;                           \
    if (ebur128->i##time.cache_pos ==                       \
        ebur128->i##time.cache_size) {                      \
        ebur128->i##time.filled    = 1;                     \
        ebur128->i##time.cache_pos = 0;                     \
    }                                                       \
} while (0)

◆ FILTER

#define FILTER	(	Y,
		X,
		NUM,
		DEN
	)

Value:

            do {                                             \
            double *dst = ebur128->Y + ch*3;                                    \
            double *src = ebur128->X + ch*3;                                    \
            dst[2] = dst[1];                                                    \
            dst[1] = dst[0];                                                    \
            dst[0] = src[0]*NUM[0] + src[1]*NUM[1] + src[2]*NUM[2]              \
                                   - dst[1]*DEN[1] - dst[2]*DEN[2];             \
} while (0)

◆ COMPUTE_LOUDNESS

#define COMPUTE_LOUDNESS	(	m,
		time
	)

Value:

    do {                                              \
    if (ebur128->i##time.filled) {                                                  \
        /* weighting sum of the last <time> ms */                                   \
        for (ch = 0; ch < nb_channels; ch++)                                        \
            power_##time += ebur128->ch_weighting[ch] * ebur128->i##time.sum[ch];   \
        power_##time /= I##time##_BINS(inlink->sample_rate);                        \
    }                                                                               \
    loudness_##time = LOUDNESS(power_##time);                                       \
} while (0)

◆ I_GATE_THRES

#define I_GATE_THRES -10

◆ LRA_GATE_THRES

#define LRA_GATE_THRES -20

◆ LRA_LOWER_PRC

#define LRA_LOWER_PRC 10

◆ LRA_HIGHER_PRC

#define LRA_HIGHER_PRC 95

◆ LOG_FMT

#define LOG_FMT "TARGET:%d LUFS M:%6.1f S:%6.1f I:%6.1f %s LRA:%6.1f LU"

◆ META_PREFIX

#define META_PREFIX "lavfi.r128."

◆ SET_META

#define SET_META	(	name,
		var
	)

Value:

    do {                                            \
    snprintf(metabuf, sizeof(metabuf), "%.3f", var);                        \
    av_dict_set(&insamples->metadata, name, metabuf, 0);                    \
} while (0)

◆ SET_META_PEAK

#define SET_META_PEAK	(	name,
		ptype
	)

Value:

    do {                                     \
    if (ebur128->peak_mode & PEAK_MODE_ ## ptype ## _PEAKS) {               \
        double max_peak = 0.0;                                              \
        char key[64];                                                       \
        for (ch = 0; ch < nb_channels; ch++) {                              \
            snprintf(key, sizeof(key),                                      \
                     META_PREFIX AV_STRINGIFY(name) "_peaks_ch%d", ch);     \
            max_peak = fmax(max_peak, ebur128->name##_peaks[ch]);           \
            SET_META(key, ebur128->name##_peaks[ch]);                       \
        }                                                                   \
        snprintf(key, sizeof(key),                                          \
                 META_PREFIX AV_STRINGIFY(name) "_peak");                   \
        SET_META(key, max_peak);                                            \
    }                                                                       \
} while (0)

◆ PRINT_PEAKS

#define PRINT_PEAKS	(	str,
		sp,
		ptype
	)

Value:

    do {                            \
    if (ebur128->peak_mode & PEAK_MODE_ ## ptype ## _PEAKS) {       \
        av_log(ctx, ebur128->loglevel, "  " str ":");               \
        for (ch = 0; ch < nb_channels; ch++)                        \
            av_log(ctx, ebur128->loglevel, " %5.1f", DBFS(sp[ch])); \
        av_log(ctx, ebur128->loglevel, " dBFS");                    \
    }                                                               \
} while (0)

◆ PRINT_PEAK_SUMMARY

#define PRINT_PEAK_SUMMARY	(	str,
		sp,
		ptype
	)

Value:

    do {                  \
    int ch;                                                      \
    double maxpeak;                                              \
    maxpeak = 0.0;                                               \
    if (ebur128->peak_mode & PEAK_MODE_ ## ptype ## _PEAKS) {    \
        for (ch = 0; ch < ebur128->nb_channels; ch++)            \
            maxpeak = FFMAX(maxpeak, sp[ch]);                    \
        av_log(ctx, AV_LOG_INFO, "\n\n  " str " peak:\n"         \
               "    Peak:      %5.1f dBFS",                      \
               DBFS(maxpeak));                                   \
    }                                                            \
} while (0)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
PEAK_MODE_NONE
PEAK_MODE_SAMPLES_PEAKS
PEAK_MODE_TRUE_PEAKS

Definition at line 142 of file f_ebur128.c.

◆ anonymous enum

anonymous enum

Enumerator
GAUGE_TYPE_MOMENTARY
GAUGE_TYPE_SHORTTERM

Definition at line 148 of file f_ebur128.c.

◆ anonymous enum

anonymous enum

Enumerator
SCALE_TYPE_ABSOLUTE
SCALE_TYPE_RELATIVE

Definition at line 153 of file f_ebur128.c.

Function Documentation

◆ AVFILTER_DEFINE_CLASS()

AVFILTER_DEFINE_CLASS ( ebur128 )

◆ get_graph_color()

static const uint8_t* get_graph_color	(	const EBUR128Context *	ebur128,
		int	v,
		int	y
	)

static

Definition at line 212 of file f_ebur128.c.

Referenced by config_video_output(), and filter_frame().

◆ lu_to_y()

static int lu_to_y	(	const EBUR128Context *	ebur128,
		double	v
	)

inlinestatic

Definition at line 222 of file f_ebur128.c.

Referenced by config_video_output(), and filter_frame().

◆ drawtext()

static void drawtext	(	AVFrame *	pic,
		int	x,
		int	y,
		int	ftid,
		const uint8_t *	color,
		const char *	fmt,
			...
	)

static

Definition at line 238 of file f_ebur128.c.

Referenced by config_video_output(), and filter_frame().

◆ drawline()

static void drawline	(	AVFrame *	pic,
		int	x,
		int	y,
		int	len,
		int	step
	)

static

Definition at line 271 of file f_ebur128.c.

◆ config_video_output()

static int config_video_output ( AVFilterLink * outlink )

static

Definition at line 282 of file f_ebur128.c.

Referenced by init().

◆ config_audio_input()

static int config_audio_input ( AVFilterLink * inlink )

static

Definition at line 381 of file f_ebur128.c.

◆ config_audio_output()

static int config_audio_output ( AVFilterLink * outlink )

static

Definition at line 426 of file f_ebur128.c.

Referenced by init().

◆ get_histogram()

static struct hist_entry* get_histogram ( void )

static

Definition at line 519 of file f_ebur128.c.

Referenced by init().

◆ init()

static av_cold int init ( AVFilterContext * ctx )

static

Definition at line 533 of file f_ebur128.c.

◆ gate_update()

static int gate_update	(	struct integrator *	integ,
		double	power,
		double	loudness,
		int	gate_thres
	)

static

Definition at line 596 of file f_ebur128.c.

Referenced by filter_frame().

◆ filter_frame()

static int filter_frame	(	AVFilterLink *	inlink,
		AVFrame *	insamples
	)

static

Definition at line 619 of file f_ebur128.c.

Referenced by activate().

◆ activate()

static int activate ( AVFilterContext * ctx )

static

Definition at line 946 of file f_ebur128.c.

◆ query_formats()

static int query_formats ( AVFilterContext * ctx )

static

Definition at line 983 of file f_ebur128.c.

◆ uninit()

static av_cold void uninit ( AVFilterContext * ctx )

static

Definition at line 1024 of file f_ebur128.c.

Variable Documentation

◆ ebur128_options

const AVOption ebur128_options[]

static

Initial value:

= {
    { "video", "set video output", OFFSET(do_video), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, V|F },
    { "size",  "set video size",   OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x480"}, 0, 0, V|F },
    { "meter", "set scale meter (+9 to +18)",  OFFSET(meter), AV_OPT_TYPE_INT, {.i64 = 9}, 9, 18, V|F },
    { "framelog", "force frame logging level", OFFSET(loglevel), AV_OPT_TYPE_INT, {.i64 = -1},   INT_MIN, INT_MAX, A|V|F, "level" },
        { "quiet",   "logging disabled",          0, AV_OPT_TYPE_CONST, {.i64 = AV_LOG_QUIET},   INT_MIN, INT_MAX, A|V|F, "level" },
        { "info",    "information logging level", 0, AV_OPT_TYPE_CONST, {.i64 = AV_LOG_INFO},    INT_MIN, INT_MAX, A|V|F, "level" },
        { "verbose", "verbose logging level",     0, AV_OPT_TYPE_CONST, {.i64 = AV_LOG_VERBOSE}, INT_MIN, INT_MAX, A|V|F, "level" },
    { "metadata", "inject metadata in the filtergraph", OFFSET(metadata), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, A|V|F },
    { "peak", "set peak mode", OFFSET(peak_mode), AV_OPT_TYPE_FLAGS, {.i64 = PEAK_MODE_NONE}, 0, INT_MAX, A|F, "mode" },
        { "none",   "disable any peak mode",   0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_NONE},          INT_MIN, INT_MAX, A|F, "mode" },
        { "sample", "enable peak-sample mode", 0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_SAMPLES_PEAKS}, INT_MIN, INT_MAX, A|F, "mode" },
        { "true",   "enable true-peak mode",   0, AV_OPT_TYPE_CONST, {.i64 = PEAK_MODE_TRUE_PEAKS},    INT_MIN, INT_MAX, A|F, "mode" },
    { "dualmono", "treat mono input files as dual-mono", OFFSET(dual_mono), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, A|F },
    { "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 },
    { "target", "set a specific target level in LUFS (-23 to 0)", OFFSET(target), AV_OPT_TYPE_INT, {.i64 = -23}, -23, 0, V|F },
    { "gauge", "set gauge display type", OFFSET(gauge_type), AV_OPT_TYPE_INT, {.i64 = 0 }, GAUGE_TYPE_MOMENTARY, GAUGE_TYPE_SHORTTERM, V|F, "gaugetype" },
        { "momentary",   "display momentary value",   0, AV_OPT_TYPE_CONST, {.i64 = GAUGE_TYPE_MOMENTARY}, INT_MIN, INT_MAX, V|F, "gaugetype" },
        { "m",           "display momentary value",   0, AV_OPT_TYPE_CONST, {.i64 = GAUGE_TYPE_MOMENTARY}, INT_MIN, INT_MAX, V|F, "gaugetype" },
        { "shortterm",   "display short-term value",  0, AV_OPT_TYPE_CONST, {.i64 = GAUGE_TYPE_SHORTTERM}, INT_MIN, INT_MAX, V|F, "gaugetype" },
        { "s",           "display short-term value",  0, AV_OPT_TYPE_CONST, {.i64 = GAUGE_TYPE_SHORTTERM}, INT_MIN, INT_MAX, V|F, "gaugetype" },
    { "scale", "sets display method for the stats", OFFSET(scale), AV_OPT_TYPE_INT, {.i64 = 0}, SCALE_TYPE_ABSOLUTE, SCALE_TYPE_RELATIVE, V|F, "scaletype" },
        { "absolute",   "display absolute values (LUFS)",          0, AV_OPT_TYPE_CONST, {.i64 = SCALE_TYPE_ABSOLUTE}, INT_MIN, INT_MAX, V|F, "scaletype" },
        { "LUFS",       "display absolute values (LUFS)",          0, AV_OPT_TYPE_CONST, {.i64 = SCALE_TYPE_ABSOLUTE}, INT_MIN, INT_MAX, V|F, "scaletype" },
        { "relative",   "display values relative to target (LU)",  0, AV_OPT_TYPE_CONST, {.i64 = SCALE_TYPE_RELATIVE}, INT_MIN, INT_MAX, V|F, "scaletype" },
        { "LU",         "display values relative to target (LU)",  0, AV_OPT_TYPE_CONST, {.i64 = SCALE_TYPE_RELATIVE}, INT_MIN, INT_MAX, V|F, "scaletype" },
    { NULL },
}

Definition at line 162 of file f_ebur128.c.

◆ graph_colors

const uint8_t graph_colors[]

static

Initial value:

= {
    0xdd, 0x66, 0x66,   
    0x66, 0x66, 0xdd,   
    0x96, 0x33, 0x33,   
    0x33, 0x33, 0x96,   
    0xdd, 0x96, 0x96,   
    0x96, 0x96, 0xdd,   
    0xdd, 0x33, 0x33,   
    0x33, 0x33, 0xdd,   
    0xdd, 0x66, 0x66,   
    0x66, 0xdd, 0x66,   
    0x96, 0x33, 0x33,   
    0x33, 0x96, 0x33,   
    0xdd, 0x96, 0x96,   
    0x96, 0xdd, 0x96,   
    0xdd, 0x33, 0x33,   
    0x33, 0xdd, 0x33,   
}

Definition at line 193 of file f_ebur128.c.

Referenced by get_graph_color().

◆ font_colors

const uint8_t font_colors[]

static

Initial value:

= {
    0xdd, 0xdd, 0x00,
    0x00, 0x96, 0x96,
}

Definition at line 233 of file f_ebur128.c.

Referenced by config_video_output(), and filter_frame().

◆ ebur128_inputs

const AVFilterPad ebur128_inputs[]

static

Initial value:

= {
    {
        .name         = "default",
        .type         = AVMEDIA_TYPE_AUDIO,
        .config_props = config_audio_input,
    },
}

Definition at line 1094 of file f_ebur128.c.

◆ ff_af_ebur128

const AVFilter ff_af_ebur128

Initial value:

= {
    .name          = "ebur128",
    .description   = NULL_IF_CONFIG_SMALL("EBU R128 scanner."),
    .priv_size     = sizeof(EBUR128Context),
    .init          = init,
    .uninit        = uninit,
    .activate      = activate,
    FILTER_INPUTS(ebur128_inputs),
    .outputs       = NULL,
    FILTER_QUERY_FUNC(query_formats),
    .priv_class    = &ebur128_class,
    .flags         = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
}

Definition at line 1102 of file f_ebur128.c.

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ABS_THRES

◆ ABS_UP_THRES

◆ HIST_GRAIN

◆ HIST_SIZE

◆ OFFSET

◆ A

◆ V

◆ F

◆ FONT8

◆ FONT16

◆ PAD

◆ DRAW_RECT

◆ BACK_MASK

◆ I400_BINS

◆ I3000_BINS

◆ ENERGY

◆ LOUDNESS

◆ DBFS

◆ HIST_POS

◆ MOVE_TO_NEXT_CACHED_ENTRY

◆ FILTER

◆ COMPUTE_LOUDNESS

◆ I_GATE_THRES

◆ LRA_GATE_THRES

◆ LRA_LOWER_PRC

◆ LRA_HIGHER_PRC

◆ LOG_FMT

◆ META_PREFIX

◆ SET_META

◆ SET_META_PEAK

◆ PRINT_PEAKS

◆ PRINT_PEAK_SUMMARY

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ AVFILTER_DEFINE_CLASS()

◆ get_graph_color()

◆ lu_to_y()

◆ drawtext()

◆ drawline()

◆ config_video_output()

◆ config_audio_input()

◆ config_audio_output()

◆ get_histogram()

◆ init()

◆ gate_update()

◆ filter_frame()

◆ activate()

◆ query_formats()

◆ uninit()

Variable Documentation

◆ ebur128_options

◆ graph_colors

◆ font_colors

◆ ebur128_inputs

◆ ff_af_ebur128