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 struct SwrContext *swr_opts;
55 extern AVDictionary *format_opts, *codec_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(const char *opt, const char *arg);
81 * Set the libav* libraries log level.
83 int opt_loglevel(const char *opt, const char *arg);
85 int opt_report(const char *opt);
87 int opt_max_alloc(const char *opt, const char *arg);
89 int opt_cpuflags(const char *opt, const char *arg);
91 int opt_codec_debug(const char *opt, const char *arg);
94 * Limit the execution time.
96 int opt_timelimit(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
128 int64_t parse_time_or_die(const char *context, const char *timestr,
131 typedef struct SpecifierOpt {
132 char *specifier; /**< stream/chapter/program/... specifier */
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_GRAB 0x0040
152 #define OPT_INT 0x0080
153 #define OPT_FLOAT 0x0100
154 #define OPT_SUBTITLE 0x0200
155 #define OPT_INT64 0x0400
156 #define OPT_EXIT 0x0800
157 #define OPT_DATA 0x1000
158 #define OPT_FUNC2 0x2000
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
167 int (*func_arg)(const char *, const char *);
168 int (*func2_arg)(void *, const char *, const char *);
175 void show_help_options(const OptionDef *options, const char *msg, int mask,
179 * Show help for all options with given flags in class and all its
182 void show_help_children(const AVClass *class, int flags);
185 * Parse the command line arguments.
187 * @param optctx an opaque options context
188 * @param options Array with the definitions required to interpret every
189 * option of the form: -option_name [argument]
190 * @param parse_arg_function Name of the function called to process every
191 * argument without a leading option name flag. NULL if such arguments do
192 * not have to be processed.
194 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
195 void (* parse_arg_function)(void *optctx, const char*));
198 * Parse one given option.
200 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
202 int parse_option(void *optctx, const char *opt, const char *arg,
203 const OptionDef *options);
206 * Find the '-loglevel' option in the command line args and apply it.
208 void parse_loglevel(int argc, char **argv, const OptionDef *options);
211 * Return index of option opt in argv or 0 if not found.
213 int locate_option(int argc, char **argv, const OptionDef *options,
214 const char *optname);
217 * Check if the given stream matches a stream specifier.
219 * @param s Corresponding format context.
220 * @param st Stream from s to be checked.
221 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
223 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
225 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
228 * Filter out options for given codec.
230 * Create a new options dictionary containing only the options from
231 * opts which apply to the codec with ID codec_id.
233 * @param s Corresponding format context.
234 * @param st A stream from s for which the options should be filtered.
235 * @return a pointer to the created dictionary
237 AVDictionary *filter_codec_opts(AVDictionary *opts, AVCodec *codec,
238 AVFormatContext *s, AVStream *st);
241 * Setup AVCodecContext options for avformat_find_stream_info().
243 * Create an array of dictionaries, one dictionary for each stream
245 * Each dictionary will contain the options from codec_opts which can
246 * be applied to the corresponding stream codec context.
248 * @return pointer to the created array of dictionaries, NULL if it
251 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
252 AVDictionary *codec_opts);
255 * Print an error message to stderr, indicating filename and a human
256 * readable description of the error code err.
258 * If strerror_r() is not available the use of this function in a
259 * multithreaded application may be unsafe.
263 void print_error(const char *filename, int err);
266 * Print the program banner to stderr. The banner contents depend on the
267 * current version of the repository and of the libav* libraries used by
270 void show_banner(int argc, char **argv, const OptionDef *options);
273 * Print the version of the program to stdout. The version message
274 * depends on the current versions of the repository and of the libav*
276 * This option processing function does not utilize the arguments.
278 int opt_version(const char *opt, const char *arg);
281 * Print the license of the program to stdout. The license depends on
282 * the license of the libraries compiled into the program.
283 * This option processing function does not utilize the arguments.
285 int opt_license(const char *opt, const char *arg);
288 * Print a listing containing all the formats supported by the
290 * This option processing function does not utilize the arguments.
292 int opt_formats(const char *opt, const char *arg);
295 * Print a listing containing all the codecs supported by the
297 * This option processing function does not utilize the arguments.
299 int opt_codecs(const char *opt, const char *arg);
302 * Print a listing containing all the filters supported by the
304 * This option processing function does not utilize the arguments.
306 int opt_filters(const char *opt, const char *arg);
309 * Print a listing containing all the bit stream filters supported by the
311 * This option processing function does not utilize the arguments.
313 int opt_bsfs(const char *opt, const char *arg);
316 * Print a listing containing all the protocols supported by the
318 * This option processing function does not utilize the arguments.
320 int opt_protocols(const char *opt, const char *arg);
323 * Print a listing containing all the pixel formats supported by the
325 * This option processing function does not utilize the arguments.
327 int opt_pix_fmts(const char *opt, const char *arg);
330 * Print a listing containing all the sample formats supported by the
333 int show_sample_fmts(const char *opt, const char *arg);
336 * Return a positive value if a line read from standard input
337 * starts with [yY], otherwise return 0.
339 int read_yesno(void);
342 * Read the file with name filename, and put its content in a newly
343 * allocated 0-terminated buffer.
345 * @param bufptr location where pointer to buffer is returned
346 * @param size location where size of buffer is returned
347 * @return 0 in case of success, a negative value corresponding to an
348 * AVERROR error code in case of failure.
350 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
353 * Get a file corresponding to a preset file.
355 * If is_path is non-zero, look for the file in the path preset_name.
356 * Otherwise search for a file named arg.ffpreset in the directories
357 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
358 * at configuration time or in a "ffpresets" folder along the executable
359 * on win32, in that order. If no such file is found and
360 * codec_name is defined, then search for a file named
361 * codec_name-preset_name.avpreset in the above-mentioned directories.
363 * @param filename buffer where the name of the found filename is written
364 * @param filename_size size in bytes of the filename buffer
365 * @param preset_name name of the preset to search
366 * @param is_path tell if preset_name is a filename path
367 * @param codec_name name of the codec for which to look for the
368 * preset, may be NULL
370 FILE *get_preset_file(char *filename, size_t filename_size,
371 const char *preset_name, int is_path, const char *codec_name);
374 * Do all the necessary cleanup and abort.
375 * This function is implemented in the avtools, not cmdutils.
377 void exit_program(int ret);
380 * Realloc array to hold new_size elements of elem_size.
381 * Calls exit_program() on failure.
383 * @param elem_size size in bytes of each element
384 * @param size new element count will be written here
385 * @return reallocated array
387 void *grow_array(void *array, int elem_size, int *size, int new_size);
389 #endif /* CMDUTILS_H */