get rid of the last svn mentions
[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
85663ef3 40extern const char **opt_names;
72415b2a 41extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
42extern AVFormatContext *avformat_opts;
43extern struct SwsContext *sws_opts;
44
45/**
a5c33faa
RD
46 * Initialize the cmdutils option system, in particular
47 * allocate the *_opts contexts.
48 */
49void init_opts(void);
50/**
51 * Uninitialize the cmdutils option system, in particular
52 * free the *_opts contexts and their contents.
53 */
54void uninit_opts(void);
55
56/**
1790d3b3
SS
57 * Trivial log callback.
58 * Only suitable for show_help and similar since it lacks prefix handling.
59 */
60void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
61
62/**
b7438896 63 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
64 * parsed through AVOptions.
65 */
66int opt_default(const char *opt, const char *arg);
67
ea9c581f 68/**
49bd8e4b 69 * Set the libav* libraries log level.
4c97a6fa
SS
70 */
71int opt_loglevel(const char *opt, const char *arg);
72
73/**
ffcc6e24
MR
74 * Limit the execution time.
75 */
76int opt_timelimit(const char *opt, const char *arg);
77
78/**
49bd8e4b
MR
79 * Parse a string and return its corresponding value as a double.
80 * Exit from the application if the string cannot be correctly
15067504 81 * parsed or the corresponding value is invalid.
60b5a745
SS
82 *
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
15067504
DB
88 * @param min the minimum valid accepted value
89 * @param max the maximum valid accepted value
60b5a745
SS
90 */
91double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
92
7542157d 93/**
49bd8e4b
MR
94 * Parse a string specifying a time and return its corresponding
95 * value as a number of microseconds. Exit from the application if
7542157d
SS
96 * 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
bf7e799c
SS
101 * @param is_duration a flag which tells how to interpret timestr, if
102 * not zero timestr is interpreted as a duration, otherwise as a
7542157d
SS
103 * date
104 *
748061de 105 * @see parse_date()
7542157d
SS
106 */
107int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
108
01310af2
FB
109typedef 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
02d504a7
FB
116#define OPT_VIDEO 0x0010
117#define OPT_AUDIO 0x0020
118#define OPT_GRAB 0x0040
26d4f26b 119#define OPT_INT 0x0080
394c4d77 120#define OPT_FLOAT 0x0100
ae27975d 121#define OPT_SUBTITLE 0x0200
8bbf6db9 122#define OPT_FUNC2 0x0400
ffdf9a1f 123#define OPT_INT64 0x0800
a0b3bcd9 124#define OPT_EXIT 0x1000
ae27975d 125 union {
8bbf6db9 126 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
01310af2
FB
127 int *int_arg;
128 char **str_arg;
1f631450 129 float *float_arg;
8bbf6db9 130 int (*func2_arg)(const char *, const char *);
ffdf9a1f 131 int64_t *int64_arg;
01310af2
FB
132 } u;
133 const char *help;
134 const char *argname;
135} OptionDef;
136
02d504a7 137void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
138
139/**
49bd8e4b 140 * Parse the command line arguments.
60a9966e 141 * @param options Array with the definitions required to interpret every
0baf34d8 142 * option of the form: -option_name [argument]
60a9966e
SS
143 * @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 */
147void parse_options(int argc, char **argv, const OptionDef *options,
148 void (* parse_arg_function)(const char*));
149
0093ebc2 150void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
85663ef3 151
8d787f8e 152/**
49bd8e4b 153 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
154 * 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 */
01310af2
FB
161void print_error(const char *filename, int err);
162
c5dc6026
SS
163void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
164
f35917b2 165/**
49bd8e4b 166 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
167 * current version of the repository and of the libav* libraries used by
168 * the program.
86074ed1 169 */
ea9c581f 170void show_banner(void);
86074ed1
SS
171
172/**
49bd8e4b 173 * Print the version of the program to stdout. The version message
86074ed1
SS
174 * depends on the current versions of the repository and of the libav*
175 * libraries.
86074ed1 176 */
64555bd9 177void show_version(void);
86074ed1
SS
178
179/**
49bd8e4b 180 * Print the license of the program to stdout. The license depends on
15067504 181 * the license of the libraries compiled into the program.
f35917b2
SS
182 */
183void show_license(void);
184
ba9880c1 185/**
49bd8e4b 186 * Print a listing containing all the formats supported by the
ba9880c1
SS
187 * program.
188 */
189void show_formats(void);
190
090b61b2 191/**
49bd8e4b 192 * Print a listing containing all the codecs supported by the
8447f0bd
MN
193 * program.
194 */
195void show_codecs(void);
196
197/**
49bd8e4b 198 * Print a listing containing all the filters supported by the
62d75662
SS
199 * program.
200 */
201void show_filters(void);
202
203/**
49bd8e4b 204 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
205 * program.
206 */
207void show_bsfs(void);
208
209/**
49bd8e4b 210 * Print a listing containing all the protocols supported by the
8447f0bd
MN
211 * program.
212 */
213void show_protocols(void);
214
215/**
49bd8e4b 216 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
217 * program.
218 */
219void show_pix_fmts(void);
220
221/**
48966b02
MR
222 * Return a positive value if a line read from standard input
223 * starts with [yY], otherwise return 0.
090b61b2
SS
224 */
225int read_yesno(void);
226
458b062d 227/**
49bd8e4b 228 * Read the file with name filename, and put its content in a newly
458b062d
SS
229 * allocated 0-terminated buffer.
230 *
49bd8e4b
MR
231 * @param bufptr location where pointer to buffer is returned
232 * @param size location where size of buffer is returned
458b062d
SS
233 * @return 0 in case of success, a negative value corresponding to an
234 * AVERROR error code in case of failure.
235 */
236int read_file(const char *filename, char **bufptr, size_t *size);
237
7a8bfa5d
AS
238typedef 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/**
f03f30d7 246 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
247 */
248void init_pts_correction(PtsCorrectionContext *ctx);
249
250/**
f03f30d7 251 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
252 * which might have incorrect times. Input timestamps may wrap around, in
253 * which case the output will as well.
254 *
f03f30d7 255 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 256 * AVCodecContext.reordered_opaque
f03f30d7
SS
257 * @param dts the dts field of the decoded AVPacket
258 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
259 */
260int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
261
6e872935
SS
262/**
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 */
279FILE *get_preset_file(char *filename, size_t filename_size,
280 const char *preset_name, int is_path, const char *codec_name);
281
f7ead94c
SS
282#if CONFIG_AVFILTER
283#include "libavfilter/avfilter.h"
284
285typedef struct {
286 enum PixelFormat pix_fmt;
287} FFSinkContext;
288
289extern AVFilter ffsink;
290
ff0652e5
SS
291/**
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 */
297int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
298 AVFilterBufferRef **picref, AVRational *pts_tb);
299
f7ead94c
SS
300#endif /* CONFIG_AVFILTER */
301
5b21bdab 302#endif /* FFMPEG_CMDUTILS_H */