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