vf_drawtext: fontconfig support.
[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 FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef FFMPEG_CMDUTILS_H
23 #define FFMPEG_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 #ifdef __MINGW32__
33 #undef main /* We don't want SDL to override our main() */
34 #endif
35
36 /**
37  * program name, defined by the program for show_version().
38  */
39 extern const char program_name[];
40
41 /**
42  * program birth year, defined by the program for show_banner()
43  */
44 extern const int program_birth_year;
45
46 /**
47  * this year, defined by the program for show_banner()
48  */
49 extern const int this_year;
50
51 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
52 extern AVFormatContext *avformat_opts;
53 extern struct SwsContext *sws_opts;
54 extern AVDictionary *format_opts, *codec_opts;
55
56 /**
57  * Initialize the cmdutils option system, in particular
58  * allocate the *_opts contexts.
59  */
60 void init_opts(void);
61 /**
62  * Uninitialize the cmdutils option system, in particular
63  * free the *_opts contexts and their contents.
64  */
65 void uninit_opts(void);
66
67 /**
68  * Trivial log callback.
69  * Only suitable for opt_help and similar since it lacks prefix handling.
70  */
71 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
72
73 /**
74  * Fallback for options that are not explicitly handled, these will be
75  * parsed through AVOptions.
76  */
77 int opt_default(const char *opt, const char *arg);
78
79 /**
80  * Set the libav* libraries log level.
81  */
82 int opt_loglevel(const char *opt, const char *arg);
83
84 int opt_report(const char *opt);
85
86 int opt_max_alloc(const char *opt, const char *arg);
87
88 int opt_cpuflags(const char *opt, const char *arg);
89
90 int opt_codec_debug(const char *opt, const char *arg);
91
92 /**
93  * Limit the execution time.
94  */
95 int opt_timelimit(const char *opt, const char *arg);
96
97 /**
98  * Parse a string and return its corresponding value as a double.
99  * Exit from the application if the string cannot be correctly
100  * parsed or the corresponding value is invalid.
101  *
102  * @param context the context of the value to be set (e.g. the
103  * corresponding command line option name)
104  * @param numstr the string to be parsed
105  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
106  * string should be parsed
107  * @param min the minimum valid accepted value
108  * @param max the maximum valid accepted value
109  */
110 double parse_number_or_die(const char *context, const char *numstr, int type,
111                            double min, double max);
112
113 /**
114  * Parse a string specifying a time and return its corresponding
115  * value as a number of microseconds. Exit from the application if
116  * the string cannot be correctly parsed.
117  *
118  * @param context the context of the value to be set (e.g. the
119  * corresponding command line option name)
120  * @param timestr the string to be parsed
121  * @param is_duration a flag which tells how to interpret timestr, if
122  * not zero timestr is interpreted as a duration, otherwise as a
123  * date
124  *
125  * @see parse_date()
126  */
127 int64_t parse_time_or_die(const char *context, const char *timestr,
128                           int is_duration);
129
130 typedef struct SpecifierOpt {
131     char *specifier;    /**< stream/chapter/program/... specifier */
132     union {
133         uint8_t *str;
134         int        i;
135         int64_t  i64;
136         float      f;
137         double   dbl;
138     } u;
139 } SpecifierOpt;
140
141 typedef struct {
142     const char *name;
143     int flags;
144 #define HAS_ARG    0x0001
145 #define OPT_BOOL   0x0002
146 #define OPT_EXPERT 0x0004
147 #define OPT_STRING 0x0008
148 #define OPT_VIDEO  0x0010
149 #define OPT_AUDIO  0x0020
150 #define OPT_GRAB   0x0040
151 #define OPT_INT    0x0080
152 #define OPT_FLOAT  0x0100
153 #define OPT_SUBTITLE 0x0200
154 #define OPT_INT64  0x0400
155 #define OPT_EXIT   0x0800
156 #define OPT_DATA   0x1000
157 #define OPT_FUNC2  0x2000
158 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
159 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
160                                    Implies OPT_OFFSET. Next element after the offset is
161                                    an int containing element count in the array. */
162 #define OPT_TIME  0x10000
163 #define OPT_DOUBLE 0x20000
164      union {
165         void *dst_ptr;
166         int (*func_arg)(const char *, const char *);
167         int (*func2_arg)(void *, const char *, const char *);
168         size_t off;
169     } u;
170     const char *help;
171     const char *argname;
172 } OptionDef;
173
174 void show_help_options(const OptionDef *options, const char *msg, int mask,
175                        int value);
176
177 /**
178  * Show help for all options with given flags in class and all its
179  * children.
180  */
181 void show_help_children(const AVClass *class, int flags);
182
183 /**
184  * Parse the command line arguments.
185  *
186  * @param optctx an opaque options context
187  * @param options Array with the definitions required to interpret every
188  * option of the form: -option_name [argument]
189  * @param parse_arg_function Name of the function called to process every
190  * argument without a leading option name flag. NULL if such arguments do
191  * not have to be processed.
192  */
193 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
194                    void (* parse_arg_function)(void *optctx, const char*));
195
196 /**
197  * Parse one given option.
198  *
199  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
200  */
201 int parse_option(void *optctx, const char *opt, const char *arg,
202                  const OptionDef *options);
203
204 /**
205  * Find the '-loglevel' option in the command line args and apply it.
206  */
207 void parse_loglevel(int argc, char **argv, const OptionDef *options);
208
209 /**
210  * Return index of option opt in argv or 0 if not found.
211  */
212 int locate_option(int argc, char **argv, const OptionDef *options,
213                   const char *optname);
214
215 /**
216  * Check if the given stream matches a stream specifier.
217  *
218  * @param s  Corresponding format context.
219  * @param st Stream from s to be checked.
220  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
221  *
222  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
223  */
224 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
225
226 /**
227  * Filter out options for given codec.
228  *
229  * Create a new options dictionary containing only the options from
230  * opts which apply to the codec with ID codec_id.
231  *
232  * @param s Corresponding format context.
233  * @param st A stream from s for which the options should be filtered.
234  * @return a pointer to the created dictionary
235  */
236 AVDictionary *filter_codec_opts(AVDictionary *opts, AVCodec *codec,
237                                 AVFormatContext *s, AVStream *st);
238
239 /**
240  * Setup AVCodecContext options for avformat_find_stream_info().
241  *
242  * Create an array of dictionaries, one dictionary for each stream
243  * contained in s.
244  * Each dictionary will contain the options from codec_opts which can
245  * be applied to the corresponding stream codec context.
246  *
247  * @return pointer to the created array of dictionaries, NULL if it
248  * cannot be created
249  */
250 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
251                                            AVDictionary *codec_opts);
252
253 /**
254  * Print an error message to stderr, indicating filename and a human
255  * readable description of the error code err.
256  *
257  * If strerror_r() is not available the use of this function in a
258  * multithreaded application may be unsafe.
259  *
260  * @see av_strerror()
261  */
262 void print_error(const char *filename, int err);
263
264 /**
265  * Print the program banner to stderr. The banner contents depend on the
266  * current version of the repository and of the libav* libraries used by
267  * the program.
268  */
269 void show_banner(int argc, char **argv, const OptionDef *options);
270
271 /**
272  * Print the version of the program to stdout. The version message
273  * depends on the current versions of the repository and of the libav*
274  * libraries.
275  * This option processing function does not utilize the arguments.
276  */
277 int opt_version(const char *opt, const char *arg);
278
279 /**
280  * Print the license of the program to stdout. The license depends on
281  * the license of the libraries compiled into the program.
282  * This option processing function does not utilize the arguments.
283  */
284 int opt_license(const char *opt, const char *arg);
285
286 /**
287  * Print a listing containing all the formats supported by the
288  * program.
289  * This option processing function does not utilize the arguments.
290  */
291 int opt_formats(const char *opt, const char *arg);
292
293 /**
294  * Print a listing containing all the codecs supported by the
295  * program.
296  * This option processing function does not utilize the arguments.
297  */
298 int opt_codecs(const char *opt, const char *arg);
299
300 /**
301  * Print a listing containing all the filters supported by the
302  * program.
303  * This option processing function does not utilize the arguments.
304  */
305 int opt_filters(const char *opt, const char *arg);
306
307 /**
308  * Print a listing containing all the bit stream filters supported by the
309  * program.
310  * This option processing function does not utilize the arguments.
311  */
312 int opt_bsfs(const char *opt, const char *arg);
313
314 /**
315  * Print a listing containing all the protocols supported by the
316  * program.
317  * This option processing function does not utilize the arguments.
318  */
319 int opt_protocols(const char *opt, const char *arg);
320
321 /**
322  * Print a listing containing all the pixel formats supported by the
323  * program.
324  * This option processing function does not utilize the arguments.
325  */
326 int opt_pix_fmts(const char *opt, const char *arg);
327
328 /**
329  * Print a listing containing all the sample formats supported by the
330  * program.
331  */
332 int show_sample_fmts(const char *opt, const char *arg);
333
334 /**
335  * Return a positive value if a line read from standard input
336  * starts with [yY], otherwise return 0.
337  */
338 int read_yesno(void);
339
340 /**
341  * Read the file with name filename, and put its content in a newly
342  * allocated 0-terminated buffer.
343  *
344  * @param bufptr location where pointer to buffer is returned
345  * @param size   location where size of buffer is returned
346  * @return 0 in case of success, a negative value corresponding to an
347  * AVERROR error code in case of failure.
348  */
349 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
350
351 /**
352  * Get a file corresponding to a preset file.
353  *
354  * If is_path is non-zero, look for the file in the path preset_name.
355  * Otherwise search for a file named arg.ffpreset in the directories
356  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
357  * at configuration time or in a "ffpresets" folder along the executable
358  * on win32, in that order. If no such file is found and
359  * codec_name is defined, then search for a file named
360  * codec_name-preset_name.avpreset in the above-mentioned directories.
361  *
362  * @param filename buffer where the name of the found filename is written
363  * @param filename_size size in bytes of the filename buffer
364  * @param preset_name name of the preset to search
365  * @param is_path tell if preset_name is a filename path
366  * @param codec_name name of the codec for which to look for the
367  * preset, may be NULL
368  */
369 FILE *get_preset_file(char *filename, size_t filename_size,
370                       const char *preset_name, int is_path, const char *codec_name);
371
372 /**
373  * Do all the necessary cleanup and abort.
374  * This function is implemented in the avtools, not cmdutils.
375  */
376 void exit_program(int ret);
377
378 /**
379  * Realloc array to hold new_size elements of elem_size.
380  * Calls exit_program() on failure.
381  *
382  * @param elem_size size in bytes of each element
383  * @param size new element count will be written here
384  * @return reallocated array
385  */
386 void *grow_array(void *array, int elem_size, int *size, int new_size);
387
388 #endif /* CMDUTILS_H */