cmdutils: store all codec options in one dict instead of video/audio/sub
[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
85663ef3 42extern const char **opt_names;
72415b2a 43extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
44extern AVFormatContext *avformat_opts;
45extern struct SwsContext *sws_opts;
8c8eab8b 46extern AVDictionary *format_opts, *codec_opts;
85663ef3
MN
47
48/**
a5c33faa
RD
49 * Initialize the cmdutils option system, in particular
50 * allocate the *_opts contexts.
51 */
52void init_opts(void);
53/**
54 * Uninitialize the cmdutils option system, in particular
55 * free the *_opts contexts and their contents.
56 */
57void uninit_opts(void);
58
59/**
1790d3b3
SS
60 * Trivial log callback.
61 * Only suitable for show_help and similar since it lacks prefix handling.
62 */
63void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
64
65/**
b7438896 66 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
67 * parsed through AVOptions.
68 */
69int opt_default(const char *opt, const char *arg);
70
ea9c581f 71/**
49bd8e4b 72 * Set the libav* libraries log level.
4c97a6fa
SS
73 */
74int opt_loglevel(const char *opt, const char *arg);
75
76/**
ffcc6e24
MR
77 * Limit the execution time.
78 */
79int opt_timelimit(const char *opt, const char *arg);
80
81/**
49bd8e4b
MR
82 * Parse a string and return its corresponding value as a double.
83 * Exit from the application if the string cannot be correctly
15067504 84 * parsed or the corresponding value is invalid.
60b5a745
SS
85 *
86 * @param context the context of the value to be set (e.g. the
87 * corresponding commandline option name)
88 * @param numstr the string to be parsed
89 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
90 * string should be parsed
15067504
DB
91 * @param min the minimum valid accepted value
92 * @param max the maximum valid accepted value
60b5a745
SS
93 */
94double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
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
102 * corresponding commandline option name)
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
SS
109 */
110int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
111
01310af2
FB
112typedef struct {
113 const char *name;
114 int flags;
115#define HAS_ARG 0x0001
116#define OPT_BOOL 0x0002
117#define OPT_EXPERT 0x0004
118#define OPT_STRING 0x0008
02d504a7
FB
119#define OPT_VIDEO 0x0010
120#define OPT_AUDIO 0x0020
121#define OPT_GRAB 0x0040
26d4f26b 122#define OPT_INT 0x0080
394c4d77 123#define OPT_FLOAT 0x0100
ae27975d 124#define OPT_SUBTITLE 0x0200
26513856
SS
125#define OPT_INT64 0x0400
126#define OPT_EXIT 0x0800
127#define OPT_DATA 0x1000
ae27975d 128 union {
01310af2
FB
129 int *int_arg;
130 char **str_arg;
1f631450 131 float *float_arg;
26513856 132 int (*func_arg)(const char *, const char *);
ffdf9a1f 133 int64_t *int64_arg;
01310af2
FB
134 } u;
135 const char *help;
136 const char *argname;
137} OptionDef;
138
02d504a7 139void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
140
141/**
49bd8e4b 142 * Parse the command line arguments.
60a9966e 143 * @param options Array with the definitions required to interpret every
0baf34d8 144 * option of the form: -option_name [argument]
60a9966e
SS
145 * @param parse_arg_function Name of the function called to process every
146 * argument without a leading option name flag. NULL if such arguments do
147 * not have to be processed.
148 */
149void parse_options(int argc, char **argv, const OptionDef *options,
150 void (* parse_arg_function)(const char*));
151
0093ebc2 152void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
85663ef3 153
8d787f8e 154/**
8c8eab8b
AK
155 * Filter out options for given codec.
156 */
157AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, int encoder);
158
159/**
49bd8e4b 160 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
161 * readable description of the error code err.
162 *
163 * If strerror_r() is not available the use of this function in a
164 * multithreaded application may be unsafe.
165 *
166 * @see av_strerror()
167 */
01310af2 168void print_error(const char *filename, int err);
c5dc6026 169
f35917b2 170/**
49bd8e4b 171 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
172 * current version of the repository and of the libav* libraries used by
173 * the program.
86074ed1 174 */
ea9c581f 175void show_banner(void);
86074ed1
SS
176
177/**
49bd8e4b 178 * Print the version of the program to stdout. The version message
86074ed1
SS
179 * depends on the current versions of the repository and of the libav*
180 * libraries.
86074ed1 181 */
64555bd9 182void show_version(void);
86074ed1
SS
183
184/**
49bd8e4b 185 * Print the license of the program to stdout. The license depends on
15067504 186 * the license of the libraries compiled into the program.
f35917b2
SS
187 */
188void show_license(void);
189
ba9880c1 190/**
49bd8e4b 191 * Print a listing containing all the formats supported by the
ba9880c1
SS
192 * program.
193 */
194void show_formats(void);
195
090b61b2 196/**
49bd8e4b 197 * Print a listing containing all the codecs supported by the
8447f0bd
MN
198 * program.
199 */
200void show_codecs(void);
201
202/**
49bd8e4b 203 * Print a listing containing all the filters supported by the
62d75662
SS
204 * program.
205 */
206void show_filters(void);
207
208/**
49bd8e4b 209 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
210 * program.
211 */
212void show_bsfs(void);
213
214/**
49bd8e4b 215 * Print a listing containing all the protocols supported by the
8447f0bd
MN
216 * program.
217 */
218void show_protocols(void);
219
220/**
49bd8e4b 221 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
222 * program.
223 */
224void show_pix_fmts(void);
225
226/**
48966b02
MR
227 * Return a positive value if a line read from standard input
228 * starts with [yY], otherwise return 0.
090b61b2
SS
229 */
230int read_yesno(void);
231
458b062d 232/**
49bd8e4b 233 * Read the file with name filename, and put its content in a newly
458b062d
SS
234 * allocated 0-terminated buffer.
235 *
49bd8e4b
MR
236 * @param bufptr location where pointer to buffer is returned
237 * @param size location where size of buffer is returned
458b062d
SS
238 * @return 0 in case of success, a negative value corresponding to an
239 * AVERROR error code in case of failure.
240 */
241int read_file(const char *filename, char **bufptr, size_t *size);
242
7a8bfa5d
AS
243typedef struct {
244 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
245 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
246 int64_t last_pts; /// PTS of the last frame
247 int64_t last_dts; /// DTS of the last frame
248} PtsCorrectionContext;
249
250/**
f03f30d7 251 * Reset the state of the PtsCorrectionContext.
7a8bfa5d
AS
252 */
253void init_pts_correction(PtsCorrectionContext *ctx);
254
255/**
f03f30d7 256 * Attempt to guess proper monotonic timestamps for decoded video frames
7a8bfa5d
AS
257 * which might have incorrect times. Input timestamps may wrap around, in
258 * which case the output will as well.
259 *
f03f30d7 260 * @param pts the pts field of the decoded AVPacket, as passed through
7a8bfa5d 261 * AVCodecContext.reordered_opaque
f03f30d7
SS
262 * @param dts the dts field of the decoded AVPacket
263 * @return one of the input values, may be AV_NOPTS_VALUE
7a8bfa5d
AS
264 */
265int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
266
6e872935
SS
267/**
268 * Get a file corresponding to a preset file.
269 *
270 * If is_path is non-zero, look for the file in the path preset_name.
271 * Otherwise search for a file named arg.ffpreset in the directories
272 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
273 * at configuration time, in that order. If no such file is found and
274 * codec_name is defined, then search for a file named
275 * codec_name-preset_name.ffpreset in the above-mentioned directories.
276 *
277 * @param filename buffer where the name of the found filename is written
278 * @param filename_size size in bytes of the filename buffer
279 * @param preset_name name of the preset to search
280 * @param is_path tell if preset_name is a filename path
281 * @param codec_name name of the codec for which to look for the
282 * preset, may be NULL
283 */
284FILE *get_preset_file(char *filename, size_t filename_size,
285 const char *preset_name, int is_path, const char *codec_name);
286
f7ead94c
SS
287typedef struct {
288 enum PixelFormat pix_fmt;
289} FFSinkContext;
290
291extern AVFilter ffsink;
292
ff0652e5
SS
293/**
294 * Extract a frame from sink.
295 *
296 * @return a negative error in case of failure, 1 if one frame has
297 * been extracted successfully.
298 */
299int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
300 AVFilterBufferRef **picref, AVRational *pts_tb);
301
153382e1 302#endif /* LIBAV_CMDUTILS_H */