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