2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef LIBAV_CMDUTILS_H
23 #define LIBAV_CMDUTILS_H
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
33 * program name, defined by the program for show_version().
35 extern const char program_name[];
38 * program birth year, defined by the program for show_banner()
40 extern const int program_birth_year;
42 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
43 extern AVFormatContext *avformat_opts;
44 extern struct SwsContext *sws_opts;
45 extern AVDictionary *format_opts, *codec_opts;
48 * Initialize the cmdutils option system, in particular
49 * allocate the *_opts contexts.
53 * Uninitialize the cmdutils option system, in particular
54 * free the *_opts contexts and their contents.
56 void uninit_opts(void);
59 * Trivial log callback.
60 * Only suitable for show_help and similar since it lacks prefix handling.
62 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
65 * Fallback for options that are not explicitly handled, these will be
66 * parsed through AVOptions.
68 int opt_default(const char *opt, const char *arg);
71 * Set the libav* libraries log level.
73 int opt_loglevel(const char *opt, const char *arg);
76 * Limit the execution time.
78 int opt_timelimit(const char *opt, const char *arg);
81 * Parse a string and return its corresponding value as a double.
82 * Exit from the application if the string cannot be correctly
83 * parsed or the corresponding value is invalid.
85 * @param context the context of the value to be set (e.g. the
86 * corresponding command line option name)
87 * @param numstr the string to be parsed
88 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
89 * string should be parsed
90 * @param min the minimum valid accepted value
91 * @param max the maximum valid accepted value
93 double parse_number_or_die(const char *context, const char *numstr, int type,
94 double min, double max);
97 * Parse a string specifying a time and return its corresponding
98 * value as a number of microseconds. Exit from the application if
99 * the string cannot be correctly parsed.
101 * @param context the context of the value to be set (e.g. the
102 * corresponding command line option name)
103 * @param timestr the string to be parsed
104 * @param is_duration a flag which tells how to interpret timestr, if
105 * not zero timestr is interpreted as a duration, otherwise as a
110 int64_t parse_time_or_die(const char *context, const char *timestr,
113 typedef struct SpecifierOpt {
114 char *specifier; /**< stream/chapter/program/... specifier */
127 #define HAS_ARG 0x0001
128 #define OPT_BOOL 0x0002
129 #define OPT_EXPERT 0x0004
130 #define OPT_STRING 0x0008
131 #define OPT_VIDEO 0x0010
132 #define OPT_AUDIO 0x0020
133 #define OPT_GRAB 0x0040
134 #define OPT_INT 0x0080
135 #define OPT_FLOAT 0x0100
136 #define OPT_SUBTITLE 0x0200
137 #define OPT_INT64 0x0400
138 #define OPT_EXIT 0x0800
139 #define OPT_DATA 0x1000
140 #define OPT_FUNC2 0x2000
141 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
142 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
143 Implies OPT_OFFSET. Next element after the offset is
144 an int containing element count in the array. */
145 #define OPT_TIME 0x10000
146 #define OPT_DOUBLE 0x20000
149 int (*func_arg)(const char *, const char *);
150 int (*func2_arg)(void *, const char *, const char *);
157 void show_help_options(const OptionDef *options, const char *msg, int mask,
161 * Show help for all options with given flags in class and all its
164 void show_help_children(const AVClass *class, int flags);
167 * Parse the command line arguments.
169 * @param optctx an opaque options context
170 * @param options Array with the definitions required to interpret every
171 * option of the form: -option_name [argument]
172 * @param parse_arg_function Name of the function called to process every
173 * argument without a leading option name flag. NULL if such arguments do
174 * not have to be processed.
176 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
177 void (* parse_arg_function)(void *optctx, const char*));
180 * Parse one given option.
182 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
184 int parse_option(void *optctx, const char *opt, const char *arg,
185 const OptionDef *options);
188 * Find the '-loglevel' option in the command line args and apply it.
190 void parse_loglevel(int argc, char **argv, const OptionDef *options);
193 * Return index of option opt in argv or 0 if not found.
195 int locate_option(int argc, char **argv, const OptionDef *options,
196 const char *optname);
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 * @param codec The particular codec for which the options should be filtered.
218 * If null, the default one is looked up according to the codec id.
219 * @return a pointer to the created dictionary
221 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id,
222 AVFormatContext *s, AVStream *st, AVCodec *codec);
225 * Setup AVCodecContext options for avformat_find_stream_info().
227 * Create an array of dictionaries, one dictionary for each stream
229 * Each dictionary will contain the options from codec_opts which can
230 * be applied to the corresponding stream codec context.
232 * @return pointer to the created array of dictionaries, NULL if it
235 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
236 AVDictionary *codec_opts);
239 * Print an error message to stderr, indicating filename and a human
240 * readable description of the error code err.
242 * If strerror_r() is not available the use of this function in a
243 * multithreaded application may be unsafe.
247 void print_error(const char *filename, int err);
250 * Print the program banner to stderr. The banner contents depend on the
251 * current version of the repository and of the libav* libraries used by
254 void show_banner(void);
257 * Print the version of the program to stdout. The version message
258 * depends on the current versions of the repository and of the libav*
261 void show_version(void);
264 * Print the license of the program to stdout. The license depends on
265 * the license of the libraries compiled into the program.
267 void show_license(void);
270 * Print a listing containing all the formats supported by the
273 void show_formats(void);
276 * Print a listing containing all the codecs supported by the
279 void show_codecs(void);
282 * Print a listing containing all the filters supported by the
285 void show_filters(void);
288 * Print a listing containing all the bit stream filters supported by the
291 void show_bsfs(void);
294 * Print a listing containing all the protocols supported by the
297 void show_protocols(void);
300 * Print a listing containing all the pixel formats supported by the
303 void show_pix_fmts(void);
306 * Print a listing containing all the sample formats supported by the
309 int show_sample_fmts(const char *opt, const char *arg);
312 * Return a positive value if a line read from standard input
313 * starts with [yY], otherwise return 0.
315 int read_yesno(void);
318 * Read the file with name filename, and put its content in a newly
319 * allocated 0-terminated buffer.
321 * @param bufptr location where pointer to buffer is returned
322 * @param size location where size of buffer is returned
323 * @return 0 in case of success, a negative value corresponding to an
324 * AVERROR error code in case of failure.
326 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
329 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
330 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
331 int64_t last_pts; /// PTS of the last frame
332 int64_t last_dts; /// DTS of the last frame
333 } PtsCorrectionContext;
336 * Reset the state of the PtsCorrectionContext.
338 void init_pts_correction(PtsCorrectionContext *ctx);
341 * Attempt to guess proper monotonic timestamps for decoded video frames
342 * which might have incorrect times. Input timestamps may wrap around, in
343 * which case the output will as well.
345 * @param pts the pts field of the decoded AVPacket, as passed through
346 * AVCodecContext.reordered_opaque
347 * @param dts the dts field of the decoded AVPacket
348 * @return one of the input values, may be AV_NOPTS_VALUE
350 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
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.avpreset in the directories
357 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
358 * at configuration time, in that order. If no such file is found and
359 * codec_name is defined, then search for a file named
360 * codec_name-preset_name.avpreset in the above-mentioned directories.
362 * @param filename buffer where the name of the found filename is written
363 * @param filename_size size in bytes of the filename buffer
364 * @param preset_name name of the preset to search
365 * @param is_path tell if preset_name is a filename path
366 * @param codec_name name of the codec for which to look for the
367 * preset, may be NULL
369 FILE *get_preset_file(char *filename, size_t filename_size,
370 const char *preset_name, int is_path, const char *codec_name);
373 * Do all the necessary cleanup and abort.
374 * This function is implemented in the avtools, not cmdutils.
376 av_noreturn void exit_program(int ret);
379 * Realloc array to hold new_size elements of elem_size.
380 * Calls exit_program() on failure.
382 * @param elem_size size in bytes of each element
383 * @param size new element count will be written here
384 * @return reallocated array
386 void *grow_array(void *array, int elem_size, int *size, int new_size);
388 typedef struct FrameBuffer {
394 enum PixelFormat pix_fmt;
397 struct FrameBuffer **pool; ///< head of the buffer pool
398 struct FrameBuffer *next;
402 * Get a frame from the pool. This is intended to be used as a callback for
403 * AVCodecContext.get_buffer.
405 * @param s codec context. s->opaque must be a pointer to the head of the
407 * @param frame frame->opaque will be set to point to the FrameBuffer
408 * containing the frame data.
410 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
413 * A callback to be used for AVCodecContext.release_buffer along with
414 * codec_get_buffer().
416 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
419 * A callback to be used for AVFilterBuffer.free.
420 * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
421 * containing the buffer data.
423 void filter_release_buffer(AVFilterBuffer *fb);
426 * Free all the buffers in the pool. This must be called after all the
427 * buffers have been released.
429 void free_buffer_pool(FrameBuffer **pool);
430 #endif /* LIBAV_CMDUTILS_H */