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