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 * Initialize the cmdutils option system, in particular
49 * allocate the *_opts contexts.
53 * Uninitialize the cmdutils option system, in particular
54 * free the *_opts contexts and their contents.
56 void uninit_opts(void);
59 * Trivial log callback.
60 * Only suitable for show_help and similar since it lacks prefix handling.
62 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
65 * Fallback for options that are not explicitly handled, these will be
66 * parsed through AVOptions.
68 int opt_default(void *optctx, const char *opt, const char *arg);
71 * Set the libav* libraries log level.
73 int opt_loglevel(void *optctx, const char *opt, const char *arg);
76 * Limit the execution time.
78 int opt_timelimit(void *optctx, const char *opt, const char *arg);
81 * Parse a string and return its corresponding value as a double.
82 * Exit from the application if the string cannot be correctly
83 * parsed or the corresponding value is invalid.
85 * @param context the context of the value to be set (e.g. the
86 * corresponding command line option name)
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
90 * @param min the minimum valid accepted value
91 * @param max the maximum valid accepted value
93 double parse_number_or_die(const char *context, const char *numstr, int type,
94 double min, double max);
97 * Parse a string specifying a time and return its corresponding
98 * value as a number of microseconds. Exit from the application if
99 * the string cannot be correctly parsed.
101 * @param context the context of the value to be set (e.g. the
102 * corresponding command line option name)
103 * @param timestr the string to be parsed
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
110 int64_t parse_time_or_die(const char *context, const char *timestr,
113 typedef struct SpecifierOpt {
114 char *specifier; /**< stream/chapter/program/... specifier */
124 typedef struct OptionDef {
127 #define HAS_ARG 0x0001
128 #define OPT_BOOL 0x0002
129 #define OPT_EXPERT 0x0004
130 #define OPT_STRING 0x0008
131 #define OPT_VIDEO 0x0010
132 #define OPT_AUDIO 0x0020
133 #define OPT_INT 0x0080
134 #define OPT_FLOAT 0x0100
135 #define OPT_SUBTITLE 0x0200
136 #define OPT_INT64 0x0400
137 #define OPT_EXIT 0x0800
138 #define OPT_DATA 0x1000
139 #define OPT_PERFILE 0x2000 /* the option is per-file (currently avconv-only).
140 implied by OPT_OFFSET or OPT_SPEC */
141 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
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. */
145 #define OPT_TIME 0x10000
146 #define OPT_DOUBLE 0x20000
147 #define OPT_INPUT 0x40000
148 #define OPT_OUTPUT 0x80000
151 int (*func_arg)(void *, const char *, const char *);
159 * Print help for all options matching specified flags.
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.
165 * @param alt_flags print only options that have at least one of those flags set
167 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
168 int rej_flags, int alt_flags);
171 * Show help for all options with given flags in class and all its
174 void show_help_children(const AVClass *class, int flags);
177 * Per-avtool specific help handler. Implemented in each
178 * avtool, called by show_help().
180 void show_help_default(const char *opt, const char *arg);
183 * Generic -h handler common to all avtools.
185 int show_help(void *optctx, const char *opt, const char *arg);
188 * Parse the command line arguments.
190 * @param optctx an opaque options context
191 * @param argc number of command line arguments
192 * @param argv values of command line arguments
193 * @param options Array with the definitions required to interpret every
194 * option of the form: -option_name [argument]
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.
199 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
200 void (* parse_arg_function)(void *optctx, const char*));
203 * Parse one given option.
205 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
207 int parse_option(void *optctx, const char *opt, const char *arg,
208 const OptionDef *options);
211 * An option extracted from the commandline.
212 * Cannot use AVDictionary because of options like -map which can be
213 * used multiple times.
215 typedef struct Option {
216 const OptionDef *opt;
221 typedef struct OptionGroupDef {
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)
230 * Option flags that must be set on each option that is
231 * applied to this group
236 typedef struct OptionGroup {
237 const OptionGroupDef *group_def;
243 AVDictionary *codec_opts;
244 AVDictionary *format_opts;
245 AVDictionary *resample_opts;
246 struct SwsContext *sws_opts;
250 * A list of option groups that all have the same group type
251 * (e.g. input files or output files)
253 typedef struct OptionGroupList {
254 const OptionGroupDef *group_def;
260 typedef struct OptionParseContext {
261 OptionGroup global_opts;
263 OptionGroupList *groups;
267 OptionGroup cur_group;
268 } OptionParseContext;
271 * Parse an options group and write results into optctx.
273 * @param optctx an app-specific options context. NULL for global options group
275 int parse_optgroup(void *optctx, OptionGroup *g);
278 * Split the commandline into an intermediate form convenient for further
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
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.
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.
295 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
296 const OptionDef *options,
297 const OptionGroupDef *groups, int nb_groups);
300 * Free all allocated memory in an OptionParseContext.
302 void uninit_parse_context(OptionParseContext *octx);
305 * Find the '-loglevel' option in the command line args and apply it.
307 void parse_loglevel(int argc, char **argv, const OptionDef *options);
310 * Return index of option opt in argv or 0 if not found.
312 int locate_option(int argc, char **argv, const OptionDef *options,
313 const char *optname);
316 * Check if the given stream matches a stream specifier.
318 * @param s Corresponding format context.
319 * @param st Stream from s to be checked.
320 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
322 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
324 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
327 * Filter out options for given codec.
329 * Create a new options dictionary containing only the options from
330 * opts which apply to the codec with ID codec_id.
332 * @param opts dictionary to place options in
333 * @param codec_id ID of the codec that should be filtered for
334 * @param s Corresponding format context.
335 * @param st A stream from s for which the options should be filtered.
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.
338 * @return a pointer to the created dictionary
340 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
341 AVFormatContext *s, AVStream *st, AVCodec *codec);
344 * Setup AVCodecContext options for avformat_find_stream_info().
346 * Create an array of dictionaries, one dictionary for each stream
348 * Each dictionary will contain the options from codec_opts which can
349 * be applied to the corresponding stream codec context.
351 * @return pointer to the created array of dictionaries, NULL if it
354 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
355 AVDictionary *codec_opts);
358 * Print an error message to stderr, indicating filename and a human
359 * readable description of the error code err.
361 * If strerror_r() is not available the use of this function in a
362 * multithreaded application may be unsafe.
366 void print_error(const char *filename, int err);
369 * Print the program banner to stderr. The banner contents depend on the
370 * current version of the repository and of the libav* libraries used by
373 void show_banner(void);
376 * Print the version of the program to stdout. The version message
377 * depends on the current versions of the repository and of the libav*
380 int show_version(void *optctx, const char *opt, const char *arg);
383 * Print the license of the program to stdout. The license depends on
384 * the license of the libraries compiled into the program.
386 int show_license(void *optctx, const char *opt, const char *arg);
389 * Print a listing containing all the formats supported by the
392 int show_formats(void *optctx, const char *opt, const char *arg);
395 * Print a listing containing all the codecs supported by the
398 int show_codecs(void *optctx, const char *opt, const char *arg);
401 * Print a listing containing all the decoders supported by the
404 int show_decoders(void *optctx, const char *opt, const char *arg);
407 * Print a listing containing all the encoders supported by the
410 int show_encoders(void *optctx, const char *opt, const char *arg);
413 * Print a listing containing all the filters supported by the
416 int show_filters(void *optctx, const char *opt, const char *arg);
419 * Print a listing containing all the bit stream filters supported by the
422 int show_bsfs(void *optctx, const char *opt, const char *arg);
425 * Print a listing containing all the protocols supported by the
428 int show_protocols(void *optctx, const char *opt, const char *arg);
431 * Print a listing containing all the pixel formats supported by the
434 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
437 * Print a listing containing all the sample formats supported by the
440 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
443 * Return a positive value if a line read from standard input
444 * starts with [yY], otherwise return 0.
446 int read_yesno(void);
449 * Read the file with name filename, and put its content in a newly
450 * allocated 0-terminated buffer.
452 * @param filename file to read from
453 * @param bufptr location where pointer to buffer is returned
454 * @param size location where size of buffer is returned
455 * @return 0 in case of success, a negative value corresponding to an
456 * AVERROR error code in case of failure.
458 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
460 typedef struct PtsCorrectionContext {
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;
468 * Reset the state of the PtsCorrectionContext.
470 void init_pts_correction(PtsCorrectionContext *ctx);
473 * Attempt to guess proper monotonic timestamps for decoded video frames
474 * which might have incorrect times. Input timestamps may wrap around, in
475 * which case the output will as well.
477 * @param ctx the PtsCorrectionContext carrying stream pts information
478 * @param pts the pts field of the decoded AVPacket, as passed through
479 * AVCodecContext.reordered_opaque
480 * @param dts the dts field of the decoded AVPacket
481 * @return one of the input values, may be AV_NOPTS_VALUE
483 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
486 * Get a file corresponding to a preset file.
488 * If is_path is non-zero, look for the file in the path preset_name.
489 * Otherwise search for a file named arg.avpreset in the directories
490 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
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
493 * codec_name-preset_name.avpreset in the above-mentioned directories.
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
502 FILE *get_preset_file(char *filename, size_t filename_size,
503 const char *preset_name, int is_path, const char *codec_name);
506 * Realloc array to hold new_size elements of elem_size.
507 * Calls exit() on failure.
509 * @param array array to reallocate
510 * @param elem_size size in bytes of each element
511 * @param size new element count will be written here
512 * @param new_size number of elements to place in reallocated array
513 * @return reallocated array
515 void *grow_array(void *array, int elem_size, int *size, int new_size);
518 * Get a string describing a media type.
520 const char *media_type_string(enum AVMediaType media_type);
522 #define GROW_ARRAY(array, nb_elems)\
523 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
525 #define GET_PIX_FMT_NAME(pix_fmt)\
526 const char *name = av_get_pix_fmt_name(pix_fmt);
528 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
529 const char *name = av_get_sample_fmt_name(sample_fmt)
531 #define GET_SAMPLE_RATE_NAME(rate)\
533 snprintf(name, sizeof(name), "%d", rate);
535 #define GET_CH_LAYOUT_NAME(ch_layout)\
537 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
539 #define GET_CH_LAYOUT_DESC(ch_layout)\
541 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
543 #endif /* LIBAV_CMDUTILS_H */