Statistics
| Branch: | Revision:

ffmpeg / cmdutils.h @ ebba2b3e

History | View | Annotate | Download (9.06 KB)

1 f5a90186 Diego Biurrun
/*
2
 * Various utilities for command line tools
3
 * copyright (c) 2003 Fabrice Bellard
4
 *
5 2912e87a Mans Rullgard
 * This file is part of Libav.
6 f5a90186 Diego Biurrun
 *
7 2912e87a Mans Rullgard
 * Libav is free software; you can redistribute it and/or
8 f5a90186 Diego Biurrun
 * 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 2912e87a Mans Rullgard
 * Libav is distributed in the hope that it will be useful,
13 f5a90186 Diego Biurrun
 * 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 2912e87a Mans Rullgard
 * License along with Libav; if not, write to the Free Software
19 f5a90186 Diego Biurrun
 * 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 85663ef3 Michael Niedermayer
extern const char **opt_names;
41 72415b2a Stefano Sabatini
extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
42 85663ef3 Michael Niedermayer
extern AVFormatContext *avformat_opts;
43
extern struct SwsContext *sws_opts;
44
45
/**
46 a5c33faa Reimar Döffinger
 * Initialize the cmdutils option system, in particular
47
 * allocate the *_opts contexts.
48
 */
49
void init_opts(void);
50
/**
51
 * Uninitialize the cmdutils option system, in particular
52
 * free the *_opts contexts and their contents.
53
 */
54
void uninit_opts(void);
55
56
/**
57 1790d3b3 Stefano Sabatini
 * Trivial log callback.
58
 * Only suitable for show_help and similar since it lacks prefix handling.
59
 */
60
void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
61
62
/**
63 b7438896 Stefano Sabatini
 * Fallback for options that are not explicitly handled, these will be
64 85663ef3 Michael Niedermayer
 * parsed through AVOptions.
65
 */
66
int opt_default(const char *opt, const char *arg);
67
68 ea9c581f Stefano Sabatini
/**
69 49bd8e4b Måns Rullgård
 * Set the libav* libraries log level.
70 4c97a6fa Stefano Sabatini
 */
71
int opt_loglevel(const char *opt, const char *arg);
72
73
/**
74 ffcc6e24 Måns Rullgård
 * Limit the execution time.
75
 */
76
int opt_timelimit(const char *opt, const char *arg);
77
78
/**
79 49bd8e4b Måns Rullgård
 * Parse a string and return its corresponding value as a double.
80
 * Exit from the application if the string cannot be correctly
81 15067504 Diego Biurrun
 * parsed or the corresponding value is invalid.
82 60b5a745 Stefano Sabatini
 *
83
 * @param context the context of the value to be set (e.g. the
84
 * corresponding commandline option name)
85
 * @param numstr the string to be parsed
86
 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
87
 * string should be parsed
88 15067504 Diego Biurrun
 * @param min the minimum valid accepted value
89
 * @param max the maximum valid accepted value
90 60b5a745 Stefano Sabatini
 */
91
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
92
93 7542157d Stefano Sabatini
/**
94 49bd8e4b Måns Rullgård
 * Parse a string specifying a time and return its corresponding
95
 * value as a number of microseconds. Exit from the application if
96 7542157d Stefano Sabatini
 * the string cannot be correctly parsed.
97
 *
98
 * @param context the context of the value to be set (e.g. the
99
 * corresponding commandline option name)
100
 * @param timestr the string to be parsed
101 bf7e799c Stefano Sabatini
 * @param is_duration a flag which tells how to interpret timestr, if
102
 * not zero timestr is interpreted as a duration, otherwise as a
103 7542157d Stefano Sabatini
 * date
104
 *
105 748061de Stefano Sabatini
 * @see parse_date()
106 7542157d Stefano Sabatini
 */
