make AVOptions default value field work.
[ffmpeg.git] / libavcodec / opt.h
1 /*
2  * AVOptions
3  * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 #ifndef AVOPT_H
21 #define AVOPT_H
22
23 /**
24  * @file opt.h
25  * AVOptions
26  */
27
28 enum AVOptionType{
29     FF_OPT_TYPE_FLAGS,
30     FF_OPT_TYPE_INT,
31     FF_OPT_TYPE_INT64,
32     FF_OPT_TYPE_DOUBLE,
33     FF_OPT_TYPE_FLOAT,
34     FF_OPT_TYPE_STRING,
35     FF_OPT_TYPE_RATIONAL,
36     FF_OPT_TYPE_CONST=128,
37 };
38
39 /**
40  * AVOption.
41  */
42 typedef struct AVOption {
43     const char *name;
44
45     /**
46      * short English text help.
47      * @fixme what about other languages
48      */
49     const char *help;
50     int offset;             ///< offset to context structure where the parsed value should be stored
51     enum AVOptionType type;
52
53     double default_val;
54     double min;
55     double max;
56
57     int flags;
58 #define AV_OPT_FLAG_ENCODING_PARAM  1   ///< a generic parameter which can be set by the user for muxing or encoding
59 #define AV_OPT_FLAG_DECODING_PARAM  2   ///< a generic parameter which can be set by the user for demuxing or decoding
60 #define AV_OPT_FLAG_METADATA        4   ///< some data extracted or inserted into the file like title, comment, ...
61 #define AV_OPT_FLAG_AUDIO_PARAM     8
62 #define AV_OPT_FLAG_VIDEO_PARAM     16
63 #define AV_OPT_FLAG_SUBTITLE_PARAM  32
64 //FIXME think about enc-audio, ... style flags
65     const char *unit;
66 } AVOption;
67
68
69 AVOption *av_set_string(void *obj, const char *name, const char *val);
70 AVOption *av_set_double(void *obj, const char *name, double n);
71 AVOption *av_set_q(void *obj, const char *name, AVRational n);
72 AVOption *av_set_int(void *obj, const char *name, int64_t n);
73 double av_get_double(void *obj, const char *name, AVOption **o_out);
74 AVRational av_get_q(void *obj, const char *name, AVOption **o_out);
75 int64_t av_get_int(void *obj, const char *name, AVOption **o_out);
76 const char *av_get_string(void *obj, const char *name, AVOption **o_out, char *buf, int buf_len);
77 AVOption *av_next_option(void *obj, AVOption *last);
78 int av_opt_show(void *obj, void *av_log_obj);
79 void av_opt_set_defaults(void *s);
80
81 #endif