FFmpeg
af_apulsator.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2010 Krzysztof Foltman, Markus Schmidt, Thor Harald Johansen and others
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/avassert.h"
22 #include "libavutil/channel_layout.h"
23 #include "libavutil/opt.h"
24 #include "avfilter.h"
25 #include "internal.h"
26 #include "audio.h"
27 
28 enum PulsatorModes { SINE, TRIANGLE, SQUARE, SAWUP, SAWDOWN, NB_MODES };
29 enum PulsatorTimings { UNIT_BPM, UNIT_MS, UNIT_HZ, NB_TIMINGS };
30 
31 typedef struct SimpleLFO {
32  double phase;
33  double freq;
34  double offset;
35  double amount;
36  double pwidth;
37  int mode;
38  int srate;
39 } SimpleLFO;
40 
41 typedef struct AudioPulsatorContext {
42  const AVClass *class;
43  int mode;
44  double level_in;
45  double level_out;
46  double amount;
47  double offset_l;
48  double offset_r;
49  double pwidth;
50  double bpm;
51  double hertz;
52  int ms;
53  int timing;
54 
55  SimpleLFO lfoL, lfoR;
56 } AudioPulsatorContext;
57 
58 #define OFFSET(x) offsetof(AudioPulsatorContext, x)
59 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
60 
61 static const AVOption apulsator_options[] = {
62  { "level_in", "set input gain", OFFSET(level_in), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, FLAGS, },
63  { "level_out", "set output gain", OFFSET(level_out), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.015625, 64, FLAGS, },
64  { "mode", "set mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=SINE}, SINE, NB_MODES-1, FLAGS, "mode" },
65  { "sine", NULL, 0, AV_OPT_TYPE_CONST, {.i64=SINE}, 0, 0, FLAGS, "mode" },
66  { "triangle", NULL, 0, AV_OPT_TYPE_CONST, {.i64=TRIANGLE},0, 0, FLAGS, "mode" },
67  { "square", NULL, 0, AV_OPT_TYPE_CONST, {.i64=SQUARE}, 0, 0, FLAGS, "mode" },
68  { "sawup", NULL, 0, AV_OPT_TYPE_CONST, {.i64=SAWUP}, 0, 0, FLAGS, "mode" },
69  { "sawdown", NULL, 0, AV_OPT_TYPE_CONST, {.i64=SAWDOWN}, 0, 0, FLAGS, "mode" },
70  { "amount", "set modulation", OFFSET(amount), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0, 1, FLAGS },
71  { "offset_l", "set offset L", OFFSET(offset_l), AV_OPT_TYPE_DOUBLE, {.dbl=0}, 0, 1, FLAGS },
72  { "offset_r", "set offset R", OFFSET(offset_r), AV_OPT_TYPE_DOUBLE, {.dbl=.5}, 0, 1, FLAGS },
73  { "width", "set pulse width", OFFSET(pwidth), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0, 2, FLAGS },
74  { "timing", "set timing", OFFSET(timing), AV_OPT_TYPE_INT, {.i64=2}, 0, NB_TIMINGS-1, FLAGS, "timing" },
75  { "bpm", NULL, 0, AV_OPT_TYPE_CONST, {.i64=UNIT_BPM}, 0, 0, FLAGS, "timing" },
76  { "ms", NULL, 0, AV_OPT_TYPE_CONST, {.i64=UNIT_MS}, 0, 0, FLAGS, "timing" },
77  { "hz", NULL, 0, AV_OPT_TYPE_CONST, {.i64=UNIT_HZ}, 0, 0, FLAGS, "timing" },
78  { "bpm", "set BPM", OFFSET(bpm), AV_OPT_TYPE_DOUBLE, {.dbl=120}, 30, 300, FLAGS },
79  { "ms", "set ms", OFFSET(ms), AV_OPT_TYPE_INT, {.i64=500}, 10, 2000, FLAGS },
80  { "hz", "set frequency", OFFSET(hertz), AV_OPT_TYPE_DOUBLE, {.dbl=2}, 0.01, 100, FLAGS },
81  { NULL }
82 };
83 
84 AVFILTER_DEFINE_CLASS(apulsator);
85 
86 static void lfo_advance(SimpleLFO *lfo, unsigned count)
87 {
88  lfo->phase = fabs(lfo->phase + count * lfo->freq / lfo->srate);
89  if (lfo->phase >= 1)
90  lfo->phase = fmod(lfo->phase, 1);
91 }
92 
93 static double lfo_get_value(SimpleLFO *lfo)
94 {
95  double phs = FFMIN(100, lfo->phase / FFMIN(1.99, FFMAX(0.01, lfo->pwidth)) + lfo->offset);
96  double val;
97 
98  if (phs > 1)
99  phs = fmod(phs, 1.);
100 
101  switch (lfo->mode) {
102  case SINE:
103  val = sin(phs * 2 * M_PI);
104  break;
105  case TRIANGLE:
106  if (phs > 0.75)
107  val = (phs - 0.75) * 4 - 1;
108  else if (phs > 0.25)
109  val = -4 * phs + 2;
110  else
111  val = phs * 4;
112  break;
113  case SQUARE:
114  val = phs < 0.5 ? -1 : +1;
115  break;
116  case SAWUP:
117  val = phs * 2 - 1;
118  break;
119  case SAWDOWN:
120  val = 1 - phs * 2;
121  break;
122  default: av_assert0(0);
123  }
124 
125  return val * lfo->amount;
126 }
127 
128 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
129 {
130  AVFilterContext *ctx = inlink->dst;
131  AVFilterLink *outlink = ctx->outputs[0];
132  AudioPulsatorContext *s = ctx->priv;
133  const double *src = (const double *)in->data[0];
134  const int nb_samples = in->nb_samples;
135  const double level_out = s->level_out;
136  const double level_in = s->level_in;
137  const double amount = s->amount;
138  AVFrame *out;
139  double *dst;
140  int n;
141 
142  if (av_frame_is_writable(in)) {
143  out = in;
144  } else {
145  out = ff_get_audio_buffer(inlink, in->nb_samples);
146  if (!out) {
147  av_frame_free(&in);
148  return AVERROR(ENOMEM);
149  }
150  av_frame_copy_props(out, in);
151  }
152  dst = (double *)out->data[0];
153 
154  for (n = 0; n < nb_samples; n++) {
155  double outL;
156  double outR;
157  double inL = src[0] * level_in;
158  double inR = src[1] * level_in;
159  double procL = inL;
160  double procR = inR;
161 
162  procL *= lfo_get_value(&s->lfoL) * 0.5 + amount / 2;
163  procR *= lfo_get_value(&s->lfoR) * 0.5 + amount / 2;
164 
165  outL = procL + inL * (1 - amount);
166  outR = procR + inR * (1 - amount);
167 
168  outL *= level_out;
169  outR *= level_out;
170 
171  dst[0] = outL;
172  dst[1] = outR;
173 
174  lfo_advance(&s->lfoL, 1);
175  lfo_advance(&s->lfoR, 1);
176 
177  dst += 2;
178  src += 2;
179  }
180 
181  if (in != out)
182  av_frame_free(&in);
183 
184  return ff_filter_frame(outlink, out);
185 }
186 
187 static int query_formats(AVFilterContext *ctx)
188 {
189  AVFilterChannelLayouts *layout = NULL;
190  AVFilterFormats *formats = NULL;
191  int ret;
192 
193  if ((ret = ff_add_format (&formats, AV_SAMPLE_FMT_DBL )) < 0 ||
194  (ret = ff_set_common_formats (ctx , formats )) < 0 ||
195  (ret = ff_add_channel_layout (&layout , AV_CH_LAYOUT_STEREO)) < 0 ||
196  (ret = ff_set_common_channel_layouts (ctx , layout )) < 0)
197  return ret;
198 
199  return ff_set_common_all_samplerates(ctx);
200 }
201 
202 static int config_input(AVFilterLink *inlink)
203 {
204  AVFilterContext *ctx = inlink->dst;
205  AudioPulsatorContext *s = ctx->priv;
206  double freq;
207 
208  switch (s->timing) {
209  case UNIT_BPM: freq = s->bpm / 60; break;
210  case UNIT_MS: freq = 1 / (s->ms / 1000.); break;
211  case UNIT_HZ: freq = s->hertz; break;
212  default: av_assert0(0);
213  }
214 
215  s->lfoL.freq = freq;
216  s->lfoR.freq = freq;
217  s->lfoL.mode = s->mode;
218  s->lfoR.mode = s->mode;
219  s->lfoL.offset = s->offset_l;
220  s->lfoR.offset = s->offset_r;
221  s->lfoL.srate = inlink->sample_rate;
222  s->lfoR.srate = inlink->sample_rate;
223  s->lfoL.amount = s->amount;
224  s->lfoR.amount = s->amount;
225  s->lfoL.pwidth = s->pwidth;
226  s->lfoR.pwidth = s->pwidth;
227 
228  return 0;
229 }
230 
231 static const AVFilterPad inputs[] = {
232  {
233  .name = "default",
234  .type = AVMEDIA_TYPE_AUDIO,
235  .config_props = config_input,
236  .filter_frame = filter_frame,
237  },
238 };
239 
240 static const AVFilterPad outputs[] = {
241  {
242  .name = "default",
243  .type = AVMEDIA_TYPE_AUDIO,
244  },
245 };
246 
247 const AVFilter ff_af_apulsator = {
248  .name = "apulsator",
249  .description = NULL_IF_CONFIG_SMALL("Audio pulsator."),
250  .priv_size = sizeof(AudioPulsatorContext),
251  .priv_class = &apulsator_class,
252  FILTER_INPUTS(inputs),
253  FILTER_OUTPUTS(outputs),
254  FILTER_QUERY_FUNC(query_formats),
255 };
formats
formats
Definition: signature.h:48
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:88
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:85
SQUARE
@ SQUARE
Definition: af_apulsator.c:28
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:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
AudioPulsatorContext
Definition: af_apulsator.c:41
inlink
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
Definition: filter_design.txt:212
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:109
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:317
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
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:689
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
AudioPulsatorContext::timing
int timing
Definition: af_apulsator.c:53
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:169
SimpleLFO::phase
double phase
Definition: af_apulsator.c:32
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:338
UNIT_BPM
@ UNIT_BPM
Definition: af_apulsator.c:29
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
lfo_advance
static void lfo_advance(SimpleLFO *lfo, unsigned count)
Definition: af_apulsator.c:86
apulsator_options
static const AVOption apulsator_options[]
Definition: af_apulsator.c:61
val
static double val(void *priv, double ch)
Definition: aeval.c:76
SimpleLFO::srate
int srate
Definition: af_apulsator.c:38
AudioPulsatorContext::bpm
double bpm
Definition: af_apulsator.c:50
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:91
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
avassert.h
UNIT_MS
@ UNIT_MS
Definition: af_apulsator.c:29
ff_set_common_formats
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:699
SimpleLFO::pwidth
double pwidth
Definition: af_apulsator.c:36
ff_add_channel_layout
int ff_add_channel_layout(AVFilterChannelLayouts **l, uint64_t channel_layout)
Definition: formats.c:426
s
#define s(width, name)
Definition: cbs_vp9.c:257
NB_TIMINGS
@ NB_TIMINGS
Definition: af_apulsator.c:29
AudioPulsatorContext::level_out
double level_out
Definition: af_apulsator.c:45
PulsatorTimings
PulsatorTimings
Definition: af_apulsator.c:29
AV_OPT_TYPE_DOUBLE
@ AV_OPT_TYPE_DOUBLE
Definition: opt.h:226
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: af_apulsator.c:128
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_apulsator.c:187
ctx
AVFormatContext * ctx
Definition: movenc.c:48
SimpleLFO
Definition: af_apulsator.c:31
AudioPulsatorContext::lfoL
SimpleLFO lfoL
Definition: af_apulsator.c:55
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
if
if(ret)
Definition: filter_design.txt:179
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
fabs
static __device__ float fabs(float a)
Definition: cuda_runtime.h:182
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:537
AudioPulsatorContext::amount
double amount
Definition: af_apulsator.c:46
src
#define src
Definition: vp8dsp.c:255
ff_add_format
int ff_add_format(AVFilterFormats **avff, int64_t fmt)
Add fmt to the list of media formats contained in *avff.
Definition: formats.c:420
TRIANGLE
@ TRIANGLE
Definition: af_apulsator.c:28
PulsatorModes
PulsatorModes
Definition: af_apulsator.c:28
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(apulsator)
AudioPulsatorContext::hertz
double hertz
Definition: af_apulsator.c:51
for
for(j=16;j >0;--j)
Definition: h264pred_template.c:469
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:117
SAWUP
@ SAWUP
Definition: af_apulsator.c:28
AudioPulsatorContext::lfoR
SimpleLFO lfoR
Definition: af_apulsator.c:55
UNIT_HZ
@ UNIT_HZ
Definition: af_apulsator.c:29
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:473
FLAGS
#define FLAGS
Definition: af_apulsator.c:59
M_PI
#define M_PI
Definition: mathematics.h:52
internal.h
AudioPulsatorContext::level_in
double level_in
Definition: af_apulsator.c:44
SimpleLFO::freq
double freq
Definition: af_apulsator.c:33
layout
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 layout
Definition: filter_design.txt:18
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:397
lfo_get_value
static double lfo_get_value(SimpleLFO *lfo)
Definition: af_apulsator.c:93
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
SimpleLFO::mode
int mode
Definition: af_apulsator.c:37
AVFilter
Filter definition.
Definition: avfilter.h:165
config_input
static int config_input(AVFilterLink *inlink)
Definition: af_apulsator.c:202
AudioPulsatorContext::pwidth
double pwidth
Definition: af_apulsator.c:49
ret
ret
Definition: filter_design.txt:187
NB_MODES
@ NB_MODES
Definition: af_apulsator.c:28
SINE
@ SINE
Definition: af_apulsator.c:28
AudioPulsatorContext::ms
int ms
Definition: af_apulsator.c:52
SimpleLFO::offset
double offset
Definition: af_apulsator.c:34
channel_layout.h
SAWDOWN
@ SAWDOWN
Definition: af_apulsator.c:28
ff_af_apulsator
const AVFilter ff_af_apulsator
Definition: af_apulsator.c:247
mode
mode
Definition: ebur128.h:83
OFFSET
#define OFFSET(x)
Definition: af_apulsator.c:58
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
outputs
static const AVFilterPad outputs[]
Definition: af_apulsator.c:240
AudioPulsatorContext::mode
int mode
Definition: af_apulsator.c:43
AVFilterContext
An instance of a filter.
Definition: avfilter.h:402
audio.h
AudioPulsatorContext::offset_r
double offset_r
Definition: af_apulsator.c:48
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
inputs
static const AVFilterPad inputs[]
Definition: af_apulsator.c:231
SimpleLFO::amount
double amount
Definition: af_apulsator.c:35
AV_SAMPLE_FMT_DBL
@ AV_SAMPLE_FMT_DBL
double
Definition: samplefmt.h:64
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
AudioPulsatorContext::offset_l
double offset_l
Definition: af_apulsator.c:47
ff_set_common_channel_layouts
int ff_set_common_channel_layouts(AVFilterContext *ctx, AVFilterChannelLayouts *channel_layouts)
Helpers for query_formats() which set all free audio links to the same list of channel layouts/sample...
Definition: formats.c:658
Generated on Wed Aug 24 2022 21:38:05 for FFmpeg by   doxygen 1.8.17