1 | /*
|
---|
2 | * AVOptions
|
---|
3 | * copyright (c) 2005 Michael Niedermayer <[email protected]>
|
---|
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 AVOPT_H
|
---|
23 | #define AVOPT_H
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * @file opt.h
|
---|
27 | * AVOptions
|
---|
28 | */
|
---|
29 |
|
---|
30 | #include "rational.h"
|
---|
31 |
|
---|
32 | enum AVOptionType{
|
---|
33 | FF_OPT_TYPE_FLAGS,
|
---|
34 | FF_OPT_TYPE_INT,
|
---|
35 | FF_OPT_TYPE_INT64,
|
---|
36 | FF_OPT_TYPE_DOUBLE,
|
---|
37 | FF_OPT_TYPE_FLOAT,
|
---|
38 | FF_OPT_TYPE_STRING,
|
---|
39 | FF_OPT_TYPE_RATIONAL,
|
---|
40 | FF_OPT_TYPE_CONST=128,
|
---|
41 | };
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * AVOption.
|
---|
45 | */
|
---|
46 | typedef struct AVOption {
|
---|
47 | const char *name;
|
---|
48 |
|
---|
49 | /**
|
---|
50 | * short English text help.
|
---|
51 | * @todo what about other languages
|
---|
52 | */
|
---|
53 | const char *help;
|
---|
54 | int offset; ///< offset to context structure where the parsed value should be stored
|
---|
55 | enum AVOptionType type;
|
---|
56 |
|
---|
57 | double default_val;
|
---|
58 | double min;
|
---|
59 | double max;
|
---|
60 |
|
---|
61 | int flags;
|
---|
62 | #define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding
|
---|
63 | #define AV_OPT_FLAG_DECODING_PARAM 2 ///< a generic parameter which can be set by the user for demuxing or decoding
|
---|
64 | #define AV_OPT_FLAG_METADATA 4 ///< some data extracted or inserted into the file like title, comment, ...
|
---|
65 | #define AV_OPT_FLAG_AUDIO_PARAM 8
|
---|
66 | #define AV_OPT_FLAG_VIDEO_PARAM 16
|
---|
67 | #define AV_OPT_FLAG_SUBTITLE_PARAM 32
|
---|
68 | //FIXME think about enc-audio, ... style flags
|
---|
69 | const char *unit;
|
---|
70 | } AVOption;
|
---|
71 |
|
---|
72 |
|
---|
73 | const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);
|
---|
74 | const AVOption *av_set_string(void *obj, const char *name, const char *val);
|
---|
75 | const AVOption *av_set_double(void *obj, const char *name, double n);
|
---|
76 | const AVOption *av_set_q(void *obj, const char *name, AVRational n);
|
---|
77 | const AVOption *av_set_int(void *obj, const char *name, int64_t n);
|
---|
78 | double av_get_double(void *obj, const char *name, const AVOption **o_out);
|
---|
79 | AVRational av_get_q(void *obj, const char *name, const AVOption **o_out);
|
---|
80 | int64_t av_get_int(void *obj, const char *name, const AVOption **o_out);
|
---|
81 | const char *av_get_string(void *obj, const char *name, const AVOption **o_out, char *buf, int buf_len);
|
---|
82 | const AVOption *av_next_option(void *obj, const AVOption *last);
|
---|
83 | int av_opt_show(void *obj, void *av_log_obj);
|
---|
84 | void av_opt_set_defaults(void *s);
|
---|
85 | void av_opt_set_defaults2(void *s, int mask, int flags);
|
---|
86 |
|
---|
87 | #endif
|
---|