mpegenc/mpegtsenc: add muxrate private options.
[ffmpeg.git] / libavformat / options.c
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 "libavutil/opt.h"
22
23 /**
24  * @file
25  * Options definition for AVFormatContext.
26  */
27
28 static const char* format_to_name(void* ptr)
29 {
30     AVFormatContext* fc = (AVFormatContext*) ptr;
31     if(fc->iformat) return fc->iformat->name;
32     else if(fc->oformat) return fc->oformat->name;
33     else return "NULL";
34 }
35
36 static void *format_child_next(void *obj, void *prev)
37 {
38     AVFormatContext *s = obj;
39     if (!prev && s->priv_data &&
40         ((s->iformat && s->iformat->priv_class) ||
41           s->oformat && s->oformat->priv_class))
42         return s->priv_data;
43     return NULL;
44 }
45
46 static const AVClass *format_child_class_next(const AVClass *prev)
47 {
48     AVInputFormat  *ifmt = NULL;
49     AVOutputFormat *ofmt = NULL;
50
51     while (prev && (ifmt = av_iformat_next(ifmt)))
52         if (ifmt->priv_class == prev)
53             break;
54     if ((prev && ifmt) || (!prev))
55         while (ifmt = av_iformat_next(ifmt))
56             if (ifmt->priv_class)
57                 return ifmt->priv_class;
58
59     while (prev && (ofmt = av_oformat_next(ofmt)))
60         if (ofmt->priv_class == prev)
61             break;
62     while (ofmt = av_oformat_next(ofmt))
63         if (ofmt->priv_class)
64             return ofmt->priv_class;
65
66     return NULL;
67 }
68
69 #define OFFSET(x) offsetof(AVFormatContext,x)
70 #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
71 //these names are too long to be readable
72 #define E AV_OPT_FLAG_ENCODING_PARAM
73 #define D AV_OPT_FLAG_DECODING_PARAM
74
75 static const AVOption options[]={
76 {"probesize", "set probing size", OFFSET(probesize), AV_OPT_TYPE_INT, {.dbl = 5000000 }, 32, INT_MAX, D},
77 #if FF_API_MUXRATE
78 {"muxrate", "set mux rate", OFFSET(mux_rate), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
79 #endif
80 {"packetsize", "set packet size", OFFSET(packet_size), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
81 {"fflags", NULL, OFFSET(flags), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, INT_MIN, INT_MAX, D|E, "fflags"},
82 {"ignidx", "ignore index", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNIDX }, INT_MIN, INT_MAX, D, "fflags"},
83 {"genpts", "generate pts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_GENPTS }, INT_MIN, INT_MAX, D, "fflags"},
84 {"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"},
85 {"noparse", "disable AVParsers, this needs nofillin too", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOPARSE }, INT_MIN, INT_MAX, D, "fflags"},
86 {"igndts", "ignore dts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNDTS }, INT_MIN, INT_MAX, D, "fflags"},
87 #if FF_API_FLAG_RTP_HINT
88 {"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"},
89 #endif
90 {"discardcorrupt", "discard corrupted frames", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_DISCARD_CORRUPT }, INT_MIN, INT_MAX, D, "fflags"},
91 {"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},
92 {"cryptokey", "decryption key", OFFSET(key), AV_OPT_TYPE_BINARY, {.dbl = 0}, 0, 0, D},
93 {"indexmem", "max memory used for timestamp index (per stream)", OFFSET(max_index_size), AV_OPT_TYPE_INT, {.dbl = 1<<20 }, 0, INT_MAX, D},
94 {"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 */
95 {"fdebug", "print specific debug info", OFFSET(debug), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, 0, INT_MAX, E|D, "fdebug"},
96 {"ts", NULL, 0, AV_OPT_TYPE_CONST, {.dbl = FF_FDEBUG_TS }, INT_MIN, INT_MAX, E|D, "fdebug"},
97 {"max_delay", "maximum muxing or demuxing delay in microseconds", OFFSET(max_delay), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E|D},
98 {"fer", "set error detection aggressivity", OFFSET(error_recognition), AV_OPT_TYPE_INT, {.dbl = FF_ER_CAREFUL }, INT_MIN, INT_MAX, D, "fer"},
99 {"careful", NULL, 0, AV_OPT_TYPE_CONST, {.dbl = FF_ER_CAREFUL }, INT_MIN, INT_MAX, D, "fer"},
100 {"explode", "abort decoding on error recognition", 0, AV_OPT_TYPE_CONST, {.dbl = FF_ER_EXPLODE }, INT_MIN, INT_MAX, D, "fer"},
101 {"fpsprobesize", "number of frames used to probe fps", OFFSET(fps_probe_size), AV_OPT_TYPE_INT, {.dbl = -1}, -1, INT_MAX-1, D},
102 {NULL},
103 };
104
105 #undef E
106 #undef D
107 #undef DEFAULT
108
109 static const AVClass av_format_context_class = {
110     .class_name     = "AVFormatContext",
111     .item_name      = format_to_name,
112     .option         = options,
113     .version        = LIBAVUTIL_VERSION_INT,
114     .child_next     = format_child_next,
115     .child_class_next = format_child_class_next,
116 };
117
118 static void avformat_get_context_defaults(AVFormatContext *s)
119 {
120     memset(s, 0, sizeof(AVFormatContext));
121
122     s->av_class = &av_format_context_class;
123
124     av_opt_set_defaults(s);
125 }
126
127 AVFormatContext *avformat_alloc_context(void)
128 {
129     AVFormatContext *ic;
130     ic = av_malloc(sizeof(AVFormatContext));
131     if (!ic) return ic;
132     avformat_get_context_defaults(ic);
133     return ic;
134 }
135
136 const AVClass *avformat_get_class(void)
137 {
138     return &av_format_context_class;
139 }