avformat/utils: Inject global side data into first packet.
[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  * If AVPacket.buf is set on the returned packet, then the packet is
162  * allocated dynamically and the user may keep it indefinitely.
163  * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
164  * static storage somewhere inside the demuxer and the packet is only valid
165  * until the next av_read_frame() call or closing the file. If the caller
166  * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
167  * of it.
168  * In both cases, the packet must be freed with av_free_packet() when it is no
169  * longer needed.
170  *
171  * @section lavf_decoding_seek Seeking
172  * @}
173  *
174  * @defgroup lavf_encoding Muxing
175  * @{
176  * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write
177  * it into files or other output bytestreams in the specified container format.
178  *
179  * The main API functions for muxing are avformat_write_header() for writing the
180  * file header, av_write_frame() / av_interleaved_write_frame() for writing the
181  * packets and av_write_trailer() for finalizing the file.
182  *
183  * At the beginning of the muxing process, the caller must first call
184  * avformat_alloc_context() to create a muxing context. The caller then sets up
185  * the muxer by filling the various fields in this context:
186  *
187  * - The @ref AVFormatContext.oformat "oformat" field must be set to select the
188  *   muxer that will be used.
189  * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb
190  *   "pb" field must be set to an opened IO context, either returned from
191  *   avio_open2() or a custom one.
192  * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must
193  *   be created with the avformat_new_stream() function. The caller should fill
194  *   the @ref AVStream.codec "stream codec context" information, such as the
195  *   codec @ref AVCodecContext.codec_type "type", @ref AVCodecContext.codec_id
196  *   "id" and other parameters (e.g. width / height, the pixel or sample format,
197  *   etc.) as known. The @ref AVCodecContext.time_base "codec timebase" should
198  *   be set to the timebase that the caller desires to use for this stream (note
199  *   that the timebase actually used by the muxer can be different, as will be
200  *   described later).
201  * - The caller may fill in additional information, such as @ref
202  *   AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream"
203  *   metadata, @ref AVFormatContext.chapters "chapters", @ref
204  *   AVFormatContext.programs "programs", etc. as described in the
205  *   AVFormatContext documentation. Whether such information will actually be
206  *   stored in the output depends on what the container format and the muxer
207  *   support.
208  *
209  * When the muxing context is fully set up, the caller must call
210  * avformat_write_header() to initialize the muxer internals and write the file
211  * header. Whether anything actually is written to the IO context at this step
212  * depends on the muxer, but this function must always be called. Any muxer
213  * private options must be passed in the options parameter to this function.
214  *
215  * The data is then sent to the muxer by repeatedly calling av_write_frame() or
216  * av_interleaved_write_frame() (consult those functions' documentation for
217  * discussion on the difference between them; only one of them may be used with
218  * a single muxing context, they should not be mixed). Do note that the timing
219  * information on the packets sent to the muxer must be in the corresponding
220  * AVStream's timebase. That timebase is set by the muxer (in the
221  * avformat_write_header() step) and may be different from the timebase the
222  * caller set on the codec context.
223  *
224  * Once all the data has been written, the caller must call av_write_trailer()
225  * to flush any buffered packets and finalize the output file, then close the IO
226  * context (if any) and finally free the muxing context with
227  * avformat_free_context().
228  * @}
229  *
230  * @defgroup lavf_io I/O Read/Write
231  * @{
232  * @}
233  *
234  * @defgroup lavf_codec Demuxers
235  * @{
236  * @defgroup lavf_codec_native Native Demuxers
237  * @{
238  * @}
239  * @defgroup lavf_codec_wrappers External library wrappers
240  * @{
241  * @}
242  * @}
243  * @defgroup lavf_protos I/O Protocols
244  * @{
245  * @}
246  * @defgroup lavf_internal Internal
247  * @{
248  * @}
249  * @}
250  *
251  */
252
253 #include <time.h>
254 #include <stdio.h>  /* FILE */
255 #include "libavcodec/avcodec.h"
256 #include "libavutil/dict.h"
257 #include "libavutil/log.h"
258
259 #include "avio.h"
260 #include "libavformat/version.h"
261
262 struct AVFormatContext;
263
264 struct AVDeviceInfoList;
265 struct AVDeviceCapabilitiesQuery;
266
267 /**
268  * @defgroup metadata_api Public Metadata API
269  * @{
270  * @ingroup libavf
271  * The metadata API allows libavformat to export metadata tags to a client
272  * application when demuxing. Conversely it allows a client application to
273  * set metadata when muxing.
274  *
275  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
276  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
277  * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg,
278  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
279  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
280  *
281  * Important concepts to keep in mind:
282  * -  Keys are unique; there can never be 2 tags with the same key. This is
283  *    also meant semantically, i.e., a demuxer should not knowingly produce
284  *    several keys that are literally different but semantically identical.
285  *    E.g., key=Author5, key=Author6. In this example, all authors must be
286  *    placed in the same tag.
287  * -  Metadata is flat, not hierarchical; there are no subtags. If you
288  *    want to store, e.g., the email address of the child of producer Alice
289  *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
290  * -  Several modifiers can be applied to the tag name. This is done by
291  *    appending a dash character ('-') and the modifier name in the order
292  *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
293  *    -  language -- a tag whose value is localized for a particular language
294  *       is appended with the ISO 639-2/B 3-letter language code.
295  *       For example: Author-ger=Michael, Author-eng=Mike
296  *       The original/default language is in the unqualified "Author" tag.
297  *       A demuxer should set a default if it sets any translated tag.
298  *    -  sorting  -- a modified version of a tag that should be used for
299  *       sorting will have '-sort' appended. E.g. artist="The Beatles",
300  *       artist-sort="Beatles, The".
301  *
302  * -  Demuxers attempt to export metadata in a generic format, however tags
303  *    with no generic equivalents are left as they are stored in the container.
304  *    Follows a list of generic tag names:
305  *
306  @verbatim
307  album        -- name of the set this work belongs to
308  album_artist -- main creator of the set/album, if different from artist.
309                  e.g. "Various Artists" for compilation albums.
310  artist       -- main creator of the work
311  comment      -- any additional description of the file.
312  composer     -- who composed the work, if different from artist.
313  copyright    -- name of copyright holder.
314  creation_time-- date when the file was created, preferably in ISO 8601.
315  date         -- date when the work was created, preferably in ISO 8601.
316  disc         -- number of a subset, e.g. disc in a multi-disc collection.
317  encoder      -- name/settings of the software/hardware that produced the file.
318  encoded_by   -- person/group who created the file.
319  filename     -- original name of the file.
320  genre        -- <self-evident>.
321  language     -- main language in which the work is performed, preferably
322                  in ISO 639-2 format. Multiple languages can be specified by
323                  separating them with commas.
324  performer    -- artist who performed the work, if different from artist.
325                  E.g for "Also sprach Zarathustra", artist would be "Richard
326                  Strauss" and performer "London Philharmonic Orchestra".
327  publisher    -- name of the label/publisher.
328  service_name     -- name of the service in broadcasting (channel name).
329  service_provider -- name of the service provider in broadcasting.
330  title        -- name of the work.
331  track        -- number of this work in the set, can be in form current/total.
332  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
333  @endverbatim
334  *
335  * Look in the examples section for an application example how to use the Metadata API.
336  *
337  * @}
338  */
339
340 /* packet functions */
341
342
343 /**
344  * Allocate and read the payload of a packet and initialize its
345  * fields with default values.
346  *
347  * @param s    associated IO context
348  * @param pkt packet
349  * @param size desired payload size
350  * @return >0 (read size) if OK, AVERROR_xxx otherwise
351  */
352 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
353
354
355 /**
356  * Read data and append it to the current content of the AVPacket.
357  * If pkt->size is 0 this is identical to av_get_packet.
358  * Note that this uses av_grow_packet and thus involves a realloc
359  * which is inefficient. Thus this function should only be used
360  * when there is no reasonable way to know (an upper bound of)
361  * the final size.
362  *
363  * @param s    associated IO context
364  * @param pkt packet
365  * @param size amount of data to read
366  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
367  *         will not be lost even if an error occurs.
368  */
369 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
370
371 /*************************************************/
372 /* fractional numbers for exact pts handling */
373
374 /**
375  * The exact value of the fractional number is: 'val + num / den'.
376  * num is assumed to be 0 <= num < den.
377  */
378 typedef struct AVFrac {
379     int64_t val, num, den;
380 } AVFrac;
381
382 /*************************************************/
383 /* input/output formats */
384
385 struct AVCodecTag;
386
387 /**
388  * This structure contains the data a format has to probe a file.
389  */
390 typedef struct AVProbeData {
391     const char *filename;
392     unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
393     int buf_size;       /**< Size of buf except extra allocated bytes */
394 } AVProbeData;
395
396 #define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4)
397 #define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1)
398
399 #define AVPROBE_SCORE_EXTENSION  50 ///< score for file extension
400 #define AVPROBE_SCORE_MAX       100 ///< maximum score
401
402 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
403
404 /// Demuxer will use avio_open, no opened file should be provided by the caller.
405 #define AVFMT_NOFILE        0x0001
406 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
407 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
408 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
409                                       raw picture data. */
410 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
411 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
412 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
413 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
414 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
415 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
416 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
417 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
418 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fall back on generic search */
419 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
420 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
421 #if LIBAVFORMAT_VERSION_MAJOR <= 54
422 #define AVFMT_TS_NONSTRICT 0x8020000 //we try to be compatible to the ABIs of ffmpeg and major forks
423 #else
424 #define AVFMT_TS_NONSTRICT 0x20000
425 #endif
426                                    /**< Format does not require strictly
427                                         increasing timestamps, but they must
428                                         still be monotonic */
429 #define AVFMT_TS_NEGATIVE  0x40000 /**< Format allows muxing negative
430                                         timestamps. If not set the timestamp
431                                         will be shifted in av_write_frame and
432                                         av_interleaved_write_frame so they
433                                         start from 0.
434                                         The user or muxer can override this through
435                                         AVFormatContext.avoid_negative_ts
436                                         */
437
438 #define AVFMT_SEEK_TO_PTS   0x4000000 /**< Seeking is based on PTS */
439
440 /**
441  * @addtogroup lavf_encoding
442  * @{
443  */
444 typedef struct AVOutputFormat {
445     const char *name;
446     /**
447      * Descriptive name for the format, meant to be more human-readable
448      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
449      * to define it.
450      */
451     const char *long_name;
452     const char *mime_type;
453     const char *extensions; /**< comma-separated filename extensions */
454     /* output support */
455     enum AVCodecID audio_codec;    /**< default audio codec */
456     enum AVCodecID video_codec;    /**< default video codec */
457     enum AVCodecID subtitle_codec; /**< default subtitle codec */
458     /**
459      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
460      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
461      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
462      * AVFMT_TS_NONSTRICT
463      */
464     int flags;
465
466     /**
467      * List of supported codec_id-codec_tag pairs, ordered by "better
468      * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
469      */
470     const struct AVCodecTag * const *codec_tag;
471
472
473     const AVClass *priv_class; ///< AVClass for the private context
474
475     /*****************************************************************
476      * No fields below this line are part of the public API. They
477      * may not be used outside of libavformat and can be changed and
478      * removed at will.
479      * New public fields should be added right above.
480      *****************************************************************
481      */
482     struct AVOutputFormat *next;
483     /**
484      * size of private data so that it can be allocated in the wrapper
485      */
486     int priv_data_size;
487
488     int (*write_header)(struct AVFormatContext *);
489     /**
490      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
491      * pkt can be NULL in order to flush data buffered in the muxer.
492      * When flushing, return 0 if there still is more data to flush,
493      * or 1 if everything was flushed and there is no more buffered
494      * data.
495      */
496     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
497     int (*write_trailer)(struct AVFormatContext *);
498     /**
499      * Currently only used to set pixel format if not YUV420P.
500      */
501     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
502                              AVPacket *in, int flush);
503     /**
504      * Test if the given codec can be stored in this container.
505      *
506      * @return 1 if the codec is supported, 0 if it is not.
507      *         A negative number if unknown.
508      *         MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC
509      */
510     int (*query_codec)(enum AVCodecID id, int std_compliance);
511
512     void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
513                                  int64_t *dts, int64_t *wall);
514     /**
515      * Allows sending messages from application to device.
516      */
517     int (*control_message)(struct AVFormatContext *s, int type,
518                            void *data, size_t data_size);
519
520     /**
521      * Write an uncoded AVFrame.
522      *
523      * See av_write_uncoded_frame() for details.
524      *
525      * The library will free *frame afterwards, but the muxer can prevent it
526      * by setting the pointer to NULL.
527      */
528     int (*write_uncoded_frame)(struct AVFormatContext *, int stream_index,
529                                AVFrame **frame, unsigned flags);
530     /**
531      * Returns device list with it properties.
532      * @see avdevice_list_devices() for more details.
533      */
534     int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
535     /**
536      * Initialize device capabilities submodule.
537      * @see avdevice_capabilities_create() for more details.
538      */
539     int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
540     /**
541      * Free device capabilities submodule.
542      * @see avdevice_capabilities_free() for more details.
543      */
544     int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
545 } AVOutputFormat;
546 /**
547  * @}
548  */
549
550 /**
551  * @addtogroup lavf_decoding
552  * @{
553  */
554 typedef struct AVInputFormat {
555     /**
556      * A comma separated list of short names for the format. New names
557      * may be appended with a minor bump.
558      */
559     const char *name;
560
561     /**
562      * Descriptive name for the format, meant to be more human-readable
563      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
564      * to define it.
565      */
566     const char *long_name;
567
568     /**
569      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
570      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
571      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.
572      */
573     int flags;
574
575     /**
576      * If extensions are defined, then no probe is done. You should
577      * usually not use extension format guessing because it is not
578      * reliable enough
579      */
580     const char *extensions;
581
582     const struct AVCodecTag * const *codec_tag;
583
584     const AVClass *priv_class; ///< AVClass for the private context
585
586     /*****************************************************************
587      * No fields below this line are part of the public API. They
588      * may not be used outside of libavformat and can be changed and
589      * removed at will.
590      * New public fields should be added right above.
591      *****************************************************************
592      */
593     struct AVInputFormat *next;
594
595     /**
596      * Raw demuxers store their codec ID here.
597      */
598     int raw_codec_id;
599
600     /**
601      * Size of private data so that it can be allocated in the wrapper.
602      */
603     int priv_data_size;
604
605     /**
606      * Tell if a given file has a chance of being parsed as this format.
607      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
608      * big so you do not have to check for that unless you need more.
609      */
610     int (*read_probe)(AVProbeData *);
611
612     /**
613      * Read the format header and initialize the AVFormatContext
614      * structure. Return 0 if OK. Only used in raw format right
615      * now. 'avformat_new_stream' should be called to create new streams.
616      */
617     int (*read_header)(struct AVFormatContext *);
618
619     /**
620      * Read one packet and put it in 'pkt'. pts and flags are also
621      * set. 'avformat_new_stream' can be called only if the flag
622      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
623      * background thread).
624      * @return 0 on success, < 0 on error.
625      *         When returning an error, pkt must not have been allocated
626      *         or must be freed before returning
627      */
628     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
629
630     /**
631      * Close the stream. The AVFormatContext and AVStreams are not
632      * freed by this function
633      */
634     int (*read_close)(struct AVFormatContext *);
635
636     /**
637      * Seek to a given timestamp relative to the frames in
638      * stream component stream_index.
639      * @param stream_index Must not be -1.
640      * @param flags Selects which direction should be preferred if no exact
641      *              match is available.
642      * @return >= 0 on success (but not necessarily the new offset)
643      */
644     int (*read_seek)(struct AVFormatContext *,
645                      int stream_index, int64_t timestamp, int flags);
646
647     /**
648      * Get the next timestamp in stream[stream_index].time_base units.
649      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
650      */
651     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
652                               int64_t *pos, int64_t pos_limit);
653
654     /**
655      * Start/resume playing - only meaningful if using a network-based format
656      * (RTSP).
657      */
658     int (*read_play)(struct AVFormatContext *);
659
660     /**
661      * Pause playing - only meaningful if using a network-based format
662      * (RTSP).
663      */
664     int (*read_pause)(struct AVFormatContext *);
665
666     /**
667      * Seek to timestamp ts.
668      * Seeking will be done so that the point from which all active streams
669      * can be presented successfully will be closest to ts and within min/max_ts.
670      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
671      */
672     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
673
674     /**
675      * Returns device list with it properties.
676      * @see avdevice_list_devices() for more details.
677      */
678     int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
679
680     /**
681      * Initialize device capabilities submodule.
682      * @see avdevice_capabilities_create() for more details.
683      */
684     int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
685
686     /**
687      * Free device capabilities submodule.
688      * @see avdevice_capabilities_free() for more details.
689      */
690     int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps);
691 } AVInputFormat;
692 /**
693  * @}
694  */
695
696 enum AVStreamParseType {
697     AVSTREAM_PARSE_NONE,
698     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
699     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
700     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
701     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
702     AVSTREAM_PARSE_FULL_RAW=MKTAG(0,'R','A','W'),       /**< full parsing and repack with timestamp and position generation by parser for raw
703                                                              this assumes that each packet in the file contains no demuxer level headers and
704                                                              just codec level data, otherwise position generation would fail */
705 };
706
707 typedef struct AVIndexEntry {
708     int64_t pos;
709     int64_t timestamp;        /**<
710                                * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
711                                * when seeking to this entry. That means preferable PTS on keyframe based formats.
712                                * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
713                                * is known
714                                */
715 #define AVINDEX_KEYFRAME 0x0001
716     int flags:2;
717     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).
718     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
719 } AVIndexEntry;
720
721 #define AV_DISPOSITION_DEFAULT   0x0001
722 #define AV_DISPOSITION_DUB       0x0002
723 #define AV_DISPOSITION_ORIGINAL  0x0004
724 #define AV_DISPOSITION_COMMENT   0x0008
725 #define AV_DISPOSITION_LYRICS    0x0010
726 #define AV_DISPOSITION_KARAOKE   0x0020
727
728 /**
729  * Track should be used during playback by default.
730  * Useful for subtitle track that should be displayed
731  * even when user did not explicitly ask for subtitles.
732  */
733 #define AV_DISPOSITION_FORCED    0x0040
734 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
735 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
736 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
737 /**
738  * The stream is stored in the file as an attached picture/"cover art" (e.g.
739  * APIC frame in ID3v2). The single packet associated with it will be returned
740  * among the first few packets read from the file unless seeking takes place.
741  * It can also be accessed at any time in AVStream.attached_pic.
742  */
743 #define AV_DISPOSITION_ATTACHED_PIC      0x0400
744
745 /**
746  * To specify text track kind (different from subtitles default).
747  */
748 #define AV_DISPOSITION_CAPTIONS     0x10000
749 #define AV_DISPOSITION_DESCRIPTIONS 0x20000
750 #define AV_DISPOSITION_METADATA     0x40000
751
752 /**
753  * Options for behavior on timestamp wrap detection.
754  */
755 #define AV_PTS_WRAP_IGNORE      0   ///< ignore the wrap
756 #define AV_PTS_WRAP_ADD_OFFSET  1   ///< add the format specific offset on wrap detection
757 #define AV_PTS_WRAP_SUB_OFFSET  -1  ///< subtract the format specific offset on wrap detection
758
759 /**
760  * Stream structure.
761  * New fields can be added to the end with minor version bumps.
762  * Removal, reordering and changes to existing fields require a major
763  * version bump.
764  * sizeof(AVStream) must not be used outside libav*.
765  */
766 typedef struct AVStream {
767     int index;    /**< stream index in AVFormatContext */
768     /**
769      * Format-specific stream ID.
770      * decoding: set by libavformat
771      * encoding: set by the user, replaced by libavformat if left unset
772      */
773     int id;
774     /**
775      * Codec context associated with this stream. Allocated and freed by
776      * libavformat.
777      *
778      * - decoding: The demuxer exports codec information stored in the headers
779      *             here.
780      * - encoding: The user sets codec information, the muxer writes it to the
781      *             output. Mandatory fields as specified in AVCodecContext
782      *             documentation must be set even if this AVCodecContext is
783      *             not actually used for encoding.
784      */
785     AVCodecContext *codec;
786     void *priv_data;
787
788     /**
789      * encoding: pts generation when outputting stream
790      */
791     struct AVFrac pts;
792
793     /**
794      * This is the fundamental unit of time (in seconds) in terms
795      * of which frame timestamps are represented.
796      *
797      * decoding: set by libavformat
798      * encoding: set by libavformat in avformat_write_header. The muxer may use the
799      * user-provided value of @ref AVCodecContext.time_base "codec->time_base"
800      * as a hint.
801      */
802     AVRational time_base;
803
804     /**
805      * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
806      * Only set this if you are absolutely 100% sure that the value you set
807      * it to really is the pts of the first frame.
808      * This may be undefined (AV_NOPTS_VALUE).
809      * @note The ASF header does NOT contain a correct start_time the ASF
810      * demuxer must NOT set this.
811      */
812     int64_t start_time;
813
814     /**
815      * Decoding: duration of the stream, in stream time base.
816      * If a source file does not specify a duration, but does specify
817      * a bitrate, this value will be estimated from bitrate and file size.
818      */
819     int64_t duration;
820
821     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
822
823     int disposition; /**< AV_DISPOSITION_* bit field */
824
825     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
826
827     /**
828      * sample aspect ratio (0 if unknown)
829      * - encoding: Set by user.
830      * - decoding: Set by libavformat.
831      */
832     AVRational sample_aspect_ratio;
833
834     AVDictionary *metadata;
835
836     /**
837      * Average framerate
838      */
839     AVRational avg_frame_rate;
840
841     /**
842      * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
843      * will contain the attached picture.
844      *
845      * decoding: set by libavformat, must not be modified by the caller.
846      * encoding: unused
847      */
848     AVPacket attached_pic;
849
850     /**
851      * An array of side data that applies to the whole stream (i.e. the
852      * container does not allow it to change between packets).
853      *
854      * There may be no overlap between the side data in this array and side data
855      * in the packets. I.e. a given side data is either exported by the muxer
856      * (demuxing) / set by the caller (muxing) in this array, then it never
857      * appears in the packets, or the side data is exported / sent through
858      * the packets (always in the first packet where the value becomes known or
859      * changes), then it does not appear in this array.
860      *
861      * - demuxing: Set by libavformat when the stream is created.
862      * - muxing: May be set by the caller before avformat_write_header().
863      *
864      * Freed by libavformat in avformat_free_context().
865      */
866     AVPacketSideData *side_data;
867     /**
868      * The number of elements in the AVStream.side_data array.
869      */
870     int            nb_side_data;
871
872     /*****************************************************************
873      * All fields below this line are not part of the public API. They
874      * may not be used outside of libavformat and can be changed and
875      * removed at will.
876      * New public fields should be added right above.
877      *****************************************************************
878      */
879
880     /**
881      * Stream information used internally by av_find_stream_info()
882      */
883 #define MAX_STD_TIMEBASES (60*12+6)
884     struct {
885         int64_t last_dts;
886         int64_t duration_gcd;
887         int duration_count;
888         int64_t rfps_duration_sum;
889         double (*duration_error)[2][MAX_STD_TIMEBASES];
890         int64_t codec_info_duration;
891         int64_t codec_info_duration_fields;
892         int found_decoder;
893
894         int64_t last_duration;
895
896         /**
897          * Those are used for average framerate estimation.
898          */
899         int64_t fps_first_dts;
900         int     fps_first_dts_idx;
901         int64_t fps_last_dts;
902         int     fps_last_dts_idx;
903
904     } *info;
905
906     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
907
908 #if FF_API_REFERENCE_DTS
909     /* a hack to keep ABI compatibility for ffmpeg and other applications, which accesses parser even
910      * though it should not */
911     int64_t do_not_use;
912 #endif
913     // Timestamp generation support:
914     /**
915      * Timestamp corresponding to the last dts sync point.
916      *
917      * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
918      * a DTS is received from the underlying container. Otherwise set to
919      * AV_NOPTS_VALUE by default.
920      */
921     int64_t first_dts;
922     int64_t cur_dts;
923     int64_t last_IP_pts;
924     int last_IP_duration;
925
926     /**
927      * Number of packets to buffer for codec probing
928      */
929 #define MAX_PROBE_PACKETS 2500
930     int probe_packets;
931
932     /**
933      * Number of frames that have been demuxed during av_find_stream_info()
934      */
935     int codec_info_nb_frames;
936
937     /* av_read_frame() support */
938     enum AVStreamParseType need_parsing;
939     struct AVCodecParserContext *parser;
940
941     /**
942      * last packet in packet_buffer for this stream when muxing.
943      */
944     struct AVPacketList *last_in_packet_buffer;
945     AVProbeData probe_data;
946 #define MAX_REORDER_DELAY 16
947     int64_t pts_buffer[MAX_REORDER_DELAY+1];
948
949     AVIndexEntry *index_entries; /**< Only used if the format does not
950                                     support seeking natively. */
951     int nb_index_entries;
952     unsigned int index_entries_allocated_size;
953
954     /**
955      * Real base framerate of the stream.
956      * This is the lowest framerate with which all timestamps can be
957      * represented accurately (it is the least common multiple of all
958      * framerates in the stream). Note, this value is just a guess!
959      * For example, if the time base is 1/90000 and all frames have either
960      * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
961      *
962      * Code outside avformat should access this field using:
963      * av_stream_get/set_r_frame_rate(stream)
964      */
965     AVRational r_frame_rate;
966
967     /**
968      * Stream Identifier
969      * This is the MPEG-TS stream identifier +1
970      * 0 means unknown
971      */
972     int stream_identifier;
973
974     int64_t interleaver_chunk_size;
975     int64_t interleaver_chunk_duration;
976
977     /**
978      * stream probing state
979      * -1   -> probing finished
980      *  0   -> no probing requested
981      * rest -> perform probing with request_probe being the minimum score to accept.
982      * NOT PART OF PUBLIC API
983      */
984     int request_probe;
985     /**
986      * Indicates that everything up to the next keyframe
987      * should be discarded.
988      */
989     int skip_to_keyframe;
990
991     /**
992      * Number of samples to skip at the start of the frame decoded from the next packet.
993      */
994     int skip_samples;
995
996     /**
997      * Number of internally decoded frames, used internally in libavformat, do not access
998      * its lifetime differs from info which is why it is not in that structure.
999      */
1000     int nb_decoded_frames;
1001
1002     /**
1003      * Timestamp offset added to timestamps before muxing
1004      * NOT PART OF PUBLIC API
1005      */
1006     int64_t mux_ts_offset;
1007
1008     /**
1009      * Internal data to check for wrapping of the time stamp
1010      */
1011     int64_t pts_wrap_reference;
1012
1013     /**
1014      * Options for behavior, when a wrap is detected.
1015      *
1016      * Defined by AV_PTS_WRAP_ values.
1017      *
1018      * If correction is enabled, there are two possibilities:
1019      * If the first time stamp is near the wrap point, the wrap offset
1020      * will be subtracted, which will create negative time stamps.
1021      * Otherwise the offset will be added.
1022      */
1023     int pts_wrap_behavior;
1024
1025     /**
1026      * Internal data to prevent doing update_initial_durations() twice
1027      */
1028     int update_initial_durations_done;
1029
1030     /**
1031      * Internal data to generate dts from pts
1032      */
1033     int64_t pts_reorder_error[MAX_REORDER_DELAY+1];
1034     uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1];
1035
1036     /**
1037      * Internal data to analyze DTS and detect faulty mpeg streams
1038      */
1039     int64_t last_dts_for_order_check;
1040     uint8_t dts_ordered;
1041     uint8_t dts_misordered;
1042
1043     /**
1044      * Internal data to inject global side data
1045      */
1046     int global_side_data_injected;
1047
1048 } AVStream;
1049
1050 AVRational av_stream_get_r_frame_rate(const AVStream *s);
1051 void       av_stream_set_r_frame_rate(AVStream *s, AVRational r);
1052
1053 #define AV_PROGRAM_RUNNING 1
1054
1055 /**
1056  * New fields can be added to the end with minor version bumps.
1057  * Removal, reordering and changes to existing fields require a major
1058  * version bump.
1059  * sizeof(AVProgram) must not be used outside libav*.
1060  */
1061 typedef struct AVProgram {
1062     int            id;
1063     int            flags;
1064     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
1065     unsigned int   *stream_index;
1066     unsigned int   nb_stream_indexes;
1067     AVDictionary *metadata;
1068
1069     int program_num;
1070     int pmt_pid;
1071     int pcr_pid;
1072
1073     /*****************************************************************
1074      * All fields below this line are not part of the public API. They
1075      * may not be used outside of libavformat and can be changed and
1076      * removed at will.
1077      * New public fields should be added right above.
1078      *****************************************************************
1079      */
1080     int64_t start_time;
1081     int64_t end_time;
1082
1083     int64_t pts_wrap_reference;    ///< reference dts for wrap detection
1084     int pts_wrap_behavior;         ///< behavior on wrap detection
1085 } AVProgram;
1086
1087 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
1088                                          (streams are added dynamically) */
1089
1090 typedef struct AVChapter {
1091     int id;                 ///< unique ID to identify the chapter
1092     AVRational time_base;   ///< time base in which the start/end timestamps are specified
1093     int64_t start, end;     ///< chapter start/end time in time_base units
1094     AVDictionary *metadata;
1095 } AVChapter;
1096
1097
1098 /**
1099  * Callback used by devices to communicate with application.
1100  */
1101 typedef int (*av_format_control_message)(struct AVFormatContext *s, int type,
1102                                          void *data, size_t data_size);
1103
1104
1105 /**
1106  * The duration of a video can be estimated through various ways, and this enum can be used
1107  * to know how the duration was estimated.
1108  */
1109 enum AVDurationEstimationMethod {
1110     AVFMT_DURATION_FROM_PTS,    ///< Duration accurately estimated from PTSes
1111     AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration
1112     AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate)
1113 };
1114
1115 typedef struct AVFormatInternal AVFormatInternal;
1116
1117 /**
1118  * Format I/O context.
1119  * New fields can be added to the end with minor version bumps.
1120  * Removal, reordering and changes to existing fields require a major
1121  * version bump.
1122  * sizeof(AVFormatContext) must not be used outside libav*, use
1123  * avformat_alloc_context() to create an AVFormatContext.
1124  */
1125 typedef struct AVFormatContext {
1126     /**
1127      * A class for logging and @ref avoptions. Set by avformat_alloc_context().
1128      * Exports (de)muxer private options if they exist.
1129      */
1130     const AVClass *av_class;
1131
1132     /**
1133      * The input container format.
1134      *
1135      * Demuxing only, set by avformat_open_input().
1136      */
1137     struct AVInputFormat *iformat;
1138
1139     /**
1140      * The output container format.
1141      *
1142      * Muxing only, must be set by the caller before avformat_write_header().
1143      */
1144     struct AVOutputFormat *oformat;
1145
1146     /**
1147      * Format private data. This is an AVOptions-enabled struct
1148      * if and only if iformat/oformat.priv_class is not NULL.
1149      *
1150      * - muxing: set by avformat_write_header()
1151      * - demuxing: set by avformat_open_input()
1152      */
1153     void *priv_data;
1154
1155     /**
1156      * I/O context.
1157      *
1158      * - demuxing: either set by the user before avformat_open_input() (then
1159      *             the user must close it manually) or set by avformat_open_input().
1160      * - muxing: set by the user before avformat_write_header(). The caller must
1161      *           take care of closing / freeing the IO context.
1162      *
1163      * Do NOT set this field if AVFMT_NOFILE flag is set in
1164      * iformat/oformat.flags. In such a case, the (de)muxer will handle
1165      * I/O in some other way and this field will be NULL.
1166      */
1167     AVIOContext *pb;
1168
1169     /* stream info */
1170     int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
1171
1172     /**
1173      * Number of elements in AVFormatContext.streams.
1174      *
1175      * Set by avformat_new_stream(), must not be modified by any other code.
1176      */
1177     unsigned int nb_streams;
1178     /**
1179      * A list of all streams in the file. New streams are created with
1180      * avformat_new_stream().
1181      *
1182      * - demuxing: streams are created by libavformat in avformat_open_input().
1183      *             If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
1184      *             appear in av_read_frame().
1185      * - muxing: streams are created by the user before avformat_write_header().
1186      *
1187      * Freed by libavformat in avformat_free_context().
1188      */
1189     AVStream **streams;
1190
1191     /**
1192      * input or output filename
1193      *
1194      * - demuxing: set by avformat_open_input()
1195      * - muxing: may be set by the caller before avformat_write_header()
1196      */
1197     char filename[1024];
1198
1199     /**
1200      * Position of the first frame of the component, in
1201      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
1202      * It is deduced from the AVStream values.
1203      *
1204      * Demuxing only, set by libavformat.
1205      */
1206     int64_t start_time;
1207
1208     /**
1209      * Duration of the stream, in AV_TIME_BASE fractional
1210      * seconds. Only set this value if you know none of the individual stream
1211      * durations and also do not set any of them. This is deduced from the
1212      * AVStream values if not set.
1213      *
1214      * Demuxing only, set by libavformat.
1215      */
1216     int64_t duration;
1217
1218     /**
1219      * Total stream bitrate in bit/s, 0 if not
1220      * available. Never set it directly if the file_size and the
1221      * duration are known as FFmpeg can compute it automatically.
1222      */
1223     int bit_rate;
1224
1225     unsigned int packet_size;
1226     int max_delay;
1227
1228     int flags;
1229 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
1230 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
1231 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
1232 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1233 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1234 #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
1235 #define AVFMT_FLAG_NOBUFFER     0x0040 ///< Do not buffer frames when possible
1236 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1237 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
1238 #define AVFMT_FLAG_FLUSH_PACKETS    0x0200 ///< Flush the AVIOContext every packet.
1239 #define AVFMT_FLAG_MP4A_LATM    0x8000 ///< Enable RTP MP4A-LATM payload
1240 #define AVFMT_FLAG_SORT_DTS    0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
1241 #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)
1242 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Don't merge side data but keep it separate.
1243
1244     /**
1245      * Maximum size of the data read from input for determining
1246      * the input container format.
1247      * Demuxing only, set by the caller before avformat_open_input().
1248      */
1249     unsigned int probesize;
1250
1251     /**
1252      * Maximum duration (in AV_TIME_BASE units) of the data read
1253      * from input in avformat_find_stream_info().
1254      * Demuxing only, set by the caller before avformat_find_stream_info().
1255      */
1256     int max_analyze_duration;
1257
1258     const uint8_t *key;
1259     int keylen;
1260
1261     unsigned int nb_programs;
1262     AVProgram **programs;
1263
1264     /**
1265      * Forced video codec_id.
1266      * Demuxing: Set by user.
1267      */
1268     enum AVCodecID video_codec_id;
1269
1270     /**
1271      * Forced audio codec_id.
1272      * Demuxing: Set by user.
1273      */
1274     enum AVCodecID audio_codec_id;
1275
1276     /**
1277      * Forced subtitle codec_id.
1278      * Demuxing: Set by user.
1279      */
1280     enum AVCodecID subtitle_codec_id;
1281
1282     /**
1283      * Maximum amount of memory in bytes to use for the index of each stream.
1284      * If the index exceeds this size, entries will be discarded as
1285      * needed to maintain a smaller size. This can lead to slower or less
1286      * accurate seeking (depends on demuxer).
1287      * Demuxers for which a full in-memory index is mandatory will ignore
1288      * this.
1289      * - muxing: unused
1290      * - demuxing: set by user
1291      */
1292     unsigned int max_index_size;
1293
1294     /**
1295      * Maximum amount of memory in bytes to use for buffering frames
1296      * obtained from realtime capture devices.
1297      */
1298     unsigned int max_picture_buffer;
1299
1300     /**
1301      * Number of chapters in AVChapter array.
1302      * When muxing, chapters are normally written in the file header,
1303      * so nb_chapters should normally be initialized before write_header
1304      * is called. Some muxers (e.g. mov and mkv) can also write chapters
1305      * in the trailer.  To write chapters in the trailer, nb_chapters
1306      * must be zero when write_header is called and non-zero when
1307      * write_trailer is called.
1308      * - muxing: set by user
1309      * - demuxing: set by libavformat
1310      */
1311     unsigned int nb_chapters;
1312     AVChapter **chapters;
1313
1314     /**
1315      * Metadata that applies to the whole file.
1316      *
1317      * - demuxing: set by libavformat in avformat_open_input()
1318      * - muxing: may be set by the caller before avformat_write_header()
1319      *
1320      * Freed by libavformat in avformat_free_context().
1321      */
1322     AVDictionary *metadata;
1323
1324     /**
1325      * Start time of the stream in real world time, in microseconds
1326      * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1327      * stream was captured at this real world time.
1328      * - muxing: Set by the caller before avformat_write_header(). If set to
1329      *           either 0 or AV_NOPTS_VALUE, then the current wall-time will
1330      *           be used.
1331      * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that
1332      *             the value may become known after some number of frames
1333      *             have been received.
1334      */
1335     int64_t start_time_realtime;
1336
1337     /**
1338      * The number of frames used for determining the framerate in
1339      * avformat_find_stream_info().
1340      * Demuxing only, set by the caller before avformat_find_stream_info().
1341      */
1342     int fps_probe_size;
1343
1344     /**
1345      * Error recognition; higher values will detect more errors but may
1346      * misdetect some more or less valid parts as errors.
1347      * Demuxing only, set by the caller before avformat_open_input().
1348      */
1349     int error_recognition;
1350
1351     /**
1352      * Custom interrupt callbacks for the I/O layer.
1353      *
1354      * demuxing: set by the user before avformat_open_input().
1355      * muxing: set by the user before avformat_write_header()
1356      * (mainly useful for AVFMT_NOFILE formats). The callback
1357      * should also be passed to avio_open2() if it's used to
1358      * open the file.
1359      */
1360     AVIOInterruptCB interrupt_callback;
1361
1362     /**
1363      * Flags to enable debugging.
1364      */
1365     int debug;
1366 #define FF_FDEBUG_TS        0x0001
1367
1368     /**
1369      * Maximum buffering duration for interleaving.
1370      *
1371      * To ensure all the streams are interleaved correctly,
1372      * av_interleaved_write_frame() will wait until it has at least one packet
1373      * for each stream before actually writing any packets to the output file.
1374      * When some streams are "sparse" (i.e. there are large gaps between
1375      * successive packets), this can result in excessive buffering.
1376      *
1377      * This field specifies the maximum difference between the timestamps of the
1378      * first and the last packet in the muxing queue, above which libavformat
1379      * will output a packet regardless of whether it has queued a packet for all
1380      * the streams.
1381      *
1382      * Muxing only, set by the caller before avformat_write_header().
1383      */
1384     int64_t max_interleave_delta;
1385
1386     /**
1387      * Transport stream id.
1388      * This will be moved into demuxer private options. Thus no API/ABI compatibility
1389      */
1390     int ts_id;
1391
1392     /**
1393      * Audio preload in microseconds.
1394      * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1395      * - encoding: Set by user via AVOptions (NO direct access)
1396      * - decoding: unused
1397      */
1398     int audio_preload;
1399
1400     /**
1401      * Max chunk time in microseconds.
1402      * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1403      * - encoding: Set by user via AVOptions (NO direct access)
1404      * - decoding: unused
1405      */
1406     int max_chunk_duration;
1407
1408     /**
1409      * Max chunk size in bytes
1410      * Note, not all formats support this and unpredictable things may happen if it is used when not supported.
1411      * - encoding: Set by user via AVOptions (NO direct access)
1412      * - decoding: unused
1413      */
1414     int max_chunk_size;
1415
1416     /**
1417      * forces the use of wallclock timestamps as pts/dts of packets
1418      * This has undefined results in the presence of B frames.
1419      * - encoding: unused
1420      * - decoding: Set by user via AVOptions (NO direct access)
1421      */
1422     int use_wallclock_as_timestamps;
1423
1424     /**
1425      * Avoid negative timestamps during muxing.
1426      *  0 -> allow negative timestamps
1427      *  1 -> avoid negative timestamps
1428      * -1 -> choose automatically (default)
1429      * Note, this only works when interleave_packet_per_dts is in use.
1430      * - encoding: Set by user via AVOptions (NO direct access)
1431      * - decoding: unused
1432      */
1433     int avoid_negative_ts;
1434
1435     /**
1436      * avio flags, used to force AVIO_FLAG_DIRECT.
1437      * - encoding: unused
1438      * - decoding: Set by user via AVOptions (NO direct access)
1439      */
1440     int avio_flags;
1441
1442     /**
1443      * The duration field can be estimated through various ways, and this field can be used
1444      * to know how the duration was estimated.
1445      * - encoding: unused
1446      * - decoding: Read by user via AVOptions (NO direct access)
1447      */
1448     enum AVDurationEstimationMethod duration_estimation_method;
1449
1450     /**
1451      * Skip initial bytes when opening stream
1452      * - encoding: unused
1453      * - decoding: Set by user via AVOptions (NO direct access)
1454      */
1455     unsigned int skip_initial_bytes;
1456
1457     /**
1458      * Correct single timestamp overflows
1459      * - encoding: unused
1460      * - decoding: Set by user via AVOptions (NO direct access)
1461      */
1462     unsigned int correct_ts_overflow;
1463
1464     /**
1465      * Force seeking to any (also non key) frames.
1466      * - encoding: unused
1467      * - decoding: Set by user via AVOptions (NO direct access)
1468      */
1469     int seek2any;
1470
1471     /**
1472      * Flush the I/O context after each packet.
1473      * - encoding: Set by user via AVOptions (NO direct access)
1474      * - decoding: unused
1475      */
1476     int flush_packets;
1477
1478     /**
1479      * format probing score.
1480      * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes
1481      * the format.
1482      * - encoding: unused
1483      * - decoding: set by avformat, read by user via av_format_get_probe_score() (NO direct access)
1484      */
1485     int probe_score;
1486
1487     /*****************************************************************
1488      * All fields below this line are not part of the public API. They
1489      * may not be used outside of libavformat and can be changed and
1490      * removed at will.
1491      * New public fields should be added right above.
1492      *****************************************************************
1493      */
1494
1495     /**
1496      * This buffer is only needed when packets were already buffered but
1497      * not decoded, for example to get the codec parameters in MPEG
1498      * streams.
1499      */
1500     struct AVPacketList *packet_buffer;
1501     struct AVPacketList *packet_buffer_end;
1502
1503     /* av_seek_frame() support */
1504     int64_t data_offset; /**< offset of the first packet */
1505
1506     /**
1507      * Raw packets from the demuxer, prior to parsing and decoding.
1508      * This buffer is used for buffering packets until the codec can
1509      * be identified, as parsing cannot be done without knowing the
1510      * codec.
1511      */
1512     struct AVPacketList *raw_packet_buffer;
1513     struct AVPacketList *raw_packet_buffer_end;
1514     /**
1515      * Packets split by the parser get queued here.
1516      */
1517     struct AVPacketList *parse_queue;
1518     struct AVPacketList *parse_queue_end;
1519     /**
1520      * Remaining size available for raw_packet_buffer, in bytes.
1521      */
1522 #define RAW_PACKET_BUFFER_SIZE 2500000
1523     int raw_packet_buffer_remaining_size;
1524
1525     /**
1526      * Offset to remap timestamps to be non-negative.
1527      * Expressed in timebase units.
1528      * @see AVStream.mux_ts_offset
1529      */
1530     int64_t offset;
1531
1532     /**
1533      * Timebase for the timestamp offset.
1534      */
1535     AVRational offset_timebase;
1536
1537     /**
1538      * An opaque field for libavformat internal usage.
1539      * Must not be accessed in any way by callers.
1540      */
1541     AVFormatInternal *internal;
1542
1543     /**
1544      * IO repositioned flag.
1545      * This is set by avformat when the underlaying IO context read pointer
1546      * is repositioned, for example when doing byte based seeking.
1547      * Demuxers can use the flag to detect such changes.
1548      */
1549     int io_repositioned;
1550
1551     /**
1552      * Forced video codec.
1553      * This allows forcing a specific decoder, even when there are multiple with
1554      * the same codec_id.
1555      * Demuxing: Set by user via av_format_set_video_codec (NO direct access).
1556      */
1557     AVCodec *video_codec;
1558
1559     /**
1560      * Forced audio codec.
1561      * This allows forcing a specific decoder, even when there are multiple with
1562      * the same codec_id.
1563      * Demuxing: Set by user via av_format_set_audio_codec (NO direct access).
1564      */
1565     AVCodec *audio_codec;
1566
1567     /**
1568      * Forced subtitle codec.
1569      * This allows forcing a specific decoder, even when there are multiple with
1570      * the same codec_id.
1571      * Demuxing: Set by user via av_format_set_subtitle_codec (NO direct access).
1572      */
1573     AVCodec *subtitle_codec;
1574
1575     /**
1576      * Number of bytes to be written as padding in a metadata header.
1577      * Demuxing: Unused.
1578      * Muxing: Set by user via av_format_set_metadata_header_padding.
1579      */
1580     int metadata_header_padding;
1581
1582     /**
1583      * User data.
1584      * This is a place for some private data of the user.
1585      * Mostly usable with control_message_cb or any future callbacks in device's context.
1586      */
1587     void *opaque;
1588
1589     /**
1590      * Callback used by devices to communicate with application.
1591      */
1592     av_format_control_message control_message_cb;
1593
1594     /**
1595      * Output timestamp offset, in microseconds.
1596      * Muxing: set by user via AVOptions (NO direct access)
1597      */
1598     int64_t output_ts_offset;
1599 } AVFormatContext;
1600
1601 int av_format_get_probe_score(const AVFormatContext *s);
1602 AVCodec * av_format_get_video_codec(const AVFormatContext *s);
1603 void      av_format_set_video_codec(AVFormatContext *s, AVCodec *c);
1604 AVCodec * av_format_get_audio_codec(const AVFormatContext *s);
1605 void      av_format_set_audio_codec(AVFormatContext *s, AVCodec *c);
1606 AVCodec * av_format_get_subtitle_codec(const AVFormatContext *s);
1607 void      av_format_set_subtitle_codec(AVFormatContext *s, AVCodec *c);
1608 int       av_format_get_metadata_header_padding(const AVFormatContext *s);
1609 void      av_format_set_metadata_header_padding(AVFormatContext *s, int c);
1610 void *    av_format_get_opaque(const AVFormatContext *s);
1611 void      av_format_set_opaque(AVFormatContext *s, void *opaque);
1612 av_format_control_message av_format_get_control_message_cb(const AVFormatContext *s);
1613 void      av_format_set_control_message_cb(AVFormatContext *s, av_format_control_message callback);
1614
1615 /**
1616  * Returns the method used to set ctx->duration.
1617  *
1618  * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE.
1619  */
1620 enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext* ctx);
1621
1622 typedef struct AVPacketList {
1623     AVPacket pkt;
1624     struct AVPacketList *next;
1625 } AVPacketList;
1626
1627
1628 /**
1629  * @defgroup lavf_core Core functions
1630  * @ingroup libavf
1631  *
1632  * Functions for querying libavformat capabilities, allocating core structures,
1633  * etc.
1634  * @{
1635  */
1636
1637 /**
1638  * Return the LIBAVFORMAT_VERSION_INT constant.
1639  */
1640 unsigned avformat_version(void);
1641
1642 /**
1643  * Return the libavformat build-time configuration.
1644  */
1645 const char *avformat_configuration(void);
1646
1647 /**
1648  * Return the libavformat license.
1649  */
1650 const char *avformat_license(void);
1651
1652 /**
1653  * Initialize libavformat and register all the muxers, demuxers and
1654  * protocols. If you do not call this function, then you can select
1655  * exactly which formats you want to support.
1656  *
1657  * @see av_register_input_format()
1658  * @see av_register_output_format()
1659  */
1660 void av_register_all(void);
1661
1662 void av_register_input_format(AVInputFormat *format);
1663 void av_register_output_format(AVOutputFormat *format);
1664
1665 /**
1666  * Do global initialization of network components. This is optional,
1667  * but recommended, since it avoids the overhead of implicitly
1668  * doing the setup for each session.
1669  *
1670  * Calling this function will become mandatory if using network
1671  * protocols at some major version bump.
1672  */
1673 int avformat_network_init(void);
1674
1675 /**
1676  * Undo the initialization done by avformat_network_init.
1677  */
1678 int avformat_network_deinit(void);
1679
1680 /**
1681  * If f is NULL, returns the first registered input format,
1682  * if f is non-NULL, returns the next registered input format after f
1683  * or NULL if f is the last one.
1684  */
1685 AVInputFormat  *av_iformat_next(AVInputFormat  *f);
1686
1687 /**
1688  * If f is NULL, returns the first registered output format,
1689  * if f is non-NULL, returns the next registered output format after f
1690  * or NULL if f is the last one.
1691  */
1692 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1693
1694 /**
1695  * Allocate an AVFormatContext.
1696  * avformat_free_context() can be used to free the context and everything
1697  * allocated by the framework within it.
1698  */
1699 AVFormatContext *avformat_alloc_context(void);
1700
1701 /**
1702  * Free an AVFormatContext and all its streams.
1703  * @param s context to free
1704  */
1705 void avformat_free_context(AVFormatContext *s);
1706
1707 /**
1708  * Get the AVClass for AVFormatContext. It can be used in combination with
1709  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1710  *
1711  * @see av_opt_find().
1712  */
1713 const AVClass *avformat_get_class(void);
1714
1715 /**
1716  * Add a new stream to a media file.
1717  *
1718  * When demuxing, it is called by the demuxer in read_header(). If the
1719  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1720  * be called in read_packet().
1721  *
1722  * When muxing, should be called by the user before avformat_write_header().
1723  *
1724  * User is required to call avcodec_close() and avformat_free_context() to
1725  * clean up the allocation by avformat_new_stream().
1726  *
1727  * @param s media file handle
1728  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1729  * will be initialized to use this codec. This is needed for e.g. codec-specific
1730  * defaults to be set, so codec should be provided if it is known.
1731  *
1732  * @return newly created stream or NULL on error.
1733  */
1734 AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c);
1735
1736 AVProgram *av_new_program(AVFormatContext *s, int id);
1737
1738 /**
1739  * @}
1740  */
1741
1742
1743 #if FF_API_ALLOC_OUTPUT_CONTEXT
1744 /**
1745  * @deprecated deprecated in favor of avformat_alloc_output_context2()
1746  */
1747 attribute_deprecated
1748 AVFormatContext *avformat_alloc_output_context(const char *format,
1749                                                AVOutputFormat *oformat,
1750                                                const char *filename);
1751 #endif
1752
1753 /**
1754  * Allocate an AVFormatContext for an output format.
1755  * avformat_free_context() can be used to free the context and
1756  * everything allocated by the framework within it.
1757  *
1758  * @param *ctx is set to the created format context, or to NULL in
1759  * case of failure
1760  * @param oformat format to use for allocating the context, if NULL
1761  * format_name and filename are used instead
1762  * @param format_name the name of output format to use for allocating the
1763  * context, if NULL filename is used instead
1764  * @param filename the name of the filename to use for allocating the
1765  * context, may be NULL
1766  * @return >= 0 in case of success, a negative AVERROR code in case of
1767  * failure
1768  */
1769 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1770                                    const char *format_name, const char *filename);
1771
1772 /**
1773  * @addtogroup lavf_decoding
1774  * @{
1775  */
1776
1777 /**
1778  * Find AVInputFormat based on the short name of the input format.
1779  */
1780 AVInputFormat *av_find_input_format(const char *short_name);
1781
1782 /**
1783  * Guess the file format.
1784  *
1785  * @param pd        data to be probed
1786  * @param is_opened Whether the file is already opened; determines whether
1787  *                  demuxers with or without AVFMT_NOFILE are probed.
1788  */
1789 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1790
1791 /**
1792  * Guess the file format.
1793  *
1794  * @param pd        data to be probed
1795  * @param is_opened Whether the file is already opened; determines whether
1796  *                  demuxers with or without AVFMT_NOFILE are probed.
1797  * @param score_max A probe score larger that this is required to accept a
1798  *                  detection, the variable is set to the actual detection
1799  *                  score afterwards.
1800  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1801  *                  to retry with a larger probe buffer.
1802  */
1803 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1804
1805 /**
1806  * Guess the file format.
1807  *
1808  * @param is_opened Whether the file is already opened; determines whether
1809  *                  demuxers with or without AVFMT_NOFILE are probed.
1810  * @param score_ret The score of the best detection.
1811  */
1812 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1813
1814 /**
1815  * Probe a bytestream to determine the input format. Each time a probe returns
1816  * with a score that is too low, the probe buffer size is increased and another
1817  * attempt is made. When the maximum probe size is reached, the input format
1818  * with the highest score is returned.
1819  *
1820  * @param pb the bytestream to probe
1821  * @param fmt the input format is put here
1822  * @param filename the filename of the stream
1823  * @param logctx the log context
1824  * @param offset the offset within the bytestream to probe from
1825  * @param max_probe_size the maximum probe buffer size (zero for default)
1826  * @return the score in case of success, a negative value corresponding to an
1827  *         the maximal score is AVPROBE_SCORE_MAX
1828  * AVERROR code otherwise
1829  */
1830 int av_probe_input_buffer2(AVIOContext *pb, AVInputFormat **fmt,
1831                            const char *filename, void *logctx,
1832                            unsigned int offset, unsigned int max_probe_size);
1833
1834 /**
1835  * Like av_probe_input_buffer2() but returns 0 on success
1836  */
1837 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1838                           const char *filename, void *logctx,
1839                           unsigned int offset, unsigned int max_probe_size);
1840
1841 /**
1842  * Open an input stream and read the header. The codecs are not opened.
1843  * The stream must be closed with avformat_close_input().
1844  *
1845  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1846  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1847  *           function and written into ps.
1848  *           Note that a user-supplied AVFormatContext will be freed on failure.
1849  * @param filename Name of the stream to open.
1850  * @param fmt If non-NULL, this parameter forces a specific input format.
1851  *            Otherwise the format is autodetected.
1852  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1853  *                 On return this parameter will be destroyed and replaced with a dict containing
1854  *                 options that were not found. May be NULL.
1855  *
1856  * @return 0 on success, a negative AVERROR on failure.
1857  *
1858  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1859  */
1860 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1861
1862 attribute_deprecated
1863 int av_demuxer_open(AVFormatContext *ic);
1864
1865 #if FF_API_FORMAT_PARAMETERS
1866 /**
1867  * Read packets of a media file to get stream information. This
1868  * is useful for file formats with no headers such as MPEG. This
1869  * function also computes the real framerate in case of MPEG-2 repeat
1870  * frame mode.
1871  * The logical file position is not changed by this function;
1872  * examined packets may be buffered for later processing.
1873  *
1874  * @param ic media file handle
1875  * @return >=0 if OK, AVERROR_xxx on error
1876  * @todo Let the user decide somehow what information is needed so that
1877  *       we do not waste time getting stuff the user does not need.
1878  *
1879  * @deprecated use avformat_find_stream_info.
1880  */
1881 attribute_deprecated
1882 int av_find_stream_info(AVFormatContext *ic);
1883 #endif
1884
1885 /**
1886  * Read packets of a media file to get stream information. This
1887  * is useful for file formats with no headers such as MPEG. This
1888  * function also computes the real framerate in case of MPEG-2 repeat
1889  * frame mode.
1890  * The logical file position is not changed by this function;
1891  * examined packets may be buffered for later processing.
1892  *
1893  * @param ic media file handle
1894  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1895  *                 dictionaries, where i-th member contains options for
1896  *                 codec corresponding to i-th stream.
1897  *                 On return each dictionary will be filled with options that were not found.
1898  * @return >=0 if OK, AVERROR_xxx on error
1899  *
1900  * @note this function isn't guaranteed to open all the codecs, so
1901  *       options being non-empty at return is a perfectly normal behavior.
1902  *
1903  * @todo Let the user decide somehow what information is needed so that
1904  *       we do not waste time getting stuff the user does not need.
1905  */
1906 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1907
1908 /**
1909  * Find the programs which belong to a given stream.
1910  *
1911  * @param ic    media file handle
1912  * @param last  the last found program, the search will start after this
1913  *              program, or from the beginning if it is NULL
1914  * @param s     stream index
1915  * @return the next program which belongs to s, NULL if no program is found or
1916  *         the last program is not among the programs of ic.
1917  */
1918 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s);
1919
1920 /**
1921  * Find the "best" stream in the file.
1922  * The best stream is determined according to various heuristics as the most
1923  * likely to be what the user expects.
1924  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1925  * default decoder for the stream's codec; streams for which no decoder can
1926  * be found are ignored.
1927  *
1928  * @param ic                media file handle
1929  * @param type              stream type: video, audio, subtitles, etc.
1930  * @param wanted_stream_nb  user-requested stream number,
1931  *                          or -1 for automatic selection
1932  * @param related_stream    try to find a stream related (eg. in the same
1933  *                          program) to this one, or -1 if none
1934  * @param decoder_ret       if non-NULL, returns the decoder for the
1935  *                          selected stream
1936  * @param flags             flags; none are currently defined
1937  * @return  the non-negative stream number in case of success,
1938  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1939  *          could be found,
1940  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1941  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1942  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1943  */
1944 int av_find_best_stream(AVFormatContext *ic,
1945                         enum AVMediaType type,
1946                         int wanted_stream_nb,
1947                         int related_stream,
1948                         AVCodec **decoder_ret,
1949                         int flags);
1950
1951 #if FF_API_READ_PACKET
1952 /**
1953  * @deprecated use AVFMT_FLAG_NOFILLIN | AVFMT_FLAG_NOPARSE to read raw
1954  * unprocessed packets
1955  *
1956  * Read a transport packet from a media file.
1957  *
1958  * This function is obsolete and should never be used.
1959  * Use av_read_frame() instead.
1960  *
1961  * @param s media file handle
1962  * @param pkt is filled
1963  * @return 0 if OK, AVERROR_xxx on error
1964  */
1965 attribute_deprecated
1966 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1967 #endif
1968
1969 /**
1970  * Return the next frame of a stream.
1971  * This function returns what is stored in the file, and does not validate
1972  * that what is there are valid frames for the decoder. It will split what is
1973  * stored in the file into frames and return one for each call. It will not
1974  * omit invalid data between valid frames so as to give the decoder the maximum
1975  * information possible for decoding.
1976  *
1977  * If pkt->buf is NULL, then the packet is valid until the next
1978  * av_read_frame() or until avformat_close_input(). Otherwise the packet
1979  * is valid indefinitely. In both cases the packet must be freed with
1980  * av_free_packet when it is no longer needed. For video, the packet contains
1981  * exactly one frame. For audio, it contains an integer number of frames if each
1982  * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1983  * have a variable size (e.g. MPEG audio), then it contains one frame.
1984  *
1985  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1986  * values in AVStream.time_base units (and guessed if the format cannot
1987  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1988  * has B-frames, so it is better to rely on pkt->dts if you do not
1989  * decompress the payload.
1990  *
1991  * @return 0 if OK, < 0 on error or end of file
1992  */
1993 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1994
1995 /**
1996  * Seek to the keyframe at timestamp.
1997  * 'timestamp' in 'stream_index'.
1998  *
1999  * @param s media file handle
2000  * @param stream_index If stream_index is (-1), a default
2001  * stream is selected, and timestamp is automatically converted
2002  * from AV_TIME_BASE units to the stream specific time_base.
2003  * @param timestamp Timestamp in AVStream.time_base units
2004  *        or, if no stream is specified, in AV_TIME_BASE units.
2005  * @param flags flags which select direction and seeking mode
2006  * @return >= 0 on success
2007  */
2008 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
2009                   int flags);
2010
2011 /**
2012  * Seek to timestamp ts.
2013  * Seeking will be done so that the point from which all active streams
2014  * can be presented successfully will be closest to ts and within min/max_ts.
2015  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
2016  *
2017  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
2018  * are the file position (this may not be supported by all demuxers).
2019  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
2020  * in the stream with stream_index (this may not be supported by all demuxers).
2021  * Otherwise all timestamps are in units of the stream selected by stream_index
2022  * or if stream_index is -1, in AV_TIME_BASE units.
2023  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
2024  * keyframes (this may not be supported by all demuxers).
2025  * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored.
2026  *
2027  * @param s media file handle
2028  * @param stream_index index of the stream which is used as time base reference
2029  * @param min_ts smallest acceptable timestamp
2030  * @param ts target timestamp
2031  * @param max_ts largest acceptable timestamp
2032  * @param flags flags
2033  * @return >=0 on success, error code otherwise
2034  *
2035  * @note This is part of the new seek API which is still under construction.
2036  *       Thus do not use this yet. It may change at any time, do not expect
2037  *       ABI compatibility yet!
2038  */
2039 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
2040
2041 /**
2042  * Start playing a network-based stream (e.g. RTSP stream) at the
2043  * current position.
2044  */
2045 int av_read_play(AVFormatContext *s);
2046
2047 /**
2048  * Pause a network-based stream (e.g. RTSP stream).
2049  *
2050  * Use av_read_play() to resume it.
2051  */
2052 int av_read_pause(AVFormatContext *s);
2053
2054 #if FF_API_CLOSE_INPUT_FILE
2055 /**
2056  * @deprecated use avformat_close_input()
2057  * Close a media file (but not its codecs).
2058  *
2059  * @param s media file handle
2060  */
2061 attribute_deprecated
2062 void av_close_input_file(AVFormatContext *s);
2063 #endif
2064
2065 /**
2066  * Close an opened input AVFormatContext. Free it and all its contents
2067  * and set *s to NULL.
2068  */
2069 void avformat_close_input(AVFormatContext **s);
2070 /**
2071  * @}
2072  */
2073
2074 #if FF_API_NEW_STREAM
2075 /**
2076  * Add a new stream to a media file.
2077  *
2078  * Can only be called in the read_header() function. If the flag
2079  * AVFMTCTX_NOHEADER is in the format context, then new streams
2080  * can be added in read_packet too.
2081  *
2082  * @param s media file handle
2083  * @param id file-format-dependent stream ID
2084  */
2085 attribute_deprecated
2086 AVStream *av_new_stream(AVFormatContext *s, int id);
2087 #endif
2088
2089 #if FF_API_SET_PTS_INFO
2090 /**
2091  * @deprecated this function is not supposed to be called outside of lavf
2092  */
2093 attribute_deprecated
2094 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
2095                      unsigned int pts_num, unsigned int pts_den);
2096 #endif
2097
2098 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
2099 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
2100 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
2101 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
2102
2103 /**
2104  * @addtogroup lavf_encoding
2105  * @{
2106  */
2107 /**
2108  * Allocate the stream private data and write the stream header to
2109  * an output media file.
2110  *
2111  * @param s Media file handle, must be allocated with avformat_alloc_context().
2112  *          Its oformat field must be set to the desired output format;
2113  *          Its pb field must be set to an already opened AVIOContext.
2114  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
2115  *                 On return this parameter will be destroyed and replaced with a dict containing
2116  *                 options that were not found. May be NULL.
2117  *
2118  * @return 0 on success, negative AVERROR on failure.
2119  *
2120  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
2121  */
2122 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
2123
2124 /**
2125  * Write a packet to an output media file.
2126  *
2127  * This function passes the packet directly to the muxer, without any buffering
2128  * or reordering. The caller is responsible for correctly interleaving the
2129  * packets if the format requires it. Callers that want libavformat to handle
2130  * the interleaving should call av_interleaved_write_frame() instead of this
2131  * function.
2132  *
2133  * @param s media file handle
2134  * @param pkt The packet containing the data to be written. Note that unlike
2135  *            av_interleaved_write_frame(), this function does not take
2136  *            ownership of the packet passed to it (though some muxers may make
2137  *            an internal reference to the input packet).
2138  *            <br>
2139  *            This parameter can be NULL (at any time, not just at the end), in
2140  *            order to immediately flush data buffered within the muxer, for
2141  *            muxers that buffer up data internally before writing it to the
2142  *            output.
2143  *            <br>
2144  *            Packet's @ref AVPacket.stream_index "stream_index" field must be
2145  *            set to the index of the corresponding stream in @ref
2146  *            AVFormatContext.streams "s->streams". It is very strongly
2147  *            recommended that timing information (@ref AVPacket.pts "pts", @ref
2148  *            AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
2149  *            correct values.
2150  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
2151  *
2152  * @see av_interleaved_write_frame()
2153  */
2154 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
2155
2156 /**
2157  * Write a packet to an output media file ensuring correct interleaving.
2158  *
2159  * This function will buffer the packets internally as needed to make sure the
2160  * packets in the output file are properly interleaved in the order of
2161  * increasing dts. Callers doing their own interleaving should call
2162  * av_write_frame() instead of this function.
2163  *
2164  * @param s media file handle
2165  * @param pkt The packet containing the data to be written.
2166  *            <br>
2167  *            If the packet is reference-counted, this function will take
2168  *            ownership of this reference and unreference it later when it sees
2169  *            fit.
2170  *            The caller must not access the data through this reference after
2171  *            this function returns. If the packet is not reference-counted,
2172  *            libavformat will make a copy.
2173  *            <br>
2174  *            This parameter can be NULL (at any time, not just at the end), to
2175  *            flush the interleaving queues.
2176  *            <br>
2177  *            Packet's @ref AVPacket.stream_index "stream_index" field must be
2178  *            set to the index of the corresponding stream in @ref
2179  *            AVFormatContext.streams "s->streams". It is very strongly
2180  *            recommended that timing information (@ref AVPacket.pts "pts", @ref
2181  *            AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
2182  *            correct values.
2183  *
2184  * @return 0 on success, a negative AVERROR on error. Libavformat will always
2185  *         take care of freeing the packet, even if this function fails.
2186  *
2187  * @see av_write_frame(), AVFormatContext.max_interleave_delta
2188  */
2189 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
2190
2191 /**
2192  * Write a uncoded frame to an output media file.
2193  *
2194  * The frame must be correctly interleaved according to the container
2195  * specification; if not, then av_interleaved_write_frame() must be used.
2196  *
2197  * See av_interleaved_write_frame() for details.
2198  */
2199 int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
2200                            AVFrame *frame);
2201
2202 /**
2203  * Write a uncoded frame to an output media file.
2204  *
2205  * If the muxer supports it, this function allows to write an AVFrame
2206  * structure directly, without encoding it into a packet.
2207  * It is mostly useful for devices and similar special muxers that use raw
2208  * video or PCM data and will not serialize it into a byte stream.
2209  *
2210  * To test whether it is possible to use it with a given muxer and stream,
2211  * use av_write_uncoded_frame_query().
2212  *
2213  * The caller gives up ownership of the frame and must not access it
2214  * afterwards.
2215  *
2216  * @return  >=0 for success, a negative code on error
2217  */
2218 int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index,
2219                                        AVFrame *frame);
2220
2221 /**
2222  * Test whether a muxer supports uncoded frame.
2223  *
2224  * @return  >=0 if an uncoded frame can be written to that muxer and stream,
2225  *          <0 if not
2226  */
2227 int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index);
2228
2229 /**
2230  * Write the stream trailer to an output media file and free the
2231  * file private data.
2232  *
2233  * May only be called after a successful call to avformat_write_header.
2234  *
2235  * @param s media file handle
2236  * @return 0 if OK, AVERROR_xxx on error
2237  */
2238 int av_write_trailer(AVFormatContext *s);
2239
2240 /**
2241  * Return the output format in the list of registered output formats
2242  * which best matches the provided parameters, or return NULL if
2243  * there is no match.
2244  *
2245  * @param short_name if non-NULL checks if short_name matches with the
2246  * names of the registered formats
2247  * @param filename if non-NULL checks if filename terminates with the
2248  * extensions of the registered formats
2249  * @param mime_type if non-NULL checks if mime_type matches with the
2250  * MIME type of the registered formats
2251  */
2252 AVOutputFormat *av_guess_format(const char *short_name,
2253                                 const char *filename,
2254                                 const char *mime_type);
2255
2256 /**
2257  * Guess the codec ID based upon muxer and filename.
2258  */
2259 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
2260                             const char *filename, const char *mime_type,
2261                             enum AVMediaType type);
2262
2263 /**
2264  * Get timing information for the data currently output.
2265  * The exact meaning of "currently output" depends on the format.
2266  * It is mostly relevant for devices that have an internal buffer and/or
2267  * work in real time.
2268  * @param s          media file handle
2269  * @param stream     stream in the media file
2270  * @param[out] dts   DTS of the last packet output for the stream, in stream
2271  *                   time_base units
2272  * @param[out] wall  absolute time when that packet whas output,
2273  *                   in microsecond
2274  * @return  0 if OK, AVERROR(ENOSYS) if the format does not support it
2275  * Note: some formats or devices may not allow to measure dts and wall
2276  * atomically.
2277  */
2278 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
2279                             int64_t *dts, int64_t *wall);
2280
2281
2282 /**
2283  * @}
2284  */
2285
2286
2287 /**
2288  * @defgroup lavf_misc Utility functions
2289  * @ingroup libavf
2290  * @{
2291  *
2292  * Miscellaneous utility functions related to both muxing and demuxing
2293  * (or neither).
2294  */
2295
2296 /**
2297  * Send a nice hexadecimal dump of a buffer to the specified file stream.
2298  *
2299  * @param f The file stream pointer where the dump should be sent to.
2300  * @param buf buffer
2301  * @param size buffer size
2302  *
2303  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
2304  */
2305 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
2306
2307 /**
2308  * Send a nice hexadecimal dump of a buffer to the log.
2309  *
2310  * @param avcl A pointer to an arbitrary struct of which the first field is a
2311  * pointer to an AVClass struct.
2312  * @param level The importance level of the message, lower values signifying
2313  * higher importance.
2314  * @param buf buffer
2315  * @param size buffer size
2316  *
2317  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
2318  */
2319 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
2320
2321 /**
2322  * Send a nice dump of a packet to the specified file stream.
2323  *
2324  * @param f The file stream pointer where the dump should be sent to.
2325  * @param pkt packet to dump
2326  * @param dump_payload True if the payload must be displayed, too.
2327  * @param st AVStream that the packet belongs to
2328  */
2329 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st);
2330
2331
2332 /**
2333  * Send a nice dump of a packet to the log.
2334  *
2335  * @param avcl A pointer to an arbitrary struct of which the first field is a
2336  * pointer to an AVClass struct.
2337  * @param level The importance level of the message, lower values signifying
2338  * higher importance.
2339  * @param pkt packet to dump
2340  * @param dump_payload True if the payload must be displayed, too.
2341  * @param st AVStream that the packet belongs to
2342  */
2343 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
2344                       const AVStream *st);
2345
2346 /**
2347  * Get the AVCodecID for the given codec tag tag.
2348  * If no codec id is found returns AV_CODEC_ID_NONE.
2349  *
2350  * @param tags list of supported codec_id-codec_tag pairs, as stored
2351  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2352  * @param tag  codec tag to match to a codec ID
2353  */
2354 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
2355
2356 /**
2357  * Get the codec tag for the given codec id id.
2358  * If no codec tag is found returns 0.
2359  *
2360  * @param tags list of supported codec_id-codec_tag pairs, as stored
2361  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2362  * @param id   codec ID to match to a codec tag
2363  */
2364 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
2365
2366 /**
2367  * Get the codec tag for the given codec id.
2368  *
2369  * @param tags list of supported codec_id - codec_tag pairs, as stored
2370  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
2371  * @param id codec id that should be searched for in the list
2372  * @param tag A pointer to the found tag
2373  * @return 0 if id was not found in tags, > 0 if it was found
2374  */
2375 int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id,
2376                       unsigned int *tag);
2377
2378 int av_find_default_stream_index(AVFormatContext *s);
2379
2380 /**
2381  * Get the index for a specific timestamp.
2382  *
2383  * @param st        stream that the timestamp belongs to
2384  * @param timestamp timestamp to retrieve the index for
2385  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
2386  *                 to the timestamp which is <= the requested one, if backward
2387  *                 is 0, then it will be >=
2388  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
2389  * @return < 0 if no such timestamp could be found
2390  */
2391 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
2392
2393 /**
2394  * Add an index entry into a sorted list. Update the entry if the list
2395  * already contains it.
2396  *
2397  * @param timestamp timestamp in the time base of the given stream
2398  */
2399 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
2400                        int size, int distance, int flags);
2401
2402
2403 /**
2404  * Split a URL string into components.
2405  *
2406  * The pointers to buffers for storing individual components may be null,
2407  * in order to ignore that component. Buffers for components not found are
2408  * set to empty strings. If the port is not found, it is set to a negative
2409  * value.
2410  *
2411  * @param proto the buffer for the protocol
2412  * @param proto_size the size of the proto buffer
2413  * @param authorization the buffer for the authorization
2414  * @param authorization_size the size of the authorization buffer
2415  * @param hostname the buffer for the host name
2416  * @param hostname_size the size of the hostname buffer
2417  * @param port_ptr a pointer to store the port number in
2418  * @param path the buffer for the path
2419  * @param path_size the size of the path buffer
2420  * @param url the URL to split
2421  */
2422 void av_url_split(char *proto,         int proto_size,
2423                   char *authorization, int authorization_size,
2424                   char *hostname,      int hostname_size,
2425                   int *port_ptr,
2426                   char *path,          int path_size,
2427                   const char *url);
2428
2429 /**
2430  * log a nice Dump of input format context or output format context
2431  * @param ic already initialized Format Context, must not be NULL.
2432  * @param index index of the stream to dump information about
2433  * @param url name of file or URL of stream to print information about
2434  * @param is_output Select whether specified context is of input(0) or output(1)
2435  */
2436 void av_dump_format(AVFormatContext *ic,
2437                     int index,
2438                     const char *url,
2439                     int is_output);
2440
2441 /**
2442  * Return in 'buf' the path with '%d' replaced by a number.
2443  *
2444  * Also handles the '%0nd' format where 'n' is the total number
2445  * of digits and '%%'.
2446  *
2447  * @param buf destination buffer
2448  * @param buf_size destination buffer size
2449  * @param path numbered sequence string
2450  * @param number frame number
2451  * @return 0 if OK, -1 on format error
2452  */
2453 int av_get_frame_filename(char *buf, int buf_size,
2454                           const char *path, int number);
2455
2456 /**
2457  * Check whether filename actually is a numbered sequence generator.
2458  *
2459  * @param filename possible numbered sequence string
2460  * @return 1 if a valid numbered sequence string, 0 otherwise
2461  */
2462 int av_filename_number_test(const char *filename);
2463
2464 /**
2465  * Generate an SDP for an RTP session.
2466  *
2467  * Note, this overwrites the id values of AVStreams in the muxer contexts
2468  * for getting unique dynamic payload types.
2469  *
2470  * @param ac array of AVFormatContexts describing the RTP streams. If the
2471  *           array is composed by only one context, such context can contain
2472  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
2473  *           all the contexts in the array (an AVCodecContext per RTP stream)
2474  *           must contain only one AVStream.
2475  * @param n_files number of AVCodecContexts contained in ac
2476  * @param buf buffer where the SDP will be stored (must be allocated by
2477  *            the caller)
2478  * @param size the size of the buffer
2479  * @return 0 if OK, AVERROR_xxx on error
2480  */
2481 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
2482
2483 /**
2484  * Return a positive value if the given filename has one of the given
2485  * extensions, 0 otherwise.
2486  *
2487  * @param filename   file name to check against the given extensions
2488  * @param extensions a comma-separated list of filename extensions
2489  */
2490 int av_match_ext(const char *filename, const char *extensions);
2491
2492 /**
2493  * Test if the given container can store a codec.
2494  *
2495  * @param ofmt           container to check for compatibility
2496  * @param codec_id       codec to potentially store in container
2497  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
2498  *
2499  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
2500  *         A negative number if this information is not available.
2501  */
2502 int avformat_query_codec(AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance);
2503
2504 /**
2505  * @defgroup riff_fourcc RIFF FourCCs
2506  * @{
2507  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
2508  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
2509  * following code:
2510  * @code
2511  * uint32_t tag = MKTAG('H', '2', '6', '4');
2512  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
2513  * enum AVCodecID id = av_codec_get_id(table, tag);
2514  * @endcode
2515  */
2516 /**
2517  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
2518  */
2519 const struct AVCodecTag *avformat_get_riff_video_tags(void);
2520 /**
2521  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
2522  */
2523 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2524 /**
2525  * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID.
2526  */
2527 const struct AVCodecTag *avformat_get_mov_video_tags(void);
2528 /**
2529  * @return the table mapping MOV FourCCs for audio to AVCodecID.
2530  */
2531 const struct AVCodecTag *avformat_get_mov_audio_tags(void);
2532
2533 /**
2534  * @}
2535  */
2536
2537 /**
2538  * Guess the sample aspect ratio of a frame, based on both the stream and the
2539  * frame aspect ratio.
2540  *
2541  * Since the frame aspect ratio is set by the codec but the stream aspect ratio
2542  * is set by the demuxer, these two may not be equal. This function tries to
2543  * return the value that you should use if you would like to display the frame.
2544  *
2545  * Basic logic is to use the stream aspect ratio if it is set to something sane
2546  * otherwise use the frame aspect ratio. This way a container setting, which is
2547  * usually easy to modify can override the coded value in the frames.
2548  *
2549  * @param format the format context which the stream is part of
2550  * @param stream the stream which the frame is part of
2551  * @param frame the frame with the aspect ratio to be determined
2552  * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea
2553  */
2554 AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame);
2555
2556 /**
2557  * Guess the frame rate, based on both the container and codec information.
2558  *
2559  * @param ctx the format context which the stream is part of
2560  * @param stream the stream which the frame is part of
2561  * @param frame the frame for which the frame rate should be determined, may be NULL
2562  * @return the guessed (valid) frame rate, 0/1 if no idea
2563  */
2564 AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame);
2565
2566 /**
2567  * Check if the stream st contained in s is matched by the stream specifier
2568  * spec.
2569  *
2570  * See the "stream specifiers" chapter in the documentation for the syntax
2571  * of spec.
2572  *
2573  * @return  >0 if st is matched by spec;
2574  *          0  if st is not matched by spec;
2575  *          AVERROR code if spec is invalid
2576  *
2577  * @note  A stream specifier can match several streams in the format.
2578  */
2579 int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st,
2580                                     const char *spec);
2581
2582 int avformat_queue_attached_pictures(AVFormatContext *s);
2583
2584
2585 /**
2586  * @}
2587  */
2588
2589 #endif /* AVFORMAT_AVFORMAT_H */