aarch64: vp9mc: Simplify the extmla macro parameters
[libav.git] / cmdutils.h
CommitLineData
f5a90186
DB
1/*
2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
4 *
2912e87a 5 * This file is part of Libav.
f5a90186 6 *
2912e87a 7 * Libav is free software; you can redistribute it and/or
f5a90186
DB
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 *
2912e87a 12 * Libav is distributed in the hope that it will be useful,
f5a90186
DB
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
2912e87a 18 * License along with Libav; if not, write to the Free Software
f5a90186
DB
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
153382e1
DB
22#ifndef LIBAV_CMDUTILS_H
23#define LIBAV_CMDUTILS_H
01310af2 24
ea91e771
DB
25#include <stdint.h>
26
95137bbb 27#include "libavcodec/avcodec.h"
ea91e771 28#include "libavfilter/avfilter.h"
95137bbb
DB
29#include "libavformat/avformat.h"
30#include "libswscale/swscale.h"
f0a838e5 31
60b5a745 32/**
64555bd9
MN
33 * program name, defined by the program for show_version().
34 */
35extern const char program_name[];
36
37/**
ea9c581f
SS
38 * program birth year, defined by the program for show_banner()
39 */
40extern const int program_birth_year;
41
72415b2a 42extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
43extern AVFormatContext *avformat_opts;
44extern struct SwsContext *sws_opts;
5c7db097 45extern AVDictionary *format_opts, *codec_opts, *resample_opts;
85663ef3
MN
46
47/**
636ced8e
LB
48 * Register a program-specific cleanup routine.
49 */
50void register_exit(void (*cb)(int ret));
51
52/**
53 * Wraps exit with a program-specific cleanup routine.
54 */
85698be4 55void exit_program(int ret) av_noreturn;
636ced8e
LB
56
57/**
a5c33faa
RD
58 * Initialize the cmdutils option system, in particular
59 * allocate the *_opts contexts.
60 */
61void init_opts(void);
62/**
63 * Uninitialize the cmdutils option system, in particular
64 * free the *_opts contexts and their contents.
65 */
66void uninit_opts(void);
67
68/**
1790d3b3
SS
69 * Trivial log callback.
70 * Only suitable for show_help and similar since it lacks prefix handling.
71 */
72void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74/**
f825d42b
LB
75 * Override the cpuflags mask.
76 */
77int opt_cpuflags(void *optctx, const char *opt, const char *arg);
78
79/**
b7438896 80 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
81 * parsed through AVOptions.
82 */
11d957fb 83int opt_default(void *optctx, const char *opt, const char *arg);
85663ef3 84
ea9c581f 85/**
49bd8e4b 86 * Set the libav* libraries log level.
4c97a6fa 87 */
11d957fb 88int opt_loglevel(void *optctx, const char *opt, const char *arg);
4c97a6fa
SS
89
90/**
ffcc6e24
MR
91 * Limit the execution time.
92 */
11d957fb 93int opt_timelimit(void *optctx, const char *opt, const char *arg);
ffcc6e24
MR
94
95/**
49bd8e4b
MR
96 * Parse a string and return its corresponding value as a double.
97 * Exit from the application if the string cannot be correctly
15067504 98 * parsed or the corresponding value is invalid.
60b5a745
SS
99 *
100 * @param context the context of the value to be set (e.g. the
da9cea77 101 * corresponding command line option name)
60b5a745
SS
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
15067504
DB
105 * @param min the minimum valid accepted value
106 * @param max the maximum valid accepted value
60b5a745 107 */
0184bbe2
GN
108double parse_number_or_die(const char *context, const char *numstr, int type,
109 double min, double max);
60b5a745 110
7542157d 111/**
49bd8e4b
MR
112 * Parse a string specifying a time and return its corresponding
113 * value as a number of microseconds. Exit from the application if
7542157d
SS
114 * the string cannot be correctly parsed.
115 *
116 * @param context the context of the value to be set (e.g. the
da9cea77 117 * corresponding command line option name)
7542157d 118 * @param timestr the string to be parsed
bf7e799c
SS
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
7542157d
SS
121 * date
122 *
748061de 123 * @see parse_date()
7542157d 124 */
0184bbe2
GN
125int64_t parse_time_or_die(const char *context, const char *timestr,
126 int is_duration);
7542157d 127
6361c5e1
AK
128typedef 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;
33f75d72 135 double dbl;
6361c5e1
AK
136 } u;
137} SpecifierOpt;
138
e4cbf752 139typedef struct OptionDef {
01310af2
FB
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
02d504a7
FB
146#define OPT_VIDEO 0x0010
147#define OPT_AUDIO 0x0020
26d4f26b 148#define OPT_INT 0x0080
394c4d77 149#define OPT_FLOAT 0x0100
ae27975d 150#define OPT_SUBTITLE 0x0200
26513856
SS
151#define OPT_INT64 0x0400
152#define OPT_EXIT 0x0800
153#define OPT_DATA 0x1000
11d957fb
AK
154#define OPT_PERFILE 0x2000 /* the option is per-file (currently avconv-only).
155 implied by OPT_OFFSET or OPT_SPEC */
7cc8d638 156#define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
6361c5e1
AK
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. */
6b779ccc 160#define OPT_TIME 0x10000
33f75d72 161#define OPT_DOUBLE 0x20000
9d3009c6
AK
162#define OPT_INPUT 0x40000
163#define OPT_OUTPUT 0x80000
ae27975d 164 union {
7efe05ab 165 void *dst_ptr;
11d957fb 166 int (*func_arg)(void *, const char *, const char *);
7cc8d638 167 size_t off;
01310af2
FB
168 } u;
169 const char *help;
170 const char *argname;
171} OptionDef;
172
7c501212
AK
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.
f9fada27 180 * @param alt_flags print only options that have at least one of those flags set
7c501212
AK
181 */
182void show_help_options(const OptionDef *options, const char *msg, int req_flags,
f9fada27 183 int rej_flags, int alt_flags);
60a9966e 184
122de16d
DB
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
60a9966e 205/**
7a6cd995
AK
206 * Show help for all options with given flags in class and all its
207 * children.
208 */
209void show_help_children(const AVClass *class, int flags);
210
211/**
a3ad68d3
AK
212 * Per-avtool specific help handler. Implemented in each
213 * avtool, called by show_help().
214 */
215void show_help_default(const char *opt, const char *arg);
216
217/**
218 * Generic -h handler common to all avtools.
219 */
11d957fb 220int show_help(void *optctx, const char *opt, const char *arg);
a3ad68d3
AK
221
222/**
49bd8e4b 223 * Parse the command line arguments.
7cc8d638
AK
224 *
225 * @param optctx an opaque options context
02e42751
DB
226 * @param argc number of command line arguments
227 * @param argv values of command line arguments
60a9966e 228 * @param options Array with the definitions required to interpret every
0baf34d8 229 * option of the form: -option_name [argument]
60a9966e
SS
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 */
7cc8d638
AK
234void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
235 void (* parse_arg_function)(void *optctx, const char*));
60a9966e 236
8d787f8e 237/**
2f8e586d
AK
238 * Parse one given option.
239 *
240 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
241 */
0184bbe2
GN
242int parse_option(void *optctx, const char *opt, const char *arg,
243 const OptionDef *options);
2f8e586d
AK
244
245/**
8c9af5b2
AK
246 * An option extracted from the commandline.
247 * Cannot use AVDictionary because of options like -map which can be
248 * used multiple times.
249 */
250typedef struct Option {
251 const OptionDef *opt;
252 const char *key;
253 const char *val;
254} Option;
255
256typedef 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;
9d3009c6
AK
264 /**
265 * Option flags that must be set on each option that is
266 * applied to this group
267 */
268 int flags;
8c9af5b2
AK
269} OptionGroupDef;
270
271typedef 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;
5c7db097 280 AVDictionary *resample_opts;
8c9af5b2
AK
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 */
288typedef struct OptionGroupList {
289 const OptionGroupDef *group_def;
290
291 OptionGroup *groups;
292 int nb_groups;
293} OptionGroupList;
294
295typedef 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 */
310int 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 */
330int split_commandline(OptionParseContext *octx, int argc, char *argv[],
331 const OptionDef *options,
c661cb66 332 const OptionGroupDef *groups, int nb_groups);
8c9af5b2
AK
333
334/**
335 * Free all allocated memory in an OptionParseContext.
336 */
337void uninit_parse_context(OptionParseContext *octx);
338
339/**
da9cea77 340 * Find the '-loglevel' option in the command line args and apply it.
182cbe43
AK
341 */
342void parse_loglevel(int argc, char **argv, const OptionDef *options);
343
344/**
4138cd29
AK
345 * Return index of option opt in argv or 0 if not found.
346 */
347int locate_option(int argc, char **argv, const OptionDef *options,
348 const char *optname);
349
350/**
d4863fc1
AK
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.
e873c03a 355 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
d4863fc1
AK
356 *
357 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
358 */
359int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
360
361/**
8c8eab8b 362 * Filter out options for given codec.
ce23ca81
SS
363 *
364 * Create a new options dictionary containing only the options from
365 * opts which apply to the codec with ID codec_id.
366 *
02e42751
DB
367 * @param opts dictionary to place options in
368 * @param codec_id ID of the codec that should be filtered for
d4863fc1
AK
369 * @param s Corresponding format context.
370 * @param st A stream from s for which the options should be filtered.
d3ed1c95
MS
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.
ce23ca81 373 * @return a pointer to the created dictionary
8c8eab8b 374 */
36ef5369 375AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
d3ed1c95 376 AVFormatContext *s, AVStream *st, AVCodec *codec);
8c8eab8b 377
7cea06d1
SS
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
3009f521 388 */
0184bbe2
GN
389AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
390 AVDictionary *codec_opts);
3009f521 391
8c8eab8b 392/**
49bd8e4b 393 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
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 */
01310af2 401void print_error(const char *filename, int err);
c5dc6026 402
f35917b2 403/**
49bd8e4b 404 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
405 * current version of the repository and of the libav* libraries used by
406 * the program.
86074ed1 407 */
ea9c581f 408void show_banner(void);
86074ed1
SS
409
410/**
49bd8e4b 411 * Print the version of the program to stdout. The version message
86074ed1
SS
412 * depends on the current versions of the repository and of the libav*
413 * libraries.
86074ed1 414 */
11d957fb 415int show_version(void *optctx, const char *opt, const char *arg);
86074ed1
SS
416
417/**
49bd8e4b 418 * Print the license of the program to stdout. The license depends on
15067504 419 * the license of the libraries compiled into the program.
f35917b2 420 */
11d957fb 421int show_license(void *optctx, const char *opt, const char *arg);
f35917b2 422
ba9880c1 423/**
49bd8e4b 424 * Print a listing containing all the formats supported by the
ba9880c1
SS
425 * program.
426 */
11d957fb 427int show_formats(void *optctx, const char *opt, const char *arg);
ba9880c1 428
090b61b2 429/**
49bd8e4b 430 * Print a listing containing all the codecs supported by the
8447f0bd
MN
431 * program.
432 */
11d957fb 433int show_codecs(void *optctx, const char *opt, const char *arg);
8447f0bd
MN
434
435/**
7c101949
AK
436 * Print a listing containing all the decoders supported by the
437 * program.
438 */
11d957fb 439int show_decoders(void *optctx, const char *opt, const char *arg);
7c101949
AK
440
441/**
442 * Print a listing containing all the encoders supported by the
443 * program.
444 */
11d957fb 445int show_encoders(void *optctx, const char *opt, const char *arg);
7c101949
AK
446
447/**
49bd8e4b 448 * Print a listing containing all the filters supported by the
62d75662
SS
449 * program.
450 */
11d957fb 451int show_filters(void *optctx, const char *opt, const char *arg);
62d75662
SS
452
453/**
49bd8e4b 454 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
455 * program.
456 */
11d957fb 457int show_bsfs(void *optctx, const char *opt, const char *arg);
8447f0bd
MN
458
459/**
49bd8e4b 460 * Print a listing containing all the protocols supported by the
8447f0bd
MN
461 * program.
462 */
11d957fb 463int show_protocols(void *optctx, const char *opt, const char *arg);
8447f0bd
MN
464
465/**
49bd8e4b 466 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
467 * program.
468 */
11d957fb 469int show_pix_fmts(void *optctx, const char *opt, const char *arg);
3f7bb426
SS
470
471/**
05bffc12
AK
472 * Print a listing containing all the sample formats supported by the
473 * program.
474 */
11d957fb 475int show_sample_fmts(void *optctx, const char *opt, const char *arg);
05bffc12
AK
476
477/**
48966b02
MR
478 * Return a positive value if a line read from standard input
479 * starts with [yY], otherwise return 0.
090b61b2
SS
480 */
481int read_yesno(void);
482
e4cbf752 483typedef struct PtsCorrectionContext {
7a8bfa5d
AS
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/**
f03f30d7 491 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
492 */
493void init_pts_correction(PtsCorrectionContext *ctx);
494
495/**
f03f30d7 496 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
497 * which might have incorrect times. Input timestamps may wrap around, in
498 * which case the output will as well.
499 *
02e42751 500 * @param ctx the PtsCorrectionContext carrying stream pts information
f03f30d7 501 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 502 * AVCodecContext.reordered_opaque
f03f30d7
SS
503 * @param dts the dts field of the decoded AVPacket
504 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
505 */
506int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
507
6e872935
SS
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.
050dc127 512 * Otherwise search for a file named arg.avpreset in the directories
25c27f37 513 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
6e872935
SS
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
050dc127 516 * codec_name-preset_name.avpreset in the above-mentioned directories.
6e872935
SS
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 */
525FILE *get_preset_file(char *filename, size_t filename_size,
526 const char *preset_name, int is_path, const char *codec_name);
527
dad09ff9 528/**
cac651c8 529 * Realloc array to hold new_size elements of elem_size.
5e3f9979 530 * Calls exit() on failure.
cac651c8 531 *
02e42751 532 * @param array array to reallocate
cac651c8
AK
533 * @param elem_size size in bytes of each element
534 * @param size new element count will be written here
02e42751 535 * @param new_size number of elements to place in reallocated array
cac651c8
AK
536 * @return reallocated array
537 */
538void *grow_array(void *array, int elem_size, int *size, int new_size);
539
e19e8aee
AK
540/**
541 * Get a string describing a media type.
542 */
543const char *media_type_string(enum AVMediaType media_type);
544
10bca661
AK
545#define GROW_ARRAY(array, nb_elems)\
546 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
547
a3ad68d3
AK
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
153382e1 566#endif /* LIBAV_CMDUTILS_H */