cmdutils.h 11.3 KB
Newer Older
Diego Biurrun's avatar
Diego Biurrun committed
1 2 3 4
/*
 * Various utilities for command line tools
 * copyright (c) 2003 Fabrice Bellard
 *
5
 * This file is part of Libav.
Diego Biurrun's avatar
Diego Biurrun committed
6
 *
7
 * Libav is free software; you can redistribute it and/or
Diego Biurrun's avatar
Diego Biurrun committed
8 9 10 11
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * 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,
Diego Biurrun's avatar
Diego Biurrun committed
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with Libav; if not, write to the Free Software
Diego Biurrun's avatar
Diego Biurrun committed
19 20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22 23
#ifndef LIBAV_CMDUTILS_H
#define LIBAV_CMDUTILS_H
Fabrice Bellard's avatar
Fabrice Bellard committed
24

25 26
#include <stdint.h>

27
#include "libavcodec/avcodec.h"
28
#include "libavfilter/avfilter.h"
29 30
#include "libavformat/avformat.h"
#include "libswscale/swscale.h"
31

32 33 34 35 36
/**
 * program name, defined by the program for show_version().
 */
extern const char program_name[];

37 38 39 40 41
/**
 * program birth year, defined by the program for show_banner()
 */
extern const int program_birth_year;

42
extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
43 44
extern AVFormatContext *avformat_opts;
extern struct SwsContext *sws_opts;
45
extern AVDictionary *format_opts, *codec_opts;
46

47 48 49 50 51 52 53 54 55 56 57
/**
 * Initialize the cmdutils option system, in particular
 * allocate the *_opts contexts.
 */
void init_opts(void);
/**
 * Uninitialize the cmdutils option system, in particular
 * free the *_opts contexts and their contents.
 */
void uninit_opts(void);

58 59 60 61 62 63
/**
 * Trivial log callback.
 * Only suitable for show_help and similar since it lacks prefix handling.
 */
void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);

64
/**
65
 * Fallback for options that are not explicitly handled, these will be
66 67 68 69
 * parsed through AVOptions.
 */
int opt_default(const char *opt, const char *arg);

70
/**
71
 * Set the libav* libraries log level.
72 73 74
 */
int opt_loglevel(const char *opt, const char *arg);

Måns Rullgård's avatar
Måns Rullgård committed
75 76 77 78 79
/**
 * Limit the execution time.
 */
int opt_timelimit(const char *opt, const char *arg);

80
/**
81 82
 * Parse a string and return its corresponding value as a double.
 * Exit from the application if the string cannot be correctly
83
 * parsed or the corresponding value is invalid.
84 85 86 87 88 89
 *
 * @param context the context of the value to be set (e.g. the
 * corresponding commandline option name)
 * @param numstr the string to be parsed
 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
 * string should be parsed
90 91
 * @param min the minimum valid accepted value
 * @param max the maximum valid accepted value
92 93 94
 */
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);

95
/**
96 97
 * Parse a string specifying a time and return its corresponding
 * value as a number of microseconds. Exit from the application if
98 99 100 101 102
 * the string cannot be correctly parsed.
 *
 * @param context the context of the value to be set (e.g. the
 * corresponding commandline option name)
 * @param timestr the string to be parsed
103 104
 * @param is_duration a flag which tells how to interpret timestr, if
 * not zero timestr is interpreted as a duration, otherwise as a
105 106
 * date
 *
Stefano Sabatini's avatar
Typo  
Stefano Sabatini committed
107
 * @see parse_date()
108 109 110
 */
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);

111 112 113 114 115 116 117 118 119 120
typedef struct SpecifierOpt {
    char *specifier;    /**< stream/chapter/program/... specifier */
    union {
        uint8_t *str;
        int        i;
        int64_t  i64;
        float      f;
    } u;
} SpecifierOpt;

