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