vf_libvmaf.c File Reference

Calculate the VMAF between two input videos. More...

#include <pthread.h>
#include <libvmaf.h>
#include "libavutil/avstring.h"
#include "libavutil/opt.h"
#include "libavutil/pixdesc.h"
#include "avfilter.h"
#include "drawutils.h"
#include "formats.h"
#include "framesync.h"
#include "internal.h"
#include "video.h"

Go to the source code of this file.

Data Structures
struct	LIBVMAFContext

Macros
#define	OFFSET(x)   offsetof(LIBVMAFContext, x)
#define	FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
#define	read_frame_fn(type, bits)

Functions
	FRAMESYNC_DEFINE_CLASS (libvmaf, LIBVMAFContext, fs)
	read_frame_fn (uint8_t, 8)
	read_frame_fn (uint16_t, 10)
static void	compute_vmaf_score (LIBVMAFContext *s)
static void *	call_vmaf (void *ctx)
static int	do_vmaf (FFFrameSync *fs)
static av_cold int	init (AVFilterContext *ctx)
static int	query_formats (AVFilterContext *ctx)
static int	config_input_ref (AVFilterLink *inlink)
static int	config_output (AVFilterLink *outlink)
static int	activate (AVFilterContext *ctx)
static av_cold void	uninit (AVFilterContext *ctx)

Variables
static const AVOption	libvmaf_options []
static const AVFilterPad	libvmaf_inputs []
static const AVFilterPad	libvmaf_outputs []
AVFilter	ff_vf_libvmaf

Detailed Description

Calculate the VMAF between two input videos.

Definition in file vf_libvmaf.c.

Macro Definition Documentation

OFFSET

#define OFFSET

(

x

)

offsetof(LIBVMAFContext, x)

Definition at line 67 of file vf_libvmaf.c.

FLAGS

#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM

Definition at line 68 of file vf_libvmaf.c.

read_frame_fn

#define read_frame_fn	(		type,
			bits
	)

Definition at line 85 of file vf_libvmaf.c.

Function Documentation

FRAMESYNC_DEFINE_CLASS()

FRAMESYNC_DEFINE_CLASS	(	libvmaf	,
		LIBVMAFContext	,
		fs
	)

read_frame_fn() [1/2]

read_frame_fn	(	uint8_t	,
		8
	)

read_frame_fn() [2/2]

read_frame_fn	(	uint16_t	,
		10
	)

compute_vmaf_score()

static void compute_vmaf_score ( LIBVMAFContext *  s )

static

Definition at line 150 of file vf_libvmaf.c.

Referenced by call_vmaf().

call_vmaf()

static void* call_vmaf ( void *  ctx )

static

Definition at line 171 of file vf_libvmaf.c.

Referenced by config_input_ref().

do_vmaf()

static int do_vmaf ( FFFrameSync *  fs )

static

Definition at line 186 of file vf_libvmaf.c.

Referenced by init().

init()

static av_cold int init ( AVFilterContext *  ctx )

static

Definition at line 223 of file vf_libvmaf.c.

query_formats()

static int query_formats ( AVFilterContext *  ctx )

static

Definition at line 238 of file vf_libvmaf.c.

config_input_ref()

static int config_input_ref ( AVFilterLink *  inlink )

static

Definition at line 253 of file vf_libvmaf.c.

config_output()

static int config_output ( AVFilterLink *  outlink )

static

Definition at line 282 of file vf_libvmaf.c.

activate()

static int activate ( AVFilterContext *  ctx )

static

Definition at line 303 of file vf_libvmaf.c.

uninit()

static av_cold void uninit ( AVFilterContext *  ctx )

static

Definition at line 309 of file vf_libvmaf.c.

Variable Documentation

libvmaf_options

const AVOption libvmaf_options[]

static

Initial value:

= {
    {"model_path",  "Set the model to be used for computing vmaf.",                     OFFSET(model_path), AV_OPT_TYPE_STRING, {.str="/usr/local/share/model/vmaf_v0.6.1.pkl"}, 0, 1, FLAGS},
    {"log_path",  "Set the file path to be used to store logs.",                        OFFSET(log_path), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 1, FLAGS},
    {"log_fmt",  "Set the format of the log (xml or json).",                            OFFSET(log_fmt), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 1, FLAGS},
    {"enable_transform",  "Enables transform for computing vmaf.",                      OFFSET(enable_transform), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
    {"phone_model",  "Invokes the phone model that will generate higher VMAF scores.",  OFFSET(phone_model), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
    {"psnr",  "Enables computing psnr along with vmaf.",                                OFFSET(psnr), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
    {"ssim",  "Enables computing ssim along with vmaf.",                                OFFSET(ssim), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
    {"ms_ssim",  "Enables computing ms-ssim along with vmaf.",                          OFFSET(ms_ssim), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
    {"pool",  "Set the pool method to be used for computing vmaf.",                     OFFSET(pool), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 1, FLAGS},
    { NULL }
}

Definition at line 70 of file vf_libvmaf.c.

libvmaf_inputs

const AVFilterPad libvmaf_inputs[]

static

Initial value:

= {
    {
        .name         = "main",
        .type         = AVMEDIA_TYPE_VIDEO,
    },{
        .name         = "reference",
        .type         = AVMEDIA_TYPE_VIDEO,
        .config_props = config_input_ref,
    },
    { NULL }
}

Definition at line 329 of file vf_libvmaf.c.

libvmaf_outputs

const AVFilterPad libvmaf_outputs[]

static

Initial value:

= {
    {
        .name          = "default",
        .type          = AVMEDIA_TYPE_VIDEO,
        .config_props  = config_output,
    },
    { NULL }
}

Definition at line 341 of file vf_libvmaf.c.

ff_vf_libvmaf

AVFilter ff_vf_libvmaf

Initial value:

= {
    .name          = "libvmaf",
    .description   = NULL_IF_CONFIG_SMALL("Calculate the VMAF between two video streams."),
    .preinit       = libvmaf_framesync_preinit,
    .init          = init,
    .uninit        = uninit,
    .query_formats = query_formats,
    .activate      = activate,
    .priv_size     = sizeof(LIBVMAFContext),
    .priv_class    = &libvmaf_class,
    .inputs        = libvmaf_inputs,
    .outputs       = libvmaf_outputs,
}

Definition at line 350 of file vf_libvmaf.c.