Make FRAPS decoder use PC range instead of TV range
[libav.git] / cmdutils.h
CommitLineData
f5a90186
DB
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
5b21bdab
DB
22#ifndef FFMPEG_CMDUTILS_H
23#define FFMPEG_CMDUTILS_H
01310af2 24
f0a838e5 25#include <inttypes.h>
95137bbb
DB
26#include "libavcodec/avcodec.h"
27#include "libavformat/avformat.h"
28#include "libswscale/swscale.h"
f0a838e5 29
60b5a745 30/**
64555bd9
MN
31 * program name, defined by the program for show_version().
32 */
33extern const char program_name[];
34
35/**
ea9c581f
SS
36 * program birth year, defined by the program for show_banner()
37 */
38extern const int program_birth_year;
39
ef4c0bb1
SS
40extern const int this_year;
41
85663ef3 42extern const char **opt_names;
72415b2a 43extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
44extern AVFormatContext *avformat_opts;
45extern struct SwsContext *sws_opts;
46
47/**
1790d3b3
SS
48 * Trivial log callback.
49 * Only suitable for show_help and similar since it lacks prefix handling.
50 */
51void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
52
53/**
b7438896 54 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
55 * parsed through AVOptions.
56 */
57int opt_default(const char *opt, const char *arg);
58
ea9c581f 59/**
49bd8e4b 60 * Set the libav* libraries log level.
4c97a6fa
SS
61 */
62int opt_loglevel(const char *opt, const char *arg);
63
64/**
ffcc6e24
MR
65 * Limit the execution time.
66 */
67int opt_timelimit(const char *opt, const char *arg);
68
69/**
49bd8e4b
MR
70 * Parse a string and return its corresponding value as a double.
71 * Exit from the application if the string cannot be correctly
15067504 72 * parsed or the corresponding value is invalid.
60b5a745
SS
73 *
74 * @param context the context of the value to be set (e.g. the
75 * corresponding commandline option name)
76 * @param numstr the string to be parsed
77 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
78 * string should be parsed
15067504
DB
79 * @param min the minimum valid accepted value
80 * @param max the maximum valid accepted value
60b5a745
SS
81 */
82double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
83
7542157d 84/**
49bd8e4b
MR
85 * Parse a string specifying a time and return its corresponding
86 * value as a number of microseconds. Exit from the application if
7542157d
SS
87 * the string cannot be correctly parsed.
88 *
89 * @param context the context of the value to be set (e.g. the
90 * corresponding commandline option name)
91 * @param timestr the string to be parsed
bf7e799c
SS
92 * @param is_duration a flag which tells how to interpret timestr, if
93 * not zero timestr is interpreted as a duration, otherwise as a
7542157d
SS
94 * date
95 *
748061de 96 * @see parse_date()
7542157d
SS
97 */
98int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
99
01310af2
FB
100typedef struct {
101 const char *name;
102 int flags;
103#define HAS_ARG 0x0001
104#define OPT_BOOL 0x0002
105#define OPT_EXPERT 0x0004
106#define OPT_STRING 0x0008
02d504a7
FB
107#define OPT_VIDEO 0x0010
108#define OPT_AUDIO 0x0020
109#define OPT_GRAB 0x0040
26d4f26b 110#define OPT_INT 0x0080
394c4d77 111#define OPT_FLOAT 0x0100
ae27975d 112#define OPT_SUBTITLE 0x0200
8bbf6db9 113#define OPT_FUNC2 0x0400
ffdf9a1f 114#define OPT_INT64 0x0800
a0b3bcd9 115#define OPT_EXIT 0x1000
ae27975d 116 union {
8bbf6db9 117 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
01310af2
FB
118 int *int_arg;
119 char **str_arg;
1f631450 120 float *float_arg;
8bbf6db9 121 int (*func2_arg)(const char *, const char *);
ffdf9a1f 122 int64_t *int64_arg;
01310af2
FB
123 } u;
124 const char *help;
125 const char *argname;
126} OptionDef;
127
02d504a7 128void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
129
130/**
49bd8e4b 131 * Parse the command line arguments.
60a9966e 132 * @param options Array with the definitions required to interpret every
0baf34d8 133 * option of the form: -option_name [argument]
60a9966e
SS
134 * @param parse_arg_function Name of the function called to process every
135 * argument without a leading option name flag. NULL if such arguments do
136 * not have to be processed.
137 */
138void parse_options(int argc, char **argv, const OptionDef *options,
139 void (* parse_arg_function)(const char*));
140
0093ebc2 141void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
85663ef3 142
8d787f8e 143/**
49bd8e4b 144 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
145 * readable description of the error code err.
146 *
147 * If strerror_r() is not available the use of this function in a
148 * multithreaded application may be unsafe.
149 *
150 * @see av_strerror()
151 */
01310af2
FB
152void print_error(const char *filename, int err);
153
c5dc6026
SS
154void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
155
f35917b2 156/**
49bd8e4b 157 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
158 * current version of the repository and of the libav* libraries used by
159 * the program.
86074ed1 160 */
ea9c581f 161void show_banner(void);
86074ed1
SS
162
163/**
49bd8e4b 164 * Print the version of the program to stdout. The version message
86074ed1
SS
165 * depends on the current versions of the repository and of the libav*
166 * libraries.
86074ed1 167 */
64555bd9 168void show_version(void);
86074ed1
SS
169
170/**
49bd8e4b 171 * Print the license of the program to stdout. The license depends on
15067504 172 * the license of the libraries compiled into the program.
f35917b2
SS
173 */
174void show_license(void);
175
ba9880c1 176/**
49bd8e4b 177 * Print a listing containing all the formats supported by the
ba9880c1
SS
178 * program.
179 */
180void show_formats(void);
181
090b61b2 182/**
49bd8e4b 183 * Print a listing containing all the codecs supported by the
8447f0bd
MN
184 * program.
185 */
186void show_codecs(void);
187
188/**
49bd8e4b 189 * Print a listing containing all the filters supported by the
62d75662
SS
190 * program.
191 */
192void show_filters(void);
193
194/**
49bd8e4b 195 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
196 * program.
197 */
198void show_bsfs(void);
199
200/**
49bd8e4b 201 * Print a listing containing all the protocols supported by the
8447f0bd
MN
202 * program.
203 */
204void show_protocols(void);
205
206/**
49bd8e4b 207 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
208 * program.
209 */
210void show_pix_fmts(void);
211
212/**
48966b02
MR
213 * Return a positive value if a line read from standard input
214 * starts with [yY], otherwise return 0.
090b61b2
SS
215 */
216int read_yesno(void);
217
458b062d 218/**
49bd8e4b 219 * Read the file with name filename, and put its content in a newly
458b062d
SS
220 * allocated 0-terminated buffer.
221 *
49bd8e4b
MR
222 * @param bufptr location where pointer to buffer is returned
223 * @param size location where size of buffer is returned
458b062d
SS
224 * @return 0 in case of success, a negative value corresponding to an
225 * AVERROR error code in case of failure.
226 */
227int read_file(const char *filename, char **bufptr, size_t *size);
228
7a8bfa5d
AS
229typedef struct {
230 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
231 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
232 int64_t last_pts; /// PTS of the last frame
233 int64_t last_dts; /// DTS of the last frame
234} PtsCorrectionContext;
235
236/**
f03f30d7 237 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
238 */
239void init_pts_correction(PtsCorrectionContext *ctx);
240
241/**
f03f30d7 242 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
243 * which might have incorrect times. Input timestamps may wrap around, in
244 * which case the output will as well.
245 *
f03f30d7 246 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 247 * AVCodecContext.reordered_opaque
f03f30d7
SS
248 * @param dts the dts field of the decoded AVPacket
249 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
250 */
251int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
252
5b21bdab 253#endif /* FFMPEG_CMDUTILS_H */