Statistics
| Branch: | Revision:

ffmpeg / cmdutils.h @ f7ead94c

History | View | Annotate | Download (7.89 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
#include "libavcodec/avcodec.h"
27
#include "libavformat/avformat.h"
28
#include "libswscale/swscale.h"
29

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

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

    
40
extern const int this_year;
41

    
42
extern const char **opt_names;
43
extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
44
extern AVFormatContext *avformat_opts;
45
extern struct SwsContext *sws_opts;
46

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

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

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

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

    
75
/**
76
 * Limit the execution time.
77
 */
78
int opt_timelimit(const char *opt, const char *arg);
79

    
80
/**
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.
84
 *
85
 * @param context the context of the value to be set (e.g. the
86
 * corresponding commandline 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
92
 */
93
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
94

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

    
111
typedef struct {
112
    const char *name;
113
    int flags;
114
#define HAS_ARG    0x0001
115
#define OPT_BOOL   0x0002
116
#define OPT_EXPERT 0x0004
117
#define OPT_STRING 0x0008
118
#define OPT_VIDEO  0x0010
119
#define OPT_AUDIO  0x0020
120
#define OPT_GRAB   0x0040
121
#define OPT_INT    0x0080
122
#define OPT_FLOAT  0x0100
123
#define OPT_SUBTITLE 0x0200
124
#define OPT_FUNC2  0x0400
125
#define OPT_INT64  0x0800
126
#define OPT_EXIT   0x1000
127
     union {
128
        void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
129
        int *int_arg;
130
        char **str_arg;
131
        float *float_arg;
132
        int (*func2_arg)(const char *, const char *);
133
        int64_t *int64_arg;
134
    } u;
135
    const char *help;
136
    const char *argname;
137
} OptionDef;
138

    
139
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
140

    
141
/**
142
 * Parse the command line arguments.
143
 * @param options Array with the definitions required to interpret every
144
 * option of the form: -option_name [argument]
145
 * @param parse_arg_function Name of the function called to process every
146
 * argument without a leading option name flag. NULL if such arguments do
147
 * not have to be processed.
148
 */
149
void parse_options(int argc, char **argv, const OptionDef *options,
150
                   void (* parse_arg_function)(const char*));
151

    
152
void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
153

    
154
/**
155
 * Print an error message to stderr, indicating filename and a human
156
 * readable description of the error code err.
157
 *
158
 * If strerror_r() is not available the use of this function in a
159
 * multithreaded application may be unsafe.
160
 *
161
 * @see av_strerror()
162
 */
163
void print_error(const char *filename, int err);
164

    
165
void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
166

    
167
/**
168
 * Print the program banner to stderr. The banner contents depend on the
169
 * current version of the repository and of the libav* libraries used by
170
 * the program.
171
 */
172
void show_banner(void);
173

    
174
/**
175
 * Print the version of the program to stdout. The version message
176
 * depends on the current versions of the repository and of the libav*
177
 * libraries.
178
 */
179
void show_version(void);
180

    
181
/**
182
 * Print the license of the program to stdout. The license depends on
183
 * the license of the libraries compiled into the program.
184
 */
185
void show_license(void);
186

    
187
/**
188
 * Print a listing containing all the formats supported by the
189
 * program.
190
 */
191
void show_formats(void);
192

    
193
/**
194
 * Print a listing containing all the codecs supported by the
195
 * program.
196
 */
197
void show_codecs(void);
198

    
199
/**
200
 * Print a listing containing all the filters supported by the
201
 * program.
202
 */
203
void show_filters(void);
204

    
205
/**
206
 * Print a listing containing all the bit stream filters supported by the
207
 * program.
208
 */
209
void show_bsfs(void);
210

    
211
/**
212
 * Print a listing containing all the protocols supported by the
213
 * program.
214
 */
215
void show_protocols(void);
216

    
217
/**
218
 * Print a listing containing all the pixel formats supported by the
219
 * program.
220
 */
221
void show_pix_fmts(void);
222

    
223
/**
224
 * Return a positive value if a line read from standard input
225
 * starts with [yY], otherwise return 0.
226
 */
227
int read_yesno(void);
228

    
229
/**
230
 * Read the file with name filename, and put its content in a newly
231
 * allocated 0-terminated buffer.
232
 *
233
 * @param bufptr location where pointer to buffer is returned
234
 * @param size   location where size of buffer is returned
235
 * @return 0 in case of success, a negative value corresponding to an
236
 * AVERROR error code in case of failure.
237
 */
238
int read_file(const char *filename, char **bufptr, size_t *size);
239

    
240
typedef struct {
241
    int64_t num_faulty_pts; /// Number of incorrect PTS values so far
242
    int64_t num_faulty_dts; /// Number of incorrect DTS values so far
243
    int64_t last_pts;       /// PTS of the last frame
244
    int64_t last_dts;       /// DTS of the last frame
245
} PtsCorrectionContext;
246

    
247
/**
248
 * Reset the state of the PtsCorrectionContext.
249
 */
250
void init_pts_correction(PtsCorrectionContext *ctx);
251

    
252
/**
253
 * Attempt to guess proper monotonic timestamps for decoded video frames
254
 * which might have incorrect times. Input timestamps may wrap around, in
255
 * which case the output will as well.
256
 *
257
 * @param pts the pts field of the decoded AVPacket, as passed through
258
 * AVCodecContext.reordered_opaque
259
 * @param dts the dts field of the decoded AVPacket
260
 * @return one of the input values, may be AV_NOPTS_VALUE
261
 */
262
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
263

    
264
#if CONFIG_AVFILTER
265
#include "libavfilter/avfilter.h"
266

    
267
typedef struct {
268
    enum PixelFormat pix_fmt;
269
} FFSinkContext;
270

    
271
extern AVFilter ffsink;
272

    
273
#endif /* CONFIG_AVFILTER */
274

    
275
#endif /* FFMPEG_CMDUTILS_H */