cmdutils.h 16.9 KB
Newer Older
1 2 3 4
/*
 * Various utilities for command line tools
 * copyright (c) 2003 Fabrice Bellard
 *
5
 * This file is part of Libav.
6
 *
7
 * Libav is free software; you can redistribute it and/or
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,
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
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, *resample_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
 * parsed through AVOptions.
 */
68
int opt_default(void *optctx, const char *opt, const char *arg);
69

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

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

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
 *
 * @param context the context of the value to be set (e.g. the
86
 * corresponding command line option name)
87 88 89
 * @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 98
 * Parse a string specifying a time and return its corresponding
 * value as a number of microseconds. Exit from the application if
99 100 101
 * the string cannot be correctly parsed.
 *
 * @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 105
 * @param is_duration a flag which tells how to interpret timestr, if
 * not zero timestr is interpreted as a duration, otherwise as a
106 107
 * date
 *
Stefano Sabatini's avatar
Stefano Sabatini committed
108
 * @see parse_date()
109
 */
110 111
int64_t parse_time_or_die(const char *context, const char *timestr,
                          int is_duration);
112

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

124
typedef struct OptionDef {
Fabrice Bellard's avatar
Fabrice Bellard committed
125 126 127 128 129 130
    const char *name;
    int flags;
#define HAS_ARG    0x0001
#define OPT_BOOL   0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008
131 132
#define OPT_VIDEO  0x0010
#define OPT_AUDIO  0x0020
Michael Niedermayer's avatar
Michael Niedermayer committed
133
#define OPT_INT    0x0080
134
#define OPT_FLOAT  0x0100
Fabrice Bellard's avatar
Fabrice Bellard committed
135
#define OPT_SUBTITLE 0x0200
136 137 138
#define OPT_INT64  0x0400
#define OPT_EXIT   0x0800
#define OPT_DATA   0x1000
139 140
#define OPT_PERFILE  0x2000     /* the option is per-file (currently avconv-only).
                                   implied by OPT_OFFSET or OPT_SPEC */
141
#define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
142 143 144
#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. */
145
#define OPT_TIME  0x10000
146
#define OPT_DOUBLE 0x20000
Fabrice Bellard's avatar
Fabrice Bellard committed
147
     union {
148
        void *dst_ptr;
149
        int (*func_arg)(void *, const char *, const char *);
150
        size_t off;
Fabrice Bellard's avatar
Fabrice Bellard committed
151 152 153 154 155
    } u;
    const char *help;
    const char *argname;
} OptionDef;

156 157 158 159 160 161 162
/**
 * Print help for all options matching specified flags.
 *
 * @param options a list of options
 * @param msg title of this group. Only printed if at least one option matches.
 * @param req_flags print only options which have all those flags set.
 * @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
164 165
 */
void show_help_options(const OptionDef *options, const char *msg, int req_flags,
166
                       int rej_flags, int alt_flags);
167

168 169 170 171 172 173
/**
 * Show help for all options with given flags in class and all its
 * children.
 */
void show_help_children(const AVClass *class, int flags);

174 175 176 177 178 179 180 181 182
/**
 * Per-avtool specific help handler. Implemented in each
 * avtool, called by show_help().
 */
void show_help_default(const char *opt, const char *arg);

/**
 * Generic -h handler common to all avtools.
 */
183
int show_help(void *optctx, const char *opt, const char *arg);
184

185
/**
186
 * Parse the command line arguments.
187 188
 *
 * @param optctx an opaque options context
189 190
 * @param argc   number of command line arguments
 * @param argv   values of command line arguments
191
 * @param options Array with the definitions required to interpret every
192
 * option of the form: -option_name [argument]
193 194 195 196
 * @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.
 */
197 198
void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
                   void (* parse_arg_function)(void *optctx, const char*));
199

200 201 202 203 204
/**
 * Parse one given option.
 *
 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
 */
205 206
int parse_option(void *optctx, const char *opt, const char *arg,
                 const OptionDef *options);
207

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
/**
 * An option extracted from the commandline.
 * Cannot use AVDictionary because of options like -map which can be
 * used multiple times.
 */
typedef struct Option {
    const OptionDef  *opt;
    const char       *key;
    const char       *val;
} Option;

typedef struct OptionGroupDef {
    /**< group name */
    const char *name;
    /**
     * Option to be used as group separator. Can be NULL for groups which
     * are terminated by a non-option argument (e.g. avconv output files)
     */
    const char *sep;
} OptionGroupDef;

