Merge commit 'c661cb6672af5ebcb900ec8766b24761bd2ab011'
[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(void *optctx, const char *opt, const char *arg);
79
80 /**
81  * Set the libav* libraries log level.
82  */
83 int opt_loglevel(void *optctx, const char *opt, const char *arg);
84
85 int opt_report(const char *opt);
86
87 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
88
89 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
90
91 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
92
93 /**
94  * Limit the execution time.
95  */
96 int opt_timelimit(void *optctx, 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 OptionDef {
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_PERFILE  0x2000     /* the option is per-file (currently ffmpeg-only).
158                                    implied by OPT_OFFSET or OPT_SPEC */
159 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
160 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
161                                    Implies OPT_OFFSET. Next element after the offset is
162                                    an int containing element count in the array. */
163 #define OPT_TIME  0x10000
164 #define OPT_DOUBLE 0x20000
165      union {
166         void *dst_ptr;
167         int (*func_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  * @param alt_flags print only options that have at least one of those flags set
182  */
183 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
184                        int rej_flags, int alt_flags);
185
186 /**
187  * Show help for all options with given flags in class and all its
188  * children.
189  */
190 void show_help_children(const AVClass *class, int flags);
191
192 /**
193  * Per-avtool specific help handler. Implemented in each
194  * avtool, called by show_help().
195  */
196 void show_help_default(const char *opt, const char *arg);
197
198 /**
199  * Generic -h handler common to all avtools.
200  */
201 int show_help(void *optctx, const char *opt, const char *arg);
202
203 /**
204  * Parse the command line arguments.
205  *
206  * @param optctx an opaque options context
207  * @param argc   number of command line arguments
208  * @param argv   values of command line arguments
209  * @param options Array with the definitions required to interpret every
210  * option of the form: -option_name [argument]
211  * @param parse_arg_function Name of the function called to process every
212  * argument without a leading option name flag. NULL if such arguments do
213  * not have to be processed.
214  */
215 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
216                    void (* parse_arg_function)(void *optctx, const char*));
217
218 /**
219  * Parse one given option.
220  *
221  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
222  */
223 int parse_option(void *optctx, const char *opt, const char *arg,
224                  const OptionDef *options);
225
226 /**
227  * An option extracted from the commandline.
228  * Cannot use AVDictionary because of options like -map which can be
229  * used multiple times.
230  */
231 typedef struct Option {
232     const OptionDef  *opt;
233     const char       *key;
234     const char       *val;
235 } Option;
236
237 typedef struct OptionGroupDef {
238     /**< group name */
239     const char *name;
240     /**
241      * Option to be used as group separator. Can be NULL for groups which
242      * are terminated by a non-option argument (e.g. ffmpeg output files)
243      */
244     const char *sep;
245 } OptionGroupDef;
246
247 typedef struct OptionGroup {
248     const OptionGroupDef *group_def;
249     const char *arg;
250
251     Option *opts;
252     int  nb_opts;
253
254     AVDictionary *codec_opts;
255     AVDictionary *format_opts;
256     struct SwsContext *sws_opts;
257     struct SwrContext *swr_opts;
258 } OptionGroup;
259
260 /**
261  * A list of option groups that all have the same group type
262  * (e.g. input files or output files)
263  */
264 typedef struct OptionGroupList {
265     const OptionGroupDef *group_def;
266
267     OptionGroup *groups;
268     int       nb_groups;
269 } OptionGroupList;
270
271 typedef struct OptionParseContext {
272     OptionGroup global_opts;
273
274     OptionGroupList *groups;
275     int           nb_groups;
276
277     /* parsing state */
278     OptionGroup cur_group;
279 } OptionParseContext;
280
281 /**
282  * Parse an options group and write results into optctx.
283  *
284  * @param optctx an app-specific options context. NULL for global options group
285  */
286 int parse_optgroup(void *optctx, OptionGroup *g);
287
288 /**
289  * Split the commandline into an intermediate form convenient for further
290  * processing.
291  *
292  * The commandline is assumed to be composed of options which either belong to a
293  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
294  * (everything else).
295  *
296  * A group (defined by an OptionGroupDef struct) is a sequence of options
297  * terminated by either a group separator option (e.g. -i) or a parameter that
298  * is not an option (doesn't start with -). A group without a separator option
299  * must always be first in the supplied groups list.
300  *
301  * All options within the same group are stored in one OptionGroup struct in an
302  * OptionGroupList, all groups with the same group definition are stored in one
303  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
304  * same as the order of group definitions.
305  */
306 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
307                       const OptionDef *options,
308                       const OptionGroupDef *groups, int nb_groups);
309
310 /**
311  * Free all allocated memory in an OptionParseContext.
312  */
313 void uninit_parse_context(OptionParseContext *octx);
314
315 /**
316  * Find the '-loglevel' option in the command line args and apply it.
317  */
318 void parse_loglevel(int argc, char **argv, const OptionDef *options);
319
320 /**
321  * Return index of option opt in argv or 0 if not found.
322  */
323 int locate_option(int argc, char **argv, const OptionDef *options,
324                   const char *optname);
325
326 /**
327  * Check if the given stream matches a stream specifier.
328  *
329  * @param s  Corresponding format context.
330  * @param st Stream from s to be checked.
331  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
332  *
333  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
334  */
335 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
336
337 /**
338  * Filter out options for given codec.
339  *
340  * Create a new options dictionary containing only the options from
341  * opts which apply to the codec with ID codec_id.
342  *
343  * @param opts     dictionary to place options in
344  * @param codec_id ID of the codec that should be filtered for
345  * @param s Corresponding format context.
346  * @param st A stream from s for which the options should be filtered.
347  * @param codec The particular codec for which the options should be filtered.
348  *              If null, the default one is looked up according to the codec id.
349  * @return a pointer to the created dictionary
350  */
351 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
352                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
353
354 /**
355  * Setup AVCodecContext options for avformat_find_stream_info().
356  *
357  * Create an array of dictionaries, one dictionary for each stream
358  * contained in s.
359  * Each dictionary will contain the options from codec_opts which can
360  * be applied to the corresponding stream codec context.
361  *
362  * @return pointer to the created array of dictionaries, NULL if it
363  * cannot be created
364  */
365 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
366                                            AVDictionary *codec_opts);
367
368 /**
369  * Print an error message to stderr, indicating filename and a human
370  * readable description of the error code err.
371  *
372  * If strerror_r() is not available the use of this function in a
373  * multithreaded application may be unsafe.
374  *
375  * @see av_strerror()
376  */
377 void print_error(const char *filename, int err);
378
379 /**
380  * Print the program banner to stderr. The banner contents depend on the
381  * current version of the repository and of the libav* libraries used by
382  * the program.
383  */
384 void show_banner(int argc, char **argv, const OptionDef *options);
385
386 /**
387  * Print the version of the program to stdout. The version message
388  * depends on the current versions of the repository and of the libav*
389  * libraries.
390  * This option processing function does not utilize the arguments.
391  */
392 int show_version(void *optctx, const char *opt, const char *arg);
393
394 /**
395  * Print the license of the program to stdout. The license depends on
396  * the license of the libraries compiled into the program.
397  * This option processing function does not utilize the arguments.
398  */
399 int show_license(void *optctx, const char *opt, const char *arg);
400
401 /**
402  * Print a listing containing all the formats supported by the
403  * program.
404  * This option processing function does not utilize the arguments.
405  */
406 int show_formats(void *optctx, const char *opt, const char *arg);
407
408 /**
409  * Print a listing containing all the codecs supported by the
410  * program.
411  * This option processing function does not utilize the arguments.
412  */
413 int show_codecs(void *optctx, const char *opt, const char *arg);
414
415 /**
416  * Print a listing containing all the decoders supported by the
417  * program.
418  */
419 int show_decoders(void *optctx, const char *opt, const char *arg);
420
421 /**
422  * Print a listing containing all the encoders supported by the
423  * program.
424  */
425 int show_encoders(void *optctx, const char *opt, const char *arg);
426
427 /**
428  * Print a listing containing all the filters supported by the
429  * program.
430  * This option processing function does not utilize the arguments.
431  */
432 int show_filters(void *optctx, const char *opt, const char *arg);
433
434 /**
435  * Print a listing containing all the bit stream filters supported by the
436  * program.
437  * This option processing function does not utilize the arguments.
438  */
439 int show_bsfs(void *optctx, const char *opt, const char *arg);
440
441 /**
442  * Print a listing containing all the protocols supported by the
443  * program.
444  * This option processing function does not utilize the arguments.
445  */
446 int show_protocols(void *optctx, const char *opt, const char *arg);
447
448 /**
449  * Print a listing containing all the pixel formats supported by the
450  * program.
451  * This option processing function does not utilize the arguments.
452  */
453 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
454
455 /**
456  * Print a listing containing all the standard channel layouts supported by
457  * the program.
458  * This option processing function does not utilize the arguments.
459  */
460 int show_layouts(void *optctx, const char *opt, const char *arg);
461
462 /**
463  * Print a listing containing all the sample formats supported by the
464  * program.
465  */
466 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
467
468 /**
469  * Return a positive value if a line read from standard input
470  * starts with [yY], otherwise return 0.
471  */
472 int read_yesno(void);
473
474 /**
475  * Read the file with name filename, and put its content in a newly
476  * allocated 0-terminated buffer.
477  *
478  * @param filename file to read from
479  * @param bufptr location where pointer to buffer is returned
480  * @param size   location where size of buffer is returned
481  * @return 0 in case of success, a negative value corresponding to an
482  * AVERROR error code in case of failure.
483  */
484 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
485
486 /**
487  * Get a file corresponding to a preset file.
488  *
489  * If is_path is non-zero, look for the file in the path preset_name.
490  * Otherwise search for a file named arg.ffpreset in the directories
491  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
492  * at configuration time or in a "ffpresets" folder along the executable
493  * on win32, in that order. If no such file is found and
494  * codec_name is defined, then search for a file named
495  * codec_name-preset_name.avpreset in the above-mentioned directories.
496  *
497  * @param filename buffer where the name of the found filename is written
498  * @param filename_size size in bytes of the filename buffer
499  * @param preset_name name of the preset to search
500  * @param is_path tell if preset_name is a filename path
501  * @param codec_name name of the codec for which to look for the
502  * preset, may be NULL
503  */
504 FILE *get_preset_file(char *filename, size_t filename_size,
505                       const char *preset_name, int is_path, const char *codec_name);
506
507 /**
508  * Realloc array to hold new_size elements of elem_size.
509  * Calls exit() on failure.
510  *
511  * @param array array to reallocate
512  * @param elem_size size in bytes of each element
513  * @param size new element count will be written here
514  * @param new_size number of elements to place in reallocated array
515  * @return reallocated array
516  */
517 void *grow_array(void *array, int elem_size, int *size, int new_size);
518
519 #define GROW_ARRAY(array, nb_elems)\
520     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
521
522 typedef struct FrameBuffer {
523     uint8_t *base[4];
524     uint8_t *data[4];
525     int  linesize[4];
526
527     int h, w;
528     enum AVPixelFormat pix_fmt;
529
530     int refcount;
531     struct FrameBuffer **pool;  ///< head of the buffer pool
532     struct FrameBuffer *next;
533 } FrameBuffer;
534
535 /**
536  * Get a frame from the pool. This is intended to be used as a callback for
537  * AVCodecContext.get_buffer.
538  *
539  * @param s codec context. s->opaque must be a pointer to the head of the
540  *          buffer pool.
541  * @param frame frame->opaque will be set to point to the FrameBuffer
542  *              containing the frame data.
543  */
544 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
545
546 /**
547  * A callback to be used for AVCodecContext.release_buffer along with
548  * codec_get_buffer().
549  */
550 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
551
552 /**
553  * A callback to be used for AVFilterBuffer.free.
554  * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
555  *           containing the buffer data.
556  */
557 void filter_release_buffer(AVFilterBuffer *fb);
558
559 /**
560  * Free all the buffers in the pool. This must be called after all the
561  * buffers have been released.
562  */
563 void free_buffer_pool(FrameBuffer **pool);
564
565 #define GET_PIX_FMT_NAME(pix_fmt)\
566     const char *name = av_get_pix_fmt_name(pix_fmt);
567
568 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
569     const char *name = av_get_sample_fmt_name(sample_fmt)
570
571 #define GET_SAMPLE_RATE_NAME(rate)\
572     char name[16];\
573     snprintf(name, sizeof(name), "%d", rate);
574
575 #define GET_CH_LAYOUT_NAME(ch_layout)\
576     char name[16];\
577     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
578
579 #define GET_CH_LAYOUT_DESC(ch_layout)\
580     char name[128];\
581     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
582
583 #endif /* CMDUTILS_H */