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