configure: Explicitly spell out first require_pkg_config() parameter
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef LIBAV_CMDUTILS_H
23 #define LIBAV_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 /**
33  * program name, defined by the program for show_version().
34  */
35 extern const char program_name[];
36
37 /**
38  * program birth year, defined by the program for show_banner()
39  */
40 extern const int program_birth_year;
41
42 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
43 extern AVFormatContext *avformat_opts;
44 extern struct SwsContext *sws_opts;
45 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
46
47 /**
48  * Register a program-specific cleanup routine.
49  */
50 void register_exit(void (*cb)(int ret));
51
52 /**
53  * Wraps exit with a program-specific cleanup routine.
54  */
55 void exit_program(int ret) av_noreturn;
56
57 /**
58  * Initialize the cmdutils option system, in particular
59  * allocate the *_opts contexts.
60  */
61 void init_opts(void);
62 /**
63  * Uninitialize the cmdutils option system, in particular
64  * free the *_opts contexts and their contents.
65  */
66 void uninit_opts(void);
67
68 /**
69  * Trivial log callback.
70  * Only suitable for show_help and similar since it lacks prefix handling.
71  */
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74 /**
75  * Override the cpuflags mask.
76  */
77 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
78
79 /**
80  * Fallback for options that are not explicitly handled, these will be
81  * parsed through AVOptions.
82  */
83 int opt_default(void *optctx, const char *opt, const char *arg);
84
85 /**
86  * Set the libav* libraries log level.
87  */
88 int opt_loglevel(void *optctx, const char *opt, const char *arg);
89
90 /**
91  * Limit the execution time.
92  */
93 int opt_timelimit(void *optctx, 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 OptionDef {
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_INT    0x0080
149 #define OPT_FLOAT  0x0100
150 #define OPT_SUBTITLE 0x0200
151 #define OPT_INT64  0x0400
152 #define OPT_EXIT   0x0800
153 #define OPT_DATA   0x1000
154 #define OPT_PERFILE  0x2000     /* the option is per-file (currently avconv-only).
155                                    implied by OPT_OFFSET or OPT_SPEC */
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 #define OPT_INPUT  0x40000
163 #define OPT_OUTPUT 0x80000
164      union {
165         void *dst_ptr;
166         int (*func_arg)(void *, const char *, const char *);
167         size_t off;
168     } u;
169     const char *help;
170     const char *argname;
171 } OptionDef;
172
173 /**
174  * Print help for all options matching specified flags.
175  *
176  * @param options a list of options
177  * @param msg title of this group. Only printed if at least one option matches.
178  * @param req_flags print only options which have all those flags set.
179  * @param rej_flags don't print options which have any of those flags set.
180  * @param alt_flags print only options that have at least one of those flags set
181  */
182 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
183                        int rej_flags, int alt_flags);
184
185 #define CMDUTILS_COMMON_OPTIONS                                                                                         \
186     { "L",           OPT_EXIT,             { .func_arg = show_license },     "show license" },                          \
187     { "h",           OPT_EXIT,             { .func_arg = show_help },        "show help", "topic" },                    \
188     { "?",           OPT_EXIT,             { .func_arg = show_help },        "show help", "topic" },                    \
189     { "help",        OPT_EXIT,             { .func_arg = show_help },        "show help", "topic" },                    \
190     { "-help",       OPT_EXIT,             { .func_arg = show_help },        "show help", "topic" },                    \
191     { "version",     OPT_EXIT,             { .func_arg = show_version },     "show version" },                          \
192     { "formats",     OPT_EXIT,             { .func_arg = show_formats },     "show available formats" },                \
193     { "codecs",      OPT_EXIT,             { .func_arg = show_codecs },      "show available codecs" },                 \
194     { "decoders",    OPT_EXIT,             { .func_arg = show_decoders },    "show available decoders" },               \
195     { "encoders",    OPT_EXIT,             { .func_arg = show_encoders },    "show available encoders" },               \
196     { "bsfs",        OPT_EXIT,             { .func_arg = show_bsfs },        "show available bit stream filters" },     \
197     { "protocols",   OPT_EXIT,             { .func_arg = show_protocols },   "show available protocols" },              \
198     { "filters",     OPT_EXIT,             { .func_arg = show_filters },     "show available filters" },                \
199     { "pix_fmts",    OPT_EXIT,             { .func_arg = show_pix_fmts },    "show available pixel formats" },          \
200     { "sample_fmts", OPT_EXIT,             { .func_arg = show_sample_fmts }, "show available audio sample formats" },   \
201     { "loglevel",    HAS_ARG,              { .func_arg = opt_loglevel },     "set libav* logging level", "loglevel" },  \
202     { "v",           HAS_ARG,              { .func_arg = opt_loglevel },     "set libav* logging level", "loglevel" },  \
203     { "cpuflags",    HAS_ARG | OPT_EXPERT, { .func_arg = opt_cpuflags },     "set CPU flags mask", "mask" },            \
204
205 /**
206  * Show help for all options with given flags in class and all its
207  * children.
208  */
209 void show_help_children(const AVClass *class, int flags);
210
211 /**
212  * Per-avtool specific help handler. Implemented in each
213  * avtool, called by show_help().
214  */
215 void show_help_default(const char *opt, const char *arg);
216
217 /**
218  * Generic -h handler common to all avtools.
219  */
220 int show_help(void *optctx, const char *opt, const char *arg);
221
222 /**
223  * Parse the command line arguments.
224  *
225  * @param optctx an opaque options context
226  * @param argc   number of command line arguments
227  * @param argv   values of command line arguments
228  * @param options Array with the definitions required to interpret every
229  * option of the form: -option_name [argument]
230  * @param parse_arg_function Name of the function called to process every
231  * argument without a leading option name flag. NULL if such arguments do
232  * not have to be processed.
233  */
234 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
235                    void (* parse_arg_function)(void *optctx, const char*));
236
237 /**
238  * Parse one given option.
239  *
240  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
241  */
242 int parse_option(void *optctx, const char *opt, const char *arg,
243                  const OptionDef *options);
244
245 /**
246  * An option extracted from the commandline.
247  * Cannot use AVDictionary because of options like -map which can be
248  * used multiple times.
249  */
250 typedef struct Option {
251     const OptionDef  *opt;
252     const char       *key;
253     const char       *val;
254 } Option;
255
256 typedef struct OptionGroupDef {
257     /**< group name */
258     const char *name;
259     /**
260      * Option to be used as group separator. Can be NULL for groups which
261      * are terminated by a non-option argument (e.g. avconv output files)
262      */
263     const char *sep;
264     /**
265      * Option flags that must be set on each option that is
266      * applied to this group
267      */
268     int flags;
269 } OptionGroupDef;
270
271 typedef struct OptionGroup {
272     const OptionGroupDef *group_def;
273     const char *arg;
274
275     Option *opts;
276     int  nb_opts;
277
278     AVDictionary *codec_opts;
279     AVDictionary *format_opts;
280     AVDictionary *resample_opts;
281     struct SwsContext *sws_opts;
282 } OptionGroup;
283
284 /**
285  * A list of option groups that all have the same group type
286  * (e.g. input files or output files)
287  */
288 typedef struct OptionGroupList {
289     const OptionGroupDef *group_def;
290
291     OptionGroup *groups;
292     int       nb_groups;
293 } OptionGroupList;
294
295 typedef struct OptionParseContext {
296     OptionGroup global_opts;
297
298     OptionGroupList *groups;
299     int           nb_groups;
300
301     /* parsing state */
302     OptionGroup cur_group;
303 } OptionParseContext;
304
305 /**
306  * Parse an options group and write results into optctx.
307  *
308  * @param optctx an app-specific options context. NULL for global options group
309  */
310 int parse_optgroup(void *optctx, OptionGroup *g);
311
312 /**
313  * Split the commandline into an intermediate form convenient for further
314  * processing.
315  *
316  * The commandline is assumed to be composed of options which either belong to a
317  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
318  * (everything else).
319  *
320  * A group (defined by an OptionGroupDef struct) is a sequence of options
321  * terminated by either a group separator option (e.g. -i) or a parameter that
322  * is not an option (doesn't start with -). A group without a separator option
323  * must always be first in the supplied groups list.
324  *
325  * All options within the same group are stored in one OptionGroup struct in an
326  * OptionGroupList, all groups with the same group definition are stored in one
327  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
328  * same as the order of group definitions.
329  */
330 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
331                       const OptionDef *options,
332                       const OptionGroupDef *groups, int nb_groups);
333
334 /**
335  * Free all allocated memory in an OptionParseContext.
336  */
337 void uninit_parse_context(OptionParseContext *octx);
338
339 /**
340  * Find the '-loglevel' option in the command line args and apply it.
341  */
342 void parse_loglevel(int argc, char **argv, const OptionDef *options);
343
344 /**
345  * Return index of option opt in argv or 0 if not found.
346  */
347 int locate_option(int argc, char **argv, const OptionDef *options,
348                   const char *optname);
349
350 /**
351  * Check if the given stream matches a stream specifier.
352  *
353  * @param s  Corresponding format context.
354  * @param st Stream from s to be checked.
355  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
356  *
357  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
358  */
359 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
360
361 /**
362  * Filter out options for given codec.
363  *
364  * Create a new options dictionary containing only the options from
365  * opts which apply to the codec with ID codec_id.
366  *
367  * @param opts     dictionary to place options in
368  * @param codec_id ID of the codec that should be filtered for
369  * @param s Corresponding format context.
370  * @param st A stream from s for which the options should be filtered.
371  * @param codec The particular codec for which the options should be filtered.
372  *              If null, the default one is looked up according to the codec id.
373  * @return a pointer to the created dictionary
374  */
375 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
376                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
377
378 /**
379  * Setup AVCodecContext options for avformat_find_stream_info().
380  *
381  * Create an array of dictionaries, one dictionary for each stream
382  * contained in s.
383  * Each dictionary will contain the options from codec_opts which can
384  * be applied to the corresponding stream codec context.
385  *
386  * @return pointer to the created array of dictionaries, NULL if it
387  * cannot be created
388  */
389 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
390                                            AVDictionary *codec_opts);
391
392 /**
393  * Print an error message to stderr, indicating filename and a human
394  * readable description of the error code err.
395  *
396  * If strerror_r() is not available the use of this function in a
397  * multithreaded application may be unsafe.
398  *
399  * @see av_strerror()
400  */
401 void print_error(const char *filename, int err);
402
403 /**
404  * Print the program banner to stderr. The banner contents depend on the
405  * current version of the repository and of the libav* libraries used by
406  * the program.
407  */
408 void show_banner(void);
409
410 /**
411  * Print the version of the program to stdout. The version message
412  * depends on the current versions of the repository and of the libav*
413  * libraries.
414  */
415 int show_version(void *optctx, const char *opt, const char *arg);
416
417 /**
418  * Print the license of the program to stdout. The license depends on
419  * the license of the libraries compiled into the program.
420  */
421 int show_license(void *optctx, const char *opt, const char *arg);
422
423 /**
424  * Print a listing containing all the formats supported by the
425  * program.
426  */
427 int show_formats(void *optctx, const char *opt, const char *arg);
428
429 /**
430  * Print a listing containing all the codecs supported by the
431  * program.
432  */
433 int show_codecs(void *optctx, const char *opt, const char *arg);
434
435 /**
436  * Print a listing containing all the decoders supported by the
437  * program.
438  */
439 int show_decoders(void *optctx, const char *opt, const char *arg);
440
441 /**
442  * Print a listing containing all the encoders supported by the
443  * program.
444  */
445 int show_encoders(void *optctx, const char *opt, const char *arg);
446
447 /**
448  * Print a listing containing all the filters supported by the
449  * program.
450  */
451 int show_filters(void *optctx, const char *opt, const char *arg);
452
453 /**
454  * Print a listing containing all the bit stream filters supported by the
455  * program.
456  */
457 int show_bsfs(void *optctx, const char *opt, const char *arg);
458
459 /**
460  * Print a listing containing all the protocols supported by the
461  * program.
462  */
463 int show_protocols(void *optctx, const char *opt, const char *arg);
464
465 /**
466  * Print a listing containing all the pixel formats supported by the
467  * program.
468  */
469 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
470
471 /**
472  * Print a listing containing all the sample formats supported by the
473  * program.
474  */
475 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
476
477 /**
478  * Return a positive value if a line read from standard input
479  * starts with [yY], otherwise return 0.
480  */
481 int read_yesno(void);
482
483 typedef struct PtsCorrectionContext {
484     int64_t num_faulty_pts; /// Number of incorrect PTS values so far
485     int64_t num_faulty_dts; /// Number of incorrect DTS values so far
486     int64_t last_pts;       /// PTS of the last frame
487     int64_t last_dts;       /// DTS of the last frame
488 } PtsCorrectionContext;
489
490 /**
491  * Reset the state of the PtsCorrectionContext.
492  */
493 void init_pts_correction(PtsCorrectionContext *ctx);
494
495 /**
496  * Attempt to guess proper monotonic timestamps for decoded video frames
497  * which might have incorrect times. Input timestamps may wrap around, in
498  * which case the output will as well.
499  *
500  * @param ctx the PtsCorrectionContext carrying stream pts information
501  * @param pts the pts field of the decoded AVPacket, as passed through
502  * AVCodecContext.reordered_opaque
503  * @param dts the dts field of the decoded AVPacket
504  * @return one of the input values, may be AV_NOPTS_VALUE
505  */
506 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
507
508 /**
509  * Get a file corresponding to a preset file.
510  *
511  * If is_path is non-zero, look for the file in the path preset_name.
512  * Otherwise search for a file named arg.avpreset in the directories
513  * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
514  * at configuration time, in that order. If no such file is found and
515  * codec_name is defined, then search for a file named
516  * codec_name-preset_name.avpreset in the above-mentioned directories.
517  *
518  * @param filename buffer where the name of the found filename is written
519  * @param filename_size size in bytes of the filename buffer
520  * @param preset_name name of the preset to search
521  * @param is_path tell if preset_name is a filename path
522  * @param codec_name name of the codec for which to look for the
523  * preset, may be NULL
524  */
525 FILE *get_preset_file(char *filename, size_t filename_size,
526                       const char *preset_name, int is_path, const char *codec_name);
527
528 /**
529  * Realloc array to hold new_size elements of elem_size.
530  * Calls exit() on failure.
531  *
532  * @param array array to reallocate
533  * @param elem_size size in bytes of each element
534  * @param size new element count will be written here
535  * @param new_size number of elements to place in reallocated array
536  * @return reallocated array
537  */
538 void *grow_array(void *array, int elem_size, int *size, int new_size);
539
540 /**
541  * Get a string describing a media type.
542  */
543 const char *media_type_string(enum AVMediaType media_type);
544
545 #define GROW_ARRAY(array, nb_elems)\
546     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
547
548 #define GET_PIX_FMT_NAME(pix_fmt)\
549     const char *name = av_get_pix_fmt_name(pix_fmt);
550
551 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
552     const char *name = av_get_sample_fmt_name(sample_fmt)
553
554 #define GET_SAMPLE_RATE_NAME(rate)\
555     char name[16];\
556     snprintf(name, sizeof(name), "%d", rate);
557
558 #define GET_CH_LAYOUT_NAME(ch_layout)\
559     char name[16];\
560     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
561
562 #define GET_CH_LAYOUT_DESC(ch_layout)\
563     char name[128];\
564     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
565
566 #endif /* LIBAV_CMDUTILS_H */