FFmpeg
Data Structures | Macros | Enumerations | Functions | Variables
af_anlms.c File Reference
#include "libavutil/channel_layout.h"
#include "libavutil/common.h"
#include "libavutil/float_dsp.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"
#include "audio.h"
#include "avfilter.h"
#include "filters.h"
#include "formats.h"
#include "anlms_template.c"

Go to the source code of this file.

Data Structures

struct  AudioNLMSContext
 

Macros

#define OFFSET(x)   offsetof(AudioNLMSContext, x)
 
#define A   AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 
#define AT   AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
 
#define DEPTH   32
 
#define DEPTH   64
 

Enumerations

enum  OutModes {
  IN_MODE, DESIRED_MODE, OUT_MODE, NOISE_MODE,
  ERROR_MODE, NB_OMODES, IN_MODE, OUT_MODE,
  NOISE_MODE, NB_MODES, IN_MODE, OUT_MODE,
  NOISE_MODE, NB_MODES, IN_MODE, DESIRED_MODE,
  OUT_MODE, NOISE_MODE, ERROR_MODE, NB_OMODES,
  IN_MODE, DESIRED_MODE, OUT_MODE, NOISE_MODE,
  ERROR_MODE, NB_OMODES, IN_MODE, OUT_MODE,
  ESS_MODE, NB_MODES
}
 

Functions

 AVFILTER_DEFINE_CLASS_EXT (anlms, "anlm(f|s)", anlms_options)
 
static int query_formats (const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out)
 
static int activate (AVFilterContext *ctx)
 
static int config_output (AVFilterLink *outlink)
 
static av_cold int init (AVFilterContext *ctx)
 
static av_cold void uninit (AVFilterContext *ctx)
 

Variables

static const AVOption anlms_options []
 
static const AVFilterPad inputs []
 
static const AVFilterPad outputs []
 
const AVFilter ff_af_anlms
 
const AVFilter ff_af_anlmf
 

Macro Definition Documentation

◆ OFFSET

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

Definition at line 66 of file af_anlms.c.

◆ A

Definition at line 67 of file af_anlms.c.

◆ AT

Definition at line 68 of file af_anlms.c.

◆ DEPTH [1/2]

#define DEPTH   32

Definition at line 179 of file af_anlms.c.

◆ DEPTH [2/2]

#define DEPTH   64

Definition at line 179 of file af_anlms.c.

Enumeration Type Documentation

◆ OutModes

enum OutModes
Enumerator
IN_MODE 
DESIRED_MODE 
OUT_MODE 
NOISE_MODE 
ERROR_MODE 
NB_OMODES 
IN_MODE 
OUT_MODE 
NOISE_MODE 
NB_MODES 
IN_MODE 
OUT_MODE 
NOISE_MODE 
NB_MODES 
IN_MODE 
DESIRED_MODE 
OUT_MODE 
NOISE_MODE 
ERROR_MODE 
NB_OMODES 
IN_MODE 
DESIRED_MODE 
OUT_MODE 
NOISE_MODE 
ERROR_MODE 
NB_OMODES 
IN_MODE 
OUT_MODE 
ESS_MODE 
NB_MODES 

Definition at line 32 of file af_anlms.c.

Function Documentation

◆ AVFILTER_DEFINE_CLASS_EXT()

AVFILTER_DEFINE_CLASS_EXT ( anlms  ,
"anlm(f|s)"  ,
anlms_options   
)

◆ query_formats()

static int query_formats ( const AVFilterContext ctx,
AVFilterFormatsConfig **  cfg_in,
AVFilterFormatsConfig **  cfg_out 
)
static

Definition at line 90 of file af_anlms.c.

◆ activate()

static int activate ( AVFilterContext ctx)
static

Definition at line 109 of file af_anlms.c.

◆ config_output()

static int config_output ( AVFilterLink outlink)
static

Definition at line 182 of file af_anlms.c.

◆ init()

static av_cold int init ( AVFilterContext ctx)
static

Definition at line 213 of file af_anlms.c.

◆ uninit()

static av_cold void uninit ( AVFilterContext ctx)
static

Definition at line 224 of file af_anlms.c.

Variable Documentation

◆ anlms_options

