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