FFmpeg
af_aformat.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 Mina Nagy Zaki
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 /**
22  * @file
23  * format audio filter
24  */
25 
26 #include "libavutil/avstring.h"
28 #include "libavutil/common.h"
29 #include "libavutil/opt.h"
30 
31 #include "audio.h"
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 
36 typedef struct AFormatContext {
37  const AVClass *class;
38 
42 
43  char *formats_str;
47 
48 #define OFFSET(x) offsetof(AFormatContext, x)
49 #define A AV_OPT_FLAG_AUDIO_PARAM
50 #define F AV_OPT_FLAG_FILTERING_PARAM
51 static const AVOption aformat_options[] = {
52  { "sample_fmts", "A '|'-separated list of sample formats.", OFFSET(formats_str), AV_OPT_TYPE_STRING, .flags = A|F },
53  { "f", "A '|'-separated list of sample formats.", OFFSET(formats_str), AV_OPT_TYPE_STRING, .flags = A|F },
54  { "sample_rates", "A '|'-separated list of sample rates.", OFFSET(sample_rates_str), AV_OPT_TYPE_STRING, .flags = A|F },
55  { "r", "A '|'-separated list of sample rates.", OFFSET(sample_rates_str), AV_OPT_TYPE_STRING, .flags = A|F },
56  { "channel_layouts", "A '|'-separated list of channel layouts.", OFFSET(channel_layouts_str), AV_OPT_TYPE_STRING, .flags = A|F },
57  { "cl", "A '|'-separated list of channel layouts.", OFFSET(channel_layouts_str), AV_OPT_TYPE_STRING, .flags = A|F },
58  { NULL }
59 };
60 
61 AVFILTER_DEFINE_CLASS(aformat);
62 
63 #define PARSE_FORMATS(str, type, list, add_to_list, get_fmt, none, desc) \
64 do { \
65  char *next, *cur = str, sep; \
66  int ret; \
67  \
68  if (str && strchr(str, ',')) { \
69  av_log(ctx, AV_LOG_WARNING, "This syntax is deprecated, use '|' to "\
70  "separate %s.\n", desc); \
71  sep = ','; \
72  } else \
73  sep = '|'; \
74  \
75  while (cur) { \
76  type fmt; \
77  next = strchr(cur, sep); \
78  if (next) \
79  *next++ = 0; \
80  \
81  if ((fmt = get_fmt(cur)) == none) { \
82  av_log(ctx, AV_LOG_ERROR, "Error parsing " desc ": %s.\n", cur);\
83  return AVERROR(EINVAL); \
84  } \
85  if ((ret = add_to_list(&list, fmt)) < 0) { \
86  return ret; \
87  } \
88  \
89  cur = next; \
90  } \
91 } while (0)
92 
93 static int get_sample_rate(const char *samplerate)
94 {
95  int ret = strtol(samplerate, NULL, 0);
96  return FFMAX(ret, 0);
97 }
98 
100 {
101  AFormatContext *s = ctx->priv;
102 
103  PARSE_FORMATS(s->formats_str, enum AVSampleFormat, s->formats,
105  PARSE_FORMATS(s->sample_rates_str, int, s->sample_rates, ff_add_format,
106  get_sample_rate, 0, "sample rate");
107  PARSE_FORMATS(s->channel_layouts_str, uint64_t, s->channel_layouts,
109  "channel layout");
110 
111  return 0;
112 }
113 
115 {
116  AFormatContext *s = ctx->priv;
117 
118  ff_formats_unref(&s->formats);
119  ff_formats_unref(&s->sample_rates);
120  ff_channel_layouts_unref(&s->channel_layouts);
121 }
122 
124 {
125  AFormatContext *s = ctx->priv;
126  int ret;
127 
128  ret = ff_set_common_formats(ctx, s->formats ? s->formats :
130  s->formats = NULL;
131  if (ret < 0)
132  return ret;
133  ret = ff_set_common_samplerates(ctx, s->sample_rates ? s->sample_rates :
135  s->sample_rates = NULL;
136  if (ret < 0)
137  return ret;
138  ret = ff_set_common_channel_layouts(ctx, s->channel_layouts ? s->channel_layouts :
140  s->channel_layouts = NULL;
141  return ret;
142 }
143 
145  {
146  .name = "default",
147  .type = AVMEDIA_TYPE_AUDIO,
148  },
149 };
150 
152  {
153  .name = "default",
154  .type = AVMEDIA_TYPE_AUDIO
155  },
156 };
157 
159  .name = "aformat",
160  .description = NULL_IF_CONFIG_SMALL("Convert the input audio to one of the specified formats."),
161  .init = init,
162  .uninit = uninit,
163  .priv_size = sizeof(AFormatContext),
164  .priv_class = &aformat_class,
168 };
AVFilterChannelLayouts
A list of supported channel layouts.
Definition: formats.h:85
opt.h
PARSE_FORMATS
#define PARSE_FORMATS(str, type, list, add_to_list, get_fmt, none, desc)
Definition: af_aformat.c:63
ff_all_channel_counts
AVFilterChannelLayouts * ff_all_channel_counts(void)
Construct an AVFilterChannelLayouts coding for any channel layout, with known or unknown disposition.
Definition: formats.c:525
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
AFormatContext::channel_layouts
AVFilterChannelLayouts * channel_layouts
Definition: af_aformat.c:41
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: af_aformat.c:114
av_get_channel_layout
uint64_t av_get_channel_layout(const char *name)
Return a channel layout id that matches name, or 0 if no match is found.
Definition: channel_layout.c:145
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
formats.h
AFormatContext::sample_rates_str
char * sample_rates_str
Definition: af_aformat.c:44
ff_all_formats
AVFilterFormats * ff_all_formats(enum AVMediaType type)
Return a list of all formats supported by FFmpeg for the given media type.
Definition: formats.c:439
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
OFFSET
#define OFFSET(x)
Definition: af_aformat.c:48
av_cold
#define av_cold
Definition: attributes.h:90
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
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
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
F
#define F
Definition: af_aformat.c:50
get_sample_rate
static int get_sample_rate(const char *samplerate)
Definition: af_aformat.c:93
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: af_aformat.c:123
ctx
AVFormatContext * ctx
Definition: movenc.c:48
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
AFormatContext::channel_layouts_str
char * channel_layouts_str
Definition: af_aformat.c:45
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(aformat)
init
static av_cold int init(AVFilterContext *ctx)
Definition: af_aformat.c:99
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
AFormatContext::sample_rates
AVFilterFormats * sample_rates
Definition: af_aformat.c:40
ff_channel_layouts_unref
void ff_channel_layouts_unref(AVFilterChannelLayouts **ref)
Remove a reference to a channel layouts list.
Definition: formats.c:597
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
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:59
AFormatContext
Definition: af_aformat.c:36
avfilter_af_aformat_inputs
static const AVFilterPad avfilter_af_aformat_inputs[]
Definition: af_aformat.c:144
internal.h
ff_formats_unref
void ff_formats_unref(AVFilterFormats **ref)
If *ref is non-NULL, remove *ref as a reference to the format list it currently points to,...
Definition: formats.c:592
av_get_sample_fmt
enum AVSampleFormat av_get_sample_fmt(const char *name)
Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE on error.
Definition: samplefmt.c:56
common.h
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
aformat_options
static const AVOption aformat_options[]
Definition: af_aformat.c:51
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
ff_af_aformat
const AVFilter ff_af_aformat
Definition: af_aformat.c:158
ff_all_samplerates
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:510
channel_layout.h
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
audio.h
avfilter_af_aformat_outputs
static const AVFilterPad avfilter_af_aformat_outputs[]
Definition: af_aformat.c:151
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
ff_set_common_samplerates
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:676
AFormatContext::formats_str
char * formats_str
Definition: af_aformat.c:43
avstring.h
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
AFormatContext::formats
AVFilterFormats * formats
Definition: af_aformat.c:39
A
#define A
Definition: af_aformat.c:49
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