Fabrice Bellard's avatar
Fabrice Bellard committed
121 122 123 124 125 126 127
typedef struct {
    const char *name;
    int flags;
#define HAS_ARG    0x0001
#define OPT_BOOL   0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008
128 129 130
#define OPT_VIDEO  0x0010
#define OPT_AUDIO  0x0020
#define OPT_GRAB   0x0040
Michael Niedermayer's avatar
OPT_INT  
Michael Niedermayer committed
131
#define OPT_INT    0x0080
Michael Niedermayer's avatar
Michael Niedermayer committed
132
#define OPT_FLOAT  0x0100
Fabrice Bellard's avatar
Fabrice Bellard committed
133
#define OPT_SUBTITLE 0x0200
Stefano Sabatini's avatar
Stefano Sabatini committed
134 135 136
#define OPT_INT64  0x0400
#define OPT_EXIT   0x0800
#define OPT_DATA   0x1000
137 138
#define OPT_FUNC2  0x2000
#define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
139 140 141
#define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
                                   Implies OPT_OFFSET. Next element after the offset is
                                   an int containing element count in the array. */
Fabrice Bellard's avatar
Fabrice Bellard committed
142
     union {
143
        void *dst_ptr;
Stefano Sabatini's avatar
Stefano Sabatini committed
144
        int (*func_arg)(const char *, const char *);
145 146
        int (*func2_arg)(void *, const char *, const char *);
        size_t off;
Fabrice Bellard's avatar
Fabrice Bellard committed
147 148 149 150 151
    } u;
    const char *help;
    const char *argname;
} OptionDef;

152
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
153 154

/**
155
 * Parse the command line arguments.
156 157
 *
 * @param optctx an opaque options context
158
 * @param options Array with the definitions required to interpret every
159
 * option of the form: -option_name [argument]
160 161 162 163
 * @param parse_arg_function Name of the function called to process every
 * argument without a leading option name flag. NULL if such arguments do
 * not have to be processed.
 */
164 165
void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
                   void (* parse_arg_function)(void *optctx, const char*));
166

167 168 169 170 171 172 173
/**
 * Parse one given option.
 *
 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
 */
int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options);

174 175 176 177 178 179 180 181 182 183 184
/**
 * Check if the given stream matches a stream specifier.
 *
 * @param s  Corresponding format context.
 * @param st Stream from s to be checked.
 * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
 *
 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
 */
int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);

185 186
/**
 * Filter out options for given codec.
187 188 189 190
 *
 * Create a new options dictionary containing only the options from
 * opts which apply to the codec with ID codec_id.
 *
191 192
 * @param s Corresponding format context.
 * @param st A stream from s for which the options should be filtered.
193
 * @return a pointer to the created dictionary
194
 */
195
AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
196

197 198 199 200 201 202 203 204 205 206
/**
 * Setup AVCodecContext options for avformat_find_stream_info().
 *
 * Create an array of dictionaries, one dictionary for each stream
 * contained in s.
 * Each dictionary will contain the options from codec_opts which can
 * be applied to the corresponding stream codec context.
 *
 * @return pointer to the created array of dictionaries, NULL if it
 * cannot be created
207
 */
208
AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
209

210
/**
211
 * Print an error message to stderr, indicating filename and a human
212 213 214 215 216 217 218
 * readable description of the error code err.
 *
 * If strerror_r() is not available the use of this function in a
 * multithreaded application may be unsafe.
 *
 * @see av_strerror()
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
219
void print_error(const char *filename, int err);
220

221
/**
222
 * Print the program banner to stderr. The banner contents depend on the
223 224
 * current version of the repository and of the libav* libraries used by
 * the program.
225
 */
226
void show_banner(void);
227 228

/**
229
 * Print the version of the program to stdout. The version message
230 231 232
 * depends on the current versions of the repository and of the libav*
 * libraries.
 */
233
void show_version(void);
234

235
/**
236
 * Print the license of the program to stdout. The license depends on
237
 * the license of the libraries compiled into the program.
238 239 240
 */
void show_license(void);

241
/**
242
 * Print a listing containing all the formats supported by the
243 244 245 246
 * program.
 */
void show_formats(void);

Michael Niedermayer's avatar
Michael Niedermayer committed
247
/**
248
 * Print a listing containing all the codecs supported by the
Michael Niedermayer's avatar
Michael Niedermayer committed
249 250 251 252
 * program.
 */
void show_codecs(void);

