Statistics
| Branch: | Revision:

ffmpeg / cmdutils.h @ 831ec935

History | View | Annotate | Download (4.31 KB)

1
/*
2
 * Various utilities for command line tools
3
 * copyright (c) 2003 Fabrice Bellard
4
 *
5
 * This file is part of FFmpeg.
6
 *
7
 * FFmpeg 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.
11
 *
12
 * FFmpeg 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.
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with FFmpeg; if not, write to the Free Software
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
 */
21

    
22
#ifndef FFMPEG_CMDUTILS_H
23
#define FFMPEG_CMDUTILS_H
24

    
25
#include <inttypes.h>
26

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

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

    
37
/**
38
 * Parses a string and returns its corresponding value as a double.
39
 * Exits from the application if the string cannot be correctly
40
 * parsed or the corresponding value is invalid.
41
 *
42
 * @param context the context of the value to be set (e.g. the
43
 * corresponding commandline option name)
44
 * @param numstr the string to be parsed
45
 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
46
 * string should be parsed
47
 * @param min the minimum valid accepted value
48
 * @param max the maximum valid accepted value
49
 */
50
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
51

    
52
/**
53
 * Parses a string specifying a time and returns its corresponding
54
 * value as a number of microseconds. Exits from the application if
55
 * the string cannot be correctly parsed.
56
 *
57
 * @param context the context of the value to be set (e.g. the
58
 * corresponding commandline option name)
59
 * @param timestr the string to be parsed
60
 * @param is_duration a flag which tells how to interpret \p timestr, if
61
 * not zero \p timestr is interpreted as a duration, otherwise as a
62
 * date
63
 *
64
 * @see parse_date()
65
 */
66
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
67

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

    
96
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
97

    
98
/**
99
 * Parses the command line arguments.
100
 * @param options Array with the definitions required to interpret every
101
 * option of the form: -<option_name> [<argument>]
102
 * @param parse_arg_function Name of the function called to process every
103
 * argument without a leading option name flag. NULL if such arguments do
104
 * not have to be processed.
105
 */
106
void parse_options(int argc, char **argv, const OptionDef *options,
107
                   void (* parse_arg_function)(const char*));
108

    
109
void print_error(const char *filename, int err);
110

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

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

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

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

    
137
#endif /* FFMPEG_CMDUTILS_H */