Statistics
| Branch: | Revision:

ffmpeg / cmdutils.h @ ff0652e5

History | View | Annotate | Download (8.17 KB)

1 f5a90186 Diego Biurrun
/*
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 5b21bdab Diego Biurrun
#ifndef FFMPEG_CMDUTILS_H
23
#define FFMPEG_CMDUTILS_H
24 01310af2 Fabrice Bellard
25 f0a838e5 Diego Biurrun
#include <inttypes.h>
26 95137bbb Diego Biurrun
#include "libavcodec/avcodec.h"
27
#include "libavformat/avformat.h"
28
#include "libswscale/swscale.h"
29 f0a838e5 Diego Biurrun
30 60b5a745 Stefano Sabatini
/**
31 64555bd9 Michael Niedermayer
 * program name, defined by the program for show_version().
32
 */
33
extern const char program_name[];
34
35
/**
36 ea9c581f Stefano Sabatini
 * program birth year, defined by the program for show_banner()
37
 */
38
extern const int program_birth_year;
39
40 ef4c0bb1 Stefano Sabatini
extern const int this_year;
41
42 85663ef3 Michael Niedermayer
extern const char **opt_names;
43 72415b2a Stefano Sabatini
extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
44 85663ef3 Michael Niedermayer
extern AVFormatContext *avformat_opts;
45
extern struct SwsContext *sws_opts;
46
47
/**
48 a5c33faa Reimar Döffinger
 * 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 1790d3b3 Stefano Sabatini
 * 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 b7438896 Stefano Sabatini
 * Fallback for options that are not explicitly handled, these will be
66 85663ef3 Michael Niedermayer
 * parsed through AVOptions.
67
 */
68
int opt_default(const char *opt, const char *arg);
69
70 ea9c581f Stefano Sabatini
/**
71 49bd8e4b Måns Rullgård
 * Set the libav* libraries log level.
72 4c97a6fa Stefano Sabatini
 */
73
int opt_loglevel(const char *opt, const char *arg);
74
75
/**
76 ffcc6e24 Måns Rullgård
 * Limit the execution time.
77
 */
78
int opt_timelimit(const char *opt, const char *arg);
79
80
/**
81 49bd8e4b Måns Rullgård
 * Parse a string and return its corresponding value as a double.
82
 * Exit from the application if the string cannot be correctly
83 15067504 Diego Biurrun
 * parsed or the corresponding value is invalid.
84 60b5a745 Stefano Sabatini
 *
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 15067504 Diego Biurrun
 * @param min the minimum valid accepted value
91
 * @param max the maximum valid accepted value
92 60b5a745 Stefano Sabatini
 */
93
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
94
95 7542157d Stefano Sabatini
/**
96 49bd8e4b Måns Rullgård
 * Parse a string specifying a time and return its corresponding
97
 * value as a number of microseconds. Exit from the application if
98 7542157d Stefano Sabatini
 * 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 bf7e799c Stefano Sabatini
 * @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 7542157d Stefano Sabatini
 * date
106
 *
107 748061de Stefano Sabatini
 * @see parse_date()
108 7542157d Stefano Sabatini
 */
109
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
110
111 01310af2 Fabrice Bellard
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 02d504a7 Fabrice Bellard
#define OPT_VIDEO  0x0010
119
#define OPT_AUDIO  0x0020
120
#define OPT_GRAB   0x0040
121 26d4f26b Michael Niedermayer
#define OPT_INT    0x0080
122 394c4d77 Michael Niedermayer
#define OPT_FLOAT  0x0100
123 ae27975d Fabrice Bellard
#define OPT_SUBTITLE 0x0200
124 8bbf6db9 Michael Niedermayer
#define OPT_FUNC2  0x0400
125 ffdf9a1f Baptiste Coudurier
#define OPT_INT64  0x0800
126 a0b3bcd9 Michael Niedermayer
#define OPT_EXIT   0x1000
127 ae27975d Fabrice Bellard
     union {
128 8bbf6db9 Michael Niedermayer
        void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
129 01310af2 Fabrice Bellard
        int *int_arg;
130
        char **str_arg;
131 1f631450 Michael Niedermayer
        float *float_arg;
132 8bbf6db9 Michael Niedermayer
        int (*func2_arg)(const char *, const char *);
133 ffdf9a1f Baptiste Coudurier
        int64_t *int64_arg;
134 01310af2 Fabrice Bellard
    } u;
135
    const char *help;
136
    const char *argname;