const AVOption anlms_options[]
static
Initial value:
= {
{ "order", "set the filter order", OFFSET(order), AV_OPT_TYPE_INT, {.i64=256}, 1, INT16_MAX, A },
{ "mu", "set the filter mu", OFFSET(mu), AV_OPT_TYPE_FLOAT, {.dbl=0.75}, 0, 2, AT },
{ "eps", "set the filter eps", OFFSET(eps), AV_OPT_TYPE_FLOAT, {.dbl=1}, 0, 1, AT },
{ "leakage", "set the filter leakage", OFFSET(leakage), AV_OPT_TYPE_FLOAT, {.dbl=0}, 0, 1, AT },
{ "out_mode", "set output mode", OFFSET(output_mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_OMODES-1, AT, .unit = "mode" },
{ "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, AT, .unit = "mode" },
{ "d", "desired", 0, AV_OPT_TYPE_CONST, {.i64=DESIRED_MODE}, 0, 0, AT, .unit = "mode" },
{ "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, AT, .unit = "mode" },
{ "n", "noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_MODE}, 0, 0, AT, .unit = "mode" },
{ "e", "error", 0, AV_OPT_TYPE_CONST, {.i64=ERROR_MODE}, 0, 0, AT, .unit = "mode" },
{ "precision", "set processing precision", OFFSET(precision), AV_OPT_TYPE_INT, {.i64=0}, 0, 2, A, .unit = "precision" },
{ "auto", "set auto processing precision", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, A, .unit = "precision" },
{ "float", "set single-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, A, .unit = "precision" },
{ "double","set double-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, A, .unit = "precision" },
{ NULL }
}

Definition at line 70 of file af_anlms.c.

◆ inputs

const AVFilterPad inputs[]
static
Initial value:
= {
{
.name = "input",
},
{
.name = "desired",
},
}

Definition at line 235 of file af_anlms.c.

◆ outputs

const AVFilterPad outputs[]
static
Initial value:
= {
{
.name = "default",
.config_props = config_output,
},
}

Definition at line 246 of file af_anlms.c.

◆ ff_af_anlms

const AVFilter ff_af_anlms
Initial value:
= {
.name = "anlms",
.description = NULL_IF_CONFIG_SMALL("Apply Normalized Least-Mean-Squares algorithm to first audio stream."),
.priv_size = sizeof(AudioNLMSContext),
.priv_class = &anlms_class,
.init = init,
.process_command = ff_filter_process_command,
}

Definition at line 254 of file af_anlms.c.

◆ ff_af_anlmf

const AVFilter ff_af_anlmf
Initial value:
= {
.name = "anlmf",
.description = NULL_IF_CONFIG_SMALL("Apply Normalized Least-Mean-Fourth algorithm to first audio stream."),
.priv_size = sizeof(AudioNLMSContext),
.priv_class = &anlms_class,
.init = init,
.process_command = ff_filter_process_command,
}

Definition at line 270 of file af_anlms.c.

AV_SAMPLE_FMT_FLTP
@ AV_SAMPLE_FMT_FLTP
float, planar
Definition: samplefmt.h:66
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
OUT_MODE
@ OUT_MODE
Definition: af_anlms.c:35
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_anlms.c:213
IN_MODE
@ IN_MODE
Definition: af_anlms.c:33
OFFSET
#define OFFSET(x)
Definition: af_anlms.c:66
DESIRED_MODE
@ DESIRED_MODE
Definition: af_anlms.c:34
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: filters.h:263
NULL
#define NULL
Definition: coverity.c:32
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_anlms.c:224
FILTER_SINGLE_SAMPLEFMT
#define FILTER_SINGLE_SAMPLEFMT(sample_fmt_)
Definition: filters.h:255
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
query_formats
static int query_formats(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out)
Definition: af_anlms.c:90
ff_filter_process_command
int ff_filter_process_command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
Generic processing of user supplied commands that are set in the same way as the filter options.
Definition: avfilter.c:900
NB_OMODES
@ NB_OMODES
Definition: af_anlms.c:38
AV_OPT_TYPE_FLOAT
@ AV_OPT_TYPE_FLOAT
Underlying C type is float.
Definition: opt.h:271
activate
static int activate(AVFilterContext *ctx)
Definition: af_anlms.c:109
FILTER_QUERY_FUNC2
#define FILTER_QUERY_FUNC2(func)
Definition: filters.h:239
ERROR_MODE
@ ERROR_MODE
Definition: af_anlms.c:37
NOISE_MODE
@ NOISE_MODE
Definition: af_anlms.c:36
AudioNLMSContext
Definition: af_anlms.c:41
inputs
static const AVFilterPad inputs[]
Definition: af_anlms.c:235
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
A
#define A
Definition: af_anlms.c:67
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_anlms.c:182
AVFILTER_FLAG_SLICE_THREADS
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:152
AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
#define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will have its filter_frame() c...
Definition: avfilter.h:190
outputs
static const AVFilterPad outputs[]
Definition: af_anlms.c:246
AT
#define AT
Definition: af_anlms.c:68
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Special option type for declaring named constants.
Definition: opt.h:299