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