cmdutils: add support for caller-provided option context.
[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
7cc8d638
AK
127#define OPT_FUNC2 0x2000
128#define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
ae27975d 129 union {
7efe05ab 130 void *dst_ptr;
26513856 131 int (*func_arg)(const char *, const char *);
7cc8d638
AK
132 int (*func2_arg)(void *, const char *, const char *);
133 size_t off;
01310af2
FB
134 } u;
135 const char *help;
136 const char *argname;
137} OptionDef;
138
02d504a7 139void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
140
141/**
49bd8e4b 142 * Parse the command line arguments.
7cc8d638
AK
143 *
144 * @param optctx an opaque options context
60a9966e 145 * @param options Array with the definitions required to interpret every
0baf34d8 146 * option of the form: -option_name [argument]
60a9966e
SS
147 * @param parse_arg_function Name of the function called to process every
148 * argument without a leading option name flag. NULL if such arguments do
149 * not have to be processed.
150 */
7cc8d638
AK
151void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
152 void (* parse_arg_function)(void *optctx, const char*));
60a9966e 153
8d787f8e 154/**
d4863fc1
AK
155 * Check if the given stream matches a stream specifier.
156 *
157 * @param s Corresponding format context.
158 * @param st Stream from s to be checked.
159 * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
160 *
161 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
162 */
163int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
164
165/**
8c8eab8b 166 * Filter out options for given codec.
ce23ca81
SS
167 *
168 * Create a new options dictionary containing only the options from
169 * opts which apply to the codec with ID codec_id.
170 *
d4863fc1
AK
171 * @param s Corresponding format context.
172 * @param st A stream from s for which the options should be filtered.
ce23ca81 173 * @return a pointer to the created dictionary
8c8eab8b 174 */
d4863fc1 175AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
8c8eab8b 176
7cea06d1
SS
177/**
178 * Setup AVCodecContext options for avformat_find_stream_info().
179 *
180 * Create an array of dictionaries, one dictionary for each stream
181 * contained in s.
182 * Each dictionary will contain the options from codec_opts which can
183 * be applied to the corresponding stream codec context.
184 *
185 * @return pointer to the created array of dictionaries, NULL if it
186 * cannot be created
3009f521 187 */
8ec19f84 188AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
3009f521 189
8c8eab8b 190/**
49bd8e4b 191 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
192 * readable description of the error code err.
193 *
194 * If strerror_r() is not available the use of this function in a
195 * multithreaded application may be unsafe.
196 *
197 * @see av_strerror()
198 */
01310af2 199void print_error(const char *filename, int err);
c5dc6026 200
f35917b2 201/**
49bd8e4b 202 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
203 * current version of the repository and of the libav* libraries used by
204 * the program.
86074ed1 205 */
ea9c581f 206void show_banner(void);
86074ed1
SS
207
208/**
49bd8e4b 209 * Print the version of the program to stdout. The version message
86074ed1
SS
210 * depends on the current versions of the repository and of the libav*
211 * libraries.
86074ed1 212 */
64555bd9 213void show_version(void);
86074ed1
SS
214
215/**
49bd8e4b 216 * Print the license of the program to stdout. The license depends on
15067504 217 * the license of the libraries compiled into the program.
f35917b2
SS
218 */
219void show_license(void);
220
ba9880c1 221/**
49bd8e4b 222 * Print a listing containing all the formats supported by the
ba9880c1
SS
223 * program.
224 */
225void show_formats(void);
226
090b61b2 227/**
49bd8e4b 228 * Print a listing containing all the codecs supported by the
8447f0bd
MN
229 * program.
230 */
231void show_codecs(void);
232
233/**
49bd8e4b 234 * Print a listing containing all the filters supported by the
62d75662
SS
235 * program.
236 */
237void show_filters(void);
238
239/**
49bd8e4b 240 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
241 * program.
242 */
243void show_bsfs(void);
244
245/**
49bd8e4b 246 * Print a listing containing all the protocols supported by the
8447f0bd
MN
247 * program.
248 */
249void show_protocols(void);
250
251/**
49bd8e4b 252 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
253 * program.
254 */
255void show_pix_fmts(void);
256
257/**
48966b02
MR
258 * Return a positive value if a line read from standard input
259 * starts with [yY], otherwise return 0.
090b61b2
SS
260 */
261int read_yesno(void);
262
458b062d 263/**
49bd8e4b 264 * Read the file with name filename, and put its content in a newly
458b062d
SS
265 * allocated 0-terminated buffer.
266 *
49bd8e4b
MR
267 * @param bufptr location where pointer to buffer is returned
268 * @param size location where size of buffer is returned
458b062d
SS
269 * @return 0 in case of success, a negative value corresponding to an
270 * AVERROR error code in case of failure.
271 */
272int read_file(const char *filename, char **bufptr, size_t *size);
273
7a8bfa5d
AS
274typedef struct {
275 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
276 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
277 int64_t last_pts; /// PTS of the last frame
278 int64_t last_dts; /// DTS of the last frame
279} PtsCorrectionContext;
280
281/**
f03f30d7 282 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
283 */
284void init_pts_correction(PtsCorrectionContext *ctx);
285
286/**
f03f30d7 287 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
288 * which might have incorrect times. Input timestamps may wrap around, in
289 * which case the output will as well.
290 *
f03f30d7 291 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 292 * AVCodecContext.reordered_opaque
f03f30d7
SS
293 * @param dts the dts field of the decoded AVPacket
294 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
295 */
296int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
297
6e872935
SS
298/**
299 * Get a file corresponding to a preset file.
300 *
301 * If is_path is non-zero, look for the file in the path preset_name.
302 * Otherwise search for a file named arg.ffpreset in the directories
303 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
304 * at configuration time, in that order. If no such file is found and
305 * codec_name is defined, then search for a file named
306 * codec_name-preset_name.ffpreset in the above-mentioned directories.
307 *
308 * @param filename buffer where the name of the found filename is written
309 * @param filename_size size in bytes of the filename buffer
310 * @param preset_name name of the preset to search
311 * @param is_path tell if preset_name is a filename path
312 * @param codec_name name of the codec for which to look for the
313 * preset, may be NULL
314 */
315FILE *get_preset_file(char *filename, size_t filename_size,
316 const char *preset_name, int is_path, const char *codec_name);
317
f7ead94c
SS
318typedef struct {
319 enum PixelFormat pix_fmt;
320} FFSinkContext;
321
322extern AVFilter ffsink;
323
ff0652e5
SS
324/**
325 * Extract a frame from sink.
326 *
327 * @return a negative error in case of failure, 1 if one frame has
328 * been extracted successfully.
329 */
330int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
331 AVFilterBufferRef **picref, AVRational *pts_tb);
332
dad09ff9
AK
333/**
334 * Do all the necessary cleanup and abort.
335 * This function is implemented in the avtools, not cmdutils.
336 */
337void exit_program(int ret);
338
cac651c8
AK
339/**
340 * Realloc array to hold new_size elements of elem_size.
341 * Calls exit_program() on failure.
342 *
343 * @param elem_size size in bytes of each element
344 * @param size new element count will be written here
345 * @return reallocated array
346 */
347void *grow_array(void *array, int elem_size, int *size, int new_size);
348
153382e1 349#endif /* LIBAV_CMDUTILS_H */