lavf: Add a flag to enable/disable per-packet flushing
[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_EXTENSION  50 ///< score for file extension
341 #define AVPROBE_SCORE_MAX       100 ///< maximum score
342
343 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
344
345 /// Demuxer will use avio_open, no opened file should be provided by the caller.
346 #define AVFMT_NOFILE        0x0001
347 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
348 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
349 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
350                                       raw picture data. */
351 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
352 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
353 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
354 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
355 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
356 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
357 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
358 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
359 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fall back on generic search */
360 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
361 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
362 #define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
363                                         increasing timestamps, but they must
364                                         still be monotonic */
365 #define AVFMT_TS_NEGATIVE  0x40000 /**< Format allows muxing negative
366                                         timestamps. If not set the timestamp
367                                         will be shifted in av_write_frame and
368                                         av_interleaved_write_frame so they
369                                         start from 0. */
370
371 /**
372  * @addtogroup lavf_encoding
373  * @{
374  */
375 typedef struct AVOutputFormat {
376     const char *name;
377     /**
378      * Descriptive name for the format, meant to be more human-readable
379      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
380      * to define it.
381      */
382     const char *long_name;
383     const char *mime_type;
384     const char *extensions; /**< comma-separated filename extensions */
385     /* output support */
386     enum AVCodecID audio_codec;    /**< default audio codec */
387     enum AVCodecID video_codec;    /**< default video codec */
388     enum AVCodecID subtitle_codec; /**< default subtitle codec */
389     /**
390      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
391      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
392      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
393      * AVFMT_TS_NONSTRICT
394      */
395     int flags;
396
397     /**
398      * List of supported codec_id-codec_tag pairs, ordered by "better
399      * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
400      */
401     const struct AVCodecTag * const *codec_tag;
402
403
404     const AVClass *priv_class; ///< AVClass for the private context
405
406     /*****************************************************************
407      * No fields below this line are part of the public API. They
408      * may not be used outside of libavformat and can be changed and
409      * removed at will.
410      * New public fields should be added right above.
411      *****************************************************************
412      */
413     struct AVOutputFormat *next;
414     /**
415      * size of private data so that it can be allocated in the wrapper
416      */
417     int priv_data_size;
418
419     int (*write_header)(struct AVFormatContext *);
420     /**
421      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
422      * pkt can be NULL in order to flush data buffered in the muxer.
423      * When flushing, return 0 if there still is more data to flush,
424      * or 1 if everything was flushed and there is no more buffered
425      * data.
426      */
427     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
428     int (*write_trailer)(struct AVFormatContext *);
429     /**
430      * Currently only used to set pixel format if not YUV420P.
431      */
432     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
433                              AVPacket *in, int flush);
434     /**
435      * Test if the given codec can be stored in this container.
436      *
437      * @return 1 if the codec is supported, 0 if it is not.
438      *         A negative number if unknown.
439      */
440     int (*query_codec)(enum AVCodecID id, int std_compliance);
441 } AVOutputFormat;
442 /**
443  * @}
444  */
445
446 /**
447  * @addtogroup lavf_decoding
448  * @{
449  */
450 typedef struct AVInputFormat {
451     /**
452      * A comma separated list of short names for the format. New names
453      * may be appended with a minor bump.
454      */
455     const char *name;
456
457     /**
458      * Descriptive name for the format, meant to be more human-readable
459      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
460      * to define it.
461      */
462     const char *long_name;
463
464     /**
465      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
466      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
467      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
468      */
469     int flags;
470
471     /**
472      * If extensions are defined, then no probe is done. You should
473      * usually not use extension format guessing because it is not
474      * reliable enough
475      */
476     const char *extensions;
477
478     const struct AVCodecTag * const *codec_tag;
479
480     const AVClass *priv_class; ///< AVClass for the private context
481
482     /*****************************************************************
483      * No fields below this line are part of the public API. They
484      * may not be used outside of libavformat and can be changed and
485      * removed at will.
486      * New public fields should be added right above.
487      *****************************************************************
488      */
489     struct AVInputFormat *next;
490
491     /**
492      * Raw demuxers store their codec ID here.
493      */
494     int raw_codec_id;
495
496     /**
497      * Size of private data so that it can be allocated in the wrapper.
498      */
499     int priv_data_size;
500
501     /**
502      * Tell if a given file has a chance of being parsed as this format.
503      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
504      * big so you do not have to check for that unless you need more.
505      */
506     int (*read_probe)(AVProbeData *);
507
508     /**
509      * Read the format header and initialize the AVFormatContext
510      * structure. Return 0 if OK. Only used in raw format right
511      * now. 'avformat_new_stream' should be called to create new streams.
512      */
513     int (*read_header)(struct AVFormatContext *);
514
515     /**
516      * Read one packet and put it in 'pkt'. pts and flags are also
517      * set. 'avformat_new_stream' can be called only if the flag
518      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
519      * background thread).
520      * @return 0 on success, < 0 on error.
521      *         When returning an error, pkt must not have been allocated
522      *         or must be freed before returning
523      */
524     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
525
526     /**
527      * Close the stream. The AVFormatContext and AVStreams are not
528      * freed by this function
529      */
530     int (*read_close)(struct AVFormatContext *);
531
532     /**
533      * Seek to a given timestamp relative to the frames in
534      * stream component stream_index.
535      * @param stream_index Must not be -1.
536      * @param flags Selects which direction should be preferred if no exact
537      *              match is available.
538      * @return >= 0 on success (but not necessarily the new offset)
539      */
540     int (*read_seek)(struct AVFormatContext *,
541                      int stream_index, int64_t timestamp, int flags);
542
543     /**
544      * Get the next timestamp in stream[stream_index].time_base units.
545      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
546      */
547     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
548                               int64_t *pos, int64_t pos_limit);
549
550     /**
551      * Start/resume playing - only meaningful if using a network-based format
552      * (RTSP).
553      */
554     int (*read_play)(struct AVFormatContext *);
555
556     /**
557      * Pause playing - only meaningful if using a network-based format
558      * (RTSP).
559      */
560     int (*read_pause)(struct AVFormatContext *);
561
562     /**
563      * Seek to timestamp ts.
564      * Seeking will be done so that the point from which all active streams
565      * can be presented successfully will be closest to ts and within min/max_ts.
566      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
567      */
568     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
569 } AVInputFormat;
570 /**
571  * @}
572  */
573
574 enum AVStreamParseType {
575     AVSTREAM_PARSE_NONE,
576     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
577     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
578     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
579     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
580 };
581
582 typedef struct AVIndexEntry {
583     int64_t pos;
584     int64_t timestamp;
585 #define AVINDEX_KEYFRAME 0x0001
586     int flags:2;
587     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).
588     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
589 } AVIndexEntry;
590
591 #define AV_DISPOSITION_DEFAULT   0x0001
592 #define AV_DISPOSITION_DUB       0x0002
593 #define AV_DISPOSITION_ORIGINAL  0x0004
594 #define AV_DISPOSITION_COMMENT   0x0008
595 #define AV_DISPOSITION_LYRICS    0x0010
596 #define AV_DISPOSITION_KARAOKE   0x0020
597
598 /**
599  * Track should be used during playback by default.
600  * Useful for subtitle track that should be displayed
601  * even when user did not explicitly ask for subtitles.
602  */
603 #define AV_DISPOSITION_FORCED    0x0040
604 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
605 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
606 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
607 /**
608  * The stream is stored in the file as an attached picture/"cover art" (e.g.
609  * APIC frame in ID3v2). The single packet associated with it will be returned
610  * among the first few packets read from the file unless seeking takes place.
611  * It can also be accessed at any time in AVStream.attached_pic.
612  */
613 #define AV_DISPOSITION_ATTACHED_PIC      0x0400
614
615 /**
616  * Stream structure.
617  * New fields can be added to the end with minor version bumps.
618  * Removal, reordering and changes to existing fields require a major
619  * version bump.
620  * sizeof(AVStream) must not be used outside libav*.
621  */
622 typedef struct AVStream {
623     int index;    /**< stream index in AVFormatContext */
624     /**
625      * Format-specific stream ID.
626      * decoding: set by libavformat
627      * encoding: set by the user, replaced by libavformat if left unset
628      */
629     int id;
630     /**
631      * Codec context associated with this stream. Allocated and freed by
632      * libavformat.
633      *
634      * - decoding: The demuxer exports codec information stored in the headers
635      *             here.
636      * - encoding: The user sets codec information, the muxer writes it to the
637      *             output. Mandatory fields as specified in AVCodecContext
638      *             documentation must be set even if this AVCodecContext is
639      *             not actually used for encoding.
640      */
641     AVCodecContext *codec;
642     void *priv_data;
643
644     /**
645      * encoding: pts generation when outputting stream
646      */
647     struct AVFrac pts;
648
649     /**
650      * This is the fundamental unit of time (in seconds) in terms
651      * of which frame timestamps are represented.
652      *
653      * decoding: set by libavformat
654      * encoding: set by libavformat in avformat_write_header. The muxer may use the
655      * user-provided value of @ref AVCodecContext.time_base "codec->time_base"
656      * as a hint.
657      */
658     AVRational time_base;
659
660     /**
661      * Decoding: pts of the first frame of the stream, in stream time base.
662      * Only set this if you are absolutely 100% sure that the value you set
663      * it to really is the pts of the first frame.
664      * This may be undefined (AV_NOPTS_VALUE).
665      */
666     int64_t start_time;
667
668     /**
669      * Decoding: duration of the stream, in stream time base.
670      * If a source file does not specify a duration, but does specify
671      * a bitrate, this value will be estimated from bitrate and file size.
672      */
673     int64_t duration;
674
675     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
676
677     int disposition; /**< AV_DISPOSITION_* bit field */
678
679     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
680
681     /**
682      * sample aspect ratio (0 if unknown)
683      * - encoding: Set by user.
684      * - decoding: Set by libavformat.
685      */
686     AVRational sample_aspect_ratio;
687
688     AVDictionary *metadata;
689
690     /**
691      * Average framerate
692      */
693     AVRational avg_frame_rate;
694
695     /**
696      * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
697      * will contain the attached picture.
698      *
699      * decoding: set by libavformat, must not be modified by the caller.
700      * encoding: unused
701      */
702     AVPacket attached_pic;
703
704     /*****************************************************************
705      * All fields below this line are not part of the public API. They
706      * may not be used outside of libavformat and can be changed and
707      * removed at will.
708      * New public fields should be added right above.
709      *****************************************************************
710      */
711
712     /**
713      * Stream information used internally by av_find_stream_info()
714      */
715 #define MAX_STD_TIMEBASES (60*12+5)
716     struct {
717         int nb_decoded_frames;
718         int found_decoder;
719
720         /**
721          * Those are used for average framerate estimation.
722          */
723         int64_t fps_first_dts;
724         int     fps_first_dts_idx;
725         int64_t fps_last_dts;
726         int     fps_last_dts_idx;
727
728     } *info;
729
730     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
731
732     // Timestamp generation support:
733     /**
734      * Timestamp corresponding to the last dts sync point.
735      *
736      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
737      * a DTS is received from the underlying container. Otherwise set to
738      * AV_NOPTS_VALUE by default.
739      */
740     int64_t reference_dts;
741     int64_t first_dts;
742     int64_t cur_dts;
743     int64_t last_IP_pts;
744     int last_IP_duration;
745
746     /**
747      * Number of packets to buffer for codec probing
748      */
749 #define MAX_PROBE_PACKETS 2500
750     int probe_packets;
751
752     /**
753      * Number of frames that have been demuxed during av_find_stream_info()
754      */
755     int codec_info_nb_frames;
756
757     /* av_read_frame() support */
758     enum AVStreamParseType need_parsing;
759     struct AVCodecParserContext *parser;
760
761     /**
762      * last packet in packet_buffer for this stream when muxing.
763      */
764     struct AVPacketList *last_in_packet_buffer;
765     AVProbeData probe_data;
766 #define MAX_REORDER_DELAY 16
767     int64_t pts_buffer[MAX_REORDER_DELAY+1];
768
769     AVIndexEntry *index_entries; /**< Only used if the format does not
770                                     support seeking natively. */
771     int nb_index_entries;
772     unsigned int index_entries_allocated_size;
773 } AVStream;
774
775 #define AV_PROGRAM_RUNNING 1
776
777 /**
778  * New fields can be added to the end with minor version bumps.
779  * Removal, reordering and changes to existing fields require a major
780  * version bump.
781  * sizeof(AVProgram) must not be used outside libav*.
782  */
783 typedef struct AVProgram {
784     int            id;
785     int            flags;
786     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
787     unsigned int   *stream_index;
788     unsigned int   nb_stream_indexes;
789     AVDictionary *metadata;
790 } AVProgram;
791
792 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
793                                          (streams are added dynamically) */
794
795 typedef struct AVChapter {
796     int id;                 ///< unique ID to identify the chapter
797     AVRational time_base;   ///< time base in which the start/end timestamps are specified
798     int64_t start, end;     ///< chapter start/end time in time_base units
799     AVDictionary *metadata;
800 } AVChapter;
801
802 /**
803  * Format I/O context.
804  * New fields can be added to the end with minor version bumps.
805  * Removal, reordering and changes to existing fields require a major
806  * version bump.
807  * sizeof(AVFormatContext) must not be used outside libav*, use
808  * avformat_alloc_context() to create an AVFormatContext.
809  */
810 typedef struct AVFormatContext {
811     /**
812      * A class for logging and AVOptions. Set by avformat_alloc_context().
813      * Exports (de)muxer private options if they exist.
814      */
815     const AVClass *av_class;
816
817     /**
818      * Can only be iformat or oformat, not both at the same time.
819      *
820      * decoding: set by avformat_open_input().
821      * encoding: set by the user.
822      */
823     struct AVInputFormat *iformat;
824     struct AVOutputFormat *oformat;
825
826     /**
827      * Format private data. This is an AVOptions-enabled struct
828      * if and only if iformat/oformat.priv_class is not NULL.
829      */
830     void *priv_data;
831
832     /**
833      * I/O context.
834      *
835      * decoding: either set by the user before avformat_open_input() (then
836      * the user must close it manually) or set by avformat_open_input().
837      * encoding: set by the user.
838      *
839      * Do NOT set this field if AVFMT_NOFILE flag is set in
840      * iformat/oformat.flags. In such a case, the (de)muxer will handle
841      * I/O in some other way and this field will be NULL.
842      */
843     AVIOContext *pb;
844
845     /* stream info */
846     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
847
848     /**
849      * A list of all streams in the file. New streams are created with
850      * avformat_new_stream().
851      *
852      * decoding: streams are created by libavformat in avformat_open_input().
853      * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
854      * appear in av_read_frame().
855      * encoding: streams are created by the user before avformat_write_header().
856      */
857     unsigned int nb_streams;
858     AVStream **streams;
859
860     char filename[1024]; /**< input or output filename */
861
862     /**
863      * Decoding: position of the first frame of the component, in
864      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
865      * It is deduced from the AVStream values.
866      */
867     int64_t start_time;
868
869     /**
870      * Decoding: duration of the stream, in AV_TIME_BASE fractional
871      * seconds. Only set this value if you know none of the individual stream
872      * durations and also do not set any of them. This is deduced from the
873      * AVStream values if not set.
874      */
875     int64_t duration;
876
877     /**
878      * Decoding: total stream bitrate in bit/s, 0 if not
879      * available. Never set it directly if the file_size and the
880      * duration are known as Libav can compute it automatically.
881      */
882     int bit_rate;
883
884     unsigned int packet_size;
885     int max_delay;
886
887     int flags;
888 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
889 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
890 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
891 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
892 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
893 #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
894 #define AVFMT_FLAG_NOBUFFER     0x0040 ///< Do not buffer frames when possible
895 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
896 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
897 #define AVFMT_FLAG_FLUSH_PACKETS    0x0200 ///< Flush the AVIOContext every packet.
898
899     /**
900      * decoding: size of data to probe; encoding: unused.
901      */
902     unsigned int probesize;
903
904     /**
905      * decoding: maximum time (in AV_TIME_BASE units) during which the input should
906      * be analyzed in avformat_find_stream_info().
907      */
908     int max_analyze_duration;
909
910     const uint8_t *key;
911     int keylen;
912
913     unsigned int nb_programs;
914     AVProgram **programs;
915
916     /**
917      * Forced video codec_id.
918      * Demuxing: Set by user.
919      */
920     enum AVCodecID video_codec_id;
921
922     /**
923      * Forced audio codec_id.
924      * Demuxing: Set by user.
925      */
926     enum AVCodecID audio_codec_id;
927
928     /**
929      * Forced subtitle codec_id.
930      * Demuxing: Set by user.
931      */
932     enum AVCodecID subtitle_codec_id;
933
934     /**
935      * Maximum amount of memory in bytes to use for the index of each stream.
936      * If the index exceeds this size, entries will be discarded as
937      * needed to maintain a smaller size. This can lead to slower or less
938      * accurate seeking (depends on demuxer).
939      * Demuxers for which a full in-memory index is mandatory will ignore
940      * this.
941      * muxing  : unused
942      * demuxing: set by user
943      */
944     unsigned int max_index_size;
945
946     /**
947      * Maximum amount of memory in bytes to use for buffering frames
948      * obtained from realtime capture devices.
949      */
950     unsigned int max_picture_buffer;
951
952     /**
953      * Number of chapters in AVChapter array.
954      * When muxing, chapters are normally written in the file header,
955      * so nb_chapters should normally be initialized before write_header
956      * is called. Some muxers (e.g. mov and mkv) can also write chapters
957      * in the trailer.  To write chapters in the trailer, nb_chapters
958      * must be zero when write_header is called and non-zero when
959      * write_trailer is called.
960      * muxing  : set by user
961      * demuxing: set by libavformat
962      */
963     unsigned int nb_chapters;
964     AVChapter **chapters;
965
966     AVDictionary *metadata;
967
968     /**
969      * Start time of the stream in real world time, in microseconds
970      * since the unix epoch (00:00 1st January 1970). That is, pts=0
971      * in the stream was captured at this real world time.
972      * - encoding: Set by user.
973      * - decoding: Unused.
974      */
975     int64_t start_time_realtime;
976
977     /**
978      * decoding: number of frames used to probe fps
979      */
980     int fps_probe_size;
981
982     /**
983      * Error recognition; higher values will detect more errors but may
984      * misdetect some more or less valid parts as errors.
985      * - encoding: unused
986      * - decoding: Set by user.
987      */
988     int error_recognition;
989
990     /**
991      * Custom interrupt callbacks for the I/O layer.
992      *
993      * decoding: set by the user before avformat_open_input().
994      * encoding: set by the user before avformat_write_header()
995      * (mainly useful for AVFMT_NOFILE formats). The callback
996      * should also be passed to avio_open2() if it's used to
997      * open the file.
998      */
999     AVIOInterruptCB interrupt_callback;
1000
1001     /**
1002      * Flags to enable debugging.
1003      */
1004     int debug;
1005 #define FF_FDEBUG_TS        0x0001
1006     /*****************************************************************
1007      * All fields below this line are not part of the public API. They
1008      * may not be used outside of libavformat and can be changed and
1009      * removed at will.
1010      * New public fields should be added right above.
1011      *****************************************************************
1012      */
1013
1014     /**
1015      * This buffer is only needed when packets were already buffered but
1016      * not decoded, for example to get the codec parameters in MPEG
1017      * streams.
1018      */
1019     struct AVPacketList *packet_buffer;
1020     struct AVPacketList *packet_buffer_end;
1021
1022     /* av_seek_frame() support */
1023     int64_t data_offset; /**< offset of the first packet */
1024
1025     /**
1026      * Raw packets from the demuxer, prior to parsing and decoding.
1027      * This buffer is used for buffering packets until the codec can
1028      * be identified, as parsing cannot be done without knowing the
1029      * codec.
1030      */
1031     struct AVPacketList *raw_packet_buffer;
1032     struct AVPacketList *raw_packet_buffer_end;
1033     /**
1034      * Packets split by the parser get queued here.
1035      */
1036     struct AVPacketList *parse_queue;
1037     struct AVPacketList *parse_queue_end;
1038     /**
1039      * Remaining size available for raw_packet_buffer, in bytes.
1040      */
1041 #define RAW_PACKET_BUFFER_SIZE 2500000
1042     int raw_packet_buffer_remaining_size;
1043
1044     /**
1045      * Offset to remap timestamps to be non-negative.
1046      * Expressed in timebase units.
1047      */
1048     int64_t offset;
1049
1050     /**
1051      * Timebase for the timestamp offset.
1052      */
1053     AVRational offset_timebase;
1054
1055 } AVFormatContext;
1056
1057 typedef struct AVPacketList {
1058     AVPacket pkt;
1059     struct AVPacketList *next;
1060 } AVPacketList;
1061
1062
1063 /**
1064  * @defgroup lavf_core Core functions
1065  * @ingroup libavf
1066  *
1067  * Functions for querying libavformat capabilities, allocating core structures,
1068  * etc.
1069  * @{
1070  */
1071
1072 /**
1073  * Return the LIBAVFORMAT_VERSION_INT constant.
1074  */
1075 unsigned avformat_version(void);
1076
1077 /**
1078  * Return the libavformat build-time configuration.
1079  */
1080 const char *avformat_configuration(void);
1081
1082 /**
1083  * Return the libavformat license.
1084  */
1085 const char *avformat_license(void);
1086
1087 /**
1088  * Initialize libavformat and register all the muxers, demuxers and
1089  * protocols. If you do not call this function, then you can select
1090  * exactly which formats you want to support.
1091  *
1092  * @see av_register_input_format()
1093  * @see av_register_output_format()
1094  * @see av_register_protocol()
1095  */
1096 void av_register_all(void);
1097
1098 void av_register_input_format(AVInputFormat *format);
1099 void av_register_output_format(AVOutputFormat *format);
1100
1101 /**
1102  * Do global initialization of network components. This is optional,
1103  * but recommended, since it avoids the overhead of implicitly
1104  * doing the setup for each session.
1105  *
1106  * Calling this function will become mandatory if using network
1107  * protocols at some major version bump.
1108  */
1109 int avformat_network_init(void);
1110
1111 /**
1112  * Undo the initialization done by avformat_network_init.
1113  */
1114 int avformat_network_deinit(void);
1115
1116 /**
1117  * If f is NULL, returns the first registered input format,
1118  * if f is non-NULL, returns the next registered input format after f
1119  * or NULL if f is the last one.
1120  */
1121 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1122
1123 /**
1124  * If f is NULL, returns the first registered output format,
1125  * if f is non-NULL, returns the next registered output format after f
1126  * or NULL if f is the last one.
1127  */
1128 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1129
1130 /**
1131  * Allocate an AVFormatContext.
1132  * avformat_free_context() can be used to free the context and everything
1133  * allocated by the framework within it.
1134  */
1135 AVFormatContext *avformat_alloc_context(void);
1136
1137 /**
1138  * Free an AVFormatContext and all its streams.
1139  * @param s context to free
1140  */
1141 void avformat_free_context(AVFormatContext *s);
1142
1143 /**
1144  * Get the AVClass for AVFormatContext. It can be used in combination with
1145  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1146  *
1147  * @see av_opt_find().
1148  */
1149 const AVClass *avformat_get_class(void);
1150
1151 /**
1152  * Add a new stream to a media file.
1153  *
1154  * When demuxing, it is called by the demuxer in read_header(). If the
1155  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1156  * be called in read_packet().
1157  *
1158  * When muxing, should be called by the user before avformat_write_header().
1159  *
1160  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1161  * will be initialized to use this codec. This is needed for e.g. codec-specific
1162  * defaults to be set, so codec should be provided if it is known.
1163  *
1164  * @return newly created stream or NULL on error.
1165  */
1166 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1167
1168 AVProgram *av_new_program(AVFormatContext *s, int id);
1169
1170 /**
1171  * @}
1172  */
1173
1174
1175 /**
1176  * @addtogroup lavf_decoding
1177  * @{
1178  */
1179
1180 /**
1181  * Find AVInputFormat based on the short name of the input format.
1182  */
1183 AVInputFormat *av_find_input_format(const char *short_name);
1184
1185 /**
1186  * Guess the file format.
1187  *
1188  * @param is_opened Whether the file is already opened; determines whether
1189  *                  demuxers with or without AVFMT_NOFILE are probed.
1190  */
1191 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1192
1193 /**
1194  * Guess the file format.
1195  *
1196  * @param is_opened Whether the file is already opened; determines whether
1197  *                  demuxers with or without AVFMT_NOFILE are probed.
1198  * @param score_max A probe score larger that this is required to accept a
1199  *                  detection, the variable is set to the actual detection
1200  *                  score afterwards.
1201  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1202  *                  to retry with a larger probe buffer.
1203  */
1204 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1205
1206 /**
1207  * Probe a bytestream to determine the input format. Each time a probe returns
1208  * with a score that is too low, the probe buffer size is increased and another
1209  * attempt is made. When the maximum probe size is reached, the input format
1210  * with the highest score is returned.
1211  *
1212  * @param pb the bytestream to probe
1213  * @param fmt the input format is put here
1214  * @param filename the filename of the stream
1215  * @param logctx the log context
1216  * @param offset the offset within the bytestream to probe from
1217  * @param max_probe_size the maximum probe buffer size (zero for default)
1218  * @return 0 in case of success, a negative value corresponding to an
1219  * AVERROR code otherwise
1220  */
1221 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1222                           const char *filename, void *logctx,
1223                           unsigned int offset, unsigned int max_probe_size);
1224
1225 /**
1226  * Open an input stream and read the header. The codecs are not opened.
1227  * The stream must be closed with avformat_close_input().
1228  *
1229  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1230  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1231  *           function and written into ps.
1232  *           Note that a user-supplied AVFormatContext will be freed on failure.
1233  * @param filename Name of the stream to open.
1234  * @param fmt If non-NULL, this parameter forces a specific input format.
1235  *            Otherwise the format is autodetected.
1236  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1237  *                 On return this parameter will be destroyed and replaced with a dict containing
1238  *                 options that were not found. May be NULL.
1239  *
1240  * @return 0 on success, a negative AVERROR on failure.
1241  *
1242  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1243  */
1244 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1245
1246 /**
1247  * Read packets of a media file to get stream information. This
1248  * is useful for file formats with no headers such as MPEG. This
1249  * function also computes the real framerate in case of MPEG-2 repeat
1250  * frame mode.
1251  * The logical file position is not changed by this function;
1252  * examined packets may be buffered for later processing.
1253  *
1254  * @param ic media file handle
1255  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1256  *                 dictionaries, where i-th member contains options for
1257  *                 codec corresponding to i-th stream.
1258  *                 On return each dictionary will be filled with options that were not found.
1259  * @return >=0 if OK, AVERROR_xxx on error
1260  *
1261  * @note this function isn't guaranteed to open all the codecs, so
1262  *       options being non-empty at return is a perfectly normal behavior.
1263  *
1264  * @todo Let the user decide somehow what information is needed so that
1265  *       we do not waste time getting stuff the user does not need.
1266  */
1267 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1268
1269 /**
1270  * Find the "best" stream in the file.
1271  * The best stream is determined according to various heuristics as the most
1272  * likely to be what the user expects.
1273  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1274  * default decoder for the stream's codec; streams for which no decoder can
1275  * be found are ignored.
1276  *
1277  * @param ic                media file handle
1278  * @param type              stream type: video, audio, subtitles, etc.
1279  * @param wanted_stream_nb  user-requested stream number,
1280  *                          or -1 for automatic selection
1281  * @param related_stream    try to find a stream related (eg. in the same
1282  *                          program) to this one, or -1 if none
1283  * @param decoder_ret       if non-NULL, returns the decoder for the
1284  *                          selected stream
1285  * @param flags             flags; none are currently defined
1286  * @return  the non-negative stream number in case of success,
1287  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1288  *          could be found,
1289  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1290  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1291  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1292  */
1293 int av_find_best_stream(AVFormatContext *ic,
1294                         enum AVMediaType type,
1295                         int wanted_stream_nb,
1296                         int related_stream,
1297                         AVCodec **decoder_ret,
1298                         int flags);
1299
1300 /**
1301  * Return the next frame of a stream.
1302  * This function returns what is stored in the file, and does not validate
1303  * that what is there are valid frames for the decoder. It will split what is
1304  * stored in the file into frames and return one for each call. It will not
1305  * omit invalid data between valid frames so as to give the decoder the maximum
1306  * information possible for decoding.
1307  *
1308  * If pkt->buf is NULL, then the packet is valid until the next
1309  * av_read_frame() or until avformat_close_input(). Otherwise the packet
1310  * is valid indefinitely. In both cases the packet must be freed with
1311  * av_free_packet when it is no longer needed. For video, the packet contains
1312  * exactly one frame. For audio, it contains an integer number of frames if each
1313  * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1314  * have a variable size (e.g. MPEG audio), then it contains one frame.
1315  *
1316  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1317  * values in AVStream.time_base units (and guessed if the format cannot
1318  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1319  * has B-frames, so it is better to rely on pkt->dts if you do not
1320  * decompress the payload.
1321  *
1322  * @return 0 if OK, < 0 on error or end of file
1323  */
1324 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1325
1326 /**
1327  * Seek to the keyframe at timestamp.
1328  * 'timestamp' in 'stream_index'.
1329  * @param stream_index If stream_index is (-1), a default
1330  * stream is selected, and timestamp is automatically converted
1331  * from AV_TIME_BASE units to the stream specific time_base.
1332  * @param timestamp Timestamp in AVStream.time_base units
1333  *        or, if no stream is specified, in AV_TIME_BASE units.
1334  * @param flags flags which select direction and seeking mode
1335  * @return >= 0 on success
1336  */
1337 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1338                   int flags);
1339
1340 /**
1341  * Seek to timestamp ts.
1342  * Seeking will be done so that the point from which all active streams
1343  * can be presented successfully will be closest to ts and within min/max_ts.
1344  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1345  *
1346  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1347  * are the file position (this may not be supported by all demuxers).
1348  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1349  * in the stream with stream_index (this may not be supported by all demuxers).
1350  * Otherwise all timestamps are in units of the stream selected by stream_index
1351  * or if stream_index is -1, in AV_TIME_BASE units.
1352  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1353  * keyframes (this may not be supported by all demuxers).
1354  *
1355  * @param stream_index index of the stream which is used as time base reference
1356  * @param min_ts smallest acceptable timestamp
1357  * @param ts target timestamp
1358  * @param max_ts largest acceptable timestamp
1359  * @param flags flags
1360  * @return >=0 on success, error code otherwise
1361  *
1362  * @note This is part of the new seek API which is still under construction.
1363  *       Thus do not use this yet. It may change at any time, do not expect
1364  *       ABI compatibility yet!
1365  */
1366 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1367
1368 /**
1369  * Start playing a network-based stream (e.g. RTSP stream) at the
1370  * current position.
1371  */
1372 int av_read_play(AVFormatContext *s);
1373
1374 /**
1375  * Pause a network-based stream (e.g. RTSP stream).
1376  *
1377  * Use av_read_play() to resume it.
1378  */
1379 int av_read_pause(AVFormatContext *s);
1380
1381 /**
1382  * Close an opened input AVFormatContext. Free it and all its contents
1383  * and set *s to NULL.
1384  */
1385 void avformat_close_input(AVFormatContext **s);
1386 /**
1387  * @}
1388  */
1389
1390 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1391 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1392 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1393 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1394
1395 /**
1396  * @addtogroup lavf_encoding
1397  * @{
1398  */
1399 /**
1400  * Allocate the stream private data and write the stream header to
1401  * an output media file.
1402  *
1403  * @param s Media file handle, must be allocated with avformat_alloc_context().
1404  *          Its oformat field must be set to the desired output format;
1405  *          Its pb field must be set to an already opened AVIOContext.
1406  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1407  *                 On return this parameter will be destroyed and replaced with a dict containing
1408  *                 options that were not found. May be NULL.
1409  *
1410  * @return 0 on success, negative AVERROR on failure.
1411  *
1412  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1413  */
1414 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1415
1416 /**
1417  * Write a packet to an output media file.
1418  *
1419  * The packet shall contain one audio or video frame.
1420  * The packet must be correctly interleaved according to the container
1421  * specification, if not then av_interleaved_write_frame must be used.
1422  *
1423  * @param s media file handle
1424  * @param pkt The packet, which contains the stream_index, buf/buf_size,
1425  *            dts/pts, ...
1426  *            This can be NULL (at any time, not just at the end), in
1427  *            order to immediately flush data buffered within the muxer,
1428  *            for muxers that buffer up data internally before writing it
1429  *            to the output.
1430  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1431  */
1432 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1433
1434 /**
1435  * Write a packet to an output media file ensuring correct interleaving.
1436  *
1437  * The packet must contain one audio or video frame.
1438  * If the packets are already correctly interleaved, the application should
1439  * call av_write_frame() instead as it is slightly faster. It is also important
1440  * to keep in mind that completely non-interleaved input will need huge amounts
1441  * of memory to interleave with this, so it is preferable to interleave at the
1442  * demuxer level.
1443  *
1444  * @param s media file handle
1445  * @param pkt The packet containing the data to be written. pkt->buf must be set
1446  * to a valid AVBufferRef describing the packet data. Libavformat takes
1447  * ownership of this reference and will unref it when it sees fit. The caller
1448  * must not access the data through this reference after this function returns.
1449  * This can be NULL (at any time, not just at the end), to flush the
1450  * interleaving queues.
1451  * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1452  * index of the corresponding stream in @ref AVFormatContext.streams
1453  * "s.streams".
1454  * It is very strongly recommended that timing information (@ref AVPacket.pts
1455  * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1456  * correct values.
1457  *
1458  * @return 0 on success, a negative AVERROR on error.
1459  */
1460 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1461
1462 /**
1463  * Write the stream trailer to an output media file and free the
1464  * file private data.
1465  *
1466  * May only be called after a successful call to avformat_write_header.
1467  *
1468  * @param s media file handle
1469  * @return 0 if OK, AVERROR_xxx on error
1470  */
1471 int av_write_trailer(AVFormatContext *s);
1472
1473 /**
1474  * Return the output format in the list of registered output formats
1475  * which best matches the provided parameters, or return NULL if
1476  * there is no match.
1477  *
1478  * @param short_name if non-NULL checks if short_name matches with the
1479  * names of the registered formats
1480  * @param filename if non-NULL checks if filename terminates with the
1481  * extensions of the registered formats
1482  * @param mime_type if non-NULL checks if mime_type matches with the
1483  * MIME type of the registered formats
1484  */
1485 AVOutputFormat *av_guess_format(const char *short_name,
1486                                 const char *filename,
1487                                 const char *mime_type);
1488
1489 /**
1490  * Guess the codec ID based upon muxer and filename.
1491  */
1492 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1493                             const char *filename, const char *mime_type,
1494                             enum AVMediaType type);
1495
1496 /**
1497  * @}
1498  */
1499
1500
1501 /**
1502  * @defgroup lavf_misc Utility functions
1503  * @ingroup libavf
1504  * @{
1505  *
1506  * Miscellaneous utility functions related to both muxing and demuxing
1507  * (or neither).
1508  */
1509
1510 /**
1511  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1512  *
1513  * @param f The file stream pointer where the dump should be sent to.
1514  * @param buf buffer
1515  * @param size buffer size
1516  *
1517  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1518  */
1519 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
1520
1521 /**
1522  * Send a nice hexadecimal dump of a buffer to the log.
1523  *
1524  * @param avcl A pointer to an arbitrary struct of which the first field is a
1525  * pointer to an AVClass struct.
1526  * @param level The importance level of the message, lower values signifying
1527  * higher importance.
1528  * @param buf buffer
1529  * @param size buffer size
1530  *
1531  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1532  */
1533 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
1534
1535 /**
1536  * Send a nice dump of a packet to the specified file stream.
1537  *
1538  * @param f The file stream pointer where the dump should be sent to.
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_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1544
1545
1546 /**
1547  * Send a nice dump of a packet to the log.
1548  *
1549  * @param avcl A pointer to an arbitrary struct of which the first field is a
1550  * pointer to an AVClass struct.
1551  * @param level The importance level of the message, lower values signifying
1552  * higher importance.
1553  * @param pkt packet to dump
1554  * @param dump_payload True if the payload must be displayed, too.
1555  * @param st AVStream that the packet belongs to
1556  */
1557 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1558                       AVStream *st);
1559
1560 /**
1561  * Get the AVCodecID for the given codec tag tag.
1562  * If no codec id is found returns AV_CODEC_ID_NONE.
1563  *
1564  * @param tags list of supported codec_id-codec_tag pairs, as stored
1565  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1566  */
1567 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1568
1569 /**
1570  * Get the codec tag for the given codec id id.
1571  * If no codec tag is found returns 0.
1572  *
1573  * @param tags list of supported codec_id-codec_tag pairs, as stored
1574  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1575  */
1576 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
1577
1578 int av_find_default_stream_index(AVFormatContext *s);
1579
1580 /**
1581  * Get the index for a specific timestamp.
1582  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1583  *                 to the timestamp which is <= the requested one, if backward
1584  *                 is 0, then it will be >=
1585  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1586  * @return < 0 if no such timestamp could be found
1587  */
1588 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1589
1590 /**
1591  * Add an index entry into a sorted list. Update the entry if the list
1592  * already contains it.
1593  *
1594  * @param timestamp timestamp in the time base of the given stream
1595  */
1596 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1597                        int size, int distance, int flags);
1598
1599
1600 /**
1601  * Split a URL string into components.
1602  *
1603  * The pointers to buffers for storing individual components may be null,
1604  * in order to ignore that component. Buffers for components not found are
1605  * set to empty strings. If the port is not found, it is set to a negative
1606  * value.
1607  *
1608  * @param proto the buffer for the protocol
1609  * @param proto_size the size of the proto buffer
1610  * @param authorization the buffer for the authorization
1611  * @param authorization_size the size of the authorization buffer
1612  * @param hostname the buffer for the host name
1613  * @param hostname_size the size of the hostname buffer
1614  * @param port_ptr a pointer to store the port number in
1615  * @param path the buffer for the path
1616  * @param path_size the size of the path buffer
1617  * @param url the URL to split
1618  */
1619 void av_url_split(char *proto,         int proto_size,
1620                   char *authorization, int authorization_size,
1621                   char *hostname,      int hostname_size,
1622                   int *port_ptr,
1623                   char *path,          int path_size,
1624                   const char *url);
1625
1626
1627 void av_dump_format(AVFormatContext *ic,
1628                     int index,
1629                     const char *url,
1630                     int is_output);
1631
1632 /**
1633  * Return in 'buf' the path with '%d' replaced by a number.
1634  *
1635  * Also handles the '%0nd' format where 'n' is the total number
1636  * of digits and '%%'.
1637  *
1638  * @param buf destination buffer
1639  * @param buf_size destination buffer size
1640  * @param path numbered sequence string
1641  * @param number frame number
1642  * @return 0 if OK, -1 on format error
1643  */
1644 int av_get_frame_filename(char *buf, int buf_size,
1645                           const char *path, int number);
1646
1647 /**
1648  * Check whether filename actually is a numbered sequence generator.
1649  *
1650  * @param filename possible numbered sequence string
1651  * @return 1 if a valid numbered sequence string, 0 otherwise
1652  */
1653 int av_filename_number_test(const char *filename);
1654
1655 /**
1656  * Generate an SDP for an RTP session.
1657  *
1658  * Note, this overwrites the id values of AVStreams in the muxer contexts
1659  * for getting unique dynamic payload types.
1660  *
1661  * @param ac array of AVFormatContexts describing the RTP streams. If the
1662  *           array is composed by only one context, such context can contain
1663  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1664  *           all the contexts in the array (an AVCodecContext per RTP stream)
1665  *           must contain only one AVStream.
1666  * @param n_files number of AVCodecContexts contained in ac
1667  * @param buf buffer where the SDP will be stored (must be allocated by
1668  *            the caller)
1669  * @param size the size of the buffer
1670  * @return 0 if OK, AVERROR_xxx on error
1671  */
1672 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1673
1674 /**
1675  * Return a positive value if the given filename has one of the given
1676  * extensions, 0 otherwise.
1677  *
1678  * @param extensions a comma-separated list of filename extensions
1679  */
1680 int av_match_ext(const char *filename, const char *extensions);
1681
1682 /**
1683  * Test if the given container can store a codec.
1684  *
1685  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1686  *
1687  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1688  *         A negative number if this information is not available.
1689  */
1690 int avformat_query_codec(AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance);
1691
1692 /**
1693  * @defgroup riff_fourcc RIFF FourCCs
1694  * @{
1695  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
1696  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1697  * following code:
1698  * @code
1699  * uint32_t tag = MKTAG('H', '2', '6', '4');
1700  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1701  * enum AVCodecID id = av_codec_get_id(table, tag);
1702  * @endcode
1703  */
1704 /**
1705  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
1706  */
1707 const struct AVCodecTag *avformat_get_riff_video_tags(void);
1708 /**
1709  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
1710  */
1711 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1712 /**
1713  * @}
1714  */
1715
1716 /**
1717  * @}
1718  */
1719
1720 #endif /* AVFORMAT_AVFORMAT_H */