FFmpeg
af_anlms.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
22 #include "libavutil/common.h"
23 #include "libavutil/float_dsp.h"
24 #include "libavutil/mem.h"
25 #include "libavutil/opt.h"
26 
27 #include "audio.h"
28 #include "avfilter.h"
29 #include "filters.h"
30 #include "formats.h"
31 #include "internal.h"
32 
33 enum OutModes {
40 };
41 
42 typedef struct AudioNLMSContext {
43  const AVClass *class;
44 
45  int order;
46  float mu;
47  float eps;
48  float leakage;
50  int precision;
51 
57 
59 
60  int anlmf;
61 
62  int (*filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
63 
66 
67 #define OFFSET(x) offsetof(AudioNLMSContext, x)
68 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
69 #define AT AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
70 
71 static const AVOption anlms_options[] = {
72  { "order", "set the filter order", OFFSET(order), AV_OPT_TYPE_INT, {.i64=256}, 1, INT16_MAX, A },
73  { "mu", "set the filter mu", OFFSET(mu), AV_OPT_TYPE_FLOAT, {.dbl=0.75}, 0, 2, AT },
74  { "eps", "set the filter eps", OFFSET(eps), AV_OPT_TYPE_FLOAT, {.dbl=1}, 0, 1, AT },
75  { "leakage", "set the filter leakage", OFFSET(leakage), AV_OPT_TYPE_FLOAT, {.dbl=0}, 0, 1, AT },
76  { "out_mode", "set output mode", OFFSET(output_mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_OMODES-1, AT, .unit = "mode" },
77  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, AT, .unit = "mode" },
78  { "d", "desired", 0, AV_OPT_TYPE_CONST, {.i64=DESIRED_MODE}, 0, 0, AT, .unit = "mode" },
79  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, AT, .unit = "mode" },
80  { "n", "noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_MODE}, 0, 0, AT, .unit = "mode" },
81  { "e", "error", 0, AV_OPT_TYPE_CONST, {.i64=ERROR_MODE}, 0, 0, AT, .unit = "mode" },
82  { "precision", "set processing precision", OFFSET(precision), AV_OPT_TYPE_INT, {.i64=0}, 0, 2, A, .unit = "precision" },
83  { "auto", "set auto processing precision", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, A, .unit = "precision" },
84  { "float", "set single-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, A, .unit = "precision" },
85  { "double","set double-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, A, .unit = "precision" },
86  { NULL }
87 };
88 
89 AVFILTER_DEFINE_CLASS_EXT(anlms, "anlm(f|s)", anlms_options);
90 
92 {
93  AudioNLMSContext *s = ctx->priv;
94  static const enum AVSampleFormat sample_fmts[3][3] = {
98  };
99  int ret;
100 
102  return ret;
103 
104  if ((ret = ff_set_common_formats_from_list(ctx, sample_fmts[s->precision])) < 0)
105  return ret;
106 
108 }
109 
111 {
112  AudioNLMSContext *s = ctx->priv;
113  int i, ret, status;
114  int nb_samples;
115  int64_t pts;
116 
118 
119  nb_samples = FFMIN(ff_inlink_queued_samples(ctx->inputs[0]),
120  ff_inlink_queued_samples(ctx->inputs[1]));
121  for (i = 0; i < ctx->nb_inputs && nb_samples > 0; i++) {
122  if (s->frame[i])
123  continue;
124 
125  if (ff_inlink_check_available_samples(ctx->inputs[i], nb_samples) > 0) {
126  ret = ff_inlink_consume_samples(ctx->inputs[i], nb_samples, nb_samples, &s->frame[i]);
127  if (ret < 0)
128  return ret;
129  }
130  }
131 
132  if (s->frame[0] && s->frame[1]) {
133  AVFrame *out;
134 
135  out = ff_get_audio_buffer(ctx->outputs[0], s->frame[0]->nb_samples);
136  if (!out) {
137  av_frame_free(&s->frame[0]);
138  av_frame_free(&s->frame[1]);
139  return AVERROR(ENOMEM);
140  }
141 
142  ff_filter_execute(ctx, s->filter_channels, out, NULL,
143  FFMIN(ctx->outputs[0]->ch_layout.nb_channels, ff_filter_get_nb_threads(ctx)));
144 
145  out->pts = s->frame[0]->pts;
146  out->duration = s->frame[0]->duration;
147 
148  av_frame_free(&s->frame[0]);
149  av_frame_free(&s->frame[1]);
150 
151  ret = ff_filter_frame(ctx->outputs[0], out);
152  if (ret < 0)
153  return ret;
154  }
155 
156  if (!nb_samples) {
157  for (i = 0; i < 2; i++) {
158  if (ff_inlink_acknowledge_status(ctx->inputs[i], &status, &pts)) {
159  ff_outlink_set_status(ctx->outputs[0], status, pts);
160  return 0;
161  }
162  }
163  }
164 
165  if (ff_outlink_frame_wanted(ctx->outputs[0])) {
166  for (i = 0; i < 2; i++) {
167  if (s->frame[i] || ff_inlink_queued_samples(ctx->inputs[i]) > 0)
168  continue;
169  ff_inlink_request_frame(ctx->inputs[i]);
170  return 0;
171  }
172  }
173  return 0;
174 }
175 
176 #define DEPTH 32
177 #include "anlms_template.c"
178 
179 #undef DEPTH
180 #define DEPTH 64
181 #include "anlms_template.c"
182 
183 static int config_output(AVFilterLink *outlink)
184 {
185  AVFilterContext *ctx = outlink->src;
186  AudioNLMSContext *s = ctx->priv;
187 
188  s->anlmf = !strcmp(ctx->filter->name, "anlmf");
189  s->kernel_size = FFALIGN(s->order, 16);
190 
191  if (!s->offset)
192  s->offset = ff_get_audio_buffer(outlink, 1);
193  if (!s->delay)
194  s->delay = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
195  if (!s->coeffs)
196  s->coeffs = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
197  if (!s->tmp)
198  s->tmp = ff_get_audio_buffer(outlink, s->kernel_size);
199  if (!s->delay || !s->coeffs || !s->offset || !s->tmp)
200  return AVERROR(ENOMEM);
201 
202  switch (outlink->format) {
203  case AV_SAMPLE_FMT_DBLP:
204  s->filter_channels = filter_channels_double;
205  break;
206  case AV_SAMPLE_FMT_FLTP:
207  s->filter_channels = filter_channels_float;
208  break;
209  }
210 
211  return 0;
212 }
213 
215 {
216  AudioNLMSContext *s = ctx->priv;
217 
218  s->fdsp = avpriv_float_dsp_alloc(0);
219  if (!s->fdsp)
220  return AVERROR(ENOMEM);
221 
222  return 0;
223 }
224 
226 {
227  AudioNLMSContext *s = ctx->priv;
228 
229  av_freep(&s->fdsp);
230  av_frame_free(&s->delay);
231  av_frame_free(&s->coeffs);
232  av_frame_free(&s->offset);
233  av_frame_free(&s->tmp);
234 }
235 
236 static const AVFilterPad inputs[] = {
237  {
238  .name = "input",
239  .type = AVMEDIA_TYPE_AUDIO,
240  },
241  {
242  .name = "desired",
243  .type = AVMEDIA_TYPE_AUDIO,
244  },
245 };
246 
247 static const AVFilterPad outputs[] = {
248  {
249  .name = "default",
250  .type = AVMEDIA_TYPE_AUDIO,
251  .config_props = config_output,
252  },
253 };
254 
256  .name = "anlms",
257  .description = NULL_IF_CONFIG_SMALL("Apply Normalized Least-Mean-Squares algorithm to first audio stream."),
258  .priv_size = sizeof(AudioNLMSContext),
259  .priv_class = &anlms_class,
260  .init = init,
261  .uninit = uninit,
262  .activate = activate,
268  .process_command = ff_filter_process_command,
269 };
270 
272  .name = "anlmf",
273  .description = NULL_IF_CONFIG_SMALL("Apply Normalized Least-Mean-Fourth algorithm to first audio stream."),
274  .priv_size = sizeof(AudioNLMSContext),
275  .priv_class = &anlms_class,
276  .init = init,
277  .uninit = uninit,
278  .activate = activate,
284  .process_command = ff_filter_process_command,
285 };
ff_get_audio_buffer
AVFrame * ff_get_audio_buffer(AVFilterLink *link, int nb_samples)
Request an audio samples buffer with a specific set of permissions.
Definition: audio.c:97
AV_SAMPLE_FMT_FLTP
@ AV_SAMPLE_FMT_FLTP
float, planar
Definition: samplefmt.h:66
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
out
FILE * out
Definition: movenc.c:55
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1015
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:948
anlms_template.c
FILTER_SINGLE_SAMPLEFMT
#define FILTER_SINGLE_SAMPLEFMT(sample_fmt_)
Definition: internal.h:175
int64_t
long long int64_t
Definition: coverity.c:34
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:160
OutModes
OutModes
Definition: af_aap.c:33
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
AVOption
AVOption.
Definition: opt.h:357
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:159
OUT_MODE
@ OUT_MODE
Definition: af_anlms.c:36
ff_set_common_all_samplerates
int ff_set_common_all_samplerates(AVFilterContext *ctx)
Equivalent to ff_set_common_samplerates(ctx, ff_all_samplerates())
Definition: formats.c:822
AudioNLMSContext::mu
float mu
Definition: af_anlms.c:46
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_anlms.c:214
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
IN_MODE
@ IN_MODE
Definition: af_anlms.c:34
ff_af_anlms
const AVFilter ff_af_anlms
Definition: af_anlms.c:255
formats.h
FF_FILTER_FORWARD_STATUS_BACK_ALL
#define FF_FILTER_FORWARD_STATUS_BACK_ALL(outlink, filter)
Forward the status on an output link to all input links.
Definition: filters.h:212
AudioNLMSContext::fdsp
AVFloatDSPContext * fdsp
Definition: af_anlms.c:64
anlms_options
static const AVOption anlms_options[]
Definition: af_anlms.c:71
pts
static int64_t pts
Definition: transcode_aac.c:644
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
OFFSET
#define OFFSET(x)
Definition: af_anlms.c:67
ff_inlink_check_available_samples
int ff_inlink_check_available_samples(AVFilterLink *link, unsigned min)
Test if enough samples are available on the link.
Definition: avfilter.c:1423
av_cold
#define av_cold
Definition: attributes.h:90
AudioNLMSContext::offset
AVFrame * offset
Definition: af_anlms.c:53
DESIRED_MODE
@ DESIRED_MODE
Definition: af_anlms.c:35
ff_outlink_set_status
static void ff_outlink_set_status(AVFilterLink *link, int status, int64_t pts)
Set the status field of a link from the source filter.
Definition: filters.h:189
ff_inlink_request_frame
void ff_inlink_request_frame(AVFilterLink *link)
Mark that a frame is wanted on the link.
Definition: avfilter.c:1568
AudioNLMSContext::tmp
AVFrame * tmp
Definition: af_anlms.c:56
s
#define s(width, name)
Definition: cbs_vp9.c:198
AudioNLMSContext::frame
AVFrame * frame[2]
Definition: af_anlms.c:58
AudioNLMSContext::kernel_size
int kernel_size
Definition: af_anlms.c:52
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
ff_set_common_formats_from_list
int ff_set_common_formats_from_list(AVFilterContext *ctx, const int *fmts)
Equivalent to ff_set_common_formats(ctx, ff_make_format_list(fmts))
Definition: formats.c:874
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
AudioNLMSContext::leakage
float leakage
Definition: af_anlms.c:48
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
arg
const char * arg
Definition: jacosubdec.c:67
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
ff_inlink_consume_samples
int ff_inlink_consume_samples(AVFilterLink *link, unsigned min, unsigned max, AVFrame **rframe)
Take samples from the link's FIFO and update the link's stats.
Definition: avfilter.c:1462
NULL
#define NULL
Definition: coverity.c:32
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_anlms.c:225
AudioNLMSContext::anlmf
int anlmf
Definition: af_anlms.c:60
AudioNLMSContext::eps
float eps
Definition: af_anlms.c:47
ff_set_common_all_channel_counts
int ff_set_common_all_channel_counts(AVFilterContext *ctx)
Equivalent to ff_set_common_channel_layouts(ctx, ff_all_channel_counts())
Definition: formats.c:804
ff_inlink_acknowledge_status
int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts)
Test and acknowledge the change of status on the link.
Definition: avfilter.c:1389
float_dsp.h
ff_af_anlmf
const AVFilter ff_af_anlmf
Definition: af_anlms.c:271
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
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_anlms.c:91
AVFloatDSPContext
Definition: float_dsp.h:24
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:887
AudioNLMSContext::coeffs
AVFrame * coeffs
Definition: af_anlms.c:55
NB_OMODES
@ NB_OMODES
Definition: af_anlms.c:39
internal.h
AV_OPT_TYPE_FLOAT
@ AV_OPT_TYPE_FLOAT
Definition: opt.h:248
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AudioNLMSContext::order
int order
Definition: af_anlms.c:45
activate
static int activate(AVFilterContext *ctx)
Definition: af_anlms.c:110
common.h
ff_filter_get_nb_threads
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:827
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:55
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AudioNLMSContext::filter_channels
int(* filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: af_anlms.c:62
AudioNLMSContext::output_mode
int output_mode
Definition: af_anlms.c:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
ff_inlink_queued_samples
int ff_inlink_queued_samples(AVFilterLink *link)
Definition: avfilter.c:1417
AVFilter
Filter definition.
Definition: avfilter.h:166
ret
ret
Definition: filter_design.txt:187
ERROR_MODE
@ ERROR_MODE
Definition: af_anlms.c:38
NOISE_MODE
@ NOISE_MODE
Definition: af_anlms.c:37
AudioNLMSContext
Definition: af_anlms.c:42
AudioNLMSContext::delay
AVFrame * delay
Definition: af_anlms.c:54
status
ov_status_e status
Definition: dnn_backend_openvino.c:101
channel_layout.h
inputs
static const AVFilterPad inputs[]
Definition: af_anlms.c:236
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:245
avfilter.h
A
#define A
Definition: af_anlms.c:68
AudioNLMSContext::precision
int precision
Definition: af_anlms.c:50
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:67
AVFILTER_DEFINE_CLASS_EXT
AVFILTER_DEFINE_CLASS_EXT(anlms, "anlm(f|s)", anlms_options)
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_anlms.c:183
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
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:117
mem.h
audio.h
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
avpriv_float_dsp_alloc
av_cold AVFloatDSPContext * avpriv_float_dsp_alloc(int bit_exact)
Allocate a float DSP context.
Definition: float_dsp.c:146
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:155
outputs
static const AVFilterPad outputs[]
Definition: af_anlms.c:247
ff_outlink_frame_wanted
the definition of that something depends on the semantic of the filter The callback must examine the status of the filter s links and proceed accordingly The status of output links is stored in the status_in and status_out fields and tested by the ff_outlink_frame_wanted() function. If this function returns true
AT
#define AT
Definition: af_anlms.c:69
ff_filter_execute
static av_always_inline int ff_filter_execute(AVFilterContext *ctx, avfilter_action_func *func, void *arg, int *ret, int nb_jobs)
Definition: internal.h:134
int
int
Definition: ffmpeg_filter.c:424
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:254