ff*: Fix duplicatedly printed version info with -version
[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 <stdint.h>
26
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
31
32 #ifdef __MINGW32__
33 #undef main /* We don't want SDL to override our main() */
34 #endif
35
36 /**
37  * program name, defined by the program for show_version().
38  */
39 extern const char program_name[];
40
41 /**
42  * program birth year, defined by the program for show_banner()
43  */
44 extern const int program_birth_year;
45
46 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
47 extern AVFormatContext *avformat_opts;
48 extern struct SwsContext *sws_opts;
49 extern AVDictionary *format_opts, *codec_opts;
50
51 /**
52  * Initialize the cmdutils option system, in particular
53  * allocate the *_opts contexts.
54  */
55 void init_opts(void);
56 /**
57  * Uninitialize the cmdutils option system, in particular
58  * free the *_opts contexts and their contents.
59  */
60 void uninit_opts(void);
61
62 /**
63  * Trivial log callback.
64  * Only suitable for opt_help and similar since it lacks prefix handling.
65  */
66 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
67
68 /**
69  * Fallback for options that are not explicitly handled, these will be
70  * parsed through AVOptions.
71  */
72 int opt_default(const char *opt, const char *arg);
73
74 /**
75  * Set the libav* libraries log level.
76  */
77 int opt_loglevel(const char *opt, const char *arg);
78
79 int opt_report(const char *opt);
80
81 int opt_codec_debug(const char *opt, const char *arg);
82
83 /**
84  * Limit the execution time.
85  */
86 int opt_timelimit(const char *opt, const char *arg);
87
88 /**
89  * Parse a string and return its corresponding value as a double.
90  * Exit from the application if the string cannot be correctly
91  * parsed or the corresponding value is invalid.
92  *
93  * @param context the context of the value to be set (e.g. the
94  * corresponding command line option name)
95  * @param numstr the string to be parsed
96  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
97  * string should be parsed
98  * @param min the minimum valid accepted value
99  * @param max the maximum valid accepted value
100  */
101 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
102
103 /**
104  * Parse a string specifying a time and return its corresponding
105  * value as a number of microseconds. Exit from the application if
106  * the string cannot be correctly parsed.
107  *
108  * @param context the context of the value to be set (e.g. the
109  * corresponding command line option name)
110  * @param timestr the string to be parsed
111  * @param is_duration a flag which tells how to interpret timestr, if
112  * not zero timestr is interpreted as a duration, otherwise as a
113  * date
114  *
115  * @see parse_date()
116  */
117 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
118
119 typedef struct SpecifierOpt {
120     char *specifier;    /**< stream/chapter/program/... specifier */
121     union {
122         uint8_t *str;
123         int        i;
124         int64_t  i64;
125         float      f;
126         double   dbl;
127     } u;
128 } SpecifierOpt;
129
130 typedef struct {
131     const char *name;
132     int flags;
133 #define HAS_ARG    0x0001
134 #define OPT_BOOL   0x0002
135 #define OPT_EXPERT 0x0004
136 #define OPT_STRING 0x0008
137 #define OPT_VIDEO  0x0010
138 #define OPT_AUDIO  0x0020
139 #define OPT_GRAB   0x0040
140 #define OPT_INT    0x0080
141 #define OPT_FLOAT  0x0100
142 #define OPT_SUBTITLE 0x0200
143 #define OPT_INT64  0x0400
144 #define OPT_EXIT   0x0800
145 #define OPT_DATA   0x1000
146 #define OPT_FUNC2  0x2000
147 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
148 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
149                                    Implies OPT_OFFSET. Next element after the offset is
150                                    an int containing element count in the array. */
151 #define OPT_TIME  0x10000
152 #define OPT_DOUBLE 0x20000
153      union {
154         void *dst_ptr;
155         int (*func_arg)(const char *, const char *);
156         int (*func2_arg)(void *, const char *, const char *);
157         size_t off;
158     } u;
159     const char *help;
160     const char *argname;
161 } OptionDef;
162
163 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
164
165 /**
166  * Show help for all options with given flags in class and all its
167  * children.
168  */
169 void show_help_children(const AVClass *class, int flags);
170
171 /**
172  * Parse the command line arguments.
173  *
174  * @param optctx an opaque options context
175  * @param options Array with the definitions required to interpret every
176  * option of the form: -option_name [argument]
177  * @param parse_arg_function Name of the function called to process every
178  * argument without a leading option name flag. NULL if such arguments do
179  * not have to be processed.
180  */
181 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
182                    void (* parse_arg_function)(void *optctx, const char*));
183
184 /**
185  * Parse one given option.
186  *
187  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
188  */
189 int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options);
190
191 /**
192  * Find the '-loglevel' option in the command line args and apply it.
193  */
194 void parse_loglevel(int argc, char **argv, const OptionDef *options);
195
196 /**
197  * Check if the given stream matches a stream specifier.
198  *
199  * @param s  Corresponding format context.
200  * @param st Stream from s to be checked.
201  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
202  *
203  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
204  */
205 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
206
207 /**
208  * Filter out options for given codec.
209  *
210  * Create a new options dictionary containing only the options from
211  * opts which apply to the codec with ID codec_id.
212  *
213  * @param s Corresponding format context.
214  * @param st A stream from s for which the options should be filtered.
215  * @return a pointer to the created dictionary
216  */
217 AVDictionary *filter_codec_opts(AVDictionary *opts, AVCodec *codec, AVFormatContext *s, AVStream *st);
218
219 /**
220  * Setup AVCodecContext options for avformat_find_stream_info().
221  *
222  * Create an array of dictionaries, one dictionary for each stream
223  * contained in s.
224  * Each dictionary will contain the options from codec_opts which can
225  * be applied to the corresponding stream codec context.
226  *
227  * @return pointer to the created array of dictionaries, NULL if it
228  * cannot be created
229  */
230 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
231
232 /**
233  * Print an error message to stderr, indicating filename and a human
234  * readable description of the error code err.
235  *
236  * If strerror_r() is not available the use of this function in a
237  * multithreaded application may be unsafe.
238  *
239  * @see av_strerror()
240  */
241 void print_error(const char *filename, int err);
242
243 /**
244  * Print the program banner to stderr. The banner contents depend on the
245  * current version of the repository and of the libav* libraries used by
246  * the program.
247  */
248 void show_banner(int argc, char **argv, const OptionDef *options);
249
250 /**
251  * Print the version of the program to stdout. The version message
252  * depends on the current versions of the repository and of the libav*
253  * libraries.
254  * This option processing function does not utilize the arguments.
255  */
256 int opt_version(const char *opt, const char *arg);
257
258 /**
259  * Print the license of the program to stdout. The license depends on
260  * the license of the libraries compiled into the program.
261  * This option processing function does not utilize the arguments.
262  */
263 int opt_license(const char *opt, const char *arg);
264
265 /**
266  * Print a listing containing all the formats supported by the
267  * program.
268  * This option processing function does not utilize the arguments.
269  */
270 int opt_formats(const char *opt, const char *arg);
271
272 /**
273  * Print a listing containing all the codecs supported by the
274  * program.
275  * This option processing function does not utilize the arguments.
276  */
277 int opt_codecs(const char *opt, const char *arg);
278
279 /**
280  * Print a listing containing all the filters supported by the
281  * program.
282  * This option processing function does not utilize the arguments.
283  */
284 int opt_filters(const char *opt, const char *arg);
285
286 /**
287  * Print a listing containing all the bit stream filters supported by the
288  * program.
289  * This option processing function does not utilize the arguments.
290  */
291 int opt_bsfs(const char *opt, const char *arg);
292
293 /**
294  * Print a listing containing all the protocols supported by the
295  * program.
296  * This option processing function does not utilize the arguments.
297  */
298 int opt_protocols(const char *opt, const char *arg);
299
300 /**
301  * Print a listing containing all the pixel formats supported by the
302  * program.
303  * This option processing function does not utilize the arguments.
304  */
305 int opt_pix_fmts(const char *opt, const char *arg);
306
307 /**
308  * Print a listing containing all the sample formats supported by the
309  * program.
310  */
311 int show_sample_fmts(const char *opt, const char *arg);
312
313 /**
314  * Return a positive value if a line read from standard input
315  * starts with [yY], otherwise return 0.
316  */
317 int read_yesno(void);
318
319 /**
320  * Read the file with name filename, and put its content in a newly
321  * allocated 0-terminated buffer.
322  *
323  * @param bufptr location where pointer to buffer is returned
324  * @param size   location where size of buffer is returned
325  * @return 0 in case of success, a negative value corresponding to an
326  * AVERROR error code in case of failure.
327  */
328 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
329
330 /**
331  * Get a file corresponding to a preset file.
332  *
333  * If is_path is non-zero, look for the file in the path preset_name.
334  * Otherwise search for a file named arg.ffpreset in the directories
335  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
336  * at configuration time or in a "ffpresets" folder along the executable
337  * on win32, in that order. If no such file is found and
338  * codec_name is defined, then search for a file named
339  * codec_name-preset_name.ffpreset in the above-mentioned directories.
340  *
341  * @param filename buffer where the name of the found filename is written
342  * @param filename_size size in bytes of the filename buffer
343  * @param preset_name name of the preset to search
344  * @param is_path tell if preset_name is a filename path
345  * @param codec_name name of the codec for which to look for the
346  * preset, may be NULL
347  */
348 FILE *get_preset_file(char *filename, size_t filename_size,
349                       const char *preset_name, int is_path, const char *codec_name);
350
351 /**
352  * Do all the necessary cleanup and abort.
353  * This function is implemented in the avtools, not cmdutils.
354  */
355 void exit_program(int ret);
356
357 /**
358  * Realloc array to hold new_size elements of elem_size.
359  * Calls exit_program() on failure.
360  *
361  * @param elem_size size in bytes of each element
362  * @param size new element count will be written here
363  * @return reallocated array
364  */
365 void *grow_array(void *array, int elem_size, int *size, int new_size);
366
367 #endif /* CMDUTILS_H */