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