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;
46 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
47 extern AVFormatContext *avformat_opts;
48 extern struct SwsContext *sws_opts;
49 extern AVDictionary *format_opts, *codec_opts;
52 * Initialize the cmdutils option system, in particular
53 * allocate the *_opts contexts.
57 * Uninitialize the cmdutils option system, in particular
58 * free the *_opts contexts and their contents.
60 void uninit_opts(void);
63 * Trivial log callback.
64 * Only suitable for opt_help and similar since it lacks prefix handling.
66 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
69 * Fallback for options that are not explicitly handled, these will be
70 * parsed through AVOptions.
72 int opt_default(const char *opt, const char *arg);
75 * Set the libav* libraries log level.
77 int opt_loglevel(const char *opt, const char *arg);
79 int opt_report(const char *opt);
81 int opt_max_alloc(const char *opt, const char *arg);
83 int opt_codec_debug(const char *opt, const char *arg);
86 * Limit the execution time.
88 int opt_timelimit(const char *opt, const char *arg);
91 * Parse a string and return its corresponding value as a double.
92 * Exit from the application if the string cannot be correctly
93 * parsed or the corresponding value is invalid.
95 * @param context the context of the value to be set (e.g. the
96 * corresponding command line option name)
97 * @param numstr the string to be parsed
98 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
99 * string should be parsed
100 * @param min the minimum valid accepted value
101 * @param max the maximum valid accepted value
103 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
106 * Parse a string specifying a time and return its corresponding
107 * value as a number of microseconds. Exit from the application if
108 * the string cannot be correctly parsed.
110 * @param context the context of the value to be set (e.g. the
111 * corresponding command line option name)
112 * @param timestr the string to be parsed
113 * @param is_duration a flag which tells how to interpret timestr, if
114 * not zero timestr is interpreted as a duration, otherwise as a
119 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
121 typedef struct SpecifierOpt {
122 char *specifier; /**< stream/chapter/program/... specifier */
135 #define HAS_ARG 0x0001
136 #define OPT_BOOL 0x0002
137 #define OPT_EXPERT 0x0004
138 #define OPT_STRING 0x0008
139 #define OPT_VIDEO 0x0010
140 #define OPT_AUDIO 0x0020
141 #define OPT_GRAB 0x0040
142 #define OPT_INT 0x0080
143 #define OPT_FLOAT 0x0100
144 #define OPT_SUBTITLE 0x0200
145 #define OPT_INT64 0x0400
146 #define OPT_EXIT 0x0800
147 #define OPT_DATA 0x1000
148 #define OPT_FUNC2 0x2000
149 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
150 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
151 Implies OPT_OFFSET. Next element after the offset is
152 an int containing element count in the array. */
153 #define OPT_TIME 0x10000
154 #define OPT_DOUBLE 0x20000
157 int (*func_arg)(const char *, const char *);
158 int (*func2_arg)(void *, const char *, const char *);
165 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
168 * Show help for all options with given flags in class and all its
171 void show_help_children(const AVClass *class, int flags);
174 * Parse the command line arguments.
176 * @param optctx an opaque options context
177 * @param options Array with the definitions required to interpret every
178 * option of the form: -option_name [argument]
179 * @param parse_arg_function Name of the function called to process every
180 * argument without a leading option name flag. NULL if such arguments do
181 * not have to be processed.
183 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
184 void (* parse_arg_function)(void *optctx, const char*));
187 * Parse one given option.
189 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
191 int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options);
194 * Find the '-loglevel' option in the command line args and apply it.
196 void parse_loglevel(int argc, char **argv, const OptionDef *options);
199 * Check if the given stream matches a stream specifier.
201 * @param s Corresponding format context.
202 * @param st Stream from s to be checked.
203 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
205 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
207 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
210 * Filter out options for given codec.
212 * Create a new options dictionary containing only the options from
213 * opts which apply to the codec with ID codec_id.
215 * @param s Corresponding format context.
216 * @param st A stream from s for which the options should be filtered.
217 * @return a pointer to the created dictionary
219 AVDictionary *filter_codec_opts(AVDictionary *opts, AVCodec *codec, AVFormatContext *s, AVStream *st);
222 * Setup AVCodecContext options for avformat_find_stream_info().
224 * Create an array of dictionaries, one dictionary for each stream
226 * Each dictionary will contain the options from codec_opts which can
227 * be applied to the corresponding stream codec context.
229 * @return pointer to the created array of dictionaries, NULL if it
232 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
235 * Print an error message to stderr, indicating filename and a human
236 * readable description of the error code err.
238 * If strerror_r() is not available the use of this function in a
239 * multithreaded application may be unsafe.
243 void print_error(const char *filename, int err);
246 * Print the program banner to stderr. The banner contents depend on the
247 * current version of the repository and of the libav* libraries used by
250 void show_banner(int argc, char **argv, const OptionDef *options);
253 * Print the version of the program to stdout. The version message
254 * depends on the current versions of the repository and of the libav*
256 * This option processing function does not utilize the arguments.
258 int opt_version(const char *opt, const char *arg);
261 * Print the license of the program to stdout. The license depends on
262 * the license of the libraries compiled into the program.
263 * This option processing function does not utilize the arguments.
265 int opt_license(const char *opt, const char *arg);
268 * Print a listing containing all the formats supported by the
270 * This option processing function does not utilize the arguments.
272 int opt_formats(const char *opt, const char *arg);
275 * Print a listing containing all the codecs supported by the
277 * This option processing function does not utilize the arguments.
279 int opt_codecs(const char *opt, const char *arg);
282 * Print a listing containing all the filters supported by the
284 * This option processing function does not utilize the arguments.
286 int opt_filters(const char *opt, const char *arg);
289 * Print a listing containing all the bit stream filters supported by the
291 * This option processing function does not utilize the arguments.
293 int opt_bsfs(const char *opt, const char *arg);
296 * Print a listing containing all the protocols supported by the
298 * This option processing function does not utilize the arguments.
300 int opt_protocols(const char *opt, const char *arg);
303 * Print a listing containing all the pixel formats supported by the
305 * This option processing function does not utilize the arguments.
307 int opt_pix_fmts(const char *opt, const char *arg);
310 * Print a listing containing all the sample formats supported by the
313 int show_sample_fmts(const char *opt, const char *arg);
316 * Return a positive value if a line read from standard input
317 * starts with [yY], otherwise return 0.
319 int read_yesno(void);
322 * Read the file with name filename, and put its content in a newly
323 * allocated 0-terminated buffer.
325 * @param bufptr location where pointer to buffer is returned
326 * @param size location where size of buffer is returned
327 * @return 0 in case of success, a negative value corresponding to an
328 * AVERROR error code in case of failure.
330 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
333 * Get a file corresponding to a preset file.
335 * If is_path is non-zero, look for the file in the path preset_name.
336 * Otherwise search for a file named arg.ffpreset in the directories
337 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
338 * at configuration time or in a "ffpresets" folder along the executable
339 * on win32, in that order. If no such file is found and
340 * codec_name is defined, then search for a file named
341 * codec_name-preset_name.ffpreset in the above-mentioned directories.
343 * @param filename buffer where the name of the found filename is written
344 * @param filename_size size in bytes of the filename buffer
345 * @param preset_name name of the preset to search
346 * @param is_path tell if preset_name is a filename path
347 * @param codec_name name of the codec for which to look for the
348 * preset, may be NULL
350 FILE *get_preset_file(char *filename, size_t filename_size,
351 const char *preset_name, int is_path, const char *codec_name);
354 * Do all the necessary cleanup and abort.
355 * This function is implemented in the avtools, not cmdutils.
357 void exit_program(int ret);
360 * Realloc array to hold new_size elements of elem_size.
361 * Calls exit_program() on failure.
363 * @param elem_size size in bytes of each element
364 * @param size new element count will be written here
365 * @return reallocated array
367 void *grow_array(void *array, int elem_size, int *size, int new_size);
369 #endif /* CMDUTILS_H */