cmdutils: remove OPT_FUNC2
[libav.git] / cmdutils.h
1 /*
2 * Various utilities for command line tools
3 * copyright (c) 2003 Fabrice Bellard
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #ifndef LIBAV_CMDUTILS_H
23 #define LIBAV_CMDUTILS_H
24
25 #include <stdint.h>
26
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
31
32 /**
33 * program name, defined by the program for show_version().
34 */
35 extern const char program_name[];
36
37 /**
38 * program birth year, defined by the program for show_banner()
39 */
40 extern const int program_birth_year;
41
42 extern const char **opt_names;
43 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
44 extern AVFormatContext *avformat_opts;
45 extern struct SwsContext *sws_opts;
46
47 /**
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 /**
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 /**
65 * Fallback for options that are not explicitly handled, these will be
66 * parsed through AVOptions.
67 */
68 int opt_default(const char *opt, const char *arg);
69
70 /**
71 * Set the libav* libraries log level.
72 */
73 int opt_loglevel(const char *opt, const char *arg);
74
75 /**
76 * Limit the execution time.
77 */
78 int opt_timelimit(const char *opt, const char *arg);
79
80 /**
81 * Parse a string and return its corresponding value as a double.
82 * Exit from the application if the string cannot be correctly
83 * parsed or the corresponding value is invalid.
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
90 * @param min the minimum valid accepted value
91 * @param max the maximum valid accepted value
92 */
93 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
94
95 /**
96 * Parse a string specifying a time and return its corresponding
97 * value as a number of microseconds. Exit from the application if
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
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
105 * date
106 *
107 * @see parse_date()
108 */
109 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
110
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
118 #define OPT_VIDEO 0x0010
119 #define OPT_AUDIO 0x0020
120 #define OPT_GRAB 0x0040
121 #define OPT_INT 0x0080
122 #define OPT_FLOAT 0x0100
123 #define OPT_SUBTITLE 0x0200
124 #define OPT_INT64 0x0400
125 #define OPT_EXIT 0x0800
126 #define OPT_DATA 0x1000
127 union {
128 int *int_arg;
129 char **str_arg;
130 float *float_arg;
131 int (*func_arg)(const char *, const char *);
132 int64_t *int64_arg;
133 } u;
134 const char *help;
135 const char *argname;
136 } OptionDef;
137
138 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
139
140 /**
141 * Parse the command line arguments.
142 * @param options Array with the definitions required to interpret every
143 * option of the form: -option_name [argument]
144 * @param parse_arg_function Name of the function called to process every
145 * argument without a leading option name flag. NULL if such arguments do
146 * not have to be processed.
147 */
148 void parse_options(int argc, char **argv, const OptionDef *options,
149 void (* parse_arg_function)(const char*));
150
151 void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
152
153 /**
154 * Print an error message to stderr, indicating filename and a human
155 * readable description of the error code err.
156 *
157 * If strerror_r() is not available the use of this function in a
158 * multithreaded application may be unsafe.
159 *
160 * @see av_strerror()
161 */
162 void print_error(const char *filename, int err);
163
164 /**
165 * Print the program banner to stderr. The banner contents depend on the
166 * current version of the repository and of the libav* libraries used by
167 * the program.
168 */
169 void show_banner(void);
170
171 /**
172 * Print the version of the program to stdout. The version message
173 * depends on the current versions of the repository and of the libav*
174 * libraries.
175 */
176 void show_version(void);
177
178 /**
179 * Print the license of the program to stdout. The license depends on
180 * the license of the libraries compiled into the program.
181 */
182 void show_license(void);
183
184 /**
185 * Print a listing containing all the formats supported by the
186 * program.
187 */
188 void show_formats(void);
189
190 /**
191 * Print a listing containing all the codecs supported by the
192 * program.
193 */
194 void show_codecs(void);
195
196 /**
197 * Print a listing containing all the filters supported by the
198 * program.
199 */
200 void show_filters(void);
201
202 /**
203 * Print a listing containing all the bit stream filters supported by the
204 * program.
205 */
206 void show_bsfs(void);
207
208 /**
209 * Print a listing containing all the protocols supported by the
210 * program.
211 */
212 void show_protocols(void);
213
214 /**
215 * Print a listing containing all the pixel formats supported by the
216 * program.
217 */
218 void show_pix_fmts(void);
219
220 /**
221 * Return a positive value if a line read from standard input
222 * starts with [yY], otherwise return 0.
223 */
224 int read_yesno(void);
225
226 /**
227 * Read the file with name filename, and put its content in a newly
228 * allocated 0-terminated buffer.
229 *
230 * @param bufptr location where pointer to buffer is returned
231 * @param size location where size of buffer is returned
232 * @return 0 in case of success, a negative value corresponding to an
233 * AVERROR error code in case of failure.
234 */
235 int read_file(const char *filename, char **bufptr, size_t *size);
236
237 typedef struct {
238 int64_t num_faulty_pts; /// Number of incorrect PTS values so far
239 int64_t num_faulty_dts; /// Number of incorrect DTS values so far
240 int64_t last_pts; /// PTS of the last frame
241 int64_t last_dts; /// DTS of the last frame
242 } PtsCorrectionContext;
243
244 /**
245 * Reset the state of the PtsCorrectionContext.
246 */
247 void init_pts_correction(PtsCorrectionContext *ctx);
248
249 /**
250 * Attempt to guess proper monotonic timestamps for decoded video frames
251 * which might have incorrect times. Input timestamps may wrap around, in
252 * which case the output will as well.
253 *
254 * @param pts the pts field of the decoded AVPacket, as passed through
255 * AVCodecContext.reordered_opaque
256 * @param dts the dts field of the decoded AVPacket
257 * @return one of the input values, may be AV_NOPTS_VALUE
258 */
259 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
260
261 /**
262 * Get a file corresponding to a preset file.
263 *
264 * If is_path is non-zero, look for the file in the path preset_name.
265 * Otherwise search for a file named arg.ffpreset in the directories
266 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
267 * at configuration time, in that order. If no such file is found and
268 * codec_name is defined, then search for a file named
269 * codec_name-preset_name.ffpreset in the above-mentioned directories.
270 *
271 * @param filename buffer where the name of the found filename is written
272 * @param filename_size size in bytes of the filename buffer
273 * @param preset_name name of the preset to search
274 * @param is_path tell if preset_name is a filename path
275 * @param codec_name name of the codec for which to look for the
276 * preset, may be NULL
277 */
278 FILE *get_preset_file(char *filename, size_t filename_size,
279 const char *preset_name, int is_path, const char *codec_name);
280
281 typedef struct {
282 enum PixelFormat pix_fmt;
283 } FFSinkContext;
284
285 extern AVFilter ffsink;
286
287 /**
288 * Extract a frame from sink.
289 *
290 * @return a negative error in case of failure, 1 if one frame has
291 * been extracted successfully.
292 */
293 int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
294 AVFilterBufferRef **picref, AVRational *pts_tb);
295
296 #endif /* LIBAV_CMDUTILS_H */