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