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