cmdutils: change semantics of show_help_options() and document it.
[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/**
49bd8e4b 174 * Parse the command line arguments.
7cc8d638
AK
175 *
176 * @param optctx an opaque options context
60a9966e 177 * @param options Array with the definitions required to interpret every
0baf34d8 178 * option of the form: -option_name [argument]
60a9966e
SS
179 * @param parse_arg_function Name of the function called to process every
180 * argument without a leading option name flag. NULL if such arguments do
181 * not have to be processed.
182 */
7cc8d638
AK
183void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
184 void (* parse_arg_function)(void *optctx, const char*));
60a9966e 185
8d787f8e 186/**
2f8e586d
AK
187 * Parse one given option.
188 *
189 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
190 */
0184bbe2
GN
191int parse_option(void *optctx, const char *opt, const char *arg,
192 const OptionDef *options);
2f8e586d
AK
193
194/**
da9cea77 195 * Find the '-loglevel' option in the command line args and apply it.
182cbe43
AK
196 */
197void parse_loglevel(int argc, char **argv, const OptionDef *options);
198
199/**
4138cd29
AK
200 * Return index of option opt in argv or 0 if not found.
201 */
202int locate_option(int argc, char **argv, const OptionDef *options,
203 const char *optname);
204
205/**
d4863fc1
AK
206 * Check if the given stream matches a stream specifier.
207 *
208 * @param s Corresponding format context.
209 * @param st Stream from s to be checked.
e873c03a 210 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
d4863fc1
AK
211 *
212 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
213 */
214int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
215
216/**
8c8eab8b 217 * Filter out options for given codec.
ce23ca81
SS
218 *
219 * Create a new options dictionary containing only the options from
220 * opts which apply to the codec with ID codec_id.
221 *
d4863fc1
AK
222 * @param s Corresponding format context.
223 * @param st A stream from s for which the options should be filtered.
d3ed1c95
MS
224 * @param codec The particular codec for which the options should be filtered.
225 * If null, the default one is looked up according to the codec id.
ce23ca81 226 * @return a pointer to the created dictionary
8c8eab8b 227 */
36ef5369 228AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
d3ed1c95 229 AVFormatContext *s, AVStream *st, AVCodec *codec);
8c8eab8b 230
7cea06d1
SS
231/**
232 * Setup AVCodecContext options for avformat_find_stream_info().
233 *
234 * Create an array of dictionaries, one dictionary for each stream
235 * contained in s.
236 * Each dictionary will contain the options from codec_opts which can
237 * be applied to the corresponding stream codec context.
238 *
239 * @return pointer to the created array of dictionaries, NULL if it
240 * cannot be created
3009f521 241 */
0184bbe2
GN
242AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
243 AVDictionary *codec_opts);
3009f521 244
8c8eab8b 245/**
49bd8e4b 246 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
247 * readable description of the error code err.
248 *
249 * If strerror_r() is not available the use of this function in a
250 * multithreaded application may be unsafe.
251 *
252 * @see av_strerror()
253 */
01310af2 254void print_error(const char *filename, int err);
c5dc6026 255
f35917b2 256/**
49bd8e4b 257 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
258 * current version of the repository and of the libav* libraries used by
259 * the program.
86074ed1 260 */
ea9c581f 261void show_banner(void);
86074ed1
SS
262
263/**
49bd8e4b 264 * Print the version of the program to stdout. The version message
86074ed1
SS
265 * depends on the current versions of the repository and of the libav*
266 * libraries.
86074ed1 267 */
f617135b 268int show_version(const char *opt, const char *arg);
86074ed1
SS
269
270/**
49bd8e4b 271 * Print the license of the program to stdout. The license depends on
15067504 272 * the license of the libraries compiled into the program.
f35917b2 273 */
f617135b 274int show_license(const char *opt, const char *arg);
f35917b2 275
ba9880c1 276/**
49bd8e4b 277 * Print a listing containing all the formats supported by the
ba9880c1
SS
278 * program.
279 */
f617135b 280int show_formats(const char *opt, const char *arg);
ba9880c1 281
090b61b2 282/**
49bd8e4b 283 * Print a listing containing all the codecs supported by the
8447f0bd
MN
284 * program.
285 */
f617135b 286int show_codecs(const char *opt, const char *arg);
8447f0bd
MN
287
288/**
7c101949
AK
289 * Print a listing containing all the decoders supported by the
290 * program.
291 */
292int show_decoders(const char *opt, const char *arg);
293
294/**
295 * Print a listing containing all the encoders supported by the
296 * program.
297 */
298int show_encoders(const char *opt, const char *arg);
299
300/**
49bd8e4b 301 * Print a listing containing all the filters supported by the
62d75662
SS
302 * program.
303 */
f617135b 304int show_filters(const char *opt, const char *arg);
62d75662
SS
305
306/**
49bd8e4b 307 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
308 * program.
309 */
f617135b 310int show_bsfs(const char *opt, const char *arg);
8447f0bd
MN
311
312/**
49bd8e4b 313 * Print a listing containing all the protocols supported by the
8447f0bd
MN
314 * program.
315 */
f617135b 316int show_protocols(const char *opt, const char *arg);
8447f0bd
MN
317
318/**
49bd8e4b 319 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
320 * program.
321 */
f617135b 322int show_pix_fmts(const char *opt, const char *arg);
3f7bb426
SS
323
324/**
05bffc12
AK
325 * Print a listing containing all the sample formats supported by the
326 * program.
327 */
328int show_sample_fmts(const char *opt, const char *arg);
329
330/**
48966b02
MR
331 * Return a positive value if a line read from standard input
332 * starts with [yY], otherwise return 0.
090b61b2
SS
333 */
334int read_yesno(void);
335
458b062d 336/**
49bd8e4b 337 * Read the file with name filename, and put its content in a newly
458b062d
SS
338 * allocated 0-terminated buffer.
339 *
49bd8e4b
MR
340 * @param bufptr location where pointer to buffer is returned
341 * @param size location where size of buffer is returned
458b062d
SS
342 * @return 0 in case of success, a negative value corresponding to an
343 * AVERROR error code in case of failure.
344 */
02170990 345int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
458b062d 346
7a8bfa5d
AS
347typedef struct {
348 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
349 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
350 int64_t last_pts; /// PTS of the last frame
351 int64_t last_dts; /// DTS of the last frame
352} PtsCorrectionContext;
353
354/**
f03f30d7 355 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
356 */
357void init_pts_correction(PtsCorrectionContext *ctx);
358
359/**
f03f30d7 360 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
361 * which might have incorrect times. Input timestamps may wrap around, in
362 * which case the output will as well.
363 *
f03f30d7 364 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 365 * AVCodecContext.reordered_opaque
f03f30d7
SS
366 * @param dts the dts field of the decoded AVPacket
367 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
368 */
369int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
370
6e872935
SS
371/**
372 * Get a file corresponding to a preset file.
373 *
374 * If is_path is non-zero, look for the file in the path preset_name.
050dc127 375 * Otherwise search for a file named arg.avpreset in the directories
25c27f37 376 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined
6e872935
SS
377 * at configuration time, in that order. If no such file is found and
378 * codec_name is defined, then search for a file named
050dc127 379 * codec_name-preset_name.avpreset in the above-mentioned directories.
6e872935
SS
380 *
381 * @param filename buffer where the name of the found filename is written
382 * @param filename_size size in bytes of the filename buffer
383 * @param preset_name name of the preset to search
384 * @param is_path tell if preset_name is a filename path
385 * @param codec_name name of the codec for which to look for the
386 * preset, may be NULL
387 */
388FILE *get_preset_file(char *filename, size_t filename_size,
389 const char *preset_name, int is_path, const char *codec_name);
390
dad09ff9
AK
391/**
392 * Do all the necessary cleanup and abort.
393 * This function is implemented in the avtools, not cmdutils.
394 */
22662ca5 395av_noreturn void exit_program(int ret);
dad09ff9 396
cac651c8
AK
397/**
398 * Realloc array to hold new_size elements of elem_size.
399 * Calls exit_program() on failure.
400 *
401 * @param elem_size size in bytes of each element
402 * @param size new element count will be written here
403 * @return reallocated array
404 */
405void *grow_array(void *array, int elem_size, int *size, int new_size);
406
d55c2e05
AK
407typedef struct FrameBuffer {
408 uint8_t *base[4];
409 uint8_t *data[4];
410 int linesize[4];
411
412 int h, w;
413 enum PixelFormat pix_fmt;
414
415 int refcount;
416 struct FrameBuffer **pool; ///< head of the buffer pool
417 struct FrameBuffer *next;
418} FrameBuffer;
419
420/**
421 * Get a frame from the pool. This is intended to be used as a callback for
422 * AVCodecContext.get_buffer.
423 *
424 * @param s codec context. s->opaque must be a pointer to the head of the
425 * buffer pool.
426 * @param frame frame->opaque will be set to point to the FrameBuffer
427 * containing the frame data.
428 */
429int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
430
431/**
432 * A callback to be used for AVCodecContext.release_buffer along with
433 * codec_get_buffer().
434 */
435void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
436
437/**
438 * A callback to be used for AVFilterBuffer.free.
439 * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
440 * containing the buffer data.
441 */
442void filter_release_buffer(AVFilterBuffer *fb);
443
444/**
445 * Free all the buffers in the pool. This must be called after all the
446 * buffers have been released.
447 */
448void free_buffer_pool(FrameBuffer **pool);
153382e1 449#endif /* LIBAV_CMDUTILS_H */