cmdutils: extend -h to allow printing codec details.
[libav.git] / cmdutils.h
CommitLineData
f5a90186
DB
1/*
2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
4 *
2912e87a 5 * This file is part of Libav.
f5a90186 6 *
2912e87a 7 * Libav is free software; you can redistribute it and/or
f5a90186
DB
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 *
2912e87a 12 * Libav is distributed in the hope that it will be useful,
f5a90186
DB
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
2912e87a 18 * License along with Libav; if not, write to the Free Software
f5a90186
DB
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
153382e1
DB
22#ifndef LIBAV_CMDUTILS_H
23#define LIBAV_CMDUTILS_H
01310af2 24
ea91e771
DB
25#include <stdint.h>
26
95137bbb 27#include "libavcodec/avcodec.h"
ea91e771 28#include "libavfilter/avfilter.h"
95137bbb
DB
29#include "libavformat/avformat.h"
30#include "libswscale/swscale.h"
f0a838e5 31
60b5a745 32/**
64555bd9
MN
33 * program name, defined by the program for show_version().
34 */
35extern const char program_name[];
36
37/**
ea9c581f
SS
38 * program birth year, defined by the program for show_banner()
39 */
40extern const int program_birth_year;
41
72415b2a 42extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
43extern AVFormatContext *avformat_opts;
44extern struct SwsContext *sws_opts;
8c8eab8b 45extern AVDictionary *format_opts, *codec_opts;
85663ef3
MN
46
47/**
a5c33faa
RD
48 * Initialize the cmdutils option system, in particular
49 * allocate the *_opts contexts.
50 */
51void init_opts(void);
52/**
53 * Uninitialize the cmdutils option system, in particular
54 * free the *_opts contexts and their contents.
55 */
56void uninit_opts(void);
57
58/**
1790d3b3
SS
59 * Trivial log callback.
60 * Only suitable for show_help and similar since it lacks prefix handling.
61 */
62void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
63
64/**
b7438896 65 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
66 * parsed through AVOptions.
67 */
68int opt_default(const char *opt, const char *arg);
69
ea9c581f 70/**
49bd8e4b 71 * Set the libav* libraries log level.
4c97a6fa
SS
72 */
73int opt_loglevel(const char *opt, const char *arg);
74
75/**
ffcc6e24
MR
76 * Limit the execution time.
77 */
78int opt_timelimit(const char *opt, const char *arg);
79
80/**
49bd8e4b
MR
81 * Parse a string and return its corresponding value as a double.
82 * Exit from the application if the string cannot be correctly
15067504 83 * parsed or the corresponding value is invalid.
60b5a745
SS
84 *
85 * @param context the context of the value to be set (e.g. the
da9cea77 86 * corresponding command line option name)
60b5a745
SS
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
15067504
DB
90 * @param min the minimum valid accepted value
91 * @param max the maximum valid accepted value
60b5a745 92 */
0184bbe2
GN
93double parse_number_or_die(const char *context, const char *numstr, int type,
94 double min, double max);
60b5a745 95
7542157d 96/**
49bd8e4b
MR
97 * Parse a string specifying a time and return its corresponding
98 * value as a number of microseconds. Exit from the application if
7542157d
SS
99 * the string cannot be correctly parsed.
100 *
101 * @param context the context of the value to be set (e.g. the
da9cea77 102 * corresponding command line option name)
7542157d 103 * @param timestr the string to be parsed
bf7e799c
SS
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
7542157d
SS
106 * date
107 *
748061de 108 * @see parse_date()
7542157d 109 */
0184bbe2
GN
110int64_t parse_time_or_die(const char *context, const char *timestr,
111 int is_duration);
7542157d 112
6361c5e1
AK
113typedef 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;
33f75d72 120 double dbl;
6361c5e1
AK
121 } u;
122} SpecifierOpt;
123
01310af2
FB
124typedef 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
02d504a7
FB
131#define OPT_VIDEO 0x0010
132#define OPT_AUDIO 0x0020
26d4f26b 133#define OPT_INT 0x0080
394c4d77 134#define OPT_FLOAT 0x0100
ae27975d 135#define OPT_SUBTITLE 0x0200
26513856
SS
136#define OPT_INT64 0x0400
137#define OPT_EXIT 0x0800
138#define OPT_DATA 0x1000
7cc8d638
AK
139#define OPT_FUNC2 0x2000
140#define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
6361c5e1
AK
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. */
6b779ccc 144#define OPT_TIME 0x10000
33f75d72 145#define OPT_DOUBLE 0x20000
ae27975d 146 union {
7efe05ab 147 void *dst_ptr;
26513856 148 int (*func_arg)(const char *, const char *);
7cc8d638
AK
149 int (*func2_arg)(void *, const char *, const char *);
150 size_t off;
01310af2
FB
151 } u;
152 const char *help;
153 const char *argname;
154} OptionDef;
155
7c501212
AK
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 */
164void show_help_options(const OptionDef *options, const char *msg, int req_flags,
165 int rej_flags);
60a9966e
SS
166
167/**
7a6cd995
AK
168 * Show help for all options with given flags in class and all its
169 * children.
170 */
171void show_help_children(const AVClass *class, int flags);
172
173/**
a3ad68d3
AK
174 * Per-avtool specific help handler. Implemented in each
175 * avtool, called by show_help().
176 */
177void show_help_default(const char *opt, const char *arg);
178
179/**
180 * Generic -h handler common to all avtools.
181 */
182int show_help(const char *opt, const char *arg);
183
184/**
49bd8e4b 185 * Parse the command line arguments.
7cc8d638
AK
186 *
187 * @param optctx an opaque options context
60a9966e 188 * @param options Array with the definitions required to interpret every
0baf34d8 189 * option of the form: -option_name [argument]
60a9966e
SS
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 */
7cc8d638
AK
194void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
195 void (* parse_arg_function)(void *optctx, const char*));
60a9966e 196
8d787f8e 197/**
2f8e586d
AK
198 * Parse one given option.
199 *
200 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
201 */
0184bbe2
GN
202int parse_option(void *optctx, const char *opt, const char *arg,
203 const OptionDef *options);
2f8e586d
AK
204
205/**
da9cea77 206 * Find the '-loglevel' option in the command line args and apply it.
182cbe43
AK
207 */
208void parse_loglevel(int argc, char **argv, const OptionDef *options);
209
210/**
4138cd29
AK
211 * Return index of option opt in argv or 0 if not found.
212 */
213int locate_option(int argc, char **argv, const OptionDef *options,
214 const char *optname);
215
216/**
d4863fc1
AK
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.
e873c03a 221 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
d4863fc1
AK
222 *
223 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
224 */
225int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
226
227/**
8c8eab8b 228 * Filter out options for given codec.
ce23ca81
SS
229 *
230 * Create a new options dictionary containing only the options from
231 * opts which apply to the codec with ID codec_id.
232 *
d4863fc1
AK
233 * @param s Corresponding format context.
234 * @param st A stream from s for which the options should be filtered.
d3ed1c95
MS
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.
ce23ca81 237 * @return a pointer to the created dictionary
8c8eab8b 238 */
36ef5369 239AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
d3ed1c95 240 AVFormatContext *s, AVStream *st, AVCodec *codec);
8c8eab8b 241
7cea06d1
SS
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
3009f521 252 */
0184bbe2
GN
253AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
254 AVDictionary *codec_opts);
3009f521 255
8c8eab8b 256/**
49bd8e4b 257 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
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 */
01310af2 265void print_error(const char *filename, int err);
c5dc6026 266
f35917b2 267/**
49bd8e4b 268 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
269 * current version of the repository and of the libav* libraries used by
270 * the program.
86074ed1 271 */
ea9c581f 272void show_banner(void);
86074ed1
SS
273
274/**
49bd8e4b 275 * Print the version of the program to stdout. The version message
86074ed1
SS
276 * depends on the current versions of the repository and of the libav*
277 * libraries.
86074ed1 278 */
f617135b 279int show_version(const char *opt, const char *arg);
86074ed1
SS
280
281/**
49bd8e4b 282 * Print the license of the program to stdout. The license depends on
15067504 283 * the license of the libraries compiled into the program.
f35917b2 284 */
f617135b 285int show_license(const char *opt, const char *arg);
f35917b2 286
ba9880c1 287/**
49bd8e4b 288 * Print a listing containing all the formats supported by the
ba9880c1
SS
289 * program.
290 */
f617135b 291int show_formats(const char *opt, const char *arg);
ba9880c1 292
090b61b2 293/**
49bd8e4b 294 * Print a listing containing all the codecs supported by the
8447f0bd
MN
295 * program.
296 */
f617135b 297int show_codecs(const char *opt, const char *arg);
8447f0bd
MN
298
299/**
7c101949
AK
300 * Print a listing containing all the decoders supported by the
301 * program.
302 */
303int show_decoders(const char *opt, const char *arg);
304
305/**
306 * Print a listing containing all the encoders supported by the
307 * program.
308 */
309int show_encoders(const char *opt, const char *arg);
310
311/**
49bd8e4b 312 * Print a listing containing all the filters supported by the
62d75662
SS
313 * program.
314 */
f617135b 315int show_filters(const char *opt, const char *arg);
62d75662
SS
316
317/**
49bd8e4b 318 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
319 * program.
320 */
f617135b 321int show_bsfs(const char *opt, const char *arg);
8447f0bd
MN
322
323/**
49bd8e4b 324 * Print a listing containing all the protocols supported by the
8447f0bd
MN
325 * program.
326 */
f617135b 327int show_protocols(const char *opt, const char *arg);
8447f0bd
MN
328
329/**
49bd8e4b 330 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
331 * program.
332 */
f617135b 333int show_pix_fmts(const char *opt, const char *arg);
3f7bb426
SS
334
335/**
05bffc12
AK
336 * Print a listing containing all the sample formats supported by the
337 * program.
338 */
339int show_sample_fmts(const char *opt, const char *arg);
340
341/**
48966b02
MR
342 * Return a positive value if a line read from standard input
343 * starts with [yY], otherwise return 0.
090b61b2
SS
344 */
345int read_yesno(void);
346
458b062d 347/**
49bd8e4b 348 * Read the file with name filename, and put its content in a newly
458b062d
SS
349 * allocated 0-terminated buffer.
350 *
49bd8e4b
MR
351 * @param bufptr location where pointer to buffer is returned
352 * @param size location where size of buffer is returned
458b062d
SS
353 * @return 0 in case of success, a negative value corresponding to an
354 * AVERROR error code in case of failure.
355 */
02170990 356int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
458b062d 357
7a8bfa5d
AS
358typedef 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/**
f03f30d7 366 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
367 */
368void init_pts_correction(PtsCorrectionContext *ctx);
369
370/**
f03f30d7 371 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
372 * which might have incorrect times. Input timestamps may wrap around, in
373 * which case the output will as well.
374 *
f03f30d7 375 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 376 * AVCodecContext.reordered_opaque
f03f30d7
SS
377 * @param dts the dts field of the decoded AVPacket
378 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
379 */
380int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
381
6e872935
SS
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.
050dc127 386 * Otherwise search for a file named arg.avpreset in the directories
25c27f37 387 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
6e872935
SS
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
050dc127 390 * codec_name-preset_name.avpreset in the above-mentioned directories.
6e872935
SS
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 */
399FILE *get_preset_file(char *filename, size_t filename_size,
400 const char *preset_name, int is_path, const char *codec_name);
401
dad09ff9
AK
402/**
403 * Do all the necessary cleanup and abort.
404 * This function is implemented in the avtools, not cmdutils.
405 */
22662ca5 406av_noreturn void exit_program(int ret);
dad09ff9 407
cac651c8
AK
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 */
416void *grow_array(void *array, int elem_size, int *size, int new_size);
417
d55c2e05
AK
418typedef 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 */
440int 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 */
446void 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 */
453void 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 */
459void free_buffer_pool(FrameBuffer **pool);
a3ad68d3
AK
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
153382e1 479#endif /* LIBAV_CMDUTILS_H */