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