107
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
108
109 01310af2 Fabrice Bellard
typedef struct {
110
    const char *name;
111
    int flags;
112
#define HAS_ARG    0x0001
113
#define OPT_BOOL   0x0002
114
#define OPT_EXPERT 0x0004
115
#define OPT_STRING 0x0008
116 02d504a7 Fabrice Bellard
#define OPT_VIDEO  0x0010
117
#define OPT_AUDIO  0x0020
118
#define OPT_GRAB   0x0040
119 26d4f26b Michael Niedermayer
#define OPT_INT    0x0080
120 394c4d77 Michael Niedermayer
#define OPT_FLOAT  0x0100
121 ae27975d Fabrice Bellard
#define OPT_SUBTITLE 0x0200
122 8bbf6db9 Michael Niedermayer
#define OPT_FUNC2  0x0400
123 ffdf9a1f Baptiste Coudurier
#define OPT_INT64  0x0800
124 a0b3bcd9 Michael Niedermayer
#define OPT_EXIT   0x1000
125 ae27975d Fabrice Bellard
     union {
126 8bbf6db9 Michael Niedermayer
        void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
127 01310af2 Fabrice Bellard
        int *int_arg;
128
        char **str_arg;
129 1f631450 Michael Niedermayer
        float *float_arg;
130 8bbf6db9 Michael Niedermayer
        int (*func2_arg)(const char *, const char *);
131 ffdf9a1f Baptiste Coudurier
        int64_t *int64_arg;
132 01310af2 Fabrice Bellard
    } u;
133
    const char *help;
134
    const char *argname;
135
} OptionDef;
136
137 02d504a7 Fabrice Bellard
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
138 60a9966e Stefano Sabatini
139
/**
140 49bd8e4b Måns Rullgård
 * Parse the command line arguments.
141 60a9966e Stefano Sabatini
 * @param options Array with the definitions required to interpret every
142 0baf34d8 Diego Biurrun
 * option of the form: -option_name [argument]
143 60a9966e Stefano Sabatini
 * @param parse_arg_function Name of the function called to process every
144
 * argument without a leading option name flag. NULL if such arguments do
145
 * not have to be processed.
146
 */
147
void parse_options(int argc, char **argv, const OptionDef *options,
148
                   void (* parse_arg_function)(const char*));
149
150 0093ebc2 Michael Niedermayer
void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
151 85663ef3 Michael Niedermayer
152 8d787f8e Stefano Sabatini
/**
153 49bd8e4b Måns Rullgård
 * Print an error message to stderr, indicating filename and a human
154 8d787f8e Stefano Sabatini
 * readable description of the error code err.
155
 *
156
 * If strerror_r() is not available the use of this function in a
157
 * multithreaded application may be unsafe.
158
 *
159
 * @see av_strerror()
160
 */
161 01310af2 Fabrice Bellard
void print_error(const char *filename, int err);
162
163 c5dc6026 Stefano Sabatini
void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
164
165 f35917b2 Stefano Sabatini
/**
166 49bd8e4b Måns Rullgård
 * Print the program banner to stderr. The banner contents depend on the
167 15067504 Diego Biurrun
 * current version of the repository and of the libav* libraries used by
168
 * the program.
169 86074ed1 Stefano Sabatini
 */
170 ea9c581f Stefano Sabatini
void show_banner(void);
171 86074ed1 Stefano Sabatini
172
/**
173 49bd8e4b Måns Rullgård
 * Print the version of the program to stdout. The version message
174 86074ed1 Stefano Sabatini
 * depends on the current versions of the repository and of the libav*
175
 * libraries.
176
 */
177 64555bd9 Michael Niedermayer
void show_version(void);
178 86074ed1 Stefano Sabatini
179
/**
180 49bd8e4b Måns Rullgård
 * Print the license of the program to stdout. The license depends on
181 15067504 Diego Biurrun
 * the license of the libraries compiled into the program.
182 f35917b2 Stefano Sabatini
 */
183
void show_license(void);
184
185 ba9880c1 Stefano Sabatini
/**
186 49bd8e4b Måns Rullgård
 * Print a listing containing all the formats supported by the
187 ba9880c1 Stefano Sabatini
 * program.
188
 */
189
void show_formats(void);
190
191 090b61b2 Stefano Sabatini
/**
192 49bd8e4b Måns Rullgård
 * Print a listing containing all the codecs supported by the
193 8447f0bd Michael Niedermayer
 * program.
194
 */
195
void show_codecs(void);
196
197
/**
198 49bd8e4b Måns Rullgård
 * Print a listing containing all the filters supported by the
199 62d75662 Stefano Sabatini
 * program.
200
 */
201
void show_filters(void);
202
203
/**
204 49bd8e4b Måns Rullgård
 * Print a listing containing all the bit stream filters supported by the
205 8447f0bd Michael Niedermayer
 * program.
206
 */
