2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
5 * This file is part of Libav.
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.
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.
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
22 #ifndef LIBAV_CMDUTILS_H
23 #define LIBAV_CMDUTILS_H
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
33 * program name, defined by the program for show_version().
35 extern const char program_name[];
38 * program birth year, defined by the program for show_banner()
40 extern const int program_birth_year;
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;
48 * Register a program-specific cleanup routine.
50 void register_exit(void (*cb)(int ret));
53 * Wraps exit with a program-specific cleanup routine.
55 void exit_program(int ret) av_noreturn;
58 * Initialize the cmdutils option system, in particular
59 * allocate the *_opts contexts.
63 * Uninitialize the cmdutils option system, in particular
64 * free the *_opts contexts and their contents.
66 void uninit_opts(void);
69 * Trivial log callback.
70 * Only suitable for show_help and similar since it lacks prefix handling.
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
75 * Override the cpuflags mask.
77 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
80 * Fallback for options that are not explicitly handled, these will be
81 * parsed through AVOptions.
83 int opt_default(void *optctx, const char *opt, const char *arg);
86 * Set the libav* libraries log level.
88 int opt_loglevel(void *optctx, const char *opt, const char *arg);
91 * Limit the execution time.
93 int opt_timelimit(void *optctx, const char *opt, const char *arg);
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.
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
108 double parse_number_or_die(const char *context, const char *numstr, int type,
109 double min, double max);
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.
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
125 int64_t parse_time_or_die(const char *context, const char *timestr,
128 typedef struct SpecifierOpt {
129 char *specifier; /**< stream/chapter/program/... specifier */
139 typedef struct OptionDef {
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
166 int (*func_arg)(void *, const char *, const char *);
174 * Print help for all options matching specified flags.
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
182 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
183 int rej_flags, int alt_flags);
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" }, \
206 * Show help for all options with given flags in class and all its
209 void show_help_children(const AVClass *class, int flags);
212 * Per-avtool specific help handler. Implemented in each
213 * avtool, called by show_help().
215 void show_help_default(const char *opt, const char *arg);
218 * Generic -h handler common to all avtools.
220 int show_help(void *optctx, const char *opt, const char *arg);
223 * Parse the command line arguments.
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.
234 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
235 void (* parse_arg_function)(void *optctx, const char*));
238 * Parse one given option.
240 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
242 int parse_option(void *optctx, const char *opt, const char *arg,
243 const OptionDef *options);
246 * An option extracted from the commandline.
247 * Cannot use AVDictionary because of options like -map which can be
248 * used multiple times.
250 typedef struct Option {
251 const OptionDef *opt;
256 typedef struct OptionGroupDef {
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)
265 * Option flags that must be set on each option that is
266 * applied to this group
271 typedef struct OptionGroup {
272 const OptionGroupDef *group_def;
278 AVDictionary *codec_opts;
279 AVDictionary *format_opts;
280 AVDictionary *resample_opts;
281 struct SwsContext *sws_opts;
285 * A list of option groups that all have the same group type
286 * (e.g. input files or output files)
288 typedef struct OptionGroupList {
289 const OptionGroupDef *group_def;
295 typedef struct OptionParseContext {
296 OptionGroup global_opts;
298 OptionGroupList *groups;
302 OptionGroup cur_group;
303 } OptionParseContext;
306 * Parse an options group and write results into optctx.
308 * @param optctx an app-specific options context. NULL for global options group
310 int parse_optgroup(void *optctx, OptionGroup *g);
313 * Split the commandline into an intermediate form convenient for further
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
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.
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.
330 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
331 const OptionDef *options,
332 const OptionGroupDef *groups, int nb_groups);
335 * Free all allocated memory in an OptionParseContext.
337 void uninit_parse_context(OptionParseContext *octx);
340 * Find the '-loglevel' option in the command line args and apply it.
342 void parse_loglevel(int argc, char **argv, const OptionDef *options);
345 * Return index of option opt in argv or 0 if not found.
347 int locate_option(int argc, char **argv, const OptionDef *options,
348 const char *optname);
351 * Check if the given stream matches a stream specifier.
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.
357 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
359 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
362 * Filter out options for given codec.
364 * Create a new options dictionary containing only the options from
365 * opts which apply to the codec with ID codec_id.
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
375 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
376 AVFormatContext *s, AVStream *st, AVCodec *codec);
379 * Setup AVCodecContext options for avformat_find_stream_info().
381 * Create an array of dictionaries, one dictionary for each stream
383 * Each dictionary will contain the options from codec_opts which can
384 * be applied to the corresponding stream codec context.
386 * @return pointer to the created array of dictionaries, NULL if it
389 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
390 AVDictionary *codec_opts);
393 * Print an error message to stderr, indicating filename and a human
394 * readable description of the error code err.
396 * If strerror_r() is not available the use of this function in a
397 * multithreaded application may be unsafe.
401 void print_error(const char *filename, int err);
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
408 void show_banner(void);
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*
415 int show_version(void *optctx, const char *opt, const char *arg);
418 * Print the license of the program to stdout. The license depends on
419 * the license of the libraries compiled into the program.
421 int show_license(void *optctx, const char *opt, const char *arg);
424 * Print a listing containing all the formats supported by the
427 int show_formats(void *optctx, const char *opt, const char *arg);
430 * Print a listing containing all the codecs supported by the
433 int show_codecs(void *optctx, const char *opt, const char *arg);
436 * Print a listing containing all the decoders supported by the
439 int show_decoders(void *optctx, const char *opt, const char *arg);
442 * Print a listing containing all the encoders supported by the
445 int show_encoders(void *optctx, const char *opt, const char *arg);
448 * Print a listing containing all the filters supported by the
451 int show_filters(void *optctx, const char *opt, const char *arg);
454 * Print a listing containing all the bit stream filters supported by the
457 int show_bsfs(void *optctx, const char *opt, const char *arg);
460 * Print a listing containing all the protocols supported by the
463 int show_protocols(void *optctx, const char *opt, const char *arg);
466 * Print a listing containing all the pixel formats supported by the
469 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
472 * Print a listing containing all the sample formats supported by the
475 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
478 * Return a positive value if a line read from standard input
479 * starts with [yY], otherwise return 0.
481 int read_yesno(void);
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;
491 * Reset the state of the PtsCorrectionContext.
493 void init_pts_correction(PtsCorrectionContext *ctx);
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.
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
506 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
509 * Get a file corresponding to a preset file.
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.
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
525 FILE *get_preset_file(char *filename, size_t filename_size,
526 const char *preset_name, int is_path, const char *codec_name);
529 * Realloc array to hold new_size elements of elem_size.
530 * Calls exit() on failure.
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
538 void *grow_array(void *array, int elem_size, int *size, int new_size);
541 * Get a string describing a media type.
543 const char *media_type_string(enum AVMediaType media_type);
545 #define GROW_ARRAY(array, nb_elems)\
546 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
548 #define GET_PIX_FMT_NAME(pix_fmt)\
549 const char *name = av_get_pix_fmt_name(pix_fmt);
551 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
552 const char *name = av_get_sample_fmt_name(sample_fmt)
554 #define GET_SAMPLE_RATE_NAME(rate)\
556 snprintf(name, sizeof(name), "%d", rate);
558 #define GET_CH_LAYOUT_NAME(ch_layout)\
560 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
562 #define GET_CH_LAYOUT_DESC(ch_layout)\
564 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
566 #endif /* LIBAV_CMDUTILS_H */