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