FFmpeg
af_vibrato.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Kyle Swanson <k@ylo.ph>.
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/opt.h"
22 #include "avfilter.h"
23 #include "internal.h"
24 #include "audio.h"
25 #include "generate_wave_table.h"
26 
27 typedef struct VibratoContext {
28  const AVClass *class;
29  double freq;
30  double depth;
31  int channels;
32 
33  double **buf;
34  int buf_index;
35  int buf_size;
36 
37  double *wave_table;
41 
42 #define OFFSET(x) offsetof(VibratoContext, x)
43 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
44 
45 static const AVOption vibrato_options[] = {
46  { "f", "set frequency in hertz", OFFSET(freq), AV_OPT_TYPE_DOUBLE, {.dbl = 5.0}, 0.1, 20000.0, FLAGS },
47  { "d", "set depth as percentage", OFFSET(depth), AV_OPT_TYPE_DOUBLE, {.dbl = 0.5}, 0.00, 1.0, FLAGS },
48  { NULL }
49 };
50 
51 AVFILTER_DEFINE_CLASS(vibrato);
52 
54 {
55  AVFilterContext *ctx = inlink->dst;
56  VibratoContext *s = ctx->priv;
57  AVFilterLink *outlink = ctx->outputs[0];
58  AVFrame *out;
59  int n, c;
60  const double *src;
61  double *dst;
62 
63  if (av_frame_is_writable(in)) {
64  out = in;
65  } else {
66  out = ff_get_audio_buffer(outlink, in->nb_samples);
67  if (!out) {
68  av_frame_free(&in);
69  return AVERROR(ENOMEM);
70  }
71  av_frame_copy_props(out, in);
72  }
73 
74 
75  for (n = 0; n < in->nb_samples; n++) {
76  double integer, decimal;
77  decimal = modf(s->depth * s->wave_table[s->wave_table_index], &integer);
78 
79  s->wave_table_index++;
80  if (s->wave_table_index >= s->wave_table_size)
82 
83  for (c = 0; c < inlink->channels; c++) {
84  int samp1_index, samp2_index;
85  double *buf;
86  double this_samp;
87 
88  src = (const double *)in->extended_data[c];
89  dst = (double *)out->extended_data[c];
90  buf = s->buf[c];
91 
92  samp1_index = s->buf_index + integer;
93  if (samp1_index >= s->buf_size)
94  samp1_index -= s->buf_size;
95  samp2_index = samp1_index + 1;
96  if (samp2_index >= s->buf_size)
97  samp2_index -= s->buf_size;
98 
99  this_samp = src[n];
100  dst[n] = buf[samp1_index] + (decimal * (buf[samp2_index] - buf[samp1_index]));
101  buf[s->buf_index] = this_samp;
102  }
103  s->buf_index++;
104  if (s->buf_index >= s->buf_size)
105  s->buf_index -= s->buf_size;
106  }
107 
108  if (in != out)
109  av_frame_free(&in);
110 
111  return ff_filter_frame(outlink, out);
112 }
113 
115 {
118  static const enum AVSampleFormat sample_fmts[] = {
121  };
122  int ret;
123 
124  layouts = ff_all_channel_counts();
125  if (!layouts)
126  return AVERROR(ENOMEM);
127  ret = ff_set_common_channel_layouts(ctx, layouts);
128  if (ret < 0)
129  return ret;
130 
131  formats = ff_make_format_list(sample_fmts);
132  if (!formats)
133  return AVERROR(ENOMEM);
134  ret = ff_set_common_formats(ctx, formats);
135  if (ret < 0)
136  return ret;
137 
138  formats = ff_all_samplerates();
139  if (!formats)
140  return AVERROR(ENOMEM);
141  return ff_set_common_samplerates(ctx, formats);
142 }
143 
145 {
146  VibratoContext *s = ctx->priv;
147  int c;
148 
149  av_freep(&s->wave_table);
150  for (c = 0; c < s->channels; c++)
151  av_freep(&s->buf[c]);
152  av_freep(&s->buf);
153 }
154 
156 {
157  int c;
158  AVFilterContext *ctx = inlink->dst;
159  VibratoContext *s = ctx->priv;
160  s->channels = inlink->channels;
161 
162  s->buf = av_calloc(inlink->channels, sizeof(*s->buf));
163  if (!s->buf)
164  return AVERROR(ENOMEM);
165  s->buf_size = inlink->sample_rate * 0.005;
166  for (c = 0; c < s->channels; c++) {
167  s->buf[c] = av_malloc_array(s->buf_size, sizeof(*s->buf[c]));
168  if (!s->buf[c])
169  return AVERROR(ENOMEM);
170  }
171  s->buf_index = 0;
172 
173  s->wave_table_size = inlink->sample_rate / s->freq;
175  if (!s->wave_table)
176  return AVERROR(ENOMEM);
178  s->wave_table_index = 0;
179 
180  return 0;
181 }
182 
184  {
185  .name = "default",
186  .type = AVMEDIA_TYPE_AUDIO,
187  .config_props = config_input,
188  .filter_frame = filter_frame,
189  },
190  { NULL }
191 };
192 
194  {
195  .name = "default",
196  .type = AVMEDIA_TYPE_AUDIO,
197  },
198  { NULL }
199 };
200 
202  .name = "vibrato",
203  .description = NULL_IF_CONFIG_SMALL("Apply vibrato effect."),
204  .priv_size = sizeof(VibratoContext),
205  .priv_class = &vibrato_class,
206  .uninit = uninit,
208  .inputs = avfilter_af_vibrato_inputs,
209  .outputs = avfilter_af_vibrato_outputs,
210 };
#define NULL
Definition: coverity.c:32
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *layouts)
A helper for query_formats() which sets all links to the same list of channel layouts/sample rates...
Definition: formats.c:550
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
AVOption.
Definition: opt.h:246
static const AVFilterPad avfilter_af_vibrato_inputs[]
Definition: af_vibrato.c:183
Main libavfilter public API header.
double depth
Definition: af_vibrato.c:30
static int query_formats(AVFilterContext *ctx)
Definition: af_vibrato.c:114
double, planar
Definition: samplefmt.h:70
int wave_table_size
Definition: af_vibrato.c:39
static const AVOption vibrato_options[]
Definition: af_vibrato.c:45
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_vibrato.c:144
#define src
Definition: vp8dsp.c:254
void * av_calloc(size_t nmemb, size_t size)
Non-inlined equivalent of av_mallocz_array().
Definition: mem.c:244
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
const char * name
Pad name.
Definition: internal.h:60
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1093
#define av_cold
Definition: attributes.h:82
AVOptions.
#define FLAGS
Definition: af_vibrato.c:43
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
double ** buf
Definition: af_vibrato.c:33
AVFilter ff_af_vibrato
Definition: af_vibrato.c:201
A filter pad used for either input or output.
Definition: internal.h:54
static int config_input(AVFilterLink *inlink)
Definition: af_vibrato.c:155
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:569
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:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
void * priv
private data for use by the filter
Definition: avfilter.h:353
#define M_PI_2
Definition: mathematics.h:55
int wave_table_index
Definition: af_vibrato.c:38
AVFormatContext * ctx
Definition: movenc.c:48
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_vibrato.c:53
#define s(width, name)
Definition: cbs_vp9.c:257
int n
Definition: avisynth_c.h:760
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
void ff_generate_wave_table(enum WaveType wave_type, enum AVSampleFormat sample_fmt, void *table, int table_size, double min, double max, double phase)
A list of supported channel layouts.
Definition: formats.h:85
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:594
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
uint8_t pi<< 24) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0f/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_U8, uint8_t,(*(const uint8_t *) pi-0x80)*(1.0/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S16, int16_t,(*(const int16_t *) pi >> 8)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0f/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S16, int16_t,*(const int16_t *) pi *(1.0/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S32, int32_t,(*(const int32_t *) pi >> 24)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0f/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S32, int32_t,*(const int32_t *) pi *(1.0/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_FLT, float, av_clip_uint8(lrintf(*(const float *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_FLT, float, av_clip_int16(lrintf(*(const float *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_FLT, float, av_clipl_int32(llrintf(*(const float *) pi *(1U<< 31)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_DBL, double, av_clip_uint8(lrint(*(const double *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_DBL, double, av_clip_int16(lrint(*(const double *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_DBL, double, av_clipl_int32(llrint(*(const double *) pi *(1U<< 31))))#define SET_CONV_FUNC_GROUP(ofmt, ifmt) static void set_generic_function(AudioConvert *ac){}void ff_audio_convert_free(AudioConvert **ac){if(!*ac) return;ff_dither_free(&(*ac) ->dc);av_freep(ac);}AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr, enum AVSampleFormat out_fmt, enum AVSampleFormat in_fmt, int channels, int sample_rate, int apply_map){AudioConvert *ac;int in_planar, out_planar;ac=av_mallocz(sizeof(*ac));if(!ac) return NULL;ac->avr=avr;ac->out_fmt=out_fmt;ac->in_fmt=in_fmt;ac->channels=channels;ac->apply_map=apply_map;if(avr->dither_method!=AV_RESAMPLE_DITHER_NONE &&av_get_packed_sample_fmt(out_fmt)==AV_SAMPLE_FMT_S16 &&av_get_bytes_per_sample(in_fmt) > 2){ac->dc=ff_dither_alloc(avr, out_fmt, in_fmt, channels, sample_rate, apply_map);if(!ac->dc){av_free(ac);return NULL;}return ac;}in_planar=ff_sample_fmt_is_planar(in_fmt, channels);out_planar=ff_sample_fmt_is_planar(out_fmt, channels);if(in_planar==out_planar){ac->func_type=CONV_FUNC_TYPE_FLAT;ac->planes=in_planar?ac->channels:1;}else if(in_planar) ac->func_type=CONV_FUNC_TYPE_INTERLEAVE;else ac->func_type=CONV_FUNC_TYPE_DEINTERLEAVE;set_generic_function(ac);if(ARCH_AARCH64) ff_audio_convert_init_aarch64(ac);if(ARCH_ARM) ff_audio_convert_init_arm(ac);if(ARCH_X86) ff_audio_convert_init_x86(ac);return ac;}int ff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in){int use_generic=1;int len=in->nb_samples;int p;if(ac->dc){av_log(ac->avr, AV_LOG_TRACE,"%d samples - audio_convert: %s to %s (dithered)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt));return ff_convert_dither(ac-> in
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
const char * name
Filter name.
Definition: avfilter.h:148
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:394
double * wave_table
Definition: af_vibrato.c:37
AVFILTER_DEFINE_CLASS(vibrato)
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
#define OFFSET(x)
Definition: af_vibrato.c:42
static const AVFilterPad avfilter_af_vibrato_outputs[]
Definition: af_vibrato.c:193
A list of supported formats for one end of a filter link.
Definition: formats.h:64
An instance of a filter.
Definition: avfilter.h:338
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:701
FILE * out
Definition: movenc.c:54
int integer
#define av_freep(p)
#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:409
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:342
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:361
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:557
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:654