Merge commit 'f8b1e665539010d3ca148f09cb1203c20c1ca174'
[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 /**
47  * this year, defined by the program for show_banner()
48  */
49 extern const int this_year;
50
51 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
52 extern AVFormatContext *avformat_opts;
53 extern struct SwsContext *sws_opts;
54 extern struct SwrContext *swr_opts;
55 extern AVDictionary *format_opts, *codec_opts;
56
57 /**
58  * Initialize the cmdutils option system, in particular
59  * allocate the *_opts contexts.
60  */
61 void init_opts(void);
62 /**
63  * Uninitialize the cmdutils option system, in particular
64  * free the *_opts contexts and their contents.
65  */
66 void uninit_opts(void);
67
68 /**
69  * Trivial log callback.
70  * Only suitable for opt_help and similar since it lacks prefix handling.
71  */
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74 /**
75  * Fallback for options that are not explicitly handled, these will be
76  * parsed through AVOptions.
77  */
78 int opt_default(const char *opt, const char *arg);
79
80 /**
81  * Set the libav* libraries log level.
82  */
83 int opt_loglevel(const char *opt, const char *arg);
84
85 int opt_report(const char *opt);
86
87 int opt_max_alloc(const char *opt, const char *arg);
88
89 int opt_cpuflags(const char *opt, const char *arg);
90
91 int opt_codec_debug(const char *opt, const char *arg);
92
93 /**
94  * Limit the execution time.
95  */
96 int opt_timelimit(const char *opt, const char *arg);
97
98 /**
99  * Parse a string and return its corresponding value as a double.
100  * Exit from the application if the string cannot be correctly
101  * parsed or the corresponding value is invalid.
102  *
103  * @param context the context of the value to be set (e.g. the
104  * corresponding command line option name)
105  * @param numstr the string to be parsed
106  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
107  * string should be parsed
108  * @param min the minimum valid accepted value
109  * @param max the maximum valid accepted value
110  */
111 double parse_number_or_die(const char *context, const char *numstr, int type,
112                            double min, double max);
113
114 /**
115  * Parse a string specifying a time and return its corresponding
116  * value as a number of microseconds. Exit from the application if
117  * the string cannot be correctly parsed.
118  *
119  * @param context the context of the value to be set (e.g. the
120  * corresponding command line option name)
121  * @param timestr the string to be parsed
122  * @param is_duration a flag which tells how to interpret timestr, if
123  * not zero timestr is interpreted as a duration, otherwise as a
124  * date
125  *
126  * @see parse_date()
127  */
128 int64_t parse_time_or_die(const char *context, const char *timestr,
129                           int is_duration);
130
131 typedef struct SpecifierOpt {
132     char *specifier;    /**< stream/chapter/program/... specifier */
133     union {
134         uint8_t *str;
135         int        i;
136         int64_t  i64;
137         float      f;
138         double   dbl;
139     } u;
140 } SpecifierOpt;
141
142 typedef struct {
143     const char *name;
144     int flags;
145 #define HAS_ARG    0x0001
146 #define OPT_BOOL   0x0002
147 #define OPT_EXPERT 0x0004
148 #define OPT_STRING 0x0008
149 #define OPT_VIDEO  0x0010
150 #define OPT_AUDIO  0x0020
151 #define OPT_INT    0x0080
152 #define OPT_FLOAT  0x0100
153 #define OPT_SUBTITLE 0x0200
154 #define OPT_INT64  0x0400
155 #define OPT_EXIT   0x0800
156 #define OPT_DATA   0x1000
157 #define OPT_FUNC2  0x2000
158 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
159 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
160                                    Implies OPT_OFFSET. Next element after the offset is
161                                    an int containing element count in the array. */
162 #define OPT_TIME  0x10000
163 #define OPT_DOUBLE 0x20000
164      union {
165         void *dst_ptr;
166         int (*func_arg)(const char *, const char *);
167         int (*func2_arg)(void *, const char *, const char *);
168         size_t off;
169     } u;
170     const char *help;
171     const char *argname;
172 } OptionDef;
173
174 /**
175  * Print help for all options matching specified flags.
176  *
177  * @param options a list of options
178  * @param msg title of this group. Only printed if at least one option matches.
179  * @param req_flags print only options which have all those flags set.
180  * @param rej_flags don't print options which have any of those flags set.
181  */
182 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
183                        int rej_flags);
184
185 /**
186  * Show help for all options with given flags in class and all its
187  * children.
188  */
189 void show_help_children(const AVClass *class, int flags);
190
191 /**
192  * Per-avtool specific help handler. Implemented in each
193  * avtool, called by show_help().
194  */
195 void show_help_default(const char *opt, const char *arg);
196
197 /**
198  * Generic -h handler common to all avtools.
199  */
200 int show_help(const char *opt, const char *arg);
201
202 /**
203  * Parse the command line arguments.
204  *
205  * @param optctx an opaque options context
206  * @param options Array with the definitions required to interpret every
207  * option of the form: -option_name [argument]
208  * @param parse_arg_function Name of the function called to process every
209  * argument without a leading option name flag. NULL if such arguments do
210  * not have to be processed.
211  */
212 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
213                    void (* parse_arg_function)(void *optctx, const char*));
214
215 /**
216  * Parse one given option.
217  *
218  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
219  */
220 int parse_option(void *optctx, const char *opt, const char *arg,
221                  const OptionDef *options);
222
223 /**
224  * Find the '-loglevel' option in the command line args and apply it.
225  */
226 void parse_loglevel(int argc, char **argv, const OptionDef *options);
227
228 /**
229  * Return index of option opt in argv or 0 if not found.
230  */
231 int locate_option(int argc, char **argv, const OptionDef *options,
232                   const char *optname);
233
234 /**
235  * Check if the given stream matches a stream specifier.
236  *
237  * @param s  Corresponding format context.
238  * @param st Stream from s to be checked.
239  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
240  *
241  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
242  */
243 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
244
245 /**
246  * Filter out options for given codec.
247  *
248  * Create a new options dictionary containing only the options from
249  * opts which apply to the codec with ID codec_id.
250  *
251  * @param s Corresponding format context.
252  * @param st A stream from s for which the options should be filtered.
253  * @param codec The particular codec for which the options should be filtered.
254  *              If null, the default one is looked up according to the codec id.
255  * @return a pointer to the created dictionary
256  */
257 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
258                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
259
260 /**
261  * Setup AVCodecContext options for avformat_find_stream_info().
262  *
263  * Create an array of dictionaries, one dictionary for each stream
264  * contained in s.
265  * Each dictionary will contain the options from codec_opts which can
266  * be applied to the corresponding stream codec context.
267  *
268  * @return pointer to the created array of dictionaries, NULL if it
269  * cannot be created
270  */
271 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
272                                            AVDictionary *codec_opts);
273
274 /**
275  * Print an error message to stderr, indicating filename and a human
276  * readable description of the error code err.
277  *
278  * If strerror_r() is not available the use of this function in a
279  * multithreaded application may be unsafe.
280  *
281  * @see av_strerror()
282  */
283 void print_error(const char *filename, int err);
284
285 /**
286  * Print the program banner to stderr. The banner contents depend on the
287  * current version of the repository and of the libav* libraries used by
288  * the program.
289  */
290 void show_banner(int argc, char **argv, const OptionDef *options);
291
292 /**
293  * Print the version of the program to stdout. The version message
294  * depends on the current versions of the repository and of the libav*
295  * libraries.
296  * This option processing function does not utilize the arguments.
297  */
298 int show_version(const char *opt, const char *arg);
299
300 /**
301  * Print the license of the program to stdout. The license depends on
302  * the license of the libraries compiled into the program.
303  * This option processing function does not utilize the arguments.
304  */
305 int show_license(const char *opt, const char *arg);
306
307 /**
308  * Print a listing containing all the formats supported by the
309  * program.
310  * This option processing function does not utilize the arguments.
311  */
312 int show_formats(const char *opt, const char *arg);
313
314 /**
315  * Print a listing containing all the codecs supported by the
316  * program.
317  * This option processing function does not utilize the arguments.
318  */
319 int show_codecs(const char *opt, const char *arg);
320
321 /**
322  * Print a listing containing all the decoders supported by the
323  * program.
324  */
325 int show_decoders(const char *opt, const char *arg);
326
327 /**
328  * Print a listing containing all the encoders supported by the
329  * program.
330  */
331 int show_encoders(const char *opt, const char *arg);
332
333 /**
334  * Print a listing containing all the filters supported by the
335  * program.
336  * This option processing function does not utilize the arguments.
337  */
338 int show_filters(const char *opt, const char *arg);
339
340 /**
341  * Print a listing containing all the bit stream filters supported by the
342  * program.
343  * This option processing function does not utilize the arguments.
344  */
345 int show_bsfs(const char *opt, const char *arg);
346
347 /**
348  * Print a listing containing all the protocols supported by the
349  * program.
350  * This option processing function does not utilize the arguments.
351  */
352 int show_protocols(const char *opt, const char *arg);
353
354 /**
355  * Print a listing containing all the pixel formats supported by the
356  * program.
357  * This option processing function does not utilize the arguments.
358  */
359 int show_pix_fmts(const char *opt, const char *arg);
360
361 /**
362  * Print a listing containing all the sample formats supported by the
363  * program.
364  */
365 int show_sample_fmts(const char *opt, const char *arg);
366
367 /**
368  * Return a positive value if a line read from standard input
369  * starts with [yY], otherwise return 0.
370  */
371 int read_yesno(void);
372
373 /**
374  * Read the file with name filename, and put its content in a newly
375  * allocated 0-terminated buffer.
376  *
377  * @param bufptr location where pointer to buffer is returned
378  * @param size   location where size of buffer is returned
379  * @return 0 in case of success, a negative value corresponding to an
380  * AVERROR error code in case of failure.
381  */
382 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
383
384 /**
385  * Get a file corresponding to a preset file.
386  *
387  * If is_path is non-zero, look for the file in the path preset_name.
388  * Otherwise search for a file named arg.ffpreset in the directories
389  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
390  * at configuration time or in a "ffpresets" folder along the executable
391  * on win32, in that order. If no such file is found and
392  * codec_name is defined, then search for a file named
393  * codec_name-preset_name.avpreset in the above-mentioned directories.
394  *
395  * @param filename buffer where the name of the found filename is written
396  * @param filename_size size in bytes of the filename buffer
397  * @param preset_name name of the preset to search
398  * @param is_path tell if preset_name is a filename path
399  * @param codec_name name of the codec for which to look for the
400  * preset, may be NULL
401  */
402 FILE *get_preset_file(char *filename, size_t filename_size,
403                       const char *preset_name, int is_path, const char *codec_name);
404
405 /**
406  * Do all the necessary cleanup and abort.
407  * This function is implemented in the avtools, not cmdutils.
408  */
409 av_noreturn void exit_program(int ret);
410
411 /**
412  * Realloc array to hold new_size elements of elem_size.
413  * Calls exit_program() on failure.
414  *
415  * @param elem_size size in bytes of each element
416  * @param size new element count will be written here
417  * @return reallocated array
418  */
419 void *grow_array(void *array, int elem_size, int *size, int new_size);
420
421 typedef struct FrameBuffer {
422     uint8_t *base[4];
423     uint8_t *data[4];
424     int  linesize[4];
425
426     int h, w;
427     enum PixelFormat pix_fmt;
428
429     int refcount;
430     struct FrameBuffer **pool;  ///< head of the buffer pool
431     struct FrameBuffer *next;
432 } FrameBuffer;
433
434 /**
435  * Get a frame from the pool. This is intended to be used as a callback for
436  * AVCodecContext.get_buffer.
437  *
438  * @param s codec context. s->opaque must be a pointer to the head of the
439  *          buffer pool.
440  * @param frame frame->opaque will be set to point to the FrameBuffer
441  *              containing the frame data.
442  */
443 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
444
445 /**
446  * A callback to be used for AVCodecContext.release_buffer along with
447  * codec_get_buffer().
448  */
449 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
450
451 /**
452  * A callback to be used for AVFilterBuffer.free.
453  * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
454  *           containing the buffer data.
455  */
456 void filter_release_buffer(AVFilterBuffer *fb);
457
458 /**
459  * Free all the buffers in the pool. This must be called after all the
460  * buffers have been released.
461  */
462 void free_buffer_pool(FrameBuffer **pool);
463
464 #define GET_PIX_FMT_NAME(pix_fmt)\
465     const char *name = av_get_pix_fmt_name(pix_fmt);
466
467 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
468     const char *name = av_get_sample_fmt_name(sample_fmt)
469
470 #define GET_SAMPLE_RATE_NAME(rate)\
471     char name[16];\
472     snprintf(name, sizeof(name), "%d", rate);
473
474 #define GET_CH_LAYOUT_NAME(ch_layout)\
475     char name[16];\
476     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
477
478 #define GET_CH_LAYOUT_DESC(ch_layout)\
479     char name[128];\
480     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
481
482 #endif /* CMDUTILS_H */