cmdutils: declare only one pointer type in OptionDef
[libav.git] / cmdutils.h
CommitLineData
f5a90186
DB
1/*
2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
4 *
2912e87a 5 * This file is part of Libav.
f5a90186 6 *
2912e87a 7 * Libav is free software; you can redistribute it and/or
f5a90186
DB
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 *
2912e87a 12 * Libav is distributed in the hope that it will be useful,
f5a90186
DB
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
2912e87a 18 * License along with Libav; if not, write to the Free Software
f5a90186
DB
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
153382e1
DB
22#ifndef LIBAV_CMDUTILS_H
23#define LIBAV_CMDUTILS_H
01310af2 24
ea91e771
DB
25#include <stdint.h>
26
95137bbb 27#include "libavcodec/avcodec.h"
ea91e771 28#include "libavfilter/avfilter.h"
95137bbb
DB
29#include "libavformat/avformat.h"
30#include "libswscale/swscale.h"
f0a838e5 31
60b5a745 32/**
64555bd9
MN
33 * program name, defined by the program for show_version().
34 */
35extern const char program_name[];
36
37/**
ea9c581f
SS
38 * program birth year, defined by the program for show_banner()
39 */
40extern const int program_birth_year;
41
72415b2a 42extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
43extern AVFormatContext *avformat_opts;
44extern struct SwsContext *sws_opts;
8c8eab8b 45extern AVDictionary *format_opts, *codec_opts;
85663ef3
MN
46
47/**
a5c33faa
RD
48 * Initialize the cmdutils option system, in particular
49 * allocate the *_opts contexts.
50 */
51void init_opts(void);
52/**
53 * Uninitialize the cmdutils option system, in particular
54 * free the *_opts contexts and their contents.
55 */
56void uninit_opts(void);
57
58/**
1790d3b3
SS
59 * Trivial log callback.
60 * Only suitable for show_help and similar since it lacks prefix handling.
61 */
62void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
63
64/**
b7438896 65 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
66 * parsed through AVOptions.
67 */
68int opt_default(const char *opt, const char *arg);
69
ea9c581f 70/**
49bd8e4b 71 * Set the libav* libraries log level.
4c97a6fa
SS
72 */
73int opt_loglevel(const char *opt, const char *arg);
74
75/**
ffcc6e24
MR
76 * Limit the execution time.
77 */
78int opt_timelimit(const char *opt, const char *arg);
79
80/**
49bd8e4b
MR
81 * Parse a string and return its corresponding value as a double.
82 * Exit from the application if the string cannot be correctly
15067504 83 * parsed or the corresponding value is invalid.
60b5a745
SS
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
15067504
DB
90 * @param min the minimum valid accepted value
91 * @param max the maximum valid accepted value
60b5a745
SS
92 */
93double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
94
7542157d 95/**
49bd8e4b
MR
96 * Parse a string specifying a time and return its corresponding
97 * value as a number of microseconds. Exit from the application if
7542157d
SS
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
bf7e799c
SS
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
7542157d
SS
105 * date
106 *
748061de 107 * @see parse_date()
7542157d
SS
108 */
109int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
110
01310af2
FB
111typedef 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
02d504a7
FB
118#define OPT_VIDEO 0x0010
119#define OPT_AUDIO 0x0020
120#define OPT_GRAB 0x0040
26d4f26b 121#define OPT_INT 0x0080
394c4d77 122#define OPT_FLOAT 0x0100
ae27975d 123#define OPT_SUBTITLE 0x0200
26513856
SS
124#define OPT_INT64 0x0400
125#define OPT_EXIT 0x0800
126#define OPT_DATA 0x1000
ae27975d 127 union {
7efe05ab 128 void *dst_ptr;
26513856 129 int (*func_arg)(const char *, const char *);
01310af2
FB
130 } u;
131 const char *help;
132 const char *argname;
133} OptionDef;
134
02d504a7 135void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
136
137/**
49bd8e4b 138 * Parse the command line arguments.
60a9966e 139 * @param options Array with the definitions required to interpret every
0baf34d8 140 * option of the form: -option_name [argument]
60a9966e
SS
141 * @param parse_arg_function Name of the function called to process every
142 * argument without a leading option name flag. NULL if such arguments do
143 * not have to be processed.
144 */
145void parse_options(int argc, char **argv, const OptionDef *options,
146 void (* parse_arg_function)(const char*));
147
8d787f8e 148/**
d4863fc1
AK
149 * Check if the given stream matches a stream specifier.
150 *
151 * @param s Corresponding format context.
152 * @param st Stream from s to be checked.
153 * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
154 *
155 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
156 */
157int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
158
159/**
8c8eab8b 160 * Filter out options for given codec.
ce23ca81
SS
161 *
162 * Create a new options dictionary containing only the options from
163 * opts which apply to the codec with ID codec_id.
164 *
d4863fc1
AK
165 * @param s Corresponding format context.
166 * @param st A stream from s for which the options should be filtered.
ce23ca81 167 * @return a pointer to the created dictionary
8c8eab8b 168 */
d4863fc1 169AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
8c8eab8b 170
7cea06d1
SS
171/**
172 * Setup AVCodecContext options for avformat_find_stream_info().
173 *
174 * Create an array of dictionaries, one dictionary for each stream
175 * contained in s.
176 * Each dictionary will contain the options from codec_opts which can
177 * be applied to the corresponding stream codec context.
178 *
179 * @return pointer to the created array of dictionaries, NULL if it
180 * cannot be created
3009f521 181 */
8ec19f84 182AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
3009f521 183
8c8eab8b 184/**
49bd8e4b 185 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
186 * readable description of the error code err.
187 *
188 * If strerror_r() is not available the use of this function in a
189 * multithreaded application may be unsafe.
190 *
191 * @see av_strerror()
192 */
01310af2 193void print_error(const char *filename, int err);
c5dc6026 194
f35917b2 195/**
49bd8e4b 196 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
197 * current version of the repository and of the libav* libraries used by
198 * the program.
86074ed1 199 */
ea9c581f 200void show_banner(void);
86074ed1
SS
201
202/**
49bd8e4b 203 * Print the version of the program to stdout. The version message
86074ed1
SS
204 * depends on the current versions of the repository and of the libav*
205 * libraries.
86074ed1 206 */
64555bd9 207void show_version(void);
86074ed1
SS
208
209/**
49bd8e4b 210 * Print the license of the program to stdout. The license depends on
15067504 211 * the license of the libraries compiled into the program.
f35917b2
SS
212 */
213void show_license(void);
214
ba9880c1 215/**
49bd8e4b 216 * Print a listing containing all the formats supported by the
ba9880c1
SS
217 * program.
218 */
219void show_formats(void);
220
090b61b2 221/**
49bd8e4b 222 * Print a listing containing all the codecs supported by the
8447f0bd
MN
223 * program.
224 */
225void show_codecs(void);
226
227/**
49bd8e4b 228 * Print a listing containing all the filters supported by the
62d75662
SS
229 * program.
230 */
231void show_filters(void);
232
233/**
49bd8e4b 234 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
235 * program.
236 */
237void show_bsfs(void);
238
239/**
49bd8e4b 240 * Print a listing containing all the protocols supported by the
8447f0bd
MN
241 * program.
242 */
243void show_protocols(void);
244
245/**
49bd8e4b 246 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
247 * program.
248 */
249void show_pix_fmts(void);
250
251/**
48966b02
MR
252 * Return a positive value if a line read from standard input
253 * starts with [yY], otherwise return 0.
090b61b2
SS
254 */
255int read_yesno(void);
256
458b062d 257/**
49bd8e4b 258 * Read the file with name filename, and put its content in a newly
458b062d
SS
259 * allocated 0-terminated buffer.
260 *
49bd8e4b
MR
261 * @param bufptr location where pointer to buffer is returned
262 * @param size location where size of buffer is returned
458b062d
SS
263 * @return 0 in case of success, a negative value corresponding to an
264 * AVERROR error code in case of failure.
265 */
266int read_file(const char *filename, char **bufptr, size_t *size);
267
7a8bfa5d
AS
268typedef struct {
269 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
270 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
271 int64_t last_pts; /// PTS of the last frame
272 int64_t last_dts; /// DTS of the last frame
273} PtsCorrectionContext;
274
275/**
f03f30d7 276 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
277 */
278void init_pts_correction(PtsCorrectionContext *ctx);
279
280/**
f03f30d7 281 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
282 * which might have incorrect times. Input timestamps may wrap around, in
283 * which case the output will as well.
284 *
f03f30d7 285 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 286 * AVCodecContext.reordered_opaque
f03f30d7
SS
287 * @param dts the dts field of the decoded AVPacket
288 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
289 */
290int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
291
6e872935
SS
292/**
293 * Get a file corresponding to a preset file.
294 *
295 * If is_path is non-zero, look for the file in the path preset_name.
296 * Otherwise search for a file named arg.ffpreset in the directories
297 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
298 * at configuration time, in that order. If no such file is found and
299 * codec_name is defined, then search for a file named
300 * codec_name-preset_name.ffpreset in the above-mentioned directories.
301 *
302 * @param filename buffer where the name of the found filename is written
303 * @param filename_size size in bytes of the filename buffer
304 * @param preset_name name of the preset to search
305 * @param is_path tell if preset_name is a filename path
306 * @param codec_name name of the codec for which to look for the
307 * preset, may be NULL
308 */
309FILE *get_preset_file(char *filename, size_t filename_size,
310 const char *preset_name, int is_path, const char *codec_name);
311
f7ead94c
SS
312typedef struct {
313 enum PixelFormat pix_fmt;
314} FFSinkContext;
315
316extern AVFilter ffsink;
317
ff0652e5
SS
318/**
319 * Extract a frame from sink.
320 *
321 * @return a negative error in case of failure, 1 if one frame has
322 * been extracted successfully.
323 */
324int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
325 AVFilterBufferRef **picref, AVRational *pts_tb);
326
dad09ff9
AK
327/**
328 * Do all the necessary cleanup and abort.
329 * This function is implemented in the avtools, not cmdutils.
330 */
331void exit_program(int ret);
332
cac651c8
AK
333/**
334 * Realloc array to hold new_size elements of elem_size.
335 * Calls exit_program() on failure.
336 *
337 * @param elem_size size in bytes of each element
338 * @param size new element count will be written here
339 * @return reallocated array
340 */
341void *grow_array(void *array, int elem_size, int *size, int new_size);
342
153382e1 343#endif /* LIBAV_CMDUTILS_H */