Merge commit '7c5012127fb7e18f0616011257bb4248f6a8b608'
[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 struct SwrContext *swr_opts;
55 extern AVDictionary *format_opts, *codec_opts;
56
57 /**
58  * Initialize the cmdutils option system, in particular
59  * allocate the *_opts contexts.
60  */
61 void init_opts(void);
62 /**
63  * Uninitialize the cmdutils option system, in particular
64  * free the *_opts contexts and their contents.
65  */
66 void uninit_opts(void);
67
68 /**
69  * Trivial log callback.
70  * Only suitable for opt_help and similar since it lacks prefix handling.
71  */
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74 /**
75  * Fallback for options that are not explicitly handled, these will be
76  * parsed through AVOptions.
77  */
78 int opt_default(const char *opt, const char *arg);
79
80 /**
81  * Set the libav* libraries log level.
82  */
83 int opt_loglevel(const char *opt, const char *arg);
84
85 int opt_report(const char *opt);
86
87 int opt_max_alloc(const char *opt, const char *arg);
88
89 int opt_cpuflags(const char *opt, const char *arg);
90
91 int opt_codec_debug(const char *opt, const char *arg);
92
93 /**
94  * Limit the execution time.
95  */
96 int opt_timelimit(const char *opt, const char *arg);
97
98 /**
99  * Parse a string and return its corresponding value as a double.
100  * Exit from the application if the string cannot be correctly
101  * parsed or the corresponding value is invalid.
102  *
103  * @param context the context of the value to be set (e.g. the
104  * corresponding command line option name)
105  * @param numstr the string to be parsed
106  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
107  * string should be parsed
108  * @param min the minimum valid accepted value
109  * @param max the maximum valid accepted value
110  */
111 double parse_number_or_die(const char *context, const char *numstr, int type,
112                            double min, double max);
113
114 /**
115  * Parse a string specifying a time and return its corresponding
116  * value as a number of microseconds. Exit from the application if
117  * the string cannot be correctly parsed.
118  *
119  * @param context the context of the value to be set (e.g. the
120  * corresponding command line option name)
121  * @param timestr the string to be parsed
122  * @param is_duration a flag which tells how to interpret timestr, if
123  * not zero timestr is interpreted as a duration, otherwise as a
124  * date
125  *
126  * @see parse_date()
127  */
128 int64_t parse_time_or_die(const char *context, const char *timestr,
129                           int is_duration);
130
131 typedef struct SpecifierOpt {
132     char *specifier;    /**< stream/chapter/program/... specifier */
133     union {
134         uint8_t *str;
135         int        i;
136         int64_t  i64;
137         float      f;
138         double   dbl;
139     } u;
140 } SpecifierOpt;
141
142 typedef struct {
143     const char *name;
144     int flags;
145 #define HAS_ARG    0x0001
146 #define OPT_BOOL   0x0002
147 #define OPT_EXPERT 0x0004
148 #define OPT_STRING 0x0008
149 #define OPT_VIDEO  0x0010
150 #define OPT_AUDIO  0x0020
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 /**
175  * Print help for all options matching specified flags.
176  *
177  * @param options a list of options
178  * @param msg title of this group. Only printed if at least one option matches.
179  * @param req_flags print only options which have all those flags set.
180  * @param rej_flags don't print options which have any of those flags set.
181  */
182 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
183                        int rej_flags);
184
185 /**
186  * Show help for all options with given flags in class and all its
187  * children.
188  */
189 void show_help_children(const AVClass *class, int flags);
190
191 /**
192  * Parse the command line arguments.
193  *
194  * @param optctx an opaque options context
195  * @param options Array with the definitions required to interpret every
196  * option of the form: -option_name [argument]
197  * @param parse_arg_function Name of the function called to process every
198  * argument without a leading option name flag. NULL if such arguments do
199  * not have to be processed.
200  */
201 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
202                    void (* parse_arg_function)(void *optctx, const char*));
203
204 /**
205  * Parse one given option.
206  *
207  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
208  */
209 int parse_option(void *optctx, const char *opt, const char *arg,
210                  const OptionDef *options);
211
212 /**
213  * Find the '-loglevel' option in the command line args and apply it.
214  */
215 void parse_loglevel(int argc, char **argv, const OptionDef *options);
216
217 /**
218  * Return index of option opt in argv or 0 if not found.
219  */
220 int locate_option(int argc, char **argv, const OptionDef *options,
221                   const char *optname);
222
223 /**
224  * Check if the given stream matches a stream specifier.
225  *
226  * @param s  Corresponding format context.
227  * @param st Stream from s to be checked.
228  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
229  *
230  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
231  */
232 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
233
234 /**
235  * Filter out options for given codec.
236  *
237  * Create a new options dictionary containing only the options from
238  * opts which apply to the codec with ID codec_id.
239  *
240  * @param s Corresponding format context.
241  * @param st A stream from s for which the options should be filtered.
242  * @param codec The particular codec for which the options should be filtered.
243  *              If null, the default one is looked up according to the codec id.
244  * @return a pointer to the created dictionary
245  */
246 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
247                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
248
249 /**
250  * Setup AVCodecContext options for avformat_find_stream_info().
251  *
252  * Create an array of dictionaries, one dictionary for each stream
253  * contained in s.
254  * Each dictionary will contain the options from codec_opts which can
255  * be applied to the corresponding stream codec context.
256  *
257  * @return pointer to the created array of dictionaries, NULL if it
258  * cannot be created
259  */
260 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
261                                            AVDictionary *codec_opts);
262
263 /**
264  * Print an error message to stderr, indicating filename and a human
265  * readable description of the error code err.
266  *
267  * If strerror_r() is not available the use of this function in a
268  * multithreaded application may be unsafe.
269  *
270  * @see av_strerror()
271  */
272 void print_error(const char *filename, int err);
273
274 /**
275  * Print the program banner to stderr. The banner contents depend on the
276  * current version of the repository and of the libav* libraries used by
277  * the program.
278  */
279 void show_banner(int argc, char **argv, const OptionDef *options);
280
281 /**
282  * Print the version of the program to stdout. The version message
283  * depends on the current versions of the repository and of the libav*
284  * libraries.
285  * This option processing function does not utilize the arguments.
286  */
287 int show_version(const char *opt, const char *arg);
288
289 /**
290  * Print the license of the program to stdout. The license depends on
291  * the license of the libraries compiled into the program.
292  * This option processing function does not utilize the arguments.
293  */
294 int show_license(const char *opt, const char *arg);
295
296 /**
297  * Print a listing containing all the formats supported by the
298  * program.
299  * This option processing function does not utilize the arguments.
300  */
301 int show_formats(const char *opt, const char *arg);
302
303 /**
304  * Print a listing containing all the codecs supported by the
305  * program.
306  * This option processing function does not utilize the arguments.
307  */
308 int show_codecs(const char *opt, const char *arg);
309
310 /**
311  * Print a listing containing all the decoders supported by the
312  * program.
313  */
314 int show_decoders(const char *opt, const char *arg);
315
316 /**
317  * Print a listing containing all the encoders supported by the
318  * program.
319  */
320 int show_encoders(const char *opt, const char *arg);
321
322 /**
323  * Print a listing containing all the filters supported by the
324  * program.
325  * This option processing function does not utilize the arguments.
326  */
327 int show_filters(const char *opt, const char *arg);
328
329 /**
330  * Print a listing containing all the bit stream filters supported by the
331  * program.
332  * This option processing function does not utilize the arguments.
333  */
334 int show_bsfs(const char *opt, const char *arg);
335
336 /**
337  * Print a listing containing all the protocols supported by the
338  * program.
339  * This option processing function does not utilize the arguments.
340  */
341 int show_protocols(const char *opt, const char *arg);
342
343 /**
344  * Print a listing containing all the pixel formats supported by the
345  * program.
346  * This option processing function does not utilize the arguments.
347  */
348 int show_pix_fmts(const char *opt, const char *arg);
349
350 /**
351  * Print a listing containing all the sample formats supported by the
352  * program.
353  */
354 int show_sample_fmts(const char *opt, const char *arg);
355
356 /**
357  * Return a positive value if a line read from standard input
358  * starts with [yY], otherwise return 0.
359  */
360 int read_yesno(void);
361
362 /**
363  * Read the file with name filename, and put its content in a newly
364  * allocated 0-terminated buffer.
365  *
366  * @param bufptr location where pointer to buffer is returned
367  * @param size   location where size of buffer is returned
368  * @return 0 in case of success, a negative value corresponding to an
369  * AVERROR error code in case of failure.
370  */
371 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
372
373 /**
374  * Get a file corresponding to a preset file.
375  *
376  * If is_path is non-zero, look for the file in the path preset_name.
377  * Otherwise search for a file named arg.ffpreset in the directories
378  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
379  * at configuration time or in a "ffpresets" folder along the executable
380  * on win32, in that order. If no such file is found and
381  * codec_name is defined, then search for a file named
382  * codec_name-preset_name.avpreset in the above-mentioned directories.
383  *
384  * @param filename buffer where the name of the found filename is written
385  * @param filename_size size in bytes of the filename buffer
386  * @param preset_name name of the preset to search
387  * @param is_path tell if preset_name is a filename path
388  * @param codec_name name of the codec for which to look for the
389  * preset, may be NULL
390  */
391 FILE *get_preset_file(char *filename, size_t filename_size,
392                       const char *preset_name, int is_path, const char *codec_name);
393
394 /**
395  * Do all the necessary cleanup and abort.
396  * This function is implemented in the avtools, not cmdutils.
397  */
398 av_noreturn void exit_program(int ret);
399
400 /**
401  * Realloc array to hold new_size elements of elem_size.
402  * Calls exit_program() on failure.
403  *
404  * @param elem_size size in bytes of each element
405  * @param size new element count will be written here
406  * @return reallocated array
407  */
408 void *grow_array(void *array, int elem_size, int *size, int new_size);
409
410 typedef struct FrameBuffer {
411     uint8_t *base[4];
412     uint8_t *data[4];
413     int  linesize[4];
414
415     int h, w;
416     enum PixelFormat pix_fmt;
417
418     int refcount;
419     struct FrameBuffer **pool;  ///< head of the buffer pool
420     struct FrameBuffer *next;
421 } FrameBuffer;
422
423 /**
424  * Get a frame from the pool. This is intended to be used as a callback for
425  * AVCodecContext.get_buffer.
426  *
427  * @param s codec context. s->opaque must be a pointer to the head of the
428  *          buffer pool.
429  * @param frame frame->opaque will be set to point to the FrameBuffer
430  *              containing the frame data.
431  */
432 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
433
434 /**
435  * A callback to be used for AVCodecContext.release_buffer along with
436  * codec_get_buffer().
437  */
438 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
439
440 /**
441  * A callback to be used for AVFilterBuffer.free.
442  * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
443  *           containing the buffer data.
444  */
445 void filter_release_buffer(AVFilterBuffer *fb);
446
447 /**
448  * Free all the buffers in the pool. This must be called after all the
449  * buffers have been released.
450  */
451 void free_buffer_pool(FrameBuffer **pool);
452 #endif /* CMDUTILS_H */