AVOptions: add av_opt_get*, deprecate av_get*.
[ffmpeg.git] / libavutil / opt.h
1 /*
2  * AVOptions
3  * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 #include "log.h"
34
35 enum AVOptionType{
36     FF_OPT_TYPE_FLAGS,
37     FF_OPT_TYPE_INT,
38     FF_OPT_TYPE_INT64,
39     FF_OPT_TYPE_DOUBLE,
40     FF_OPT_TYPE_FLOAT,
41     FF_OPT_TYPE_STRING,
42     FF_OPT_TYPE_RATIONAL,
43     FF_OPT_TYPE_BINARY,  ///< offset must point to a pointer immediately followed by an int for the length
44     FF_OPT_TYPE_CONST=128,
45 };
46
47 /**
48  * AVOption
49  */
50 typedef struct AVOption {
51     const char *name;
52
53     /**
54      * short English help text
55      * @todo What about other languages?
56      */
57     const char *help;
58
59     /**
60      * The offset relative to the context structure where the option
61      * value is stored. It should be 0 for named constants.
62      */
63     int offset;
64     enum AVOptionType type;
65
66     /**
67      * the default value for scalar options
68      */
69     union {
70         double dbl;
71         const char *str;
72         /* TODO those are unused now */
73         int64_t i64;
74         AVRational q;
75     } default_val;
76     double min;                 ///< minimum valid value for the option
77     double max;                 ///< maximum valid value for the option
78
79     int flags;
80 #define AV_OPT_FLAG_ENCODING_PARAM  1   ///< a generic parameter which can be set by the user for muxing or encoding
81 #define AV_OPT_FLAG_DECODING_PARAM  2   ///< a generic parameter which can be set by the user for demuxing or decoding
82 #define AV_OPT_FLAG_METADATA        4   ///< some data extracted or inserted into the file like title, comment, ...
83 #define AV_OPT_FLAG_AUDIO_PARAM     8
84 #define AV_OPT_FLAG_VIDEO_PARAM     16
85 #define AV_OPT_FLAG_SUBTITLE_PARAM  32
86 //FIXME think about enc-audio, ... style flags
87
88     /**
89      * The logical unit to which the option belongs. Non-constant
90      * options and corresponding named constants share the same
91      * unit. May be NULL.
92      */
93     const char *unit;
94 } AVOption;
95
96 #if FF_API_FIND_OPT
97 /**
98  * Look for an option in obj. Look only for the options which
99  * have the flags set as specified in mask and flags (that is,
100  * for which it is the case that opt->flags & mask == flags).
101  *
102  * @param[in] obj a pointer to a struct whose first element is a
103  * pointer to an AVClass
104  * @param[in] name the name of the option to look for
105  * @param[in] unit the unit of the option to look for, or any if NULL
106  * @return a pointer to the option found, or NULL if no option
107  * has been found
108  *
109  * @deprecated use av_opt_find.
110  */
111 attribute_deprecated
112 const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);
113 #endif
114
115 #if FF_API_OLD_AVOPTIONS
116 /**
117  * Set the field of obj with the given name to value.
118  *
119  * @param[in] obj A struct whose first element is a pointer to an
120  * AVClass.
121  * @param[in] name the name of the field to set
122  * @param[in] val The value to set. If the field is not of a string
123  * type, then the given string is parsed.
124  * SI postfixes and some named scalars are supported.
125  * If the field is of a numeric type, it has to be a numeric or named
126  * scalar. Behavior with more than one scalar and +- infix operators
127  * is undefined.
128  * If the field is of a flags type, it has to be a sequence of numeric
129  * scalars or named flags separated by '+' or '-'. Prefixing a flag
130  * with '+' causes it to be set without affecting the other flags;
131  * similarly, '-' unsets a flag.
132  * @param[out] o_out if non-NULL put here a pointer to the AVOption
133  * found
134  * @param alloc this parameter is currently ignored
135  * @return 0 if the value has been set, or an AVERROR code in case of
136  * error:
137  * AVERROR_OPTION_NOT_FOUND 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  * @deprecated use av_opt_set()
141  */
142 attribute_deprecated
143 int av_set_string3(void *obj, const char *name, const char *val, int alloc, const AVOption **o_out);
144
145 attribute_deprecated const AVOption *av_set_double(void *obj, const char *name, double n);
146 attribute_deprecated const AVOption *av_set_q(void *obj, const char *name, AVRational n);
147 attribute_deprecated const AVOption *av_set_int(void *obj, const char *name, int64_t n);
148
149 attribute_deprecated double av_get_double(void *obj, const char *name, const AVOption **o_out);
150 attribute_deprecated AVRational av_get_q(void *obj, const char *name, const AVOption **o_out);
151 attribute_deprecated int64_t av_get_int(void *obj, const char *name, const AVOption **o_out);
152 attribute_deprecated const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len);
153 #endif
154 const AVOption *av_next_option(void *obj, const AVOption *last);
155
156 /**
157  * Show the obj options.
158  *
159  * @param req_flags requested flags for the options to show. Show only the
160  * options for which it is opt->flags & req_flags.
161  * @param rej_flags rejected flags for the options to show. Show only the
162  * options for which it is !(opt->flags & req_flags).
163  * @param av_log_obj log context to use for showing the options
164  */
165 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags);
166
167 /**
168  * Set the values of all AVOption fields to their default values.
169  *
170  * @param s an AVOption-enabled struct (its first member must be a pointer to AVClass)
171  */
172 void av_opt_set_defaults(void *s);
173
174 #if FF_API_OLD_AVOPTIONS
175 attribute_deprecated
176 void av_opt_set_defaults2(void *s, int mask, int flags);
177 #endif
178
179 /**
180  * Parse the key/value pairs list in opts. For each key/value pair
181  * found, stores the value in the field in ctx that is named like the
182  * key. ctx must be an AVClass context, storing is done using
183  * AVOptions.
184  *
185  * @param key_val_sep a 0-terminated list of characters used to
186  * separate key from value
187  * @param pairs_sep a 0-terminated list of characters used to separate
188  * two pairs from each other
189  * @return the number of successfully set key/value pairs, or a negative
190  * value corresponding to an AVERROR code in case of error:
191  * AVERROR(EINVAL) if opts cannot be parsed,
192  * the error code issued by av_set_string3() if a key/value pair
193  * cannot be set
194  */
195 int av_set_options_string(void *ctx, const char *opts,
196                           const char *key_val_sep, const char *pairs_sep);
197
198 /**
199  * Free all string and binary options in obj.
200  */
201 void av_opt_free(void *obj);
202
203 /**
204  * Check whether a particular flag is set in a flags field.
205  *
206  * @param field_name the name of the flag field option
207  * @param flag_name the name of the flag to check
208  * @return non-zero if the flag is set, zero if the flag isn't set,
209  *         isn't of the right type, or the flags field doesn't exist.
210  */
211 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name);
212
213 /*
214  * Set all the options from a given dictionary on an object.
215  *
216  * @param obj a struct whose first element is a pointer to AVClass
217  * @param options options to process. This dictionary will be freed and replaced
218  *                by a new one containing all options not found in obj.
219  *                Of course this new dictionary needs to be freed by caller
220  *                with av_dict_free().
221  *
222  * @return 0 on success, a negative AVERROR if some option was found in obj,
223  *         but could not be set.
224  *
225  * @see av_dict_copy()
226  */
227 int av_opt_set_dict(void *obj, struct AVDictionary **options);
228
229 #define AV_OPT_SEARCH_CHILDREN   0x0001 /**< Search in possible children of the
230                                              given object first. */
231 /**
232  *  The obj passed to av_opt_find() is fake -- only a double pointer to AVClass
233  *  instead of a required pointer to a struct containing AVClass. This is
234  *  useful for searching for options without needing to allocate the corresponding
235  *  object.
236  */
237 #define AV_OPT_SEARCH_FAKE_OBJ   0x0002
238
239 /**
240  * Look for an option in an object. Consider only options which
241  * have all the specified flags set.
242  *
243  * @param[in] obj A pointer to a struct whose first element is a
244  *                pointer to an AVClass.
245  *                Alternatively a double pointer to an AVClass, if
246  *                AV_OPT_SEARCH_FAKE_OBJ search flag is set.
247  * @param[in] name The name of the option to look for.
248  * @param[in] unit When searching for named constants, name of the unit
249  *                 it belongs to.
250  * @param opt_flags Find only options with all the specified flags set (AV_OPT_FLAG).
251  * @param search_flags A combination of AV_OPT_SEARCH_*.
252  *
253  * @return A pointer to the option found, or NULL if no option
254  *         was found.
255  *
256  * @note Options found with AV_OPT_SEARCH_CHILDREN flag may not be settable
257  * directly with av_set_string3(). Use special calls which take an options
258  * AVDictionary (e.g. avformat_open_input()) to set options found with this
259  * flag.
260  */
261 const AVOption *av_opt_find(void *obj, const char *name, const char *unit,
262                             int opt_flags, int search_flags);
263
264 /**
265  * Look for an option in an object. Consider only options which
266  * have all the specified flags set.
267  *
268  * @param[in] obj A pointer to a struct whose first element is a
269  *                pointer to an AVClass.
270  *                Alternatively a double pointer to an AVClass, if
271  *                AV_OPT_SEARCH_FAKE_OBJ search flag is set.
272  * @param[in] name The name of the option to look for.
273  * @param[in] unit When searching for named constants, name of the unit
274  *                 it belongs to.
275  * @param opt_flags Find only options with all the specified flags set (AV_OPT_FLAG).
276  * @param search_flags A combination of AV_OPT_SEARCH_*.
277  * @param[out] target_obj if non-NULL, an object to which the option belongs will be
278  * written here. It may be different from obj if AV_OPT_SEARCH_CHILDREN is present
279  * in search_flags. This parameter is ignored if search_flags contain
280  * AV_OPT_SEARCH_FAKE_OBJ.
281  *
282  * @return A pointer to the option found, or NULL if no option
283  *         was found.
284  */
285 const AVOption *av_opt_find2(void *obj, const char *name, const char *unit,
286                              int opt_flags, int search_flags, void **target_obj);
287
288 /**
289  * Iterate over AVOptions-enabled children of obj.
290  *
291  * @param prev result of a previous call to this function or NULL
292  * @return next AVOptions-enabled child or NULL
293  */
294 void *av_opt_child_next(void *obj, void *prev);
295
296 /**
297  * Iterate over potential AVOptions-enabled children of parent.
298  *
299  * @param prev result of a previous call to this function or NULL
300  * @return AVClass corresponding to next potential child or NULL
301  */
302 const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev);
303
304 /**
305  * @defgroup opt_set_funcs Option setting functions
306  * @{
307  * Those functions set the field of obj with the given name to value.
308  *
309  * @param[in] obj A struct whose first element is a pointer to an AVClass.
310  * @param[in] name the name of the field to set
311  * @param[in] val The value to set. In case of av_opt_set() if the field is not
312  * of a string type, then the given string is parsed.
313  * SI postfixes and some named scalars are supported.
314  * If the field is of a numeric type, it has to be a numeric or named
315  * scalar. Behavior with more than one scalar and +- infix operators
316  * is undefined.
317  * If the field is of a flags type, it has to be a sequence of numeric
318  * scalars or named flags separated by '+' or '-'. Prefixing a flag
319  * with '+' causes it to be set without affecting the other flags;
320  * similarly, '-' unsets a flag.
321  * @param search_flags flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN
322  * is passed here, then the option may be set on a child of obj.
323  *
324  * @return 0 if the value has been set, or an AVERROR code in case of
325  * error:
326  * AVERROR_OPTION_NOT_FOUND if no matching option exists
327  * AVERROR(ERANGE) if the value is out of range
328  * AVERROR(EINVAL) if the value is not valid
329  */
330 int av_opt_set       (void *obj, const char *name, const char *val, int search_flags);
331 int av_opt_set_int   (void *obj, const char *name, int64_t     val, int search_flags);
332 int av_opt_set_double(void *obj, const char *name, double      val, int search_flags);
333 int av_opt_set_q     (void *obj, const char *name, AVRational  val, int search_flags);
334 /**
335  * @}
336  */
337
338 /**
339  * @defgroup opt_get_funcs Option getting functions
340  * @{
341  * Those functions get a value of the option with the given name from an object.
342  *
343  * @param[in] obj a struct whose first element is a pointer to an AVClass.
344  * @param[in] name name of the option to get.
345  * @param[in] search_flags flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN
346  * is passed here, then the option may be found in a child of obj.
347  * @param[out] out_val value of the option will be written here
348  * @return 0 on success, a negative error code otherwise
349  */
350 /**
351  * @note the returned string will av_malloc()ed and must be av_free()ed by the caller
352  */
353 int av_opt_get       (void *obj, const char *name, int search_flags, uint8_t   **out_val);
354 int av_opt_get_int   (void *obj, const char *name, int search_flags, int64_t    *out_val);
355 int av_opt_get_double(void *obj, const char *name, int search_flags, double     *out_val);
356 int av_opt_get_q     (void *obj, const char *name, int search_flags, AVRational *out_val);
357 /**
358  * @}
359  */
360
361 #endif /* AVUTIL_OPT_H */