options.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 #include "avformat.h"
21 #include "avio_internal.h"
22 #include "libavutil/opt.h"
23 
29 static const char* format_to_name(void* ptr)
30 {
31  AVFormatContext* fc = (AVFormatContext*) ptr;
32  if(fc->iformat) return fc->iformat->name;
33  else if(fc->oformat) return fc->oformat->name;
34  else return "NULL";
35 }
36 
37 static void *format_child_next(void *obj, void *prev)
38 {
39  AVFormatContext *s = obj;
40  if (!prev && s->priv_data &&
41  ((s->iformat && s->iformat->priv_class) ||
42  s->oformat && s->oformat->priv_class))
43  return s->priv_data;
44 #if !FF_API_OLD_AVIO
45  if (s->pb && s->pb->av_class && prev != s->pb)
46  return s->pb;
47 #endif
48  return NULL;
49 }
50 
51 static const AVClass *format_child_class_next(const AVClass *prev)
52 {
53  AVInputFormat *ifmt = NULL;
54  AVOutputFormat *ofmt = NULL;
55 
56  if (!prev)
57 #if !FF_API_OLD_AVIO
58  return &ffio_url_class;
59 #else
60  prev = (void *)&ifmt; // Dummy pointer;
61 #endif
62 
63  while ((ifmt = av_iformat_next(ifmt)))
64  if (ifmt->priv_class == prev)
65  break;
66 
67  if (!ifmt)
68  while ((ofmt = av_oformat_next(ofmt)))
69  if (ofmt->priv_class == prev)
70  break;
71  if (!ofmt)
72  while (ifmt = av_iformat_next(ifmt))
73  if (ifmt->priv_class)
74  return ifmt->priv_class;
75 
76  while (ofmt = av_oformat_next(ofmt))
77  if (ofmt->priv_class)
78  return ofmt->priv_class;
79 
80  return NULL;
81 }
82 
83 #define OFFSET(x) offsetof(AVFormatContext,x)
84 #define DEFAULT 0 //should be NAN but it does not work as it is not a constant in glibc as required by ANSI/ISO C
85 //these names are too long to be readable
86 #define E AV_OPT_FLAG_ENCODING_PARAM
87 #define D AV_OPT_FLAG_DECODING_PARAM
88 
89 static const AVOption options[]={
90 {"probesize", "set probing size", OFFSET(probesize), AV_OPT_TYPE_INT, {.dbl = 5000000 }, 32, INT_MAX, D},
91 #if FF_API_MUXRATE
92 {"muxrate", "set mux rate", OFFSET(mux_rate), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
93 #endif
94 {"packetsize", "set packet size", OFFSET(packet_size), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
95 {"fflags", NULL, OFFSET(flags), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, INT_MIN, INT_MAX, D|E, "fflags"},
96 {"ignidx", "ignore index", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNIDX }, INT_MIN, INT_MAX, D, "fflags"},
97 {"genpts", "generate pts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_GENPTS }, INT_MIN, INT_MAX, D, "fflags"},
98 {"nofillin", "do not fill in missing values that can be exactly calculated", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOFILLIN }, INT_MIN, INT_MAX, D, "fflags"},
99 {"noparse", "disable AVParsers, this needs nofillin too", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOPARSE }, INT_MIN, INT_MAX, D, "fflags"},
100 {"igndts", "ignore dts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNDTS }, INT_MIN, INT_MAX, D, "fflags"},
101 #if FF_API_FLAG_RTP_HINT
102 {"rtphint", "add rtp hinting (deprecated, use the -movflags rtphint option instead)", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_RTP_HINT }, INT_MIN, INT_MAX, E, "fflags"},
103 #endif
104 {"discardcorrupt", "discard corrupted frames", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_DISCARD_CORRUPT }, INT_MIN, INT_MAX, D, "fflags"},
105 {"analyzeduration", "how many microseconds are analyzed to estimate duration", OFFSET(max_analyze_duration), AV_OPT_TYPE_INT, {.dbl = 5*AV_TIME_BASE }, 0, INT_MAX, D},
106 {"cryptokey", "decryption key", OFFSET(key), AV_OPT_TYPE_BINARY, {.dbl = 0}, 0, 0, D},
107 {"indexmem", "max memory used for timestamp index (per stream)", OFFSET(max_index_size), AV_OPT_TYPE_INT, {.dbl = 1<<20 }, 0, INT_MAX, D},
108 {"rtbufsize", "max memory used for buffering real-time frames", OFFSET(max_picture_buffer), AV_OPT_TYPE_INT, {.dbl = 3041280 }, 0, INT_MAX, D}, /* defaults to 1s of 15fps 352x288 YUYV422 video */
109 {"fdebug", "print specific debug info", OFFSET(debug), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, 0, INT_MAX, E|D, "fdebug"},
110 {"ts", NULL, 0, AV_OPT_TYPE_CONST, {.dbl = FF_FDEBUG_TS }, INT_MIN, INT_MAX, E|D, "fdebug"},
111 {"max_delay", "maximum muxing or demuxing delay in microseconds", OFFSET(max_delay), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E|D},
112 {"fpsprobesize", "number of frames used to probe fps", OFFSET(fps_probe_size), AV_OPT_TYPE_INT, {.dbl = -1}, -1, INT_MAX-1, D},
113 /* this is a crutch for avconv, since it cannot deal with identically named options in different contexts.
114  * to be removed when avconv is fixed */
115 {"f_err_detect", "set error detection flags (deprecated; use err_detect, save via avconv)", OFFSET(error_recognition), AV_OPT_TYPE_FLAGS, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
116 {"err_detect", "set error detection flags", OFFSET(error_recognition), AV_OPT_TYPE_FLAGS, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
117 {"crccheck", "verify embedded CRCs", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
118 {"bitstream", "detect bitstream specification deviations", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_BITSTREAM }, INT_MIN, INT_MAX, D, "err_detect"},
119 {"buffer", "detect improper bitstream length", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_BUFFER }, INT_MIN, INT_MAX, D, "err_detect"},
120 {"explode", "abort decoding on minor error detection", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_EXPLODE }, INT_MIN, INT_MAX, D, "err_detect"},
121 {NULL},
122 };
123 
124 #undef E
125 #undef D
126 #undef DEFAULT
127 
129  .class_name = "AVFormatContext",
130  .item_name = format_to_name,
131  .option = options,
132  .version = LIBAVUTIL_VERSION_INT,
133  .child_next = format_child_next,
134  .child_class_next = format_child_class_next,
135 };
136 
138 {
139  memset(s, 0, sizeof(AVFormatContext));
140 
142 
144 }
145 
147 {
148  AVFormatContext *ic;
149  ic = av_malloc(sizeof(AVFormatContext));
150  if (!ic) return ic;
152  return ic;
153 }
154 
156 {
157  return &av_format_context_class;
158 }
static const AVClass av_format_context_class
Definition: options.c:128
AVOption.
Definition: opt.h:244
void av_opt_set_defaults(void *s)
Set the values of all AVOption fields to their default values.
Definition: opt.c:598
AVOptions.
#define AV_EF_BUFFER
Definition: avcodec.h:3158
#define AV_EF_BITSTREAM
Definition: avcodec.h:3157
Format I/O context.
Definition: avformat.h:863
#define AVFMT_FLAG_NOPARSE
Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no...
Definition: avformat.h:996
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:38
#define AVFMT_FLAG_IGNIDX
Ignore index.
Definition: avformat.h:992
#define AVFMT_FLAG_DISCARD_CORRUPT
Discard frames marked corrupted.
Definition: avformat.h:1001
#define AVFMT_FLAG_GENPTS
Generate missing pts even if it requires parsing future frames.
Definition: avformat.h:991
static void avformat_get_context_defaults(AVFormatContext *s)
Definition: options.c:137
AVFormatContext * avformat_alloc_context(void)
Allocate an AVFormatContext.
Definition: options.c:146
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:570
static int flags
Definition: log.c:34
const AVClass * avformat_get_class(void)
Get the AVClass for AVFormatContext.
Definition: options.c:155
struct AVOutputFormat * oformat
Definition: avformat.h:877
#define OFFSET(x)
Definition: options.c:83
static int debug
Definition: avplay.c:242
#define AVFMT_FLAG_IGNDTS
Ignore DTS on frames that contain both DTS & PTS.
Definition: avformat.h:994
static const AVClass * format_child_class_next(const AVClass *prev)
Definition: options.c:51
#define E
Definition: options.c:86
#define AV_TIME_BASE
Internal time base represented as integer.
Definition: avutil.h:277
const char * name
Definition: avformat.h:390
static const AVOption options[]
Definition: options.c:89
#define AV_EF_EXPLODE
Definition: avcodec.h:3159
const AVClass * priv_class
AVClass for the private context.
Definition: avformat.h:434
LIBAVUTIL_VERSION_INT
Definition: eval.c:50
offset must point to a pointer immediately followed by an int for the length
Definition: opt.h:226
AVOutputFormat * av_oformat_next(AVOutputFormat *f)
If f is NULL, returns the first registered output format, if f is non-NULL, returns the next register...
Definition: utils.c:133
const AVClass ffio_url_class
Definition: aviobuf.c:59
NULL
Definition: eval.c:50
#define FF_FDEBUG_TS
Definition: avformat.h:1070
#define D
Definition: options.c:87
AVIOContext * pb
Definition: avformat.h:896
static int error_recognition
Definition: avplay.c:253
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:64
Describe the class of an AVClass context structure.
Definition: log.h:33
static void * format_child_next(void *obj, void *prev)
Definition: options.c:37
const AVClass * av_class
A class for logging and AVOptions.
Definition: avformat.h:868
#define AV_EF_CRCCHECK
Definition: avcodec.h:3156
Main libavformat public API header.
struct AVInputFormat * iformat
Can only be iformat or oformat, not both at the same time.
Definition: avformat.h:876
AVInputFormat * av_iformat_next(AVInputFormat *f)
If f is NULL, returns the first registered input format, if f is non-NULL, returns the next registere...
Definition: utils.c:127
void * priv_data
Format private data.
Definition: avformat.h:883
AVClass * av_class
A class for private options.
Definition: avio.h:82
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:460
#define DEFAULT
Definition: options.c:84
#define AVFMT_FLAG_NOFILLIN
Do not infer any values from other values, just return what is stored in the container.
Definition: avformat.h:995
static const char * format_to_name(void *ptr)
Definition: options.c:29