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