FFmpeg
af_aap.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 
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 "formats.h"
30 #include "filters.h"
31 #include "internal.h"
32 
33 enum OutModes {
40 };
41 
42 typedef struct AudioAPContext {
43  const AVClass *class;
44 
45  int order;
47  float mu;
48  float delta;
50  int precision;
51 
64 
65  void **tmpmp;
66  void **itmpmp;
67 
69 
70  int (*filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
71 
74 
75 #define OFFSET(x) offsetof(AudioAPContext, x)
76 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
77 #define AT AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
78 
79 static const AVOption aap_options[] = {
80  { "order", "set the filter order", OFFSET(order), AV_OPT_TYPE_INT, {.i64=16}, 1, INT16_MAX, A },
81  { "projection", "set the filter projection", OFFSET(projection), AV_OPT_TYPE_INT, {.i64=2}, 1, 256, A },
82  { "mu", "set the filter mu", OFFSET(mu), AV_OPT_TYPE_FLOAT, {.dbl=0.0001},0,1, AT },
83  { "delta", "set the filter delta", OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=0.001},0, 1, AT },
84  { "out_mode", "set output mode", OFFSET(output_mode), AV_OPT_TYPE_INT, {.i64=OUT_MODE}, 0, NB_OMODES-1, AT, .unit = "mode" },
85  { "i", "input", 0, AV_OPT_TYPE_CONST, {.i64=IN_MODE}, 0, 0, AT, .unit = "mode" },
86  { "d", "desired", 0, AV_OPT_TYPE_CONST, {.i64=DESIRED_MODE}, 0, 0, AT, .unit = "mode" },
87  { "o", "output", 0, AV_OPT_TYPE_CONST, {.i64=OUT_MODE}, 0, 0, AT, .unit = "mode" },
88  { "n", "noise", 0, AV_OPT_TYPE_CONST, {.i64=NOISE_MODE}, 0, 0, AT, .unit = "mode" },
89  { "e", "error", 0, AV_OPT_TYPE_CONST, {.i64=ERROR_MODE}, 0, 0, AT, .unit = "mode" },
90  { "precision", "set processing precision", OFFSET(precision), AV_OPT_TYPE_INT, {.i64=0}, 0, 2, A, .unit = "precision" },
91  { "auto", "set auto processing precision", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, A, .unit = "precision" },
92  { "float", "set single-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, A, .unit = "precision" },
93  { "double","set double-floating point processing precision", 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, A, .unit = "precision" },
94  { NULL }
95 };
96 
98 
100 {
101  AudioAPContext *s = ctx->priv;
102  static const enum AVSampleFormat sample_fmts[3][3] = {
106  };
107  int ret;
108 
110  return ret;
111 
112  if ((ret = ff_set_common_formats_from_list(ctx, sample_fmts[s->precision])) < 0)
113  return ret;
114 
116 }
117 
119 {
120  AudioAPContext *s = ctx->priv;
121  int i, ret, status;
122  int nb_samples;
123  int64_t pts;
124 
126 
127  nb_samples = FFMIN(ff_inlink_queued_samples(ctx->inputs[0]),
128  ff_inlink_queued_samples(ctx->inputs[1]));
129  for (i = 0; i < ctx->nb_inputs && nb_samples > 0; i++) {
130  if (s->frame[i])
131  continue;
132 
133  if (ff_inlink_check_available_samples(ctx->inputs[i], nb_samples) > 0) {
134  ret = ff_inlink_consume_samples(ctx->inputs[i], nb_samples, nb_samples, &s->frame[i]);
135  if (ret < 0)
136  return ret;
137  }
138  }
139 
140  if (s->frame[0] && s->frame[1]) {
141  AVFrame *out;
142 
143  out = ff_get_audio_buffer(ctx->outputs[0], s->frame[0]->nb_samples);
144  if (!out) {
145  av_frame_free(&s->frame[0]);
146  av_frame_free(&s->frame[1]);
147  return AVERROR(ENOMEM);
148  }
149 
150  ff_filter_execute(ctx, s->filter_channels, out, NULL,
151  FFMIN(ctx->outputs[0]->ch_layout.nb_channels, ff_filter_get_nb_threads(ctx)));
152 
153  out->pts = s->frame[0]->pts;
154  out->duration = s->frame[0]->duration;
155 
156  av_frame_free(&s->frame[0]);
157  av_frame_free(&s->frame[1]);
158 
159  ret = ff_filter_frame(ctx->outputs[0], out);
160  if (ret < 0)
161  return ret;
162  }
163 
164  if (!nb_samples) {
165  for (i = 0; i < 2; i++) {
166  if (ff_inlink_acknowledge_status(ctx->inputs[i], &status, &pts)) {
167  ff_outlink_set_status(ctx->outputs[0], status, pts);
168  return 0;
169  }
170  }
171  }
172 
173  if (ff_outlink_frame_wanted(ctx->outputs[0])) {
174  for (i = 0; i < 2; i++) {
175  if (s->frame[i] || ff_inlink_queued_samples(ctx->inputs[i]) > 0)
176  continue;
177  ff_inlink_request_frame(ctx->inputs[i]);
178  return 0;
179  }
180  }
181  return 0;
182 }
183 
184 #define DEPTH 32
185 #include "aap_template.c"
186 
187 #undef DEPTH
188 #define DEPTH 64
189 #include "aap_template.c"
190 
191 static int config_output(AVFilterLink *outlink)
192 {
193  const int channels = outlink->ch_layout.nb_channels;
194  AVFilterContext *ctx = outlink->src;
195  AudioAPContext *s = ctx->priv;
196 
197  s->kernel_size = FFALIGN(s->order, 16);
198 
199  if (!s->offset)
200  s->offset = ff_get_audio_buffer(outlink, 3);
201  if (!s->delay)
202  s->delay = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
203  if (!s->dcoeffs)
204  s->dcoeffs = ff_get_audio_buffer(outlink, s->kernel_size);
205  if (!s->coeffs)
206  s->coeffs = ff_get_audio_buffer(outlink, 2 * s->kernel_size);
207  if (!s->e)
208  s->e = ff_get_audio_buffer(outlink, 2 * s->projection);
209  if (!s->p)
210  s->p = ff_get_audio_buffer(outlink, s->projection + 1);
211  if (!s->x)
212  s->x = ff_get_audio_buffer(outlink, 2 * (s->projection + s->order));
213  if (!s->w)
214  s->w = ff_get_audio_buffer(outlink, s->projection);
215  if (!s->tmp)
216  s->tmp = ff_get_audio_buffer(outlink, s->kernel_size);
217  if (!s->tmpm)
218  s->tmpm = ff_get_audio_buffer(outlink, s->projection * s->projection);
219  if (!s->itmpm)
220  s->itmpm = ff_get_audio_buffer(outlink, s->projection * s->projection);
221 
222  if (!s->tmpmp)
223  s->tmpmp = av_calloc(s->projection * channels, sizeof(*s->tmpmp));
224  if (!s->itmpmp)
225  s->itmpmp = av_calloc(s->projection * channels, sizeof(*s->itmpmp));
226 
227  if (!s->offset || !s->delay || !s->dcoeffs || !s->coeffs || !s->tmpmp || !s->itmpmp ||
228  !s->e || !s->p || !s->x || !s->w || !s->tmp || !s->tmpm || !s->itmpm)
229  return AVERROR(ENOMEM);
230 
231  switch (outlink->format) {
232  case AV_SAMPLE_FMT_DBLP:
233  for (int ch = 0; ch < channels; ch++) {
234  double *itmpm = (double *)s->itmpm->extended_data[ch];
235  double *tmpm = (double *)s->tmpm->extended_data[ch];
236  double **itmpmp = (double **)&s->itmpmp[s->projection * ch];
237  double **tmpmp = (double **)&s->tmpmp[s->projection * ch];
238 
239  for (int i = 0; i < s->projection; i++) {
240  itmpmp[i] = &itmpm[i * s->projection];
241  tmpmp[i] = &tmpm[i * s->projection];
242  }
243  }
244 
245  s->filter_channels = filter_channels_double;
246  break;
247  case AV_SAMPLE_FMT_FLTP:
248  for (int ch = 0; ch < channels; ch++) {
249  float *itmpm = (float *)s->itmpm->extended_data[ch];
250  float *tmpm = (float *)s->tmpm->extended_data[ch];
251  float **itmpmp = (float **)&s->itmpmp[s->projection * ch];
252  float **tmpmp = (float **)&s->tmpmp[s->projection * ch];
253 
254  for (int i = 0; i < s->projection; i++) {
255  itmpmp[i] = &itmpm[i * s->projection];
256  tmpmp[i] = &tmpm[i * s->projection];
257  }
258  }
259 
260  s->filter_channels = filter_channels_float;
261  break;
262  }
263 
264  return 0;
265 }
266 
268 {
269  AudioAPContext *s = ctx->priv;
270 
271  s->fdsp = avpriv_float_dsp_alloc(0);
272  if (!s->fdsp)
273  return AVERROR(ENOMEM);
274 
275  return 0;
276 }
277 
279 {
280  AudioAPContext *s = ctx->priv;
281 
282  av_freep(&s->fdsp);
283 
284  av_frame_free(&s->offset);
285  av_frame_free(&s->delay);
286  av_frame_free(&s->dcoeffs);
287  av_frame_free(&s->coeffs);
288  av_frame_free(&s->e);
289  av_frame_free(&s->p);
290  av_frame_free(&s->w);
291  av_frame_free(&s->x);
292  av_frame_free(&s->tmp);
293  av_frame_free(&s->tmpm);
294  av_frame_free(&s->itmpm);
295 
296  av_freep(&s->tmpmp);
297  av_freep(&s->itmpmp);
298 }
299 
300 static const AVFilterPad inputs[] = {
301  {
302  .name = "input",
303  .type = AVMEDIA_TYPE_AUDIO,
304  },
305  {
306  .name = "desired",
307  .type = AVMEDIA_TYPE_AUDIO,
308  },
309 };
310 
311 static const AVFilterPad outputs[] = {
312  {
313  .name = "default",
314  .type = AVMEDIA_TYPE_AUDIO,
315  .config_props = config_output,
316  },
317 };
318 
320  .name = "aap",
321  .description = NULL_IF_CONFIG_SMALL("Apply Affine Projection algorithm to first audio stream."),
322  .priv_size = sizeof(AudioAPContext),
323  .priv_class = &aap_class,
324  .init = init,
325  .uninit = uninit,
326  .activate = activate,
332  .process_command = ff_filter_process_command,
333 };
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
AudioAPContext::order
int order
Definition: af_aap.c:45
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
AudioAPContext::frame
AVFrame * frame[2]
Definition: af_aap.c:68
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
AudioAPContext::p
AVFrame * p
Definition: af_aap.c:57
AudioAPContext::tmpm
AVFrame * tmpm
Definition: af_aap.c:62
AVOption
AVOption.
Definition: opt.h:357
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:159
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
AudioAPContext::itmpmp
void ** itmpmp
Definition: af_aap.c:66
AudioAPContext::delta
float delta
Definition: af_aap.c:48
activate
static int activate(AVFilterContext *ctx)
Definition: af_aap.c:118
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
inputs
static const AVFilterPad inputs[]
Definition: af_aap.c:300
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:321
AudioAPContext::precision
int precision
Definition: af_aap.c:50
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
pts
static int64_t pts
Definition: transcode_aac.c:644
aap_options
static const AVOption aap_options[]
Definition: af_aap.c:79
AudioAPContext::filter_channels
int(* filter_channels)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: af_aap.c:70
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
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
ERROR_MODE
@ ERROR_MODE
Definition: af_aap.c:38
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
AudioAPContext::delay
AVFrame * delay
Definition: af_aap.c:54
s
#define s(width, name)
Definition: cbs_vp9.c:198
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
channels
channels
Definition: aptx.h:31
NB_OMODES
@ NB_OMODES
Definition: af_aap.c:39
DESIRED_MODE
@ DESIRED_MODE
Definition: af_aap.c:35
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
AudioAPContext::dcoeffs
AVFrame * dcoeffs
Definition: af_aap.c:60
arg
const char * arg
Definition: jacosubdec.c:67
AudioAPContext::e
AVFrame * e
Definition: af_aap.c:56
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
AudioAPContext::tmp
AVFrame * tmp
Definition: af_aap.c:61
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(aap)
AudioAPContext::w
AVFrame * w
Definition: af_aap.c:59
aap_template.c
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
AudioAPContext::fdsp
AVFloatDSPContext * fdsp
Definition: af_aap.c:72
AudioAPContext::tmpmp
void ** tmpmp
Definition: af_aap.c:65
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
config_output
static int config_output(AVFilterLink *outlink)
Definition: af_aap.c:191
AudioAPContext::offset
AVFrame * offset
Definition: af_aap.c:53
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
AVFloatDSPContext
Definition: float_dsp.h:24
AudioAPContext::itmpm
AVFrame * itmpm
Definition: af_aap.c:63
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
AudioAPContext::x
AVFrame * x
Definition: af_aap.c:58
internal.h
AV_OPT_TYPE_FLOAT
@ AV_OPT_TYPE_FLOAT
Definition: opt.h:248
A
#define A
Definition: af_aap.c:76
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_aap.c:99
OFFSET
#define OFFSET(x)
Definition: af_aap.c:75
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
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_aap.c:267
AudioAPContext::mu
float mu
Definition: af_aap.c:47
AudioAPContext
Definition: af_aap.c:42
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
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
outputs
static const AVFilterPad outputs[]
Definition: af_aap.c:311
AudioAPContext::output_mode
int output_mode
Definition: af_aap.c:49
AVFilter
Filter definition.
Definition: avfilter.h:166
ret
ret
Definition: filter_design.txt:187
NOISE_MODE
@ NOISE_MODE
Definition: af_aap.c:37
IN_MODE
@ IN_MODE
Definition: af_aap.c:34
status
ov_status_e status
Definition: dnn_backend_openvino.c:101
channel_layout.h
AT
#define AT
Definition: af_aap.c:77
OUT_MODE
@ OUT_MODE
Definition: af_aap.c:36
AudioAPContext::kernel_size
int kernel_size
Definition: af_aap.c:52
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:245
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
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
ff_af_aap
const AVFilter ff_af_aap
Definition: af_aap.c:319
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:254
AudioAPContext::coeffs
AVFrame * coeffs
Definition: af_aap.c:55
AudioAPContext::projection
int projection
Definition: af_aap.c:46
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_aap.c:278