253
/**
254
 * Print a listing containing all the filters supported by the
255 256 257 258
 * program.
 */
void show_filters(void);

Michael Niedermayer's avatar
Michael Niedermayer committed
259
/**
260
 * Print a listing containing all the bit stream filters supported by the
Michael Niedermayer's avatar
Michael Niedermayer committed
261 262 263 264 265
 * program.
 */
void show_bsfs(void);

/**
266
 * Print a listing containing all the protocols supported by the
Michael Niedermayer's avatar
Michael Niedermayer committed
267 268 269 270
 * program.
 */
void show_protocols(void);

271
/**
272
 * Print a listing containing all the pixel formats supported by the
273 274 275 276
 * program.
 */
void show_pix_fmts(void);

Stefano Sabatini's avatar
Stefano Sabatini committed
277
/**
Måns Rullgård's avatar
Måns Rullgård committed
278 279
 * Return a positive value if a line read from standard input
 * starts with [yY], otherwise return 0.
Stefano Sabatini's avatar
Stefano Sabatini committed
280 281 282
 */
int read_yesno(void);

283
/**
284
 * Read the file with name filename, and put its content in a newly
285 286
 * allocated 0-terminated buffer.
 *
287 288
 * @param bufptr location where pointer to buffer is returned
 * @param size   location where size of buffer is returned
289 290 291 292 293
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR error code in case of failure.
 */
int read_file(const char *filename, char **bufptr, size_t *size);

294 295 296 297 298 299 300 301
typedef struct {
    int64_t num_faulty_pts; /// Number of incorrect PTS values so far
    int64_t num_faulty_dts; /// Number of incorrect DTS values so far
    int64_t last_pts;       /// PTS of the last frame
    int64_t last_dts;       /// DTS of the last frame
} PtsCorrectionContext;

/**
302
 * Reset the state of the PtsCorrectionContext.
303 304 305 306
 */
void init_pts_correction(PtsCorrectionContext *ctx);

/**
307
 * Attempt to guess proper monotonic timestamps for decoded video frames
308 309 310
 * which might have incorrect times. Input timestamps may wrap around, in
 * which case the output will as well.
 *
311
 * @param pts the pts field of the decoded AVPacket, as passed through
312
 * AVCodecContext.reordered_opaque
313 314
 * @param dts the dts field of the decoded AVPacket
 * @return one of the input values, may be AV_NOPTS_VALUE
315 316 317
 */
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
/**
 * Get a file corresponding to a preset file.
 *
 * If is_path is non-zero, look for the file in the path preset_name.
 * Otherwise search for a file named arg.ffpreset in the directories
 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 * at configuration time, in that order. If no such file is found and
 * codec_name is defined, then search for a file named
 * codec_name-preset_name.ffpreset in the above-mentioned directories.
 *
 * @param filename buffer where the name of the found filename is written
 * @param filename_size size in bytes of the filename buffer
 * @param preset_name name of the preset to search
 * @param is_path tell if preset_name is a filename path
 * @param codec_name name of the codec for which to look for the
 * preset, may be NULL
 */
FILE *get_preset_file(char *filename, size_t filename_size,
                      const char *preset_name, int is_path, const char *codec_name);

338 339 340 341 342 343
typedef struct {
    enum PixelFormat pix_fmt;
} FFSinkContext;

extern AVFilter ffsink;

344 345 346 347 348 349 350 351 352
/**
 * Extract a frame from sink.
 *
 * @return a negative error in case of failure, 1 if one frame has
 * been extracted successfully.
 */
int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
                             AVFilterBufferRef **picref, AVRational *pts_tb);

353 354 355 356 357 358
/**
 * Do all the necessary cleanup and abort.
 * This function is implemented in the avtools, not cmdutils.
 */
void exit_program(int ret);

359 360 361 362 363 364 365 366 367 368
/**
 * Realloc array to hold new_size elements of elem_size.
 * Calls exit_program() on failure.
 *
 * @param elem_size size in bytes of each element
 * @param size new element count will be written here
 * @return reallocated array
 */
void *grow_array(void *array, int elem_size, int *size, int new_size);

369
#endif /* LIBAV_CMDUTILS_H */