FFmpeg
af_arls.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023 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 
21 #include "libavutil/common.h"
22 #include "libavutil/float_dsp.h"
23 #include "libavutil/mem.h"
24 #include "libavutil/opt.h"
25 
26 #include "audio.h"
27 #include "avfilter.h"
28 #include "formats.h"
29 #include "filters.h"
30 #include "internal.h"
31 
32 enum OutModes {
39 };
40 
41 typedef struct AudioRLSContext {
42  const AVClass *class;
43 
44  int order;
45  float lambda;
46  float delta;
48  int precision;
49 
54  AVFrame *p, *dp;
57 
59 
60  int (*filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
61 
64 
65 #define OFFSET(x) offsetof(AudioRLSContext, x)
66 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
67 #define AT AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
68 
69 static const AVOption arls_options[] = {
70  { "order", "set the filter order", OFFSET(order), AV_OPT_TYPE_INT, {.i64=16}, 1, INT16_MAX, A },
71  { "lambda", "set the filter lambda", OFFSET(lambda), AV_OPT_TYPE_FLOAT, {.dbl=1.f}, 0, 1, AT },
72  { "delta", "set the filter delta", OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=2.f}, 0, INT16_MAX, A },
73  { "out_mode", "set output mode", OFFSET(output_mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_OMODES-1, AT, .unit = "mode" },
74  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, AT, .unit = "mode" },
75  { "d", "desired", 0, AV_OPT_TYPE_CONST, {.i64=DESIRED_MODE}, 0, 0, AT, .unit = "mode" },
76  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, AT, .unit = "mode" },
77  { "n", "noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_MODE}, 0, 0, AT, .unit = "mode" },
78  { "e", "error", 0, AV_OPT_TYPE_CONST, {.i64=ERROR_MODE}, 0, 0, AT, .unit = "mode" },
79  { "precision", "set processing precision", OFFSET(precision), AV_OPT_TYPE_INT, {.i64=0}, 0, 2, A, .unit = "precision" },
80  { "auto", "set auto processing precision", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, A, .unit = "precision" },
81  { "float", "set single-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, A, .unit = "precision" },
82  { "double","set double-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, A, .unit = "precision" },
83  { NULL }
84 };
85 
87 
89 {
90  AudioRLSContext *s = ctx->priv;
91  static const enum AVSampleFormat sample_fmts[3][3] = {
95  };
96  int ret;
97 
99  return ret;
100 
101  if ((ret = ff_set_common_formats_from_list(ctx, sample_fmts[s->precision])) < 0)
102  return ret;
103 
105 }
106 
108 {
109  AudioRLSContext *s = ctx->priv;
110  int i, ret, status;
111  int nb_samples;
112  int64_t pts;
113 
115 
116  nb_samples = FFMIN(ff_inlink_queued_samples(ctx->inputs[0]),
117  ff_inlink_queued_samples(ctx->inputs[1]));
118  for (i = 0; i < ctx->nb_inputs && nb_samples > 0; i++) {
119  if (s->frame[i])
120  continue;
121 
122  if (ff_inlink_check_available_samples(ctx->inputs[i], nb_samples) > 0) {
123  ret = ff_inlink_consume_samples(ctx->inputs[i], nb_samples, nb_samples, &s->frame[i]);
124  if (ret < 0)
125  return ret;
126  }
127  }
128 
129  if (s->frame[0] && s->frame[1]) {
130  AVFrame *out;
131 
132  out = ff_get_audio_buffer(ctx->outputs[0], s->frame[0]->nb_samples);
133  if (!out) {
134  av_frame_free(&s->frame[0]);
135  av_frame_free(&s->frame[1]);
136  return AVERROR(ENOMEM);
137  }
138 
139  ff_filter_execute(ctx, s->filter_channels, out, NULL,
140  FFMIN(ctx->outputs[0]->ch_layout.nb_channels, ff_filter_get_nb_threads(ctx)));
141 
142  out->pts = s->frame[0]->pts;
143  out->duration = s->frame[0]->duration;
144 
145  av_frame_free(&s->frame[0]);
146  av_frame_free(&s->frame[1]);
147 
148  ret = ff_filter_frame(ctx->outputs[0], out);
149  if (ret < 0)
150  return ret;
151  }
152 
153  if (!nb_samples) {
154  for (i = 0; i < 2; i++) {
155  if (ff_inlink_acknowledge_status(ctx->inputs[i], &status, &pts)) {
156  ff_outlink_set_status(ctx->outputs[0], status, pts);
157  return 0;
158  }
159  }
160  }
161 
162  if (ff_outlink_frame_wanted(ctx->outputs[0])) {
163  for (i = 0; i < 2; i++) {
164  if (s->frame[i] || ff_inlink_queued_samples(ctx->inputs[i]) > 0)
165  continue;
166  ff_inlink_request_frame(ctx->inputs[i]);
167  return 0;
168  }
169  }
170  return 0;
171 }
172 
173 #define DEPTH 32
174 #include "arls_template.c"
175 
176 #undef DEPTH
177 #define DEPTH 64
178 #include "arls_template.c"
179 
180 static int config_output(AVFilterLink *outlink)
181 {
182  AVFilterContext *ctx = outlink->src;
183  AudioRLSContext *s = ctx->priv;
184 
185  s->kernel_size = FFALIGN(s->order, 16);
186 
187  if (!s->offset)
188  s->offset = ff_get_audio_buffer(outlink, 1);
189  if (!s->delay)
190  s->delay = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
191  if (!s->coeffs)
192  s->coeffs = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
193  if (!s->gains)
194  s->gains = ff_get_audio_buffer(outlink, s->kernel_size);
195  if (!s->p)
196  s->p = ff_get_audio_buffer(outlink, s->kernel_size * s->kernel_size);
197  if (!s->dp)
198  s->dp = ff_get_audio_buffer(outlink, s->kernel_size * s->kernel_size);
199  if (!s->u)
200  s->u = ff_get_audio_buffer(outlink, s->kernel_size);
201  if (!s->tmp)
202  s->tmp = ff_get_audio_buffer(outlink, s->kernel_size);
203 
204  if (!s->delay || !s->coeffs || !s->p || !s->dp || !s->gains || !s->offset || !s->u || !s->tmp)
205  return AVERROR(ENOMEM);
206 
207  for (int ch = 0; ch < s->offset->ch_layout.nb_channels; ch++) {
208  int *dst = (int *)s->offset->extended_data[ch];
209 
210  for (int i = 0; i < s->kernel_size; i++)
211  dst[0] = s->kernel_size - 1;
212  }
213 
214  switch (outlink->format) {
215  case AV_SAMPLE_FMT_DBLP:
216  for (int ch = 0; ch < s->p->ch_layout.nb_channels; ch++) {
217  double *dst = (double *)s->p->extended_data[ch];
218 
219  for (int i = 0; i < s->kernel_size; i++)
220  dst[i * s->kernel_size + i] = s->delta;
221  }
222 
223  s->filter_channels = filter_channels_double;
224  break;
225  case AV_SAMPLE_FMT_FLTP:
226  for (int ch = 0; ch < s->p->ch_layout.nb_channels; ch++) {
227  float *dst = (float *)s->p->extended_data[ch];
228 
229  for (int i = 0; i < s->kernel_size; i++)
230  dst[i * s->kernel_size + i] = s->delta;
231  }
232 
233  s->filter_channels = filter_channels_float;
234  break;
235  }
236 
237  return 0;
238 }
239 
241 {
242  AudioRLSContext *s = ctx->priv;
243 
244  s->fdsp = avpriv_float_dsp_alloc(0);
245  if (!s->fdsp)
246  return AVERROR(ENOMEM);
247 
248  return 0;
249 }
250 
252 {
253  AudioRLSContext *s = ctx->priv;
254 
255  av_freep(&s->fdsp);
256  av_frame_free(&s->delay);
257  av_frame_free(&s->coeffs);
258  av_frame_free(&s->gains);
259  av_frame_free(&s->offset);
260  av_frame_free(&s->p);
261  av_frame_free(&s->dp);
262  av_frame_free(&s->u);
263  av_frame_free(&s->tmp);
264 }
265 
266 static const AVFilterPad inputs[] = {
267  {
268  .name = "input",
269  .type = AVMEDIA_TYPE_AUDIO,
270  },
271  {
272  .name = "desired",
273  .type = AVMEDIA_TYPE_AUDIO,
274  },
275 };
276 
277 static const AVFilterPad outputs[] = {
278  {
279  .name = "default",
280  .type = AVMEDIA_TYPE_AUDIO,
281  .config_props = config_output,
282  },
283 };
284 
286  .name = "arls",
287  .description = NULL_IF_CONFIG_SMALL("Apply Recursive Least Squares algorithm to first audio stream."),
288  .priv_size = sizeof(AudioRLSContext),
289  .priv_class = &arls_class,
290  .init = init,
291  .uninit = uninit,
292  .activate = activate,
298  .process_command = ff_filter_process_command,
299 };
arls_template.c
IN_MODE
@ IN_MODE
Definition: af_arls.c:33
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
AudioRLSContext::u
AVFrame * u
Definition: af_arls.c:56
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
outputs
static const AVFilterPad outputs[]
Definition: af_arls.c:277
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
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
arls_options
static const AVOption arls_options[]
Definition: af_arls.c:69
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:375
AudioRLSContext::order
int order
Definition: af_arls.c:44
AVOption
AVOption.
Definition: opt.h:346
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:159
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_arls.c:180
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
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
AT
#define AT
Definition: af_arls.c:67
inputs
static const AVFilterPad inputs[]
Definition: af_arls.c:266
formats.h
AudioRLSContext::coeffs
AVFrame * coeffs
Definition: af_arls.c:53
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
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_arls.c:240
pts
static int64_t pts
Definition: transcode_aac.c:644
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
AudioRLSContext::frame
AVFrame * frame[2]
Definition: af_arls.c:58
AudioRLSContext::filter_channels
int(* filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: af_arls.c:60
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
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
DESIRED_MODE
@ DESIRED_MODE
Definition: af_arls.c:34
ff_inlink_request_frame
void ff_inlink_request_frame(AVFilterLink *link)
Mark that a frame is wanted on the link.
Definition: avfilter.c:1568
s
#define s(width, name)
Definition: cbs_vp9.c:198
NB_OMODES
@ NB_OMODES
Definition: af_arls.c:38
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
NOISE_MODE
@ NOISE_MODE
Definition: af_arls.c:36
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:49
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_arls.c:88
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
AudioRLSContext::delta
float delta
Definition: af_arls.c:46
NULL
#define NULL
Definition: coverity.c:32
OFFSET
#define OFFSET(x)
Definition: af_arls.c:65
AudioRLSContext::tmp
AVFrame * tmp
Definition: af_arls.c:56
OUT_MODE
@ OUT_MODE
Definition: af_arls.c:35
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
AudioRLSContext::p
AVFrame * p
Definition: af_arls.c:54
ERROR_MODE
@ ERROR_MODE
Definition: af_arls.c:37
float_dsp.h
AudioRLSContext::precision
int precision
Definition: af_arls.c:48
AudioRLSContext::gains
AVFrame * gains
Definition: af_arls.c:55
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
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
AVFloatDSPContext
Definition: float_dsp.h:22
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
AudioRLSContext::output_mode
int output_mode
Definition: af_arls.c:47
internal.h
AV_OPT_TYPE_FLOAT
@ AV_OPT_TYPE_FLOAT
Definition: opt.h:238
ff_af_arls
const AVFilter ff_af_arls
Definition: af_arls.c:285
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AudioRLSContext::fdsp
AVFloatDSPContext * fdsp
Definition: af_arls.c:62
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
delta
float delta
Definition: vorbis_enc_data.h:430
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AudioRLSContext::dp
AVFrame * dp
Definition: af_arls.c:54
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
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_arls.c:251
ret
ret
Definition: filter_design.txt:187
A
#define A
Definition: af_arls.c:66
AudioRLSContext::kernel_size
int kernel_size
Definition: af_arls.c:50
AudioRLSContext::delay
AVFrame * delay
Definition: af_arls.c:52
status
ov_status_e status
Definition: dnn_backend_openvino.c:121
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:235
avfilter.h
AV_SAMPLE_FMT_DBLP
@ AV_SAMPLE_FMT_DBLP
double, planar
Definition: samplefmt.h:67
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
AudioRLSContext::lambda
float lambda
Definition: af_arls.c:45
activate
static int activate(AVFilterContext *ctx)
Definition: af_arls.c:107
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:135
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
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
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:244
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(arls)
AudioRLSContext
Definition: af_arls.c:41
AudioRLSContext::offset
AVFrame * offset
Definition: af_arls.c:51