on2avc: Convert to the new bitstream reader
[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, *resample_opts;
46
47 /**
48  * Register a program-specific cleanup routine.
49  */
50 void register_exit(void (*cb)(int ret));
51
52 /**
53  * Wraps exit with a program-specific cleanup routine.
54  */
55 void exit_program(int ret) av_noreturn;
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 show_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  * Override the cpuflags mask.
76  */
77 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
78
79 /**
80  * Fallback for options that are not explicitly handled, these will be
81  * parsed through AVOptions.
82  */
83 int opt_default(void *optctx, const char *opt, const char *arg);
84
85 /**
86  * Set the libav* libraries log level.
87  */
88 int opt_loglevel(void *optctx, const char *opt, const char *arg);
89
90 /**
91  * Limit the execution time.
92  */
93 int opt_timelimit(void *optctx, 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,
109                            double min, double max);
110
111 /**
112  * Parse a string specifying a time and return its corresponding
113  * value as a number of microseconds. Exit from the application if
114  * the string cannot be correctly parsed.
115  *
116  * @param context the context of the value to be set (e.g. the
117  * corresponding command line option name)
118  * @param timestr the string to be parsed
119  * @param is_duration a flag which tells how to interpret timestr, if
120  * not zero timestr is interpreted as a duration, otherwise as a
121  * date
122  *
123  * @see parse_date()
124  */
125 int64_t parse_time_or_die(const char *context, const char *timestr,
126                           int is_duration);
127
128 typedef struct SpecifierOpt {
129     char *specifier;    /**< stream/chapter/program/... specifier */
130     union {
131         uint8_t *str;
132         int        i;
133         int64_t  i64;
134         float      f;
135         double   dbl;
136     } u;
137 } SpecifierOpt;
138
139 typedef struct OptionDef {
140     const char *name;
141     int flags;
142 #define HAS_ARG    0x0001
143 #define OPT_BOOL   0x0002
144 #define OPT_EXPERT 0x0004
145 #define OPT_STRING 0x0008
146 #define OPT_VIDEO  0x0010
147 #define OPT_AUDIO  0x0020
148 #define OPT_INT    0x0080
149 #define OPT_FLOAT  0x0100
150 #define OPT_SUBTITLE 0x0200
151 #define OPT_INT64  0x0400
152 #define OPT_EXIT   0x0800
153 #define OPT_DATA   0x1000
154 #define OPT_PERFILE  0x2000     /* the option is per-file (currently avconv-only).
155                                    implied by OPT_OFFSET or OPT_SPEC */
156 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
157 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
158                                    Implies OPT_OFFSET. Next element after the offset is
159                                    an int containing element count in the array. */
160 #define OPT_TIME  0x10000
161 #define OPT_DOUBLE 0x20000
162 #define OPT_INPUT  0x40000
163 #define OPT_OUTPUT 0x80000
164      union {
165         void *dst_ptr;
166         int (*func_arg)(void *, const char *, const char *);
167         size_t off;
168     } u;
169     const char *help;
170     const char *argname;
171 } OptionDef;
172
173 /**
174  * Print help for all options matching specified flags.
175  *
176  * @param options a list of options
177  * @param msg title of this group. Only printed if at least one option matches.
178  * @param req_flags print only options which have all those flags set.
179  * @param rej_flags don't print options which have any of those flags set.
180  * @param alt_flags print only options that have at least one of those flags set
181  */
182 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
183                        int rej_flags, int alt_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  * Per-avtool specific help handler. Implemented in each
193  * avtool, called by show_help().
194  */
195 void show_help_default(const char *opt, const char *arg);
196
197 /**
198  * Generic -h handler common to all avtools.
199  */
200 int show_help(void *optctx, const char *opt, const char *arg);
201
202 /**
203  * Parse the command line arguments.
204  *
205  * @param optctx an opaque options context
206  * @param argc   number of command line arguments
207  * @param argv   values of command line arguments
208  * @param options Array with the definitions required to interpret every
209  * option of the form: -option_name [argument]
210  * @param parse_arg_function Name of the function called to process every
211  * argument without a leading option name flag. NULL if such arguments do
212  * not have to be processed.
213  */
214 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
215                    void (* parse_arg_function)(void *optctx, const char*));
216
217 /**
218  * Parse one given option.
219  *
220  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
221  */
222 int parse_option(void *optctx, const char *opt, const char *arg,
223                  const OptionDef *options);
224
225 /**
226  * An option extracted from the commandline.
227  * Cannot use AVDictionary because of options like -map which can be
228  * used multiple times.
229  */
230 typedef struct Option {
231     const OptionDef  *opt;
232     const char       *key;
233     const char       *val;
234 } Option;
235
236 typedef struct OptionGroupDef {
237     /**< group name */
238     const char *name;
239     /**
240      * Option to be used as group separator. Can be NULL for groups which
241      * are terminated by a non-option argument (e.g. avconv output files)
242      */
243     const char *sep;
244     /**
245      * Option flags that must be set on each option that is
246      * applied to this group
247      */
248     int flags;
249 } OptionGroupDef;
250
251 typedef struct OptionGroup {
252     const OptionGroupDef *group_def;
253     const char *arg;
254
255     Option *opts;
256     int  nb_opts;
257
258     AVDictionary *codec_opts;
259     AVDictionary *format_opts;
260     AVDictionary *resample_opts;
261     struct SwsContext *sws_opts;
262 } OptionGroup;
263
264 /**
265  * A list of option groups that all have the same group type
266  * (e.g. input files or output files)
267  */
268 typedef struct OptionGroupList {
269     const OptionGroupDef *group_def;
270
271     OptionGroup *groups;
272     int       nb_groups;
273 } OptionGroupList;
274
275 typedef struct OptionParseContext {
276     OptionGroup global_opts;
277
278     OptionGroupList *groups;
279     int           nb_groups;
280
281     /* parsing state */
282     OptionGroup cur_group;
283 } OptionParseContext;
284
285 /**
286  * Parse an options group and write results into optctx.
287  *
288  * @param optctx an app-specific options context. NULL for global options group
289  */
290 int parse_optgroup(void *optctx, OptionGroup *g);
291
292 /**
293  * Split the commandline into an intermediate form convenient for further
294  * processing.
295  *
296  * The commandline is assumed to be composed of options which either belong to a
297  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
298  * (everything else).
299  *
300  * A group (defined by an OptionGroupDef struct) is a sequence of options
301  * terminated by either a group separator option (e.g. -i) or a parameter that
302  * is not an option (doesn't start with -). A group without a separator option
303  * must always be first in the supplied groups list.
304  *
305  * All options within the same group are stored in one OptionGroup struct in an
306  * OptionGroupList, all groups with the same group definition are stored in one
307  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
308  * same as the order of group definitions.
309  */
310 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
311                       const OptionDef *options,
312                       const OptionGroupDef *groups, int nb_groups);
313
314 /**
315  * Free all allocated memory in an OptionParseContext.
316  */
317 void uninit_parse_context(OptionParseContext *octx);
318
319 /**
320  * Find the '-loglevel' option in the command line args and apply it.
321  */
322 void parse_loglevel(int argc, char **argv, const OptionDef *options);
323
324 /**
325  * Return index of option opt in argv or 0 if not found.
326  */
327 int locate_option(int argc, char **argv, const OptionDef *options,
328                   const char *optname);
329
330 /**
331  * Check if the given stream matches a stream specifier.
332  *
333  * @param s  Corresponding format context.
334  * @param st Stream from s to be checked.
335  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
336  *
337  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
338  */
339 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
340
341 /**
342  * Filter out options for given codec.
343  *
344  * Create a new options dictionary containing only the options from
345  * opts which apply to the codec with ID codec_id.
346  *
347  * @param opts     dictionary to place options in
348  * @param codec_id ID of the codec that should be filtered for
349  * @param s Corresponding format context.
350  * @param st A stream from s for which the options should be filtered.
351  * @param codec The particular codec for which the options should be filtered.
352  *              If null, the default one is looked up according to the codec id.
353  * @return a pointer to the created dictionary
354  */
355 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
356                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
357
358 /**
359  * Setup AVCodecContext options for avformat_find_stream_info().
360  *
361  * Create an array of dictionaries, one dictionary for each stream
362  * contained in s.
363  * Each dictionary will contain the options from codec_opts which can
364  * be applied to the corresponding stream codec context.
365  *
366  * @return pointer to the created array of dictionaries, NULL if it
367  * cannot be created
368  */
369 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
370                                            AVDictionary *codec_opts);
371
372 /**
373  * Print an error message to stderr, indicating filename and a human
374  * readable description of the error code err.
375  *
376  * If strerror_r() is not available the use of this function in a
377  * multithreaded application may be unsafe.
378  *
379  * @see av_strerror()
380  */
381 void print_error(const char *filename, int err);
382
383 /**
384  * Print the program banner to stderr. The banner contents depend on the
385  * current version of the repository and of the libav* libraries used by
386  * the program.
387  */
388 void show_banner(void);
389
390 /**
391  * Print the version of the program to stdout. The version message
392  * depends on the current versions of the repository and of the libav*
393  * libraries.
394  */
395 int show_version(void *optctx, const char *opt, const char *arg);
396
397 /**
398  * Print the license of the program to stdout. The license depends on
399  * the license of the libraries compiled into the program.
400  */
401 int show_license(void *optctx, const char *opt, const char *arg);
402
403 /**
404  * Print a listing containing all the formats supported by the
405  * program.
406  */
407 int show_formats(void *optctx, const char *opt, const char *arg);
408
409 /**
410  * Print a listing containing all the codecs supported by the
411  * program.
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  */
431 int show_filters(void *optctx, const char *opt, const char *arg);
432
433 /**
434  * Print a listing containing all the bit stream filters supported by the
435  * program.
436  */
437 int show_bsfs(void *optctx, const char *opt, const char *arg);
438
439 /**
440  * Print a listing containing all the protocols supported by the
441  * program.
442  */
443 int show_protocols(void *optctx, const char *opt, const char *arg);
444
445 /**
446  * Print a listing containing all the pixel formats supported by the
447  * program.
448  */
449 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
450
451 /**
452  * Print a listing containing all the sample formats supported by the
453  * program.
454  */
455 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
456
457 /**
458  * Return a positive value if a line read from standard input
459  * starts with [yY], otherwise return 0.
460  */
461 int read_yesno(void);
462
463 typedef struct PtsCorrectionContext {
464     int64_t num_faulty_pts; /// Number of incorrect PTS values so far
465     int64_t num_faulty_dts; /// Number of incorrect DTS values so far
466     int64_t last_pts;       /// PTS of the last frame
467     int64_t last_dts;       /// DTS of the last frame
468 } PtsCorrectionContext;
469
470 /**
471  * Reset the state of the PtsCorrectionContext.
472  */
473 void init_pts_correction(PtsCorrectionContext *ctx);
474
475 /**
476  * Attempt to guess proper monotonic timestamps for decoded video frames
477  * which might have incorrect times. Input timestamps may wrap around, in
478  * which case the output will as well.
479  *
480  * @param ctx the PtsCorrectionContext carrying stream pts information
481  * @param pts the pts field of the decoded AVPacket, as passed through
482  * AVCodecContext.reordered_opaque
483  * @param dts the dts field of the decoded AVPacket
484  * @return one of the input values, may be AV_NOPTS_VALUE
485  */
486 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
487
488 /**
489  * Get a file corresponding to a preset file.
490  *
491  * If is_path is non-zero, look for the file in the path preset_name.
492  * Otherwise search for a file named arg.avpreset in the directories
493  * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
494  * at configuration time, in that order. If no such file is found and
495  * codec_name is defined, then search for a file named
496  * codec_name-preset_name.avpreset in the above-mentioned directories.
497  *
498  * @param filename buffer where the name of the found filename is written
499  * @param filename_size size in bytes of the filename buffer
500  * @param preset_name name of the preset to search
501  * @param is_path tell if preset_name is a filename path
502  * @param codec_name name of the codec for which to look for the
503  * preset, may be NULL
504  */
505 FILE *get_preset_file(char *filename, size_t filename_size,
506                       const char *preset_name, int is_path, const char *codec_name);
507
508 /**
509  * Realloc array to hold new_size elements of elem_size.
510  * Calls exit() on failure.
511  *
512  * @param array array to reallocate
513  * @param elem_size size in bytes of each element
514  * @param size new element count will be written here
515  * @param new_size number of elements to place in reallocated array
516  * @return reallocated array
517  */
518 void *grow_array(void *array, int elem_size, int *size, int new_size);
519
520 /**
521  * Get a string describing a media type.
522  */
523 const char *media_type_string(enum AVMediaType media_type);
524
525 #define GROW_ARRAY(array, nb_elems)\
526     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
527
528 #define GET_PIX_FMT_NAME(pix_fmt)\
529     const char *name = av_get_pix_fmt_name(pix_fmt);
530
531 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
532     const char *name = av_get_sample_fmt_name(sample_fmt)
533
534 #define GET_SAMPLE_RATE_NAME(rate)\
535     char name[16];\
536     snprintf(name, sizeof(name), "%d", rate);
537
538 #define GET_CH_LAYOUT_NAME(ch_layout)\
539     char name[16];\
540     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
541
542 #define GET_CH_LAYOUT_DESC(ch_layout)\
543     char name[128];\
544     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
545
546 #endif /* LIBAV_CMDUTILS_H */