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