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