Commit | Line | Data |
---|---|---|
f5a90186 DB |
1 | /* |
2 | * Various utilities for command line tools | |
3 | * copyright (c) 2003 Fabrice Bellard | |
4 | * | |
5 | * This file is part of FFmpeg. | |
6 | * | |
7 | * FFmpeg is free software; you can redistribute it and/or | |
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 | * | |
12 | * FFmpeg is distributed in the hope that it will be useful, | |
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 | |
18 | * License along with FFmpeg; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | */ | |
21 | ||
5b21bdab DB |
22 | #ifndef FFMPEG_CMDUTILS_H |
23 | #define FFMPEG_CMDUTILS_H | |
01310af2 | 24 | |
f0a838e5 | 25 | #include <inttypes.h> |
95137bbb DB |
26 | #include "libavcodec/avcodec.h" |
27 | #include "libavformat/avformat.h" | |
28 | #include "libswscale/swscale.h" | |
f0a838e5 | 29 | |
60b5a745 | 30 | /** |
64555bd9 MN |
31 | * program name, defined by the program for show_version(). |
32 | */ | |
33 | extern const char program_name[]; | |
34 | ||
35 | /** | |
ea9c581f SS |
36 | * program birth year, defined by the program for show_banner() |
37 | */ | |
38 | extern const int program_birth_year; | |
39 | ||
ef4c0bb1 SS |
40 | extern const int this_year; |
41 | ||
85663ef3 | 42 | extern const char **opt_names; |
72415b2a | 43 | extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB]; |
85663ef3 MN |
44 | extern AVFormatContext *avformat_opts; |
45 | extern struct SwsContext *sws_opts; | |
46 | ||
47 | /** | |
a5c33faa RD |
48 | * Initialize the cmdutils option system, in particular |
49 | * allocate the *_opts contexts. | |
50 | */ | |
51 | void init_opts(void); | |
52 | /** | |
53 | * Uninitialize the cmdutils option system, in particular | |
54 | * free the *_opts contexts and their contents. | |
55 | */ | |
56 | void 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 | */ | |
62 | void 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 | */ | |
68 | int opt_default(const char *opt, const char *arg); | |
69 | ||
ea9c581f | 70 | /** |
49bd8e4b | 71 | * Set the libav* libraries log level. |
4c97a6fa SS |
72 | */ |
73 | int opt_loglevel(const char *opt, const char *arg); | |
74 | ||
75 | /** | |
ffcc6e24 MR |
76 | * Limit the execution time. |
77 | */ | |
78 | int 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 | |
86 | * corresponding commandline option name) | |
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 SS |
92 | */ |
93 | double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max); | |
94 | ||
7542157d | 95 | /** |
49bd8e4b MR |
96 | * Parse a string specifying a time and return its corresponding |
97 | * value as a number of microseconds. Exit from the application if | |
7542157d SS |
98 | * the string cannot be correctly parsed. |
99 | * | |
100 | * @param context the context of the value to be set (e.g. the | |
101 | * corresponding commandline option name) | |
102 | * @param timestr the string to be parsed | |
bf7e799c SS |
103 | * @param is_duration a flag which tells how to interpret timestr, if |
104 | * not zero timestr is interpreted as a duration, otherwise as a | |
7542157d SS |
105 | * date |
106 | * | |
748061de | 107 | * @see parse_date() |
7542157d SS |
108 | */ |
109 | int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration); | |
110 | ||
01310af2 FB |
111 | typedef struct { |
112 | const char *name; | |
113 | int flags; | |
114 | #define HAS_ARG 0x0001 | |
115 | #define OPT_BOOL 0x0002 | |
116 | #define OPT_EXPERT 0x0004 | |
117 | #define OPT_STRING 0x0008 | |
02d504a7 FB |
118 | #define OPT_VIDEO 0x0010 |
119 | #define OPT_AUDIO 0x0020 | |
120 | #define OPT_GRAB 0x0040 | |
26d4f26b | 121 | #define OPT_INT 0x0080 |
394c4d77 | 122 | #define OPT_FLOAT 0x0100 |
ae27975d | 123 | #define OPT_SUBTITLE 0x0200 |
8bbf6db9 | 124 | #define OPT_FUNC2 0x0400 |
ffdf9a1f | 125 | #define OPT_INT64 0x0800 |
a0b3bcd9 | 126 | #define OPT_EXIT 0x1000 |
ae27975d | 127 | union { |
8bbf6db9 | 128 | void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func |
01310af2 FB |
129 | int *int_arg; |
130 | char **str_arg; | |
1f631450 | 131 | float *float_arg; |
8bbf6db9 | 132 | int (*func2_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 | 139 | void 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 | */ | |
149 | void parse_options(int argc, char **argv, const OptionDef *options, | |
150 | void (* parse_arg_function)(const char*)); | |
151 | ||
0093ebc2 | 152 | void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec); |
85663ef3 | 153 | |
8d787f8e | 154 | /** |
49bd8e4b | 155 | * Print an error message to stderr, indicating filename and a human |
8d787f8e SS |
156 | * readable description of the error code err. |
157 | * | |
158 | * If strerror_r() is not available the use of this function in a | |
159 | * multithreaded application may be unsafe. | |
160 | * | |
161 | * @see av_strerror() | |
162 | */ | |
01310af2 FB |
163 | void print_error(const char *filename, int err); |
164 | ||
c5dc6026 SS |
165 | void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts); |
166 | ||
f35917b2 | 167 | /** |
49bd8e4b | 168 | * Print the program banner to stderr. The banner contents depend on the |
15067504 DB |
169 | * current version of the repository and of the libav* libraries used by |
170 | * the program. | |
86074ed1 | 171 | */ |
ea9c581f | 172 | void show_banner(void); |
86074ed1 SS |
173 | |
174 | /** | |
49bd8e4b | 175 | * Print the version of the program to stdout. The version message |
86074ed1 SS |
176 | * depends on the current versions of the repository and of the libav* |
177 | * libraries. | |
86074ed1 | 178 | */ |
64555bd9 | 179 | void show_version(void); |
86074ed1 SS |
180 | |
181 | /** | |
49bd8e4b | 182 | * Print the license of the program to stdout. The license depends on |
15067504 | 183 | * the license of the libraries compiled into the program. |
f35917b2 SS |
184 | */ |
185 | void show_license(void); | |
186 | ||
ba9880c1 | 187 | /** |
49bd8e4b | 188 | * Print a listing containing all the formats supported by the |
ba9880c1 SS |
189 | * program. |
190 | */ | |
191 | void show_formats(void); | |
192 | ||
090b61b2 | 193 | /** |
49bd8e4b | 194 | * Print a listing containing all the codecs supported by the |
8447f0bd MN |
195 | * program. |
196 | */ | |
197 | void show_codecs(void); | |
198 | ||
199 | /** | |
49bd8e4b | 200 | * Print a listing containing all the filters supported by the |
62d75662 SS |
201 | * program. |
202 | */ | |
203 | void show_filters(void); | |
204 | ||
205 | /** | |
49bd8e4b | 206 | * Print a listing containing all the bit stream filters supported by the |
8447f0bd MN |
207 | * program. |
208 | */ | |
209 | void show_bsfs(void); | |
210 | ||
211 | /** | |
49bd8e4b | 212 | * Print a listing containing all the protocols supported by the |
8447f0bd MN |
213 | * program. |
214 | */ | |
215 | void show_protocols(void); | |
216 | ||
217 | /** | |
49bd8e4b | 218 | * Print a listing containing all the pixel formats supported by the |
3f7bb426 SS |
219 | * program. |
220 | */ | |
221 | void show_pix_fmts(void); | |
222 | ||
223 | /** | |
48966b02 MR |
224 | * Return a positive value if a line read from standard input |
225 | * starts with [yY], otherwise return 0. | |
090b61b2 SS |
226 | */ |
227 | int read_yesno(void); | |
228 | ||
458b062d | 229 | /** |
49bd8e4b | 230 | * Read the file with name filename, and put its content in a newly |
458b062d SS |
231 | * allocated 0-terminated buffer. |
232 | * | |
49bd8e4b MR |
233 | * @param bufptr location where pointer to buffer is returned |
234 | * @param size location where size of buffer is returned | |
458b062d SS |
235 | * @return 0 in case of success, a negative value corresponding to an |
236 | * AVERROR error code in case of failure. | |
237 | */ | |
238 | int read_file(const char *filename, char **bufptr, size_t *size); | |
239 | ||
7a8bfa5d AS |
240 | typedef struct { |
241 | int64_t num_faulty_pts; /// Number of incorrect PTS values so far | |
242 | int64_t num_faulty_dts; /// Number of incorrect DTS values so far | |
243 | int64_t last_pts; /// PTS of the last frame | |
244 | int64_t last_dts; /// DTS of the last frame | |
245 | } PtsCorrectionContext; | |
246 | ||
247 | /** | |
f03f30d7 | 248 | * Reset the state of the PtsCorrectionContext. |
7a8bfa5d AS |
249 | */ |
250 | void init_pts_correction(PtsCorrectionContext *ctx); | |
251 | ||
252 | /** | |
f03f30d7 | 253 | * Attempt to guess proper monotonic timestamps for decoded video frames |
7a8bfa5d AS |
254 | * which might have incorrect times. Input timestamps may wrap around, in |
255 | * which case the output will as well. | |
256 | * | |
f03f30d7 | 257 | * @param pts the pts field of the decoded AVPacket, as passed through |
7a8bfa5d | 258 | * AVCodecContext.reordered_opaque |
f03f30d7 SS |
259 | * @param dts the dts field of the decoded AVPacket |
260 | * @return one of the input values, may be AV_NOPTS_VALUE | |
7a8bfa5d AS |
261 | */ |
262 | int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts); | |
263 | ||
f7ead94c SS |
264 | #if CONFIG_AVFILTER |
265 | #include "libavfilter/avfilter.h" | |
266 | ||
267 | typedef struct { | |
268 | enum PixelFormat pix_fmt; | |
269 | } FFSinkContext; | |
270 | ||
271 | extern AVFilter ffsink; | |
272 | ||
273 | #endif /* CONFIG_AVFILTER */ | |
274 | ||
5b21bdab | 275 | #endif /* FFMPEG_CMDUTILS_H */ |