cmdutils.h 4.31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Various utilities for command line tools
 * copyright (c) 2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * 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.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * 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
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

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

25 26
#include <inttypes.h>

27 28 29 30 31
/**
 * program name, defined by the program for show_version().
 */
extern const char program_name[];

32 33 34 35 36
/**
 * program birth year, defined by the program for show_banner()
 */
extern const int program_birth_year;

37
/**
38 39 40
 * Parses a string and returns its corresponding value as a double.
 * Exits from the application if the string cannot be correctly
 * parsed or the corresponding value is invalid.
41 42 43 44 45 46
 *
 * @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
47 48
 * @param min the minimum valid accepted value
 * @param max the maximum valid accepted value
49 50 51
 */
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);

52 53 54 55 56 57 58 59 60 61 62 63
/**
 * Parses a string specifying a time and returns its corresponding
 * value as a number of microseconds. Exits from the application if
 * 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
 * @param is_duration a flag which tells how to interpret \p timestr, if
 * not zero \p timestr is interpreted as a duration, otherwise as a
 * date
 *
Stefano Sabatini's avatar
Stefano Sabatini committed
64
 * @see parse_date()
65 66 67
 */
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);

Fabrice Bellard's avatar
Fabrice Bellard committed
68 69 70 71 72 73 74
typedef struct {
    const char *name;
    int flags;
#define HAS_ARG    0x0001
#define OPT_BOOL   0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008
75 76 77
#define OPT_VIDEO  0x0010
#define OPT_AUDIO  0x0020
#define OPT_GRAB   0x0040
Michael Niedermayer's avatar
Michael Niedermayer committed
78
#define OPT_INT    0x0080
79
#define OPT_FLOAT  0x0100
Fabrice Bellard's avatar
Fabrice Bellard committed
80
#define OPT_SUBTITLE 0x0200
81
#define OPT_FUNC2  0x0400
82
#define OPT_INT64  0x0800
Michael Niedermayer's avatar
Michael Niedermayer committed
83
#define OPT_EXIT   0x1000
Fabrice Bellard's avatar
Fabrice Bellard committed
84
     union {
85
        void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
Fabrice Bellard's avatar
Fabrice Bellard committed
86 87
        int *int_arg;
        char **str_arg;
Michael Niedermayer's avatar
Michael Niedermayer committed
88
        float *float_arg;
89
        int (*func2_arg)(const char *, const char *);
90
        int64_t *int64_arg;
Fabrice Bellard's avatar
Fabrice Bellard committed
91 92 93 94 95
    } u;
    const char *help;
    const char *argname;
} OptionDef;

96
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
97 98 99 100 101 102 103 104 105 106 107 108

/**
 * Parses the command line arguments.
 * @param options Array with the definitions required to interpret every
 * option of the form: -<option_name> [<argument>]
 * @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.
 */
void parse_options(int argc, char **argv, const OptionDef *options,
                   void (* parse_arg_function)(const char*));

Fabrice Bellard's avatar
Fabrice Bellard committed
109 110
void print_error(const char *filename, int err);

111
/**
112 113 114
 * Prints the program banner to stderr. The banner contents depend on the
 * current version of the repository and of the libav* libraries used by
 * the program.
115
 */
116
void show_banner(void);
117 118

/**
119
 * Prints the version of the program to stdout. The version message
120 121 122
 * depends on the current versions of the repository and of the libav*
 * libraries.
 */
123
void show_version(void);
124

125
/**
126 127
 * Prints the license of the program to stdout. The license depends on
 * the license of the libraries compiled into the program.
128 129 130
 */
void show_license(void);

131 132 133 134 135 136
/**
 * Prints a listing containing all the formats supported by the
 * program.
 */
void show_formats(void);

137
#endif /* FFMPEG_CMDUTILS_H */