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 * Register a program-specific cleanup routine.
60 void register_exit(void (*cb)(int ret));
63 * Wraps exit with a program-specific cleanup routine.
65 void exit_program(int ret);
68 * Initialize the cmdutils option system, in particular
69 * allocate the *_opts contexts.
73 * Uninitialize the cmdutils option system, in particular
74 * free the *_opts contexts and their contents.
76 void uninit_opts(void);
79 * Trivial log callback.
80 * Only suitable for opt_help and similar since it lacks prefix handling.
82 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
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_cpuflags(void *optctx, const char *opt, const char *arg);
101 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
103 int opt_opencl(void *optctx, const char *opt, const char *arg);
106 * Limit the execution time.
108 int opt_timelimit(void *optctx, const char *opt, const char *arg);
111 * Parse a string and return its corresponding value as a double.
112 * Exit from the application if the string cannot be correctly
113 * parsed or the corresponding value is invalid.
115 * @param context the context of the value to be set (e.g. the
116 * corresponding command line option name)
117 * @param numstr the string to be parsed
118 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
119 * string should be parsed
120 * @param min the minimum valid accepted value
121 * @param max the maximum valid accepted value
123 double parse_number_or_die(const char *context, const char *numstr, int type,
124 double min, double max);
127 * Parse a string specifying a time and return its corresponding
128 * value as a number of microseconds. Exit from the application if
129 * the string cannot be correctly parsed.
131 * @param context the context of the value to be set (e.g. the
132 * corresponding command line option name)
133 * @param timestr the string to be parsed
134 * @param is_duration a flag which tells how to interpret timestr, if
135 * not zero timestr is interpreted as a duration, otherwise as a
138 * @see av_parse_time()
140 int64_t parse_time_or_die(const char *context, const char *timestr,
143 typedef struct SpecifierOpt {
144 char *specifier; /**< stream/chapter/program/... specifier */
154 typedef struct OptionDef {
157 #define HAS_ARG 0x0001
158 #define OPT_BOOL 0x0002
159 #define OPT_EXPERT 0x0004
160 #define OPT_STRING 0x0008
161 #define OPT_VIDEO 0x0010
162 #define OPT_AUDIO 0x0020
163 #define OPT_INT 0x0080
164 #define OPT_FLOAT 0x0100
165 #define OPT_SUBTITLE 0x0200
166 #define OPT_INT64 0x0400
167 #define OPT_EXIT 0x0800
168 #define OPT_DATA 0x1000
169 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
170 implied by OPT_OFFSET or OPT_SPEC */
171 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
172 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
173 Implies OPT_OFFSET. Next element after the offset is
174 an int containing element count in the array. */
175 #define OPT_TIME 0x10000
176 #define OPT_DOUBLE 0x20000
177 #define OPT_INPUT 0x40000
178 #define OPT_OUTPUT 0x80000
181 int (*func_arg)(void *, const char *, const char *);
189 * Print help for all options matching specified flags.
191 * @param options a list of options
192 * @param msg title of this group. Only printed if at least one option matches.
193 * @param req_flags print only options which have all those flags set.
194 * @param rej_flags don't print options which have any of those flags set.
195 * @param alt_flags print only options that have at least one of those flags set
197 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
198 int rej_flags, int alt_flags);
201 * Show help for all options with given flags in class and all its
204 void show_help_children(const AVClass *class, int flags);
207 * Per-fftool specific help handler. Implemented in each
208 * fftool, called by show_help().
210 void show_help_default(const char *opt, const char *arg);
213 * Generic -h handler common to all fftools.
215 int show_help(void *optctx, const char *opt, const char *arg);
218 * Parse the command line arguments.
220 * @param optctx an opaque options context
221 * @param argc number of command line arguments
222 * @param argv values of command line arguments
223 * @param options Array with the definitions required to interpret every
224 * option of the form: -option_name [argument]
225 * @param parse_arg_function Name of the function called to process every
226 * argument without a leading option name flag. NULL if such arguments do
227 * not have to be processed.
229 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
230 void (* parse_arg_function)(void *optctx, const char*));
233 * Parse one given option.
235 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
237 int parse_option(void *optctx, const char *opt, const char *arg,
238 const OptionDef *options);
241 * An option extracted from the commandline.
242 * Cannot use AVDictionary because of options like -map which can be
243 * used multiple times.
245 typedef struct Option {
246 const OptionDef *opt;
251 typedef struct OptionGroupDef {
255 * Option to be used as group separator. Can be NULL for groups which
256 * are terminated by a non-option argument (e.g. ffmpeg output files)
260 * Option flags that must be set on each option that is
261 * applied to this group
266 typedef struct OptionGroup {
267 const OptionGroupDef *group_def;
273 AVDictionary *codec_opts;
274 AVDictionary *format_opts;
275 AVDictionary *resample_opts;
276 struct SwsContext *sws_opts;
277 AVDictionary *swr_opts;
281 * A list of option groups that all have the same group type
282 * (e.g. input files or output files)
284 typedef struct OptionGroupList {
285 const OptionGroupDef *group_def;
291 typedef struct OptionParseContext {
292 OptionGroup global_opts;
294 OptionGroupList *groups;
298 OptionGroup cur_group;
299 } OptionParseContext;
302 * Parse an options group and write results into optctx.
304 * @param optctx an app-specific options context. NULL for global options group
306 int parse_optgroup(void *optctx, OptionGroup *g);
309 * Split the commandline into an intermediate form convenient for further
312 * The commandline is assumed to be composed of options which either belong to a
313 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
316 * A group (defined by an OptionGroupDef struct) is a sequence of options
317 * terminated by either a group separator option (e.g. -i) or a parameter that
318 * is not an option (doesn't start with -). A group without a separator option
319 * must always be first in the supplied groups list.
321 * All options within the same group are stored in one OptionGroup struct in an
322 * OptionGroupList, all groups with the same group definition are stored in one
323 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
324 * same as the order of group definitions.
326 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
327 const OptionDef *options,
328 const OptionGroupDef *groups, int nb_groups);
331 * Free all allocated memory in an OptionParseContext.
333 void uninit_parse_context(OptionParseContext *octx);
336 * Find the '-loglevel' option in the command line args and apply it.
338 void parse_loglevel(int argc, char **argv, const OptionDef *options);
341 * Return index of option opt in argv or 0 if not found.
343 int locate_option(int argc, char **argv, const OptionDef *options,
344 const char *optname);
347 * Check if the given stream matches a stream specifier.
349 * @param s Corresponding format context.
350 * @param st Stream from s to be checked.
351 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
353 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
355 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
358 * Filter out options for given codec.
360 * Create a new options dictionary containing only the options from
361 * opts which apply to the codec with ID codec_id.
363 * @param opts dictionary to place options in
364 * @param codec_id ID of the codec that should be filtered for
365 * @param s Corresponding format context.
366 * @param st A stream from s for which the options should be filtered.
367 * @param codec The particular codec for which the options should be filtered.
368 * If null, the default one is looked up according to the codec id.
369 * @return a pointer to the created dictionary
371 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
372 AVFormatContext *s, AVStream *st, AVCodec *codec);
375 * Setup AVCodecContext options for avformat_find_stream_info().
377 * Create an array of dictionaries, one dictionary for each stream
379 * Each dictionary will contain the options from codec_opts which can
380 * be applied to the corresponding stream codec context.
382 * @return pointer to the created array of dictionaries, NULL if it
385 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
386 AVDictionary *codec_opts);
389 * Print an error message to stderr, indicating filename and a human
390 * readable description of the error code err.
392 * If strerror_r() is not available the use of this function in a
393 * multithreaded application may be unsafe.
397 void print_error(const char *filename, int err);
400 * Print the program banner to stderr. The banner contents depend on the
401 * current version of the repository and of the libav* libraries used by
404 void show_banner(int argc, char **argv, const OptionDef *options);
407 * Print the version of the program to stdout. The version message
408 * depends on the current versions of the repository and of the libav*
410 * This option processing function does not utilize the arguments.
412 int show_version(void *optctx, const char *opt, const char *arg);
415 * Print the license of the program to stdout. The license depends on
416 * the license of the libraries compiled into the program.
417 * This option processing function does not utilize the arguments.
419 int show_license(void *optctx, const char *opt, const char *arg);
422 * Print a listing containing all the formats supported by the
424 * This option processing function does not utilize the arguments.
426 int show_formats(void *optctx, const char *opt, const char *arg);
429 * Print a listing containing all the codecs supported by the
431 * This option processing function does not utilize the arguments.
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
450 * This option processing function does not utilize the arguments.
452 int show_filters(void *optctx, const char *opt, const char *arg);
455 * Print a listing containing all the bit stream filters supported by the
457 * This option processing function does not utilize the arguments.
459 int show_bsfs(void *optctx, const char *opt, const char *arg);
462 * Print a listing containing all the protocols supported by the
464 * This option processing function does not utilize the arguments.
466 int show_protocols(void *optctx, const char *opt, const char *arg);
469 * Print a listing containing all the pixel formats supported by the
471 * This option processing function does not utilize the arguments.
473 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
476 * Print a listing containing all the standard channel layouts supported by
478 * This option processing function does not utilize the arguments.
480 int show_layouts(void *optctx, const char *opt, const char *arg);
483 * Print a listing containing all the sample formats supported by the
486 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
489 * Return a positive value if a line read from standard input
490 * starts with [yY], otherwise return 0.
492 int read_yesno(void);
495 * Read the file with name filename, and put its content in a newly
496 * allocated 0-terminated buffer.
498 * @param filename file to read from
499 * @param bufptr location where pointer to buffer is returned
500 * @param size location where size of buffer is returned
501 * @return 0 in case of success, a negative value corresponding to an
502 * AVERROR error code in case of failure.
504 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
507 * Get a file corresponding to a preset file.
509 * If is_path is non-zero, look for the file in the path preset_name.
510 * Otherwise search for a file named arg.ffpreset in the directories
511 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
512 * at configuration time or in a "ffpresets" folder along the executable
513 * on win32, in that order. If no such file is found and
514 * codec_name is defined, then search for a file named
515 * codec_name-preset_name.avpreset in the above-mentioned directories.
517 * @param filename buffer where the name of the found filename is written
518 * @param filename_size size in bytes of the filename buffer
519 * @param preset_name name of the preset to search
520 * @param is_path tell if preset_name is a filename path
521 * @param codec_name name of the codec for which to look for the
522 * preset, may be NULL
524 FILE *get_preset_file(char *filename, size_t filename_size,
525 const char *preset_name, int is_path, const char *codec_name);
528 * Realloc array to hold new_size elements of elem_size.
529 * Calls exit() on failure.
531 * @param array array to reallocate
532 * @param elem_size size in bytes of each element
533 * @param size new element count will be written here
534 * @param new_size number of elements to place in reallocated array
535 * @return reallocated array
537 void *grow_array(void *array, int elem_size, int *size, int new_size);
539 #define media_type_string av_get_media_type_string
541 #define GROW_ARRAY(array, nb_elems)\
542 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
544 #define GET_PIX_FMT_NAME(pix_fmt)\
545 const char *name = av_get_pix_fmt_name(pix_fmt);
547 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
548 const char *name = av_get_sample_fmt_name(sample_fmt)
550 #define GET_SAMPLE_RATE_NAME(rate)\
552 snprintf(name, sizeof(name), "%d", rate);
554 #define GET_CH_LAYOUT_NAME(ch_layout)\
556 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
558 #define GET_CH_LAYOUT_DESC(ch_layout)\
560 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
562 #endif /* CMDUTILS_H */