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