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