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