cmdutils: remove unnecessary OPT_DUMMY implementation
[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 <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 #ifdef __MINGW32__
33 #undef main /* We don't want SDL to override our main() */
34 #endif
35
36 /**
37  * program name, defined by the program for show_version().
38  */
39 extern const char program_name[];
40
41 /**
42  * program birth year, defined by the program for show_banner()
43  */
44 extern const int program_birth_year;
45
46 extern const char **opt_names;
47 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
48 extern AVFormatContext *avformat_opts;
49 extern struct SwsContext *sws_opts;
50
51 /**
52  * Initialize the cmdutils option system, in particular
53  * allocate the *_opts contexts.
54  */
55 void init_opts(void);
56 /**
57  * Uninitialize the cmdutils option system, in particular
58  * free the *_opts contexts and their contents.
59  */
60 void uninit_opts(void);
61
62 /**
63  * Trivial log callback.
64  * Only suitable for show_help and similar since it lacks prefix handling.
65  */
66 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
67
68 /**
69  * Fallback for options that are not explicitly handled, these will be
70  * parsed through AVOptions.
71  */
72 int opt_default(const char *opt, const char *arg);
73
74 /**
75  * Set the libav* libraries log level.
76  */
77 int opt_loglevel(const char *opt, const char *arg);
78
79 /**
80  * Limit the execution time.
81  */
82 int opt_timelimit(const char *opt, const char *arg);
83
84 /**
85  * Parse a string and return its corresponding value as a double.
86  * Exit from the application if the string cannot be correctly
87  * parsed or the corresponding value is invalid.
88  *
89  * @param context the context of the value to be set (e.g. the
90  * corresponding commandline option name)
91  * @param numstr the string to be parsed
92  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
93  * string should be parsed
94  * @param min the minimum valid accepted value
95  * @param max the maximum valid accepted value
96  */
97 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
98
99 /**
100  * Parse a string specifying a time and return its corresponding
101  * value as a number of microseconds. Exit from the application if
102  * the string cannot be correctly parsed.
103  *
104  * @param context the context of the value to be set (e.g. the
105  * corresponding commandline option name)
106  * @param timestr the string to be parsed
107  * @param is_duration a flag which tells how to interpret timestr, if
108  * not zero timestr is interpreted as a duration, otherwise as a
109  * date
110  *
111  * @see parse_date()
112  */
113 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
114
115 typedef struct {
116     const char *name;
117     int flags;
118 #define HAS_ARG    0x0001
119 #define OPT_BOOL   0x0002
120 #define OPT_EXPERT 0x0004
121 #define OPT_STRING 0x0008
122 #define OPT_VIDEO  0x0010
123 #define OPT_AUDIO  0x0020
124 #define OPT_GRAB   0x0040
125 #define OPT_INT    0x0080
126 #define OPT_FLOAT  0x0100
127 #define OPT_SUBTITLE 0x0200
128 #define OPT_INT64  0x0400
129 #define OPT_EXIT   0x0800
130 #define OPT_DATA   0x1000
131      union {
132         int *int_arg;
133         char **str_arg;
134         float *float_arg;
135         int (*func_arg)(const char *, const char *);
136         int64_t *int64_arg;
137     } u;
138     const char *help;
139     const char *argname;
140 } OptionDef;
141
142 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
143
144 /**
145  * Parse the command line arguments.
146  * @param options Array with the definitions required to interpret every
147  * option of the form: -option_name [argument]
148  * @param parse_arg_function Name of the function called to process every
149  * argument without a leading option name flag. NULL if such arguments do
150  * not have to be processed.
151  */
152 void parse_options(int argc, char **argv, const OptionDef *options,
153                    int (* parse_arg_function)(const char *opt, const char *arg));
154
155 void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
156
157 /**
158  * Print an error message to stderr, indicating filename and a human
159  * readable description of the error code err.
160  *
161  * If strerror_r() is not available the use of this function in a
162  * multithreaded application may be unsafe.
163  *
164  * @see av_strerror()
165  */
166 void print_error(const char *filename, int err);
167
168 /**
169  * Print the program banner to stderr. The banner contents depend on the
170  * current version of the repository and of the libav* libraries used by
171  * the program.
172  */
173 void show_banner(void);
174
175 /**
176  * Print the version of the program to stdout. The version message
177  * depends on the current versions of the repository and of the libav*
178  * libraries.
179  */
180 void show_version(void);
181
182 /**
183  * Print the license of the program to stdout. The license depends on
184  * the license of the libraries compiled into the program.
185  */
186 void show_license(void);
187
188 /**
189  * Print a listing containing all the formats supported by the
190  * program.
191  */
192 void show_formats(void);
193
194 /**
195  * Print a listing containing all the codecs supported by the
196  * program.
197  */
198 void show_codecs(void);
199
200 /**
201  * Print a listing containing all the filters supported by the
202  * program.
203  */
204 void show_filters(void);
205
206 /**
207  * Print a listing containing all the bit stream filters supported by the
208  * program.
209  */
210 void show_bsfs(void);
211
212 /**
213  * Print a listing containing all the protocols supported by the
214  * program.
215  */
216 void show_protocols(void);
217
218 /**
219  * Print a listing containing all the pixel formats supported by the
220  * program.
221  */
222 void show_pix_fmts(void);
223
224 /**
225  * Return a positive value if a line read from standard input
226  * starts with [yY], otherwise return 0.
227  */
228 int read_yesno(void);
229
230 /**
231  * Read the file with name filename, and put its content in a newly
232  * allocated 0-terminated buffer.
233  *
234  * @param bufptr location where pointer to buffer is returned
235  * @param size   location where size of buffer is returned
236  * @return 0 in case of success, a negative value corresponding to an
237  * AVERROR error code in case of failure.
238  */
239 int read_file(const char *filename, char **bufptr, size_t *size);
240
241 /**
242  * Get a file corresponding to a preset file.
243  *
244  * If is_path is non-zero, look for the file in the path preset_name.
245  * Otherwise search for a file named arg.ffpreset in the directories
246  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
247  * at configuration time or in a "ffpresets" folder along the executable
248  * on win32, in that order. If no such file is found and
249  * codec_name is defined, then search for a file named
250  * codec_name-preset_name.ffpreset in the above-mentioned directories.
251  *
252  * @param filename buffer where the name of the found filename is written
253  * @param filename_size size in bytes of the filename buffer
254  * @param preset_name name of the preset to search
255  * @param is_path tell if preset_name is a filename path
256  * @param codec_name name of the codec for which to look for the
257  * preset, may be NULL
258  */
259 FILE *get_preset_file(char *filename, size_t filename_size,
260                       const char *preset_name, int is_path, const char *codec_name);
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 /* FFMPEG_CMDUTILS_H */