68a29b40335e18a6a9bdc893fcf2ddcc206f0716
[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  * Trivial log callback.
49  * Only suitable for show_help and similar since it lacks prefix handling.
50  */
51 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
52
53 /**
54  * Fallback for options that are not explicitly handled, these will be
55  * parsed through AVOptions.
56  */
57 int opt_default(const char *opt, const char *arg);
58
59 /**
60  * Set the libav* libraries log level.
61  */
62 int opt_loglevel(const char *opt, const char *arg);
63
64 /**
65  * Limit the execution time.
66  */
67 int opt_timelimit(const char *opt, const char *arg);
68
69 /**
70  * Parse a string and return its corresponding value as a double.
71  * Exit from the application if the string cannot be correctly
72  * parsed or the corresponding value is invalid.
73  *
74  * @param context the context of the value to be set (e.g. the
75  * corresponding commandline option name)
76  * @param numstr the string to be parsed
77  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
78  * string should be parsed
79  * @param min the minimum valid accepted value
80  * @param max the maximum valid accepted value
81  */
82 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
83
84 /**
85  * Parse a string specifying a time and return its corresponding
86  * value as a number of microseconds. Exit from the application if
87  * the string cannot be correctly parsed.
88  *
89  * @param context the context of the value to be set (e.g. the
90  * corresponding commandline option name)
91  * @param timestr the string to be parsed
92  * @param is_duration a flag which tells how to interpret timestr, if
93  * not zero timestr is interpreted as a duration, otherwise as a
94  * date
95  *
96  * @see parse_date()
97  */
98 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
99
100 typedef struct {
101     const char *name;
102     int flags;
103 #define HAS_ARG    0x0001
104 #define OPT_BOOL   0x0002
105 #define OPT_EXPERT 0x0004
106 #define OPT_STRING 0x0008
107 #define OPT_VIDEO  0x0010
108 #define OPT_AUDIO  0x0020
109 #define OPT_GRAB   0x0040
110 #define OPT_INT    0x0080
111 #define OPT_FLOAT  0x0100
112 #define OPT_SUBTITLE 0x0200
113 #define OPT_FUNC2  0x0400
114 #define OPT_INT64  0x0800
115 #define OPT_EXIT   0x1000
116      union {
117         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
118         int *int_arg;
119         char **str_arg;
120         float *float_arg;
121         int (*func2_arg)(const char *, const char *);
122         int64_t *int64_arg;
123     } u;
124     const char *help;
125     const char *argname;
126 } OptionDef;
127
128 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
129
130 /**
131  * Parse the command line arguments.
132  * @param options Array with the definitions required to interpret every
133  * option of the form: -option_name [argument]
134  * @param parse_arg_function Name of the function called to process every
135  * argument without a leading option name flag. NULL if such arguments do
136  * not have to be processed.
137  */
138 void parse_options(int argc, char **argv, const OptionDef *options,
139                    void (* parse_arg_function)(const char*));
140
141 void set_context_opts(void *ctx, void *opts_ctx, int flags);
142
143 /**
144  * Print an error message to stderr, indicating filename and a human
145  * readable description of the error code err.
146  *
147  * If strerror_r() is not available the use of this function in a
148  * multithreaded application may be unsafe.
149  *
150  * @see av_strerror()
151  */
152 void print_error(const char *filename, int err);
153
154 void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
155
156 /**
157  * Print the program banner to stderr. The banner contents depend on the
158  * current version of the repository and of the libav* libraries used by
159  * the program.
160  */
161 void show_banner(void);
162
163 /**
164  * Print the version of the program to stdout. The version message
165  * depends on the current versions of the repository and of the libav*
166  * libraries.
167  */
168 void show_version(void);
169
170 /**
171  * Print the license of the program to stdout. The license depends on
172  * the license of the libraries compiled into the program.
173  */
174 void show_license(void);
175
176 /**
177  * Print a listing containing all the formats supported by the
178  * program.
179  */
180 void show_formats(void);
181
182 /**
183  * Print a listing containing all the codecs supported by the
184  * program.
185  */
186 void show_codecs(void);
187
188 /**
189  * Print a listing containing all the filters supported by the
190  * program.
191  */
192 void show_filters(void);
193
194 /**
195  * Print a listing containing all the bit stream filters supported by the
196  * program.
197  */
198 void show_bsfs(void);
199
200 /**
201  * Print a listing containing all the protocols supported by the
202  * program.
203  */
204 void show_protocols(void);
205
206 /**
207  * Print a listing containing all the pixel formats supported by the
208  * program.
209  */
210 void show_pix_fmts(void);
211
212 /**
213  * Return a positive value if a line read from standard input
214  * starts with [yY], otherwise return 0.
215  */
216 int read_yesno(void);
217
218 /**
219  * Read the file with name filename, and put its content in a newly
220  * allocated 0-terminated buffer.
221  *
222  * @param bufptr location where pointer to buffer is returned
223  * @param size   location where size of buffer is returned
224  * @return 0 in case of success, a negative value corresponding to an
225  * AVERROR error code in case of failure.
226  */
227 int read_file(const char *filename, char **bufptr, size_t *size);
228
229 #endif /* FFMPEG_CMDUTILS_H */