Define AVMediaType enum, and use it instead of enum CodecType, which
[ffmpeg.git] / cmdutils.h
1 /*
2  * Various utilities for command line tools
3  * copyright (c) 2003 Fabrice Bellard
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 FFMPEG_CMDUTILS_H
23 #define FFMPEG_CMDUTILS_H
24
25 #include <inttypes.h>
26 #include "libavcodec/avcodec.h"
27 #include "libavformat/avformat.h"
28 #include "libswscale/swscale.h"
29
30 /**
31  * program name, defined by the program for show_version().
32  */
33 extern const char program_name[];
34
35 /**
36  * program birth year, defined by the program for show_banner()
37  */
38 extern const int program_birth_year;
39
40 extern const int this_year;
41
42 extern const char **opt_names;
43 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
44 extern AVFormatContext *avformat_opts;
45 extern struct SwsContext *sws_opts;
46
47 /**
48  * Fallback for options that are not explicitly handled, these will be
49  * parsed through AVOptions.
50  */
51 int opt_default(const char *opt, const char *arg);
52
53 /**
54  * Sets the libav* libraries log level.
55  */
56 int opt_loglevel(const char *opt, const char *arg);
57
58 /**
59  * Limit the execution time.
60  */
61 int opt_timelimit(const char *opt, const char *arg);
62
63 /**
64  * Parses a string and returns its corresponding value as a double.
65  * Exits from the application if the string cannot be correctly
66  * parsed or the corresponding value is invalid.
67  *
68  * @param context the context of the value to be set (e.g. the
69  * corresponding commandline option name)
70  * @param numstr the string to be parsed
71  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
72  * string should be parsed
73  * @param min the minimum valid accepted value
74  * @param max the maximum valid accepted value
75  */
76 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
77
78 /**
79  * Parses a string specifying a time and returns its corresponding
80  * value as a number of microseconds. Exits from the application if
81  * the string cannot be correctly parsed.
82  *
83  * @param context the context of the value to be set (e.g. the
84  * corresponding commandline option name)
85  * @param timestr the string to be parsed
86  * @param is_duration a flag which tells how to interpret timestr, if
87  * not zero timestr is interpreted as a duration, otherwise as a
88  * date
89  *
90  * @see parse_date()
91  */
92 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
93
94 typedef struct {
95     const char *name;
96     int flags;
97 #define HAS_ARG    0x0001
98 #define OPT_BOOL   0x0002
99 #define OPT_EXPERT 0x0004
100 #define OPT_STRING 0x0008
101 #define OPT_VIDEO  0x0010
102 #define OPT_AUDIO  0x0020
103 #define OPT_GRAB   0x0040
104 #define OPT_INT    0x0080
105 #define OPT_FLOAT  0x0100
106 #define OPT_SUBTITLE 0x0200
107 #define OPT_FUNC2  0x0400
108 #define OPT_INT64  0x0800
109 #define OPT_EXIT   0x1000
110      union {
111         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
112         int *int_arg;
113         char **str_arg;
114         float *float_arg;
115         int (*func2_arg)(const char *, const char *);
116         int64_t *int64_arg;
117     } u;
118     const char *help;
119     const char *argname;
120 } OptionDef;
121
122 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
123
124 /**
125  * Parses the command line arguments.
126  * @param options Array with the definitions required to interpret every
127  * option of the form: -<option_name> [<argument>]
128  * @param parse_arg_function Name of the function called to process every
129  * argument without a leading option name flag. NULL if such arguments do
130  * not have to be processed.
131  */
132 void parse_options(int argc, char **argv, const OptionDef *options,
133                    void (* parse_arg_function)(const char*));
134
135 void set_context_opts(void *ctx, void *opts_ctx, int flags);
136
137 void print_error(const char *filename, int err);
138
139 void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
140
141 /**
142  * Prints the program banner to stderr. The banner contents depend on the
143  * current version of the repository and of the libav* libraries used by
144  * the program.
145  */
146 void show_banner(void);
147
148 /**
149  * Prints the version of the program to stdout. The version message
150  * depends on the current versions of the repository and of the libav*
151  * libraries.
152  */
153 void show_version(void);
154
155 /**
156  * Prints the license of the program to stdout. The license depends on
157  * the license of the libraries compiled into the program.
158  */
159 void show_license(void);
160
161 /**
162  * Prints a listing containing all the formats supported by the
163  * program.
164  */
165 void show_formats(void);
166
167 /**
168  * Prints a listing containing all the codecs supported by the
169  * program.
170  */
171 void show_codecs(void);
172
173 /**
174  * Prints a listing containing all the filters supported by the
175  * program.
176  */
177 void show_filters(void);
178
179 /**
180  * Prints a listing containing all the bit stream filters supported by the
181  * program.
182  */
183 void show_bsfs(void);
184
185 /**
186  * Prints a listing containing all the protocols supported by the
187  * program.
188  */
189 void show_protocols(void);
190
191 /**
192  * Prints a listing containing all the pixel formats supported by the
193  * program.
194  */
195 void show_pix_fmts(void);
196
197 /**
198  * Returns a positive value if reads from standard input a line
199  * starting with [yY], otherwise returns 0.
200  */
201 int read_yesno(void);
202
203 #endif /* FFMPEG_CMDUTILS_H */