typedef struct OptionGroup {
    const OptionGroupDef *group_def;
    const char *arg;

    Option *opts;
    int  nb_opts;

    AVDictionary *codec_opts;
    AVDictionary *format_opts;
238
    AVDictionary *resample_opts;
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
    struct SwsContext *sws_opts;
} OptionGroup;

/**
 * A list of option groups that all have the same group type
 * (e.g. input files or output files)
 */
typedef struct OptionGroupList {
    const OptionGroupDef *group_def;

    OptionGroup *groups;
    int       nb_groups;
} OptionGroupList;

typedef struct OptionParseContext {
    OptionGroup global_opts;

    OptionGroupList *groups;
    int           nb_groups;

    /* parsing state */
    OptionGroup cur_group;
} OptionParseContext;

/**
 * Parse an options group and write results into optctx.
 *
 * @param optctx an app-specific options context. NULL for global options group
 */
int parse_optgroup(void *optctx, OptionGroup *g);

/**
 * Split the commandline into an intermediate form convenient for further
 * processing.
 *
 * The commandline is assumed to be composed of options which either belong to a
 * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
 * (everything else).
 *
 * A group (defined by an OptionGroupDef struct) is a sequence of options
 * terminated by either a group separator option (e.g. -i) or a parameter that
 * is not an option (doesn't start with -). A group without a separator option
 * must always be first in the supplied groups list.
 *
 * All options within the same group are stored in one OptionGroup struct in an
 * OptionGroupList, all groups with the same group definition are stored in one
 * OptionGroupList in OptionParseContext.groups. The order of group lists is the
 * same as the order of group definitions.
 */
int split_commandline(OptionParseContext *octx, int argc, char *argv[],
                      const OptionDef *options,
290
                      const OptionGroupDef *groups, int nb_groups);
291 292 293 294 295 296

/**
 * Free all allocated memory in an OptionParseContext.
 */
void uninit_parse_context(OptionParseContext *octx);

297
/**
298
 * Find the '-loglevel' option in the command line args and apply it.
299 300 301
 */
void parse_loglevel(int argc, char **argv, const OptionDef *options);

302 303 304 305 306 307
/**
 * Return index of option opt in argv or 0 if not found.
 */
int locate_option(int argc, char **argv, const OptionDef *options,
                  const char *optname);

308 309 310 311 312
/**
 * Check if the given stream matches a stream specifier.
 *
 * @param s  Corresponding format context.
 * @param st Stream from s to be checked.
313
 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
314 315 316 317 318
 *
 * @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);

319 320
/**
 * Filter out options for given codec.
321 322 323 324
 *
 * Create a new options dictionary containing only the options from
 * opts which apply to the codec with ID codec_id.
 *
325 326
 * @param opts     dictionary to place options in
 * @param codec_id ID of the codec that should be filtered for
327 328
 * @param s Corresponding format context.
 * @param st A stream from s for which the options should be filtered.
329 330
 * @param codec The particular codec for which the options should be filtered.
 *              If null, the default one is looked up according to the codec id.
331
 * @return a pointer to the created dictionary
332
 */
333
AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
334
                                AVFormatContext *s, AVStream *st, AVCodec *codec);
335

336 337 338 339 340 341 342 343 344 345
/**
 * 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
346
 */
347 348
AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
                                           AVDictionary *codec_opts);
349

350
/**
351
 * Print an error message to stderr, indicating filename and a human
352 353 354 355 356 357 358
 * 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
359
void print_error(const char *filename, int err);
360

361
/**
362
 * Print the program banner to stderr. The banner contents depend on the
363 364
 * current version of the repository and of the libav* libraries used by
 * the program.
365
 */
366
void show_banner(void);
367 368

/**
369
 * Print the version of the program to stdout. The version message
370 371 372
 * depends on the current versions of the repository and of the libav*
 * libraries.
 */
373
int show_version(void *optctx, const char *opt, const char *arg);
374

375
/**
376
 * Print the license of the program to stdout. The license depends on
377
 * the license of the libraries compiled into the program.
378
 */
379
int show_license(void *optctx, const char *opt, const char *arg);
380

381
/**
382
 * Print a listing containing all the formats supported by the
383 384
 * program.
 */
385
int show_formats(void *optctx, const char *opt, const char *arg);
386

