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