137
} OptionDef;
138
139 02d504a7 Fabrice Bellard
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
140 60a9966e Stefano Sabatini
141
/**
142 49bd8e4b Måns Rullgård
 * Parse the command line arguments.
143 60a9966e Stefano Sabatini
 * @param options Array with the definitions required to interpret every
144 0baf34d8 Diego Biurrun
 * option of the form: -option_name [argument]
145 60a9966e Stefano Sabatini
 * @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 0093ebc2 Michael Niedermayer
void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
153 85663ef3 Michael Niedermayer
154 8d787f8e Stefano Sabatini
/**
155 49bd8e4b Måns Rullgård
 * Print an error message to stderr, indicating filename and a human
156 8d787f8e Stefano Sabatini
 * 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 01310af2 Fabrice Bellard
void print_error(const char *filename, int err);
164
165 c5dc6026 Stefano Sabatini
void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
166
167 f35917b2 Stefano Sabatini
/**
168 49bd8e4b Måns Rullgård
 * Print the program banner to stderr. The banner contents depend on the
169 15067504 Diego Biurrun
 * current version of the repository and of the libav* libraries used by
170
 * the program.
171 86074ed1 Stefano Sabatini
 */
172 ea9c581f Stefano Sabatini
void show_banner(void);
173 86074ed1 Stefano Sabatini
174
/**
175 49bd8e4b Måns Rullgård
 * Print the version of the program to stdout. The version message
176 86074ed1 Stefano Sabatini
 * depends on the current versions of the repository and of the libav*
177
 * libraries.
178
 */
179 64555bd9 Michael Niedermayer
void show_version(void);
180 86074ed1 Stefano Sabatini
181
/**
182 49bd8e4b Måns Rullgård
 * Print the license of the program to stdout. The license depends on
183 15067504 Diego Biurrun
 * the license of the libraries compiled into the program.
184 f35917b2 Stefano Sabatini
 */
185
void show_license(void);
186
187 ba9880c1 Stefano Sabatini
/**
188 49bd8e4b Måns Rullgård
 * Print a listing containing all the formats supported by the
189 ba9880c1 Stefano Sabatini
 * program.
190
 */
191
void show_formats(void);
192
193 090b61b2 Stefano Sabatini
/**
194 49bd8e4b Måns Rullgård
 * Print a listing containing all the codecs supported by the
195 8447f0bd Michael Niedermayer
 * program.
196
 */
197
void show_codecs(void);
198
199
/**
200 49bd8e4b Måns Rullgård
 * Print a listing containing all the filters supported by the
201 62d75662 Stefano Sabatini
 * program.
202
 */
203
void show_filters(void);
204
205
/**
206 49bd8e4b Måns Rullgård
 * Print a listing containing all the bit stream filters supported by the
207 8447f0bd Michael Niedermayer
 * program.
208
 */
209
void show_bsfs(void);
210
211
/**
212 49bd8e4b Måns Rullgård
 * Print a listing containing all the protocols supported by the
213 8447f0bd Michael Niedermayer
 * program.
214
 */
215
void show_protocols(void);
216
217
/**
218 49bd8e4b Måns Rullgård
 * Print a listing containing all the pixel formats supported by the
219 3f7bb426 Stefano Sabatini
 * program.
220
 */
221
void show_pix_fmts(void);
222
223
/**
224 48966b02 Måns Rullgård
 * Return a positive value if a line read from standard input
225
 * starts with [yY], otherwise return 0.
226 090b61b2 Stefano Sabatini
 */
227
int read_yesno(void);
228
229 458b062d Stefano Sabatini
/**
230 49bd8e4b Måns Rullgård
 * Read the file with name filename, and put its content in a newly
231 458b062d Stefano Sabatini
 * allocated 0-terminated buffer.
232
 *
233 49bd8e4b Måns Rullgård
 * @param bufptr location where pointer to buffer is returned
234
 * @param size   location where size of buffer is returned
235 458b062d Stefano Sabatini
 * @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 7a8bfa5d Alexander Strange
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 f03f30d7 Stefano Sabatini
 * Reset the state of the PtsCorrectionContext.
249 7a8bfa5d Alexander Strange
 */
250
void init_pts_correction(PtsCorrectionContext *ctx);
251
252
/**
253 f03f30d7 Stefano Sabatini
 * Attempt to guess proper monotonic timestamps for decoded video frames
254 7a8bfa5d Alexander Strange
 * which might have incorrect times. Input timestamps may wrap around, in
255
 * which case the output will as well.
256
 *
257 f03f30d7 Stefano Sabatini
 * @param pts the pts field of the decoded AVPacket, as passed through
258 7a8bfa5d Alexander Strange
 * AVCodecContext.reordered_opaque
259 f03f30d7 Stefano Sabatini
 * @param dts the dts field of the decoded AVPacket
260
 * @return one of the input values, may be AV_NOPTS_VALUE
261 7a8bfa5d Alexander Strange
 */
262
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
263
264 f7ead94c Stefano Sabatini
#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 ff0652e5 Stefano Sabatini
/**
274
 * Extract a frame from sink.
275
 *
276
 * @return a negative error in case of failure, 1 if one frame has
277
 * been extracted successfully.
278
 */
279
int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
280
                             AVFilterBufferRef **picref, AVRational *pts_tb);
281
282 f7ead94c Stefano Sabatini
#endif /* CONFIG_AVFILTER */
283
284 5b21bdab Diego Biurrun
#endif /* FFMPEG_CMDUTILS_H */