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