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