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;
47 * this year, defined by the program for show_banner()
49 extern const int this_year;
51 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
52 extern AVFormatContext *avformat_opts;
53 extern struct SwsContext *sws_opts;
54 extern AVDictionary *swr_opts;
55 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
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 opt_help and similar since it lacks prefix handling.
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
75 * Fallback for options that are not explicitly handled, these will be
76 * parsed through AVOptions.
78 int opt_default(void *optctx, const char *opt, const char *arg);
81 * Set the libav* libraries log level.
83 int opt_loglevel(void *optctx, const char *opt, const char *arg);
85 int opt_report(const char *opt);
87 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
89 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
91 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
94 int opt_opencl(void *optctx, const char *opt, const char *arg);
98 * Limit the execution time.
100 int opt_timelimit(void *optctx, const char *opt, const char *arg);
103 * Parse a string and return its corresponding value as a double.
104 * Exit from the application if the string cannot be correctly
105 * parsed or the corresponding value is invalid.
107 * @param context the context of the value to be set (e.g. the
108 * corresponding command line option name)
109 * @param numstr the string to be parsed
110 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
111 * string should be parsed
112 * @param min the minimum valid accepted value
113 * @param max the maximum valid accepted value
115 double parse_number_or_die(const char *context, const char *numstr, int type,
116 double min, double max);
119 * Parse a string specifying a time and return its corresponding
120 * value as a number of microseconds. Exit from the application if
121 * the string cannot be correctly parsed.
123 * @param context the context of the value to be set (e.g. the
124 * corresponding command line option name)
125 * @param timestr the string to be parsed
126 * @param is_duration a flag which tells how to interpret timestr, if
127 * not zero timestr is interpreted as a duration, otherwise as a
130 * @see av_parse_time()
132 int64_t parse_time_or_die(const char *context, const char *timestr,
135 typedef struct SpecifierOpt {
136 char *specifier; /**< stream/chapter/program/... specifier */
146 typedef struct OptionDef {
149 #define HAS_ARG 0x0001
150 #define OPT_BOOL 0x0002
151 #define OPT_EXPERT 0x0004
152 #define OPT_STRING 0x0008
153 #define OPT_VIDEO 0x0010
154 #define OPT_AUDIO 0x0020
155 #define OPT_INT 0x0080
156 #define OPT_FLOAT 0x0100
157 #define OPT_SUBTITLE 0x0200
158 #define OPT_INT64 0x0400
159 #define OPT_EXIT 0x0800
160 #define OPT_DATA 0x1000
161 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
162 implied by OPT_OFFSET or OPT_SPEC */
163 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
164 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
165 Implies OPT_OFFSET. Next element after the offset is
166 an int containing element count in the array. */
167 #define OPT_TIME 0x10000
168 #define OPT_DOUBLE 0x20000
169 #define OPT_INPUT 0x40000
170 #define OPT_OUTPUT 0x80000
173 int (*func_arg)(void *, const char *, const char *);
181 * Print help for all options matching specified flags.
183 * @param options a list of options
184 * @param msg title of this group. Only printed if at least one option matches.
185 * @param req_flags print only options which have all those flags set.
186 * @param rej_flags don't print options which have any of those flags set.
187 * @param alt_flags print only options that have at least one of those flags set
189 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
190 int rej_flags, int alt_flags);
193 * Show help for all options with given flags in class and all its
196 void show_help_children(const AVClass *class, int flags);
199 * Per-fftool specific help handler. Implemented in each
200 * fftool, called by show_help().
202 void show_help_default(const char *opt, const char *arg);
205 * Generic -h handler common to all fftools.
207 int show_help(void *optctx, const char *opt, const char *arg);
210 * Parse the command line arguments.
212 * @param optctx an opaque options context
213 * @param argc number of command line arguments
214 * @param argv values of command line arguments
215 * @param options Array with the definitions required to interpret every
216 * option of the form: -option_name [argument]
217 * @param parse_arg_function Name of the function called to process every
218 * argument without a leading option name flag. NULL if such arguments do
219 * not have to be processed.
221 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
222 void (* parse_arg_function)(void *optctx, const char*));
225 * Parse one given option.
227 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
229 int parse_option(void *optctx, const char *opt, const char *arg,
230 const OptionDef *options);
233 * An option extracted from the commandline.
234 * Cannot use AVDictionary because of options like -map which can be
235 * used multiple times.
237 typedef struct Option {
238 const OptionDef *opt;
243 typedef struct OptionGroupDef {
247 * Option to be used as group separator. Can be NULL for groups which
248 * are terminated by a non-option argument (e.g. ffmpeg output files)
252 * Option flags that must be set on each option that is
253 * applied to this group
258 typedef struct OptionGroup {
259 const OptionGroupDef *group_def;
265 AVDictionary *codec_opts;
266 AVDictionary *format_opts;
267 AVDictionary *resample_opts;
268 struct SwsContext *sws_opts;
269 AVDictionary *swr_opts;
273 * A list of option groups that all have the same group type
274 * (e.g. input files or output files)
276 typedef struct OptionGroupList {
277 const OptionGroupDef *group_def;
283 typedef struct OptionParseContext {
284 OptionGroup global_opts;
286 OptionGroupList *groups;
290 OptionGroup cur_group;
291 } OptionParseContext;
294 * Parse an options group and write results into optctx.
296 * @param optctx an app-specific options context. NULL for global options group
298 int parse_optgroup(void *optctx, OptionGroup *g);
301 * Split the commandline into an intermediate form convenient for further
304 * The commandline is assumed to be composed of options which either belong to a
305 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
308 * A group (defined by an OptionGroupDef struct) is a sequence of options
309 * terminated by either a group separator option (e.g. -i) or a parameter that
310 * is not an option (doesn't start with -). A group without a separator option
311 * must always be first in the supplied groups list.
313 * All options within the same group are stored in one OptionGroup struct in an
314 * OptionGroupList, all groups with the same group definition are stored in one
315 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
316 * same as the order of group definitions.
318 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
319 const OptionDef *options,
320 const OptionGroupDef *groups, int nb_groups);
323 * Free all allocated memory in an OptionParseContext.
325 void uninit_parse_context(OptionParseContext *octx);
328 * Find the '-loglevel' option in the command line args and apply it.
330 void parse_loglevel(int argc, char **argv, const OptionDef *options);
333 * Return index of option opt in argv or 0 if not found.
335 int locate_option(int argc, char **argv, const OptionDef *options,
336 const char *optname);
339 * Check if the given stream matches a stream specifier.
341 * @param s Corresponding format context.
342 * @param st Stream from s to be checked.
343 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
345 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
347 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
350 * Filter out options for given codec.
352 * Create a new options dictionary containing only the options from
353 * opts which apply to the codec with ID codec_id.
355 * @param opts dictionary to place options in
356 * @param codec_id ID of the codec that should be filtered for
357 * @param s Corresponding format context.
358 * @param st A stream from s for which the options should be filtered.
359 * @param codec The particular codec for which the options should be filtered.
360 * If null, the default one is looked up according to the codec id.
361 * @return a pointer to the created dictionary
363 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
364 AVFormatContext *s, AVStream *st, AVCodec *codec);
367 * Setup AVCodecContext options for avformat_find_stream_info().
369 * Create an array of dictionaries, one dictionary for each stream
371 * Each dictionary will contain the options from codec_opts which can
372 * be applied to the corresponding stream codec context.
374 * @return pointer to the created array of dictionaries, NULL if it
377 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
378 AVDictionary *codec_opts);
381 * Print an error message to stderr, indicating filename and a human
382 * readable description of the error code err.
384 * If strerror_r() is not available the use of this function in a
385 * multithreaded application may be unsafe.
389 void print_error(const char *filename, int err);
392 * Print the program banner to stderr. The banner contents depend on the
393 * current version of the repository and of the libav* libraries used by
396 void show_banner(int argc, char **argv, const OptionDef *options);
399 * Print the version of the program to stdout. The version message
400 * depends on the current versions of the repository and of the libav*
402 * This option processing function does not utilize the arguments.
404 int show_version(void *optctx, const char *opt, const char *arg);
407 * Print the license of the program to stdout. The license depends on
408 * the license of the libraries compiled into the program.
409 * This option processing function does not utilize the arguments.
411 int show_license(void *optctx, const char *opt, const char *arg);
414 * Print a listing containing all the formats supported by the
416 * This option processing function does not utilize the arguments.
418 int show_formats(void *optctx, const char *opt, const char *arg);
421 * Print a listing containing all the codecs supported by the
423 * This option processing function does not utilize the arguments.
425 int show_codecs(void *optctx, const char *opt, const char *arg);
428 * Print a listing containing all the decoders supported by the
431 int show_decoders(void *optctx, const char *opt, const char *arg);
434 * Print a listing containing all the encoders supported by the
437 int show_encoders(void *optctx, const char *opt, const char *arg);
440 * Print a listing containing all the filters supported by the
442 * This option processing function does not utilize the arguments.
444 int show_filters(void *optctx, const char *opt, const char *arg);
447 * Print a listing containing all the bit stream filters supported by the
449 * This option processing function does not utilize the arguments.
451 int show_bsfs(void *optctx, const char *opt, const char *arg);
454 * Print a listing containing all the protocols supported by the
456 * This option processing function does not utilize the arguments.
458 int show_protocols(void *optctx, const char *opt, const char *arg);
461 * Print a listing containing all the pixel formats supported by the
463 * This option processing function does not utilize the arguments.
465 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
468 * Print a listing containing all the standard channel layouts supported by
470 * This option processing function does not utilize the arguments.
472 int show_layouts(void *optctx, const char *opt, const char *arg);
475 * Print a listing containing all the sample formats supported by the
478 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
481 * Return a positive value if a line read from standard input
482 * starts with [yY], otherwise return 0.
484 int read_yesno(void);
487 * Read the file with name filename, and put its content in a newly
488 * allocated 0-terminated buffer.
490 * @param filename file to read from
491 * @param bufptr location where pointer to buffer is returned
492 * @param size location where size of buffer is returned
493 * @return 0 in case of success, a negative value corresponding to an
494 * AVERROR error code in case of failure.
496 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
499 * Get a file corresponding to a preset file.
501 * If is_path is non-zero, look for the file in the path preset_name.
502 * Otherwise search for a file named arg.ffpreset in the directories
503 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
504 * at configuration time or in a "ffpresets" folder along the executable
505 * on win32, in that order. If no such file is found and
506 * codec_name is defined, then search for a file named
507 * codec_name-preset_name.avpreset in the above-mentioned directories.
509 * @param filename buffer where the name of the found filename is written
510 * @param filename_size size in bytes of the filename buffer
511 * @param preset_name name of the preset to search
512 * @param is_path tell if preset_name is a filename path
513 * @param codec_name name of the codec for which to look for the
514 * preset, may be NULL
516 FILE *get_preset_file(char *filename, size_t filename_size,
517 const char *preset_name, int is_path, const char *codec_name);
520 * Realloc array to hold new_size elements of elem_size.
521 * Calls exit() on failure.
523 * @param array array to reallocate
524 * @param elem_size size in bytes of each element
525 * @param size new element count will be written here
526 * @param new_size number of elements to place in reallocated array
527 * @return reallocated array
529 void *grow_array(void *array, int elem_size, int *size, int new_size);
531 #define GROW_ARRAY(array, nb_elems)\
532 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
534 #define GET_PIX_FMT_NAME(pix_fmt)\
535 const char *name = av_get_pix_fmt_name(pix_fmt);
537 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
538 const char *name = av_get_sample_fmt_name(sample_fmt)
540 #define GET_SAMPLE_RATE_NAME(rate)\
542 snprintf(name, sizeof(name), "%d", rate);
544 #define GET_CH_LAYOUT_NAME(ch_layout)\
546 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
548 #define GET_CH_LAYOUT_DESC(ch_layout)\
550 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
552 #endif /* CMDUTILS_H */