Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavutil / opt.h
1 /*
2  * AVOptions
3  * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
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 #ifndef AVUTIL_OPT_H
23 #define AVUTIL_OPT_H
24
25 /**
26  * @file
27  * AVOptions
28  */
29
30 #include "rational.h"
31 #include "avutil.h"
32 #include "dict.h"
33
34 enum AVOptionType{
35     FF_OPT_TYPE_FLAGS,
36     FF_OPT_TYPE_INT,
37     FF_OPT_TYPE_INT64,
38     FF_OPT_TYPE_DOUBLE,
39     FF_OPT_TYPE_FLOAT,
40     FF_OPT_TYPE_STRING,
41     FF_OPT_TYPE_RATIONAL,
42     FF_OPT_TYPE_BINARY,  ///< offset must point to a pointer immediately followed by an int for the length
43     FF_OPT_TYPE_CONST=128,
44 };
45
46 /**
47  * AVOption
48  */
49 typedef struct AVOption {
50     const char *name;
51
52     /**
53      * short English help text
54      * @todo What about other languages?
55      */
56     const char *help;
57
58     /**
59      * The offset relative to the context structure where the option
60      * value is stored. It should be 0 for named constants.
61      */
62     int offset;
63     enum AVOptionType type;
64
65     /**
66      * the default value for scalar options
67      */
68     union {
69         double dbl;
70         const char *str;
71         /* TODO those are unused now */
72         int64_t i64;
73         AVRational q;
74     } default_val;
75     double min;                 ///< minimum valid value for the option
76     double max;                 ///< maximum valid value for the option
77
78     int flags;
79 #define AV_OPT_FLAG_ENCODING_PARAM  1   ///< a generic parameter which can be set by the user for muxing or encoding
80 #define AV_OPT_FLAG_DECODING_PARAM  2   ///< a generic parameter which can be set by the user for demuxing or decoding
81 #define AV_OPT_FLAG_METADATA        4   ///< some data extracted or inserted into the file like title, comment, ...
82 #define AV_OPT_FLAG_AUDIO_PARAM     8
83 #define AV_OPT_FLAG_VIDEO_PARAM     16
84 #define AV_OPT_FLAG_SUBTITLE_PARAM  32
85 //FIXME think about enc-audio, ... style flags
86
87     /**
88      * The logical unit to which the option belongs. Non-constant
89      * options and corresponding named constants share the same
90      * unit. May be NULL.
91      */
92     const char *unit;
93 } AVOption;
94
95 #if FF_API_FIND_OPT
96 /**
97  * Look for an option in obj. Look only for the options which
98  * have the flags set as specified in mask and flags (that is,
99  * for which it is the case that opt->flags & mask == flags).
100  *
101  * @param[in] obj a pointer to a struct whose first element is a
102  * pointer to an AVClass
103  * @param[in] name the name of the option to look for
104  * @param[in] unit the unit of the option to look for, or any if NULL
105  * @return a pointer to the option found, or NULL if no option
106  * has been found
107  *
108  * @deprecated use av_opt_find.
109  */
110 attribute_deprecated
111 const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);
112 #endif
113
114 /**
115  * Set the field of obj with the given name to value.
116  *
117  * @param[in] obj A struct whose first element is a pointer to an
118  * AVClass.
119  * @param[in] name the name of the field to set
120  * @param[in] val The value to set. If the field is not of a string
121  * type, then the given string is parsed.
122  * SI postfixes and some named scalars are supported.
123  * If the field is of a numeric type, it has to be a numeric or named
124  * scalar. Behavior with more than one scalar and +- infix operators
125  * is undefined.
126  * If the field is of a flags type, it has to be a sequence of numeric
127  * scalars or named flags separated by '+' or '-'. Prefixing a flag
128  * with '+' causes it to be set without affecting the other flags;
129  * similarly, '-' unsets a flag.
130  * @param[out] o_out if non-NULL put here a pointer to the AVOption
131  * found
132  * @param alloc when 1 then the old value will be av_freed() and the
133  *                     new av_strduped()
134  *              when 0 then no av_free() nor av_strdup() will be used
135  * @return 0 if the value has been set, or an AVERROR code in case of
136  * error:
137  * AVERROR(ENOENT) if no matching option exists
138  * AVERROR(ERANGE) if the value is out of range
139  * AVERROR(EINVAL) if the value is not valid
140  */
141 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out);
142
143 const AVOption *av_set_double(void *obj, const char *name, double n);
144 const AVOption *av_set_q(void *obj, const char *name, AVRational n);
145 const AVOption *av_set_int(void *obj, const char *name, int64_t n);
146 double av_get_double(void *obj, const char *name, const AVOption **o_out);
147 AVRational av_get_q(void *obj, const char *name, const AVOption **o_out);
148 int64_t av_get_int(void *obj, const char *name, const AVOption **o_out);
149 const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len);
150 const AVOption *av_next_option(void *obj, const AVOption *last);
151
152 /**
153  * Show the obj options.
154  *
155  * @param req_flags requested flags for the options to show. Show only the
156  * options for which it is opt->flags & req_flags.
157  * @param rej_flags rejected flags for the options to show. Show only the
158  * options for which it is !(opt->flags & req_flags).
159  * @param av_log_obj log context to use for showing the options
160  */
161 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags);
162
163 void av_opt_set_defaults(void *s);
164 void av_opt_set_defaults2(void *s, int mask, int flags);
165
166 /**
167  * Parse the key/value pairs list in opts. For each key/value pair
168  * found, stores the value in the field in ctx that is named like the
169  * key. ctx must be an AVClass context, storing is done using
170  * AVOptions.
171  *
172  * @param opts options string to parse, may be NULL
173  * @param key_val_sep a 0-terminated list of characters used to
174  * separate key from value
175  * @param pairs_sep a 0-terminated list of characters used to separate
176  * two pairs from each other
177  * @return the number of successfully set key/value pairs, or a negative
178  * value corresponding to an AVERROR code in case of error:
179  * AVERROR(EINVAL) if opts cannot be parsed,
180  * the error code issued by av_set_string3() if a key/value pair
181  * cannot be set
182  */
183 int av_set_options_string(void *ctx, const char *opts,
184                           const char *key_val_sep, const char *pairs_sep);
185
186 /**
187  * Free all string and binary options in obj.
188  */
189 void av_opt_free(void *obj);
190
191 /**
192  * Check whether a particular flag is set in a flags field.
193  *
194  * @param field_name the name of the flag field option
195  * @param flag_name the name of the flag to check
196  * @return non-zero if the flag is set, zero if the flag isn't set,
197  *         isn't of the right type, or the flags field doesn't exist.
198  */
199 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name);
200
201 /*
202  * Set all the options from a given dictionary on an object.
203  *
204  * @param obj a struct whose first element is a pointer to AVClass
205  * @param options options to process. This dictionary will be freed and replaced
206  *                by a new one containing all options not found in obj.
207  *                Of course this new dictionary needs to be freed by caller
208  *                with av_dict_free().
209  *
210  * @return 0 on success, a negative AVERROR if some option was found in obj,
211  *         but could not be set.
212  *
213  * @see av_dict_copy()
214  */
215 int av_opt_set_dict(void *obj, struct AVDictionary **options);
216
217 #define AV_OPT_SEARCH_CHILDREN   0x0001 /**< Search in possible children of the
218                                              given object first. */
219
220 /**
221  * Look for an option in an object. Consider only options which
222  * have all the specified flags set.
223  *
224  * @param[in] obj A pointer to a struct whose first element is a
225  *                pointer to an AVClass.
226  * @param[in] name The name of the option to look for.
227  * @param[in] unit When searching for named constants, name of the unit
228  *                 it belongs to.
229  * @param opt_flags Find only options with all the specified flags set (AV_OPT_FLAG).
230  * @param search_flags A combination of AV_OPT_SEARCH_*.
231  *
232  * @return A pointer to the option found, or NULL if no option
233  *         was found.
234  *
235  * @note Options found with AV_OPT_SEARCH_CHILDREN flag may not be settable
236  * directly with av_set_string3(). Use special calls which take an options
237  * AVDictionary (e.g. avformat_open_input()) to set options found with this
238  * flag.
239  */
240 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
241                             int opt_flags, int search_flags);
242
243 #endif /* AVUTIL_OPT_H */