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 * Limit the execution time.
96 int opt_timelimit(void *optctx, const char *opt, const char *arg);
99 * Parse a string and return its corresponding value as a double.
100 * Exit from the application if the string cannot be correctly
101 * parsed or the corresponding value is invalid.
103 * @param context the context of the value to be set (e.g. the
104 * corresponding command line option name)
105 * @param numstr the string to be parsed
106 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
107 * string should be parsed
108 * @param min the minimum valid accepted value
109 * @param max the maximum valid accepted value
111 double parse_number_or_die(const char *context, const char *numstr, int type,
112 double min, double max);
115 * Parse a string specifying a time and return its corresponding
116 * value as a number of microseconds. Exit from the application if
117 * the string cannot be correctly parsed.
119 * @param context the context of the value to be set (e.g. the
120 * corresponding command line option name)
121 * @param timestr the string to be parsed
122 * @param is_duration a flag which tells how to interpret timestr, if
123 * not zero timestr is interpreted as a duration, otherwise as a
126 * @see av_parse_time()
128 int64_t parse_time_or_die(const char *context, const char *timestr,
131 typedef struct SpecifierOpt {
132 char *specifier; /**< stream/chapter/program/... specifier */
142 typedef struct OptionDef {
145 #define HAS_ARG 0x0001
146 #define OPT_BOOL 0x0002
147 #define OPT_EXPERT 0x0004
148 #define OPT_STRING 0x0008
149 #define OPT_VIDEO 0x0010
150 #define OPT_AUDIO 0x0020
151 #define OPT_INT 0x0080
152 #define OPT_FLOAT 0x0100
153 #define OPT_SUBTITLE 0x0200
154 #define OPT_INT64 0x0400
155 #define OPT_EXIT 0x0800
156 #define OPT_DATA 0x1000
157 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
158 implied by OPT_OFFSET or OPT_SPEC */
159 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
160 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
161 Implies OPT_OFFSET. Next element after the offset is
162 an int containing element count in the array. */
163 #define OPT_TIME 0x10000
164 #define OPT_DOUBLE 0x20000
165 #define OPT_INPUT 0x40000
166 #define OPT_OUTPUT 0x80000
169 int (*func_arg)(void *, const char *, const char *);
177 * Print help for all options matching specified flags.
179 * @param options a list of options
180 * @param msg title of this group. Only printed if at least one option matches.
181 * @param req_flags print only options which have all those flags set.
182 * @param rej_flags don't print options which have any of those flags set.
183 * @param alt_flags print only options that have at least one of those flags set
185 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
186 int rej_flags, int alt_flags);
189 * Show help for all options with given flags in class and all its
192 void show_help_children(const AVClass *class, int flags);
195 * Per-fftool specific help handler. Implemented in each
196 * fftool, called by show_help().
198 void show_help_default(const char *opt, const char *arg);
201 * Generic -h handler common to all fftools.
203 int show_help(void *optctx, const char *opt, const char *arg);
206 * Parse the command line arguments.
208 * @param optctx an opaque options context
209 * @param argc number of command line arguments
210 * @param argv values of command line arguments
211 * @param options Array with the definitions required to interpret every
212 * option of the form: -option_name [argument]
213 * @param parse_arg_function Name of the function called to process every
214 * argument without a leading option name flag. NULL if such arguments do
215 * not have to be processed.
217 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
218 void (* parse_arg_function)(void *optctx, const char*));
221 * Parse one given option.
223 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
225 int parse_option(void *optctx, const char *opt, const char *arg,
226 const OptionDef *options);
229 * An option extracted from the commandline.
230 * Cannot use AVDictionary because of options like -map which can be
231 * used multiple times.
233 typedef struct Option {
234 const OptionDef *opt;
239 typedef struct OptionGroupDef {
243 * Option to be used as group separator. Can be NULL for groups which
244 * are terminated by a non-option argument (e.g. ffmpeg output files)
248 * Option flags that must be set on each option that is
249 * applied to this group
254 typedef struct OptionGroup {
255 const OptionGroupDef *group_def;
261 AVDictionary *codec_opts;
262 AVDictionary *format_opts;
263 AVDictionary *resample_opts;
264 struct SwsContext *sws_opts;
265 AVDictionary *swr_opts;
269 * A list of option groups that all have the same group type
270 * (e.g. input files or output files)
272 typedef struct OptionGroupList {
273 const OptionGroupDef *group_def;
279 typedef struct OptionParseContext {
280 OptionGroup global_opts;
282 OptionGroupList *groups;
286 OptionGroup cur_group;
287 } OptionParseContext;
290 * Parse an options group and write results into optctx.
292 * @param optctx an app-specific options context. NULL for global options group
294 int parse_optgroup(void *optctx, OptionGroup *g);
297 * Split the commandline into an intermediate form convenient for further
300 * The commandline is assumed to be composed of options which either belong to a
301 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
304 * A group (defined by an OptionGroupDef struct) is a sequence of options
305 * terminated by either a group separator option (e.g. -i) or a parameter that
306 * is not an option (doesn't start with -). A group without a separator option
307 * must always be first in the supplied groups list.
309 * All options within the same group are stored in one OptionGroup struct in an
310 * OptionGroupList, all groups with the same group definition are stored in one
311 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
312 * same as the order of group definitions.
314 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
315 const OptionDef *options,
316 const OptionGroupDef *groups, int nb_groups);
319 * Free all allocated memory in an OptionParseContext.
321 void uninit_parse_context(OptionParseContext *octx);
324 * Find the '-loglevel' option in the command line args and apply it.
326 void parse_loglevel(int argc, char **argv, const OptionDef *options);
329 * Return index of option opt in argv or 0 if not found.
331 int locate_option(int argc, char **argv, const OptionDef *options,
332 const char *optname);
335 * Check if the given stream matches a stream specifier.
337 * @param s Corresponding format context.
338 * @param st Stream from s to be checked.
339 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
341 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
343 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
346 * Filter out options for given codec.
348 * Create a new options dictionary containing only the options from
349 * opts which apply to the codec with ID codec_id.
351 * @param opts dictionary to place options in
352 * @param codec_id ID of the codec that should be filtered for
353 * @param s Corresponding format context.
354 * @param st A stream from s for which the options should be filtered.
355 * @param codec The particular codec for which the options should be filtered.
356 * If null, the default one is looked up according to the codec id.
357 * @return a pointer to the created dictionary
359 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
360 AVFormatContext *s, AVStream *st, AVCodec *codec);
363 * Setup AVCodecContext options for avformat_find_stream_info().
365 * Create an array of dictionaries, one dictionary for each stream
367 * Each dictionary will contain the options from codec_opts which can
368 * be applied to the corresponding stream codec context.
370 * @return pointer to the created array of dictionaries, NULL if it
373 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
374 AVDictionary *codec_opts);
377 * Print an error message to stderr, indicating filename and a human
378 * readable description of the error code err.
380 * If strerror_r() is not available the use of this function in a
381 * multithreaded application may be unsafe.
385 void print_error(const char *filename, int err);
388 * Print the program banner to stderr. The banner contents depend on the
389 * current version of the repository and of the libav* libraries used by
392 void show_banner(int argc, char **argv, const OptionDef *options);
395 * Print the version of the program to stdout. The version message
396 * depends on the current versions of the repository and of the libav*
398 * This option processing function does not utilize the arguments.
400 int show_version(void *optctx, const char *opt, const char *arg);
403 * Print the license of the program to stdout. The license depends on
404 * the license of the libraries compiled into the program.
405 * This option processing function does not utilize the arguments.
407 int show_license(void *optctx, const char *opt, const char *arg);
410 * Print a listing containing all the formats supported by the
412 * This option processing function does not utilize the arguments.
414 int show_formats(void *optctx, const char *opt, const char *arg);
417 * Print a listing containing all the codecs supported by the
419 * This option processing function does not utilize the arguments.
421 int show_codecs(void *optctx, const char *opt, const char *arg);
424 * Print a listing containing all the decoders supported by the
427 int show_decoders(void *optctx, const char *opt, const char *arg);
430 * Print a listing containing all the encoders supported by the
433 int show_encoders(void *optctx, const char *opt, const char *arg);
436 * Print a listing containing all the filters supported by the
438 * This option processing function does not utilize the arguments.
440 int show_filters(void *optctx, const char *opt, const char *arg);
443 * Print a listing containing all the bit stream filters supported by the
445 * This option processing function does not utilize the arguments.
447 int show_bsfs(void *optctx, const char *opt, const char *arg);
450 * Print a listing containing all the protocols supported by the
452 * This option processing function does not utilize the arguments.
454 int show_protocols(void *optctx, const char *opt, const char *arg);
457 * Print a listing containing all the pixel formats supported by the
459 * This option processing function does not utilize the arguments.
461 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
464 * Print a listing containing all the standard channel layouts supported by
466 * This option processing function does not utilize the arguments.
468 int show_layouts(void *optctx, const char *opt, const char *arg);
471 * Print a listing containing all the sample formats supported by the
474 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
477 * Return a positive value if a line read from standard input
478 * starts with [yY], otherwise return 0.
480 int read_yesno(void);
483 * Read the file with name filename, and put its content in a newly
484 * allocated 0-terminated buffer.
486 * @param filename file to read from
487 * @param bufptr location where pointer to buffer is returned
488 * @param size location where size of buffer is returned
489 * @return 0 in case of success, a negative value corresponding to an
490 * AVERROR error code in case of failure.
492 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
495 * Get a file corresponding to a preset file.
497 * If is_path is non-zero, look for the file in the path preset_name.
498 * Otherwise search for a file named arg.ffpreset in the directories
499 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
500 * at configuration time or in a "ffpresets" folder along the executable
501 * on win32, in that order. If no such file is found and
502 * codec_name is defined, then search for a file named
503 * codec_name-preset_name.avpreset in the above-mentioned directories.
505 * @param filename buffer where the name of the found filename is written
506 * @param filename_size size in bytes of the filename buffer
507 * @param preset_name name of the preset to search
508 * @param is_path tell if preset_name is a filename path
509 * @param codec_name name of the codec for which to look for the
510 * preset, may be NULL
512 FILE *get_preset_file(char *filename, size_t filename_size,
513 const char *preset_name, int is_path, const char *codec_name);
516 * Realloc array to hold new_size elements of elem_size.
517 * Calls exit() on failure.
519 * @param array array to reallocate
520 * @param elem_size size in bytes of each element
521 * @param size new element count will be written here
522 * @param new_size number of elements to place in reallocated array
523 * @return reallocated array
525 void *grow_array(void *array, int elem_size, int *size, int new_size);
527 #define GROW_ARRAY(array, nb_elems)\
528 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
530 #define GET_PIX_FMT_NAME(pix_fmt)\
531 const char *name = av_get_pix_fmt_name(pix_fmt);
533 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
534 const char *name = av_get_sample_fmt_name(sample_fmt)
536 #define GET_SAMPLE_RATE_NAME(rate)\
538 snprintf(name, sizeof(name), "%d", rate);
540 #define GET_CH_LAYOUT_NAME(ch_layout)\
542 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
544 #define GET_CH_LAYOUT_DESC(ch_layout)\
546 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
548 #endif /* CMDUTILS_H */