asrc_anullsrc.c
Go to the documentation of this file.
1 /*
2  * Copyright 2010 S.N. Hemanth Meenakshisundaram <smeenaks ucsd edu>
3  * Copyright 2010 Stefano Sabatini <stefano.sabatini-lala poste it>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * null audio source
25  */
26 
27 #include <inttypes.h>
28 #include <stdio.h>
29 
31 #include "libavutil/internal.h"
32 #include "libavutil/opt.h"
33 #include "audio.h"
34 #include "avfilter.h"
35 #include "internal.h"
36 
37 typedef struct {
38  const AVClass *class;
40  uint64_t channel_layout;
43  int nb_samples; ///< number of samples per requested frame
44  int64_t pts;
45 } ANullContext;
46 
47 #define OFFSET(x) offsetof(ANullContext, x)
48 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
49 
50 static const AVOption anullsrc_options[]= {
51  { "channel_layout", "set channel_layout", OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, {.str = "stereo"}, 0, 0, FLAGS },
52  { "cl", "set channel_layout", OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, {.str = "stereo"}, 0, 0, FLAGS },
53  { "sample_rate", "set sample rate", OFFSET(sample_rate_str) , AV_OPT_TYPE_STRING, {.str = "44100"}, 0, 0, FLAGS },
54  { "r", "set sample rate", OFFSET(sample_rate_str) , AV_OPT_TYPE_STRING, {.str = "44100"}, 0, 0, FLAGS },
55  { "nb_samples", "set the number of samples per requested frame", OFFSET(nb_samples), AV_OPT_TYPE_INT, {.i64 = 1024}, 0, INT_MAX, FLAGS },
56  { "n", "set the number of samples per requested frame", OFFSET(nb_samples), AV_OPT_TYPE_INT, {.i64 = 1024}, 0, INT_MAX, FLAGS },
57  { NULL },
58 };
59 
60 AVFILTER_DEFINE_CLASS(anullsrc);
61 
62 static int init(AVFilterContext *ctx)
63 {
64  ANullContext *null = ctx->priv;
65  int ret;
66 
67  if ((ret = ff_parse_sample_rate(&null->sample_rate,
68  null->sample_rate_str, ctx)) < 0)
69  return ret;
70 
71  if ((ret = ff_parse_channel_layout(&null->channel_layout,
72  null->channel_layout_str, ctx)) < 0)
73  return ret;
74 
75  return 0;
76 }
77 
79 {
80  ANullContext *null = ctx->priv;
81  int64_t chlayouts[] = { null->channel_layout, -1 };
82  int sample_rates[] = { null->sample_rate, -1 };
83 
87 
88  return 0;
89 }
90 
91 static int config_props(AVFilterLink *outlink)
92 {
93  ANullContext *null = outlink->src->priv;
94  char buf[128];
95 
96  av_get_channel_layout_string(buf, sizeof(buf), 0, null->channel_layout);
97  av_log(outlink->src, AV_LOG_VERBOSE,
98  "sample_rate:%d channel_layout:'%s' nb_samples:%d\n",
99  null->sample_rate, buf, null->nb_samples);
100 
101  return 0;
102 }
103 
104 static int request_frame(AVFilterLink *outlink)
105 {
106  int ret;
107  ANullContext *null = outlink->src->priv;
108  AVFrame *samplesref;
109 
110  samplesref = ff_get_audio_buffer(outlink, null->nb_samples);
111  if (!samplesref)
112  return AVERROR(ENOMEM);
113 
114  samplesref->pts = null->pts;
115  samplesref->channel_layout = null->channel_layout;
116  samplesref->sample_rate = outlink->sample_rate;
117 
118  ret = ff_filter_frame(outlink, av_frame_clone(samplesref));
119  av_frame_free(&samplesref);
120  if (ret < 0)
121  return ret;
122 
123  null->pts += null->nb_samples;
124  return ret;
125 }
126 
128  {
129  .name = "default",
130  .type = AVMEDIA_TYPE_AUDIO,
131  .config_props = config_props,
132  .request_frame = request_frame,
133  },
134  { NULL }
135 };
136 
138  .name = "anullsrc",
139  .description = NULL_IF_CONFIG_SMALL("Null audio source, return empty audio frames."),
140 
141  .init = init,
142  .query_formats = query_formats,
143  .priv_size = sizeof(ANullContext),
144 
145  .inputs = NULL,
146 
147  .outputs = avfilter_asrc_anullsrc_outputs,
148  .priv_class = &anullsrc_class,
149 };
AVFilter avfilter_asrc_anullsrc
This structure describes decoded (raw) audio or video data.
Definition: frame.h:76
AVOption.
Definition: opt.h:251
char * channel_layout_str
Definition: asrc_anullsrc.c:39
static const AVFilterPad outputs[]
Definition: af_ashowinfo.c:117
external API header
#define OFFSET(x)
Definition: asrc_anullsrc.c:47
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:308
const char * name
Pad name.
it can be given away to ff_start_frame *A reference passed to ff_filter_frame(or the deprecated ff_start_frame) is given away and must no longer be used.*A reference created with avfilter_ref_buffer belongs to the code that created it.*A reference obtained with ff_get_video_buffer or ff_get_audio_buffer belongs to the code that requested it.*A reference given as return value by the get_video_buffer or get_audio_buffer method is given away and must no longer be used.Link reference fields---------------------The AVFilterLink structure has a few AVFilterBufferRef fields.The cur_buf and out_buf were used with the deprecated start_frame/draw_slice/end_frame API and should no longer be used.src_buf
AVOptions.
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:159
void 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:545
static int config_props(AVFilterLink *outlink)
Definition: asrc_anullsrc.c:91
AVFilterFormats * ff_all_formats(enum AVMediaType type)
Return a list of all formats supported by FFmpeg for the given media type.
Definition: formats.c:357
A filter pad used for either input or output.
AVFrame * ff_get_audio_buffer(AVFilterLink *link, int nb_samples)
Request an audio samples buffer with a specific set of permissions.
Definition: audio.c:84
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
void * priv
private data for use by the filter
Definition: avfilter.h:545
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
int nb_samples
number of samples per requested frame
Definition: asrc_anullsrc.c:43
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:331
common internal API header
#define AV_LOG_VERBOSE
Definition: log.h:157
audio channel layout utility functions
ret
Definition: avfilter.c:821
static int init(AVFilterContext *ctx)
Definition: asrc_anullsrc.c:62
AVFrame * av_frame_clone(AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:317
NULL
Definition: eval.c:55
#define FLAGS
Definition: asrc_anullsrc.c:48
AVFilterChannelLayouts * avfilter_make_format64_list(const int64_t *fmts)
Definition: formats.c:317
static const AVFilterPad avfilter_asrc_anullsrc_outputs[]
static int query_formats(AVFilterContext *ctx)
Definition: asrc_anullsrc.c:78
uint64_t channel_layout
Definition: asrc_anullsrc.c:40
void * buf
Definition: avisynth_c.h:594
Describe the class of an AVClass context structure.
Definition: log.h:50
int sample_rate
Sample rate of the audio data.
Definition: frame.h:326
Filter definition.
Definition: avfilter.h:436
const char * name
filter name
Definition: avfilter.h:437
static const AVOption anullsrc_options[]
Definition: asrc_anullsrc.c:50
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFilterBuffer 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.Buffer references ownership and permissions
static int request_frame(AVFilterLink *outlink)
void ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:533
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:108
int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx)
Parse a channel layout or a corresponding integer representation.
Definition: formats.c:632
AVFILTER_DEFINE_CLASS(anullsrc)
int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx)
Parse a sample rate.
Definition: formats.c:620
An instance of a filter.
Definition: avfilter.h:524
void 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:526
internal API functions
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
void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout)
Return a description of a channel layout.
char * sample_rate_str
Definition: asrc_anullsrc.c:41