207
void show_bsfs(void);
208
209
/**
210 49bd8e4b Måns Rullgård
 * Print a listing containing all the protocols supported by the
211 8447f0bd Michael Niedermayer
 * program.
212
 */
213
void show_protocols(void);
214
215
/**
216 49bd8e4b Måns Rullgård
 * Print a listing containing all the pixel formats supported by the
217 3f7bb426 Stefano Sabatini
 * program.
218
 */
219
void show_pix_fmts(void);
220
221
/**
222 48966b02 Måns Rullgård
 * Return a positive value if a line read from standard input
223
 * starts with [yY], otherwise return 0.
224 090b61b2 Stefano Sabatini
 */
225
int read_yesno(void);
226
227 458b062d Stefano Sabatini
/**
228 49bd8e4b Måns Rullgård
 * Read the file with name filename, and put its content in a newly
229 458b062d Stefano Sabatini
 * allocated 0-terminated buffer.
230
 *
231 49bd8e4b Måns Rullgård
 * @param bufptr location where pointer to buffer is returned
232
 * @param size   location where size of buffer is returned
233 458b062d Stefano Sabatini
 * @return 0 in case of success, a negative value corresponding to an
234
 * AVERROR error code in case of failure.
235
 */
236
int read_file(const char *filename, char **bufptr, size_t *size);
237
238 7a8bfa5d Alexander Strange
typedef struct {
239
    int64_t num_faulty_pts; /// Number of incorrect PTS values so far
240
    int64_t num_faulty_dts; /// Number of incorrect DTS values so far
241
    int64_t last_pts;       /// PTS of the last frame
242
    int64_t last_dts;       /// DTS of the last frame
243
} PtsCorrectionContext;
244
245
/**
246 f03f30d7 Stefano Sabatini
 * Reset the state of the PtsCorrectionContext.
247 7a8bfa5d Alexander Strange
 */
248
void init_pts_correction(PtsCorrectionContext *ctx);
249
250
/**
251 f03f30d7 Stefano Sabatini
 * Attempt to guess proper monotonic timestamps for decoded video frames
252 7a8bfa5d Alexander Strange
 * which might have incorrect times. Input timestamps may wrap around, in
253
 * which case the output will as well.
254
 *
255 f03f30d7 Stefano Sabatini
 * @param pts the pts field of the decoded AVPacket, as passed through
256 7a8bfa5d Alexander Strange
 * AVCodecContext.reordered_opaque
257 f03f30d7 Stefano Sabatini
 * @param dts the dts field of the decoded AVPacket
258
 * @return one of the input values, may be AV_NOPTS_VALUE
259 7a8bfa5d Alexander Strange
 */
260
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
261
262 6e872935 Stefano Sabatini
/**
263
 * Get a file corresponding to a preset file.
264
 *
265
 * If is_path is non-zero, look for the file in the path preset_name.
266
 * Otherwise search for a file named arg.ffpreset in the directories
267
 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
268
 * at configuration time, in that order. If no such file is found and
269
 * codec_name is defined, then search for a file named
270
 * codec_name-preset_name.ffpreset in the above-mentioned directories.
271
 *
272
 * @param filename buffer where the name of the found filename is written
273
 * @param filename_size size in bytes of the filename buffer
274
 * @param preset_name name of the preset to search
275
 * @param is_path tell if preset_name is a filename path
276
 * @param codec_name name of the codec for which to look for the
277
 * preset, may be NULL
278
 */
279
FILE *get_preset_file(char *filename, size_t filename_size,
280
                      const char *preset_name, int is_path, const char *codec_name);
281
282 f7ead94c Stefano Sabatini
#if CONFIG_AVFILTER
283
#include "libavfilter/avfilter.h"
284
285
typedef struct {
286
    enum PixelFormat pix_fmt;
287
} FFSinkContext;
288
289
extern AVFilter ffsink;
290
291 ff0652e5 Stefano Sabatini
/**
292
 * Extract a frame from sink.
293
 *
294
 * @return a negative error in case of failure, 1 if one frame has
295
 * been extracted successfully.
296
 */
297
int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
298
                             AVFilterBufferRef **picref, AVRational *pts_tb);
299
300 f7ead94c Stefano Sabatini
#endif /* CONFIG_AVFILTER */
301
302 5b21bdab Diego Biurrun
#endif /* FFMPEG_CMDUTILS_H */