cmdutils: remove this_year constant, use CONFIG_THIS_YEAR instead
[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 *swr_opts;
50 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
51
52 /**
53  * Register a program-specific cleanup routine.
54  */
55 void register_exit(void (*cb)(int ret));
56
57 /**
58  * Wraps exit with a program-specific cleanup routine.
59  */
60 void exit_program(int ret);
61
62 /**
63  * Initialize the cmdutils option system, in particular
64  * allocate the *_opts contexts.
65  */
66 void init_opts(void);
67 /**
68  * Uninitialize the cmdutils option system, in particular
69  * free the *_opts contexts and their contents.
70  */
71 void uninit_opts(void);
72
73 /**
74  * Trivial log callback.
75  * Only suitable for opt_help and similar since it lacks prefix handling.
76  */
77 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
78
79 /**
80  * Override the cpuflags.
81  */
82 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
83
84 /**
85  * Fallback for options that are not explicitly handled, these will be
86  * parsed through AVOptions.
87  */
88 int opt_default(void *optctx, const char *opt, const char *arg);
89
90 /**
91  * Set the libav* libraries log level.
92  */
93 int opt_loglevel(void *optctx, const char *opt, const char *arg);
94
95 int opt_report(const char *opt);
96
97 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
98
99 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
100
101 int opt_opencl(void *optctx, const char *opt, const char *arg);
102
103 /**
104  * Limit the execution time.
105  */
106 int opt_timelimit(void *optctx, const char *opt, const char *arg);
107
108 /**
109  * Parse a string and return its corresponding value as a double.
110  * Exit from the application if the string cannot be correctly
111  * parsed or the corresponding value is invalid.
112  *
113  * @param context the context of the value to be set (e.g. the
114  * corresponding command line option name)
115  * @param numstr the string to be parsed
116  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
117  * string should be parsed
118  * @param min the minimum valid accepted value
119  * @param max the maximum valid accepted value
120  */
121 double parse_number_or_die(const char *context, const char *numstr, int type,
122                            double min, double max);
123
124 /**
125  * Parse a string specifying a time and return its corresponding
126  * value as a number of microseconds. Exit from the application if
127  * the string cannot be correctly parsed.
128  *
129  * @param context the context of the value to be set (e.g. the
130  * corresponding command line option name)
131  * @param timestr the string to be parsed
132  * @param is_duration a flag which tells how to interpret timestr, if
133  * not zero timestr is interpreted as a duration, otherwise as a
134  * date
135  *
136  * @see av_parse_time()
137  */
138 int64_t parse_time_or_die(const char *context, const char *timestr,
139                           int is_duration);
140
141 typedef struct SpecifierOpt {
142     char *specifier;    /**< stream/chapter/program/... specifier */
143     union {
144         uint8_t *str;
145         int        i;
146         int64_t  i64;
147         float      f;
148         double   dbl;
149     } u;
150 } SpecifierOpt;
151
152 typedef struct OptionDef {
153     const char *name;
154     int flags;
155 #define HAS_ARG    0x0001
156 #define OPT_BOOL   0x0002
157 #define OPT_EXPERT 0x0004
158 #define OPT_STRING 0x0008
159 #define OPT_VIDEO  0x0010
160 #define OPT_AUDIO  0x0020
161 #define OPT_INT    0x0080
162 #define OPT_FLOAT  0x0100
163 #define OPT_SUBTITLE 0x0200
164 #define OPT_INT64  0x0400
165 #define OPT_EXIT   0x0800
166 #define OPT_DATA   0x1000
167 #define OPT_PERFILE  0x2000     /* the option is per-file (currently ffmpeg-only).
168                                    implied by OPT_OFFSET or OPT_SPEC */
169 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
170 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
171                                    Implies OPT_OFFSET. Next element after the offset is
172                                    an int containing element count in the array. */
173 #define OPT_TIME  0x10000
174 #define OPT_DOUBLE 0x20000
175 #define OPT_INPUT  0x40000
176 #define OPT_OUTPUT 0x80000
177      union {
178         void *dst_ptr;
179         int (*func_arg)(void *, const char *, const char *);
180         size_t off;
181     } u;
182     const char *help;
183     const char *argname;
184 } OptionDef;
185
186 /**
187  * Print help for all options matching specified flags.
188  *
189  * @param options a list of options
190  * @param msg title of this group. Only printed if at least one option matches.
191  * @param req_flags print only options which have all those flags set.
192  * @param rej_flags don't print options which have any of those flags set.
193  * @param alt_flags print only options that have at least one of those flags set
194  */
195 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
196                        int rej_flags, int alt_flags);
197
198 /**
199  * Show help for all options with given flags in class and all its
200  * children.
201  */
202 void show_help_children(const AVClass *class, int flags);
203
204 /**
205  * Per-fftool specific help handler. Implemented in each
206  * fftool, called by show_help().
207  */
208 void show_help_default(const char *opt, const char *arg);
209
210 /**
211  * Generic -h handler common to all fftools.
212  */
213 int show_help(void *optctx, const char *opt, const char *arg);
214
215 /**
216  * Parse the command line arguments.
217  *
218  * @param optctx an opaque options context
219  * @param argc   number of command line arguments
220  * @param argv   values of command line arguments
221  * @param options Array with the definitions required to interpret every
222  * option of the form: -option_name [argument]
223  * @param parse_arg_function Name of the function called to process every
224  * argument without a leading option name flag. NULL if such arguments do
225  * not have to be processed.
226  */
227 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
228                    void (* parse_arg_function)(void *optctx, const char*));
229
230 /**
231  * Parse one given option.
232  *
233  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
234  */
235 int parse_option(void *optctx, const char *opt, const char *arg,
236                  const OptionDef *options);
237
238 /**
239  * An option extracted from the commandline.
240  * Cannot use AVDictionary because of options like -map which can be
241  * used multiple times.
242  */
243 typedef struct Option {
244     const OptionDef  *opt;
245     const char       *key;
246     const char       *val;
247 } Option;
248
249 typedef struct OptionGroupDef {
250     /**< group name */
251     const char *name;
252     /**
253      * Option to be used as group separator. Can be NULL for groups which
254      * are terminated by a non-option argument (e.g. ffmpeg output files)
255      */
256     const char *sep;
257     /**
258      * Option flags that must be set on each option that is
259      * applied to this group
260      */
261     int flags;
262 } OptionGroupDef;
263
264 typedef struct OptionGroup {
265     const OptionGroupDef *group_def;
266     const char *arg;
267
268     Option *opts;
269     int  nb_opts;
270
271     AVDictionary *codec_opts;
272     AVDictionary *format_opts;
273     AVDictionary *resample_opts;
274     struct SwsContext *sws_opts;
275     AVDictionary *swr_opts;
276 } OptionGroup;
277
278 /**
279  * A list of option groups that all have the same group type
280  * (e.g. input files or output files)
281  */
282 typedef struct OptionGroupList {
283     const OptionGroupDef *group_def;
284
285     OptionGroup *groups;
286     int       nb_groups;
287 } OptionGroupList;
288
289 typedef struct OptionParseContext {
290     OptionGroup global_opts;
291
292     OptionGroupList *groups;
293     int           nb_groups;
294
295     /* parsing state */
296     OptionGroup cur_group;
297 } OptionParseContext;
298
299 /**
300  * Parse an options group and write results into optctx.
301  *
302  * @param optctx an app-specific options context. NULL for global options group
303  */
304 int parse_optgroup(void *optctx, OptionGroup *g);
305
306 /**
307  * Split the commandline into an intermediate form convenient for further
308  * processing.
309  *
310  * The commandline is assumed to be composed of options which either belong to a
311  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
312  * (everything else).
313  *
314  * A group (defined by an OptionGroupDef struct) is a sequence of options
315  * terminated by either a group separator option (e.g. -i) or a parameter that
316  * is not an option (doesn't start with -). A group without a separator option
317  * must always be first in the supplied groups list.
318  *
319  * All options within the same group are stored in one OptionGroup struct in an
320  * OptionGroupList, all groups with the same group definition are stored in one
321  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
322  * same as the order of group definitions.
323  */
324 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
325                       const OptionDef *options,
326                       const OptionGroupDef *groups, int nb_groups);
327
328 /**
329  * Free all allocated memory in an OptionParseContext.
330  */
331 void uninit_parse_context(OptionParseContext *octx);
332
333 /**
334  * Find the '-loglevel' option in the command line args and apply it.
335  */
336 void parse_loglevel(int argc, char **argv, const OptionDef *options);
337
338 /**
339  * Return index of option opt in argv or 0 if not found.
340  */
341 int locate_option(int argc, char **argv, const OptionDef *options,
342                   const char *optname);
343
344 /**
345  * Check if the given stream matches a stream specifier.
346  *
347  * @param s  Corresponding format context.
348  * @param st Stream from s to be checked.
349  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
350  *
351  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
352  */
353 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
354
355 /**
356  * Filter out options for given codec.
357  *
358  * Create a new options dictionary containing only the options from
359  * opts which apply to the codec with ID codec_id.
360  *
361  * @param opts     dictionary to place options in
362  * @param codec_id ID of the codec that should be filtered for
363  * @param s Corresponding format context.
364  * @param st A stream from s for which the options should be filtered.
365  * @param codec The particular codec for which the options should be filtered.
366  *              If null, the default one is looked up according to the codec id.
367  * @return a pointer to the created dictionary
368  */
369 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
370                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
371
372 /**
373  * Setup AVCodecContext options for avformat_find_stream_info().
374  *
375  * Create an array of dictionaries, one dictionary for each stream
376  * contained in s.
377  * Each dictionary will contain the options from codec_opts which can
378  * be applied to the corresponding stream codec context.
379  *
380  * @return pointer to the created array of dictionaries, NULL if it
381  * cannot be created
382  */
383 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
384                                            AVDictionary *codec_opts);
385
386 /**
387  * Print an error message to stderr, indicating filename and a human
388  * readable description of the error code err.
389  *
390  * If strerror_r() is not available the use of this function in a
391  * multithreaded application may be unsafe.
392  *
393  * @see av_strerror()
394  */
395 void print_error(const char *filename, int err);
396
397 /**
398  * Print the program banner to stderr. The banner contents depend on the
399  * current version of the repository and of the libav* libraries used by
400  * the program.
401  */
402 void show_banner(int argc, char **argv, const OptionDef *options);
403
404 /**
405  * Print the version of the program to stdout. The version message
406  * depends on the current versions of the repository and of the libav*
407  * libraries.
408  * This option processing function does not utilize the arguments.
409  */
410 int show_version(void *optctx, const char *opt, const char *arg);
411
412 /**
413  * Print the build configuration of the program to stdout. The contents
414  * depend on the definition of FFMPEG_CONFIGURATION.
415  * This option processing function does not utilize the arguments.
416  */
417 int show_buildconf(void *optctx, const char *opt, const char *arg);
418
419 /**
420  * Print the license of the program to stdout. The license depends on
421  * the license of the libraries compiled into the program.
422  * This option processing function does not utilize the arguments.
423  */
424 int show_license(void *optctx, const char *opt, const char *arg);
425
426 /**
427  * Print a listing containing all the formats supported by the
428  * program.
429  * This option processing function does not utilize the arguments.
430  */
431 int show_formats(void *optctx, const char *opt, const char *arg);
432
433 /**
434  * Print a listing containing all the codecs supported by the
435  * program.
436  * This option processing function does not utilize the arguments.
437  */
438 int show_codecs(void *optctx, const char *opt, const char *arg);
439
440 /**
441  * Print a listing containing all the decoders supported by the
442  * program.
443  */
444 int show_decoders(void *optctx, const char *opt, const char *arg);
445
446 /**
447  * Print a listing containing all the encoders supported by the
448  * program.
449  */
450 int show_encoders(void *optctx, const char *opt, const char *arg);
451
452 /**
453  * Print a listing containing all the filters supported by the
454  * program.
455  * This option processing function does not utilize the arguments.
456  */
457 int show_filters(void *optctx, const char *opt, const char *arg);
458
459 /**
460  * Print a listing containing all the bit stream filters supported by the
461  * program.
462  * This option processing function does not utilize the arguments.
463  */
464 int show_bsfs(void *optctx, const char *opt, const char *arg);
465
466 /**
467  * Print a listing containing all the protocols supported by the
468  * program.
469  * This option processing function does not utilize the arguments.
470  */
471 int show_protocols(void *optctx, const char *opt, const char *arg);
472
473 /**
474  * Print a listing containing all the pixel formats supported by the
475  * program.
476  * This option processing function does not utilize the arguments.
477  */
478 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
479
480 /**
481  * Print a listing containing all the standard channel layouts supported by
482  * the program.
483  * This option processing function does not utilize the arguments.
484  */
485 int show_layouts(void *optctx, const char *opt, const char *arg);
486
487 /**
488  * Print a listing containing all the sample formats supported by the
489  * program.
490  */
491 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
492
493 /**
494  * Print a listing containing all the color names and values recognized
495  * by the program.
496  */
497 int show_colors(void *optctx, const char *opt, const char *arg);
498
499 /**
500  * Return a positive value if a line read from standard input
501  * starts with [yY], otherwise return 0.
502  */
503 int read_yesno(void);
504
505 /**
506  * Read the file with name filename, and put its content in a newly
507  * allocated 0-terminated buffer.
508  *
509  * @param filename file to read from
510  * @param bufptr location where pointer to buffer is returned
511  * @param size   location where size of buffer is returned
512  * @return >= 0 in case of success, a negative value corresponding to an
513  * AVERROR error code in case of failure.
514  */
515 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
516
517 /**
518  * Get a file corresponding to a preset file.
519  *
520  * If is_path is non-zero, look for the file in the path preset_name.
521  * Otherwise search for a file named arg.ffpreset in the directories
522  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
523  * at configuration time or in a "ffpresets" folder along the executable
524  * on win32, in that order. If no such file is found and
525  * codec_name is defined, then search for a file named
526  * codec_name-preset_name.avpreset in the above-mentioned directories.
527  *
528  * @param filename buffer where the name of the found filename is written
529  * @param filename_size size in bytes of the filename buffer
530  * @param preset_name name of the preset to search
531  * @param is_path tell if preset_name is a filename path
532  * @param codec_name name of the codec for which to look for the
533  * preset, may be NULL
534  */
535 FILE *get_preset_file(char *filename, size_t filename_size,
536                       const char *preset_name, int is_path, const char *codec_name);
537
538 /**
539  * Realloc array to hold new_size elements of elem_size.
540  * Calls exit() on failure.
541  *
542  * @param array array to reallocate
543  * @param elem_size size in bytes of each element
544  * @param size new element count will be written here
545  * @param new_size number of elements to place in reallocated array
546  * @return reallocated array
547  */
548 void *grow_array(void *array, int elem_size, int *size, int new_size);
549
550 #define media_type_string av_get_media_type_string
551
552 #define GROW_ARRAY(array, nb_elems)\
553     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
554
555 #define GET_PIX_FMT_NAME(pix_fmt)\
556     const char *name = av_get_pix_fmt_name(pix_fmt);
557
558 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
559     const char *name = av_get_sample_fmt_name(sample_fmt)
560
561 #define GET_SAMPLE_RATE_NAME(rate)\
562     char name[16];\
563     snprintf(name, sizeof(name), "%d", rate);
564
565 #define GET_CH_LAYOUT_NAME(ch_layout)\
566     char name[16];\
567     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
568
569 #define GET_CH_LAYOUT_DESC(ch_layout)\
570     char name[128];\
571     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
572
573 #endif /* CMDUTILS_H */