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