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