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
28 #include "libavcodec/avcodec.h"
29 #include "libavfilter/avfilter.h"
30 #include "libavformat/avformat.h"
31 #include "libswscale/swscale.h"
34 #undef main /* We don't want SDL to override our main() */
38 * program name, defined by the program for show_version().
40 extern const char program_name[];
43 * program birth year, defined by the program for show_banner()
45 extern const int program_birth_year;
47 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
48 extern AVFormatContext *avformat_opts;
49 extern AVDictionary *sws_dict;
50 extern AVDictionary *swr_opts;
51 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
52 extern int hide_banner;
55 * Register a program-specific cleanup routine.
57 void register_exit(void (*cb)(int ret));
60 * Wraps exit with a program-specific cleanup routine.
62 void exit_program(int ret) av_noreturn;
65 * Initialize dynamic library loading
67 void init_dynload(void);
70 * Initialize the cmdutils option system, in particular
71 * allocate the *_opts contexts.
75 * Uninitialize the cmdutils option system, in particular
76 * free the *_opts contexts and their contents.
78 void uninit_opts(void);
81 * Trivial log callback.
82 * Only suitable for opt_help and similar since it lacks prefix handling.
84 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
87 * Override the cpuflags.
89 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
92 * Fallback for options that are not explicitly handled, these will be
93 * parsed through AVOptions.
95 int opt_default(void *optctx, const char *opt, const char *arg);
98 * Set the libav* libraries log level.
100 int opt_loglevel(void *optctx, const char *opt, const char *arg);
102 int opt_report(const char *opt);
104 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
106 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
109 int opt_opencl(void *optctx, const char *opt, const char *arg);
111 int opt_opencl_bench(void *optctx, const char *opt, const char *arg);
115 * Limit the execution time.
117 int opt_timelimit(void *optctx, const char *opt, const char *arg);
120 * Parse a string and return its corresponding value as a double.
121 * Exit from the application if the string cannot be correctly
122 * parsed or the corresponding value is invalid.
124 * @param context the context of the value to be set (e.g. the
125 * corresponding command line option name)
126 * @param numstr the string to be parsed
127 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
128 * string should be parsed
129 * @param min the minimum valid accepted value
130 * @param max the maximum valid accepted value
132 double parse_number_or_die(const char *context, const char *numstr, int type,
133 double min, double max);
136 * Parse a string specifying a time and return its corresponding
137 * value as a number of microseconds. Exit from the application if
138 * the string cannot be correctly parsed.
140 * @param context the context of the value to be set (e.g. the
141 * corresponding command line option name)
142 * @param timestr the string to be parsed
143 * @param is_duration a flag which tells how to interpret timestr, if
144 * not zero timestr is interpreted as a duration, otherwise as a
147 * @see av_parse_time()
149 int64_t parse_time_or_die(const char *context, const char *timestr,
152 typedef struct SpecifierOpt {
153 char *specifier; /**< stream/chapter/program/... specifier */
163 typedef struct OptionDef {
166 #define HAS_ARG 0x0001
167 #define OPT_BOOL 0x0002
168 #define OPT_EXPERT 0x0004
169 #define OPT_STRING 0x0008
170 #define OPT_VIDEO 0x0010
171 #define OPT_AUDIO 0x0020
172 #define OPT_INT 0x0080
173 #define OPT_FLOAT 0x0100
174 #define OPT_SUBTITLE 0x0200
175 #define OPT_INT64 0x0400
176 #define OPT_EXIT 0x0800
177 #define OPT_DATA 0x1000
178 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
179 implied by OPT_OFFSET or OPT_SPEC */
180 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
181 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
182 Implies OPT_OFFSET. Next element after the offset is
183 an int containing element count in the array. */
184 #define OPT_TIME 0x10000
185 #define OPT_DOUBLE 0x20000
186 #define OPT_INPUT 0x40000
187 #define OPT_OUTPUT 0x80000
190 int (*func_arg)(void *, const char *, const char *);
198 * Print help for all options matching specified flags.
200 * @param options a list of options
201 * @param msg title of this group. Only printed if at least one option matches.
202 * @param req_flags print only options which have all those flags set.
203 * @param rej_flags don't print options which have any of those flags set.
204 * @param alt_flags print only options that have at least one of those flags set
206 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
207 int rej_flags, int alt_flags);
210 #define CMDUTILS_COMMON_OPTIONS_OPENCL \
211 { "opencl_bench", OPT_EXIT, {.func_arg = opt_opencl_bench}, \
212 "run benchmark on all OpenCL devices and show results" }, \
213 { "opencl_options", HAS_ARG, {.func_arg = opt_opencl}, \
214 "set OpenCL environment options" }, \
217 #define CMDUTILS_COMMON_OPTIONS_OPENCL
221 #define CMDUTILS_COMMON_OPTIONS_AVDEVICE \
222 { "sources" , OPT_EXIT | HAS_ARG, { .func_arg = show_sources }, \
223 "list sources of the input device", "device" }, \
224 { "sinks" , OPT_EXIT | HAS_ARG, { .func_arg = show_sinks }, \
225 "list sinks of the output device", "device" }, \
228 #define CMDUTILS_COMMON_OPTIONS_AVDEVICE
231 #define CMDUTILS_COMMON_OPTIONS \
232 { "L", OPT_EXIT, { .func_arg = show_license }, "show license" }, \
233 { "h", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
234 { "?", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
235 { "help", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
236 { "-help", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
237 { "version", OPT_EXIT, { .func_arg = show_version }, "show version" }, \
238 { "buildconf", OPT_EXIT, { .func_arg = show_buildconf }, "show build configuration" }, \
239 { "formats", OPT_EXIT, { .func_arg = show_formats }, "show available formats" }, \
240 { "muxers", OPT_EXIT, { .func_arg = show_muxers }, "show available muxers" }, \
241 { "demuxers", OPT_EXIT, { .func_arg = show_demuxers }, "show available demuxers" }, \
242 { "devices", OPT_EXIT, { .func_arg = show_devices }, "show available devices" }, \
243 { "codecs", OPT_EXIT, { .func_arg = show_codecs }, "show available codecs" }, \
244 { "decoders", OPT_EXIT, { .func_arg = show_decoders }, "show available decoders" }, \
245 { "encoders", OPT_EXIT, { .func_arg = show_encoders }, "show available encoders" }, \
246 { "bsfs", OPT_EXIT, { .func_arg = show_bsfs }, "show available bit stream filters" }, \
247 { "protocols", OPT_EXIT, { .func_arg = show_protocols }, "show available protocols" }, \
248 { "filters", OPT_EXIT, { .func_arg = show_filters }, "show available filters" }, \
249 { "pix_fmts", OPT_EXIT, { .func_arg = show_pix_fmts }, "show available pixel formats" }, \
250 { "layouts", OPT_EXIT, { .func_arg = show_layouts }, "show standard channel layouts" }, \
251 { "sample_fmts", OPT_EXIT, { .func_arg = show_sample_fmts }, "show available audio sample formats" }, \
252 { "colors", OPT_EXIT, { .func_arg = show_colors }, "show available color names" }, \
253 { "loglevel", HAS_ARG, { .func_arg = opt_loglevel }, "set logging level", "loglevel" }, \
254 { "v", HAS_ARG, { .func_arg = opt_loglevel }, "set logging level", "loglevel" }, \
255 { "report", 0, { (void*)opt_report }, "generate a report" }, \
256 { "max_alloc", HAS_ARG, { .func_arg = opt_max_alloc }, "set maximum size of a single allocated block", "bytes" }, \
257 { "cpuflags", HAS_ARG | OPT_EXPERT, { .func_arg = opt_cpuflags }, "force specific cpu flags", "flags" }, \
258 { "hide_banner", OPT_BOOL | OPT_EXPERT, {&hide_banner}, "do not show program banner", "hide_banner" }, \
259 CMDUTILS_COMMON_OPTIONS_OPENCL \
260 CMDUTILS_COMMON_OPTIONS_AVDEVICE \
263 * Show help for all options with given flags in class and all its
266 void show_help_children(const AVClass *class, int flags);
269 * Per-fftool specific help handler. Implemented in each
270 * fftool, called by show_help().
272 void show_help_default(const char *opt, const char *arg);
275 * Generic -h handler common to all fftools.
277 int show_help(void *optctx, const char *opt, const char *arg);
280 * Parse the command line arguments.
282 * @param optctx an opaque options context
283 * @param argc number of command line arguments
284 * @param argv values of command line arguments
285 * @param options Array with the definitions required to interpret every
286 * option of the form: -option_name [argument]
287 * @param parse_arg_function Name of the function called to process every
288 * argument without a leading option name flag. NULL if such arguments do
289 * not have to be processed.
291 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
292 void (* parse_arg_function)(void *optctx, const char*));
295 * Parse one given option.
297 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
299 int parse_option(void *optctx, const char *opt, const char *arg,
300 const OptionDef *options);
303 * An option extracted from the commandline.
304 * Cannot use AVDictionary because of options like -map which can be
305 * used multiple times.
307 typedef struct Option {
308 const OptionDef *opt;
313 typedef struct OptionGroupDef {
317 * Option to be used as group separator. Can be NULL for groups which
318 * are terminated by a non-option argument (e.g. ffmpeg output files)
322 * Option flags that must be set on each option that is
323 * applied to this group
328 typedef struct OptionGroup {
329 const OptionGroupDef *group_def;
335 AVDictionary *codec_opts;
336 AVDictionary *format_opts;
337 AVDictionary *resample_opts;
338 AVDictionary *sws_dict;
339 AVDictionary *swr_opts;
343 * A list of option groups that all have the same group type
344 * (e.g. input files or output files)
346 typedef struct OptionGroupList {
347 const OptionGroupDef *group_def;
353 typedef struct OptionParseContext {
354 OptionGroup global_opts;
356 OptionGroupList *groups;
360 OptionGroup cur_group;
361 } OptionParseContext;
364 * Parse an options group and write results into optctx.
366 * @param optctx an app-specific options context. NULL for global options group
368 int parse_optgroup(void *optctx, OptionGroup *g);
371 * Split the commandline into an intermediate form convenient for further
374 * The commandline is assumed to be composed of options which either belong to a
375 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
378 * A group (defined by an OptionGroupDef struct) is a sequence of options
379 * terminated by either a group separator option (e.g. -i) or a parameter that
380 * is not an option (doesn't start with -). A group without a separator option
381 * must always be first in the supplied groups list.
383 * All options within the same group are stored in one OptionGroup struct in an
384 * OptionGroupList, all groups with the same group definition are stored in one
385 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
386 * same as the order of group definitions.
388 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
389 const OptionDef *options,
390 const OptionGroupDef *groups, int nb_groups);
393 * Free all allocated memory in an OptionParseContext.
395 void uninit_parse_context(OptionParseContext *octx);
398 * Find the '-loglevel' option in the command line args and apply it.
400 void parse_loglevel(int argc, char **argv, const OptionDef *options);
403 * Return index of option opt in argv or 0 if not found.
405 int locate_option(int argc, char **argv, const OptionDef *options,
406 const char *optname);
409 * Check if the given stream matches a stream specifier.
411 * @param s Corresponding format context.
412 * @param st Stream from s to be checked.
413 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
415 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
417 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
420 * Filter out options for given codec.
422 * Create a new options dictionary containing only the options from
423 * opts which apply to the codec with ID codec_id.
425 * @param opts dictionary to place options in
426 * @param codec_id ID of the codec that should be filtered for
427 * @param s Corresponding format context.
428 * @param st A stream from s for which the options should be filtered.
429 * @param codec The particular codec for which the options should be filtered.
430 * If null, the default one is looked up according to the codec id.
431 * @return a pointer to the created dictionary
433 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
434 AVFormatContext *s, AVStream *st, AVCodec *codec);
437 * Setup AVCodecContext options for avformat_find_stream_info().
439 * Create an array of dictionaries, one dictionary for each stream
441 * Each dictionary will contain the options from codec_opts which can
442 * be applied to the corresponding stream codec context.
444 * @return pointer to the created array of dictionaries, NULL if it
447 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
448 AVDictionary *codec_opts);
451 * Print an error message to stderr, indicating filename and a human
452 * readable description of the error code err.
454 * If strerror_r() is not available the use of this function in a
455 * multithreaded application may be unsafe.
459 void print_error(const char *filename, int err);
462 * Print the program banner to stderr. The banner contents depend on the
463 * current version of the repository and of the libav* libraries used by
466 void show_banner(int argc, char **argv, const OptionDef *options);
469 * Print the version of the program to stdout. The version message
470 * depends on the current versions of the repository and of the libav*
472 * This option processing function does not utilize the arguments.
474 int show_version(void *optctx, const char *opt, const char *arg);
477 * Print the build configuration of the program to stdout. The contents
478 * depend on the definition of FFMPEG_CONFIGURATION.
479 * This option processing function does not utilize the arguments.
481 int show_buildconf(void *optctx, const char *opt, const char *arg);
484 * Print the license of the program to stdout. The license depends on
485 * the license of the libraries compiled into the program.
486 * This option processing function does not utilize the arguments.
488 int show_license(void *optctx, const char *opt, const char *arg);
491 * Print a listing containing all the formats supported by the
492 * program (including devices).
493 * This option processing function does not utilize the arguments.
495 int show_formats(void *optctx, const char *opt, const char *arg);
498 * Print a listing containing all the muxers supported by the
499 * program (including devices).
500 * This option processing function does not utilize the arguments.
502 int show_muxers(void *optctx, const char *opt, const char *arg);
505 * Print a listing containing all the demuxer supported by the
506 * program (including devices).
507 * This option processing function does not utilize the arguments.
509 int show_demuxers(void *optctx, const char *opt, const char *arg);
512 * Print a listing containing all the devices supported by the
514 * This option processing function does not utilize the arguments.
516 int show_devices(void *optctx, const char *opt, const char *arg);
520 * Print a listing containing autodetected sinks of the output device.
521 * Device name with options may be passed as an argument to limit results.
523 int show_sinks(void *optctx, const char *opt, const char *arg);
526 * Print a listing containing autodetected sources of the input device.
527 * Device name with options may be passed as an argument to limit results.
529 int show_sources(void *optctx, const char *opt, const char *arg);
533 * Print a listing containing all the codecs supported by the
535 * This option processing function does not utilize the arguments.
537 int show_codecs(void *optctx, const char *opt, const char *arg);
540 * Print a listing containing all the decoders supported by the
543 int show_decoders(void *optctx, const char *opt, const char *arg);
546 * Print a listing containing all the encoders supported by the
549 int show_encoders(void *optctx, const char *opt, const char *arg);
552 * Print a listing containing all the filters supported by the
554 * This option processing function does not utilize the arguments.
556 int show_filters(void *optctx, const char *opt, const char *arg);
559 * Print a listing containing all the bit stream filters supported by the
561 * This option processing function does not utilize the arguments.
563 int show_bsfs(void *optctx, const char *opt, const char *arg);
566 * Print a listing containing all the protocols supported by the
568 * This option processing function does not utilize the arguments.
570 int show_protocols(void *optctx, const char *opt, const char *arg);
573 * Print a listing containing all the pixel formats supported by the
575 * This option processing function does not utilize the arguments.
577 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
580 * Print a listing containing all the standard channel layouts supported by
582 * This option processing function does not utilize the arguments.
584 int show_layouts(void *optctx, const char *opt, const char *arg);
587 * Print a listing containing all the sample formats supported by the
590 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
593 * Print a listing containing all the color names and values recognized
596 int show_colors(void *optctx, const char *opt, const char *arg);
599 * Return a positive value if a line read from standard input
600 * starts with [yY], otherwise return 0.
602 int read_yesno(void);
605 * Get a file corresponding to a preset file.
607 * If is_path is non-zero, look for the file in the path preset_name.
608 * Otherwise search for a file named arg.ffpreset in the directories
609 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
610 * at configuration time or in a "ffpresets" folder along the executable
611 * on win32, in that order. If no such file is found and
612 * codec_name is defined, then search for a file named
613 * codec_name-preset_name.avpreset in the above-mentioned directories.
615 * @param filename buffer where the name of the found filename is written
616 * @param filename_size size in bytes of the filename buffer
617 * @param preset_name name of the preset to search
618 * @param is_path tell if preset_name is a filename path
619 * @param codec_name name of the codec for which to look for the
620 * preset, may be NULL
622 FILE *get_preset_file(char *filename, size_t filename_size,
623 const char *preset_name, int is_path, const char *codec_name);
626 * Realloc array to hold new_size elements of elem_size.
627 * Calls exit() on failure.
629 * @param array array to reallocate
630 * @param elem_size size in bytes of each element
631 * @param size new element count will be written here
632 * @param new_size number of elements to place in reallocated array
633 * @return reallocated array
635 void *grow_array(void *array, int elem_size, int *size, int new_size);
637 #define media_type_string av_get_media_type_string
639 #define GROW_ARRAY(array, nb_elems)\
640 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
642 #define GET_PIX_FMT_NAME(pix_fmt)\
643 const char *name = av_get_pix_fmt_name(pix_fmt);
645 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
646 const char *name = av_get_sample_fmt_name(sample_fmt)
648 #define GET_SAMPLE_RATE_NAME(rate)\
650 snprintf(name, sizeof(name), "%d", rate);
652 #define GET_CH_LAYOUT_NAME(ch_layout)\
654 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
656 #define GET_CH_LAYOUT_DESC(ch_layout)\
658 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
660 double get_rotation(AVStream *st);
662 #endif /* CMDUTILS_H */