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