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