2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef FFMPEG_CMDUTILS_H
23 #define FFMPEG_CMDUTILS_H
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
33 #undef main /* We don't want SDL to override our main() */
37 * program name, defined by the program for show_version().
39 extern const char program_name[];
42 * program birth year, defined by the program for show_banner()
44 extern const int program_birth_year;
46 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
47 extern AVFormatContext *avformat_opts;
48 extern struct SwsContext *sws_opts;
49 extern AVDictionary *swr_opts;
50 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
53 * Register a program-specific cleanup routine.
55 void register_exit(void (*cb)(int ret));
58 * Wraps exit with a program-specific cleanup routine.
60 void exit_program(int ret);
63 * Initialize the cmdutils option system, in particular
64 * allocate the *_opts contexts.
68 * Uninitialize the cmdutils option system, in particular
69 * free the *_opts contexts and their contents.
71 void uninit_opts(void);
74 * Trivial log callback.
75 * Only suitable for opt_help and similar since it lacks prefix handling.
77 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
80 * Override the cpuflags.
82 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
85 * Fallback for options that are not explicitly handled, these will be
86 * parsed through AVOptions.
88 int opt_default(void *optctx, const char *opt, const char *arg);
91 * Set the libav* libraries log level.
93 int opt_loglevel(void *optctx, const char *opt, const char *arg);
95 int opt_report(const char *opt);
97 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
99 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
101 int opt_opencl(void *optctx, const char *opt, const char *arg);
104 * Limit the execution time.
106 int opt_timelimit(void *optctx, const char *opt, const char *arg);
109 * Parse a string and return its corresponding value as a double.
110 * Exit from the application if the string cannot be correctly
111 * parsed or the corresponding value is invalid.
113 * @param context the context of the value to be set (e.g. the
114 * corresponding command line option name)
115 * @param numstr the string to be parsed
116 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
117 * string should be parsed
118 * @param min the minimum valid accepted value
119 * @param max the maximum valid accepted value
121 double parse_number_or_die(const char *context, const char *numstr, int type,
122 double min, double max);
125 * Parse a string specifying a time and return its corresponding
126 * value as a number of microseconds. Exit from the application if
127 * the string cannot be correctly parsed.
129 * @param context the context of the value to be set (e.g. the
130 * corresponding command line option name)
131 * @param timestr the string to be parsed
132 * @param is_duration a flag which tells how to interpret timestr, if
133 * not zero timestr is interpreted as a duration, otherwise as a
136 * @see av_parse_time()
138 int64_t parse_time_or_die(const char *context, const char *timestr,
141 typedef struct SpecifierOpt {
142 char *specifier; /**< stream/chapter/program/... specifier */
152 typedef struct OptionDef {
155 #define HAS_ARG 0x0001
156 #define OPT_BOOL 0x0002
157 #define OPT_EXPERT 0x0004
158 #define OPT_STRING 0x0008
159 #define OPT_VIDEO 0x0010
160 #define OPT_AUDIO 0x0020
161 #define OPT_INT 0x0080
162 #define OPT_FLOAT 0x0100
163 #define OPT_SUBTITLE 0x0200
164 #define OPT_INT64 0x0400
165 #define OPT_EXIT 0x0800
166 #define OPT_DATA 0x1000
167 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
168 implied by OPT_OFFSET or OPT_SPEC */
169 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
170 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
171 Implies OPT_OFFSET. Next element after the offset is
172 an int containing element count in the array. */
173 #define OPT_TIME 0x10000
174 #define OPT_DOUBLE 0x20000
175 #define OPT_INPUT 0x40000
176 #define OPT_OUTPUT 0x80000
179 int (*func_arg)(void *, const char *, const char *);
187 * Print help for all options matching specified flags.
189 * @param options a list of options
190 * @param msg title of this group. Only printed if at least one option matches.
191 * @param req_flags print only options which have all those flags set.
192 * @param rej_flags don't print options which have any of those flags set.
193 * @param alt_flags print only options that have at least one of those flags set
195 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
196 int rej_flags, int alt_flags);
199 * Show help for all options with given flags in class and all its
202 void show_help_children(const AVClass *class, int flags);
205 * Per-fftool specific help handler. Implemented in each
206 * fftool, called by show_help().
208 void show_help_default(const char *opt, const char *arg);
211 * Generic -h handler common to all fftools.
213 int show_help(void *optctx, const char *opt, const char *arg);
216 * Parse the command line arguments.
218 * @param optctx an opaque options context
219 * @param argc number of command line arguments
220 * @param argv values of command line arguments
221 * @param options Array with the definitions required to interpret every
222 * option of the form: -option_name [argument]
223 * @param parse_arg_function Name of the function called to process every
224 * argument without a leading option name flag. NULL if such arguments do
225 * not have to be processed.
227 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
228 void (* parse_arg_function)(void *optctx, const char*));
231 * Parse one given option.
233 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
235 int parse_option(void *optctx, const char *opt, const char *arg,
236 const OptionDef *options);
239 * An option extracted from the commandline.
240 * Cannot use AVDictionary because of options like -map which can be
241 * used multiple times.
243 typedef struct Option {
244 const OptionDef *opt;
249 typedef struct OptionGroupDef {
253 * Option to be used as group separator. Can be NULL for groups which
254 * are terminated by a non-option argument (e.g. ffmpeg output files)
258 * Option flags that must be set on each option that is
259 * applied to this group
264 typedef struct OptionGroup {
265 const OptionGroupDef *group_def;
271 AVDictionary *codec_opts;
272 AVDictionary *format_opts;
273 AVDictionary *resample_opts;
274 struct SwsContext *sws_opts;
275 AVDictionary *swr_opts;
279 * A list of option groups that all have the same group type
280 * (e.g. input files or output files)
282 typedef struct OptionGroupList {
283 const OptionGroupDef *group_def;
289 typedef struct OptionParseContext {
290 OptionGroup global_opts;
292 OptionGroupList *groups;
296 OptionGroup cur_group;
297 } OptionParseContext;
300 * Parse an options group and write results into optctx.
302 * @param optctx an app-specific options context. NULL for global options group
304 int parse_optgroup(void *optctx, OptionGroup *g);
307 * Split the commandline into an intermediate form convenient for further
310 * The commandline is assumed to be composed of options which either belong to a
311 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
314 * A group (defined by an OptionGroupDef struct) is a sequence of options
315 * terminated by either a group separator option (e.g. -i) or a parameter that
316 * is not an option (doesn't start with -). A group without a separator option
317 * must always be first in the supplied groups list.
319 * All options within the same group are stored in one OptionGroup struct in an
320 * OptionGroupList, all groups with the same group definition are stored in one
321 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
322 * same as the order of group definitions.
324 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
325 const OptionDef *options,
326 const OptionGroupDef *groups, int nb_groups);
329 * Free all allocated memory in an OptionParseContext.
331 void uninit_parse_context(OptionParseContext *octx);
334 * Find the '-loglevel' option in the command line args and apply it.
336 void parse_loglevel(int argc, char **argv, const OptionDef *options);
339 * Return index of option opt in argv or 0 if not found.
341 int locate_option(int argc, char **argv, const OptionDef *options,
342 const char *optname);
345 * Check if the given stream matches a stream specifier.
347 * @param s Corresponding format context.
348 * @param st Stream from s to be checked.
349 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
351 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
353 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
356 * Filter out options for given codec.
358 * Create a new options dictionary containing only the options from
359 * opts which apply to the codec with ID codec_id.
361 * @param opts dictionary to place options in
362 * @param codec_id ID of the codec that should be filtered for
363 * @param s Corresponding format context.
364 * @param st A stream from s for which the options should be filtered.
365 * @param codec The particular codec for which the options should be filtered.
366 * If null, the default one is looked up according to the codec id.
367 * @return a pointer to the created dictionary
369 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
370 AVFormatContext *s, AVStream *st, AVCodec *codec);
373 * Setup AVCodecContext options for avformat_find_stream_info().
375 * Create an array of dictionaries, one dictionary for each stream
377 * Each dictionary will contain the options from codec_opts which can
378 * be applied to the corresponding stream codec context.
380 * @return pointer to the created array of dictionaries, NULL if it
383 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
384 AVDictionary *codec_opts);
387 * Print an error message to stderr, indicating filename and a human
388 * readable description of the error code err.
390 * If strerror_r() is not available the use of this function in a
391 * multithreaded application may be unsafe.
395 void print_error(const char *filename, int err);
398 * Print the program banner to stderr. The banner contents depend on the
399 * current version of the repository and of the libav* libraries used by
402 void show_banner(int argc, char **argv, const OptionDef *options);
405 * Print the version of the program to stdout. The version message
406 * depends on the current versions of the repository and of the libav*
408 * This option processing function does not utilize the arguments.
410 int show_version(void *optctx, const char *opt, const char *arg);
413 * Print the build configuration of the program to stdout. The contents
414 * depend on the definition of FFMPEG_CONFIGURATION.
415 * This option processing function does not utilize the arguments.
417 int show_buildconf(void *optctx, const char *opt, const char *arg);
420 * Print the license of the program to stdout. The license depends on
421 * the license of the libraries compiled into the program.
422 * This option processing function does not utilize the arguments.
424 int show_license(void *optctx, const char *opt, const char *arg);
427 * Print a listing containing all the formats supported by the
429 * This option processing function does not utilize the arguments.
431 int show_formats(void *optctx, const char *opt, const char *arg);
434 * Print a listing containing all the codecs supported by the
436 * This option processing function does not utilize the arguments.
438 int show_codecs(void *optctx, const char *opt, const char *arg);
441 * Print a listing containing all the decoders supported by the
444 int show_decoders(void *optctx, const char *opt, const char *arg);
447 * Print a listing containing all the encoders supported by the
450 int show_encoders(void *optctx, const char *opt, const char *arg);
453 * Print a listing containing all the filters supported by the
455 * This option processing function does not utilize the arguments.
457 int show_filters(void *optctx, const char *opt, const char *arg);
460 * Print a listing containing all the bit stream filters supported by the
462 * This option processing function does not utilize the arguments.
464 int show_bsfs(void *optctx, const char *opt, const char *arg);
467 * Print a listing containing all the protocols supported by the
469 * This option processing function does not utilize the arguments.
471 int show_protocols(void *optctx, const char *opt, const char *arg);
474 * Print a listing containing all the pixel formats supported by the
476 * This option processing function does not utilize the arguments.
478 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
481 * Print a listing containing all the standard channel layouts supported by
483 * This option processing function does not utilize the arguments.
485 int show_layouts(void *optctx, const char *opt, const char *arg);
488 * Print a listing containing all the sample formats supported by the
491 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
494 * Print a listing containing all the color names and values recognized
497 int show_colors(void *optctx, const char *opt, const char *arg);
500 * Return a positive value if a line read from standard input
501 * starts with [yY], otherwise return 0.
503 int read_yesno(void);
506 * Read the file with name filename, and put its content in a newly
507 * allocated 0-terminated buffer.
509 * @param filename file to read from
510 * @param bufptr location where pointer to buffer is returned
511 * @param size location where size of buffer is returned
512 * @return >= 0 in case of success, a negative value corresponding to an
513 * AVERROR error code in case of failure.
515 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
518 * Get a file corresponding to a preset file.
520 * If is_path is non-zero, look for the file in the path preset_name.
521 * Otherwise search for a file named arg.ffpreset in the directories
522 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
523 * at configuration time or in a "ffpresets" folder along the executable
524 * on win32, in that order. If no such file is found and
525 * codec_name is defined, then search for a file named
526 * codec_name-preset_name.avpreset in the above-mentioned directories.
528 * @param filename buffer where the name of the found filename is written
529 * @param filename_size size in bytes of the filename buffer
530 * @param preset_name name of the preset to search
531 * @param is_path tell if preset_name is a filename path
532 * @param codec_name name of the codec for which to look for the
533 * preset, may be NULL
535 FILE *get_preset_file(char *filename, size_t filename_size,
536 const char *preset_name, int is_path, const char *codec_name);
539 * Realloc array to hold new_size elements of elem_size.
540 * Calls exit() on failure.
542 * @param array array to reallocate
543 * @param elem_size size in bytes of each element
544 * @param size new element count will be written here
545 * @param new_size number of elements to place in reallocated array
546 * @return reallocated array
548 void *grow_array(void *array, int elem_size, int *size, int new_size);
550 #define media_type_string av_get_media_type_string
552 #define GROW_ARRAY(array, nb_elems)\
553 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
555 #define GET_PIX_FMT_NAME(pix_fmt)\
556 const char *name = av_get_pix_fmt_name(pix_fmt);
558 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
559 const char *name = av_get_sample_fmt_name(sample_fmt)
561 #define GET_SAMPLE_RATE_NAME(rate)\
563 snprintf(name, sizeof(name), "%d", rate);
565 #define GET_CH_LAYOUT_NAME(ch_layout)\
567 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
569 #define GET_CH_LAYOUT_DESC(ch_layout)\
571 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
573 #endif /* CMDUTILS_H */