lavf: add AVFormatContext.max_ts_probe
[ffmpeg.git] / libavformat / avformat.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVFORMAT_AVFORMAT_H
22 #define AVFORMAT_AVFORMAT_H
23
24 /**
25  * @file
26  * @ingroup libavf
27  * Main libavformat public API header
28  */
29
30 /**
31  * @defgroup libavf I/O and Muxing/Demuxing Library
32  * @{
33  *
34  * Libavformat (lavf) is a library for dealing with various media container
35  * formats. Its main two purposes are demuxing - i.e. splitting a media file
36  * into component streams, and the reverse process of muxing - writing supplied
37  * data in a specified container format. It also has an @ref lavf_io
38  * "I/O module" which supports a number of protocols for accessing the data (e.g.
39  * file, tcp, http and others). Before using lavf, you need to call
40  * av_register_all() to register all compiled muxers, demuxers and protocols.
41  * Unless you are absolutely sure you won't use libavformat's network
42  * capabilities, you should also call avformat_network_init().
43  *
44  * A supported input format is described by an AVInputFormat struct, conversely
45  * an output format is described by AVOutputFormat. You can iterate over all
46  * registered input/output formats using the av_iformat_next() /
47  * av_oformat_next() functions. The protocols layer is not part of the public
48  * API, so you can only get the names of supported protocols with the
49  * avio_enum_protocols() function.
50  *
51  * Main lavf structure used for both muxing and demuxing is AVFormatContext,
52  * which exports all information about the file being read or written. As with
53  * most Libav structures, its size is not part of public ABI, so it cannot be
54  * allocated on stack or directly with av_malloc(). To create an
55  * AVFormatContext, use avformat_alloc_context() (some functions, like
56  * avformat_open_input() might do that for you).
57  *
58  * Most importantly an AVFormatContext contains:
59  * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
60  * "output" format. It is either autodetected or set by user for input;
61  * always set by user for output.
62  * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
63  * elementary streams stored in the file. AVStreams are typically referred to
64  * using their index in this array.
65  * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
66  * set by user for input, always set by user for output (unless you are dealing
67  * with an AVFMT_NOFILE format).
68  *
69  * @section lavf_options Passing options to (de)muxers
70  * Lavf allows to configure muxers and demuxers using the @ref avoptions
71  * mechanism. Generic (format-independent) libavformat options are provided by
72  * AVFormatContext, they can be examined from a user program by calling
73  * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
74  * from avformat_get_class()). Private (format-specific) options are provided by
75  * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
76  * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
77  * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
78  * if its AVClass is non-NULL, and the protocols layer. See the discussion on
79  * nesting in @ref avoptions documentation to learn how to access those.
80  *
81  * @defgroup lavf_decoding Demuxing
82  * @{
83  * Demuxers read a media file and split it into chunks of data (@em packets). A
84  * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
85  * single elementary stream. In the lavf API this process is represented by the
86  * avformat_open_input() function for opening a file, av_read_frame() for
87  * reading a single packet and finally avformat_close_input(), which does the
88  * cleanup.
89  *
90  * @section lavf_decoding_open Opening a media file
91  * The minimum information required to open a file is its URL or filename, which
92  * is passed to avformat_open_input(), as in the following code:
93  * @code
94  * const char    *url = "in.mp3";
95  * AVFormatContext *s = NULL;
96  * int ret = avformat_open_input(&s, url, NULL, NULL);
97  * if (ret < 0)
98  *     abort();
99  * @endcode
100  * The above code attempts to allocate an AVFormatContext, open the
101  * specified file (autodetecting the format) and read the header, exporting the
102  * information stored there into s. Some formats do not have a header or do not
103  * store enough information there, so it is recommended that you call the
104  * avformat_find_stream_info() function which tries to read and decode a few
105  * frames to find missing information.
106  *
107  * In some cases you might want to preallocate an AVFormatContext yourself with
108  * avformat_alloc_context() and do some tweaking on it before passing it to
109  * avformat_open_input(). One such case is when you want to use custom functions
110  * for reading input data instead of lavf internal I/O layer.
111  * To do that, create your own AVIOContext with avio_alloc_context(), passing
112  * your reading callbacks to it. Then set the @em pb field of your
113  * AVFormatContext to newly created AVIOContext.
114  *
115  * Since the format of the opened file is in general not known until after
116  * avformat_open_input() has returned, it is not possible to set demuxer private
117  * options on a preallocated context. Instead, the options should be passed to
118  * avformat_open_input() wrapped in an AVDictionary:
119  * @code
120  * AVDictionary *options = NULL;
121  * av_dict_set(&options, "video_size", "640x480", 0);
122  * av_dict_set(&options, "pixel_format", "rgb24", 0);
123  *
124  * if (avformat_open_input(&s, url, NULL, &options) < 0)
125  *     abort();
126  * av_dict_free(&options);
127  * @endcode
128  * This code passes the private options 'video_size' and 'pixel_format' to the
129  * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
130  * cannot know how to interpret raw video data otherwise. If the format turns
131  * out to be something different than raw video, those options will not be
132  * recognized by the demuxer and therefore will not be applied. Such unrecognized
133  * options are then returned in the options dictionary (recognized options are
134  * consumed). The calling program can handle such unrecognized options as it
135  * wishes, e.g.
136  * @code
137  * AVDictionaryEntry *e;
138  * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
139  *     fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
140  *     abort();
141  * }
142  * @endcode
143  *
144  * After you have finished reading the file, you must close it with
145  * avformat_close_input(). It will free everything associated with the file.
146  *
147  * @section lavf_decoding_read Reading from an opened file
148  * Reading data from an opened AVFormatContext is done by repeatedly calling
149  * av_read_frame() on it. Each call, if successful, will return an AVPacket
150  * containing encoded data for one AVStream, identified by
151  * AVPacket.stream_index. This packet may be passed straight into the libavcodec
152  * decoding functions avcodec_decode_video2(), avcodec_decode_audio4() or
153  * avcodec_decode_subtitle2() if the caller wishes to decode the data.
154  *
155  * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
156  * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
157  * pts/dts, 0 for duration) if the stream does not provide them. The timing
158  * information will be in AVStream.time_base units, i.e. it has to be
159  * multiplied by the timebase to convert them to seconds.
160  *
161  * 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 AVStream.time_base "stream 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
222  * requested by the caller.
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
265 /**
266  * @defgroup metadata_api Public Metadata API
267  * @{
268  * @ingroup libavf
269  * The metadata API allows libavformat to export metadata tags to a client
270  * application when demuxing. Conversely it allows a client application to
271  * set metadata when muxing.
272  *
273  * Metadata is exported or set as pairs of key/value strings in the 'metadata'
274  * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
275  * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
276  * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
277  * exported by demuxers isn't checked to be valid UTF-8 in most cases.
278  *
279  * Important concepts to keep in mind:
280  * -  Keys are unique; there can never be 2 tags with the same key. This is
281  *    also meant semantically, i.e., a demuxer should not knowingly produce
282  *    several keys that are literally different but semantically identical.
283  *    E.g., key=Author5, key=Author6. In this example, all authors must be
284  *    placed in the same tag.
285  * -  Metadata is flat, not hierarchical; there are no subtags. If you
286  *    want to store, e.g., the email address of the child of producer Alice
287  *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
288  * -  Several modifiers can be applied to the tag name. This is done by
289  *    appending a dash character ('-') and the modifier name in the order
290  *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
291  *    -  language -- a tag whose value is localized for a particular language
292  *       is appended with the ISO 639-2/B 3-letter language code.
293  *       For example: Author-ger=Michael, Author-eng=Mike
294  *       The original/default language is in the unqualified "Author" tag.
295  *       A demuxer should set a default if it sets any translated tag.
296  *    -  sorting  -- a modified version of a tag that should be used for
297  *       sorting will have '-sort' appended. E.g. artist="The Beatles",
298  *       artist-sort="Beatles, The".
299  * - Some protocols and demuxers support metadata updates. After a successful
300  *   call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags
301  *   will be updated to indicate if metadata changed. In order to detect metadata
302  *   changes on a stream, you need to loop through all streams in the AVFormatContext
303  *   and check their individual event_flags.
304  *
305  * -  Demuxers attempt to export metadata in a generic format, however tags
306  *    with no generic equivalents are left as they are stored in the container.
307  *    Follows a list of generic tag names:
308  *
309  @verbatim
310  album        -- name of the set this work belongs to
311  album_artist -- main creator of the set/album, if different from artist.
312                  e.g. "Various Artists" for compilation albums.
313  artist       -- main creator of the work
314  comment      -- any additional description of the file.
315  composer     -- who composed the work, if different from artist.
316  copyright    -- name of copyright holder.
317  creation_time-- date when the file was created, preferably in ISO 8601.
318  date         -- date when the work was created, preferably in ISO 8601.
319  disc         -- number of a subset, e.g. disc in a multi-disc collection.
320  encoder      -- name/settings of the software/hardware that produced the file.
321  encoded_by   -- person/group who created the file.
322  filename     -- original name of the file.
323  genre        -- <self-evident>.
324  language     -- main language in which the work is performed, preferably
325                  in ISO 639-2 format. Multiple languages can be specified by
326                  separating them with commas.
327  performer    -- artist who performed the work, if different from artist.
328                  E.g for "Also sprach Zarathustra", artist would be "Richard
329                  Strauss" and performer "London Philharmonic Orchestra".
330  publisher    -- name of the label/publisher.
331  service_name     -- name of the service in broadcasting (channel name).
332  service_provider -- name of the service provider in broadcasting.
333  title        -- name of the work.
334  track        -- number of this work in the set, can be in form current/total.
335  variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
336  @endverbatim
337  *
338  * Look in the examples section for an application example how to use the Metadata API.
339  *
340  * @}
341  */
342
343 /* packet functions */
344
345
346 /**
347  * Allocate and read the payload of a packet and initialize its
348  * fields with default values.
349  *
350  * @param s    associated IO context
351  * @param pkt packet
352  * @param size desired payload size
353  * @return >0 (read size) if OK, AVERROR_xxx otherwise
354  */
355 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
356
357
358 /**
359  * Read data and append it to the current content of the AVPacket.
360  * If pkt->size is 0 this is identical to av_get_packet.
361  * Note that this uses av_grow_packet and thus involves a realloc
362  * which is inefficient. Thus this function should only be used
363  * when there is no reasonable way to know (an upper bound of)
364  * the final size.
365  *
366  * @param s    associated IO context
367  * @param pkt packet
368  * @param size amount of data to read
369  * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
370  *         will not be lost even if an error occurs.
371  */
372 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
373
374 #if FF_API_LAVF_FRAC
375 /*************************************************/
376 /* fractional numbers for exact pts handling */
377
378 /**
379  * The exact value of the fractional number is: 'val + num / den'.
380  * num is assumed to be 0 <= num < den.
381  */
382 typedef struct AVFrac {
383     int64_t val, num, den;
384 } AVFrac;
385 #endif
386
387 /*************************************************/
388 /* input/output formats */
389
390 struct AVCodecTag;
391
392 /**
393  * This structure contains the data a format has to probe a file.
394  */
395 typedef struct AVProbeData {
396     const char *filename;
397     unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
398     int buf_size;       /**< Size of buf except extra allocated bytes */
399     uint8_t *mime_type; /**< mime_type, when known. */
400 } AVProbeData;
401
402 #define AVPROBE_SCORE_EXTENSION  50 ///< score for file extension
403 #define AVPROBE_SCORE_MIME       75 ///< score for file mime type
404 #define AVPROBE_SCORE_MAX       100 ///< maximum score
405
406 #define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
407
408 /// Demuxer will use avio_open, no opened file should be provided by the caller.
409 #define AVFMT_NOFILE        0x0001
410 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
411 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
412 #define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
413                                       raw picture data. */
414 #define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
415 #define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
416 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
417 #define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
418 #define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
419 #define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
420 #define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
421 #define AVFMT_NOBINSEARCH   0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
422 #define AVFMT_NOGENSEARCH   0x4000 /**< Format does not allow to fall back on generic search */
423 #define AVFMT_NO_BYTE_SEEK  0x8000 /**< Format does not allow seeking by bytes */
424 #define AVFMT_ALLOW_FLUSH  0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
425 #define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
426                                         increasing timestamps, but they must
427                                         still be monotonic */
428 #define AVFMT_TS_NEGATIVE  0x40000 /**< Format allows muxing negative
429                                         timestamps. If not set the timestamp
430                                         will be shifted in av_write_frame and
431                                         av_interleaved_write_frame so they
432                                         start from 0. */
433
434 /**
435  * @addtogroup lavf_encoding
436  * @{
437  */
438 typedef struct AVOutputFormat {
439     const char *name;
440     /**
441      * Descriptive name for the format, meant to be more human-readable
442      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
443      * to define it.
444      */
445     const char *long_name;
446     const char *mime_type;
447     const char *extensions; /**< comma-separated filename extensions */
448     /* output support */
449     enum AVCodecID audio_codec;    /**< default audio codec */
450     enum AVCodecID video_codec;    /**< default video codec */
451     enum AVCodecID subtitle_codec; /**< default subtitle codec */
452     /**
453      * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
454      * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
455      * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
456      * AVFMT_TS_NONSTRICT
457      */
458     int flags;
459
460     /**
461      * List of supported codec_id-codec_tag pairs, ordered by "better
462      * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
463      */
464     const struct AVCodecTag * const *codec_tag;
465
466
467     const AVClass *priv_class; ///< AVClass for the private context
468
469     /*****************************************************************
470      * No fields below this line are part of the public API. They
471      * may not be used outside of libavformat and can be changed and
472      * removed at will.
473      * New public fields should be added right above.
474      *****************************************************************
475      */
476     struct AVOutputFormat *next;
477     /**
478      * size of private data so that it can be allocated in the wrapper
479      */
480     int priv_data_size;
481
482     int (*write_header)(struct AVFormatContext *);
483     /**
484      * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
485      * pkt can be NULL in order to flush data buffered in the muxer.
486      * When flushing, return 0 if there still is more data to flush,
487      * or 1 if everything was flushed and there is no more buffered
488      * data.
489      */
490     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
491     int (*write_trailer)(struct AVFormatContext *);
492     /**
493      * Currently only used to set pixel format if not YUV420P.
494      */
495     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
496                              AVPacket *in, int flush);
497     /**
498      * Test if the given codec can be stored in this container.
499      *
500      * @return 1 if the codec is supported, 0 if it is not.
501      *         A negative number if unknown.
502      */
503     int (*query_codec)(enum AVCodecID id, int std_compliance);
504 } AVOutputFormat;
505 /**
506  * @}
507  */
508
509 /**
510  * @addtogroup lavf_decoding
511  * @{
512  */
513 typedef struct AVInputFormat {
514     /**
515      * A comma separated list of short names for the format. New names
516      * may be appended with a minor bump.
517      */
518     const char *name;
519
520     /**
521      * Descriptive name for the format, meant to be more human-readable
522      * than name. You should use the NULL_IF_CONFIG_SMALL() macro
523      * to define it.
524      */
525     const char *long_name;
526
527     /**
528      * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
529      * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
530      * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
531      */
532     int flags;
533
534     /**
535      * If extensions are defined, then no probe is done. You should
536      * usually not use extension format guessing because it is not
537      * reliable enough
538      */
539     const char *extensions;
540
541     const struct AVCodecTag * const *codec_tag;
542
543     const AVClass *priv_class; ///< AVClass for the private context
544
545     /**
546      * Comma-separated list of mime types.
547      * It is used check for matching mime types while probing.
548      * @see av_probe_input_format2
549      */
550     const char *mime_type;
551
552     /*****************************************************************
553      * No fields below this line are part of the public API. They
554      * may not be used outside of libavformat and can be changed and
555      * removed at will.
556      * New public fields should be added right above.
557      *****************************************************************
558      */
559     struct AVInputFormat *next;
560
561     /**
562      * Raw demuxers store their codec ID here.
563      */
564     int raw_codec_id;
565
566     /**
567      * Size of private data so that it can be allocated in the wrapper.
568      */
569     int priv_data_size;
570
571     /**
572      * Tell if a given file has a chance of being parsed as this format.
573      * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
574      * big so you do not have to check for that unless you need more.
575      */
576     int (*read_probe)(AVProbeData *);
577
578     /**
579      * Read the format header and initialize the AVFormatContext
580      * structure. Return 0 if OK. Only used in raw format right
581      * now. 'avformat_new_stream' should be called to create new streams.
582      */
583     int (*read_header)(struct AVFormatContext *);
584
585     /**
586      * Read one packet and put it in 'pkt'. pts and flags are also
587      * set. 'avformat_new_stream' can be called only if the flag
588      * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
589      * background thread).
590      * @return 0 on success, < 0 on error.
591      *         When returning an error, pkt must not have been allocated
592      *         or must be freed before returning
593      */
594     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
595
596     /**
597      * Close the stream. The AVFormatContext and AVStreams are not
598      * freed by this function
599      */
600     int (*read_close)(struct AVFormatContext *);
601
602     /**
603      * Seek to a given timestamp relative to the frames in
604      * stream component stream_index.
605      * @param stream_index Must not be -1.
606      * @param flags Selects which direction should be preferred if no exact
607      *              match is available.
608      * @return >= 0 on success (but not necessarily the new offset)
609      */
610     int (*read_seek)(struct AVFormatContext *,
611                      int stream_index, int64_t timestamp, int flags);
612
613     /**
614      * Get the next timestamp in stream[stream_index].time_base units.
615      * @return the timestamp or AV_NOPTS_VALUE if an error occurred
616      */
617     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
618                               int64_t *pos, int64_t pos_limit);
619
620     /**
621      * Start/resume playing - only meaningful if using a network-based format
622      * (RTSP).
623      */
624     int (*read_play)(struct AVFormatContext *);
625
626     /**
627      * Pause playing - only meaningful if using a network-based format
628      * (RTSP).
629      */
630     int (*read_pause)(struct AVFormatContext *);
631
632     /**
633      * Seek to timestamp ts.
634      * Seeking will be done so that the point from which all active streams
635      * can be presented successfully will be closest to ts and within min/max_ts.
636      * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
637      */
638     int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
639 } AVInputFormat;
640 /**
641  * @}
642  */
643
644 enum AVStreamParseType {
645     AVSTREAM_PARSE_NONE,
646     AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
647     AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
648     AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
649     AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
650 };
651
652 typedef struct AVIndexEntry {
653     int64_t pos;
654     int64_t timestamp;
655 #define AVINDEX_KEYFRAME 0x0001
656     int flags:2;
657     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).
658     int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
659 } AVIndexEntry;
660
661 #define AV_DISPOSITION_DEFAULT   0x0001
662 #define AV_DISPOSITION_DUB       0x0002
663 #define AV_DISPOSITION_ORIGINAL  0x0004
664 #define AV_DISPOSITION_COMMENT   0x0008
665 #define AV_DISPOSITION_LYRICS    0x0010
666 #define AV_DISPOSITION_KARAOKE   0x0020
667
668 /**
669  * Track should be used during playback by default.
670  * Useful for subtitle track that should be displayed
671  * even when user did not explicitly ask for subtitles.
672  */
673 #define AV_DISPOSITION_FORCED    0x0040
674 #define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
675 #define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
676 #define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
677 /**
678  * The stream is stored in the file as an attached picture/"cover art" (e.g.
679  * APIC frame in ID3v2). The single packet associated with it will be returned
680  * among the first few packets read from the file unless seeking takes place.
681  * It can also be accessed at any time in AVStream.attached_pic.
682  */
683 #define AV_DISPOSITION_ATTACHED_PIC      0x0400
684
685 /**
686  * Stream structure.
687  * New fields can be added to the end with minor version bumps.
688  * Removal, reordering and changes to existing fields require a major
689  * version bump.
690  * sizeof(AVStream) must not be used outside libav*.
691  */
692 typedef struct AVStream {
693     int index;    /**< stream index in AVFormatContext */
694     /**
695      * Format-specific stream ID.
696      * decoding: set by libavformat
697      * encoding: set by the user, replaced by libavformat if left unset
698      */
699     int id;
700     /**
701      * Codec context associated with this stream. Allocated and freed by
702      * libavformat.
703      *
704      * - decoding: The demuxer exports codec information stored in the headers
705      *             here.
706      * - encoding: The user sets codec information, the muxer writes it to the
707      *             output. Mandatory fields as specified in AVCodecContext
708      *             documentation must be set even if this AVCodecContext is
709      *             not actually used for encoding.
710      */
711     AVCodecContext *codec;
712     void *priv_data;
713
714 #if FF_API_LAVF_FRAC
715     /**
716      * @deprecated this field is unused
717      */
718     attribute_deprecated
719     struct AVFrac pts;
720 #endif
721
722     /**
723      * This is the fundamental unit of time (in seconds) in terms
724      * of which frame timestamps are represented.
725      *
726      * decoding: set by libavformat
727      * encoding: May be set by the caller before avformat_write_header() to
728      *           provide a hint to the muxer about the desired timebase. In
729      *           avformat_write_header(), the muxer will overwrite this field
730      *           with the timebase that will actually be used for the timestamps
731      *           written into the file (which may or may not be related to the
732      *           user-provided one, depending on the format).
733      */
734     AVRational time_base;
735
736     /**
737      * Decoding: pts of the first frame of the stream, in stream time base.
738      * Only set this if you are absolutely 100% sure that the value you set
739      * it to really is the pts of the first frame.
740      * This may be undefined (AV_NOPTS_VALUE).
741      */
742     int64_t start_time;
743
744     /**
745      * Decoding: duration of the stream, in stream time base.
746      * If a source file does not specify a duration, but does specify
747      * a bitrate, this value will be estimated from bitrate and file size.
748      */
749     int64_t duration;
750
751     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
752
753     int disposition; /**< AV_DISPOSITION_* bit field */
754
755     enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
756
757     /**
758      * sample aspect ratio (0 if unknown)
759      * - encoding: Set by user.
760      * - decoding: Set by libavformat.
761      */
762     AVRational sample_aspect_ratio;
763
764     AVDictionary *metadata;
765
766     /**
767      * Average framerate
768      *
769      * - demuxing: May be set by libavformat when creating the stream or in
770      *             avformat_find_stream_info().
771      * - muxing: May be set by the caller before avformat_write_header().
772      */
773     AVRational avg_frame_rate;
774
775     /**
776      * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
777      * will contain the attached picture.
778      *
779      * decoding: set by libavformat, must not be modified by the caller.
780      * encoding: unused
781      */
782     AVPacket attached_pic;
783
784     /**
785      * An array of side data that applies to the whole stream (i.e. the
786      * container does not allow it to change between packets).
787      *
788      * There may be no overlap between the side data in this array and side data
789      * in the packets. I.e. a given side data is either exported by the muxer
790      * (demuxing) / set by the caller (muxing) in this array, then it never
791      * appears in the packets, or the side data is exported / sent through
792      * the packets (always in the first packet where the value becomes known or
793      * changes), then it does not appear in this array.
794      *
795      * - demuxing: Set by libavformat when the stream is created.
796      * - muxing: May be set by the caller before avformat_write_header().
797      *
798      * Freed by libavformat in avformat_free_context().
799      */
800     AVPacketSideData *side_data;
801     /**
802      * The number of elements in the AVStream.side_data array.
803      */
804     int            nb_side_data;
805
806     /**
807      * Flags for the user to detect events happening on the stream. Flags must
808      * be cleared by the user once the event has been handled.
809      * A combination of AVSTREAM_EVENT_FLAG_*.
810      */
811     int event_flags;
812 #define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
813
814     /*****************************************************************
815      * All fields below this line are not part of the public API. They
816      * may not be used outside of libavformat and can be changed and
817      * removed at will.
818      * New public fields should be added right above.
819      *****************************************************************
820      */
821
822     /**
823      * Stream information used internally by av_find_stream_info()
824      */
825 #define MAX_STD_TIMEBASES (60*12+5)
826     struct {
827         int nb_decoded_frames;
828         int found_decoder;
829
830         /**
831          * Those are used for average framerate estimation.
832          */
833         int64_t fps_first_dts;
834         int     fps_first_dts_idx;
835         int64_t fps_last_dts;
836         int     fps_last_dts_idx;
837
838     } *info;
839
840     int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
841
842     // Timestamp generation support:
843     int64_t first_dts;
844     int64_t cur_dts;
845     int64_t last_IP_pts;
846     int last_IP_duration;
847
848     /**
849      * Number of packets to buffer for codec probing
850      */
851 #define MAX_PROBE_PACKETS 2500
852     int probe_packets;
853
854     /**
855      * Number of frames that have been demuxed during av_find_stream_info()
856      */
857     int codec_info_nb_frames;
858
859     /* av_read_frame() support */
860     enum AVStreamParseType need_parsing;
861     struct AVCodecParserContext *parser;
862
863     /**
864      * last packet in packet_buffer for this stream when muxing.
865      */
866     struct AVPacketList *last_in_packet_buffer;
867     AVProbeData probe_data;
868 #define MAX_REORDER_DELAY 16
869     int64_t pts_buffer[MAX_REORDER_DELAY+1];
870
871     AVIndexEntry *index_entries; /**< Only used if the format does not
872                                     support seeking natively. */
873     int nb_index_entries;
874     unsigned int index_entries_allocated_size;
875 } AVStream;
876
877 #define AV_PROGRAM_RUNNING 1
878
879 /**
880  * New fields can be added to the end with minor version bumps.
881  * Removal, reordering and changes to existing fields require a major
882  * version bump.
883  * sizeof(AVProgram) must not be used outside libav*.
884  */
885 typedef struct AVProgram {
886     int            id;
887     int            flags;
888     enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
889     unsigned int   *stream_index;
890     unsigned int   nb_stream_indexes;
891     AVDictionary *metadata;
892 } AVProgram;
893
894 #define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
895                                          (streams are added dynamically) */
896
897 typedef struct AVChapter {
898     int id;                 ///< unique ID to identify the chapter
899     AVRational time_base;   ///< time base in which the start/end timestamps are specified
900     int64_t start, end;     ///< chapter start/end time in time_base units
901     AVDictionary *metadata;
902 } AVChapter;
903
904 typedef struct AVFormatInternal AVFormatInternal;
905
906 /**
907  * Format I/O context.
908  * New fields can be added to the end with minor version bumps.
909  * Removal, reordering and changes to existing fields require a major
910  * version bump.
911  * sizeof(AVFormatContext) must not be used outside libav*, use
912  * avformat_alloc_context() to create an AVFormatContext.
913  */
914 typedef struct AVFormatContext {
915     /**
916      * A class for logging and @ref avoptions. Set by avformat_alloc_context().
917      * Exports (de)muxer private options if they exist.
918      */
919     const AVClass *av_class;
920
921     /**
922      * The input container format.
923      *
924      * Demuxing only, set by avformat_open_input().
925      */
926     struct AVInputFormat *iformat;
927
928     /**
929      * The output container format.
930      *
931      * Muxing only, must be set by the caller before avformat_write_header().
932      */
933     struct AVOutputFormat *oformat;
934
935     /**
936      * Format private data. This is an AVOptions-enabled struct
937      * if and only if iformat/oformat.priv_class is not NULL.
938      *
939      * - muxing: set by avformat_write_header()
940      * - demuxing: set by avformat_open_input()
941      */
942     void *priv_data;
943
944     /**
945      * I/O context.
946      *
947      * - demuxing: either set by the user before avformat_open_input() (then
948      *             the user must close it manually) or set by avformat_open_input().
949      * - muxing: set by the user before avformat_write_header(). The caller must
950      *           take care of closing / freeing the IO context.
951      *
952      * Do NOT set this field if AVFMT_NOFILE flag is set in
953      * iformat/oformat.flags. In such a case, the (de)muxer will handle
954      * I/O in some other way and this field will be NULL.
955      */
956     AVIOContext *pb;
957
958     /* stream info */
959     /**
960      * Flags signalling stream properties. A combination of AVFMTCTX_*.
961      * Set by libavformat.
962      */
963     int ctx_flags;
964
965     /**
966      * Number of elements in AVFormatContext.streams.
967      *
968      * Set by avformat_new_stream(), must not be modified by any other code.
969      */
970     unsigned int nb_streams;
971     /**
972      * A list of all streams in the file. New streams are created with
973      * avformat_new_stream().
974      *
975      * - demuxing: streams are created by libavformat in avformat_open_input().
976      *             If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
977      *             appear in av_read_frame().
978      * - muxing: streams are created by the user before avformat_write_header().
979      *
980      * Freed by libavformat in avformat_free_context().
981      */
982     AVStream **streams;
983
984     /**
985      * input or output filename
986      *
987      * - demuxing: set by avformat_open_input()
988      * - muxing: may be set by the caller before avformat_write_header()
989      */
990     char filename[1024];
991
992     /**
993      * Position of the first frame of the component, in
994      * AV_TIME_BASE fractional seconds. NEVER set this value directly:
995      * It is deduced from the AVStream values.
996      *
997      * Demuxing only, set by libavformat.
998      */
999     int64_t start_time;
1000
1001     /**
1002      * Duration of the stream, in AV_TIME_BASE fractional
1003      * seconds. Only set this value if you know none of the individual stream
1004      * durations and also do not set any of them. This is deduced from the
1005      * AVStream values if not set.
1006      *
1007      * Demuxing only, set by libavformat.
1008      */
1009     int64_t duration;
1010
1011     /**
1012      * Total stream bitrate in bit/s, 0 if not
1013      * available. Never set it directly if the file_size and the
1014      * duration are known as Libav can compute it automatically.
1015      */
1016     int bit_rate;
1017
1018     unsigned int packet_size;
1019     int max_delay;
1020
1021     /**
1022      * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
1023      * Set by the user before avformat_open_input() / avformat_write_header().
1024      */
1025     int flags;
1026 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
1027 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
1028 #define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
1029 #define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
1030 #define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1031 #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
1032 #define AVFMT_FLAG_NOBUFFER     0x0040 ///< Do not buffer frames when possible
1033 #define AVFMT_FLAG_CUSTOM_IO    0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
1034 #define AVFMT_FLAG_DISCARD_CORRUPT  0x0100 ///< Discard frames marked corrupted
1035 #define AVFMT_FLAG_FLUSH_PACKETS    0x0200 ///< Flush the AVIOContext every packet.
1036 /**
1037  * When muxing, try to avoid writing any random/volatile data to the output.
1038  * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
1039  *
1040  * This flag is mainly intended for testing.
1041  */
1042 #define AVFMT_FLAG_BITEXACT         0x0400
1043
1044     /**
1045      * Maximum size of the data read from input for determining
1046      * the input container format.
1047      * Demuxing only, set by the caller before avformat_open_input().
1048      */
1049     unsigned int probesize;
1050
1051     /**
1052      * Maximum duration (in AV_TIME_BASE units) of the data read
1053      * from input in avformat_find_stream_info().
1054      * Demuxing only, set by the caller before avformat_find_stream_info().
1055      */
1056     int max_analyze_duration;
1057
1058     const uint8_t *key;
1059     int keylen;
1060
1061     unsigned int nb_programs;
1062     AVProgram **programs;
1063
1064     /**
1065      * Forced video codec_id.
1066      * Demuxing: Set by user.
1067      */
1068     enum AVCodecID video_codec_id;
1069
1070     /**
1071      * Forced audio codec_id.
1072      * Demuxing: Set by user.
1073      */
1074     enum AVCodecID audio_codec_id;
1075
1076     /**
1077      * Forced subtitle codec_id.
1078      * Demuxing: Set by user.
1079      */
1080     enum AVCodecID subtitle_codec_id;
1081
1082     /**
1083      * Maximum amount of memory in bytes to use for the index of each stream.
1084      * If the index exceeds this size, entries will be discarded as
1085      * needed to maintain a smaller size. This can lead to slower or less
1086      * accurate seeking (depends on demuxer).
1087      * Demuxers for which a full in-memory index is mandatory will ignore
1088      * this.
1089      * - muxing: unused
1090      * - demuxing: set by user
1091      */
1092     unsigned int max_index_size;
1093
1094     /**
1095      * Maximum amount of memory in bytes to use for buffering frames
1096      * obtained from realtime capture devices.
1097      */
1098     unsigned int max_picture_buffer;
1099
1100     /**
1101      * Number of chapters in AVChapter array.
1102      * When muxing, chapters are normally written in the file header,
1103      * so nb_chapters should normally be initialized before write_header
1104      * is called. Some muxers (e.g. mov and mkv) can also write chapters
1105      * in the trailer.  To write chapters in the trailer, nb_chapters
1106      * must be zero when write_header is called and non-zero when
1107      * write_trailer is called.
1108      * - muxing: set by user
1109      * - demuxing: set by libavformat
1110      */
1111     unsigned int nb_chapters;
1112     AVChapter **chapters;
1113
1114     /**
1115      * Metadata that applies to the whole file.
1116      *
1117      * - demuxing: set by libavformat in avformat_open_input()
1118      * - muxing: may be set by the caller before avformat_write_header()
1119      *
1120      * Freed by libavformat in avformat_free_context().
1121      */
1122     AVDictionary *metadata;
1123
1124     /**
1125      * Start time of the stream in real world time, in microseconds
1126      * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1127      * stream was captured at this real world time.
1128      * Muxing only, set by the caller before avformat_write_header().
1129      */
1130     int64_t start_time_realtime;
1131
1132     /**
1133      * The number of frames used for determining the framerate in
1134      * avformat_find_stream_info().
1135      * Demuxing only, set by the caller before avformat_find_stream_info().
1136      */
1137     int fps_probe_size;
1138
1139     /**
1140      * Error recognition; higher values will detect more errors but may
1141      * misdetect some more or less valid parts as errors.
1142      * Demuxing only, set by the caller before avformat_open_input().
1143      */
1144     int error_recognition;
1145
1146     /**
1147      * Custom interrupt callbacks for the I/O layer.
1148      *
1149      * demuxing: set by the user before avformat_open_input().
1150      * muxing: set by the user before avformat_write_header()
1151      * (mainly useful for AVFMT_NOFILE formats). The callback
1152      * should also be passed to avio_open2() if it's used to
1153      * open the file.
1154      */
1155     AVIOInterruptCB interrupt_callback;
1156
1157     /**
1158      * Flags to enable debugging.
1159      */
1160     int debug;
1161 #define FF_FDEBUG_TS        0x0001
1162
1163     /**
1164      * Maximum buffering duration for interleaving.
1165      *
1166      * To ensure all the streams are interleaved correctly,
1167      * av_interleaved_write_frame() will wait until it has at least one packet
1168      * for each stream before actually writing any packets to the output file.
1169      * When some streams are "sparse" (i.e. there are large gaps between
1170      * successive packets), this can result in excessive buffering.
1171      *
1172      * This field specifies the maximum difference between the timestamps of the
1173      * first and the last packet in the muxing queue, above which libavformat
1174      * will output a packet regardless of whether it has queued a packet for all
1175      * the streams.
1176      *
1177      * Muxing only, set by the caller before avformat_write_header().
1178      */
1179     int64_t max_interleave_delta;
1180
1181     /**
1182      * Allow non-standard and experimental extension
1183      * @see AVCodecContext.strict_std_compliance
1184      */
1185     int strict_std_compliance;
1186
1187     /**
1188      * Flags for the user to detect events happening on the file. Flags must
1189      * be cleared by the user once the event has been handled.
1190      * A combination of AVFMT_EVENT_FLAG_*.
1191      */
1192     int event_flags;
1193 #define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
1194
1195     /**
1196      * Maximum number of packets to read while waiting for the first timestamp.
1197      * Decoding only.
1198      */
1199     int max_ts_probe;
1200
1201     /*****************************************************************
1202      * All fields below this line are not part of the public API. They
1203      * may not be used outside of libavformat and can be changed and
1204      * removed at will.
1205      * New public fields should be added right above.
1206      *****************************************************************
1207      */
1208
1209     /**
1210      * This buffer is only needed when packets were already buffered but
1211      * not decoded, for example to get the codec parameters in MPEG
1212      * streams.
1213      */
1214     struct AVPacketList *packet_buffer;
1215     struct AVPacketList *packet_buffer_end;
1216
1217     /* av_seek_frame() support */
1218     int64_t data_offset; /**< offset of the first packet */
1219
1220     /**
1221      * Raw packets from the demuxer, prior to parsing and decoding.
1222      * This buffer is used for buffering packets until the codec can
1223      * be identified, as parsing cannot be done without knowing the
1224      * codec.
1225      */
1226     struct AVPacketList *raw_packet_buffer;
1227     struct AVPacketList *raw_packet_buffer_end;
1228     /**
1229      * Packets split by the parser get queued here.
1230      */
1231     struct AVPacketList *parse_queue;
1232     struct AVPacketList *parse_queue_end;
1233     /**
1234      * Remaining size available for raw_packet_buffer, in bytes.
1235      */
1236 #define RAW_PACKET_BUFFER_SIZE 2500000
1237     int raw_packet_buffer_remaining_size;
1238
1239     /**
1240      * Offset to remap timestamps to be non-negative.
1241      * Expressed in timebase units.
1242      */
1243     int64_t offset;
1244
1245     /**
1246      * Timebase for the timestamp offset.
1247      */
1248     AVRational offset_timebase;
1249
1250     /**
1251      * An opaque field for libavformat internal usage.
1252      * Must not be accessed in any way by callers.
1253      */
1254     AVFormatInternal *internal;
1255 } AVFormatContext;
1256
1257 typedef struct AVPacketList {
1258     AVPacket pkt;
1259     struct AVPacketList *next;
1260 } AVPacketList;
1261
1262
1263 /**
1264  * @defgroup lavf_core Core functions
1265  * @ingroup libavf
1266  *
1267  * Functions for querying libavformat capabilities, allocating core structures,
1268  * etc.
1269  * @{
1270  */
1271
1272 /**
1273  * Return the LIBAVFORMAT_VERSION_INT constant.
1274  */
1275 unsigned avformat_version(void);
1276
1277 /**
1278  * Return the libavformat build-time configuration.
1279  */
1280 const char *avformat_configuration(void);
1281
1282 /**
1283  * Return the libavformat license.
1284  */
1285 const char *avformat_license(void);
1286
1287 /**
1288  * Initialize libavformat and register all the muxers, demuxers and
1289  * protocols. If you do not call this function, then you can select
1290  * exactly which formats you want to support.
1291  *
1292  * @see av_register_input_format()
1293  * @see av_register_output_format()
1294  * @see av_register_protocol()
1295  */
1296 void av_register_all(void);
1297
1298 void av_register_input_format(AVInputFormat *format);
1299 void av_register_output_format(AVOutputFormat *format);
1300
1301 /**
1302  * Do global initialization of network components. This is optional,
1303  * but recommended, since it avoids the overhead of implicitly
1304  * doing the setup for each session.
1305  *
1306  * Calling this function will become mandatory if using network
1307  * protocols at some major version bump.
1308  */
1309 int avformat_network_init(void);
1310
1311 /**
1312  * Undo the initialization done by avformat_network_init.
1313  */
1314 int avformat_network_deinit(void);
1315
1316 /**
1317  * If f is NULL, returns the first registered input format,
1318  * if f is non-NULL, returns the next registered input format after f
1319  * or NULL if f is the last one.
1320  */
1321 AVInputFormat  *av_iformat_next(const AVInputFormat  *f);
1322
1323 /**
1324  * If f is NULL, returns the first registered output format,
1325  * if f is non-NULL, returns the next registered output format after f
1326  * or NULL if f is the last one.
1327  */
1328 AVOutputFormat *av_oformat_next(const AVOutputFormat *f);
1329
1330 /**
1331  * Allocate an AVFormatContext.
1332  * avformat_free_context() can be used to free the context and everything
1333  * allocated by the framework within it.
1334  */
1335 AVFormatContext *avformat_alloc_context(void);
1336
1337 /**
1338  * Free an AVFormatContext and all its streams.
1339  * @param s context to free
1340  */
1341 void avformat_free_context(AVFormatContext *s);
1342
1343 /**
1344  * Get the AVClass for AVFormatContext. It can be used in combination with
1345  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1346  *
1347  * @see av_opt_find().
1348  */
1349 const AVClass *avformat_get_class(void);
1350
1351 /**
1352  * Add a new stream to a media file.
1353  *
1354  * When demuxing, it is called by the demuxer in read_header(). If the
1355  * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1356  * be called in read_packet().
1357  *
1358  * When muxing, should be called by the user before avformat_write_header().
1359  *
1360  * @param s media file handle
1361  * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1362  * will be initialized to use this codec. This is needed for e.g. codec-specific
1363  * defaults to be set, so codec should be provided if it is known.
1364  *
1365  * @return newly created stream or NULL on error.
1366  */
1367 AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c);
1368
1369 /**
1370  * Get side information from stream.
1371  *
1372  * @param stream stream
1373  * @param type desired side information type
1374  * @param size pointer for side information size to store (optional)
1375  * @return pointer to data if present or NULL otherwise
1376  */
1377 uint8_t *av_stream_get_side_data(AVStream *stream,
1378                                  enum AVPacketSideDataType type, int *size);
1379
1380 AVProgram *av_new_program(AVFormatContext *s, int id);
1381
1382 /**
1383  * @}
1384  */
1385
1386
1387 /**
1388  * @addtogroup lavf_decoding
1389  * @{
1390  */
1391
1392 /**
1393  * Find AVInputFormat based on the short name of the input format.
1394  */
1395 AVInputFormat *av_find_input_format(const char *short_name);
1396
1397 /**
1398  * Guess the file format.
1399  *
1400  * @param pd        data to be probed
1401  * @param is_opened Whether the file is already opened; determines whether
1402  *                  demuxers with or without AVFMT_NOFILE are probed.
1403  */
1404 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1405
1406 /**
1407  * Guess the file format.
1408  *
1409  * @param pd        data to be probed
1410  * @param is_opened Whether the file is already opened; determines whether
1411  *                  demuxers with or without AVFMT_NOFILE are probed.
1412  * @param score_max A probe score larger that this is required to accept a
1413  *                  detection, the variable is set to the actual detection
1414  *                  score afterwards.
1415  *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1416  *                  to retry with a larger probe buffer.
1417  */
1418 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1419
1420 /**
1421  * Probe a bytestream to determine the input format. Each time a probe returns
1422  * with a score that is too low, the probe buffer size is increased and another
1423  * attempt is made. When the maximum probe size is reached, the input format
1424  * with the highest score is returned.
1425  *
1426  * @param pb the bytestream to probe
1427  * @param fmt the input format is put here
1428  * @param filename the filename of the stream
1429  * @param logctx the log context
1430  * @param offset the offset within the bytestream to probe from
1431  * @param max_probe_size the maximum probe buffer size (zero for default)
1432  * @return 0 in case of success, a negative value corresponding to an
1433  * AVERROR code otherwise
1434  */
1435 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1436                           const char *filename, void *logctx,
1437                           unsigned int offset, unsigned int max_probe_size);
1438
1439 /**
1440  * Open an input stream and read the header. The codecs are not opened.
1441  * The stream must be closed with avformat_close_input().
1442  *
1443  * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1444  *           May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1445  *           function and written into ps.
1446  *           Note that a user-supplied AVFormatContext will be freed on failure.
1447  * @param filename Name of the stream to open.
1448  * @param fmt If non-NULL, this parameter forces a specific input format.
1449  *            Otherwise the format is autodetected.
1450  * @param options  A dictionary filled with AVFormatContext and demuxer-private options.
1451  *                 On return this parameter will be destroyed and replaced with a dict containing
1452  *                 options that were not found. May be NULL.
1453  *
1454  * @return 0 on success, a negative AVERROR on failure.
1455  *
1456  * @note If you want to use custom IO, preallocate the format context and set its pb field.
1457  */
1458 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1459
1460 /**
1461  * Read packets of a media file to get stream information. This
1462  * is useful for file formats with no headers such as MPEG. This
1463  * function also computes the real framerate in case of MPEG-2 repeat
1464  * frame mode.
1465  * The logical file position is not changed by this function;
1466  * examined packets may be buffered for later processing.
1467  *
1468  * @param ic media file handle
1469  * @param options  If non-NULL, an ic.nb_streams long array of pointers to
1470  *                 dictionaries, where i-th member contains options for
1471  *                 codec corresponding to i-th stream.
1472  *                 On return each dictionary will be filled with options that were not found.
1473  * @return >=0 if OK, AVERROR_xxx on error
1474  *
1475  * @note this function isn't guaranteed to open all the codecs, so
1476  *       options being non-empty at return is a perfectly normal behavior.
1477  *
1478  * @todo Let the user decide somehow what information is needed so that
1479  *       we do not waste time getting stuff the user does not need.
1480  */
1481 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1482
1483 /**
1484  * Find the "best" stream in the file.
1485  * The best stream is determined according to various heuristics as the most
1486  * likely to be what the user expects.
1487  * If the decoder parameter is non-NULL, av_find_best_stream will find the
1488  * default decoder for the stream's codec; streams for which no decoder can
1489  * be found are ignored.
1490  *
1491  * @param ic                media file handle
1492  * @param type              stream type: video, audio, subtitles, etc.
1493  * @param wanted_stream_nb  user-requested stream number,
1494  *                          or -1 for automatic selection
1495  * @param related_stream    try to find a stream related (eg. in the same
1496  *                          program) to this one, or -1 if none
1497  * @param decoder_ret       if non-NULL, returns the decoder for the
1498  *                          selected stream
1499  * @param flags             flags; none are currently defined
1500  * @return  the non-negative stream number in case of success,
1501  *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1502  *          could be found,
1503  *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1504  * @note  If av_find_best_stream returns successfully and decoder_ret is not
1505  *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1506  */
1507 int av_find_best_stream(AVFormatContext *ic,
1508                         enum AVMediaType type,
1509                         int wanted_stream_nb,
1510                         int related_stream,
1511                         AVCodec **decoder_ret,
1512                         int flags);
1513
1514 /**
1515  * Return the next frame of a stream.
1516  * This function returns what is stored in the file, and does not validate
1517  * that what is there are valid frames for the decoder. It will split what is
1518  * stored in the file into frames and return one for each call. It will not
1519  * omit invalid data between valid frames so as to give the decoder the maximum
1520  * information possible for decoding.
1521  *
1522  * If pkt->buf is NULL, then the packet is valid until the next
1523  * av_read_frame() or until avformat_close_input(). Otherwise the packet
1524  * is valid indefinitely. In both cases the packet must be freed with
1525  * av_free_packet when it is no longer needed. For video, the packet contains
1526  * exactly one frame. For audio, it contains an integer number of frames if each
1527  * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1528  * have a variable size (e.g. MPEG audio), then it contains one frame.
1529  *
1530  * pkt->pts, pkt->dts and pkt->duration are always set to correct
1531  * values in AVStream.time_base units (and guessed if the format cannot
1532  * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1533  * has B-frames, so it is better to rely on pkt->dts if you do not
1534  * decompress the payload.
1535  *
1536  * @return 0 if OK, < 0 on error or end of file
1537  */
1538 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1539
1540 /**
1541  * Seek to the keyframe at timestamp.
1542  * 'timestamp' in 'stream_index'.
1543  *
1544  * @param s media file handle
1545  * @param stream_index If stream_index is (-1), a default
1546  * stream is selected, and timestamp is automatically converted
1547  * from AV_TIME_BASE units to the stream specific time_base.
1548  * @param timestamp Timestamp in AVStream.time_base units
1549  *        or, if no stream is specified, in AV_TIME_BASE units.
1550  * @param flags flags which select direction and seeking mode
1551  * @return >= 0 on success
1552  */
1553 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1554                   int flags);
1555
1556 /**
1557  * Seek to timestamp ts.
1558  * Seeking will be done so that the point from which all active streams
1559  * can be presented successfully will be closest to ts and within min/max_ts.
1560  * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1561  *
1562  * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1563  * are the file position (this may not be supported by all demuxers).
1564  * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1565  * in the stream with stream_index (this may not be supported by all demuxers).
1566  * Otherwise all timestamps are in units of the stream selected by stream_index
1567  * or if stream_index is -1, in AV_TIME_BASE units.
1568  * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1569  * keyframes (this may not be supported by all demuxers).
1570  *
1571  * @param s media file handle
1572  * @param stream_index index of the stream which is used as time base reference
1573  * @param min_ts smallest acceptable timestamp
1574  * @param ts target timestamp
1575  * @param max_ts largest acceptable timestamp
1576  * @param flags flags
1577  * @return >=0 on success, error code otherwise
1578  *
1579  * @note This is part of the new seek API which is still under construction.
1580  *       Thus do not use this yet. It may change at any time, do not expect
1581  *       ABI compatibility yet!
1582  */
1583 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1584
1585 /**
1586  * Start playing a network-based stream (e.g. RTSP stream) at the
1587  * current position.
1588  */
1589 int av_read_play(AVFormatContext *s);
1590
1591 /**
1592  * Pause a network-based stream (e.g. RTSP stream).
1593  *
1594  * Use av_read_play() to resume it.
1595  */
1596 int av_read_pause(AVFormatContext *s);
1597
1598 /**
1599  * Close an opened input AVFormatContext. Free it and all its contents
1600  * and set *s to NULL.
1601  */
1602 void avformat_close_input(AVFormatContext **s);
1603 /**
1604  * @}
1605  */
1606
1607 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1608 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1609 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1610 #define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1611
1612 /**
1613  * @addtogroup lavf_encoding
1614  * @{
1615  */
1616 /**
1617  * Allocate the stream private data and write the stream header to
1618  * an output media file.
1619  *
1620  * @param s Media file handle, must be allocated with avformat_alloc_context().
1621  *          Its oformat field must be set to the desired output format;
1622  *          Its pb field must be set to an already opened AVIOContext.
1623  * @param options  An AVDictionary filled with AVFormatContext and muxer-private options.
1624  *                 On return this parameter will be destroyed and replaced with a dict containing
1625  *                 options that were not found. May be NULL.
1626  *
1627  * @return 0 on success, negative AVERROR on failure.
1628  *
1629  * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1630  */
1631 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1632
1633 /**
1634  * Write a packet to an output media file.
1635  *
1636  * This function passes the packet directly to the muxer, without any buffering
1637  * or reordering. The caller is responsible for correctly interleaving the
1638  * packets if the format requires it. Callers that want libavformat to handle
1639  * the interleaving should call av_interleaved_write_frame() instead of this
1640  * function.
1641  *
1642  * @param s media file handle
1643  * @param pkt The packet containing the data to be written. Note that unlike
1644  *            av_interleaved_write_frame(), this function does not take
1645  *            ownership of the packet passed to it (though some muxers may make
1646  *            an internal reference to the input packet).
1647  *            <br>
1648  *            This parameter can be NULL (at any time, not just at the end), in
1649  *            order to immediately flush data buffered within the muxer, for
1650  *            muxers that buffer up data internally before writing it to the
1651  *            output.
1652  *            <br>
1653  *            Packet's @ref AVPacket.stream_index "stream_index" field must be
1654  *            set to the index of the corresponding stream in @ref
1655  *            AVFormatContext.streams "s->streams". It is very strongly
1656  *            recommended that timing information (@ref AVPacket.pts "pts", @ref
1657  *            AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
1658  *            correct values.
1659  * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
1660  *
1661  * @see av_interleaved_write_frame()
1662  */
1663 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1664
1665 /**
1666  * Write a packet to an output media file ensuring correct interleaving.
1667  *
1668  * This function will buffer the packets internally as needed to make sure the
1669  * packets in the output file are properly interleaved in the order of
1670  * increasing dts. Callers doing their own interleaving should call
1671  * av_write_frame() instead of this function.
1672  *
1673  * @param s media file handle
1674  * @param pkt The packet containing the data to be written.
1675  *            <br>
1676  *            If the packet is reference-counted, this function will take
1677  *            ownership of this reference and unreference it later when it sees
1678  *            fit.
1679  *            The caller must not access the data through this reference after
1680  *            this function returns. If the packet is not reference-counted,
1681  *            libavformat will make a copy.
1682  *            <br>
1683  *            This parameter can be NULL (at any time, not just at the end), to
1684  *            flush the interleaving queues.
1685  *            <br>
1686  *            Packet's @ref AVPacket.stream_index "stream_index" field must be
1687  *            set to the index of the corresponding stream in @ref
1688  *            AVFormatContext.streams "s->streams". It is very strongly
1689  *            recommended that timing information (@ref AVPacket.pts "pts", @ref
1690  *            AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to
1691  *            correct values.
1692  *
1693  * @return 0 on success, a negative AVERROR on error. Libavformat will always
1694  *         take care of freeing the packet, even if this function fails.
1695  *
1696  * @see av_write_frame(), AVFormatContext.max_interleave_delta
1697  */
1698 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1699
1700 /**
1701  * Write the stream trailer to an output media file and free the
1702  * file private data.
1703  *
1704  * May only be called after a successful call to avformat_write_header.
1705  *
1706  * @param s media file handle
1707  * @return 0 if OK, AVERROR_xxx on error
1708  */
1709 int av_write_trailer(AVFormatContext *s);
1710
1711 /**
1712  * Return the output format in the list of registered output formats
1713  * which best matches the provided parameters, or return NULL if
1714  * there is no match.
1715  *
1716  * @param short_name if non-NULL checks if short_name matches with the
1717  * names of the registered formats
1718  * @param filename if non-NULL checks if filename terminates with the
1719  * extensions of the registered formats
1720  * @param mime_type if non-NULL checks if mime_type matches with the
1721  * MIME type of the registered formats
1722  */
1723 AVOutputFormat *av_guess_format(const char *short_name,
1724                                 const char *filename,
1725                                 const char *mime_type);
1726
1727 /**
1728  * Guess the codec ID based upon muxer and filename.
1729  */
1730 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1731                             const char *filename, const char *mime_type,
1732                             enum AVMediaType type);
1733
1734 /**
1735  * @}
1736  */
1737
1738
1739 /**
1740  * @defgroup lavf_misc Utility functions
1741  * @ingroup libavf
1742  * @{
1743  *
1744  * Miscellaneous utility functions related to both muxing and demuxing
1745  * (or neither).
1746  */
1747
1748 /**
1749  * Send a nice hexadecimal dump of a buffer to the specified file stream.
1750  *
1751  * @param f The file stream pointer where the dump should be sent to.
1752  * @param buf buffer
1753  * @param size buffer size
1754  *
1755  * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1756  */
1757 void av_hex_dump(FILE *f, const uint8_t *buf, int size);
1758
1759 /**
1760  * Send a nice hexadecimal dump of a buffer to the log.
1761  *
1762  * @param avcl A pointer to an arbitrary struct of which the first field is a
1763  * pointer to an AVClass struct.
1764  * @param level The importance level of the message, lower values signifying
1765  * higher importance.
1766  * @param buf buffer
1767  * @param size buffer size
1768  *
1769  * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1770  */
1771 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
1772
1773 /**
1774  * Send a nice dump of a packet to the specified file stream.
1775  *
1776  * @param f The file stream pointer where the dump should be sent to.
1777  * @param pkt packet to dump
1778  * @param dump_payload True if the payload must be displayed, too.
1779  * @param st AVStream that the packet belongs to
1780  */
1781 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1782
1783
1784 /**
1785  * Send a nice dump of a packet to the log.
1786  *
1787  * @param avcl A pointer to an arbitrary struct of which the first field is a
1788  * pointer to an AVClass struct.
1789  * @param level The importance level of the message, lower values signifying
1790  * higher importance.
1791  * @param pkt packet to dump
1792  * @param dump_payload True if the payload must be displayed, too.
1793  * @param st AVStream that the packet belongs to
1794  */
1795 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1796                       AVStream *st);
1797
1798 /**
1799  * Get the AVCodecID for the given codec tag tag.
1800  * If no codec id is found returns AV_CODEC_ID_NONE.
1801  *
1802  * @param tags list of supported codec_id-codec_tag pairs, as stored
1803  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1804  * @param tag  codec tag to match to a codec ID
1805  */
1806 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1807
1808 /**
1809  * Get the codec tag for the given codec id id.
1810  * If no codec tag is found returns 0.
1811  *
1812  * @param tags list of supported codec_id-codec_tag pairs, as stored
1813  * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1814  * @param id   codec ID to match to a codec tag
1815  */
1816 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
1817
1818 int av_find_default_stream_index(AVFormatContext *s);
1819
1820 /**
1821  * Get the index for a specific timestamp.
1822  *
1823  * @param st        stream that the timestamp belongs to
1824  * @param timestamp timestamp to retrieve the index for
1825  * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1826  *                 to the timestamp which is <= the requested one, if backward
1827  *                 is 0, then it will be >=
1828  *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1829  * @return < 0 if no such timestamp could be found
1830  */
1831 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1832
1833 /**
1834  * Add an index entry into a sorted list. Update the entry if the list
1835  * already contains it.
1836  *
1837  * @param timestamp timestamp in the time base of the given stream
1838  */
1839 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1840                        int size, int distance, int flags);
1841
1842
1843 /**
1844  * Split a URL string into components.
1845  *
1846  * The pointers to buffers for storing individual components may be null,
1847  * in order to ignore that component. Buffers for components not found are
1848  * set to empty strings. If the port is not found, it is set to a negative
1849  * value.
1850  *
1851  * @param proto the buffer for the protocol
1852  * @param proto_size the size of the proto buffer
1853  * @param authorization the buffer for the authorization
1854  * @param authorization_size the size of the authorization buffer
1855  * @param hostname the buffer for the host name
1856  * @param hostname_size the size of the hostname buffer
1857  * @param port_ptr a pointer to store the port number in
1858  * @param path the buffer for the path
1859  * @param path_size the size of the path buffer
1860  * @param url the URL to split
1861  */
1862 void av_url_split(char *proto,         int proto_size,
1863                   char *authorization, int authorization_size,
1864                   char *hostname,      int hostname_size,
1865                   int *port_ptr,
1866                   char *path,          int path_size,
1867                   const char *url);
1868
1869
1870 /**
1871  * Print detailed information about the input or output format, such as
1872  * duration, bitrate, streams, container, programs, metadata, side data,
1873  * codec and time base.
1874  *
1875  * @param ic        the context to analyze
1876  * @param index     the index to print, if you have multiple inputs or outputs
1877  * @param url       the URL to print, such as source or destination file
1878  * @param is_output whether the context is input or ouput
1879  */
1880 void av_dump_format(AVFormatContext *ic,
1881                     int index,
1882                     const char *url,
1883                     int is_output);
1884
1885 /**
1886  * Return in 'buf' the path with '%d' replaced by a number.
1887  *
1888  * Also handles the '%0nd' format where 'n' is the total number
1889  * of digits and '%%'.
1890  *
1891  * @param buf destination buffer
1892  * @param buf_size destination buffer size
1893  * @param path numbered sequence string
1894  * @param number frame number
1895  * @return 0 if OK, -1 on format error
1896  */
1897 int av_get_frame_filename(char *buf, int buf_size,
1898                           const char *path, int number);
1899
1900 /**
1901  * Check whether filename actually is a numbered sequence generator.
1902  *
1903  * @param filename possible numbered sequence string
1904  * @return 1 if a valid numbered sequence string, 0 otherwise
1905  */
1906 int av_filename_number_test(const char *filename);
1907
1908 /**
1909  * Generate an SDP for an RTP session.
1910  *
1911  * Note, this overwrites the id values of AVStreams in the muxer contexts
1912  * for getting unique dynamic payload types.
1913  *
1914  * @param ac array of AVFormatContexts describing the RTP streams. If the
1915  *           array is composed by only one context, such context can contain
1916  *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1917  *           all the contexts in the array (an AVCodecContext per RTP stream)
1918  *           must contain only one AVStream.
1919  * @param n_files number of AVCodecContexts contained in ac
1920  * @param buf buffer where the SDP will be stored (must be allocated by
1921  *            the caller)
1922  * @param size the size of the buffer
1923  * @return 0 if OK, AVERROR_xxx on error
1924  */
1925 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1926
1927 /**
1928  * Return a positive value if the given filename has one of the given
1929  * extensions, 0 otherwise.
1930  *
1931  * @param filename   file name to check against the given extensions
1932  * @param extensions a comma-separated list of filename extensions
1933  */
1934 int av_match_ext(const char *filename, const char *extensions);
1935
1936 /**
1937  * Test if the given container can store a codec.
1938  *
1939  * @param ofmt           container to check for compatibility
1940  * @param codec_id       codec to potentially store in container
1941  * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1942  *
1943  * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1944  *         A negative number if this information is not available.
1945  */
1946 int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id,
1947                          int std_compliance);
1948
1949 /**
1950  * @defgroup riff_fourcc RIFF FourCCs
1951  * @{
1952  * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
1953  * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1954  * following code:
1955  * @code
1956  * uint32_t tag = MKTAG('H', '2', '6', '4');
1957  * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1958  * enum AVCodecID id = av_codec_get_id(table, tag);
1959  * @endcode
1960  */
1961 /**
1962  * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
1963  */
1964 const struct AVCodecTag *avformat_get_riff_video_tags(void);
1965 /**
1966  * @return the table mapping RIFF FourCCs for audio to AVCodecID.
1967  */
1968 const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1969 /**
1970  * @}
1971  */
1972
1973 /**
1974  * @}
1975  */
1976
1977 #endif /* AVFORMAT_AVFORMAT_H */