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