cmdutils: extend -h to allow printing codec details.
[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(const char *opt, const char *arg);
69
70 /**
71  * Set the libav* libraries log level.
72  */
73 int opt_loglevel(const char *opt, const char *arg);
74
75 /**
76  * Limit the execution time.
77  */
78 int opt_timelimit(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 {
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_FUNC2  0x2000
140 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
141 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
142                                    Implies OPT_OFFSET. Next element after the offset is
143                                    an int containing element count in the array. */
144 #define OPT_TIME  0x10000
145 #define OPT_DOUBLE 0x20000
146      union {
147         void *dst_ptr;
148         int (*func_arg)(const char *, const char *);
149         int (*func2_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  */
164 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
165                        int rej_flags);
166
167 /**
168  * Show help for all options with given flags in class and all its
169  * children.
170  */
171 void show_help_children(const AVClass *class, int flags);
172
173 /**
174  * Per-avtool specific help handler. Implemented in each
175  * avtool, called by show_help().
176  */
177 void show_help_default(const char *opt, const char *arg);
178
179 /**
180  * Generic -h handler common to all avtools.
181  */
182 int show_help(const char *opt, const char *arg);
183
184 /**
185  * Parse the command line arguments.
186  *
187  * @param optctx an opaque options context
188  * @param options Array with the definitions required to interpret every
189  * option of the form: -option_name [argument]
190  * @param parse_arg_function Name of the function called to process every
191  * argument without a leading option name flag. NULL if such arguments do
192  * not have to be processed.
193  */
194 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
195                    void (* parse_arg_function)(void *optctx, const char*));
196
197 /**
198  * Parse one given option.
199  *
200  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
201  */
202 int parse_option(void *optctx, const char *opt, const char *arg,
203                  const OptionDef *options);
204
205 /**
206  * Find the '-loglevel' option in the command line args and apply it.
207  */
208 void parse_loglevel(int argc, char **argv, const OptionDef *options);
209
210 /**
211  * Return index of option opt in argv or 0 if not found.
212  */
213 int locate_option(int argc, char **argv, const OptionDef *options,
214                   const char *optname);
215
216 /**
217  * Check if the given stream matches a stream specifier.
218  *
219  * @param s  Corresponding format context.
220  * @param st Stream from s to be checked.
221  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
222  *
223  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
224  */
225 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
226
227 /**
228  * Filter out options for given codec.
229  *
230  * Create a new options dictionary containing only the options from
231  * opts which apply to the codec with ID codec_id.
232  *
233  * @param s Corresponding format context.
234  * @param st A stream from s for which the options should be filtered.
235  * @param codec The particular codec for which the options should be filtered.
236  *              If null, the default one is looked up according to the codec id.
237  * @return a pointer to the created dictionary
238  */
239 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
240                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
241
242 /**
243  * Setup AVCodecContext options for avformat_find_stream_info().
244  *
245  * Create an array of dictionaries, one dictionary for each stream
246  * contained in s.
247  * Each dictionary will contain the options from codec_opts which can
248  * be applied to the corresponding stream codec context.
249  *
250  * @return pointer to the created array of dictionaries, NULL if it
251  * cannot be created
252  */
253 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
254                                            AVDictionary *codec_opts);
255
256 /**
257  * Print an error message to stderr, indicating filename and a human
258  * readable description of the error code err.
259  *
260  * If strerror_r() is not available the use of this function in a
261  * multithreaded application may be unsafe.
262  *
263  * @see av_strerror()
264  */
265 void print_error(const char *filename, int err);
266
267 /**
268  * Print the program banner to stderr. The banner contents depend on the
269  * current version of the repository and of the libav* libraries used by
270  * the program.
271  */
272 void show_banner(void);
273
274 /**
275  * Print the version of the program to stdout. The version message
276  * depends on the current versions of the repository and of the libav*
277  * libraries.
278  */
279 int show_version(const char *opt, const char *arg);
280
281 /**
282  * Print the license of the program to stdout. The license depends on
283  * the license of the libraries compiled into the program.
284  */
285 int show_license(const char *opt, const char *arg);
286
287 /**
288  * Print a listing containing all the formats supported by the
289  * program.
290  */
291 int show_formats(const char *opt, const char *arg);
292
293 /**
294  * Print a listing containing all the codecs supported by the
295  * program.
296  */
297 int show_codecs(const char *opt, const char *arg);
298
299 /**
300  * Print a listing containing all the decoders supported by the
301  * program.
302  */
303 int show_decoders(const char *opt, const char *arg);
304
305 /**
306  * Print a listing containing all the encoders supported by the
307  * program.
308  */
309 int show_encoders(const char *opt, const char *arg);
310
311 /**
312  * Print a listing containing all the filters supported by the
313  * program.
314  */
315 int show_filters(const char *opt, const char *arg);
316
317 /**
318  * Print a listing containing all the bit stream filters supported by the
319  * program.
320  */
321 int show_bsfs(const char *opt, const char *arg);
322
323 /**
324  * Print a listing containing all the protocols supported by the
325  * program.
326  */
327 int show_protocols(const char *opt, const char *arg);
328
329 /**
330  * Print a listing containing all the pixel formats supported by the
331  * program.
332  */
333 int show_pix_fmts(const char *opt, const char *arg);
334
335 /**
336  * Print a listing containing all the sample formats supported by the
337  * program.
338  */
339 int show_sample_fmts(const char *opt, const char *arg);
340
341 /**
342  * Return a positive value if a line read from standard input
343  * starts with [yY], otherwise return 0.
344  */
345 int read_yesno(void);
346
347 /**
348  * Read the file with name filename, and put its content in a newly
349  * allocated 0-terminated buffer.
350  *
351  * @param bufptr location where pointer to buffer is returned
352  * @param size   location where size of buffer is returned
353  * @return 0 in case of success, a negative value corresponding to an
354  * AVERROR error code in case of failure.
355  */
356 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
357
358 typedef struct {
359     int64_t num_faulty_pts; /// Number of incorrect PTS values so far
360     int64_t num_faulty_dts; /// Number of incorrect DTS values so far
361     int64_t last_pts;       /// PTS of the last frame
362     int64_t last_dts;       /// DTS of the last frame
363 } PtsCorrectionContext;
364
365 /**
366  * Reset the state of the PtsCorrectionContext.
367  */
368 void init_pts_correction(PtsCorrectionContext *ctx);
369
370 /**
371  * Attempt to guess proper monotonic timestamps for decoded video frames
372  * which might have incorrect times. Input timestamps may wrap around, in
373  * which case the output will as well.
374  *
375  * @param pts the pts field of the decoded AVPacket, as passed through
376  * AVCodecContext.reordered_opaque
377  * @param dts the dts field of the decoded AVPacket
378  * @return one of the input values, may be AV_NOPTS_VALUE
379  */
380 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
381
382 /**
383  * Get a file corresponding to a preset file.
384  *
385  * If is_path is non-zero, look for the file in the path preset_name.
386  * Otherwise search for a file named arg.avpreset in the directories
387  * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
388  * at configuration time, in that order. If no such file is found and
389  * codec_name is defined, then search for a file named
390  * codec_name-preset_name.avpreset in the above-mentioned directories.
391  *
392  * @param filename buffer where the name of the found filename is written
393  * @param filename_size size in bytes of the filename buffer
394  * @param preset_name name of the preset to search
395  * @param is_path tell if preset_name is a filename path
396  * @param codec_name name of the codec for which to look for the
397  * preset, may be NULL
398  */
399 FILE *get_preset_file(char *filename, size_t filename_size,
400                       const char *preset_name, int is_path, const char *codec_name);
401
402 /**
403  * Do all the necessary cleanup and abort.
404  * This function is implemented in the avtools, not cmdutils.
405  */
406 av_noreturn void exit_program(int ret);
407
408 /**
409  * Realloc array to hold new_size elements of elem_size.
410  * Calls exit_program() on failure.
411  *
412  * @param elem_size size in bytes of each element
413  * @param size new element count will be written here
414  * @return reallocated array
415  */
416 void *grow_array(void *array, int elem_size, int *size, int new_size);
417
418 typedef struct FrameBuffer {
419     uint8_t *base[4];
420     uint8_t *data[4];
421     int  linesize[4];
422
423     int h, w;
424     enum PixelFormat pix_fmt;
425
426     int refcount;
427     struct FrameBuffer **pool;  ///< head of the buffer pool
428     struct FrameBuffer *next;
429 } FrameBuffer;
430
431 /**
432  * Get a frame from the pool. This is intended to be used as a callback for
433  * AVCodecContext.get_buffer.
434  *
435  * @param s codec context. s->opaque must be a pointer to the head of the
436  *          buffer pool.
437  * @param frame frame->opaque will be set to point to the FrameBuffer
438  *              containing the frame data.
439  */
440 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
441
442 /**
443  * A callback to be used for AVCodecContext.release_buffer along with
444  * codec_get_buffer().
445  */
446 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
447
448 /**
449  * A callback to be used for AVFilterBuffer.free.
450  * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
451  *           containing the buffer data.
452  */
453 void filter_release_buffer(AVFilterBuffer *fb);
454
455 /**
456  * Free all the buffers in the pool. This must be called after all the
457  * buffers have been released.
458  */
459 void free_buffer_pool(FrameBuffer **pool);
460
461 #define GET_PIX_FMT_NAME(pix_fmt)\
462     const char *name = av_get_pix_fmt_name(pix_fmt);
463
464 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
465     const char *name = av_get_sample_fmt_name(sample_fmt)
466
467 #define GET_SAMPLE_RATE_NAME(rate)\
468     char name[16];\
469     snprintf(name, sizeof(name), "%d", rate);
470
471 #define GET_CH_LAYOUT_NAME(ch_layout)\
472     char name[16];\
473     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
474
475 #define GET_CH_LAYOUT_DESC(ch_layout)\
476     char name[128];\
477     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
478
479 #endif /* LIBAV_CMDUTILS_H */