Bitmap Brothers JV errata
[ffmpeg.git] / cmdutils.h
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
22 #ifndef FFMPEG_CMDUTILS_H
23 #define FFMPEG_CMDUTILS_H
24
25 #include <inttypes.h>
26 #include "libavcodec/avcodec.h"
27 #include "libavformat/avformat.h"
28 #include "libswscale/swscale.h"
29
30 /**
31  * program name, defined by the program for show_version().
32  */
33 extern const char program_name[];
34
35 /**
36  * program birth year, defined by the program for show_banner()
37  */
38 extern const int program_birth_year;
39
40 extern const char **opt_names;
41 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
42 extern AVFormatContext *avformat_opts;
43 extern struct SwsContext *sws_opts;
44
45 /**
46  * Initialize the cmdutils option system, in particular
47  * allocate the *_opts contexts.
48  */
49 void init_opts(void);
50 /**
51  * Uninitialize the cmdutils option system, in particular
52  * free the *_opts contexts and their contents.
53  */
54 void uninit_opts(void);
55
56 /**
57  * Trivial log callback.
58  * Only suitable for show_help and similar since it lacks prefix handling.
59  */
60 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
61
62 /**
63  * Fallback for options that are not explicitly handled, these will be
64  * parsed through AVOptions.
65  */
66 int opt_default(const char *opt, const char *arg);
67
68 /**
69  * Set the libav* libraries log level.
70  */
71 int opt_loglevel(const char *opt, const char *arg);
72
73 /**
74  * Limit the execution time.
75  */
76 int opt_timelimit(const char *opt, const char *arg);
77
78 /**
79  * Parse a string and return its corresponding value as a double.
80  * Exit from the application if the string cannot be correctly
81  * parsed or the corresponding value is invalid.
82  *
83  * @param context the context of the value to be set (e.g. the
84  * corresponding commandline option name)
85  * @param numstr the string to be parsed
86  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
87  * string should be parsed
88  * @param min the minimum valid accepted value
89  * @param max the maximum valid accepted value
90  */
91 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
92
93 /**
94  * Parse a string specifying a time and return its corresponding
95  * value as a number of microseconds. Exit from the application if
96  * the string cannot be correctly parsed.
97  *
98  * @param context the context of the value to be set (e.g. the
99  * corresponding commandline option name)
100  * @param timestr the string to be parsed
101  * @param is_duration a flag which tells how to interpret timestr, if
102  * not zero timestr is interpreted as a duration, otherwise as a
103  * date
104  *
105  * @see parse_date()
106  */
107 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
108
109 typedef struct {
110     const char *name;
111     int flags;
112 #define HAS_ARG    0x0001
113 #define OPT_BOOL   0x0002
114 #define OPT_EXPERT 0x0004
115 #define OPT_STRING 0x0008
116 #define OPT_VIDEO  0x0010
117 #define OPT_AUDIO  0x0020
118 #define OPT_GRAB   0x0040
119 #define OPT_INT    0x0080
120 #define OPT_FLOAT  0x0100
121 #define OPT_SUBTITLE 0x0200
122 #define OPT_FUNC2  0x0400
123 #define OPT_INT64  0x0800
124 #define OPT_EXIT   0x1000
125 #define OPT_DUMMY  0x2000
126      union {
127         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
128         int *int_arg;
129         char **str_arg;
130         float *float_arg;
131         int (*func2_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 void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
165
166 /**
167  * Print the program banner to stderr. The banner contents depend on the
168  * current version of the repository and of the libav* libraries used by
169  * the program.
170  */
171 void show_banner(void);
172
173 /**
174  * Print the version of the program to stdout. The version message
175  * depends on the current versions of the repository and of the libav*
176  * libraries.
177  */
178 void show_version(void);
179
180 /**
181  * Print the license of the program to stdout. The license depends on
182  * the license of the libraries compiled into the program.
183  */
184 void show_license(void);
185
186 /**
187  * Print a listing containing all the formats supported by the
188  * program.
189  */
190 void show_formats(void);
191
192 /**
193  * Print a listing containing all the codecs supported by the
194  * program.
195  */
196 void show_codecs(void);
197
198 /**
199  * Print a listing containing all the filters supported by the
200  * program.
201  */
202 void show_filters(void);
203
204 /**
205  * Print a listing containing all the bit stream filters supported by the
206  * program.
207  */
208 void show_bsfs(void);
209
210 /**
211  * Print a listing containing all the protocols supported by the
212  * program.
213  */
214 void show_protocols(void);
215
216 /**
217  * Print a listing containing all the pixel formats supported by the
218  * program.
219  */
220 void show_pix_fmts(void);
221
222 /**
223  * Return a positive value if a line read from standard input
224  * starts with [yY], otherwise return 0.
225  */
226 int read_yesno(void);
227
228 /**
229  * Read the file with name filename, and put its content in a newly
230  * allocated 0-terminated buffer.
231  *
232  * @param bufptr location where pointer to buffer is returned
233  * @param size   location where size of buffer is returned
234  * @return 0 in case of success, a negative value corresponding to an
235  * AVERROR error code in case of failure.
236  */
237 int read_file(const char *filename, char **bufptr, size_t *size);
238
239 /**
240  * Get a file corresponding to a preset file.
241  *
242  * If is_path is non-zero, look for the file in the path preset_name.
243  * Otherwise search for a file named arg.ffpreset in the directories
244  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
245  * at configuration time, in that order. If no such file is found and
246  * codec_name is defined, then search for a file named
247  * codec_name-preset_name.ffpreset in the above-mentioned directories.
248  *
249  * @param filename buffer where the name of the found filename is written
250  * @param filename_size size in bytes of the filename buffer
251  * @param preset_name name of the preset to search
252  * @param is_path tell if preset_name is a filename path
253  * @param codec_name name of the codec for which to look for the
254  * preset, may be NULL
255  */
256 FILE *get_preset_file(char *filename, size_t filename_size,
257                       const char *preset_name, int is_path, const char *codec_name);
258
259 #if CONFIG_AVFILTER
260 #include "libavfilter/avfilter.h"
261
262 typedef struct {
263     enum PixelFormat pix_fmt;
264 } FFSinkContext;
265
266 extern AVFilter ffsink;
267
268 /**
269  * Extract a frame from sink.
270  *
271  * @return a negative error in case of failure, 1 if one frame has
272  * been extracted successfully.
273  */
274 int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
275                              AVFilterBufferRef **picref, AVRational *pts_tb);
276
277 #endif /* CONFIG_AVFILTER */
278
279 #endif /* FFMPEG_CMDUTILS_H */