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