lavc: add a variant of av_get_audio_frame_duration working with AVCodecParameters
[libav.git] / libavformat / avformat.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
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
2912e87a 17 * License along with Libav; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVFORMAT_AVFORMAT_H
22#define AVFORMAT_AVFORMAT_H
de6d9b64 23
e361b508 24/**
eca06cbe
AK
25 * @file
26 * @ingroup libavf
27 * Main libavformat public API header
28 */
29
30/**
e361b508
LB
31 * @defgroup libavf I/O and Muxing/Demuxing Library
32 * @{
33 *
ccbc1068
AK
34 * Libavformat (lavf) is a library for dealing with various media container
35 * formats. Its main two purposes are demuxing - i.e. splitting a media file
36 * into component streams, and the reverse process of muxing - writing supplied
37 * data in a specified container format. It also has an @ref lavf_io
38 * "I/O module" which supports a number of protocols for accessing the data (e.g.
39 * file, tcp, http and others). Before using lavf, you need to call
40 * av_register_all() to register all compiled muxers, demuxers and protocols.
41 * Unless you are absolutely sure you won't use libavformat's network
42 * capabilities, you should also call avformat_network_init().
43 *
44 * A supported input format is described by an AVInputFormat struct, conversely
45 * an output format is described by AVOutputFormat. You can iterate over all
46 * registered input/output formats using the av_iformat_next() /
47 * av_oformat_next() functions. The protocols layer is not part of the public
48 * API, so you can only get the names of supported protocols with the
49 * avio_enum_protocols() function.
50 *
51 * Main lavf structure used for both muxing and demuxing is AVFormatContext,
52 * which exports all information about the file being read or written. As with
53 * most Libav structures, its size is not part of public ABI, so it cannot be
54 * allocated on stack or directly with av_malloc(). To create an
55 * AVFormatContext, use avformat_alloc_context() (some functions, like
56 * avformat_open_input() might do that for you).
57 *
58 * Most importantly an AVFormatContext contains:
59 * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat
60 * "output" format. It is either autodetected or set by user for input;
61 * always set by user for output.
62 * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all
63 * elementary streams stored in the file. AVStreams are typically referred to
64 * using their index in this array.
65 * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or
66 * set by user for input, always set by user for output (unless you are dealing
67 * with an AVFMT_NOFILE format).
68 *
10fa4ff7
AK
69 * @section lavf_options Passing options to (de)muxers
70 * Lavf allows to configure muxers and demuxers using the @ref avoptions
71 * mechanism. Generic (format-independent) libavformat options are provided by
72 * AVFormatContext, they can be examined from a user program by calling
73 * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
74 * from avformat_get_class()). Private (format-specific) options are provided by
75 * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
76 * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
77 * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
78 * if its AVClass is non-NULL, and the protocols layer. See the discussion on
79 * nesting in @ref avoptions documentation to learn how to access those.
80 *
e361b508
LB
81 * @defgroup lavf_decoding Demuxing
82 * @{
59826cab 83 * Demuxers read a media file and split it into chunks of data (@em packets). A
dca9c81d
AK
84 * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
85 * single elementary stream. In the lavf API this process is represented by the
59826cab
AK
86 * avformat_open_input() function for opening a file, av_read_frame() for
87 * reading a single packet and finally avformat_close_input(), which does the
88 * cleanup.
89 *
90 * @section lavf_decoding_open Opening a media file
91 * The minimum information required to open a file is its URL or filename, which
92 * is passed to avformat_open_input(), as in the following code:
93 * @code
94 * const char *url = "in.mp3";
95 * AVFormatContext *s = NULL;
96 * int ret = avformat_open_input(&s, url, NULL, NULL);
97 * if (ret < 0)
98 * abort();
99 * @endcode
100 * The above code attempts to allocate an AVFormatContext, open the
101 * specified file (autodetecting the format) and read the header, exporting the
102 * information stored there into s. Some formats do not have a header or do not
103 * store enough information there, so it is recommended that you call the
104 * avformat_find_stream_info() function which tries to read and decode a few
105 * frames to find missing information.
106 *
107 * In some cases you might want to preallocate an AVFormatContext yourself with
108 * avformat_alloc_context() and do some tweaking on it before passing it to
109 * avformat_open_input(). One such case is when you want to use custom functions
110 * for reading input data instead of lavf internal I/O layer.
111 * To do that, create your own AVIOContext with avio_alloc_context(), passing
112 * your reading callbacks to it. Then set the @em pb field of your
113 * AVFormatContext to newly created AVIOContext.
114 *
10fa4ff7
AK
115 * Since the format of the opened file is in general not known until after
116 * avformat_open_input() has returned, it is not possible to set demuxer private
117 * options on a preallocated context. Instead, the options should be passed to
118 * avformat_open_input() wrapped in an AVDictionary:
119 * @code
120 * AVDictionary *options = NULL;
121 * av_dict_set(&options, "video_size", "640x480", 0);
122 * av_dict_set(&options, "pixel_format", "rgb24", 0);
123 *
124 * if (avformat_open_input(&s, url, NULL, &options) < 0)
125 * abort();
126 * av_dict_free(&options);
127 * @endcode
128 * This code passes the private options 'video_size' and 'pixel_format' to the
129 * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
130 * cannot know how to interpret raw video data otherwise. If the format turns
131 * out to be something different than raw video, those options will not be
132 * recognized by the demuxer and therefore will not be applied. Such unrecognized
133 * options are then returned in the options dictionary (recognized options are
134 * consumed). The calling program can handle such unrecognized options as it
135 * wishes, e.g.
136 * @code
137 * AVDictionaryEntry *e;
138 * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
139 * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
140 * abort();
141 * }
142 * @endcode
143 *
59826cab
AK
144 * After you have finished reading the file, you must close it with
145 * avformat_close_input(). It will free everything associated with the file.
146 *
147 * @section lavf_decoding_read Reading from an opened file
f58b8cc3
AK
148 * Reading data from an opened AVFormatContext is done by repeatedly calling
149 * av_read_frame() on it. Each call, if successful, will return an AVPacket
150 * containing encoded data for one AVStream, identified by
151 * AVPacket.stream_index. This packet may be passed straight into the libavcodec
152 * decoding functions avcodec_decode_video2(), avcodec_decode_audio4() or
153 * avcodec_decode_subtitle2() if the caller wishes to decode the data.
154 *
155 * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
156 * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
157 * pts/dts, 0 for duration) if the stream does not provide them. The timing
158 * information will be in AVStream.time_base units, i.e. it has to be
159 * multiplied by the timebase to convert them to seconds.
160 *
1afddbe5 161 * If AVPacket.buf is set on the returned packet, then the packet is
717a4509 162 * allocated dynamically and the user may keep it indefinitely.
1afddbe5 163 * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
717a4509
AK
164 * static storage somewhere inside the demuxer and the packet is only valid
165 * until the next av_read_frame() call or closing the file. If the caller
166 * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
167 * of it.
ce70f28a 168 * In both cases, the packet must be freed with av_packet_unref() when it is no
717a4509 169 * longer needed.
59826cab
AK
170 *
171 * @section lavf_decoding_seek Seeking
e361b508
LB
172 * @}
173 *
174 * @defgroup lavf_encoding Muxing
175 * @{
54f7e79d
AK
176 * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write
177 * it into files or other output bytestreams in the specified container format.
178 *
179 * The main API functions for muxing are avformat_write_header() for writing the
180 * file header, av_write_frame() / av_interleaved_write_frame() for writing the
181 * packets and av_write_trailer() for finalizing the file.
182 *
183 * At the beginning of the muxing process, the caller must first call
184 * avformat_alloc_context() to create a muxing context. The caller then sets up
185 * the muxer by filling the various fields in this context:
186 *
187 * - The @ref AVFormatContext.oformat "oformat" field must be set to select the
188 * muxer that will be used.
189 * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb
190 * "pb" field must be set to an opened IO context, either returned from
191 * avio_open2() or a custom one.
192 * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must
193 * be created with the avformat_new_stream() function. The caller should fill
194 * the @ref AVStream.codec "stream codec context" information, such as the
195 * codec @ref AVCodecContext.codec_type "type", @ref AVCodecContext.codec_id
196 * "id" and other parameters (e.g. width / height, the pixel or sample format,
c9c1265c 197 * etc.) as known. The @ref AVStream.time_base "stream timebase" should
54f7e79d
AK
198 * be set to the timebase that the caller desires to use for this stream (note
199 * that the timebase actually used by the muxer can be different, as will be
200 * described later).
bb770168
VG
201 * - It is advised to manually initialize only the relevant fields in
202 * AVCodecContext, rather than using @ref avcodec_copy_context() during
203 * remuxing: there is no guarantee that the codec context values remain valid
204 * for both input and output format contexts.
54f7e79d
AK
205 * - The caller may fill in additional information, such as @ref
206 * AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream"
207 * metadata, @ref AVFormatContext.chapters "chapters", @ref
208 * AVFormatContext.programs "programs", etc. as described in the
209 * AVFormatContext documentation. Whether such information will actually be
210 * stored in the output depends on what the container format and the muxer
211 * support.
212 *
213 * When the muxing context is fully set up, the caller must call
214 * avformat_write_header() to initialize the muxer internals and write the file
215 * header. Whether anything actually is written to the IO context at this step
216 * depends on the muxer, but this function must always be called. Any muxer
217 * private options must be passed in the options parameter to this function.
218 *
219 * The data is then sent to the muxer by repeatedly calling av_write_frame() or
220 * av_interleaved_write_frame() (consult those functions' documentation for
221 * discussion on the difference between them; only one of them may be used with
222 * a single muxing context, they should not be mixed). Do note that the timing
223 * information on the packets sent to the muxer must be in the corresponding
224 * AVStream's timebase. That timebase is set by the muxer (in the
c9c1265c
AK
225 * avformat_write_header() step) and may be different from the timebase
226 * requested by the caller.
54f7e79d
AK
227 *
228 * Once all the data has been written, the caller must call av_write_trailer()
229 * to flush any buffered packets and finalize the output file, then close the IO
230 * context (if any) and finally free the muxing context with
231 * avformat_free_context().
e361b508
LB
232 * @}
233 *
e4f4a1f9 234 * @defgroup lavf_io I/O Read/Write
e361b508
LB
235 * @{
236 * @}
237 *
238 * @defgroup lavf_codec Demuxers
239 * @{
240 * @defgroup lavf_codec_native Native Demuxers
241 * @{
242 * @}
243 * @defgroup lavf_codec_wrappers External library wrappers
244 * @{
245 * @}
246 * @}
247 * @defgroup lavf_protos I/O Protocols
248 * @{
249 * @}
250 * @defgroup lavf_internal Internal
251 * @{
252 * @}
253 * @}
e361b508 254 */
072e3efd 255
f71869a4 256#include <time.h>
67070e4f 257#include <stdio.h> /* FILE */
76a448ed 258#include "libavcodec/avcodec.h"
d9f80ea2 259#include "libavutil/dict.h"
abc78a5a 260#include "libavutil/log.h"
de6d9b64 261
de6d9b64 262#include "avio.h"
50196a98 263#include "libavformat/version.h"
de6d9b64 264
f610a9f2
AJ
265struct AVFormatContext;
266
a6d18a0e 267
1a53a438
RT
268/**
269 * @defgroup metadata_api Public Metadata API
270 * @{
b262a059 271 * @ingroup libavf
ea29242c 272 * The metadata API allows libavformat to export metadata tags to a client
28b4c06b
AK
273 * application when demuxing. Conversely it allows a client application to
274 * set metadata when muxing.
275 *
276 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
277 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
278 * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
279 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
61648423 280 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
28b4c06b 281 *
ea29242c 282 * Important concepts to keep in mind:
1a53a438 283 * - Keys are unique; there can never be 2 tags with the same key. This is
ea29242c
MM
284 * also meant semantically, i.e., a demuxer should not knowingly produce
285 * several keys that are literally different but semantically identical.
286 * E.g., key=Author5, key=Author6. In this example, all authors must be
287 * placed in the same tag.
1a53a438 288 * - Metadata is flat, not hierarchical; there are no subtags. If you
ea29242c
MM
289 * want to store, e.g., the email address of the child of producer Alice
290 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
1a53a438 291 * - Several modifiers can be applied to the tag name. This is done by
ca76a119
AK
292 * appending a dash character ('-') and the modifier name in the order
293 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
1a53a438 294 * - language -- a tag whose value is localized for a particular language
ca76a119
AK
295 * is appended with the ISO 639-2/B 3-letter language code.
296 * For example: Author-ger=Michael, Author-eng=Mike
297 * The original/default language is in the unqualified "Author" tag.
298 * A demuxer should set a default if it sets any translated tag.
1a53a438 299 * - sorting -- a modified version of a tag that should be used for
ca76a119
AK
300 * sorting will have '-sort' appended. E.g. artist="The Beatles",
301 * artist-sort="Beatles, The".
afbd4b7e
AS
302 * - Some protocols and demuxers support metadata updates. After a successful
303 * call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags
304 * will be updated to indicate if metadata changed. In order to detect metadata
305 * changes on a stream, you need to loop through all streams in the AVFormatContext
306 * and check their individual event_flags.
ca76a119 307 *
1a53a438 308 * - Demuxers attempt to export metadata in a generic format, however tags
03700d39
AK
309 * with no generic equivalents are left as they are stored in the container.
310 * Follows a list of generic tag names:
ca76a119 311 *
1a53a438
RT
312 @verbatim
313 album -- name of the set this work belongs to
314 album_artist -- main creator of the set/album, if different from artist.
315 e.g. "Various Artists" for compilation albums.
316 artist -- main creator of the work
317 comment -- any additional description of the file.
318 composer -- who composed the work, if different from artist.
319 copyright -- name of copyright holder.
320 creation_time-- date when the file was created, preferably in ISO 8601.
321 date -- date when the work was created, preferably in ISO 8601.
322 disc -- number of a subset, e.g. disc in a multi-disc collection.
323 encoder -- name/settings of the software/hardware that produced the file.
324 encoded_by -- person/group who created the file.
325 filename -- original name of the file.
326 genre -- <self-evident>.
327 language -- main language in which the work is performed, preferably
328 in ISO 639-2 format. Multiple languages can be specified by
329 separating them with commas.
330 performer -- artist who performed the work, if different from artist.
331 E.g for "Also sprach Zarathustra", artist would be "Richard
332 Strauss" and performer "London Philharmonic Orchestra".
333 publisher -- name of the label/publisher.
334 service_name -- name of the service in broadcasting (channel name).
335 service_provider -- name of the service provider in broadcasting.
336 title -- name of the work.
337 track -- number of this work in the set, can be in form current/total.
338 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
339 @endverbatim
340 *
12489443
RT
341 * Look in the examples section for an application example how to use the Metadata API.
342 *
1a53a438 343 * @}
a6d18a0e
MN
344 */
345
de6d9b64
FB
346/* packet functions */
347
3217cb42
PI
348
349/**
49bd8e4b 350 * Allocate and read the payload of a packet and initialize its
d1b9adf2 351 * fields with default values.
3217cb42 352 *
4d7ab5cf 353 * @param s associated IO context
3217cb42 354 * @param pkt packet
4f57fa8c
DB
355 * @param size desired payload size
356 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 357 */
ae628ec1 358int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
3217cb42 359
de6d9b64 360
6bfc2683 361/**
fa8cc126
RD
362 * Read data and append it to the current content of the AVPacket.
363 * If pkt->size is 0 this is identical to av_get_packet.
6bfc2683
RD
364 * Note that this uses av_grow_packet and thus involves a realloc
365 * which is inefficient. Thus this function should only be used
366 * when there is no reasonable way to know (an upper bound of)
367 * the final size.
368 *
4d7ab5cf 369 * @param s associated IO context
6bfc2683
RD
370 * @param pkt packet
371 * @param size amount of data to read
372 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
373 * will not be lost even if an error occurs.
374 */
ae628ec1 375int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
6bfc2683 376
a312f710 377#if FF_API_LAVF_FRAC
de6d9b64 378/*************************************************/
916c80e9
FB
379/* fractional numbers for exact pts handling */
380
671adb17 381/**
4f57fa8c
DB
382 * The exact value of the fractional number is: 'val + num / den'.
383 * num is assumed to be 0 <= num < den.
4c08b2bd 384 */
916c80e9 385typedef struct AVFrac {
115329f1 386 int64_t val, num, den;
52e57500 387} AVFrac;
a312f710 388#endif
916c80e9 389
916c80e9 390/*************************************************/
b9a281db 391/* input/output formats */
de6d9b64 392
7caf0cc6
MN
393struct AVCodecTag;
394
76c56376
MN
395/**
396 * This structure contains the data a format has to probe a file.
397 */
b9a281db 398typedef struct AVProbeData {
5c91a675 399 const char *filename;
e5f58f81 400 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
401 int buf_size; /**< Size of buf except extra allocated bytes */
b15b06eb 402 const char *mime_type; /**< mime_type, when known. */
b9a281db
FB
403} AVProbeData;
404
e0f8be64 405#define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension
3a19405d 406#define AVPROBE_SCORE_MIME 75 ///< score for file mime type
e0f8be64
DB
407#define AVPROBE_SCORE_MAX 100 ///< maximum score
408
87e87886 409#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64 410
c68fafe0 411/// Demuxer will use avio_open, no opened file should be provided by the caller.
40d9c544 412#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
413#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
414#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
34ed5c2e 415#if FF_API_LAVF_FMT_RAWPICTURE
4f57fa8c 416#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
34ed5c2e
LB
417 raw picture data. @deprecated Not used anymore */
418#endif
4f57fa8c
DB
419#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
420#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
421#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
58ec7e00 422#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
25918212 423#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 424#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
bb62d5c1 425#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
a5f88736
DB
426#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
427#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */
b631fba9 428#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
f1caf01d 429#define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
e9cef897
JZ
430#define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
431 increasing timestamps, but they must
432 still be monotonic */
c2cb01d4
LB
433#define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative
434 timestamps. If not set the timestamp
435 will be shifted in av_write_frame and
436 av_interleaved_write_frame so they
437 start from 0. */
b9a281db 438
489a7b07
AK
439/**
440 * @addtogroup lavf_encoding
441 * @{
442 */
b9a281db 443typedef struct AVOutputFormat {
de6d9b64 444 const char *name;
bde15e74
SS
445 /**
446 * Descriptive name for the format, meant to be more human-readable
819174fa 447 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
448 * to define it.
449 */
de6d9b64
FB
450 const char *long_name;
451 const char *mime_type;
4f57fa8c 452 const char *extensions; /**< comma-separated filename extensions */
183eaa9a 453 /* output support */
36ef5369
AK
454 enum AVCodecID audio_codec; /**< default audio codec */
455 enum AVCodecID video_codec; /**< default video codec */
456 enum AVCodecID subtitle_codec; /**< default subtitle codec */
183eaa9a 457 /**
34ed5c2e 458 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER,
183eaa9a 459 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
e9cef897
JZ
460 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
461 * AVFMT_TS_NONSTRICT
183eaa9a
AK
462 */
463 int flags;
464
465 /**
466 * List of supported codec_id-codec_tag pairs, ordered by "better
36ef5369 467 * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
183eaa9a
AK
468 */
469 const struct AVCodecTag * const *codec_tag;
470
471
472 const AVClass *priv_class; ///< AVClass for the private context
473
474 /*****************************************************************
475 * No fields below this line are part of the public API. They
476 * may not be used outside of libavformat and can be changed and
477 * removed at will.
478 * New public fields should be added right above.
479 *****************************************************************
480 */
481 struct AVOutputFormat *next;
76c56376
MN
482 /**
483 * size of private data so that it can be allocated in the wrapper
484 */
b9a281db 485 int priv_data_size;
183eaa9a 486
de6d9b64 487 int (*write_header)(struct AVFormatContext *);
f1caf01d
MS
488 /**
489 * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
490 * pkt can be NULL in order to flush data buffered in the muxer.
491 * When flushing, return 0 if there still is more data to flush,
492 * or 1 if everything was flushed and there is no more buffered
493 * data.
494 */
e928649b 495 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 496 int (*write_trailer)(struct AVFormatContext *);
76c56376 497 /**
76c56376
MN
498 * Currently only used to set pixel format if not YUV420P.
499 */
78cb7273
DB
500 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
501 AVPacket *in, int flush);
48f9e457
AK
502 /**
503 * Test if the given codec can be stored in this container.
504 *
505 * @return 1 if the codec is supported, 0 if it is not.
506 * A negative number if unknown.
507 */
36ef5369 508 int (*query_codec)(enum AVCodecID id, int std_compliance);
b9a281db 509} AVOutputFormat;
489a7b07
AK
510/**
511 * @}
512 */
de6d9b64 513
370f27de
AK
514/**
515 * @addtogroup lavf_decoding
516 * @{
517 */
b9a281db 518typedef struct AVInputFormat {
76c56376
MN
519 /**
520 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
521 * may be appended with a minor bump.
522 */
b9a281db 523 const char *name;
76c56376 524
bde15e74
SS
525 /**
526 * Descriptive name for the format, meant to be more human-readable
819174fa 527 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
528 * to define it.
529 */
b9a281db 530 const char *long_name;
76c56376
MN
531
532 /**
183eaa9a
AK
533 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
534 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
535 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
536 */
537 int flags;
538
539 /**
540 * If extensions are defined, then no probe is done. You should
541 * usually not use extension format guessing because it is not
542 * reliable enough
543 */
544 const char *extensions;
545
546 const struct AVCodecTag * const *codec_tag;
547
548 const AVClass *priv_class; ///< AVClass for the private context
549
3a19405d
LB
550 /**
551 * Comma-separated list of mime types.
552 * It is used check for matching mime types while probing.
553 * @see av_probe_input_format2
554 */
555 const char *mime_type;
556
183eaa9a
AK
557 /*****************************************************************
558 * No fields below this line are part of the public API. They
559 * may not be used outside of libavformat and can be changed and
560 * removed at will.
561 * New public fields should be added right above.
562 *****************************************************************
563 */
564 struct AVInputFormat *next;
565
566 /**
f7fe41a0 567 * Raw demuxers store their codec ID here.
183eaa9a 568 */
f7fe41a0 569 int raw_codec_id;
183eaa9a
AK
570
571 /**
76c56376
MN
572 * Size of private data so that it can be allocated in the wrapper.
573 */
b9a281db 574 int priv_data_size;
76c56376 575
65d7d68b 576 /**
22e77e44 577 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
578 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
579 * big so you do not have to check for that unless you need more.
65d7d68b 580 */
b9a281db 581 int (*read_probe)(AVProbeData *);
76c56376
MN
582
583 /**
584 * Read the format header and initialize the AVFormatContext
c4aa0f86
MS
585 * structure. Return 0 if OK. 'avformat_new_stream' should be
586 * called to create new streams.
76c56376 587 */
6e9651d1 588 int (*read_header)(struct AVFormatContext *);
76c56376
MN
589
590 /**
591 * Read one packet and put it in 'pkt'. pts and flags are also
6b8b0fe2 592 * set. 'avformat_new_stream' can be called only if the flag
2899a28c
AJ
593 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
594 * background thread).
76c56376
MN
595 * @return 0 on success, < 0 on error.
596 * When returning an error, pkt must not have been allocated
597 * or must be freed before returning
598 */
de6d9b64 599 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
600
601 /**
602 * Close the stream. The AVFormatContext and AVStreams are not
603 * freed by this function
604 */
de6d9b64 605 int (*read_close)(struct AVFormatContext *);
1de2db8f 606
115329f1 607 /**
4f57fa8c
DB
608 * Seek to a given timestamp relative to the frames in
609 * stream component stream_index.
22e77e44
DB
610 * @param stream_index Must not be -1.
611 * @param flags Selects which direction should be preferred if no exact
612 * match is available.
05ce0f11 613 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 614 */
e5c70815
AK
615 int (*read_seek)(struct AVFormatContext *,
616 int stream_index, int64_t timestamp, int flags);
617
8d14a25c 618 /**
58c42af7 619 * Get the next timestamp in stream[stream_index].time_base units.
d9526386 620 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
621 */
622 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
623 int64_t *pos, int64_t pos_limit);
76c56376
MN
624
625 /**
76c56376
MN
626 * Start/resume playing - only meaningful if using a network-based format
627 * (RTSP).
628 */
fb2758c8
FB
629 int (*read_play)(struct AVFormatContext *);
630
76c56376
MN
631 /**
632 * Pause playing - only meaningful if using a network-based format
633 * (RTSP).
634 */
fb2758c8
FB
635 int (*read_pause)(struct AVFormatContext *);
636
1de2db8f 637 /**
49bd8e4b 638 * Seek to timestamp ts.
1de2db8f
MN
639 * Seeking will be done so that the point from which all active streams
640 * can be presented successfully will be closest to ts and within min/max_ts.
641 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
642 */
882fb0a3 643 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
b9a281db 644} AVInputFormat;
370f27de
AK
645/**
646 * @}
647 */
de6d9b64 648
57004ff1
AJ
649enum AVStreamParseType {
650 AVSTREAM_PARSE_NONE,
651 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 652 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 653 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 654 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
655};
656
fb2758c8
FB
657typedef struct AVIndexEntry {
658 int64_t pos;
659 int64_t timestamp;
660#define AVINDEX_KEYFRAME 0x0001
30a43f2d 661 int flags:2;
4f57fa8c
DB
662 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).
663 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
664} AVIndexEntry;
665
90c2295b
ES
666#define AV_DISPOSITION_DEFAULT 0x0001
667#define AV_DISPOSITION_DUB 0x0002
668#define AV_DISPOSITION_ORIGINAL 0x0004
669#define AV_DISPOSITION_COMMENT 0x0008
670#define AV_DISPOSITION_LYRICS 0x0010
671#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
672
673/**
674 * Track should be used during playback by default.
675 * Useful for subtitle track that should be displayed
676 * even when user did not explicitly ask for subtitles.
677 */
7a617a86 678#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
679#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
680#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 681#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
dd2a4bcf
AK
682/**
683 * The stream is stored in the file as an attached picture/"cover art" (e.g.
684 * APIC frame in ID3v2). The single packet associated with it will be returned
685 * among the first few packets read from the file unless seeking takes place.
686 * It can also be accessed at any time in AVStream.attached_pic.
687 */
688#define AV_DISPOSITION_ATTACHED_PIC 0x0400
90c2295b 689
8de1ee9f
AK
690typedef struct AVStreamInternal AVStreamInternal;
691
ba66ae94
MN
692/**
693 * Stream structure.
694 * New fields can be added to the end with minor version bumps.
8bfb108b 695 * Removal, reordering and changes to existing fields require a major
ba66ae94 696 * version bump.
8bfb108b 697 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 698 */
de6d9b64 699typedef struct AVStream {
43d414ba 700 int index; /**< stream index in AVFormatContext */
e20ad71e
MS
701 /**
702 * Format-specific stream ID.
703 * decoding: set by libavformat
3b4296f4 704 * encoding: set by the user, replaced by libavformat if left unset
e20ad71e
MS
705 */
706 int id;
967923ab
AK
707 /**
708 * Codec context associated with this stream. Allocated and freed by
709 * libavformat.
710 *
711 * - decoding: The demuxer exports codec information stored in the headers
712 * here.
713 * - encoding: The user sets codec information, the muxer writes it to the
714 * output. Mandatory fields as specified in AVCodecContext
715 * documentation must be set even if this AVCodecContext is
716 * not actually used for encoding.
717 */
718 AVCodecContext *codec;
de6d9b64 719 void *priv_data;
82583548 720
a312f710 721#if FF_API_LAVF_FRAC
76c56376 722 /**
a312f710 723 * @deprecated this field is unused
76c56376 724 */
a312f710 725 attribute_deprecated
a9fd2b19 726 struct AVFrac pts;
a312f710 727#endif
5b28c8c3
MN
728
729 /**
8bfb108b 730 * This is the fundamental unit of time (in seconds) in terms
e44ada12
AK
731 * of which frame timestamps are represented.
732 *
5d820db2 733 * decoding: set by libavformat
194be1f4
AK
734 * encoding: May be set by the caller before avformat_write_header() to
735 * provide a hint to the muxer about the desired timebase. In
736 * avformat_write_header(), the muxer will overwrite this field
737 * with the timebase that will actually be used for the timestamps
738 * written into the file (which may or may not be related to the
739 * user-provided one, depending on the format).
5b28c8c3 740 */
9ee91c2f 741 AVRational time_base;
76c56376 742
6d96a9b9 743 /**
8bfb108b
DB
744 * Decoding: pts of the first frame of the stream, in stream time base.
745 * Only set this if you are absolutely 100% sure that the value you set
746 * it to really is the pts of the first frame.
4854c253 747 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 748 */
115329f1 749 int64_t start_time;
76c56376 750
e26381b6 751 /**
8bfb108b 752 * Decoding: duration of the stream, in stream time base.
e26381b6 753 * If a source file does not specify a duration, but does specify
4f57fa8c 754 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 755 */
ee404803 756 int64_t duration;
fb2758c8 757
b4b87d48 758 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 759
4f57fa8c 760 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5 761
ee42df8a
LB
762 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
763
c30a4489
AJ
764 /**
765 * sample aspect ratio (0 if unknown)
766 * - encoding: Set by user.
767 * - decoding: Set by libavformat.
768 */
769 AVRational sample_aspect_ratio;
f526adaf 770
d2d67e42 771 AVDictionary *metadata;
3a41c2f7 772
02b398ef
MN
773 /**
774 * Average framerate
7a5f4f68
AK
775 *
776 * - demuxing: May be set by libavformat when creating the stream or in
777 * avformat_find_stream_info().
778 * - muxing: May be set by the caller before avformat_write_header().
02b398ef
MN
779 */
780 AVRational avg_frame_rate;
6c6e6ef5 781
dd2a4bcf
AK
782 /**
783 * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
784 * will contain the attached picture.
785 *
786 * decoding: set by libavformat, must not be modified by the caller.
787 * encoding: unused
788 */
789 AVPacket attached_pic;
790
25b32586
AK
791 /**
792 * An array of side data that applies to the whole stream (i.e. the
793 * container does not allow it to change between packets).
794 *
795 * There may be no overlap between the side data in this array and side data
796 * in the packets. I.e. a given side data is either exported by the muxer
797 * (demuxing) / set by the caller (muxing) in this array, then it never
798 * appears in the packets, or the side data is exported / sent through
799 * the packets (always in the first packet where the value becomes known or
800 * changes), then it does not appear in this array.
801 *
802 * - demuxing: Set by libavformat when the stream is created.
803 * - muxing: May be set by the caller before avformat_write_header().
804 *
805 * Freed by libavformat in avformat_free_context().
806 */
807 AVPacketSideData *side_data;
808 /**
809 * The number of elements in the AVStream.side_data array.
810 */
811 int nb_side_data;
812
afbd4b7e
AS
813 /**
814 * Flags for the user to detect events happening on the stream. Flags must
815 * be cleared by the user once the event has been handled.
816 * A combination of AVSTREAM_EVENT_FLAG_*.
817 */
818 int event_flags;
819#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
820
9a174562
AK
821 /*****************************************************************
822 * All fields below this line are not part of the public API. They
823 * may not be used outside of libavformat and can be changed and
824 * removed at will.
825 * New public fields should be added right above.
826 *****************************************************************
827 */
828
6c6e6ef5 829 /**
da9cea77 830 * Stream information used internally by av_find_stream_info()
fd0368e7
AJ
831 */
832#define MAX_STD_TIMEBASES (60*12+5)
833 struct {
38a4be3f 834 int nb_decoded_frames;
8c1d6ac6 835 int found_decoder;
fe1c1198
AK
836
837 /**
838 * Those are used for average framerate estimation.
839 */
840 int64_t fps_first_dts;
841 int fps_first_dts_idx;
842 int64_t fps_last_dts;
843 int fps_last_dts_idx;
844
fd0368e7 845 } *info;
ee42df8a 846
ee42df8a 847 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
9a174562
AK
848
849 // Timestamp generation support:
9a174562
AK
850 int64_t first_dts;
851 int64_t cur_dts;
9a174562 852 int64_t last_IP_pts;
ee42df8a 853 int last_IP_duration;
9a174562
AK
854
855 /**
856 * Number of packets to buffer for codec probing
857 */
858#define MAX_PROBE_PACKETS 2500
859 int probe_packets;
860
861 /**
ee42df8a
LB
862 * Number of frames that have been demuxed during av_find_stream_info()
863 */
864 int codec_info_nb_frames;
865
866 /* av_read_frame() support */
867 enum AVStreamParseType need_parsing;
868 struct AVCodecParserContext *parser;
869
870 /**
9a174562
AK
871 * last packet in packet_buffer for this stream when muxing.
872 */
873 struct AVPacketList *last_in_packet_buffer;
874 AVProbeData probe_data;
875#define MAX_REORDER_DELAY 16
876 int64_t pts_buffer[MAX_REORDER_DELAY+1];
9a174562
AK
877
878 AVIndexEntry *index_entries; /**< Only used if the format does not
879 support seeking natively. */
880 int nb_index_entries;
881 unsigned int index_entries_allocated_size;
8de1ee9f
AK
882
883 /**
884 * An opaque field for libavformat internal usage.
885 * Must not be accessed in any way by callers.
886 */
887 AVStreamInternal *internal;
de6d9b64
FB
888} AVStream;
889
15afa396
NS
890#define AV_PROGRAM_RUNNING 1
891
ba66ae94 892/**
ba66ae94 893 * New fields can be added to the end with minor version bumps.
8bfb108b 894 * Removal, reordering and changes to existing fields require a major
ba66ae94 895 * version bump.
8bfb108b 896 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 897 */
15afa396
NS
898typedef struct AVProgram {
899 int id;
15afa396
NS
900 int flags;
901 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
902 unsigned int *stream_index;
903 unsigned int nb_stream_indexes;
d2d67e42 904 AVDictionary *metadata;
15afa396
NS
905} AVProgram;
906
43d414ba 907#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
908 (streams are added dynamically) */
909
79d7836a 910typedef struct AVChapter {
4f57fa8c
DB
911 int id; ///< unique ID to identify the chapter
912 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 913 int64_t start, end; ///< chapter start/end time in time_base units
d2d67e42 914 AVDictionary *metadata;
79d7836a
AK
915} AVChapter;
916
33c859c1
AK
917typedef struct AVFormatInternal AVFormatInternal;
918
252f17e2 919/**
4f57fa8c 920 * Format I/O context.
252f17e2 921 * New fields can be added to the end with minor version bumps.
8bfb108b 922 * Removal, reordering and changes to existing fields require a major
252f17e2 923 * version bump.
83daced0
AK
924 * sizeof(AVFormatContext) must not be used outside libav*, use
925 * avformat_alloc_context() to create an AVFormatContext.
252f17e2 926 */
de6d9b64 927typedef struct AVFormatContext {
83daced0 928 /**
18c896be 929 * A class for logging and @ref avoptions. Set by avformat_alloc_context().
83daced0
AK
930 * Exports (de)muxer private options if they exist.
931 */
932 const AVClass *av_class;
933
934 /**
18c896be 935 * The input container format.
83daced0 936 *
18c896be 937 * Demuxing only, set by avformat_open_input().
83daced0 938 */
b9a281db 939 struct AVInputFormat *iformat;
18c896be
AK
940
941 /**
942 * The output container format.
943 *
944 * Muxing only, must be set by the caller before avformat_write_header().
945 */
b9a281db 946 struct AVOutputFormat *oformat;
83daced0
AK
947
948 /**
949 * Format private data. This is an AVOptions-enabled struct
950 * if and only if iformat/oformat.priv_class is not NULL.
18c896be
AK
951 *
952 * - muxing: set by avformat_write_header()
953 * - demuxing: set by avformat_open_input()
83daced0 954 */
de6d9b64 955 void *priv_data;
83daced0 956
1432c1c4 957 /**
83daced0
AK
958 * I/O context.
959 *
18c896be
AK
960 * - demuxing: either set by the user before avformat_open_input() (then
961 * the user must close it manually) or set by avformat_open_input().
962 * - muxing: set by the user before avformat_write_header(). The caller must
963 * take care of closing / freeing the IO context.
83daced0
AK
964 *
965 * Do NOT set this field if AVFMT_NOFILE flag is set in
966 * iformat/oformat.flags. In such a case, the (de)muxer will handle
967 * I/O in some other way and this field will be NULL.
968 */
ae628ec1 969 AVIOContext *pb;
83daced0 970
ee42df8a 971 /* stream info */
a7385403
AK
972 /**
973 * Flags signalling stream properties. A combination of AVFMTCTX_*.
974 * Set by libavformat.
975 */
976 int ctx_flags;
ee42df8a 977
83daced0 978 /**
18c896be
AK
979 * Number of elements in AVFormatContext.streams.
980 *
981 * Set by avformat_new_stream(), must not be modified by any other code.
982 */
983 unsigned int nb_streams;
984 /**
83daced0
AK
985 * A list of all streams in the file. New streams are created with
986 * avformat_new_stream().
987 *
18c896be
AK
988 * - demuxing: streams are created by libavformat in avformat_open_input().
989 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
990 * appear in av_read_frame().
991 * - muxing: streams are created by the user before avformat_write_header().
992 *
993 * Freed by libavformat in avformat_free_context().
83daced0 994 */
38aab35f 995 AVStream **streams;
83daced0 996
18c896be
AK
997 /**
998 * input or output filename
999 *
1000 * - demuxing: set by avformat_open_input()
1001 * - muxing: may be set by the caller before avformat_write_header()
1002 */
1003 char filename[1024];
ee404803 1004
76c56376 1005 /**
18c896be 1006 * Position of the first frame of the component, in
76c56376
MN
1007 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
1008 * It is deduced from the AVStream values.
18c896be
AK
1009 *
1010 * Demuxing only, set by libavformat.
76c56376 1011 */
115329f1 1012 int64_t start_time;
76c56376
MN
1013
1014 /**
18c896be 1015 * Duration of the stream, in AV_TIME_BASE fractional
76c56376 1016 * seconds. Only set this value if you know none of the individual stream
da9cea77 1017 * durations and also do not set any of them. This is deduced from the
76c56376 1018 * AVStream values if not set.
18c896be
AK
1019 *
1020 * Demuxing only, set by libavformat.
76c56376 1021 */
ee404803 1022 int64_t duration;
76c56376 1023
76c56376 1024 /**
18c896be 1025 * Total stream bitrate in bit/s, 0 if not
76c56376 1026 * available. Never set it directly if the file_size and the
6001dad6 1027 * duration are known as Libav can compute it automatically.
76c56376 1028 */
ee404803 1029 int bit_rate;
fb2758c8 1030
92400be2 1031 unsigned int packet_size;
17c88cb0 1032 int max_delay;
8108551a 1033
a7385403
AK
1034 /**
1035 * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
1036 * Set by the user before avformat_open_input() / avformat_write_header().
1037 */
30bc6613 1038 int flags;
22e77e44 1039#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
1040#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
1041#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 1042#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
1043#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
1044#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
681ed000 1045#define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible
05e84c95 1046#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
73e8e8db 1047#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
596e5d47 1048#define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet.
0c1959b0
AK
1049/**
1050 * When muxing, try to avoid writing any random/volatile data to the output.
1051 * This includes any random IDs, real-time timestamps/dates, muxer version, etc.
1052 *
1053 * This flag is mainly intended for testing.
1054 */
1055#define AVFMT_FLAG_BITEXACT 0x0400
5894e1bb 1056
76c56376 1057 /**
18c896be
AK
1058 * Maximum size of the data read from input for determining
1059 * the input container format.
1060 * Demuxing only, set by the caller before avformat_open_input().
76c56376 1061 */
9e6c9470 1062 unsigned int probesize;
a44b3c4d
MN
1063
1064 /**
18c896be
AK
1065 * Maximum duration (in AV_TIME_BASE units) of the data read
1066 * from input in avformat_find_stream_info().
1067 * Demuxing only, set by the caller before avformat_find_stream_info().
a44b3c4d
MN
1068 */
1069 int max_analyze_duration;
c964c2c7
RD
1070
1071 const uint8_t *key;
1072 int keylen;
15afa396
NS
1073
1074 unsigned int nb_programs;
1075 AVProgram **programs;
62600469
MN
1076
1077 /**
1078 * Forced video codec_id.
4f57fa8c 1079 * Demuxing: Set by user.
62600469 1080 */
36ef5369 1081 enum AVCodecID video_codec_id;
76c56376 1082
62600469
MN
1083 /**
1084 * Forced audio codec_id.
4f57fa8c 1085 * Demuxing: Set by user.
62600469 1086 */
36ef5369 1087 enum AVCodecID audio_codec_id;
76c56376 1088
62600469
MN
1089 /**
1090 * Forced subtitle codec_id.
4f57fa8c 1091 * Demuxing: Set by user.
62600469 1092 */
36ef5369 1093 enum AVCodecID subtitle_codec_id;
3dea63bd
PK
1094
1095 /**
22e77e44
DB
1096 * Maximum amount of memory in bytes to use for the index of each stream.
1097 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
1098 * needed to maintain a smaller size. This can lead to slower or less
1099 * accurate seeking (depends on demuxer).
4f57fa8c 1100 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd 1101 * this.
18c896be
AK
1102 * - muxing: unused
1103 * - demuxing: set by user
3dea63bd
PK
1104 */
1105 unsigned int max_index_size;
ab8ab30c
RP
1106
1107 /**
ffa71b2b 1108 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 1109 * obtained from realtime capture devices.
ab8ab30c
RP
1110 */
1111 unsigned int max_picture_buffer;
79d7836a 1112
26b241c0
JS
1113 /**
1114 * Number of chapters in AVChapter array.
1115 * When muxing, chapters are normally written in the file header,
1116 * so nb_chapters should normally be initialized before write_header
1117 * is called. Some muxers (e.g. mov and mkv) can also write chapters
1118 * in the trailer. To write chapters in the trailer, nb_chapters
1119 * must be zero when write_header is called and non-zero when
1120 * write_trailer is called.
18c896be
AK
1121 * - muxing: set by user
1122 * - demuxing: set by libavformat
26b241c0 1123 */
fbabf1e9 1124 unsigned int nb_chapters;
79d7836a 1125 AVChapter **chapters;
45b2b05f 1126
18c896be
AK
1127 /**
1128 * Metadata that applies to the whole file.
1129 *
1130 * - demuxing: set by libavformat in avformat_open_input()
1131 * - muxing: may be set by the caller before avformat_write_header()
1132 *
1133 * Freed by libavformat in avformat_free_context().
1134 */
d2d67e42 1135 AVDictionary *metadata;
af122d6a 1136
b8819c85
MS
1137 /**
1138 * Start time of the stream in real world time, in microseconds
18c896be
AK
1139 * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the
1140 * stream was captured at this real world time.
1141 * Muxing only, set by the caller before avformat_write_header().
b8819c85
MS
1142 */
1143 int64_t start_time_realtime;
30315a8d
AC
1144
1145 /**
18c896be
AK
1146 * The number of frames used for determining the framerate in
1147 * avformat_find_stream_info().
1148 * Demuxing only, set by the caller before avformat_find_stream_info().
30315a8d
AC
1149 */
1150 int fps_probe_size;
2f63440c
DB
1151
1152 /**
1153 * Error recognition; higher values will detect more errors but may
1154 * misdetect some more or less valid parts as errors.
18c896be 1155 * Demuxing only, set by the caller before avformat_open_input().
2f63440c
DB
1156 */
1157 int error_recognition;
df968050 1158
6aa0b98f
MS
1159 /**
1160 * Custom interrupt callbacks for the I/O layer.
1161 *
18c896be
AK
1162 * demuxing: set by the user before avformat_open_input().
1163 * muxing: set by the user before avformat_write_header()
6aa0b98f
MS
1164 * (mainly useful for AVFMT_NOFILE formats). The callback
1165 * should also be passed to avio_open2() if it's used to
1166 * open the file.
1167 */
1168 AVIOInterruptCB interrupt_callback;
1169
ee42df8a
LB
1170 /**
1171 * Flags to enable debugging.
1172 */
1173 int debug;
1174#define FF_FDEBUG_TS 0x0001
d9ae1031
LB
1175
1176 /**
1177 * Maximum buffering duration for interleaving.
1178 *
1179 * To ensure all the streams are interleaved correctly,
1180 * av_interleaved_write_frame() will wait until it has at least one packet
1181 * for each stream before actually writing any packets to the output file.
1182 * When some streams are "sparse" (i.e. there are large gaps between
1183 * successive packets), this can result in excessive buffering.
1184 *
1185 * This field specifies the maximum difference between the timestamps of the
1186 * first and the last packet in the muxing queue, above which libavformat
1187 * will output a packet regardless of whether it has queued a packet for all
1188 * the streams.
1189 *
1190 * Muxing only, set by the caller before avformat_write_header().
1191 */
1192 int64_t max_interleave_delta;
1193
6d212599
LB
1194 /**
1195 * Allow non-standard and experimental extension
1196 * @see AVCodecContext.strict_std_compliance
1197 */
1198 int strict_std_compliance;
afbd4b7e
AS
1199
1200 /**
1201 * Flags for the user to detect events happening on the file. Flags must
1202 * be cleared by the user once the event has been handled.
1203 * A combination of AVFMT_EVENT_FLAG_*.
1204 */
1205 int event_flags;
1206#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata.
1207
b263f8ff
AK
1208 /**
1209 * Maximum number of packets to read while waiting for the first timestamp.
1210 * Decoding only.
1211 */
1212 int max_ts_probe;
1213
1384df64
MN
1214 /**
1215 * Avoid negative timestamps during muxing.
1216 * Any value of the AVFMT_AVOID_NEG_TS_* constants.
1217 * Note, this only works when using av_interleaved_write_frame.
1218 * - muxing: Set by user
1219 * - demuxing: unused
1220 */
1221 int avoid_negative_ts;
1222#define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format
1223#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative
1224#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0
1225
33c859c1
AK
1226 /**
1227 * An opaque field for libavformat internal usage.
1228 * Must not be accessed in any way by callers.
1229 */
1230 AVFormatInternal *internal;
9f61abc8
AK
1231
1232 /**
1233 * Arbitrary user data set by the caller.
1234 */
1235 void *opaque;
1236
1237 /**
1238 * A callback for opening new IO streams.
1239 *
7fbb3b5b
AK
1240 * Whenever a muxer or a demuxer needs to open an IO stream (typically from
1241 * avformat_open_input() for demuxers, but for certain formats can happen at
1242 * other times as well), it will call this callback to obtain an IO context.
9f61abc8
AK
1243 *
1244 * @param s the format context
1245 * @param pb on success, the newly opened IO context should be returned here
1246 * @param url the url to open
1247 * @param flags a combination of AVIO_FLAG_*
1248 * @param options a dictionary of additional options, with the same
1249 * semantics as in avio_open2()
1250 * @return 0 on success, a negative AVERROR code on failure
1251 *
1252 * @note Certain muxers and demuxers do nesting, i.e. they open one or more
1253 * additional internal format contexts. Thus the AVFormatContext pointer
1254 * passed to this callback may be different from the one facing the caller.
1255 * It will, however, have the same 'opaque' field.
1256 */
1257 int (*io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url,
1258 int flags, AVDictionary **options);
1259
1260 /**
1261 * A callback for closing the streams opened with AVFormatContext.io_open().
1262 */
1263 void (*io_close)(struct AVFormatContext *s, AVIOContext *pb);
ec4c4839
AK
1264
1265 /**
1266 * A comma-separated list of protocol names that will not be used internally
1267 * by libavformat. If this field is a non-empty string, then protocols
1268 * listed here will be forbidden.
1269 *
1270 * This field should be set using AVOptions.
1271 */
1272 char *protocol_blacklist;
1273
1274 /**
1275 * A comma-separated list of protocol names that can be used internally by
1276 * libavformat. If this field is a non-empty string, all protocols not
1277 * listed here will be forbidden.
1278 *
1279 * This field should be set using AVOptions.
1280 */
1281 char *protocol_whitelist;
de6d9b64
FB
1282} AVFormatContext;
1283
1284typedef struct AVPacketList {
1285 AVPacket pkt;
1286 struct AVPacketList *next;
1287} AVPacketList;
1288
469c62d0
AK
1289
1290/**
1291 * @defgroup lavf_core Core functions
1292 * @ingroup libavf
1293 *
1294 * Functions for querying libavformat capabilities, allocating core structures,
1295 * etc.
1296 * @{
1297 */
1298
1299/**
1300 * Return the LIBAVFORMAT_VERSION_INT constant.
1301 */
1302unsigned avformat_version(void);
1303
1304/**
1305 * Return the libavformat build-time configuration.
1306 */
1307const char *avformat_configuration(void);
1308
1309/**
1310 * Return the libavformat license.
1311 */
1312const char *avformat_license(void);
1313
1314/**
1315 * Initialize libavformat and register all the muxers, demuxers and
1316 * protocols. If you do not call this function, then you can select
1317 * exactly which formats you want to support.
1318 *
1319 * @see av_register_input_format()
1320 * @see av_register_output_format()
1321 * @see av_register_protocol()
1322 */
1323void av_register_all(void);
1324
1325void av_register_input_format(AVInputFormat *format);
1326void av_register_output_format(AVOutputFormat *format);
1327
1328/**
1329 * Do global initialization of network components. This is optional,
1330 * but recommended, since it avoids the overhead of implicitly
1331 * doing the setup for each session.
1332 *
1333 * Calling this function will become mandatory if using network
1334 * protocols at some major version bump.
1335 */
1336int avformat_network_init(void);
1337
1338/**
1339 * Undo the initialization done by avformat_network_init.
1340 */
1341int avformat_network_deinit(void);
1342
aeedac95
SS
1343/**
1344 * If f is NULL, returns the first registered input format,
22e77e44 1345 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
1346 * or NULL if f is the last one.
1347 */
ec4f04da 1348AVInputFormat *av_iformat_next(const AVInputFormat *f);
aeedac95
SS
1349
1350/**
1351 * If f is NULL, returns the first registered output format,
22e77e44 1352 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
1353 * or NULL if f is the last one.
1354 */
ec4f04da 1355AVOutputFormat *av_oformat_next(const AVOutputFormat *f);
de6d9b64 1356
469c62d0
AK
1357/**
1358 * Allocate an AVFormatContext.
1359 * avformat_free_context() can be used to free the context and everything
1360 * allocated by the framework within it.
1361 */
1362AVFormatContext *avformat_alloc_context(void);
1363
1364/**
1365 * Free an AVFormatContext and all its streams.
1366 * @param s context to free
1367 */
1368void avformat_free_context(AVFormatContext *s);
1369
1370/**
1371 * Get the AVClass for AVFormatContext. It can be used in combination with
1372 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1373 *
1374 * @see av_opt_find().
1375 */
1376const AVClass *avformat_get_class(void);
1377
1378/**
1379 * Add a new stream to a media file.
1380 *
1381 * When demuxing, it is called by the demuxer in read_header(). If the
1382 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1383 * be called in read_packet().
1384 *
1385 * When muxing, should be called by the user before avformat_write_header().
1386 *
4d7ab5cf 1387 * @param s media file handle
469c62d0
AK
1388 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1389 * will be initialized to use this codec. This is needed for e.g. codec-specific
1390 * defaults to be set, so codec should be provided if it is known.
1391 *
1392 * @return newly created stream or NULL on error.
1393 */
3d90f27a 1394AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c);
469c62d0 1395
c23c96b6 1396/**
7f4ec436
JS
1397 * Allocate new information from stream.
1398 *
1399 * @param stream stream
1400 * @param type desired side information type
1401 * @param size side information size
1402 * @return pointer to fresh allocated data or NULL otherwise
1403 */
1404uint8_t *av_stream_new_side_data(AVStream *stream,
1405 enum AVPacketSideDataType type, int size);
1406/**
c23c96b6
JG
1407 * Get side information from stream.
1408 *
1409 * @param stream stream
1410 * @param type desired side information type
1411 * @param size pointer for side information size to store (optional)
1412 * @return pointer to data if present or NULL otherwise
1413 */
1414uint8_t *av_stream_get_side_data(AVStream *stream,
1415 enum AVPacketSideDataType type, int *size);
1416
469c62d0
AK
1417AVProgram *av_new_program(AVFormatContext *s, int id);
1418
1419/**
1420 * @}
1421 */
1422
1423
370f27de 1424/**
370f27de
AK
1425 * @addtogroup lavf_decoding
1426 * @{
1427 */
3217cb42
PI
1428
1429/**
49bd8e4b 1430 * Find AVInputFormat based on the short name of the input format.
3217cb42 1431 */
b9a281db 1432AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1433
1434/**
49bd8e4b 1435 * Guess the file format.
3217cb42 1436 *
4d7ab5cf 1437 * @param pd data to be probed
4f57fa8c
DB
1438 * @param is_opened Whether the file is already opened; determines whether
1439 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1440 */
94988531 1441AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1442
1443/**
49bd8e4b 1444 * Guess the file format.
8e2ee182 1445 *
4d7ab5cf 1446 * @param pd data to be probed
8e2ee182
RD
1447 * @param is_opened Whether the file is already opened; determines whether
1448 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1449 * @param score_max A probe score larger that this is required to accept a
1450 * detection, the variable is set to the actual detection
1451 * score afterwards.
1452 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1453 * to retry with a larger probe buffer.
1454 */
1455AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1456
1457/**
3940caad
AH
1458 * Probe a bytestream to determine the input format. Each time a probe returns
1459 * with a score that is too low, the probe buffer size is increased and another
1460 * attempt is made. When the maximum probe size is reached, the input format
1461 * with the highest score is returned.
1462 *
1463 * @param pb the bytestream to probe
1464 * @param fmt the input format is put here
1465 * @param filename the filename of the stream
1466 * @param logctx the log context
1467 * @param offset the offset within the bytestream to probe from
1468 * @param max_probe_size the maximum probe buffer size (zero for default)
1469 * @return 0 in case of success, a negative value corresponding to an
1470 * AVERROR code otherwise
1471 */
ae628ec1 1472int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1473 const char *filename, void *logctx,
1474 unsigned int offset, unsigned int max_probe_size);
1475
88808c60 1476/**
05e84c95 1477 * Open an input stream and read the header. The codecs are not opened.
64af59bc 1478 * The stream must be closed with avformat_close_input().
05e84c95
AK
1479 *
1480 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1481 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1482 * function and written into ps.
1483 * Note that a user-supplied AVFormatContext will be freed on failure.
1484 * @param filename Name of the stream to open.
1485 * @param fmt If non-NULL, this parameter forces a specific input format.
1486 * Otherwise the format is autodetected.
1487 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1488 * On return this parameter will be destroyed and replaced with a dict containing
1489 * options that were not found. May be NULL.
1490 *
1491 * @return 0 on success, a negative AVERROR on failure.
1492 *
1493 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1494 */
1495int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1496
a67c061e
AK
1497/**
1498 * Read packets of a media file to get stream information. This
1499 * is useful for file formats with no headers such as MPEG. This
1500 * function also computes the real framerate in case of MPEG-2 repeat
1501 * frame mode.
1502 * The logical file position is not changed by this function;
1503 * examined packets may be buffered for later processing.
1504 *
1505 * @param ic media file handle
1506 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1507 * dictionaries, where i-th member contains options for
1508 * codec corresponding to i-th stream.
1509 * On return each dictionary will be filled with options that were not found.
1510 * @return >=0 if OK, AVERROR_xxx on error
1511 *
1512 * @note this function isn't guaranteed to open all the codecs, so
1513 * options being non-empty at return is a perfectly normal behavior.
1514 *
1515 * @todo Let the user decide somehow what information is needed so that
1516 * we do not waste time getting stuff the user does not need.
1517 */
1518int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
3217cb42
PI
1519
1520/**
9128ae08
NG
1521 * Find the "best" stream in the file.
1522 * The best stream is determined according to various heuristics as the most
1523 * likely to be what the user expects.
1524 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1525 * default decoder for the stream's codec; streams for which no decoder can
1526 * be found are ignored.
1527 *
1528 * @param ic media file handle
1529 * @param type stream type: video, audio, subtitles, etc.
1530 * @param wanted_stream_nb user-requested stream number,
1531 * or -1 for automatic selection
1532 * @param related_stream try to find a stream related (eg. in the same
1533 * program) to this one, or -1 if none
1534 * @param decoder_ret if non-NULL, returns the decoder for the
1535 * selected stream
1536 * @param flags flags; none are currently defined
1537 * @return the non-negative stream number in case of success,
1538 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1539 * could be found,
1540 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1541 * @note If av_find_best_stream returns successfully and decoder_ret is not
1542 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1543 */
1544int av_find_best_stream(AVFormatContext *ic,
1545 enum AVMediaType type,
1546 int wanted_stream_nb,
1547 int related_stream,
1548 AVCodec **decoder_ret,
1549 int flags);
1550
3217cb42 1551/**
49bd8e4b 1552 * Return the next frame of a stream.
4faf628f
MN
1553 * This function returns what is stored in the file, and does not validate
1554 * that what is there are valid frames for the decoder. It will split what is
1555 * stored in the file into frames and return one for each call. It will not
1556 * omit invalid data between valid frames so as to give the decoder the maximum
1557 * information possible for decoding.
3217cb42 1558 *
1afddbe5 1559 * If pkt->buf is NULL, then the packet is valid until the next
64af59bc
DB
1560 * av_read_frame() or until avformat_close_input(). Otherwise the packet
1561 * is valid indefinitely. In both cases the packet must be freed with
ce70f28a 1562 * av_packet_unref when it is no longer needed. For video, the packet contains
717a4509
AK
1563 * exactly one frame. For audio, it contains an integer number of frames if each
1564 * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1565 * have a variable size (e.g. MPEG audio), then it contains one frame.
3217cb42
PI
1566 *
1567 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1568 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1569 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1570 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1571 * decompress the payload.
1572 *
4f57fa8c 1573 * @return 0 if OK, < 0 on error or end of file
3217cb42 1574 */
fb2758c8 1575int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1576
1577/**
49bd8e4b 1578 * Seek to the keyframe at timestamp.
3217cb42 1579 * 'timestamp' in 'stream_index'.
4d7ab5cf
DB
1580 *
1581 * @param s media file handle
3217cb42
PI
1582 * @param stream_index If stream_index is (-1), a default
1583 * stream is selected, and timestamp is automatically converted
1584 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1585 * @param timestamp Timestamp in AVStream.time_base units
1586 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1587 * @param flags flags which select direction and seeking mode
1588 * @return >= 0 on success
1589 */
78cb7273
DB
1590int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1591 int flags);
3217cb42
PI
1592
1593/**
49bd8e4b 1594 * Seek to timestamp ts.
d04768fa
MN
1595 * Seeking will be done so that the point from which all active streams
1596 * can be presented successfully will be closest to ts and within min/max_ts.
1597 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1598 *
22e77e44 1599 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1600 * are the file position (this may not be supported by all demuxers).
22e77e44 1601 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1602 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1603 * Otherwise all timestamps are in units of the stream selected by stream_index
1604 * or if stream_index is -1, in AV_TIME_BASE units.
1605 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1606 * keyframes (this may not be supported by all demuxers).
1607 *
4d7ab5cf 1608 * @param s media file handle
22e77e44 1609 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1610 * @param min_ts smallest acceptable timestamp
1611 * @param ts target timestamp
1612 * @param max_ts largest acceptable timestamp
1613 * @param flags flags
32e543f8 1614 * @return >=0 on success, error code otherwise
998b6f7c 1615 *
8a4d7a30 1616 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1617 * Thus do not use this yet. It may change at any time, do not expect
1618 * ABI compatibility yet!
d04768fa
MN
1619 */
1620int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1621
1622/**
49bd8e4b 1623 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1624 * current position.
3217cb42 1625 */
fb2758c8 1626int av_read_play(AVFormatContext *s);
3217cb42
PI
1627
1628/**
49bd8e4b 1629 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1630 *
1631 * Use av_read_play() to resume it.
1632 */
fb2758c8 1633int av_read_pause(AVFormatContext *s);
3217cb42 1634
52660454
AK
1635/**
1636 * Close an opened input AVFormatContext. Free it and all its contents
1637 * and set *s to NULL.
1638 */
1639void avformat_close_input(AVFormatContext **s);
370f27de
AK
1640/**
1641 * @}
1642 */
3217cb42 1643
3ba1438d
MN
1644#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1645#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1646#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1647#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1648
3217cb42 1649/**
489a7b07
AK
1650 * @addtogroup lavf_encoding
1651 * @{
1652 */
f3bfe388 1653/**
25de5958
AK
1654 * Allocate the stream private data and write the stream header to
1655 * an output media file.
1656 *
1657 * @param s Media file handle, must be allocated with avformat_alloc_context().
1658 * Its oformat field must be set to the desired output format;
a5f88736 1659 * Its pb field must be set to an already opened AVIOContext.
25de5958
AK
1660 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1661 * On return this parameter will be destroyed and replaced with a dict containing
1662 * options that were not found. May be NULL.
1663 *
1664 * @return 0 on success, negative AVERROR on failure.
1665 *
1666 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1667 */
1668int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1669
3217cb42 1670/**
49bd8e4b 1671 * Write a packet to an output media file.
3217cb42 1672 *
4c750599
AK
1673 * This function passes the packet directly to the muxer, without any buffering
1674 * or reordering. The caller is responsible for correctly interleaving the
1675 * packets if the format requires it. Callers that want libavformat to handle
1676 * the interleaving should call av_interleaved_write_frame() instead of this
1677 * function.
3217cb42
PI
1678 *
1679 * @param s media file handle
2f2b2efd 1680 * @param pkt The packet containing the data to be written. Note that unlike
4c750599
AK
1681 * av_interleaved_write_frame(), this function does not take
1682 * ownership of the packet passed to it (though some muxers may make
1683 * an internal reference to the input packet).
2f2b2efd 1684 * <br>
4c750599
AK
1685 * This parameter can be NULL (at any time, not just at the end), in
1686 * order to immediately flush data buffered within the muxer, for
1687 * muxers that buffer up data internally before writing it to the
1688 * output.
2f2b2efd 1689 * <br>
4c750599
AK
1690 * Packet's @ref AVPacket.stream_index "stream_index" field must be
1691 * set to the index of the corresponding stream in @ref
21ab6fd0
AK
1692 * AVFormatContext.streams "s->streams".
1693 * <br>
1694 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
1695 * must be set to correct values in the stream's timebase (unless the
1696 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
1697 * they can be set to AV_NOPTS_VALUE).
1698 * The dts for subsequent packets passed to this function must be strictly
1699 * increasing when compared in their respective timebases (unless the
1700 * output format is flagged with the AVFMT_TS_NONSTRICT, then they
1701 * merely have to be nondecreasing). @ref AVPacket.duration
1702 * "duration") should also be set if known.
f1caf01d 1703 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
4c750599
AK
1704 *
1705 * @see av_interleaved_write_frame()
3217cb42 1706 */
e928649b 1707int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1708
1709/**
49bd8e4b 1710 * Write a packet to an output media file ensuring correct interleaving.
3217cb42 1711 *
ad7f2b69
AK
1712 * This function will buffer the packets internally as needed to make sure the
1713 * packets in the output file are properly interleaved in the order of
1714 * increasing dts. Callers doing their own interleaving should call
1715 * av_write_frame() instead of this function.
3217cb42
PI
1716 *
1717 * @param s media file handle
2f2b2efd
DB
1718 * @param pkt The packet containing the data to be written.
1719 * <br>
ad7f2b69
AK
1720 * If the packet is reference-counted, this function will take
1721 * ownership of this reference and unreference it later when it sees
1722 * fit.
1723 * The caller must not access the data through this reference after
1724 * this function returns. If the packet is not reference-counted,
1725 * libavformat will make a copy.
2f2b2efd 1726 * <br>
ad7f2b69
AK
1727 * This parameter can be NULL (at any time, not just at the end), to
1728 * flush the interleaving queues.
2f2b2efd 1729 * <br>
ad7f2b69
AK
1730 * Packet's @ref AVPacket.stream_index "stream_index" field must be
1731 * set to the index of the corresponding stream in @ref
21ab6fd0
AK
1732 * AVFormatContext.streams "s->streams".
1733 * <br>
1734 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts")
1735 * must be set to correct values in the stream's timebase (unless the
1736 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then
1737 * they can be set to AV_NOPTS_VALUE).
1738 * The dts for subsequent packets in one stream must be strictly
1739 * increasing (unless the output format is flagged with the
1740 * AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing).
1741 * @ref AVPacket.duration "duration") should also be set if known.
f97cb451 1742 *
394fb56c
AK
1743 * @return 0 on success, a negative AVERROR on error. Libavformat will always
1744 * take care of freeing the packet, even if this function fails.
ad7f2b69
AK
1745 *
1746 * @see av_write_frame(), AVFormatContext.max_interleave_delta
3217cb42 1747 */
3c895fc0 1748int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42 1749
3217cb42 1750/**
49bd8e4b 1751 * Write the stream trailer to an output media file and free the
2b75bde6 1752 * file private data.
3217cb42 1753 *
0af1fe84 1754 * May only be called after a successful call to avformat_write_header.
dc76fe13 1755 *
3217cb42 1756 * @param s media file handle
4f57fa8c 1757 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1758 */
b9a281db 1759int av_write_trailer(AVFormatContext *s);
c8dffc02
AK
1760
1761/**
1762 * Return the output format in the list of registered output formats
1763 * which best matches the provided parameters, or return NULL if
1764 * there is no match.
1765 *
1766 * @param short_name if non-NULL checks if short_name matches with the
1767 * names of the registered formats
1768 * @param filename if non-NULL checks if filename terminates with the
1769 * extensions of the registered formats
1770 * @param mime_type if non-NULL checks if mime_type matches with the
1771 * MIME type of the registered formats
1772 */
1773AVOutputFormat *av_guess_format(const char *short_name,
1774 const char *filename,
1775 const char *mime_type);
1776
1777/**
1778 * Guess the codec ID based upon muxer and filename.
1779 */
36ef5369 1780enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
c8dffc02
AK
1781 const char *filename, const char *mime_type,
1782 enum AVMediaType type);
1783
489a7b07
AK
1784/**
1785 * @}
1786 */
de6d9b64 1787
abf2c2d7
AK
1788
1789/**
1790 * @defgroup lavf_misc Utility functions
1791 * @ingroup libavf
1792 * @{
1793 *
511cf612 1794 * Miscellaneous utility functions related to both muxing and demuxing
abf2c2d7
AK
1795 * (or neither).
1796 */
1797
1798/**
1799 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1800 *
1801 * @param f The file stream pointer where the dump should be sent to.
1802 * @param buf buffer
1803 * @param size buffer size
1804 *
1805 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1806 */
d3c40a7d 1807void av_hex_dump(FILE *f, const uint8_t *buf, int size);
abf2c2d7
AK
1808
1809/**
1810 * Send a nice hexadecimal dump of a buffer to the log.
1811 *
1812 * @param avcl A pointer to an arbitrary struct of which the first field is a
1813 * pointer to an AVClass struct.
1814 * @param level The importance level of the message, lower values signifying
1815 * higher importance.
1816 * @param buf buffer
1817 * @param size buffer size
1818 *
1819 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1820 */
d3c40a7d 1821void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
abf2c2d7
AK
1822
1823/**
1824 * Send a nice dump of a packet to the specified file stream.
1825 *
1826 * @param f The file stream pointer where the dump should be sent to.
1827 * @param pkt packet to dump
1828 * @param dump_payload True if the payload must be displayed, too.
1829 * @param st AVStream that the packet belongs to
1830 */
1831void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1832
1833
1834/**
1835 * Send a nice dump of a packet to the log.
1836 *
1837 * @param avcl A pointer to an arbitrary struct of which the first field is a
1838 * pointer to an AVClass struct.
1839 * @param level The importance level of the message, lower values signifying
1840 * higher importance.
1841 * @param pkt packet to dump
1842 * @param dump_payload True if the payload must be displayed, too.
1843 * @param st AVStream that the packet belongs to
1844 */
1845void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1846 AVStream *st);
1847
1848/**
36ef5369
AK
1849 * Get the AVCodecID for the given codec tag tag.
1850 * If no codec id is found returns AV_CODEC_ID_NONE.
abf2c2d7
AK
1851 *
1852 * @param tags list of supported codec_id-codec_tag pairs, as stored
1853 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
4d7ab5cf 1854 * @param tag codec tag to match to a codec ID
abf2c2d7 1855 */
36ef5369 1856enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
abf2c2d7
AK
1857
1858/**
1859 * Get the codec tag for the given codec id id.
1860 * If no codec tag is found returns 0.
1861 *
1862 * @param tags list of supported codec_id-codec_tag pairs, as stored
1863 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
4d7ab5cf 1864 * @param id codec ID to match to a codec tag
abf2c2d7 1865 */
36ef5369 1866unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
abf2c2d7
AK
1867
1868int av_find_default_stream_index(AVFormatContext *s);
1869
1870/**
1871 * Get the index for a specific timestamp.
4d7ab5cf
DB
1872 *
1873 * @param st stream that the timestamp belongs to
1874 * @param timestamp timestamp to retrieve the index for
abf2c2d7
AK
1875 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1876 * to the timestamp which is <= the requested one, if backward
1877 * is 0, then it will be >=
1878 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1879 * @return < 0 if no such timestamp could be found
1880 */
1881int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1882
1883/**
1884 * Add an index entry into a sorted list. Update the entry if the list
1885 * already contains it.
1886 *
1887 * @param timestamp timestamp in the time base of the given stream
1888 */
1889int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1890 int size, int distance, int flags);
1891
1892
1893/**
1894 * Split a URL string into components.
1895 *
1896 * The pointers to buffers for storing individual components may be null,
1897 * in order to ignore that component. Buffers for components not found are
1898 * set to empty strings. If the port is not found, it is set to a negative
1899 * value.
1900 *
1901 * @param proto the buffer for the protocol
1902 * @param proto_size the size of the proto buffer
1903 * @param authorization the buffer for the authorization
1904 * @param authorization_size the size of the authorization buffer
1905 * @param hostname the buffer for the host name
1906 * @param hostname_size the size of the hostname buffer
1907 * @param port_ptr a pointer to store the port number in
1908 * @param path the buffer for the path
1909 * @param path_size the size of the path buffer
1910 * @param url the URL to split
1911 */
1912void av_url_split(char *proto, int proto_size,
1913 char *authorization, int authorization_size,
1914 char *hostname, int hostname_size,
1915 int *port_ptr,
1916 char *path, int path_size,
1917 const char *url);
1918
610219a5 1919
cdab9db2
VG
1920/**
1921 * Print detailed information about the input or output format, such as
1922 * duration, bitrate, streams, container, programs, metadata, side data,
1923 * codec and time base.
1924 *
1925 * @param ic the context to analyze
1926 * @param index the index to print, if you have multiple inputs or outputs
1927 * @param url the URL to print, such as source or destination file
1928 * @param is_output whether the context is input or ouput
1929 */
610219a5
AK
1930void av_dump_format(AVFormatContext *ic,
1931 int index,
1932 const char *url,
1933 int is_output);
3217cb42 1934
3217cb42 1935/**
49bd8e4b 1936 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1937 *
3217cb42
PI
1938 * Also handles the '%0nd' format where 'n' is the total number
1939 * of digits and '%%'.
1940 *
1941 * @param buf destination buffer
1942 * @param buf_size destination buffer size
1943 * @param path numbered sequence string
8ea0e802 1944 * @param number frame number
4f57fa8c 1945 * @return 0 if OK, -1 on format error
3217cb42 1946 */
5c07cf53
MB
1947int av_get_frame_filename(char *buf, int buf_size,
1948 const char *path, int number);
3217cb42
PI
1949
1950/**
49bd8e4b 1951 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1952 *
1953 * @param filename possible numbered sequence string
4f57fa8c 1954 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1955 */
5c07cf53 1956int av_filename_number_test(const char *filename);
96baaa6a 1957
c5388c07 1958/**
49bd8e4b 1959 * Generate an SDP for an RTP session.
c5388c07 1960 *
8034130e
LB
1961 * Note, this overwrites the id values of AVStreams in the muxer contexts
1962 * for getting unique dynamic payload types.
1963 *
c5388c07
LA
1964 * @param ac array of AVFormatContexts describing the RTP streams. If the
1965 * array is composed by only one context, such context can contain
1966 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1967 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1968 * must contain only one AVStream.
8767b80f 1969 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1970 * @param buf buffer where the SDP will be stored (must be allocated by
1971 * the caller)
8767b80f 1972 * @param size the size of the buffer
4f57fa8c 1973 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1974 */
c234d40b 1975int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe 1976
1a70d127 1977/**
49bd8e4b 1978 * Return a positive value if the given filename has one of the given
1a70d127
SS
1979 * extensions, 0 otherwise.
1980 *
4d7ab5cf 1981 * @param filename file name to check against the given extensions
1a70d127
SS
1982 * @param extensions a comma-separated list of filename extensions
1983 */
1984int av_match_ext(const char *filename, const char *extensions);
1985
48f9e457
AK
1986/**
1987 * Test if the given container can store a codec.
1988 *
4d7ab5cf
DB
1989 * @param ofmt container to check for compatibility
1990 * @param codec_id codec to potentially store in container
48f9e457
AK
1991 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1992 *
1993 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1994 * A negative number if this information is not available.
1995 */
7215fcf8
DB
1996int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id,
1997 int std_compliance);
48f9e457 1998
abf2c2d7 1999/**
dd6d3b0e
AK
2000 * @defgroup riff_fourcc RIFF FourCCs
2001 * @{
36ef5369 2002 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
dd6d3b0e
AK
2003 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
2004 * following code:
2005 * @code
2006 * uint32_t tag = MKTAG('H', '2', '6', '4');
2007 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
36ef5369 2008 * enum AVCodecID id = av_codec_get_id(table, tag);
dd6d3b0e
AK
2009 * @endcode
2010 */
2011/**
36ef5369 2012 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
dd6d3b0e
AK
2013 */
2014const struct AVCodecTag *avformat_get_riff_video_tags(void);
2015/**
36ef5369 2016 * @return the table mapping RIFF FourCCs for audio to AVCodecID.
dd6d3b0e
AK
2017 */
2018const struct AVCodecTag *avformat_get_riff_audio_tags(void);
2019/**
2020 * @}
2021 */
2022
2023/**
abf2c2d7
AK
2024 * @}
2025 */
2026
98790382 2027#endif /* AVFORMAT_AVFORMAT_H */