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(void *optctx, const char *opt, const char *arg);
71 * Set the libav* libraries log level.
73 int opt_loglevel(void *optctx, const char *opt, const char *arg);
76 * Limit the execution time.
78 int opt_timelimit(void *optctx, 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 */
124 typedef struct OptionDef {
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_INT 0x0080
134 #define OPT_FLOAT 0x0100
135 #define OPT_SUBTITLE 0x0200
136 #define OPT_INT64 0x0400
137 #define OPT_EXIT 0x0800
138 #define OPT_DATA 0x1000
139 #define OPT_PERFILE 0x2000 /* the option is per-file (currently avconv-only).
140 implied by OPT_OFFSET or OPT_SPEC */
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)(void *, const char *, const char *);
157 * Print help for all options matching specified flags.
159 * @param options a list of options
160 * @param msg title of this group. Only printed if at least one option matches.
161 * @param req_flags print only options which have all those flags set.
162 * @param rej_flags don't print options which have any of those flags set.
163 * @param alt_flags print only options that have at least one of those flags set
165 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
166 int rej_flags, int alt_flags);
169 * Show help for all options with given flags in class and all its
172 void show_help_children(const AVClass *class, int flags);
175 * Per-avtool specific help handler. Implemented in each
176 * avtool, called by show_help().
178 void show_help_default(const char *opt, const char *arg);
181 * Generic -h handler common to all avtools.
183 int show_help(void *optctx, const char *opt, const char *arg);
186 * Parse the command line arguments.
188 * @param optctx an opaque options context
189 * @param options Array with the definitions required to interpret every
190 * option of the form: -option_name [argument]
191 * @param parse_arg_function Name of the function called to process every
192 * argument without a leading option name flag. NULL if such arguments do
193 * not have to be processed.
195 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
196 void (* parse_arg_function)(void *optctx, const char*));
199 * Parse one given option.
201 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
203 int parse_option(void *optctx, const char *opt, const char *arg,
204 const OptionDef *options);
207 * Find the '-loglevel' option in the command line args and apply it.
209 void parse_loglevel(int argc, char **argv, const OptionDef *options);
212 * Return index of option opt in argv or 0 if not found.
214 int locate_option(int argc, char **argv, const OptionDef *options,
215 const char *optname);
218 * Check if the given stream matches a stream specifier.
220 * @param s Corresponding format context.
221 * @param st Stream from s to be checked.
222 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
224 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
226 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
229 * Filter out options for given codec.
231 * Create a new options dictionary containing only the options from
232 * opts which apply to the codec with ID codec_id.
234 * @param s Corresponding format context.
235 * @param st A stream from s for which the options should be filtered.
236 * @param codec The particular codec for which the options should be filtered.
237 * If null, the default one is looked up according to the codec id.
238 * @return a pointer to the created dictionary
240 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
241 AVFormatContext *s, AVStream *st, AVCodec *codec);
244 * Setup AVCodecContext options for avformat_find_stream_info().
246 * Create an array of dictionaries, one dictionary for each stream
248 * Each dictionary will contain the options from codec_opts which can
249 * be applied to the corresponding stream codec context.
251 * @return pointer to the created array of dictionaries, NULL if it
254 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
255 AVDictionary *codec_opts);
258 * Print an error message to stderr, indicating filename and a human
259 * readable description of the error code err.
261 * If strerror_r() is not available the use of this function in a
262 * multithreaded application may be unsafe.
266 void print_error(const char *filename, int err);
269 * Print the program banner to stderr. The banner contents depend on the
270 * current version of the repository and of the libav* libraries used by
273 void show_banner(void);
276 * Print the version of the program to stdout. The version message
277 * depends on the current versions of the repository and of the libav*
280 int show_version(void *optctx, const char *opt, const char *arg);
283 * Print the license of the program to stdout. The license depends on
284 * the license of the libraries compiled into the program.
286 int show_license(void *optctx, const char *opt, const char *arg);
289 * Print a listing containing all the formats supported by the
292 int show_formats(void *optctx, const char *opt, const char *arg);
295 * Print a listing containing all the codecs supported by the
298 int show_codecs(void *optctx, const char *opt, const char *arg);
301 * Print a listing containing all the decoders supported by the
304 int show_decoders(void *optctx, const char *opt, const char *arg);
307 * Print a listing containing all the encoders supported by the
310 int show_encoders(void *optctx, const char *opt, const char *arg);
313 * Print a listing containing all the filters supported by the
316 int show_filters(void *optctx, const char *opt, const char *arg);
319 * Print a listing containing all the bit stream filters supported by the
322 int show_bsfs(void *optctx, const char *opt, const char *arg);
325 * Print a listing containing all the protocols supported by the
328 int show_protocols(void *optctx, const char *opt, const char *arg);
331 * Print a listing containing all the pixel formats supported by the
334 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
337 * Print a listing containing all the sample formats supported by the
340 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
343 * Return a positive value if a line read from standard input
344 * starts with [yY], otherwise return 0.
346 int read_yesno(void);
349 * Read the file with name filename, and put its content in a newly
350 * allocated 0-terminated buffer.
352 * @param bufptr location where pointer to buffer is returned
353 * @param size location where size of buffer is returned
354 * @return 0 in case of success, a negative value corresponding to an
355 * AVERROR error code in case of failure.
357 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
359 typedef struct PtsCorrectionContext {
360 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
361 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
362 int64_t last_pts; /// PTS of the last frame
363 int64_t last_dts; /// DTS of the last frame
364 } PtsCorrectionContext;
367 * Reset the state of the PtsCorrectionContext.
369 void init_pts_correction(PtsCorrectionContext *ctx);
372 * Attempt to guess proper monotonic timestamps for decoded video frames
373 * which might have incorrect times. Input timestamps may wrap around, in
374 * which case the output will as well.
376 * @param pts the pts field of the decoded AVPacket, as passed through
377 * AVCodecContext.reordered_opaque
378 * @param dts the dts field of the decoded AVPacket
379 * @return one of the input values, may be AV_NOPTS_VALUE
381 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
384 * Get a file corresponding to a preset file.
386 * If is_path is non-zero, look for the file in the path preset_name.
387 * Otherwise search for a file named arg.avpreset in the directories
388 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
389 * at configuration time, in that order. If no such file is found and
390 * codec_name is defined, then search for a file named
391 * codec_name-preset_name.avpreset in the above-mentioned directories.
393 * @param filename buffer where the name of the found filename is written
394 * @param filename_size size in bytes of the filename buffer
395 * @param preset_name name of the preset to search
396 * @param is_path tell if preset_name is a filename path
397 * @param codec_name name of the codec for which to look for the
398 * preset, may be NULL
400 FILE *get_preset_file(char *filename, size_t filename_size,
401 const char *preset_name, int is_path, const char *codec_name);
404 * Realloc array to hold new_size elements of elem_size.
405 * Calls exit() on failure.
407 * @param elem_size size in bytes of each element
408 * @param size new element count will be written here
409 * @return reallocated array
411 void *grow_array(void *array, int elem_size, int *size, int new_size);
413 typedef struct FrameBuffer {
419 enum AVPixelFormat pix_fmt;
422 struct FrameBuffer **pool; ///< head of the buffer pool
423 struct FrameBuffer *next;
427 * Get a frame from the pool. This is intended to be used as a callback for
428 * AVCodecContext.get_buffer.
430 * @param s codec context. s->opaque must be a pointer to the head of the
432 * @param frame frame->opaque will be set to point to the FrameBuffer
433 * containing the frame data.
435 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
438 * A callback to be used for AVCodecContext.release_buffer along with
439 * codec_get_buffer().
441 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
444 * A callback to be used for AVFilterBuffer.free.
445 * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
446 * containing the buffer data.
448 void filter_release_buffer(AVFilterBuffer *fb);
451 * Free all the buffers in the pool. This must be called after all the
452 * buffers have been released.
454 void free_buffer_pool(FrameBuffer **pool);
456 #define GET_PIX_FMT_NAME(pix_fmt)\
457 const char *name = av_get_pix_fmt_name(pix_fmt);
459 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
460 const char *name = av_get_sample_fmt_name(sample_fmt)
462 #define GET_SAMPLE_RATE_NAME(rate)\
464 snprintf(name, sizeof(name), "%d", rate);
466 #define GET_CH_LAYOUT_NAME(ch_layout)\
468 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
470 #define GET_CH_LAYOUT_DESC(ch_layout)\
472 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
474 #endif /* LIBAV_CMDUTILS_H */