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);
80 * Limit the execution time.
82 int opt_timelimit(const char *opt, const char *arg);
85 * Parse a string and return its corresponding value as a double.
86 * Exit from the application if the string cannot be correctly
87 * parsed or the corresponding value is invalid.
89 * @param context the context of the value to be set (e.g. the
90 * corresponding commandline option name)
91 * @param numstr the string to be parsed
92 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
93 * string should be parsed
94 * @param min the minimum valid accepted value
95 * @param max the maximum valid accepted value
97 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
100 * Parse a string specifying a time and return its corresponding
101 * value as a number of microseconds. Exit from the application if
102 * the string cannot be correctly parsed.
104 * @param context the context of the value to be set (e.g. the
105 * corresponding commandline option name)
106 * @param timestr the string to be parsed
107 * @param is_duration a flag which tells how to interpret timestr, if
108 * not zero timestr is interpreted as a duration, otherwise as a
113 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
118 #define HAS_ARG 0x0001
119 #define OPT_BOOL 0x0002
120 #define OPT_EXPERT 0x0004
121 #define OPT_STRING 0x0008
122 #define OPT_VIDEO 0x0010
123 #define OPT_AUDIO 0x0020
124 #define OPT_GRAB 0x0040
125 #define OPT_INT 0x0080
126 #define OPT_FLOAT 0x0100
127 #define OPT_SUBTITLE 0x0200
128 #define OPT_INT64 0x0400
129 #define OPT_EXIT 0x0800
130 #define OPT_DATA 0x1000
135 int (*func_arg)(const char *, const char *);
142 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
145 * Parse the command line arguments.
146 * @param options Array with the definitions required to interpret every
147 * option of the form: -option_name [argument]
148 * @param parse_arg_function Name of the function called to process every
149 * argument without a leading option name flag. NULL if such arguments do
150 * not have to be processed.
152 void parse_options(int argc, char **argv, const OptionDef *options,
153 int (* parse_arg_function)(const char *opt, const char *arg));
156 * Check if the given stream matches a stream specifier.
158 * @param s Corresponding format context.
159 * @param st Stream from s to be checked.
160 * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
162 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
164 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
167 * Filter out options for given codec.
169 * Create a new options dictionary containing only the options from
170 * opts which apply to the codec with ID codec_id.
172 * @param s Corresponding format context.
173 * @param st A stream from s for which the options should be filtered.
174 * @return a pointer to the created dictionary
176 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
179 * Setup AVCodecContext options for avformat_find_stream_info().
181 * Create an array of dictionaries, one dictionary for each stream
183 * Each dictionary will contain the options from codec_opts which can
184 * be applied to the corresponding stream codec context.
186 * @return pointer to the created array of dictionaries, NULL if it
189 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
192 * Print an error message to stderr, indicating filename and a human
193 * readable description of the error code err.
195 * If strerror_r() is not available the use of this function in a
196 * multithreaded application may be unsafe.
200 void print_error(const char *filename, int err);
203 * Print the program banner to stderr. The banner contents depend on the
204 * current version of the repository and of the libav* libraries used by
207 void show_banner(void);
210 * Print the version of the program to stdout. The version message
211 * depends on the current versions of the repository and of the libav*
213 * This option processing function does not utilize the arguments.
215 int opt_version(const char *opt, const char *arg);
218 * Print the license of the program to stdout. The license depends on
219 * the license of the libraries compiled into the program.
220 * This option processing function does not utilize the arguments.
222 int opt_license(const char *opt, const char *arg);
225 * Print a listing containing all the formats supported by the
227 * This option processing function does not utilize the arguments.
229 int opt_formats(const char *opt, const char *arg);
232 * Print a listing containing all the codecs supported by the
234 * This option processing function does not utilize the arguments.
236 int opt_codecs(const char *opt, const char *arg);
239 * Print a listing containing all the filters supported by the
241 * This option processing function does not utilize the arguments.
243 int opt_filters(const char *opt, const char *arg);
246 * Print a listing containing all the bit stream filters supported by the
248 * This option processing function does not utilize the arguments.
250 int opt_bsfs(const char *opt, const char *arg);
253 * Print a listing containing all the protocols supported by the
255 * This option processing function does not utilize the arguments.
257 int opt_protocols(const char *opt, const char *arg);
260 * Print a listing containing all the pixel formats supported by the
262 * This option processing function does not utilize the arguments.
264 int opt_pix_fmts(const char *opt, const char *arg);
267 * Return a positive value if a line read from standard input
268 * starts with [yY], otherwise return 0.
270 int read_yesno(void);
273 * Read the file with name filename, and put its content in a newly
274 * allocated 0-terminated buffer.
276 * @param bufptr location where pointer to buffer is returned
277 * @param size location where size of buffer is returned
278 * @return 0 in case of success, a negative value corresponding to an
279 * AVERROR error code in case of failure.
281 int read_file(const char *filename, char **bufptr, size_t *size);
284 * Get a file corresponding to a preset file.
286 * If is_path is non-zero, look for the file in the path preset_name.
287 * Otherwise search for a file named arg.ffpreset in the directories
288 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
289 * at configuration time or in a "ffpresets" folder along the executable
290 * on win32, in that order. If no such file is found and
291 * codec_name is defined, then search for a file named
292 * codec_name-preset_name.ffpreset in the above-mentioned directories.
294 * @param filename buffer where the name of the found filename is written
295 * @param filename_size size in bytes of the filename buffer
296 * @param preset_name name of the preset to search
297 * @param is_path tell if preset_name is a filename path
298 * @param codec_name name of the codec for which to look for the
299 * preset, may be NULL
301 FILE *get_preset_file(char *filename, size_t filename_size,
302 const char *preset_name, int is_path, const char *codec_name);
304 #endif /* FFMPEG_CMDUTILS_H */