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