f6ad44ca40b1a04a41e3306c4c4ec5acd4db34cb
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
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 struct SwsContext
*sws_opts
;
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 the cmdutils option system, in particular
66 * allocate the *_opts contexts.
70 * Uninitialize the cmdutils option system, in particular
71 * free the *_opts contexts and their contents.
73 void uninit_opts(void);
76 * Trivial log callback.
77 * Only suitable for opt_help and similar since it lacks prefix handling.
79 void log_callback_help(void* ptr
, int level
, const char* fmt
, va_list vl
);
82 * Override the cpuflags.
84 int opt_cpuflags(void *optctx
, const char *opt
, const char *arg
);
87 * Fallback for options that are not explicitly handled, these will be
88 * parsed through AVOptions.
90 int opt_default(void *optctx
, const char *opt
, const char *arg
);
93 * Set the libav* libraries log level.
95 int opt_loglevel(void *optctx
, const char *opt
, const char *arg
);
97 int opt_report(const char *opt
);
99 int opt_max_alloc(void *optctx
, const char *opt
, const char *arg
);
101 int opt_codec_debug(void *optctx
, const char *opt
, const char *arg
);
104 int opt_opencl(void *optctx
, const char *opt
, const char *arg
);
106 int opt_opencl_bench(void *optctx
, const char *opt
, const char *arg
);
110 * Limit the execution time.
112 int opt_timelimit(void *optctx
, const char *opt
, const char *arg
);
115 * Parse a string and return its corresponding value as a double.
116 * Exit from the application if the string cannot be correctly
117 * parsed or the corresponding value is invalid.
119 * @param context the context of the value to be set (e.g. the
120 * corresponding command line option name)
121 * @param numstr the string to be parsed
122 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
123 * string should be parsed
124 * @param min the minimum valid accepted value
125 * @param max the maximum valid accepted value
127 double parse_number_or_die(const char *context
, const char *numstr
, int type
,
128 double min
, double max
);
131 * Parse a string specifying a time and return its corresponding
132 * value as a number of microseconds. Exit from the application if
133 * the string cannot be correctly parsed.
135 * @param context the context of the value to be set (e.g. the
136 * corresponding command line option name)
137 * @param timestr the string to be parsed
138 * @param is_duration a flag which tells how to interpret timestr, if
139 * not zero timestr is interpreted as a duration, otherwise as a
142 * @see av_parse_time()
144 int64_t parse_time_or_die(const char *context
, const char *timestr
,
147 typedef struct SpecifierOpt
{
148 char *specifier
; /**< stream/chapter/program/... specifier */
158 typedef struct OptionDef
{
161 #define HAS_ARG 0x0001
162 #define OPT_BOOL 0x0002
163 #define OPT_EXPERT 0x0004
164 #define OPT_STRING 0x0008
165 #define OPT_VIDEO 0x0010
166 #define OPT_AUDIO 0x0020
167 #define OPT_INT 0x0080
168 #define OPT_FLOAT 0x0100
169 #define OPT_SUBTITLE 0x0200
170 #define OPT_INT64 0x0400
171 #define OPT_EXIT 0x0800
172 #define OPT_DATA 0x1000
173 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
174 implied by OPT_OFFSET or OPT_SPEC */
175 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
176 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
177 Implies OPT_OFFSET. Next element after the offset is
178 an int containing element count in the array. */
179 #define OPT_TIME 0x10000
180 #define OPT_DOUBLE 0x20000
181 #define OPT_INPUT 0x40000
182 #define OPT_OUTPUT 0x80000
185 int (*func_arg
)(void *, const char *, const char *);
193 * Print help for all options matching specified flags.
195 * @param options a list of options
196 * @param msg title of this group. Only printed if at least one option matches.
197 * @param req_flags print only options which have all those flags set.
198 * @param rej_flags don't print options which have any of those flags set.
199 * @param alt_flags print only options that have at least one of those flags set
201 void show_help_options(const OptionDef
*options
, const char *msg
, int req_flags
,
202 int rej_flags
, int alt_flags
);
205 * Show help for all options with given flags in class and all its
208 void show_help_children(const AVClass
*class, int flags
);
211 * Per-fftool specific help handler. Implemented in each
212 * fftool, called by show_help().
214 void show_help_default(const char *opt
, const char *arg
);
217 * Generic -h handler common to all fftools.
219 int show_help(void *optctx
, const char *opt
, const char *arg
);
222 * Parse the command line arguments.
224 * @param optctx an opaque options context
225 * @param argc number of command line arguments
226 * @param argv values of command line arguments
227 * @param options Array with the definitions required to interpret every
228 * option of the form: -option_name [argument]
229 * @param parse_arg_function Name of the function called to process every
230 * argument without a leading option name flag. NULL if such arguments do
231 * not have to be processed.
233 void parse_options(void *optctx
, int argc
, char **argv
, const OptionDef
*options
,
234 void (* parse_arg_function
)(void *optctx
, const char*));
237 * Parse one given option.
239 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
241 int parse_option(void *optctx
, const char *opt
, const char *arg
,
242 const OptionDef
*options
);
245 * An option extracted from the commandline.
246 * Cannot use AVDictionary because of options like -map which can be
247 * used multiple times.
249 typedef struct Option
{
250 const OptionDef
*opt
;
255 typedef struct OptionGroupDef
{
259 * Option to be used as group separator. Can be NULL for groups which
260 * are terminated by a non-option argument (e.g. ffmpeg output files)
264 * Option flags that must be set on each option that is
265 * applied to this group
270 typedef struct OptionGroup
{
271 const OptionGroupDef
*group_def
;
277 AVDictionary
*codec_opts
;
278 AVDictionary
*format_opts
;
279 AVDictionary
*resample_opts
;
280 struct SwsContext
*sws_opts
;
281 AVDictionary
*swr_opts
;
285 * A list of option groups that all have the same group type
286 * (e.g. input files or output files)
288 typedef struct OptionGroupList
{
289 const OptionGroupDef
*group_def
;
295 typedef struct OptionParseContext
{
296 OptionGroup global_opts
;
298 OptionGroupList
*groups
;
302 OptionGroup cur_group
;
303 } OptionParseContext
;
306 * Parse an options group and write results into optctx.
308 * @param optctx an app-specific options context. NULL for global options group
310 int parse_optgroup(void *optctx
, OptionGroup
*g
);
313 * Split the commandline into an intermediate form convenient for further
316 * The commandline is assumed to be composed of options which either belong to a
317 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
320 * A group (defined by an OptionGroupDef struct) is a sequence of options
321 * terminated by either a group separator option (e.g. -i) or a parameter that
322 * is not an option (doesn't start with -). A group without a separator option
323 * must always be first in the supplied groups list.
325 * All options within the same group are stored in one OptionGroup struct in an
326 * OptionGroupList, all groups with the same group definition are stored in one
327 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
328 * same as the order of group definitions.
330 int split_commandline(OptionParseContext
*octx
, int argc
, char *argv
[],
331 const OptionDef
*options
,
332 const OptionGroupDef
*groups
, int nb_groups
);
335 * Free all allocated memory in an OptionParseContext.
337 void uninit_parse_context(OptionParseContext
*octx
);
340 * Find the '-loglevel' option in the command line args and apply it.
342 void parse_loglevel(int argc
, char **argv
, const OptionDef
*options
);
345 * Return index of option opt in argv or 0 if not found.
347 int locate_option(int argc
, char **argv
, const OptionDef
*options
,
348 const char *optname
);
351 * Check if the given stream matches a stream specifier.
353 * @param s Corresponding format context.
354 * @param st Stream from s to be checked.
355 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
357 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
359 int check_stream_specifier(AVFormatContext
*s
, AVStream
*st
, const char *spec
);
362 * Filter out options for given codec.
364 * Create a new options dictionary containing only the options from
365 * opts which apply to the codec with ID codec_id.
367 * @param opts dictionary to place options in
368 * @param codec_id ID of the codec that should be filtered for
369 * @param s Corresponding format context.
370 * @param st A stream from s for which the options should be filtered.
371 * @param codec The particular codec for which the options should be filtered.
372 * If null, the default one is looked up according to the codec id.
373 * @return a pointer to the created dictionary
375 AVDictionary
*filter_codec_opts(AVDictionary
*opts
, enum AVCodecID codec_id
,
376 AVFormatContext
*s
, AVStream
*st
, AVCodec
*codec
);
379 * Setup AVCodecContext options for avformat_find_stream_info().
381 * Create an array of dictionaries, one dictionary for each stream
383 * Each dictionary will contain the options from codec_opts which can
384 * be applied to the corresponding stream codec context.
386 * @return pointer to the created array of dictionaries, NULL if it
389 AVDictionary
**setup_find_stream_info_opts(AVFormatContext
*s
,
390 AVDictionary
*codec_opts
);
393 * Print an error message to stderr, indicating filename and a human
394 * readable description of the error code err.
396 * If strerror_r() is not available the use of this function in a
397 * multithreaded application may be unsafe.
401 void print_error(const char *filename
, int err
);
404 * Print the program banner to stderr. The banner contents depend on the
405 * current version of the repository and of the libav* libraries used by
408 void show_banner(int argc
, char **argv
, const OptionDef
*options
);
411 * Print the version of the program to stdout. The version message
412 * depends on the current versions of the repository and of the libav*
414 * This option processing function does not utilize the arguments.
416 int show_version(void *optctx
, const char *opt
, const char *arg
);
419 * Print the build configuration of the program to stdout. The contents
420 * depend on the definition of FFMPEG_CONFIGURATION.
421 * This option processing function does not utilize the arguments.
423 int show_buildconf(void *optctx
, const char *opt
, const char *arg
);
426 * Print the license of the program to stdout. The license depends on
427 * the license of the libraries compiled into the program.
428 * This option processing function does not utilize the arguments.
430 int show_license(void *optctx
, const char *opt
, const char *arg
);
433 * Print a listing containing all the formats supported by the
434 * program (including devices).
435 * This option processing function does not utilize the arguments.
437 int show_formats(void *optctx
, const char *opt
, const char *arg
);
440 * Print a listing containing all the devices supported by the
442 * This option processing function does not utilize the arguments.
444 int show_devices(void *optctx
, const char *opt
, const char *arg
);
448 * Print a listing containing audodetected sinks of the output device.
449 * Device name with options may be passed as an argument to limit results.
451 int show_sinks(void *optctx
, const char *opt
, const char *arg
);
454 * Print a listing containing audodetected sources of the input device.
455 * Device name with options may be passed as an argument to limit results.
457 int show_sources(void *optctx
, const char *opt
, const char *arg
);
461 * Print a listing containing all the codecs supported by the
463 * This option processing function does not utilize the arguments.
465 int show_codecs(void *optctx
, const char *opt
, const char *arg
);
468 * Print a listing containing all the decoders supported by the
471 int show_decoders(void *optctx
, const char *opt
, const char *arg
);
474 * Print a listing containing all the encoders supported by the
477 int show_encoders(void *optctx
, const char *opt
, const char *arg
);
480 * Print a listing containing all the filters supported by the
482 * This option processing function does not utilize the arguments.
484 int show_filters(void *optctx
, const char *opt
, const char *arg
);
487 * Print a listing containing all the bit stream filters supported by the
489 * This option processing function does not utilize the arguments.
491 int show_bsfs(void *optctx
, const char *opt
, const char *arg
);
494 * Print a listing containing all the protocols supported by the
496 * This option processing function does not utilize the arguments.
498 int show_protocols(void *optctx
, const char *opt
, const char *arg
);
501 * Print a listing containing all the pixel formats supported by the
503 * This option processing function does not utilize the arguments.
505 int show_pix_fmts(void *optctx
, const char *opt
, const char *arg
);
508 * Print a listing containing all the standard channel layouts supported by
510 * This option processing function does not utilize the arguments.
512 int show_layouts(void *optctx
, const char *opt
, const char *arg
);
515 * Print a listing containing all the sample formats supported by the
518 int show_sample_fmts(void *optctx
, const char *opt
, const char *arg
);
521 * Print a listing containing all the color names and values recognized
524 int show_colors(void *optctx
, const char *opt
, const char *arg
);
527 * Return a positive value if a line read from standard input
528 * starts with [yY], otherwise return 0.
530 int read_yesno(void);
533 * Read the file with name filename, and put its content in a newly
534 * allocated 0-terminated buffer.
536 * @param filename file to read from
537 * @param bufptr location where pointer to buffer is returned
538 * @param size location where size of buffer is returned
539 * @return >= 0 in case of success, a negative value corresponding to an
540 * AVERROR error code in case of failure.
542 int cmdutils_read_file(const char *filename
, char **bufptr
, size_t *size
);
545 * Get a file corresponding to a preset file.
547 * If is_path is non-zero, look for the file in the path preset_name.
548 * Otherwise search for a file named arg.ffpreset in the directories
549 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
550 * at configuration time or in a "ffpresets" folder along the executable
551 * on win32, in that order. If no such file is found and
552 * codec_name is defined, then search for a file named
553 * codec_name-preset_name.avpreset in the above-mentioned directories.
555 * @param filename buffer where the name of the found filename is written
556 * @param filename_size size in bytes of the filename buffer
557 * @param preset_name name of the preset to search
558 * @param is_path tell if preset_name is a filename path
559 * @param codec_name name of the codec for which to look for the
560 * preset, may be NULL
562 FILE *get_preset_file(char *filename
, size_t filename_size
,
563 const char *preset_name
, int is_path
, const char *codec_name
);
566 * Realloc array to hold new_size elements of elem_size.
567 * Calls exit() on failure.
569 * @param array array to reallocate
570 * @param elem_size size in bytes of each element
571 * @param size new element count will be written here
572 * @param new_size number of elements to place in reallocated array
573 * @return reallocated array
575 void *grow_array(void *array
, int elem_size
, int *size
, int new_size
);
577 #define media_type_string av_get_media_type_string
579 #define GROW_ARRAY(array, nb_elems)\
580 array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
582 #define GET_PIX_FMT_NAME(pix_fmt)\
583 const char *name = av_get_pix_fmt_name(pix_fmt);
585 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
586 const char *name = av_get_sample_fmt_name(sample_fmt)
588 #define GET_SAMPLE_RATE_NAME(rate)\
590 snprintf(name, sizeof(name), "%d", rate);
592 #define GET_CH_LAYOUT_NAME(ch_layout)\
594 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
596 #define GET_CH_LAYOUT_DESC(ch_layout)\
598 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
600 #endif /* CMDUTILS_H */