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