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