2512e36020ad94394217e75ecc60f23b63efb2c2
[ffmpeg.git] / libavformat / avformat.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVFORMAT_AVFORMAT_H
22 #define AVFORMAT_AVFORMAT_H
23
24 /**
25  * @file
26  * @ingroup libavf
27  * Main libavformat public API header
28  */
29
30 /**
31  * @defgroup libavf I/O and Muxing/Demuxing Library
32  * @{
33  *
34  * Libavformat (lavf) is a library for dealing with various media container
35  * formats. Its main two purposes are demuxing - i.e. splitting a media file
36  * into component streams, and the reverse process of muxing - writing supplied
37  * data in a specified container format. It also has an @ref lavf_io
38  * "I/O module" which supports a number of protocols for accessing the data (e.g.
39  * file, tcp, http and others). Before using lavf, you need to call
40  * av_register_all() to register all compiled muxers, demuxers and protocols.
41  * Unless you are absolutely sure you won't use libavformat's network
42  * capabilities, you should also call avformat_network_init().
43  *
44  * A supported input format is described by an AVInputFormat struct, conversely
45  * an output format is described by AVOutputFormat. You can iterate over all
46  * registered input/output formats using the av_iformat_next() /
47  * av_oformat_next() functions. The protocols layer is not part of the public
48  * API, so you can only get the names of supported protocols with the
49  * avio_enum_protocols() function.
50  *
51  * Main lavf structure used for both muxing and demuxing is AVFormatContext,
52  * which exports all information about the file being read or written. As with
53  * most Libav structures, its size is not part of public ABI, so it cannot be
54  * allocated on stack or directly with av_malloc(). To create an
55  * AVFormatContext, use avformat_alloc_context() (some functions, like
56  * avformat_open_input() might do that for you).
57  *
58  * Most importantly an AVFormatContext contains:
59  * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
60  * "output" format. It is either autodetected or set by user for input;
61  * always set by user for output.
62  * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
63  * elementary streams stored in the file. AVStreams are typically referred to
64  * using their index in this array.
65  * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
66  * set by user for input, always set by user for output (unless you are dealing
67  * with an AVFMT_NOFILE format).
68  *
69  * @section lavf_options Passing options to (de)muxers
70  * Lavf allows to configure muxers and demuxers using the @ref avoptions
71  * mechanism. Generic (format-independent) libavformat options are provided by
72  * AVFormatContext, they can be examined from a user program by calling
73  * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
74  * from avformat_get_class()). Private (format-specific) options are provided by
75  * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
76  * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
77  * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
78  * if its AVClass is non-NULL, and the protocols layer. See the discussion on
79  * nesting in @ref avoptions documentation to learn how to access those.
80  *
81  * @defgroup lavf_decoding Demuxing
82  * @{
83  * Demuxers read a media file and split it into chunks of data (@em packets). A
84  * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
85  * single elementary stream. In the lavf API this process is represented by the
86  * avformat_open_input() function for opening a file, av_read_frame() for
87  * reading a single packet and finally avformat_close_input(), which does the
88  * cleanup.
89  *
90  * @section lavf_decoding_open Opening a media file
91  * The minimum information required to open a file is its URL or filename, which
92  * is passed to avformat_open_input(), as in the following code:
93  * @code
94  * const char    *url = "in.mp3";
95  * AVFormatContext *s = NULL;
96  * int ret = avformat_open_input(&s, url, NULL, NULL);
97  * if (ret < 0)
98  *     abort();
99  * @endcode
100  * The above code attempts to allocate an AVFormatContext, open the
101  * specified file (autodetecting the format) and read the header, exporting the
102  * information stored there into s. Some formats do not have a header or do not
103  * store enough information there, so it is recommended that you call the
104  * avformat_find_stream_info() function which tries to read and decode a few
105  * frames to find missing information.
106  *
107  * In some cases you might want to preallocate an AVFormatContext yourself with
108  * avformat_alloc_context() and do some tweaking on it before passing it to
109  * avformat_open_input(). One such case is when you want to use custom functions
110  * for reading input data instead of lavf internal I/O layer.
111  * To do that, create your own AVIOContext with avio_alloc_context(), passing
112  * your reading callbacks to it. Then set the @em pb field of your
113  * AVFormatContext to newly created AVIOContext.
114  *
115  * Since the format of the opened file is in general not known until after
116  * avformat_open_input() has returned, it is not possible to set demuxer private
117  * options on a preallocated context. Instead, the options should be passed to
118  * avformat_open_input() wrapped in an AVDictionary:
119  * @code
120  * AVDictionary *options = NULL;
121  * av_dict_set(&options, "video_size", "640x480", 0);
122  * av_dict_set(&options, "pixel_format", "rgb24", 0);
123  *
124  * if (avformat_open_input(&s, url, NULL, &options) < 0)
125  *     abort();
126  * av_dict_free(&options);
127  * @endcode
128  * This code passes the private options 'video_size' and 'pixel_format' to the
129  * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
130  * cannot know how to interpret raw video data otherwise. If the format turns
131  * out to be something different than raw video, those options will not be
132  * recognized by the demuxer and therefore will not be applied. Such unrecognized
133  * options are then returned in the options dictionary (recognized options are
134  * consumed). The calling program can handle such unrecognized options as it
135  * wishes, e.g.
136  * @code
137  * AVDictionaryEntry *e;
138  * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
139  *     fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
140  *     abort();
141  * }
142  * @endcode
143  *
144  * After you have finished reading the file, you must close it with
145  * avformat_close_input(). It will free everything associated with the file.
146  *
147  * @section lavf_decoding_read Reading from an opened file
148  * Reading data from an opened AVFormatContext is done by repeatedly calling
149  * av_read_frame() on it. Each call, if successful, will return an AVPacket
150  * containing encoded data for one AVStream, identified by
151  * AVPacket.stream_index. This packet may be passed straight into the libavcodec
152  * decoding functions avcodec_decode_video2(), avcodec_decode_audio4() or
153  * avcodec_decode_subtitle2() if the caller wishes to decode the data.
154  *
155  * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
156  * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
157  * pts/dts, 0 for duration) if the stream does not provide them. The timing
158  * information will be in AVStream.time_base units, i.e. it has to be
159  * multiplied by the timebase to convert them to seconds.
160  *
161  * If AVPacket.buf is set on the returned packet, then the packet is
162  * allocated dynamically and the user may keep it indefinitely.
163  * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
164  * static storage somewhere inside the demuxer and the packet is only valid
165  * until the next av_read_frame() call or closing the file. If the caller
166  * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
167  * of it.
168  * In both cases, the packet must be freed with av_free_packet() when it is no
169  * longer needed.
170  *
171  * @section lavf_decoding_seek Seeking
172  * @}
173  *
174  * @defgroup lavf_encoding Muxing
175  * @{
176  * @}
177  *
178  * @defgroup lavf_io I/O Read/Write
179  * @{
180  * @}
181  *
182  * @defgroup lavf_codec Demuxers
183  * @{
184  * @defgroup lavf_codec_native Native Demuxers
185  * @{
186  * @}
187  * @defgroup lavf_codec_wrappers External library wrappers
188  * @{
189  * @}
190  * @}
191  * @defgroup lavf_protos I/O Protocols
192  * @{
193  * @}
194  * @defgroup lavf_internal Internal
195  * @{
196  * @}
197  * @}
198  *
199  */
200
201 #include <time.h>
202 #include <stdio.h>  /* FILE */
203 #include "libavcodec/avcodec.h"
204 #include "libavutil/dict.h"
205 #include "libavutil/log.h"
206
207 #include "avio.h"
208 #include "libavformat/version.h"
209
210 struct AVFormatContext;
211
212
213 /**
214  * @defgroup metadata_api Public Metadata API
215  * @{
216  * @ingroup libavf
217  * The metadata API allows libavformat to export metadata tags to a client
218  * application when demuxing. Conversely it allows a client application to
219  * set metadata when muxing.
220  *
221  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
222  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
223  * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
224  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
225  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
226  *
227  * Important concepts to keep in mind:
228  * -  Keys are unique; there can never be 2 tags with the same key. This is
229  *    also meant semantically, i.e., a demuxer should not knowingly produce
230  *    several keys that are literally different but semantically identical.
231  *    E.g., key=Author5, key=Author6. In this example, all authors must be
232  *    placed in the same tag.
233  * -  Metadata is flat, not hierarchical; there are no subtags. If you
234  *    want to store, e.g., the email address of the child of producer Alice
235  *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
236  * -  Several modifiers can be applied to the tag name. This is done by
237  *    appending a dash character ('-') and the modifier name in the order
238  *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
239  *    -  language -- a tag whose value is localized for a particular language
240  *       is appended with the ISO 639-2/B 3-letter language code.
241  *       For example: Author-ger=Michael, Author-eng=Mike
242  *       The original/default language is in the unqualified "Author" tag.
243  *       A demuxer should set a default if it sets any translated tag.
244  *    -  sorting  -- a modified version of a tag that should be used for
245  *       sorting will have '-sort' appended. E.g. artist="The Beatles",
246  *       artist-sort="Beatles, The".
247  *
248  * -  Demuxers attempt to export metadata in a generic format, however tags
249  *    with no generic equivalents are left as they are stored in the container.
250  *    Follows a list of generic tag names:
251  *
252  @verbatim
253  album        -- name of the set this work belongs to
254  album_artist -- main creator of the set/album, if different from artist.
255                  e.g. "Various Artists" for compilation albums.
256  artist       -- main creator of the work
257  comment      -- any additional description of the file.
258  composer     -- who composed the work, if different from artist.
259  copyright    -- name of copyright holder.
260  creation_time-- date when the file was created, preferably in ISO 8601.
261  date         -- date when the work was created, preferably in ISO 8601.
262  disc         -- number of a subset, e.g. disc in a multi-disc collection.
263  encoder      -- name/settings of the software/hardware that produced the file.
264  encoded_by   -- person/group who created the file.
265  filename     -- original name of the file.
266  genre        -- <self-evident>.
267  language     -- main language in which the work is performed, preferably
268                  in ISO 639-2 format. Multiple languages can be specified by
269                  separating them with commas.
270  performer    -- artist who performed the work, if different from artist.
271                  E.g for "Also sprach Zarathustra", artist would be "Richard
272                  Strauss" and performer "London Philharmonic Orchestra".
273  publisher    -- name of the label/publisher.
274  service_name     -- name of the service in broadcasting (channel name).
275  service_provider -- name of the service provider in broadcasting.
276  title        -- name of the work.
277  track        -- number of this work in the set, can be in form current/total.
278  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
279  @endverbatim
280  *
281  * Look in the examples section for an application example how to use the Metadata API.
282  *
283  * @}
284  */
285
286 /* packet functions */
287
288
289 /**
290  * Allocate and read the payload of a packet and initialize its
291  * fields with default values.
292  *
293  * @param pkt packet
294  * @param size desired payload size
295  * @return >0 (read size) if OK, AVERROR_xxx otherwise
296  */
297 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
298
299
300 /**
301  * Read data and append it to the current content of the AVPacket.
302  * If pkt->size is 0 this is identical to av_get_packet.
303  * Note that this uses av_grow_packet and thus involves a realloc
304  * which is inefficient. Thus this function should only be used
305  * when there is no reasonable way to know (an upper bound of)
306  * the final size.
307  *
308  * @param pkt packet
309  * @param size amount of data to read
310  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
311  *         will not be lost even if an error occurs.
312  */
313 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
314
315 /*************************************************/
316 /* fractional numbers for exact pts handling */
317
318 /**
319  * The exact value of the fractional number is: 'val + num / den'.
320  * num is assumed to be 0 <= num < den.
321  */
322 typedef struct AVFrac {
323     int64_t val, num, den;
324 } AVFrac;
325
326 /*************************************************/
327 /* input/output formats */
328
329 struct AVCodecTag;
330
331 /**
332  * This structure contains the data a format has to probe a file.
333  */
334 typedef struct AVProbeData {
335     const char *filename;
336     unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
337     int buf_size;       /**< Size of buf except extra allocated bytes */
338 } AVProbeData;
339
340 #define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
341 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
342
343 /// Demuxer will use avio_open, no opened file should be provided by the caller.
344 #define AVFMT_NOFILE        0x0001
345 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
346 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
347 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
348                                       raw picture data. */
349 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
350 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
351 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
352 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
353 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
354 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
355 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
356 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
357 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fallback to generic search */
358 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
359 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
360 #define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
361                                         increasing timestamps, but they must
362                                         still be monotonic */
363 #define AVFMT_TS_NEGATIVE  0x40000 /**< Format allows muxing negative
364                                         timestamps. If not set the timestamp
365                                         will be shifted in av_write_frame and
366                                         av_interleaved_write_frame so they
367                                         start from 0. */
368
369 /**
370  * @addtogroup lavf_encoding
371  * @{
372  */
373 typedef struct AVOutputFormat {
374     const char *name;
375     /**
376      * Descriptive name for the format, meant to be more human-readable
377      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
378      * to define it.
379      */
380     const char *long_name;
381     const char *mime_type;
382     const char *extensions; /**< comma-separated filename extensions */
383     /* output support */
384     enum AVCodecID audio_codec;    /**< default audio codec */
385     enum AVCodecID video_codec;    /**< default video codec */
386     enum AVCodecID subtitle_codec; /**< default subtitle codec */
387     /**
388      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
389      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
390      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
391      * AVFMT_TS_NONSTRICT
392      */
393     int flags;
394
395     /**
396      * List of supported codec_id-codec_tag pairs, ordered by "better
397      * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
398      */
399     const struct AVCodecTag * const *codec_tag;
400
401
402     const AVClass *priv_class; ///< AVClass for the private context
403
404     /*****************************************************************
405      * No fields below this line are part of the public API. They
406      * may not be used outside of libavformat and can be changed and
407      * removed at will.
408      * New public fields should be added right above.
409      *****************************************************************
410      */
411     struct AVOutputFormat *next;
412     /**
413      * size of private data so that it can be allocated in the wrapper
414      */
415     int priv_data_size;
416
417     int (*write_header)(struct AVFormatContext *);
418     /**
419      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
420      * pkt can be NULL in order to flush data buffered in the muxer.
421      * When flushing, return 0 if there still is more data to flush,
422      * or 1 if everything was flushed and there is no more buffered
423      * data.
424      */
425     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
426     int (*write_trailer)(struct AVFormatContext *);
427     /**
428      * Currently only used to set pixel format if not YUV420P.
429      */
430     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
431                              AVPacket *in, int flush);
432     /**
433      * Test if the given codec can be stored in this container.
434      *
435      * @return 1 if the codec is supported, 0 if it is not.
436      *         A negative number if unknown.
437      */
438     int (*query_codec)(enum AVCodecID id, int std_compliance);
439 } AVOutputFormat;
440 /**
441  * @}
442  */
443
444 /**
445  * @addtogroup lavf_decoding
446  * @{
447  */
448 typedef struct AVInputFormat {
449     /**
450      * A comma separated list of short names for the format. New names
451      * may be appended with a minor bump.
452      */
453     const char *name;
454
455     /**
456      * Descriptive name for the format, meant to be more human-readable
457      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
458      * to define it.
459      */
460     const char *long_name;
461
462     /**
463      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
464      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
465      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
466      */
467     int flags;
468
469     /**
470      * If extensions are defined, then no probe is done. You should
471      * usually not use extension format guessing because it is not
472      * reliable enough
473      */
474     const char *extensions;
475
476     const struct AVCodecTag * const *codec_tag;
477
478     const AVClass *priv_class; ///< AVClass for the private context
479
480     /*****************************************************************
481      * No fields below this line are part of the public API. They
482      * may not be used outside of libavformat and can be changed and
483      * removed at will.
484      * New public fields should be added right above.
485      *****************************************************************
486      */
487     struct AVInputFormat *next;
488
489     /**
490      * Raw demuxers store their codec ID here.
491      */
492     int raw_codec_id;
493
494     /**
495      * Size of private data so that it can be allocated in the wrapper.
496      */
497     int priv_data_size;
498
499     /**
500      * Tell if a given file has a chance of being parsed as this format.
501      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
502      * big so you do not have to check for that unless you need more.
503      */
504     int (*read_probe)(AVProbeData *);
505
506     /**
507      * Read the format header and initialize the AVFormatContext
508      * structure. Return 0 if OK. Only used in raw format right
509      * now. 'avformat_new_stream' should be called to create new streams.
510      */
511     int (*read_header)(struct AVFormatContext *);
512
513     /**
514      * Read one packet and put it in 'pkt'. pts and flags are also
515      * set. 'avformat_new_stream' can be called only if the flag
516      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
517      * background thread).
518      * @return 0 on success, < 0 on error.
519      *         When returning an error, pkt must not have been allocated
520      *         or must be freed before returning
521      */
522     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
523
524     /**
525      * Close the stream. The AVFormatContext and AVStreams are not
526      * freed by this function
527      */
528     int (*read_close)(struct AVFormatContext *);
529
530     /**
531      * Seek to a given timestamp relative to the frames in
532      * stream component stream_index.
533      * @param stream_index Must not be -1.
534      * @param flags Selects which direction should be preferred if no exact
535      *              match is available.
536      * @return >= 0 on success (but not necessarily the new offset)
537      */
538     int (*read_seek)(struct AVFormatContext *,
539                      int stream_index, int64_t timestamp, int flags);
540
541     /**
542      * Get the next timestamp in stream[stream_index].time_base units.
543      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
544      */
545     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
546                               int64_t *pos, int64_t pos_limit);
547
548     /**
549      * Start/resume playing - only meaningful if using a network-based format
550      * (RTSP).
551      */
552     int (*read_play)(struct AVFormatContext *);
553
554     /**
555      * Pause playing - only meaningful if using a network-based format
556      * (RTSP).
557      */
558     int (*read_pause)(struct AVFormatContext *);
559
560     /**
561      * Seek to timestamp ts.
562      * Seeking will be done so that the point from which all active streams
563      * can be presented successfully will be closest to ts and within min/max_ts.
564      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
565      */
566     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
567 } AVInputFormat;
568 /**
569  * @}
570  */
571
572 enum AVStreamParseType {
573     AVSTREAM_PARSE_NONE,
574     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
575     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
576     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
577     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
578 };
579
580 typedef struct AVIndexEntry {
581     int64_t pos;
582     int64_t timestamp;
583 #define AVINDEX_KEYFRAME 0x0001
584     int flags:2;
585     int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
586     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
587 } AVIndexEntry;
588
589 #define AV_DISPOSITION_DEFAULT   0x0001
590 #define AV_DISPOSITION_DUB       0x0002
591 #define AV_DISPOSITION_ORIGINAL  0x0004
592 #define AV_DISPOSITION_COMMENT   0x0008
593 #define AV_DISPOSITION_LYRICS    0x0010
594 #define AV_DISPOSITION_KARAOKE   0x0020
595
596 /**
597  * Track should be used during playback by default.
598  * Useful for subtitle track that should be displayed
599  * even when user did not explicitly ask for subtitles.
600  */
601 #define AV_DISPOSITION_FORCED    0x0040
602 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
603 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
604 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
605 /**
606  * The stream is stored in the file as an attached picture/"cover art" (e.g.
607  * APIC frame in ID3v2). The single packet associated with it will be returned
608  * among the first few packets read from the file unless seeking takes place.
609  * It can also be accessed at any time in AVStream.attached_pic.
610  */
611 #define AV_DISPOSITION_ATTACHED_PIC      0x0400
612
613 /**
614  * Stream structure.
615  * New fields can be added to the end with minor version bumps.
616  * Removal, reordering and changes to existing fields require a major
617  * version bump.
618  * sizeof(AVStream) must not be used outside libav*.
619  */
620 typedef struct AVStream {
621     int index;    /**< stream index in AVFormatContext */
622     /**
623      * Format-specific stream ID.
624      * decoding: set by libavformat
625      * encoding: set by the user, replaced by libavformat if left unset
626      */
627     int id;
628     /**
629      * Codec context associated with this stream. Allocated and freed by
630      * libavformat.
631      *
632      * - decoding: The demuxer exports codec information stored in the headers
633      *             here.
634      * - encoding: The user sets codec information, the muxer writes it to the
635      *             output. Mandatory fields as specified in AVCodecContext
636      *             documentation must be set even if this AVCodecContext is
637      *             not actually used for encoding.
638      */
639     AVCodecContext *codec;
640     void *priv_data;
641
642     /**
643      * encoding: pts generation when outputting stream
644      */
645     struct AVFrac pts;
646
647     /**
648      * This is the fundamental unit of time (in seconds) in terms
649      * of which frame timestamps are represented.
650      *
651      * decoding: set by libavformat
652      * encoding: set by libavformat in avformat_write_header. The muxer may use the
653      * user-provided value of @ref AVCodecContext.time_base "codec->time_base"
654      * as a hint.
655      */
656     AVRational time_base;
657
658     /**
659      * Decoding: pts of the first frame of the stream, in stream time base.
660      * Only set this if you are absolutely 100% sure that the value you set
661      * it to really is the pts of the first frame.
662      * This may be undefined (AV_NOPTS_VALUE).
663      */
664     int64_t start_time;
665
666     /**
667      * Decoding: duration of the stream, in stream time base.
668      * If a source file does not specify a duration, but does specify
669      * a bitrate, this value will be estimated from bitrate and file size.
670      */
671     int64_t duration;
672
673     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
674
675     int disposition; /**< AV_DISPOSITION_* bit field */
676
677     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
678
679     /**
680      * sample aspect ratio (0 if unknown)
681      * - encoding: Set by user.
682      * - decoding: Set by libavformat.
683      */
684     AVRational sample_aspect_ratio;
685
686     AVDictionary *metadata;
687
688     /**
689      * Average framerate
690      */
691     AVRational avg_frame_rate;
692
693     /**
694      * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
695      * will contain the attached picture.
696      *
697      * decoding: set by libavformat, must not be modified by the caller.
698      * encoding: unused
699      */
700     AVPacket attached_pic;
701
702     /*****************************************************************
703      * All fields below this line are not part of the public API. They
704      * may not be used outside of libavformat and can be changed and
705      * removed at will.
706      * New public fields should be added right above.
707      *****************************************************************
708      */
709
710     /**
711      * Stream information used internally by av_find_stream_info()
712      */
713 #define MAX_STD_TIMEBASES (60*12+5)
714     struct {
715         int nb_decoded_frames;
716         int found_decoder;
717
718         /**
719          * Those are used for average framerate estimation.
720          */
721         int64_t fps_first_dts;
722         int     fps_first_dts_idx;
723         int64_t fps_last_dts;
724         int     fps_last_dts_idx;
725
726     } *info;
727
728     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
729
730     // Timestamp generation support:
731     /**
732      * Timestamp corresponding to the last dts sync point.
733      *
734      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
735      * a DTS is received from the underlying container. Otherwise set to
736      * AV_NOPTS_VALUE by default.
737      */
738     int64_t reference_dts;
739     int64_t first_dts;
740     int64_t cur_dts;
741     int64_t last_IP_pts;
742     int last_IP_duration;
743
744     /**
745      * Number of packets to buffer for codec probing
746      */
747 #define MAX_PROBE_PACKETS 2500
748     int probe_packets;
749
750     /**
751      * Number of frames that have been demuxed during av_find_stream_info()
752      */
753     int codec_info_nb_frames;
754
755     /* av_read_frame() support */
756     enum AVStreamParseType need_parsing;
757     struct AVCodecParserContext *parser;
758
759     /**
760      * last packet in packet_buffer for this stream when muxing.
761      */
762     struct AVPacketList *last_in_packet_buffer;
763     AVProbeData probe_data;
764 #define MAX_REORDER_DELAY 16
765     int64_t pts_buffer[MAX_REORDER_DELAY+1];
766
767     AVIndexEntry *index_entries; /**< Only used if the format does not
768                                     support seeking natively. */
769     int nb_index_entries;
770     unsigned int index_entries_allocated_size;
771 } AVStream;
772
773 #define AV_PROGRAM_RUNNING 1
774
775 /**
776  * New fields can be added to the end with minor version bumps.
777  * Removal, reordering and changes to existing fields require a major
778  * version bump.
779  * sizeof(AVProgram) must not be used outside libav*.
780  */
781 typedef struct AVProgram {
782     int            id;
783     int            flags;
784     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
785     unsigned int   *stream_index;
786     unsigned int   nb_stream_indexes;
787     AVDictionary *metadata;
788 } AVProgram;
789
790 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
791                                          (streams are added dynamically) */
792
793 typedef struct AVChapter {
794     int id;                 ///< unique ID to identify the chapter
795     AVRational time_base;   ///< time base in which the start/end timestamps are specified
796     int64_t start, end;     ///< chapter start/end time in time_base units
797     AVDictionary *metadata;
798 } AVChapter;
799
800 /**
801  * Format I/O context.
802  * New fields can be added to the end with minor version bumps.
803  * Removal, reordering and changes to existing fields require a major
804  * version bump.
805  * sizeof(AVFormatContext) must not be used outside libav*, use
806  * avformat_alloc_context() to create an AVFormatContext.
807  */
808 typedef struct AVFormatContext {
809     /**
810      * A class for logging and AVOptions. Set by avformat_alloc_context().
811      * Exports (de)muxer private options if they exist.
812      */
813     const AVClass *av_class;
814
815     /**
816      * Can only be iformat or oformat, not both at the same time.
817      *
818      * decoding: set by avformat_open_input().
819      * encoding: set by the user.
820      */
821     struct AVInputFormat *iformat;
822     struct AVOutputFormat *oformat;
823
824     /**
825      * Format private data. This is an AVOptions-enabled struct
826      * if and only if iformat/oformat.priv_class is not NULL.
827      */
828     void *priv_data;
829
830     /**
831      * I/O context.
832      *
833      * decoding: either set by the user before avformat_open_input() (then
834      * the user must close it manually) or set by avformat_open_input().
835      * encoding: set by the user.
836      *
837      * Do NOT set this field if AVFMT_NOFILE flag is set in
838      * iformat/oformat.flags. In such a case, the (de)muxer will handle
839      * I/O in some other way and this field will be NULL.
840      */
841     AVIOContext *pb;
842
843     /* stream info */
844     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
845
846     /**
847      * A list of all streams in the file. New streams are created with
848      * avformat_new_stream().
849      *
850      * decoding: streams are created by libavformat in avformat_open_input().
851      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
852      * appear in av_read_frame().
853      * encoding: streams are created by the user before avformat_write_header().
854      */
855     unsigned int nb_streams;
856     AVStream **streams;
857
858     char filename[1024]; /**< input or output filename */
859
860     /**
861      * Decoding: position of the first frame of the component, in
862      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
863      * It is deduced from the AVStream values.
864      */
865     int64_t start_time;
866
867     /**
868      * Decoding: duration of the stream, in AV_TIME_BASE fractional
869      * seconds. Only set this value if you know none of the individual stream
870      * durations and also do not set any of them. This is deduced from the
871      * AVStream values if not set.
872      */
873     int64_t duration;
874
875     /**
876      * Decoding: total stream bitrate in bit/s, 0 if not
877      * available. Never set it directly if the file_size and the
878      * duration are known as Libav can compute it automatically.
879      */
880     int bit_rate;
881
882     unsigned int packet_size;
883     int max_delay;
884
885     int flags;
886 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
887 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
888 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
889 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
890 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
891 #define AVFMT_FLAG_NOPARSE      0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
892 #define AVFMT_FLAG_NOBUFFER     0x0040 ///< Do not buffer frames when possible
893 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
894 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
895
896     /**
897      * decoding: size of data to probe; encoding: unused.
898      */
899     unsigned int probesize;
900
901     /**
902      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
903      * be analyzed in avformat_find_stream_info().
904      */
905     int max_analyze_duration;
906
907     const uint8_t *key;
908     int keylen;
909
910     unsigned int nb_programs;
911     AVProgram **programs;
912
913     /**
914      * Forced video codec_id.
915      * Demuxing: Set by user.
916      */
917     enum AVCodecID video_codec_id;
918
919     /**
920      * Forced audio codec_id.
921      * Demuxing: Set by user.
922      */
923     enum AVCodecID audio_codec_id;
924
925     /**
926      * Forced subtitle codec_id.
927      * Demuxing: Set by user.
928      */
929     enum AVCodecID subtitle_codec_id;
930
931     /**
932      * Maximum amount of memory in bytes to use for the index of each stream.
933      * If the index exceeds this size, entries will be discarded as
934      * needed to maintain a smaller size. This can lead to slower or less
935      * accurate seeking (depends on demuxer).
936      * Demuxers for which a full in-memory index is mandatory will ignore
937      * this.
938      * muxing  : unused
939      * demuxing: set by user
940      */
941     unsigned int max_index_size;
942
943     /**
944      * Maximum amount of memory in bytes to use for buffering frames
945      * obtained from realtime capture devices.
946      */
947     unsigned int max_picture_buffer;
948
949     unsigned int nb_chapters;
950     AVChapter **chapters;
951
952     AVDictionary *metadata;
953
954     /**
955      * Start time of the stream in real world time, in microseconds
956      * since the unix epoch (00:00 1st January 1970). That is, pts=0
957      * in the stream was captured at this real world time.
958      * - encoding: Set by user.
959      * - decoding: Unused.
960      */
961     int64_t start_time_realtime;
962
963     /**
964      * decoding: number of frames used to probe fps
965      */
966     int fps_probe_size;
967
968     /**
969      * Error recognition; higher values will detect more errors but may
970      * misdetect some more or less valid parts as errors.
971      * - encoding: unused
972      * - decoding: Set by user.
973      */
974     int error_recognition;
975
976     /**
977      * Custom interrupt callbacks for the I/O layer.
978      *
979      * decoding: set by the user before avformat_open_input().
980      * encoding: set by the user before avformat_write_header()
981      * (mainly useful for AVFMT_NOFILE formats). The callback
982      * should also be passed to avio_open2() if it's used to
983      * open the file.
984      */
985     AVIOInterruptCB interrupt_callback;
986
987     /**
988      * Flags to enable debugging.
989      */
990     int debug;
991 #define FF_FDEBUG_TS        0x0001
992     /*****************************************************************
993      * All fields below this line are not part of the public API. They
994      * may not be used outside of libavformat and can be changed and
995      * removed at will.
996      * New public fields should be added right above.
997      *****************************************************************
998      */
999
1000     /**
1001      * This buffer is only needed when packets were already buffered but
1002      * not decoded, for example to get the codec parameters in MPEG
1003      * streams.
1004      */
1005     struct AVPacketList *packet_buffer;
1006     struct AVPacketList *packet_buffer_end;
1007
1008     /* av_seek_frame() support */
1009     int64_t data_offset; /**< offset of the first packet */
1010
1011     /**
1012      * Raw packets from the demuxer, prior to parsing and decoding.
1013      * This buffer is used for buffering packets until the codec can
1014      * be identified, as parsing cannot be done without knowing the
1015      * codec.
1016      */
1017     struct AVPacketList *raw_packet_buffer;
1018     struct AVPacketList *raw_packet_buffer_end;
1019     /**
1020      * Packets split by the parser get queued here.
1021      */
1022     struct AVPacketList *parse_queue;
1023     struct AVPacketList *parse_queue_end;
1024     /**
1025      * Remaining size available for raw_packet_buffer, in bytes.
1026      */
1027 #define RAW_PACKET_BUFFER_SIZE 2500000
1028     int raw_packet_buffer_remaining_size;
1029
1030     /**
1031      * Offset to remap timestamps to be non-negative.
1032      * Expressed in timebase units.
1033      */
1034     int64_t offset;
1035
1036     /**
1037      * Timebase for the timestamp offset.
1038      */
1039     AVRational offset_timebase;
1040
1041 } AVFormatContext;
1042
1043 typedef struct AVPacketList {
1044     AVPacket pkt;
1045     struct AVPacketList *next;
1046 } AVPacketList;
1047
1048
1049 /**
1050  * @defgroup lavf_core Core functions
1051  * @ingroup libavf
1052  *
1053  * Functions for querying libavformat capabilities, allocating core structures,
1054  * etc.
1055  * @{
1056  */
1057
1058 /**
1059  * Return the LIBAVFORMAT_VERSION_INT constant.
1060  */
1061 unsigned avformat_version(void);
1062
1063 /**
1064  * Return the libavformat build-time configuration.
1065  */
1066 const char *avformat_configuration(void);
1067
1068 /**
1069  * Return the libavformat license.
1070  */
1071 const char *avformat_license(void);
1072
1073 /**
1074  * Initialize libavformat and register all the muxers, demuxers and
1075  * protocols. If you do not call this function, then you can select
1076  * exactly which formats you want to support.
1077  *
1078  * @see av_register_input_format()
1079  * @see av_register_output_format()
1080  * @see av_register_protocol()
1081  */
1082 void av_register_all(void);
1083
1084 void av_register_input_format(AVInputFormat *format);
1085 void av_register_output_format(AVOutputFormat *format);
1086
1087 /**
1088  * Do global initialization of network components. This is optional,
1089  * but recommended, since it avoids the overhead of implicitly
1090  * doing the setup for each session.
1091  *
1092  * Calling this function will become mandatory if using network
1093  * protocols at some major version bump.
1094  */
1095 int avformat_network_init(void);
1096
1097 /**
1098  * Undo the initialization done by avformat_network_init.
1099  */
1100 int avformat_network_deinit(void);
1101
1102 /**
1103  * If f is NULL, returns the first registered input format,
1104  * if f is non-NULL, returns the next registered input format after f
1105  * or NULL if f is the last one.
1106  */
1107 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1108
1109 /**
1110  * If f is NULL, returns the first registered output format,
1111  * if f is non-NULL, returns the next registered output format after f
1112  * or NULL if f is the last one.
1113  */
1114 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1115
1116 /**
1117  * Allocate an AVFormatContext.
1118  * avformat_free_context() can be used to free the context and everything
1119  * allocated by the framework within it.
1120  */
1121 AVFormatContext *avformat_alloc_context(void);
1122
1123 /**
1124  * Free an AVFormatContext and all its streams.
1125  * @param s context to free
1126  */
1127 void avformat_free_context(AVFormatContext *s);
1128
1129 /**
1130  * Get the AVClass for AVFormatContext. It can be used in combination with
1131  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1132  *
1133  * @see av_opt_find().
1134  */
1135 const AVClass *avformat_get_class(void);
1136
1137 /**
1138  * Add a new stream to a media file.
1139  *
1140  * When demuxing, it is called by the demuxer in read_header(). If the
1141  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1142  * be called in read_packet().
1143  *
1144  * When muxing, should be called by the user before avformat_write_header().
1145  *
1146  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1147  * will be initialized to use this codec. This is needed for e.g. codec-specific
1148  * defaults to be set, so codec should be provided if it is known.
1149  *
1150  * @return newly created stream or NULL on error.
1151  */
1152 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1153
1154 AVProgram *av_new_program(AVFormatContext *s, int id);
1155
1156 /**
1157  * @}
1158  */
1159
1160
1161 /**
1162  * @addtogroup lavf_decoding
1163  * @{
1164  */
1165
1166 /**
1167  * Find AVInputFormat based on the short name of the input format.
1168  */
1169 AVInputFormat *av_find_input_format(const char *short_name);
1170
1171 /**
1172  * Guess the file format.
1173  *
1174  * @param is_opened Whether the file is already opened; determines whether
1175  *                  demuxers with or without AVFMT_NOFILE are probed.
1176  */
1177 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1178
1179 /**
1180  * Guess the file format.
1181  *
1182  * @param is_opened Whether the file is already opened; determines whether
1183  *                  demuxers with or without AVFMT_NOFILE are probed.
1184  * @param score_max A probe score larger that this is required to accept a
1185  *                  detection, the variable is set to the actual detection
1186  *                  score afterwards.
1187  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1188  *                  to retry with a larger probe buffer.
1189  */
1190 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1191
1192 /**
1193  * Probe a bytestream to determine the input format. Each time a probe returns
1194  * with a score that is too low, the probe buffer size is increased and another
1195  * attempt is made. When the maximum probe size is reached, the input format
1196  * with the highest score is returned.
1197  *
1198  * @param pb the bytestream to probe
1199  * @param fmt the input format is put here
1200  * @param filename the filename of the stream
1201  * @param logctx the log context
1202  * @param offset the offset within the bytestream to probe from
1203  * @param max_probe_size the maximum probe buffer size (zero for default)
1204  * @return 0 in case of success, a negative value corresponding to an
1205  * AVERROR code otherwise
1206  */
1207 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1208                           const char *filename, void *logctx,
1209                           unsigned int offset, unsigned int max_probe_size);
1210
1211 /**
1212  * Open an input stream and read the header. The codecs are not opened.
1213  * The stream must be closed with av_close_input_file().
1214  *
1215  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1216  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1217  *           function and written into ps.
1218  *           Note that a user-supplied AVFormatContext will be freed on failure.
1219  * @param filename Name of the stream to open.
1220  * @param fmt If non-NULL, this parameter forces a specific input format.
1221  *            Otherwise the format is autodetected.
1222  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1223  *                 On return this parameter will be destroyed and replaced with a dict containing
1224  *                 options that were not found. May be NULL.
1225  *
1226  * @return 0 on success, a negative AVERROR on failure.
1227  *
1228  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1229  */
1230 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1231
1232 /**
1233  * Read packets of a media file to get stream information. This
1234  * is useful for file formats with no headers such as MPEG. This
1235  * function also computes the real framerate in case of MPEG-2 repeat
1236  * frame mode.
1237  * The logical file position is not changed by this function;
1238  * examined packets may be buffered for later processing.
1239  *
1240  * @param ic media file handle
1241  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1242  *                 dictionaries, where i-th member contains options for
1243  *                 codec corresponding to i-th stream.
1244  *                 On return each dictionary will be filled with options that were not found.
1245  * @return >=0 if OK, AVERROR_xxx on error
1246  *
1247  * @note this function isn't guaranteed to open all the codecs, so
1248  *       options being non-empty at return is a perfectly normal behavior.
1249  *
1250  * @todo Let the user decide somehow what information is needed so that
1251  *       we do not waste time getting stuff the user does not need.
1252  */
1253 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1254
1255 /**
1256  * Find the "best" stream in the file.
1257  * The best stream is determined according to various heuristics as the most
1258  * likely to be what the user expects.
1259  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1260  * default decoder for the stream's codec; streams for which no decoder can
1261  * be found are ignored.
1262  *
1263  * @param ic                media file handle
1264  * @param type              stream type: video, audio, subtitles, etc.
1265  * @param wanted_stream_nb  user-requested stream number,
1266  *                          or -1 for automatic selection
1267  * @param related_stream    try to find a stream related (eg. in the same
1268  *                          program) to this one, or -1 if none
1269  * @param decoder_ret       if non-NULL, returns the decoder for the
1270  *                          selected stream
1271  * @param flags             flags; none are currently defined
1272  * @return  the non-negative stream number in case of success,
1273  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1274  *          could be found,
1275  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1276  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1277  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1278  */
1279 int av_find_best_stream(AVFormatContext *ic,
1280                         enum AVMediaType type,
1281                         int wanted_stream_nb,
1282                         int related_stream,
1283                         AVCodec **decoder_ret,
1284                         int flags);
1285
1286 /**
1287  * Return the next frame of a stream.
1288  * This function returns what is stored in the file, and does not validate
1289  * that what is there are valid frames for the decoder. It will split what is
1290  * stored in the file into frames and return one for each call. It will not
1291  * omit invalid data between valid frames so as to give the decoder the maximum
1292  * information possible for decoding.
1293  *
1294  * If pkt->buf is NULL, then the packet is valid until the next
1295  * av_read_frame() or until av_close_input_file(). Otherwise the packet is valid
1296  * indefinitely. In both cases the packet must be freed with
1297  * av_free_packet when it is no longer needed. For video, the packet contains
1298  * exactly one frame. For audio, it contains an integer number of frames if each
1299  * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1300  * have a variable size (e.g. MPEG audio), then it contains one frame.
1301  *
1302  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1303  * values in AVStream.time_base units (and guessed if the format cannot
1304  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1305  * has B-frames, so it is better to rely on pkt->dts if you do not
1306  * decompress the payload.
1307  *
1308  * @return 0 if OK, < 0 on error or end of file
1309  */
1310 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1311
1312 /**
1313  * Seek to the keyframe at timestamp.
1314  * 'timestamp' in 'stream_index'.
1315  * @param stream_index If stream_index is (-1), a default
1316  * stream is selected, and timestamp is automatically converted
1317  * from AV_TIME_BASE units to the stream specific time_base.
1318  * @param timestamp Timestamp in AVStream.time_base units
1319  *        or, if no stream is specified, in AV_TIME_BASE units.
1320  * @param flags flags which select direction and seeking mode
1321  * @return >= 0 on success
1322  */
1323 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1324                   int flags);
1325
1326 /**
1327  * Seek to timestamp ts.
1328  * Seeking will be done so that the point from which all active streams
1329  * can be presented successfully will be closest to ts and within min/max_ts.
1330  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1331  *
1332  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1333  * are the file position (this may not be supported by all demuxers).
1334  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1335  * in the stream with stream_index (this may not be supported by all demuxers).
1336  * Otherwise all timestamps are in units of the stream selected by stream_index
1337  * or if stream_index is -1, in AV_TIME_BASE units.
1338  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1339  * keyframes (this may not be supported by all demuxers).
1340  *
1341  * @param stream_index index of the stream which is used as time base reference
1342  * @param min_ts smallest acceptable timestamp
1343  * @param ts target timestamp
1344  * @param max_ts largest acceptable timestamp
1345  * @param flags flags
1346  * @return >=0 on success, error code otherwise
1347  *
1348  * @note This is part of the new seek API which is still under construction.
1349  *       Thus do not use this yet. It may change at any time, do not expect
1350  *       ABI compatibility yet!
1351  */
1352 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1353
1354 /**
1355  * Start playing a network-based stream (e.g. RTSP stream) at the
1356  * current position.
1357  */
1358 int av_read_play(AVFormatContext *s);
1359
1360 /**
1361  * Pause a network-based stream (e.g. RTSP stream).
1362  *
1363  * Use av_read_play() to resume it.
1364  */
1365 int av_read_pause(AVFormatContext *s);
1366
1367 /**
1368  * Close an opened input AVFormatContext. Free it and all its contents
1369  * and set *s to NULL.
1370  */
1371 void avformat_close_input(AVFormatContext **s);
1372 /**
1373  * @}
1374  */
1375
1376 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1377 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1378 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1379 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1380
1381 /**
1382  * @addtogroup lavf_encoding
1383  * @{
1384  */
1385 /**
1386  * Allocate the stream private data and write the stream header to
1387  * an output media file.
1388  *
1389  * @param s Media file handle, must be allocated with avformat_alloc_context().
1390  *          Its oformat field must be set to the desired output format;
1391  *          Its pb field must be set to an already openened AVIOContext.
1392  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1393  *                 On return this parameter will be destroyed and replaced with a dict containing
1394  *                 options that were not found. May be NULL.
1395  *
1396  * @return 0 on success, negative AVERROR on failure.
1397  *
1398  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1399  */
1400 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1401
1402 /**
1403  * Write a packet to an output media file.
1404  *
1405  * The packet shall contain one audio or video frame.
1406  * The packet must be correctly interleaved according to the container
1407  * specification, if not then av_interleaved_write_frame must be used.
1408  *
1409  * @param s media file handle
1410  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1411  *            dts/pts, ...
1412  *            This can be NULL (at any time, not just at the end), in
1413  *            order to immediately flush data buffered within the muxer,
1414  *            for muxers that buffer up data internally before writing it
1415  *            to the output.
1416  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1417  */
1418 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1419
1420 /**
1421  * Write a packet to an output media file ensuring correct interleaving.
1422  *
1423  * The packet must contain one audio or video frame.
1424  * If the packets are already correctly interleaved, the application should
1425  * call av_write_frame() instead as it is slightly faster. It is also important
1426  * to keep in mind that completely non-interleaved input will need huge amounts
1427  * of memory to interleave with this, so it is preferable to interleave at the
1428  * demuxer level.
1429  *
1430  * @param s media file handle
1431  * @param pkt The packet containing the data to be written. pkt->buf must be set
1432  * to a valid AVBufferRef describing the packet data. Libavformat takes
1433  * ownership of this reference and will unref it when it sees fit. The caller
1434  * must not access the data through this reference after this function returns.
1435  * This can be NULL (at any time, not just at the end), to flush the
1436  * interleaving queues.
1437  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1438  * index of the corresponding stream in @ref AVFormatContext.streams
1439  * "s.streams".
1440  * It is very strongly recommended that timing information (@ref AVPacket.pts
1441  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1442  * correct values.
1443  *
1444  * @return 0 on success, a negative AVERROR on error.
1445  */
1446 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1447
1448 /**
1449  * Write the stream trailer to an output media file and free the
1450  * file private data.
1451  *
1452  * May only be called after a successful call to avformat_write_header.
1453  *
1454  * @param s media file handle
1455  * @return 0 if OK, AVERROR_xxx on error
1456  */
1457 int av_write_trailer(AVFormatContext *s);
1458
1459 /**
1460  * Return the output format in the list of registered output formats
1461  * which best matches the provided parameters, or return NULL if
1462  * there is no match.
1463  *
1464  * @param short_name if non-NULL checks if short_name matches with the
1465  * names of the registered formats
1466  * @param filename if non-NULL checks if filename terminates with the
1467  * extensions of the registered formats
1468  * @param mime_type if non-NULL checks if mime_type matches with the
1469  * MIME type of the registered formats
1470  */
1471 AVOutputFormat *av_guess_format(const char *short_name,
1472                                 const char *filename,
1473                                 const char *mime_type);
1474
1475 /**
1476  * Guess the codec ID based upon muxer and filename.
1477  */
1478 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1479                             const char *filename, const char *mime_type,
1480                             enum AVMediaType type);
1481
1482 /**
1483  * @}
1484  */
1485
1486
1487 /**
1488  * @defgroup lavf_misc Utility functions
1489  * @ingroup libavf
1490  * @{
1491  *
1492  * Miscellaneous utility functions related to both muxing and demuxing
1493  * (or neither).
1494  */
1495
1496 /**
1497  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1498  *
1499  * @param f The file stream pointer where the dump should be sent to.
1500  * @param buf buffer
1501  * @param size buffer size
1502  *
1503  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1504  */
1505 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
1506
1507 /**
1508  * Send a nice hexadecimal dump of a buffer to the log.
1509  *
1510  * @param avcl A pointer to an arbitrary struct of which the first field is a
1511  * pointer to an AVClass struct.
1512  * @param level The importance level of the message, lower values signifying
1513  * higher importance.
1514  * @param buf buffer
1515  * @param size buffer size
1516  *
1517  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1518  */
1519 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
1520
1521 /**
1522  * Send a nice dump of a packet to the specified file stream.
1523  *
1524  * @param f The file stream pointer where the dump should be sent to.
1525  * @param pkt packet to dump
1526  * @param dump_payload True if the payload must be displayed, too.
1527  * @param st AVStream that the packet belongs to
1528  */
1529 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1530
1531
1532 /**
1533  * Send a nice dump of a packet to the log.
1534  *
1535  * @param avcl A pointer to an arbitrary struct of which the first field is a
1536  * pointer to an AVClass struct.
1537  * @param level The importance level of the message, lower values signifying
1538  * higher importance.
1539  * @param pkt packet to dump
1540  * @param dump_payload True if the payload must be displayed, too.
1541  * @param st AVStream that the packet belongs to
1542  */
1543 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1544                       AVStream *st);
1545
1546 /**
1547  * Get the AVCodecID for the given codec tag tag.
1548  * If no codec id is found returns AV_CODEC_ID_NONE.
1549  *
1550  * @param tags list of supported codec_id-codec_tag pairs, as stored
1551  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1552  */
1553 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1554
1555 /**
1556  * Get the codec tag for the given codec id id.
1557  * If no codec tag is found returns 0.
1558  *
1559  * @param tags list of supported codec_id-codec_tag pairs, as stored
1560  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1561  */
1562 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
1563
1564 int av_find_default_stream_index(AVFormatContext *s);
1565
1566 /**
1567  * Get the index for a specific timestamp.
1568  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1569  *                 to the timestamp which is <= the requested one, if backward
1570  *                 is 0, then it will be >=
1571  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1572  * @return < 0 if no such timestamp could be found
1573  */
1574 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1575
1576 /**
1577  * Add an index entry into a sorted list. Update the entry if the list
1578  * already contains it.
1579  *
1580  * @param timestamp timestamp in the time base of the given stream
1581  */
1582 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1583                        int size, int distance, int flags);
1584
1585
1586 /**
1587  * Split a URL string into components.
1588  *
1589  * The pointers to buffers for storing individual components may be null,
1590  * in order to ignore that component. Buffers for components not found are
1591  * set to empty strings. If the port is not found, it is set to a negative
1592  * value.
1593  *
1594  * @param proto the buffer for the protocol
1595  * @param proto_size the size of the proto buffer
1596  * @param authorization the buffer for the authorization
1597  * @param authorization_size the size of the authorization buffer
1598  * @param hostname the buffer for the host name
1599  * @param hostname_size the size of the hostname buffer
1600  * @param port_ptr a pointer to store the port number in
1601  * @param path the buffer for the path
1602  * @param path_size the size of the path buffer
1603  * @param url the URL to split
1604  */
1605 void av_url_split(char *proto,         int proto_size,
1606                   char *authorization, int authorization_size,
1607                   char *hostname,      int hostname_size,
1608                   int *port_ptr,
1609                   char *path,          int path_size,
1610                   const char *url);
1611
1612
1613 void av_dump_format(AVFormatContext *ic,
1614                     int index,
1615                     const char *url,
1616                     int is_output);
1617
1618 /**
1619  * Return in 'buf' the path with '%d' replaced by a number.
1620  *
1621  * Also handles the '%0nd' format where 'n' is the total number
1622  * of digits and '%%'.
1623  *
1624  * @param buf destination buffer
1625  * @param buf_size destination buffer size
1626  * @param path numbered sequence string
1627  * @param number frame number
1628  * @return 0 if OK, -1 on format error
1629  */
1630 int av_get_frame_filename(char *buf, int buf_size,
1631                           const char *path, int number);
1632
1633 /**
1634  * Check whether filename actually is a numbered sequence generator.
1635  *
1636  * @param filename possible numbered sequence string
1637  * @return 1 if a valid numbered sequence string, 0 otherwise
1638  */
1639 int av_filename_number_test(const char *filename);
1640
1641 /**
1642  * Generate an SDP for an RTP session.
1643  *
1644  * Note, this overwrites the id values of AVStreams in the muxer contexts
1645  * for getting unique dynamic payload types.
1646  *
1647  * @param ac array of AVFormatContexts describing the RTP streams. If the
1648  *           array is composed by only one context, such context can contain
1649  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1650  *           all the contexts in the array (an AVCodecContext per RTP stream)
1651  *           must contain only one AVStream.
1652  * @param n_files number of AVCodecContexts contained in ac
1653  * @param buf buffer where the SDP will be stored (must be allocated by
1654  *            the caller)
1655  * @param size the size of the buffer
1656  * @return 0 if OK, AVERROR_xxx on error
1657  */
1658 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1659
1660 /**
1661  * Return a positive value if the given filename has one of the given
1662  * extensions, 0 otherwise.
1663  *
1664  * @param extensions a comma-separated list of filename extensions
1665  */
1666 int av_match_ext(const char *filename, const char *extensions);
1667
1668 /**
1669  * Test if the given container can store a codec.
1670  *
1671  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1672  *
1673  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1674  *         A negative number if this information is not available.
1675  */
1676 int avformat_query_codec(AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance);
1677
1678 /**
1679  * @defgroup riff_fourcc RIFF FourCCs
1680  * @{
1681  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
1682  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1683  * following code:
1684  * @code
1685  * uint32_t tag = MKTAG('H', '2', '6', '4');
1686  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1687  * enum AVCodecID id = av_codec_get_id(table, tag);
1688  * @endcode
1689  */
1690 /**
1691  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
1692  */
1693 const struct AVCodecTag *avformat_get_riff_video_tags(void);
1694 /**
1695  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
1696  */
1697 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1698 /**
1699  * @}
1700  */
1701
1702 /**
1703  * @}
1704  */
1705
1706 #endif /* AVFORMAT_AVFORMAT_H */