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