387
/**
388
 * Print a listing containing all the codecs supported by the
389 390
 * program.
 */
391
int show_codecs(void *optctx, const char *opt, const char *arg);
392

393 394 395 396
/**
 * Print a listing containing all the decoders supported by the
 * program.
 */
397
int show_decoders(void *optctx, const char *opt, const char *arg);
398 399 400 401 402

/**
 * Print a listing containing all the encoders supported by the
 * program.
 */
403
int show_encoders(void *optctx, const char *opt, const char *arg);
404

405
/**
406
 * Print a listing containing all the filters supported by the
407 408
 * program.
 */
409
int show_filters(void *optctx, const char *opt, const char *arg);
410

411
/**
412
 * Print a listing containing all the bit stream filters supported by the
413 414
 * program.
 */
415
int show_bsfs(void *optctx, const char *opt, const char *arg);
416 417

/**
418
 * Print a listing containing all the protocols supported by the
419 420
 * program.
 */
421
int show_protocols(void *optctx, const char *opt, const char *arg);
422

423
/**
424
 * Print a listing containing all the pixel formats supported by the
425 426
 * program.
 */
427
int show_pix_fmts(void *optctx, const char *opt, const char *arg);
428

429 430 431 432
/**
 * Print a listing containing all the sample formats supported by the
 * program.
 */
433
int show_sample_fmts(void *optctx, const char *opt, const char *arg);
434

435
/**
Måns Rullgård's avatar
Måns Rullgård committed
436 437
 * Return a positive value if a line read from standard input
 * starts with [yY], otherwise return 0.
438 439 440
 */
int read_yesno(void);

441
/**
442
 * Read the file with name filename, and put its content in a newly
443 444
 * allocated 0-terminated buffer.
 *
445
 * @param filename file to read from
446 447
 * @param bufptr location where pointer to buffer is returned
 * @param size   location where size of buffer is returned
448 449 450
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR error code in case of failure.
 */
451
int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
452

453
typedef struct PtsCorrectionContext {
454 455 456 457 458 459 460
    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;

/**
461
 * Reset the state of the PtsCorrectionContext.
462 463 464 465
 */
void init_pts_correction(PtsCorrectionContext *ctx);

/**
466
 * Attempt to guess proper monotonic timestamps for decoded video frames
467 468 469
 * which might have incorrect times. Input timestamps may wrap around, in
 * which case the output will as well.
 *
470
 * @param ctx the PtsCorrectionContext carrying stream pts information
471
 * @param pts the pts field of the decoded AVPacket, as passed through
472
 * AVCodecContext.reordered_opaque
473 474
 * @param dts the dts field of the decoded AVPacket
 * @return one of the input values, may be AV_NOPTS_VALUE
475 476 477
 */
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);

478 479 480 481
/**
 * Get a file corresponding to a preset file.
 *
 * If is_path is non-zero, look for the file in the path preset_name.
482
 * Otherwise search for a file named arg.avpreset in the directories
483
 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
484 485
 * at configuration time, in that order. If no such file is found and
 * codec_name is defined, then search for a file named
486
 * codec_name-preset_name.avpreset in the above-mentioned directories.
487 488 489 490 491 492 493 494 495 496 497
 *
 * @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);

498 499
/**
 * Realloc array to hold new_size elements of elem_size.
500
 * Calls exit() on failure.
501
 *
502
 * @param array array to reallocate
503 504
 * @param elem_size size in bytes of each element
 * @param size new element count will be written here
505
 * @param new_size number of elements to place in reallocated array
506 507 508 509
 * @return reallocated array
 */
void *grow_array(void *array, int elem_size, int *size, int new_size);

510 511 512
#define GROW_ARRAY(array, nb_elems)\
    array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
#define GET_PIX_FMT_NAME(pix_fmt)\
    const char *name = av_get_pix_fmt_name(pix_fmt);

#define GET_SAMPLE_FMT_NAME(sample_fmt)\
    const char *name = av_get_sample_fmt_name(sample_fmt)

#define GET_SAMPLE_RATE_NAME(rate)\
    char name[16];\
    snprintf(name, sizeof(name), "%d", rate);

#define GET_CH_LAYOUT_NAME(ch_layout)\
    char name[16];\
    snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);

#define GET_CH_LAYOUT_DESC(ch_layout)\
    char name[128];\
    av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);

531
#endif /* LIBAV_CMDUTILS_H */