FFmpeg
asrc_sine.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Nicolas George
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 License
8  * 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
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include <float.h>
22 
23 #include "libavutil/avassert.h"
24 #include "libavutil/channel_layout.h"
25 #include "libavutil/eval.h"
26 #include "libavutil/opt.h"
27 #include "audio.h"
28 #include "avfilter.h"
29 #include "filters.h"
30 #include "formats.h"
31 #include "internal.h"
32 
33 typedef struct SineContext {
34  const AVClass *class;
35  double frequency;
36  double beep_factor;
37  char *samples_per_frame;
38  AVExpr *samples_per_frame_expr;
39  int sample_rate;
40  int64_t duration;
41  int16_t *sin;
42  int64_t pts;
43  uint32_t phi; ///< current phase of the sine (2pi = 1<<32)
44  uint32_t dphi; ///< phase increment between two samples
45  unsigned beep_period;
46  unsigned beep_index;
47  unsigned beep_length;
48  uint32_t phi_beep; ///< current phase of the beep
49  uint32_t dphi_beep; ///< phase increment of the beep
50 } SineContext;
51 
52 #define CONTEXT SineContext
53 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
54 
55 #define OPT_GENERIC(name, field, def, min, max, descr, type, deffield, ...) \
56  { name, descr, offsetof(CONTEXT, field), AV_OPT_TYPE_ ## type, \
57  { .deffield = def }, min, max, FLAGS, __VA_ARGS__ }
58 
59 #define OPT_INT(name, field, def, min, max, descr, ...) \
60  OPT_GENERIC(name, field, def, min, max, descr, INT, i64, __VA_ARGS__)
61 
62 #define OPT_DBL(name, field, def, min, max, descr, ...) \
63  OPT_GENERIC(name, field, def, min, max, descr, DOUBLE, dbl, __VA_ARGS__)
64 
65 #define OPT_DUR(name, field, def, min, max, descr, ...) \
66  OPT_GENERIC(name, field, def, min, max, descr, DURATION, str, __VA_ARGS__)
67 
68 #define OPT_STR(name, field, def, min, max, descr, ...) \
69  OPT_GENERIC(name, field, def, min, max, descr, STRING, str, __VA_ARGS__)
70 
71 static const AVOption sine_options[] = {
72  OPT_DBL("frequency", frequency, 440, 0, DBL_MAX, "set the sine frequency",),
73  OPT_DBL("f", frequency, 440, 0, DBL_MAX, "set the sine frequency",),
74  OPT_DBL("beep_factor", beep_factor, 0, 0, DBL_MAX, "set the beep frequency factor",),
75  OPT_DBL("b", beep_factor, 0, 0, DBL_MAX, "set the beep frequency factor",),
76  OPT_INT("sample_rate", sample_rate, 44100, 1, INT_MAX, "set the sample rate",),
77  OPT_INT("r", sample_rate, 44100, 1, INT_MAX, "set the sample rate",),
78  OPT_DUR("duration", duration, 0, 0, INT64_MAX, "set the audio duration",),
79  OPT_DUR("d", duration, 0, 0, INT64_MAX, "set the audio duration",),
80  OPT_STR("samples_per_frame", samples_per_frame, "1024", 0, 0, "set the number of samples per frame",),
81  {NULL}
82 };
83 
84 AVFILTER_DEFINE_CLASS(sine);
85 
86 #define LOG_PERIOD 15
87 #define AMPLITUDE 4095
88 #define AMPLITUDE_SHIFT 3
89 
90 static void make_sin_table(int16_t *sin)
91 {
92  unsigned half_pi = 1 << (LOG_PERIOD - 2);
93  unsigned ampls = AMPLITUDE << AMPLITUDE_SHIFT;
94  uint64_t unit2 = (uint64_t)(ampls * ampls) << 32;
95  unsigned step, i, c, s, k, new_k, n2;
96 
97  /* Principle: if u = exp(i*a1) and v = exp(i*a2), then
98  exp(i*(a1+a2)/2) = (u+v) / length(u+v) */
99  sin[0] = 0;
100  sin[half_pi] = ampls;
101  for (step = half_pi; step > 1; step /= 2) {
102  /* k = (1 << 16) * amplitude / length(u+v)
103  In exact values, k is constant at a given step */
104  k = 0x10000;
105  for (i = 0; i < half_pi / 2; i += step) {
106  s = sin[i] + sin[i + step];
107  c = sin[half_pi - i] + sin[half_pi - i - step];
108  n2 = s * s + c * c;
109  /* Newton's method to solve n² * k² = unit² */
110  while (1) {
111  new_k = (k + unit2 / ((uint64_t)k * n2) + 1) >> 1;
112  if (k == new_k)
113  break;
114  k = new_k;
115  }
116  sin[i + step / 2] = (k * s + 0x7FFF) >> 16;
117  sin[half_pi - i - step / 2] = (k * c + 0x8000) >> 16;
118  }
119  }
120  /* Unshift amplitude */
121  for (i = 0; i <= half_pi; i++)
122  sin[i] = (sin[i] + (1 << (AMPLITUDE_SHIFT - 1))) >> AMPLITUDE_SHIFT;
123  /* Use symmetries to fill the other three quarters */
124  for (i = 0; i < half_pi; i++)
125  sin[half_pi * 2 - i] = sin[i];
126  for (i = 0; i < 2 * half_pi; i++)
127  sin[i + 2 * half_pi] = -sin[i];
128 }
129 
130 static const char *const var_names[] = {
131  "n",
132  "pts",
133  "t",
134  "TB",
135  NULL
136 };
137 
138 enum {
139  VAR_N,
140  VAR_PTS,
141  VAR_T,
142  VAR_TB,
143  VAR_VARS_NB
144 };
145 
146 static av_cold int init(AVFilterContext *ctx)
147 {
148  int ret;
149  SineContext *sine = ctx->priv;
150 
151  if (!(sine->sin = av_malloc(sizeof(*sine->sin) << LOG_PERIOD)))
152  return AVERROR(ENOMEM);
153  sine->dphi = ldexp(sine->frequency, 32) / sine->sample_rate + 0.5;
154  make_sin_table(sine->sin);
155 
156  if (sine->beep_factor) {
157  sine->beep_period = sine->sample_rate;
158  sine->beep_length = sine->beep_period / 25;
159  sine->dphi_beep = ldexp(sine->beep_factor * sine->frequency, 32) /
160  sine->sample_rate + 0.5;
161  }
162 
163  ret = av_expr_parse(&sine->samples_per_frame_expr,
164  sine->samples_per_frame, var_names,
165  NULL, NULL, NULL, NULL, 0, sine);
166  if (ret < 0)
167  return ret;
168 
169  return 0;
170 }
171 
172 static av_cold void uninit(AVFilterContext *ctx)
173 {
174  SineContext *sine = ctx->priv;
175 
176  av_expr_free(sine->samples_per_frame_expr);
177  sine->samples_per_frame_expr = NULL;
178  av_freep(&sine->sin);
179 }
180 
181 static av_cold int query_formats(AVFilterContext *ctx)
182 {
183  SineContext *sine = ctx->priv;
184  static const AVChannelLayout chlayouts[] = { AV_CHANNEL_LAYOUT_MONO, { 0 } };
185  int sample_rates[] = { sine->sample_rate, -1 };
186  static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_S16,
187  AV_SAMPLE_FMT_NONE };
188  int ret = ff_set_common_formats_from_list(ctx, sample_fmts);
189  if (ret < 0)
190  return ret;
191 
192  ret = ff_set_common_channel_layouts_from_list(ctx, chlayouts);
193  if (ret < 0)
194  return ret;
195 
196  return ff_set_common_samplerates_from_list(ctx, sample_rates);
197 }
198 
199 static av_cold int config_props(AVFilterLink *outlink)
200 {
201  SineContext *sine = outlink->src->priv;
202  sine->duration = av_rescale(sine->duration, sine->sample_rate, AV_TIME_BASE);
203  return 0;
204 }
205 
206 static int activate(AVFilterContext *ctx)
207 {
208  AVFilterLink *outlink = ctx->outputs[0];
209  SineContext *sine = ctx->priv;
210  AVFrame *frame;
211  double values[VAR_VARS_NB] = {
212  [VAR_N] = outlink->frame_count_in,
213  [VAR_PTS] = sine->pts,
214  [VAR_T] = sine->pts * av_q2d(outlink->time_base),
215  [VAR_TB] = av_q2d(outlink->time_base),
216  };
217  int i, nb_samples = lrint(av_expr_eval(sine->samples_per_frame_expr, values, sine));
218  int16_t *samples;
219 
220  if (!ff_outlink_frame_wanted(outlink))
221  return FFERROR_NOT_READY;
222  if (nb_samples <= 0) {
223  av_log(sine, AV_LOG_WARNING, "nb samples expression evaluated to %d, "
224  "defaulting to 1024\n", nb_samples);
225  nb_samples = 1024;
226  }
227 
228  if (sine->duration) {
229  nb_samples = FFMIN(nb_samples, sine->duration - sine->pts);
230  av_assert1(nb_samples >= 0);
231  if (!nb_samples) {
232  ff_outlink_set_status(outlink, AVERROR_EOF, sine->pts);
233  return 0;
234  }
235  }
236  if (!(frame = ff_get_audio_buffer(outlink, nb_samples)))
237  return AVERROR(ENOMEM);
238  samples = (int16_t *)frame->data[0];
239 
240  for (i = 0; i < nb_samples; i++) {
241  samples[i] = sine->sin[sine->phi >> (32 - LOG_PERIOD)];
242  sine->phi += sine->dphi;
243  if (sine->beep_index < sine->beep_length) {
244  samples[i] += sine->sin[sine->phi_beep >> (32 - LOG_PERIOD)] * 2;
245  sine->phi_beep += sine->dphi_beep;
246  }
247  if (++sine->beep_index == sine->beep_period)
248  sine->beep_index = 0;
249  }
250 
251  frame->pts = sine->pts;
252  sine->pts += nb_samples;
253  return ff_filter_frame(outlink, frame);
254 }
255 
256 static const AVFilterPad sine_outputs[] = {
257  {
258  .name = "default",
259  .type = AVMEDIA_TYPE_AUDIO,
260  .config_props = config_props,
261  },
262 };
263 
264 const AVFilter ff_asrc_sine = {
265  .name = "sine",
266  .description = NULL_IF_CONFIG_SMALL("Generate sine wave audio signal."),
267  .init = init,
268  .uninit = uninit,
269  .activate = activate,
270  .priv_size = sizeof(SineContext),
271  .inputs = NULL,
272  FILTER_OUTPUTS(sine_outputs),
273  FILTER_QUERY_FUNC(query_formats),
274  .priv_class = &sine_class,
275 };
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_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
SineContext::duration
int64_t duration
Definition: asrc_sine.c:40
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
sine_options
static const AVOption sine_options[]
Definition: asrc_sine.c:71
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:947
SineContext::frequency
double frequency
Definition: asrc_sine.c:35
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
FFERROR_NOT_READY
return FFERROR_NOT_READY
Definition: filter_design.txt:204
int64_t
long long int64_t
Definition: coverity.c:34
VAR_T
@ VAR_T
Definition: asrc_sine.c:141
ff_set_common_samplerates_from_list
int ff_set_common_samplerates_from_list(AVFilterContext *ctx, const int *samplerates)
Equivalent to ff_set_common_samplerates(ctx, ff_make_format_list(samplerates))
Definition: formats.c:815
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(sine)
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:344
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:456
step
trying all byte sequences megabyte in length and selecting the best looking sequence will yield cases to try But a word about which is also called distortion Distortion can be quantified by almost any quality measurement one chooses the sum of squared differences is used but more complex methods that consider psychovisual effects can be used as well It makes no difference in this discussion First step
Definition: rate_distortion.txt:58
config_props
static av_cold int config_props(AVFilterLink *outlink)
Definition: asrc_sine.c:199
AVOption
AVOption.
Definition: opt.h:346
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:159
float.h
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
make_sin_table
static void make_sin_table(int16_t *sin)
Definition: asrc_sine.c:90
sample_rate
sample_rate
Definition: ffmpeg_filter.c:409
activate
static int activate(AVFilterContext *ctx)
Definition: asrc_sine.c:206
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:365
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
formats.h
av_expr_parse
int av_expr_parse(AVExpr **expr, const char *s, const char *const *const_names, const char *const *func1_names, double(*const *funcs1)(void *, double), const char *const *func2_names, double(*const *funcs2)(void *, double, double), int log_offset, void *log_ctx)
Parse an expression.
Definition: eval.c:711
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: asrc_sine.c:172
AVFilterContext::priv
void * priv
private data for use by the filter
Definition: avfilter.h:422
OPT_DBL
#define OPT_DBL(name, field, def, min, max, descr,...)
Definition: asrc_sine.c:62
av_expr_free
void av_expr_free(AVExpr *e)
Free a parsed expression previously created with av_expr_parse().
Definition: eval.c:359
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
avassert.h
lrint
#define lrint
Definition: tablegen.h:53
av_cold
#define av_cold
Definition: attributes.h:90
duration
int64_t duration
Definition: movenc.c:64
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
s
#define s(width, name)
Definition: cbs_vp9.c:198
AMPLITUDE_SHIFT
#define AMPLITUDE_SHIFT
Definition: asrc_sine.c:88
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_q2d
static double av_q2d(AVRational a)
Convert an AVRational to a double.
Definition: rational.h:104
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:873
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_expr_eval
double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
Evaluate a previously parsed expression.
Definition: eval.c:793
AVExpr
Definition: eval.c:159
var_names
static const char *const var_names[]
Definition: asrc_sine.c:130
ff_set_common_channel_layouts_from_list
int ff_set_common_channel_layouts_from_list(AVFilterContext *ctx, const AVChannelLayout *fmts)
Equivalent to ff_set_common_channel_layouts(ctx, ff_make_channel_layout_list(fmts))
Definition: formats.c:797
OPT_DUR
#define OPT_DUR(name, field, def, min, max, descr,...)
Definition: asrc_sine.c:65
frame
static AVFrame * frame
Definition: demux_decode.c:54
SineContext::beep_index
unsigned beep_index
Definition: asrc_sine.c:46
SineContext::samples_per_frame_expr
AVExpr * samples_per_frame_expr
Definition: asrc_sine.c:38
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
LOG_PERIOD
#define LOG_PERIOD
Definition: asrc_sine.c:86
NULL
#define NULL
Definition: coverity.c:32
SineContext::sample_rate
int sample_rate
Definition: asrc_sine.c:39
SineContext::pts
int64_t pts
Definition: asrc_sine.c:42
inputs
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
Definition: filter_design.txt:243
SineContext::dphi_beep
uint32_t dphi_beep
phase increment of the beep
Definition: asrc_sine.c:49
SineContext
Definition: asrc_sine.c:33
c
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
SineContext::beep_factor
double beep_factor
Definition: asrc_sine.c:36
eval.h
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:106
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:303
OPT_STR
#define OPT_STR(name, field, def, min, max, descr,...)
Definition: asrc_sine.c:68
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
sine_outputs
static const AVFilterPad sine_outputs[]
Definition: asrc_sine.c:256
OPT_INT
#define OPT_INT(name, field, def, min, max, descr,...)
Definition: asrc_sine.c:59
sample_rates
sample_rates
Definition: ffmpeg_filter.c:409
internal.h
SineContext::sin
int16_t * sin
Definition: asrc_sine.c:41
VAR_PTS
@ VAR_PTS
Definition: asrc_sine.c:140
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
SineContext::phi
uint32_t phi
current phase of the sine (2pi = 1<<32)
Definition: asrc_sine.c:43
AV_TIME_BASE
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:254
av_assert1
#define av_assert1(cond)
assert() equivalent, that does not lie in speed critical code.
Definition: avassert.h:56
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:55
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:58
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
av_rescale
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:129
init
static av_cold int init(AVFilterContext *ctx)
Definition: asrc_sine.c:146
AVFilter
Filter definition.
Definition: avfilter.h:166
SineContext::beep_length
unsigned beep_length
Definition: asrc_sine.c:47
SineContext::beep_period
unsigned beep_period
Definition: asrc_sine.c:45
ret
ret
Definition: filter_design.txt:187
channel_layout.h
avfilter.h
SineContext::dphi
uint32_t dphi
phase increment between two samples
Definition: asrc_sine.c:44
VAR_TB
@ VAR_TB
Definition: asrc_sine.c:142
values
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 values
Definition: filter_design.txt:263
samples
Filter the word “frame” indicates either a video frame or a group of audio samples
Definition: filter_design.txt:8
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
ff_asrc_sine
const AVFilter ff_asrc_sine
Definition: asrc_sine.c:264
audio.h
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:378
VAR_VARS_NB
@ VAR_VARS_NB
Definition: asrc_sine.c:143
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
VAR_N
@ VAR_N
Definition: asrc_sine.c:139
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
SineContext::phi_beep
uint32_t phi_beep
current phase of the beep
Definition: asrc_sine.c:48
AMPLITUDE
#define AMPLITUDE
Definition: asrc_sine.c:87
query_formats
static av_cold int query_formats(AVFilterContext *ctx)
Definition: asrc_sine.c:181
SineContext::samples_per_frame
char * samples_per_frame
Definition: asrc_sine.c:37
Generated on Thu Sep 26 2024 23:15:31 for FFmpeg by   doxygen 1.8.17