FFmpeg
af_adelay.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 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/avstring.h"
22 #include "libavutil/eval.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/samplefmt.h"
25 #include "avfilter.h"
26 #include "audio.h"
27 #include "filters.h"
28 #include "internal.h"
29 
30 typedef struct ChanDelay {
31  int delay;
32  unsigned delay_index;
33  unsigned index;
35 } ChanDelay;
36 
37 typedef struct AudioDelayContext {
38  const AVClass *class;
39  int all;
40  char *delays;
42  int nb_delays;
44  int64_t padding;
45  int64_t max_delay;
46  int64_t next_pts;
47  int eof;
48 
49  void (*delay_channel)(ChanDelay *d, int nb_samples,
50  const uint8_t *src, uint8_t *dst);
52 
53 #define OFFSET(x) offsetof(AudioDelayContext, x)
54 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
55 
56 static const AVOption adelay_options[] = {
57  { "delays", "set list of delays for each channel", OFFSET(delays), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, A },
58  { "all", "use last available delay for remained channels", OFFSET(all), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, A },
59  { NULL }
60 };
61 
62 AVFILTER_DEFINE_CLASS(adelay);
63 
65 {
68  static const enum AVSampleFormat sample_fmts[] = {
72  };
73  int ret;
74 
75  layouts = ff_all_channel_counts();
76  if (!layouts)
77  return AVERROR(ENOMEM);
78  ret = ff_set_common_channel_layouts(ctx, layouts);
79  if (ret < 0)
80  return ret;
81 
82  formats = ff_make_format_list(sample_fmts);
83  if (!formats)
84  return AVERROR(ENOMEM);
85  ret = ff_set_common_formats(ctx, formats);
86  if (ret < 0)
87  return ret;
88 
89  formats = ff_all_samplerates();
90  if (!formats)
91  return AVERROR(ENOMEM);
92  return ff_set_common_samplerates(ctx, formats);
93 }
94 
95 #define DELAY(name, type, fill) \
96 static void delay_channel_## name ##p(ChanDelay *d, int nb_samples, \
97  const uint8_t *ssrc, uint8_t *ddst) \
98 { \
99  const type *src = (type *)ssrc; \
100  type *dst = (type *)ddst; \
101  type *samples = (type *)d->samples; \
102  \
103  while (nb_samples) { \
104  if (d->delay_index < d->delay) { \
105  const int len = FFMIN(nb_samples, d->delay - d->delay_index); \
106  \
107  memcpy(&samples[d->delay_index], src, len * sizeof(type)); \
108  memset(dst, fill, len * sizeof(type)); \
109  d->delay_index += len; \
110  src += len; \
111  dst += len; \
112  nb_samples -= len; \
113  } else { \
114  *dst = samples[d->index]; \
115  samples[d->index] = *src; \
116  nb_samples--; \
117  d->index++; \
118  src++, dst++; \
119  d->index = d->index >= d->delay ? 0 : d->index; \
120  } \
121  } \
122 }
123 
124 DELAY(u8, uint8_t, 0x80)
125 DELAY(s16, int16_t, 0)
126 DELAY(s32, int32_t, 0)
127 DELAY(flt, float, 0)
128 DELAY(dbl, double, 0)
129 
131 {
132  AVFilterContext *ctx = inlink->dst;
133  AudioDelayContext *s = ctx->priv;
134  char *p, *arg, *saveptr = NULL;
135  int i;
136 
137  s->chandelay = av_calloc(inlink->channels, sizeof(*s->chandelay));
138  if (!s->chandelay)
139  return AVERROR(ENOMEM);
140  s->nb_delays = inlink->channels;
141  s->block_align = av_get_bytes_per_sample(inlink->format);
142 
143  p = s->delays;
144  for (i = 0; i < s->nb_delays; i++) {
145  ChanDelay *d = &s->chandelay[i];
146  float delay, div;
147  char type = 0;
148  int ret;
149 
150  if (!(arg = av_strtok(p, "|", &saveptr)))
151  break;
152 
153  p = NULL;
154 
155  ret = av_sscanf(arg, "%d%c", &d->delay, &type);
156  if (ret != 2 || type != 'S') {
157  div = type == 's' ? 1.0 : 1000.0;
158  if (av_sscanf(arg, "%f", &delay) != 1) {
159  av_log(ctx, AV_LOG_ERROR, "Invalid syntax for delay.\n");
160  return AVERROR(EINVAL);
161  }
162  d->delay = delay * inlink->sample_rate / div;
163  }
164 
165  if (d->delay < 0) {
166  av_log(ctx, AV_LOG_ERROR, "Delay must be non negative number.\n");
167  return AVERROR(EINVAL);
168  }
169  }
170 
171  if (s->all && i) {
172  for (int j = i; j < s->nb_delays; j++)
173  s->chandelay[j].delay = s->chandelay[i-1].delay;
174  }
175 
176  s->padding = s->chandelay[0].delay;
177  for (i = 1; i < s->nb_delays; i++) {
178  ChanDelay *d = &s->chandelay[i];
179 
180  s->padding = FFMIN(s->padding, d->delay);
181  }
182 
183  if (s->padding) {
184  for (i = 0; i < s->nb_delays; i++) {
185  ChanDelay *d = &s->chandelay[i];
186 
187  d->delay -= s->padding;
188  }
189  }
190 
191  for (i = 0; i < s->nb_delays; i++) {
192  ChanDelay *d = &s->chandelay[i];
193 
194  if (!d->delay)
195  continue;
196 
198  if (!d->samples)
199  return AVERROR(ENOMEM);
200 
201  s->max_delay = FFMAX(s->max_delay, d->delay);
202  }
203 
204  switch (inlink->format) {
205  case AV_SAMPLE_FMT_U8P : s->delay_channel = delay_channel_u8p ; break;
206  case AV_SAMPLE_FMT_S16P: s->delay_channel = delay_channel_s16p; break;
207  case AV_SAMPLE_FMT_S32P: s->delay_channel = delay_channel_s32p; break;
208  case AV_SAMPLE_FMT_FLTP: s->delay_channel = delay_channel_fltp; break;
209  case AV_SAMPLE_FMT_DBLP: s->delay_channel = delay_channel_dblp; break;
210  }
211 
212  return 0;
213 }
214 
216 {
217  AVFilterContext *ctx = inlink->dst;
218  AudioDelayContext *s = ctx->priv;
219  AVFrame *out_frame;
220  int i;
221 
222  if (ctx->is_disabled || !s->delays)
223  return ff_filter_frame(ctx->outputs[0], frame);
224 
225  out_frame = ff_get_audio_buffer(ctx->outputs[0], frame->nb_samples);
226  if (!out_frame) {
227  av_frame_free(&frame);
228  return AVERROR(ENOMEM);
229  }
230  av_frame_copy_props(out_frame, frame);
231 
232  for (i = 0; i < s->nb_delays; i++) {
233  ChanDelay *d = &s->chandelay[i];
234  const uint8_t *src = frame->extended_data[i];
235  uint8_t *dst = out_frame->extended_data[i];
236 
237  if (!d->delay)
238  memcpy(dst, src, frame->nb_samples * s->block_align);
239  else
240  s->delay_channel(d, frame->nb_samples, src, dst);
241  }
242 
243  out_frame->pts = s->next_pts;
244  s->next_pts += av_rescale_q(frame->nb_samples, (AVRational){1, inlink->sample_rate}, inlink->time_base);
245  av_frame_free(&frame);
246  return ff_filter_frame(ctx->outputs[0], out_frame);
247 }
248 
250 {
251  AVFilterLink *inlink = ctx->inputs[0];
252  AVFilterLink *outlink = ctx->outputs[0];
253  AudioDelayContext *s = ctx->priv;
254  AVFrame *frame = NULL;
255  int ret, status;
256  int64_t pts;
257 
258  FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
259 
260  if (s->padding) {
261  int nb_samples = FFMIN(s->padding, 2048);
262 
263  frame = ff_get_audio_buffer(outlink, nb_samples);
264  if (!frame)
265  return AVERROR(ENOMEM);
266  s->padding -= nb_samples;
267 
269  frame->nb_samples,
270  outlink->channels,
271  frame->format);
272 
273  frame->pts = s->next_pts;
274  if (s->next_pts != AV_NOPTS_VALUE)
275  s->next_pts += av_rescale_q(nb_samples, (AVRational){1, outlink->sample_rate}, outlink->time_base);
276 
277  return ff_filter_frame(outlink, frame);
278  }
279 
280  ret = ff_inlink_consume_frame(inlink, &frame);
281  if (ret < 0)
282  return ret;
283 
284  if (ret > 0)
285  return filter_frame(inlink, frame);
286 
287  if (ff_inlink_acknowledge_status(inlink, &status, &pts)) {
288  if (status == AVERROR_EOF)
289  s->eof = 1;
290  }
291 
292  if (s->eof && s->max_delay) {
293  int nb_samples = FFMIN(s->max_delay, 2048);
294 
295  frame = ff_get_audio_buffer(outlink, nb_samples);
296  if (!frame)
297  return AVERROR(ENOMEM);
298  s->max_delay -= nb_samples;
299 
301  frame->nb_samples,
302  outlink->channels,
303  frame->format);
304 
305  frame->pts = s->next_pts;
306  return filter_frame(inlink, frame);
307  }
308 
309  if (s->eof && s->max_delay == 0) {
311  return 0;
312  }
313 
314  if (!s->eof)
315  FF_FILTER_FORWARD_WANTED(outlink, inlink);
316 
317  return FFERROR_NOT_READY;
318 }
319 
321 {
322  AudioDelayContext *s = ctx->priv;
323 
324  if (s->chandelay) {
325  for (int i = 0; i < s->nb_delays; i++)
326  av_freep(&s->chandelay[i].samples);
327  }
328  av_freep(&s->chandelay);
329 }
330 
331 static const AVFilterPad adelay_inputs[] = {
332  {
333  .name = "default",
334  .type = AVMEDIA_TYPE_AUDIO,
335  .config_props = config_input,
336  },
337  { NULL }
338 };
339 
340 static const AVFilterPad adelay_outputs[] = {
341  {
342  .name = "default",
343  .type = AVMEDIA_TYPE_AUDIO,
344  },
345  { NULL }
346 };
347 
349  .name = "adelay",
350  .description = NULL_IF_CONFIG_SMALL("Delay one or more audio channels."),
351  .query_formats = query_formats,
352  .priv_size = sizeof(AudioDelayContext),
353  .priv_class = &adelay_class,
354  .activate = activate,
355  .uninit = uninit,
356  .inputs = adelay_inputs,
357  .outputs = adelay_outputs,
359 };
float, planar
Definition: samplefmt.h:69
int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe)
Take a frame from the link&#39;s FIFO and update the link&#39;s stats.
Definition: avfilter.c:1489
#define NULL
Definition: coverity.c:32
This structure describes decoded (raw) audio or video data.
Definition: frame.h:308
static int activate(AVFilterContext *ctx)
Definition: af_adelay.c:249
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: af_adelay.c:215
AVOption.
Definition: opt.h:248
#define OFFSET(x)
Definition: af_adelay.c:53
Main libavfilter public API header.
double, planar
Definition: samplefmt.h:70
GLint GLenum type
Definition: opengl_enc.c:104
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *channel_layouts)
A helper for query_formats() which sets all links to the same list of channel layouts/sample rates...
Definition: formats.c:569
return FFERROR_NOT_READY
int64_t next_pts
Definition: af_adelay.c:46
int is_disabled
the enabled state from the last expression evaluation
Definition: avfilter.h:388
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
uint8_t * samples
Definition: af_adelay.c:34
void * av_calloc(size_t nmemb, size_t size)
Non-inlined equivalent of av_mallocz_array().
Definition: mem.c:245
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:287
const char * name
Pad name.
Definition: internal.h:60
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:349
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1091
uint8_t
#define av_cold
Definition: attributes.h:88
AVOptions.
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:401
int64_t max_delay
Definition: af_adelay.c:45
void(* delay_channel)(ChanDelay *d, int nb_samples, const uint8_t *src, uint8_t *dst)
Definition: af_adelay.c:49
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define av_log(a,...)
#define FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink)
Forward the status on an output link to an input link.
Definition: filters.h:199
static const AVOption adelay_options[]
Definition: af_adelay.c:56
A filter pad used for either input or output.
Definition: internal.h:54
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:142
#define src
Definition: vp8dsp.c:254
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:1444
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_adelay.c:320
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:588
int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples, int nb_channels, enum AVSampleFormat sample_fmt)
Fill an audio buffer with silence.
Definition: samplefmt.c:237
AVFrame * ff_get_audio_buffer(AVFilterLink *link, int nb_samples)
Request an audio samples buffer with a specific set of permissions.
Definition: audio.c:86
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
#define A
Definition: af_adelay.c:54
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:153
void * priv
private data for use by the filter
Definition: avfilter.h:356
const char * arg
Definition: jacosubdec.c:66
#define FFMAX(a, b)
Definition: common.h:94
int av_sscanf(const char *string, const char *format,...)
See libc sscanf manual for more information.
Definition: avsscanf.c:962
int delay
Definition: af_adelay.c:31
AVFILTER_DEFINE_CLASS(adelay)
#define FFMIN(a, b)
Definition: common.h:96
static int query_formats(AVFilterContext *ctx)
Definition: af_adelay.c:64
AVFilter ff_af_adelay
Definition: af_adelay.c:348
signed 32 bits, planar
Definition: samplefmt.h:68
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
int32_t
AVFormatContext * ctx
Definition: movenc.c:48
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
#define s(width, name)
Definition: cbs_vp9.c:257
unsigned 8 bits, planar
Definition: samplefmt.h:66
ChanDelay * chandelay
Definition: af_adelay.c:41
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
A list of supported channel layouts.
Definition: formats.h:86
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:381
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
unsigned delay_index
Definition: af_adelay.c:32
int64_t padding
Definition: af_adelay.c:44
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:145
Rational number (pair of numerator and denominator).
Definition: rational.h:58
they must not be accessed directly The fifo field contains the frames that are queued in the input for processing by the filter The status_in and status_out fields contains the queued status(EOF or error) of the link
const char * name
Filter name.
Definition: avfilter.h:149
#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:134
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:353
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:422
static int64_t pts
#define flags(name, subs,...)
Definition: cbs_av1.c:560
int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
Return number of bytes per sample.
Definition: samplefmt.c:106
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
char * av_strtok(char *s, const char *delim, char **saveptr)
Split the string into several tokens which can be accessed by successive calls to av_strtok()...
Definition: avstring.c:186
static const AVFilterPad adelay_inputs[]
Definition: af_adelay.c:331
FF_FILTER_FORWARD_WANTED(outlink, inlink)
static int config_input(AVFilterLink *inlink)
Definition: af_adelay.c:130
unsigned index
Definition: af_adelay.c:33
A list of supported formats for one end of a filter link.
Definition: formats.h:65
An instance of a filter.
Definition: avfilter.h:341
static const AVFilterPad adelay_outputs[]
Definition: af_adelay.c:340
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:884
#define DELAY(name, type, fill)
Definition: af_adelay.c:95
#define av_freep(p)
signed 16 bits, planar
Definition: samplefmt.h:67
#define av_malloc_array(a, b)
formats
Definition: signature.h:48
internal API functions
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
AVFilterChannelLayouts * ff_all_channel_counts(void)
Construct an AVFilterChannelLayouts coding for any channel layout, with known or unknown disposition...
Definition: formats.c:437
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:355
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:374
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:576
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:671
int i
Definition: input.c:407
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
simple arithmetic expression evaluator