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