aacdec: Remove erroneous reference to global gain from the out of bounds scalefactor...
[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 *
e361b508
LB
69 * @defgroup lavf_decoding Demuxing
70 * @{
59826cab
AK
71 * Demuxers read a media file and split it into chunks of data (@em packets). A
72 * @ref AVPacket "packet" contains one or more frames which belong a single
73 * elementary stream. In lavf API this process is represented by the
74 * avformat_open_input() function for opening a file, av_read_frame() for
75 * reading a single packet and finally avformat_close_input(), which does the
76 * cleanup.
77 *
78 * @section lavf_decoding_open Opening a media file
79 * The minimum information required to open a file is its URL or filename, which
80 * is passed to avformat_open_input(), as in the following code:
81 * @code
82 * const char *url = "in.mp3";
83 * AVFormatContext *s = NULL;
84 * int ret = avformat_open_input(&s, url, NULL, NULL);
85 * if (ret < 0)
86 * abort();
87 * @endcode
88 * The above code attempts to allocate an AVFormatContext, open the
89 * specified file (autodetecting the format) and read the header, exporting the
90 * information stored there into s. Some formats do not have a header or do not
91 * store enough information there, so it is recommended that you call the
92 * avformat_find_stream_info() function which tries to read and decode a few
93 * frames to find missing information.
94 *
95 * In some cases you might want to preallocate an AVFormatContext yourself with
96 * avformat_alloc_context() and do some tweaking on it before passing it to
97 * avformat_open_input(). One such case is when you want to use custom functions
98 * for reading input data instead of lavf internal I/O layer.
99 * To do that, create your own AVIOContext with avio_alloc_context(), passing
100 * your reading callbacks to it. Then set the @em pb field of your
101 * AVFormatContext to newly created AVIOContext.
102 *
103 * After you have finished reading the file, you must close it with
104 * avformat_close_input(). It will free everything associated with the file.
105 *
106 * @section lavf_decoding_read Reading from an opened file
107 *
108 * @section lavf_decoding_seek Seeking
e361b508
LB
109 * @}
110 *
111 * @defgroup lavf_encoding Muxing
112 * @{
113 * @}
114 *
e4f4a1f9 115 * @defgroup lavf_io I/O Read/Write
e361b508
LB
116 * @{
117 * @}
118 *
119 * @defgroup lavf_codec Demuxers
120 * @{
121 * @defgroup lavf_codec_native Native Demuxers
122 * @{
123 * @}
124 * @defgroup lavf_codec_wrappers External library wrappers
125 * @{
126 * @}
127 * @}
128 * @defgroup lavf_protos I/O Protocols
129 * @{
130 * @}
131 * @defgroup lavf_internal Internal
132 * @{
133 * @}
134 * @}
135 *
136 */
072e3efd 137
f71869a4 138#include <time.h>
67070e4f 139#include <stdio.h> /* FILE */
76a448ed 140#include "libavcodec/avcodec.h"
d9f80ea2 141#include "libavutil/dict.h"
abc78a5a 142#include "libavutil/log.h"
de6d9b64 143
de6d9b64 144#include "avio.h"
50196a98 145#include "libavformat/version.h"
de6d9b64 146
f610a9f2
AJ
147struct AVFormatContext;
148
a6d18a0e 149
1a53a438
RT
150/**
151 * @defgroup metadata_api Public Metadata API
152 * @{
b262a059 153 * @ingroup libavf
ea29242c 154 * The metadata API allows libavformat to export metadata tags to a client
28b4c06b
AK
155 * application when demuxing. Conversely it allows a client application to
156 * set metadata when muxing.
157 *
158 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
159 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
160 * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
161 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
61648423 162 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
28b4c06b 163 *
ea29242c 164 * Important concepts to keep in mind:
1a53a438 165 * - Keys are unique; there can never be 2 tags with the same key. This is
ea29242c
MM
166 * also meant semantically, i.e., a demuxer should not knowingly produce
167 * several keys that are literally different but semantically identical.
168 * E.g., key=Author5, key=Author6. In this example, all authors must be
169 * placed in the same tag.
1a53a438 170 * - Metadata is flat, not hierarchical; there are no subtags. If you
ea29242c
MM
171 * want to store, e.g., the email address of the child of producer Alice
172 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
1a53a438 173 * - Several modifiers can be applied to the tag name. This is done by
ca76a119
AK
174 * appending a dash character ('-') and the modifier name in the order
175 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
1a53a438 176 * - language -- a tag whose value is localized for a particular language
ca76a119
AK
177 * is appended with the ISO 639-2/B 3-letter language code.
178 * For example: Author-ger=Michael, Author-eng=Mike
179 * The original/default language is in the unqualified "Author" tag.
180 * A demuxer should set a default if it sets any translated tag.
1a53a438 181 * - sorting -- a modified version of a tag that should be used for
ca76a119
AK
182 * sorting will have '-sort' appended. E.g. artist="The Beatles",
183 * artist-sort="Beatles, The".
184 *
1a53a438 185 * - Demuxers attempt to export metadata in a generic format, however tags
03700d39
AK
186 * with no generic equivalents are left as they are stored in the container.
187 * Follows a list of generic tag names:
ca76a119 188 *
1a53a438
RT
189 @verbatim
190 album -- name of the set this work belongs to
191 album_artist -- main creator of the set/album, if different from artist.
192 e.g. "Various Artists" for compilation albums.
193 artist -- main creator of the work
194 comment -- any additional description of the file.
195 composer -- who composed the work, if different from artist.
196 copyright -- name of copyright holder.
197 creation_time-- date when the file was created, preferably in ISO 8601.
198 date -- date when the work was created, preferably in ISO 8601.
199 disc -- number of a subset, e.g. disc in a multi-disc collection.
200 encoder -- name/settings of the software/hardware that produced the file.
201 encoded_by -- person/group who created the file.
202 filename -- original name of the file.
203 genre -- <self-evident>.
204 language -- main language in which the work is performed, preferably
205 in ISO 639-2 format. Multiple languages can be specified by
206 separating them with commas.
207 performer -- artist who performed the work, if different from artist.
208 E.g for "Also sprach Zarathustra", artist would be "Richard
209 Strauss" and performer "London Philharmonic Orchestra".
210 publisher -- name of the label/publisher.
211 service_name -- name of the service in broadcasting (channel name).
212 service_provider -- name of the service provider in broadcasting.
213 title -- name of the work.
214 track -- number of this work in the set, can be in form current/total.
215 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
216 @endverbatim
217 *
12489443
RT
218 * Look in the examples section for an application example how to use the Metadata API.
219 *
1a53a438 220 * @}
a6d18a0e
MN
221 */
222
de6d9b64
FB
223/* packet functions */
224
3217cb42
PI
225
226/**
49bd8e4b 227 * Allocate and read the payload of a packet and initialize its
d1b9adf2 228 * fields with default values.
3217cb42
PI
229 *
230 * @param pkt packet
4f57fa8c
DB
231 * @param size desired payload size
232 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 233 */
ae628ec1 234int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
3217cb42 235
de6d9b64 236
6bfc2683 237/**
fa8cc126
RD
238 * Read data and append it to the current content of the AVPacket.
239 * If pkt->size is 0 this is identical to av_get_packet.
6bfc2683
RD
240 * Note that this uses av_grow_packet and thus involves a realloc
241 * which is inefficient. Thus this function should only be used
242 * when there is no reasonable way to know (an upper bound of)
243 * the final size.
244 *
245 * @param pkt packet
246 * @param size amount of data to read
247 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
248 * will not be lost even if an error occurs.
249 */
ae628ec1 250int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
6bfc2683 251
de6d9b64 252/*************************************************/
916c80e9
FB
253/* fractional numbers for exact pts handling */
254
671adb17 255/**
4f57fa8c
DB
256 * The exact value of the fractional number is: 'val + num / den'.
257 * num is assumed to be 0 <= num < den.
4c08b2bd 258 */
916c80e9 259typedef struct AVFrac {
115329f1 260 int64_t val, num, den;
52e57500 261} AVFrac;
916c80e9 262
916c80e9 263/*************************************************/
b9a281db 264/* input/output formats */
de6d9b64 265
7caf0cc6
MN
266struct AVCodecTag;
267
76c56376
MN
268/**
269 * This structure contains the data a format has to probe a file.
270 */
b9a281db 271typedef struct AVProbeData {
5c91a675 272 const char *filename;
e5f58f81 273 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
274 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
275} AVProbeData;
276
22e77e44 277#define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
87e87886 278#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64 279
c68fafe0 280/// Demuxer will use avio_open, no opened file should be provided by the caller.
40d9c544 281#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
282#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
283#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
284#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
285 raw picture data. */
286#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
287#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
288#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
58ec7e00 289#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
25918212 290#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 291#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
bb62d5c1 292#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
69fa2396
VP
293#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
294#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
b631fba9 295#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
f1caf01d 296#define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
b9a281db 297
489a7b07
AK
298/**
299 * @addtogroup lavf_encoding
300 * @{
301 */
b9a281db 302typedef struct AVOutputFormat {
de6d9b64 303 const char *name;
bde15e74
SS
304 /**
305 * Descriptive name for the format, meant to be more human-readable
819174fa 306 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
307 * to define it.
308 */
de6d9b64
FB
309 const char *long_name;
310 const char *mime_type;
4f57fa8c 311 const char *extensions; /**< comma-separated filename extensions */
183eaa9a
AK
312 /* output support */
313 enum CodecID audio_codec; /**< default audio codec */
314 enum CodecID video_codec; /**< default video codec */
315 enum CodecID subtitle_codec; /**< default subtitle codec */
316 /**
317 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
318 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
319 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH
320 */
321 int flags;
322
323 /**
324 * List of supported codec_id-codec_tag pairs, ordered by "better
325 * choice first". The arrays are all terminated by CODEC_ID_NONE.
326 */
327 const struct AVCodecTag * const *codec_tag;
328
329
330 const AVClass *priv_class; ///< AVClass for the private context
331
332 /*****************************************************************
333 * No fields below this line are part of the public API. They
334 * may not be used outside of libavformat and can be changed and
335 * removed at will.
336 * New public fields should be added right above.
337 *****************************************************************
338 */
339 struct AVOutputFormat *next;
76c56376
MN
340 /**
341 * size of private data so that it can be allocated in the wrapper
342 */
b9a281db 343 int priv_data_size;
183eaa9a 344
de6d9b64 345 int (*write_header)(struct AVFormatContext *);
f1caf01d
MS
346 /**
347 * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
348 * pkt can be NULL in order to flush data buffered in the muxer.
349 * When flushing, return 0 if there still is more data to flush,
350 * or 1 if everything was flushed and there is no more buffered
351 * data.
352 */
e928649b 353 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 354 int (*write_trailer)(struct AVFormatContext *);
76c56376 355 /**
76c56376
MN
356 * Currently only used to set pixel format if not YUV420P.
357 */
78cb7273
DB
358 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
359 AVPacket *in, int flush);
48f9e457
AK
360 /**
361 * Test if the given codec can be stored in this container.
362 *
363 * @return 1 if the codec is supported, 0 if it is not.
364 * A negative number if unknown.
365 */
366 int (*query_codec)(enum CodecID id, int std_compliance);
b9a281db 367} AVOutputFormat;
489a7b07
AK
368/**
369 * @}
370 */
de6d9b64 371
370f27de
AK
372/**
373 * @addtogroup lavf_decoding
374 * @{
375 */
b9a281db 376typedef struct AVInputFormat {
76c56376
MN
377 /**
378 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
379 * may be appended with a minor bump.
380 */
b9a281db 381 const char *name;
76c56376 382
bde15e74
SS
383 /**
384 * Descriptive name for the format, meant to be more human-readable
819174fa 385 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
386 * to define it.
387 */
b9a281db 388 const char *long_name;
76c56376
MN
389
390 /**
183eaa9a
AK
391 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
392 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
393 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
394 */
395 int flags;
396
397 /**
398 * If extensions are defined, then no probe is done. You should
399 * usually not use extension format guessing because it is not
400 * reliable enough
401 */
402 const char *extensions;
403
404 const struct AVCodecTag * const *codec_tag;
405
406 const AVClass *priv_class; ///< AVClass for the private context
407
408 /*****************************************************************
409 * No fields below this line are part of the public API. They
410 * may not be used outside of libavformat and can be changed and
411 * removed at will.
412 * New public fields should be added right above.
413 *****************************************************************
414 */
415 struct AVInputFormat *next;
416
417 /**
f7fe41a0 418 * Raw demuxers store their codec ID here.
183eaa9a 419 */
f7fe41a0 420 int raw_codec_id;
183eaa9a
AK
421
422 /**
76c56376
MN
423 * Size of private data so that it can be allocated in the wrapper.
424 */
b9a281db 425 int priv_data_size;
76c56376 426
65d7d68b 427 /**
22e77e44 428 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
429 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
430 * big so you do not have to check for that unless you need more.
65d7d68b 431 */
b9a281db 432 int (*read_probe)(AVProbeData *);
76c56376
MN
433
434 /**
435 * Read the format header and initialize the AVFormatContext
6b8b0fe2
LB
436 * structure. Return 0 if OK. Only used in raw format right
437 * now. 'avformat_new_stream' should be called to create new streams.
76c56376 438 */
6e9651d1 439 int (*read_header)(struct AVFormatContext *);
76c56376
MN
440
441 /**
442 * Read one packet and put it in 'pkt'. pts and flags are also
6b8b0fe2 443 * set. 'avformat_new_stream' can be called only if the flag
2899a28c
AJ
444 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
445 * background thread).
76c56376
MN
446 * @return 0 on success, < 0 on error.
447 * When returning an error, pkt must not have been allocated
448 * or must be freed before returning
449 */
de6d9b64 450 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
451
452 /**
453 * Close the stream. The AVFormatContext and AVStreams are not
454 * freed by this function
455 */
de6d9b64 456 int (*read_close)(struct AVFormatContext *);
1de2db8f 457
115329f1 458 /**
4f57fa8c
DB
459 * Seek to a given timestamp relative to the frames in
460 * stream component stream_index.
22e77e44
DB
461 * @param stream_index Must not be -1.
462 * @param flags Selects which direction should be preferred if no exact
463 * match is available.
05ce0f11 464 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 465 */
e5c70815
AK
466 int (*read_seek)(struct AVFormatContext *,
467 int stream_index, int64_t timestamp, int flags);
468
8d14a25c 469 /**
58c42af7 470 * Get the next timestamp in stream[stream_index].time_base units.
d9526386 471 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
472 */
473 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
474 int64_t *pos, int64_t pos_limit);
76c56376
MN
475
476 /**
76c56376
MN
477 * Start/resume playing - only meaningful if using a network-based format
478 * (RTSP).
479 */
fb2758c8
FB
480 int (*read_play)(struct AVFormatContext *);
481
76c56376
MN
482 /**
483 * Pause playing - only meaningful if using a network-based format
484 * (RTSP).
485 */
fb2758c8
FB
486 int (*read_pause)(struct AVFormatContext *);
487
1de2db8f 488 /**
49bd8e4b 489 * Seek to timestamp ts.
1de2db8f
MN
490 * Seeking will be done so that the point from which all active streams
491 * can be presented successfully will be closest to ts and within min/max_ts.
492 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
493 */
882fb0a3 494 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
b9a281db 495} AVInputFormat;
370f27de
AK
496/**
497 * @}
498 */
de6d9b64 499
57004ff1
AJ
500enum AVStreamParseType {
501 AVSTREAM_PARSE_NONE,
502 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 503 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 504 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 505 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
506};
507
fb2758c8
FB
508typedef struct AVIndexEntry {
509 int64_t pos;
510 int64_t timestamp;
511#define AVINDEX_KEYFRAME 0x0001
30a43f2d 512 int flags:2;
4f57fa8c
DB
513 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).
514 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
515} AVIndexEntry;
516
90c2295b
ES
517#define AV_DISPOSITION_DEFAULT 0x0001
518#define AV_DISPOSITION_DUB 0x0002
519#define AV_DISPOSITION_ORIGINAL 0x0004
520#define AV_DISPOSITION_COMMENT 0x0008
521#define AV_DISPOSITION_LYRICS 0x0010
522#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
523
524/**
525 * Track should be used during playback by default.
526 * Useful for subtitle track that should be displayed
527 * even when user did not explicitly ask for subtitles.
528 */
7a617a86 529#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
530#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
531#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 532#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
90c2295b 533
ba66ae94
MN
534/**
535 * Stream structure.
536 * New fields can be added to the end with minor version bumps.
8bfb108b 537 * Removal, reordering and changes to existing fields require a major
ba66ae94 538 * version bump.
8bfb108b 539 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 540 */
de6d9b64 541typedef struct AVStream {
43d414ba 542 int index; /**< stream index in AVFormatContext */
4f57fa8c 543 int id; /**< format-specific stream ID */
43d414ba 544 AVCodecContext *codec; /**< codec context */
b4b87d48 545 /**
22e77e44
DB
546 * Real base framerate of the stream.
547 * This is the lowest framerate with which all timestamps can be
864ff8c1 548 * represented accurately (it is the least common multiple of all
22e77e44
DB
549 * framerates in the stream). Note, this value is just a guess!
550 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 551 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
552 */
553 AVRational r_frame_rate;
de6d9b64 554 void *priv_data;
82583548 555
76c56376
MN
556 /**
557 * encoding: pts generation when outputting stream
558 */
a9fd2b19 559 struct AVFrac pts;
5b28c8c3
MN
560
561 /**
8bfb108b
DB
562 * This is the fundamental unit of time (in seconds) in terms
563 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 564 * time base should be 1/framerate and timestamp increments should be 1.
5d820db2
RD
565 * decoding: set by libavformat
566 * encoding: set by libavformat in av_write_header
5b28c8c3 567 */
9ee91c2f 568 AVRational time_base;
4f57fa8c 569 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 570
6d96a9b9 571 /**
8bfb108b
DB
572 * Decoding: pts of the first frame of the stream, in stream time base.
573 * Only set this if you are absolutely 100% sure that the value you set
574 * it to really is the pts of the first frame.
4854c253 575 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 576 */
115329f1 577 int64_t start_time;
76c56376 578
e26381b6 579 /**
8bfb108b 580 * Decoding: duration of the stream, in stream time base.
e26381b6 581 * If a source file does not specify a duration, but does specify
4f57fa8c 582 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 583 */
ee404803 584 int64_t duration;
fb2758c8 585
b4b87d48 586 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 587
4f57fa8c 588 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5 589
c30a4489
AJ
590 /**
591 * sample aspect ratio (0 if unknown)
592 * - encoding: Set by user.
593 * - decoding: Set by libavformat.
594 */
595 AVRational sample_aspect_ratio;
f526adaf 596
d2d67e42 597 AVDictionary *metadata;
3a41c2f7 598
02b398ef
MN
599 /**
600 * Average framerate
601 */
602 AVRational avg_frame_rate;
6c6e6ef5 603
9a174562
AK
604 /*****************************************************************
605 * All fields below this line are not part of the public API. They
606 * may not be used outside of libavformat and can be changed and
607 * removed at will.
608 * New public fields should be added right above.
609 *****************************************************************
610 */
611
6c6e6ef5
MN
612 /**
613 * Number of frames that have been demuxed during av_find_stream_info()
614 */
615 int codec_info_nb_frames;
fd0368e7
AJ
616
617 /**
da9cea77 618 * Stream information used internally by av_find_stream_info()
fd0368e7
AJ
619 */
620#define MAX_STD_TIMEBASES (60*12+5)
621 struct {
622 int64_t last_dts;
623 int64_t duration_gcd;
624 int duration_count;
625 double duration_error[MAX_STD_TIMEBASES];
626 int64_t codec_info_duration;
38a4be3f 627 int nb_decoded_frames;
fd0368e7 628 } *info;
9a174562
AK
629 const uint8_t *cur_ptr;
630 int cur_len;
631 AVPacket cur_pkt;
632
633 // Timestamp generation support:
634 /**
635 * Timestamp corresponding to the last dts sync point.
636 *
637 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
638 * a DTS is received from the underlying container. Otherwise set to
639 * AV_NOPTS_VALUE by default.
640 */
641 int64_t reference_dts;
642 int64_t first_dts;
643 int64_t cur_dts;
644 int last_IP_duration;
645 int64_t last_IP_pts;
646
647 /**
648 * Number of packets to buffer for codec probing
649 */
650#define MAX_PROBE_PACKETS 2500
651 int probe_packets;
652
653 /**
654 * last packet in packet_buffer for this stream when muxing.
655 */
656 struct AVPacketList *last_in_packet_buffer;
657 AVProbeData probe_data;
658#define MAX_REORDER_DELAY 16
659 int64_t pts_buffer[MAX_REORDER_DELAY+1];
660 /* av_read_frame() support */
661 enum AVStreamParseType need_parsing;
662 struct AVCodecParserContext *parser;
663
664 AVIndexEntry *index_entries; /**< Only used if the format does not
665 support seeking natively. */
666 int nb_index_entries;
667 unsigned int index_entries_allocated_size;
668
669 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
de6d9b64
FB
670} AVStream;
671
15afa396
NS
672#define AV_PROGRAM_RUNNING 1
673
ba66ae94 674/**
ba66ae94 675 * New fields can be added to the end with minor version bumps.
8bfb108b 676 * Removal, reordering and changes to existing fields require a major
ba66ae94 677 * version bump.
8bfb108b 678 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 679 */
15afa396
NS
680typedef struct AVProgram {
681 int id;
15afa396
NS
682 int flags;
683 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
684 unsigned int *stream_index;
685 unsigned int nb_stream_indexes;
d2d67e42 686 AVDictionary *metadata;
15afa396
NS
687} AVProgram;
688
43d414ba 689#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
690 (streams are added dynamically) */
691
79d7836a 692typedef struct AVChapter {
4f57fa8c
DB
693 int id; ///< unique ID to identify the chapter
694 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 695 int64_t start, end; ///< chapter start/end time in time_base units
d2d67e42 696 AVDictionary *metadata;
79d7836a
AK
697} AVChapter;
698
252f17e2 699/**
4f57fa8c 700 * Format I/O context.
252f17e2 701 * New fields can be added to the end with minor version bumps.
8bfb108b 702 * Removal, reordering and changes to existing fields require a major
252f17e2 703 * version bump.
83daced0
AK
704 * sizeof(AVFormatContext) must not be used outside libav*, use
705 * avformat_alloc_context() to create an AVFormatContext.
252f17e2 706 */
de6d9b64 707typedef struct AVFormatContext {
83daced0
AK
708 /**
709 * A class for logging and AVOptions. Set by avformat_alloc_context().
710 * Exports (de)muxer private options if they exist.
711 */
712 const AVClass *av_class;
713
714 /**
715 * Can only be iformat or oformat, not both at the same time.
716 *
717 * decoding: set by avformat_open_input().
718 * encoding: set by the user.
719 */
b9a281db
FB
720 struct AVInputFormat *iformat;
721 struct AVOutputFormat *oformat;
83daced0
AK
722
723 /**
724 * Format private data. This is an AVOptions-enabled struct
725 * if and only if iformat/oformat.priv_class is not NULL.
726 */
de6d9b64 727 void *priv_data;
83daced0
AK
728
729 /*
730 * I/O context.
731 *
732 * decoding: either set by the user before avformat_open_input() (then
733 * the user must close it manually) or set by avformat_open_input().
734 * encoding: set by the user.
735 *
736 * Do NOT set this field if AVFMT_NOFILE flag is set in
737 * iformat/oformat.flags. In such a case, the (de)muxer will handle
738 * I/O in some other way and this field will be NULL.
739 */
ae628ec1 740 AVIOContext *pb;
83daced0
AK
741
742 /**
743 * A list of all streams in the file. New streams are created with
744 * avformat_new_stream().
745 *
746 * decoding: streams are created by libavformat in avformat_open_input().
747 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
748 * appear in av_read_frame().
749 * encoding: streams are created by the user before avformat_write_header().
750 */
db69c2e5 751 unsigned int nb_streams;
38aab35f 752 AVStream **streams;
83daced0 753
43d414ba 754 char filename[1024]; /**< input or output filename */
de6d9b64 755 /* stream info */
4f57fa8c 756 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
ee404803 757
76c56376
MN
758 /**
759 * Decoding: position of the first frame of the component, in
760 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
761 * It is deduced from the AVStream values.
762 */
115329f1 763 int64_t start_time;
76c56376
MN
764
765 /**
766 * Decoding: duration of the stream, in AV_TIME_BASE fractional
767 * seconds. Only set this value if you know none of the individual stream
da9cea77 768 * durations and also do not set any of them. This is deduced from the
76c56376
MN
769 * AVStream values if not set.
770 */
ee404803 771 int64_t duration;
76c56376 772
76c56376
MN
773 /**
774 * Decoding: total stream bitrate in bit/s, 0 if not
775 * available. Never set it directly if the file_size and the
6001dad6 776 * duration are known as Libav can compute it automatically.
76c56376 777 */
ee404803 778 int bit_rate;
fb2758c8 779
92400be2 780 unsigned int packet_size;
17c88cb0 781 int max_delay;
8108551a 782
30bc6613 783 int flags;
22e77e44 784#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
785#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
786#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 787#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
788#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
789#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
05e84c95 790#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
73e8e8db 791#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
5894e1bb 792
76c56376
MN
793 /**
794 * decoding: size of data to probe; encoding: unused.
795 */
9e6c9470 796 unsigned int probesize;
a44b3c4d
MN
797
798 /**
83daced0
AK
799 * decoding: maximum time (in AV_TIME_BASE units) during which the input should
800 * be analyzed in avformat_find_stream_info().
a44b3c4d
MN
801 */
802 int max_analyze_duration;
c964c2c7
RD
803
804 const uint8_t *key;
805 int keylen;
15afa396
NS
806
807 unsigned int nb_programs;
808 AVProgram **programs;
62600469
MN
809
810 /**
811 * Forced video codec_id.
4f57fa8c 812 * Demuxing: Set by user.
62600469
MN
813 */
814 enum CodecID video_codec_id;
76c56376 815
62600469
MN
816 /**
817 * Forced audio codec_id.
4f57fa8c 818 * Demuxing: Set by user.
62600469
MN
819 */
820 enum CodecID audio_codec_id;
76c56376 821
62600469
MN
822 /**
823 * Forced subtitle codec_id.
4f57fa8c 824 * Demuxing: Set by user.
62600469
MN
825 */
826 enum CodecID subtitle_codec_id;
3dea63bd
PK
827
828 /**
22e77e44
DB
829 * Maximum amount of memory in bytes to use for the index of each stream.
830 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
831 * needed to maintain a smaller size. This can lead to slower or less
832 * accurate seeking (depends on demuxer).
4f57fa8c 833 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
834 * this.
835 * muxing : unused
836 * demuxing: set by user
837 */
838 unsigned int max_index_size;
ab8ab30c
RP
839
840 /**
ffa71b2b 841 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 842 * obtained from realtime capture devices.
ab8ab30c
RP
843 */
844 unsigned int max_picture_buffer;
79d7836a 845
fbabf1e9 846 unsigned int nb_chapters;
79d7836a 847 AVChapter **chapters;
45b2b05f
MN
848
849 /**
4f57fa8c 850 * Flags to enable debugging.
45b2b05f
MN
851 */
852 int debug;
853#define FF_FDEBUG_TS 0x0001
0bef08e5 854
d2d67e42 855 AVDictionary *metadata;
af122d6a 856
b8819c85
MS
857 /**
858 * Start time of the stream in real world time, in microseconds
859 * since the unix epoch (00:00 1st January 1970). That is, pts=0
860 * in the stream was captured at this real world time.
861 * - encoding: Set by user.
862 * - decoding: Unused.
863 */
864 int64_t start_time_realtime;
30315a8d
AC
865
866 /**
867 * decoding: number of frames used to probe fps
868 */
869 int fps_probe_size;
2f63440c
DB
870
871 /**
872 * Error recognition; higher values will detect more errors but may
873 * misdetect some more or less valid parts as errors.
874 * - encoding: unused
875 * - decoding: Set by user.
876 */
877 int error_recognition;
df968050 878
6aa0b98f
MS
879 /**
880 * Custom interrupt callbacks for the I/O layer.
881 *
882 * decoding: set by the user before avformat_open_input().
883 * encoding: set by the user before avformat_write_header()
884 * (mainly useful for AVFMT_NOFILE formats). The callback
885 * should also be passed to avio_open2() if it's used to
886 * open the file.
887 */
888 AVIOInterruptCB interrupt_callback;
889
df968050
AK
890 /*****************************************************************
891 * All fields below this line are not part of the public API. They
892 * may not be used outside of libavformat and can be changed and
893 * removed at will.
894 * New public fields should be added right above.
895 *****************************************************************
896 */
df968050
AK
897 /**
898 * Raw packets from the demuxer, prior to parsing and decoding.
899 * This buffer is used for buffering packets until the codec can
900 * be identified, as parsing cannot be done without knowing the
901 * codec.
902 */
903 struct AVPacketList *raw_packet_buffer;
904 struct AVPacketList *raw_packet_buffer_end;
905 /**
906 * Remaining size available for raw_packet_buffer, in bytes.
907 */
908#define RAW_PACKET_BUFFER_SIZE 2500000
909 int raw_packet_buffer_remaining_size;
910
911 /**
912 * This buffer is only needed when packets were already buffered but
913 * not decoded, for example to get the codec parameters in MPEG
914 * streams.
915 */
916 struct AVPacketList *packet_buffer;
917 struct AVPacketList *packet_buffer_end;
918
919 /* av_read_frame() support */
920 AVStream *cur_st;
921
922 /* av_seek_frame() support */
923 int64_t data_offset; /**< offset of the first packet */
de6d9b64
FB
924} AVFormatContext;
925
926typedef struct AVPacketList {
927 AVPacket pkt;
928 struct AVPacketList *next;
929} AVPacketList;
930
469c62d0
AK
931
932/**
933 * @defgroup lavf_core Core functions
934 * @ingroup libavf
935 *
936 * Functions for querying libavformat capabilities, allocating core structures,
937 * etc.
938 * @{
939 */
940
941/**
942 * Return the LIBAVFORMAT_VERSION_INT constant.
943 */
944unsigned avformat_version(void);
945
946/**
947 * Return the libavformat build-time configuration.
948 */
949const char *avformat_configuration(void);
950
951/**
952 * Return the libavformat license.
953 */
954const char *avformat_license(void);
955
956/**
957 * Initialize libavformat and register all the muxers, demuxers and
958 * protocols. If you do not call this function, then you can select
959 * exactly which formats you want to support.
960 *
961 * @see av_register_input_format()
962 * @see av_register_output_format()
963 * @see av_register_protocol()
964 */
965void av_register_all(void);
966
967void av_register_input_format(AVInputFormat *format);
968void av_register_output_format(AVOutputFormat *format);
969
970/**
971 * Do global initialization of network components. This is optional,
972 * but recommended, since it avoids the overhead of implicitly
973 * doing the setup for each session.
974 *
975 * Calling this function will become mandatory if using network
976 * protocols at some major version bump.
977 */
978int avformat_network_init(void);
979
980/**
981 * Undo the initialization done by avformat_network_init.
982 */
983int avformat_network_deinit(void);
984
aeedac95
SS
985/**
986 * If f is NULL, returns the first registered input format,
22e77e44 987 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
988 * or NULL if f is the last one.
989 */
84be6e72 990AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
991
992/**
993 * If f is NULL, returns the first registered output format,
22e77e44 994 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
995 * or NULL if f is the last one.
996 */
84be6e72 997AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 998
469c62d0
AK
999/**
1000 * Allocate an AVFormatContext.
1001 * avformat_free_context() can be used to free the context and everything
1002 * allocated by the framework within it.
1003 */
1004AVFormatContext *avformat_alloc_context(void);
1005
1006/**
1007 * Free an AVFormatContext and all its streams.
1008 * @param s context to free
1009 */
1010void avformat_free_context(AVFormatContext *s);
1011
1012/**
1013 * Get the AVClass for AVFormatContext. It can be used in combination with
1014 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1015 *
1016 * @see av_opt_find().
1017 */
1018const AVClass *avformat_get_class(void);
1019
1020/**
1021 * Add a new stream to a media file.
1022 *
1023 * When demuxing, it is called by the demuxer in read_header(). If the
1024 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1025 * be called in read_packet().
1026 *
1027 * When muxing, should be called by the user before avformat_write_header().
1028 *
1029 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1030 * will be initialized to use this codec. This is needed for e.g. codec-specific
1031 * defaults to be set, so codec should be provided if it is known.
1032 *
1033 * @return newly created stream or NULL on error.
1034 */
1035AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1036
1037AVProgram *av_new_program(AVFormatContext *s, int id);
1038
1039/**
1040 * @}
1041 */
1042
1043
370f27de 1044/**
370f27de
AK
1045 * @addtogroup lavf_decoding
1046 * @{
1047 */
3217cb42
PI
1048
1049/**
49bd8e4b 1050 * Find AVInputFormat based on the short name of the input format.
3217cb42 1051 */
b9a281db 1052AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1053
1054/**
49bd8e4b 1055 * Guess the file format.
3217cb42 1056 *
4f57fa8c
DB
1057 * @param is_opened Whether the file is already opened; determines whether
1058 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1059 */
94988531 1060AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1061
1062/**
49bd8e4b 1063 * Guess the file format.
8e2ee182
RD
1064 *
1065 * @param is_opened Whether the file is already opened; determines whether
1066 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1067 * @param score_max A probe score larger that this is required to accept a
1068 * detection, the variable is set to the actual detection
1069 * score afterwards.
1070 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1071 * to retry with a larger probe buffer.
1072 */
1073AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1074
1075/**
3940caad
AH
1076 * Probe a bytestream to determine the input format. Each time a probe returns
1077 * with a score that is too low, the probe buffer size is increased and another
1078 * attempt is made. When the maximum probe size is reached, the input format
1079 * with the highest score is returned.
1080 *
1081 * @param pb the bytestream to probe
1082 * @param fmt the input format is put here
1083 * @param filename the filename of the stream
1084 * @param logctx the log context
1085 * @param offset the offset within the bytestream to probe from
1086 * @param max_probe_size the maximum probe buffer size (zero for default)
1087 * @return 0 in case of success, a negative value corresponding to an
1088 * AVERROR code otherwise
1089 */
ae628ec1 1090int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1091 const char *filename, void *logctx,
1092 unsigned int offset, unsigned int max_probe_size);
1093
88808c60 1094/**
05e84c95
AK
1095 * Open an input stream and read the header. The codecs are not opened.
1096 * The stream must be closed with av_close_input_file().
1097 *
1098 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1099 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1100 * function and written into ps.
1101 * Note that a user-supplied AVFormatContext will be freed on failure.
1102 * @param filename Name of the stream to open.
1103 * @param fmt If non-NULL, this parameter forces a specific input format.
1104 * Otherwise the format is autodetected.
1105 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1106 * On return this parameter will be destroyed and replaced with a dict containing
1107 * options that were not found. May be NULL.
1108 *
1109 * @return 0 on success, a negative AVERROR on failure.
1110 *
1111 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1112 */
1113int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1114
a67c061e
AK
1115/**
1116 * Read packets of a media file to get stream information. This
1117 * is useful for file formats with no headers such as MPEG. This
1118 * function also computes the real framerate in case of MPEG-2 repeat
1119 * frame mode.
1120 * The logical file position is not changed by this function;
1121 * examined packets may be buffered for later processing.
1122 *
1123 * @param ic media file handle
1124 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1125 * dictionaries, where i-th member contains options for
1126 * codec corresponding to i-th stream.
1127 * On return each dictionary will be filled with options that were not found.
1128 * @return >=0 if OK, AVERROR_xxx on error
1129 *
1130 * @note this function isn't guaranteed to open all the codecs, so
1131 * options being non-empty at return is a perfectly normal behavior.
1132 *
1133 * @todo Let the user decide somehow what information is needed so that
1134 * we do not waste time getting stuff the user does not need.
1135 */
1136int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
3217cb42
PI
1137
1138/**
9128ae08
NG
1139 * Find the "best" stream in the file.
1140 * The best stream is determined according to various heuristics as the most
1141 * likely to be what the user expects.
1142 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1143 * default decoder for the stream's codec; streams for which no decoder can
1144 * be found are ignored.
1145 *
1146 * @param ic media file handle
1147 * @param type stream type: video, audio, subtitles, etc.
1148 * @param wanted_stream_nb user-requested stream number,
1149 * or -1 for automatic selection
1150 * @param related_stream try to find a stream related (eg. in the same
1151 * program) to this one, or -1 if none
1152 * @param decoder_ret if non-NULL, returns the decoder for the
1153 * selected stream
1154 * @param flags flags; none are currently defined
1155 * @return the non-negative stream number in case of success,
1156 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1157 * could be found,
1158 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1159 * @note If av_find_best_stream returns successfully and decoder_ret is not
1160 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1161 */
1162int av_find_best_stream(AVFormatContext *ic,
1163 enum AVMediaType type,
1164 int wanted_stream_nb,
1165 int related_stream,
1166 AVCodec **decoder_ret,
1167 int flags);
1168
1169/**
49bd8e4b 1170 * Read a transport packet from a media file.
3217cb42 1171 *
864ff8c1 1172 * This function is obsolete and should never be used.
3217cb42
PI
1173 * Use av_read_frame() instead.
1174 *
1175 * @param s media file handle
1176 * @param pkt is filled
4f57fa8c 1177 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1178 */
de6d9b64 1179int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1180
1181/**
49bd8e4b 1182 * Return the next frame of a stream.
4faf628f
MN
1183 * This function returns what is stored in the file, and does not validate
1184 * that what is there are valid frames for the decoder. It will split what is
1185 * stored in the file into frames and return one for each call. It will not
1186 * omit invalid data between valid frames so as to give the decoder the maximum
1187 * information possible for decoding.
3217cb42
PI
1188 *
1189 * The returned packet is valid
1190 * until the next av_read_frame() or until av_close_input_file() and
1191 * must be freed with av_free_packet. For video, the packet contains
1192 * exactly one frame. For audio, it contains an integer number of
1193 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1194 * data). If the audio frames have a variable size (e.g. MPEG audio),
1195 * then it contains one frame.
1196 *
1197 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1198 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1199 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1200 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1201 * decompress the payload.
1202 *
4f57fa8c 1203 * @return 0 if OK, < 0 on error or end of file
3217cb42 1204 */
fb2758c8 1205int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1206
1207/**
49bd8e4b 1208 * Seek to the keyframe at timestamp.
3217cb42
PI
1209 * 'timestamp' in 'stream_index'.
1210 * @param stream_index If stream_index is (-1), a default
1211 * stream is selected, and timestamp is automatically converted
1212 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1213 * @param timestamp Timestamp in AVStream.time_base units
1214 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1215 * @param flags flags which select direction and seeking mode
1216 * @return >= 0 on success
1217 */
78cb7273
DB
1218int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1219 int flags);
3217cb42
PI
1220
1221/**
49bd8e4b 1222 * Seek to timestamp ts.
d04768fa
MN
1223 * Seeking will be done so that the point from which all active streams
1224 * can be presented successfully will be closest to ts and within min/max_ts.
1225 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1226 *
22e77e44 1227 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1228 * are the file position (this may not be supported by all demuxers).
22e77e44 1229 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1230 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1231 * Otherwise all timestamps are in units of the stream selected by stream_index
1232 * or if stream_index is -1, in AV_TIME_BASE units.
1233 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1234 * keyframes (this may not be supported by all demuxers).
1235 *
22e77e44 1236 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1237 * @param min_ts smallest acceptable timestamp
1238 * @param ts target timestamp
1239 * @param max_ts largest acceptable timestamp
1240 * @param flags flags
32e543f8 1241 * @return >=0 on success, error code otherwise
998b6f7c 1242 *
8a4d7a30 1243 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1244 * Thus do not use this yet. It may change at any time, do not expect
1245 * ABI compatibility yet!
d04768fa
MN
1246 */
1247int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1248
1249/**
49bd8e4b 1250 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1251 * current position.
3217cb42 1252 */
fb2758c8 1253int av_read_play(AVFormatContext *s);
3217cb42
PI
1254
1255/**
49bd8e4b 1256 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1257 *
1258 * Use av_read_play() to resume it.
1259 */
fb2758c8 1260int av_read_pause(AVFormatContext *s);
3217cb42 1261
52660454 1262#if FF_API_CLOSE_INPUT_FILE
2506fd54 1263/**
52660454 1264 * @deprecated use avformat_close_input()
49bd8e4b 1265 * Close a media file (but not its codecs).
3217cb42
PI
1266 *
1267 * @param s media file handle
1268 */
52660454 1269attribute_deprecated
de6d9b64 1270void av_close_input_file(AVFormatContext *s);
52660454
AK
1271#endif
1272
1273/**
1274 * Close an opened input AVFormatContext. Free it and all its contents
1275 * and set *s to NULL.
1276 */
1277void avformat_close_input(AVFormatContext **s);
370f27de
AK
1278/**
1279 * @}
1280 */
3217cb42 1281
3ba1438d
MN
1282#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1283#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1284#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1285#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1286
3217cb42 1287/**
489a7b07
AK
1288 * @addtogroup lavf_encoding
1289 * @{
1290 */
f3bfe388 1291/**
25de5958
AK
1292 * Allocate the stream private data and write the stream header to
1293 * an output media file.
1294 *
1295 * @param s Media file handle, must be allocated with avformat_alloc_context().
1296 * Its oformat field must be set to the desired output format;
1297 * Its pb field must be set to an already openened AVIOContext.
1298 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1299 * On return this parameter will be destroyed and replaced with a dict containing
1300 * options that were not found. May be NULL.
1301 *
1302 * @return 0 on success, negative AVERROR on failure.
1303 *
1304 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1305 */
1306int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1307
3217cb42 1308/**
49bd8e4b 1309 * Write a packet to an output media file.
3217cb42
PI
1310 *
1311 * The packet shall contain one audio or video frame.
78cb7273
DB
1312 * The packet must be correctly interleaved according to the container
1313 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1314 *
1315 * @param s media file handle
78cb7273 1316 * @param pkt The packet, which contains the stream_index, buf/buf_size,
f1caf01d
MS
1317 * dts/pts, ...
1318 * This can be NULL (at any time, not just at the end), in
1319 * order to immediately flush data buffered within the muxer,
1320 * for muxers that buffer up data internally before writing it
1321 * to the output.
1322 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
3217cb42 1323 */
e928649b 1324int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1325
1326/**
49bd8e4b 1327 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1328 *
1329 * The packet must contain one audio or video frame.
22e77e44 1330 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1331 * call av_write_frame() instead as it is slightly faster. It is also important
1332 * to keep in mind that completely non-interleaved input will need huge amounts
1333 * of memory to interleave with this, so it is preferable to interleave at the
1334 * demuxer level.
3217cb42
PI
1335 *
1336 * @param s media file handle
f97cb451
AK
1337 * @param pkt The packet containing the data to be written. Libavformat takes
1338 * ownership of the data and will free it when it sees fit using the packet's
1339 * @ref AVPacket.destruct "destruct" field. The caller must not access the data
1340 * after this function returns, as it may already be freed.
1341 * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1342 * index of the corresponding stream in @ref AVFormatContext.streams
1343 * "s.streams".
1344 * It is very strongly recommended that timing information (@ref AVPacket.pts
1345 * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1346 * correct values.
1347 *
1348 * @return 0 on success, a negative AVERROR on error.
3217cb42 1349 */
3c895fc0 1350int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1351
1352/**
49bd8e4b 1353 * Interleave a packet per dts in an output media file.
3217cb42 1354 *
78cb7273 1355 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1356 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1357 * on them is still safe.
3217cb42
PI
1358 *
1359 * @param s media file handle
1360 * @param out the interleaved packet will be output here
9a58234f 1361 * @param pkt the input packet
3217cb42
PI
1362 * @param flush 1 if no further packets are available as input and all
1363 * remaining packets should be output
1364 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1365 * < 0 if an error occurred
3217cb42 1366 */
78cb7273
DB
1367int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1368 AVPacket *pkt, int flush);
e928649b 1369
3217cb42 1370/**
49bd8e4b 1371 * Write the stream trailer to an output media file and free the
2b75bde6 1372 * file private data.
3217cb42 1373 *
dc76fe13
RD
1374 * May only be called after a successful call to av_write_header.
1375 *
3217cb42 1376 * @param s media file handle
4f57fa8c 1377 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1378 */
b9a281db 1379int av_write_trailer(AVFormatContext *s);
c8dffc02
AK
1380
1381/**
1382 * Return the output format in the list of registered output formats
1383 * which best matches the provided parameters, or return NULL if
1384 * there is no match.
1385 *
1386 * @param short_name if non-NULL checks if short_name matches with the
1387 * names of the registered formats
1388 * @param filename if non-NULL checks if filename terminates with the
1389 * extensions of the registered formats
1390 * @param mime_type if non-NULL checks if mime_type matches with the
1391 * MIME type of the registered formats
1392 */
1393AVOutputFormat *av_guess_format(const char *short_name,
1394 const char *filename,
1395 const char *mime_type);
1396
1397/**
1398 * Guess the codec ID based upon muxer and filename.
1399 */
1400enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1401 const char *filename, const char *mime_type,
1402 enum AVMediaType type);
1403
489a7b07
AK
1404/**
1405 * @}
1406 */
de6d9b64 1407
abf2c2d7
AK
1408
1409/**
1410 * @defgroup lavf_misc Utility functions
1411 * @ingroup libavf
1412 * @{
1413 *
1414 * Miscelaneous utility functions related to both muxing and demuxing
1415 * (or neither).
1416 */
1417
1418/**
1419 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1420 *
1421 * @param f The file stream pointer where the dump should be sent to.
1422 * @param buf buffer
1423 * @param size buffer size
1424 *
1425 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1426 */
1427void av_hex_dump(FILE *f, uint8_t *buf, int size);
1428
1429/**
1430 * Send a nice hexadecimal dump of a buffer to the log.
1431 *
1432 * @param avcl A pointer to an arbitrary struct of which the first field is a
1433 * pointer to an AVClass struct.
1434 * @param level The importance level of the message, lower values signifying
1435 * higher importance.
1436 * @param buf buffer
1437 * @param size buffer size
1438 *
1439 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1440 */
1441void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1442
1443/**
1444 * Send a nice dump of a packet to the specified file stream.
1445 *
1446 * @param f The file stream pointer where the dump should be sent to.
1447 * @param pkt packet to dump
1448 * @param dump_payload True if the payload must be displayed, too.
1449 * @param st AVStream that the packet belongs to
1450 */
1451void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1452
1453
1454/**
1455 * Send a nice dump of a packet to the log.
1456 *
1457 * @param avcl A pointer to an arbitrary struct of which the first field is a
1458 * pointer to an AVClass struct.
1459 * @param level The importance level of the message, lower values signifying
1460 * higher importance.
1461 * @param pkt packet to dump
1462 * @param dump_payload True if the payload must be displayed, too.
1463 * @param st AVStream that the packet belongs to
1464 */
1465void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1466 AVStream *st);
1467
1468/**
1469 * Get the CodecID for the given codec tag tag.
1470 * If no codec id is found returns CODEC_ID_NONE.
1471 *
1472 * @param tags list of supported codec_id-codec_tag pairs, as stored
1473 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1474 */
1475enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1476
1477/**
1478 * Get the codec tag for the given codec id id.
1479 * If no codec tag is found returns 0.
1480 *
1481 * @param tags list of supported codec_id-codec_tag pairs, as stored
1482 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1483 */
1484unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1485
1486int av_find_default_stream_index(AVFormatContext *s);
1487
1488/**
1489 * Get the index for a specific timestamp.
1490 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1491 * to the timestamp which is <= the requested one, if backward
1492 * is 0, then it will be >=
1493 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1494 * @return < 0 if no such timestamp could be found
1495 */
1496int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1497
1498/**
1499 * Add an index entry into a sorted list. Update the entry if the list
1500 * already contains it.
1501 *
1502 * @param timestamp timestamp in the time base of the given stream
1503 */
1504int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1505 int size, int distance, int flags);
1506
1507
1508/**
1509 * Split a URL string into components.
1510 *
1511 * The pointers to buffers for storing individual components may be null,
1512 * in order to ignore that component. Buffers for components not found are
1513 * set to empty strings. If the port is not found, it is set to a negative
1514 * value.
1515 *
1516 * @param proto the buffer for the protocol
1517 * @param proto_size the size of the proto buffer
1518 * @param authorization the buffer for the authorization
1519 * @param authorization_size the size of the authorization buffer
1520 * @param hostname the buffer for the host name
1521 * @param hostname_size the size of the hostname buffer
1522 * @param port_ptr a pointer to store the port number in
1523 * @param path the buffer for the path
1524 * @param path_size the size of the path buffer
1525 * @param url the URL to split
1526 */
1527void av_url_split(char *proto, int proto_size,
1528 char *authorization, int authorization_size,
1529 char *hostname, int hostname_size,
1530 int *port_ptr,
1531 char *path, int path_size,
1532 const char *url);
1533
610219a5
AK
1534
1535void av_dump_format(AVFormatContext *ic,
1536 int index,
1537 const char *url,
1538 int is_output);
3217cb42 1539
76c56376
MN
1540/**
1541 * Get the current time in microseconds.
1542 */
0c1a9eda 1543int64_t av_gettime(void);
94988531 1544
3217cb42 1545/**
49bd8e4b 1546 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1547 *
3217cb42
PI
1548 * Also handles the '%0nd' format where 'n' is the total number
1549 * of digits and '%%'.
1550 *
1551 * @param buf destination buffer
1552 * @param buf_size destination buffer size
1553 * @param path numbered sequence string
8ea0e802 1554 * @param number frame number
4f57fa8c 1555 * @return 0 if OK, -1 on format error
3217cb42 1556 */
5c07cf53
MB
1557int av_get_frame_filename(char *buf, int buf_size,
1558 const char *path, int number);
3217cb42
PI
1559
1560/**
49bd8e4b 1561 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1562 *
1563 * @param filename possible numbered sequence string
4f57fa8c 1564 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1565 */
5c07cf53 1566int av_filename_number_test(const char *filename);
96baaa6a 1567
c5388c07 1568/**
49bd8e4b 1569 * Generate an SDP for an RTP session.
c5388c07
LA
1570 *
1571 * @param ac array of AVFormatContexts describing the RTP streams. If the
1572 * array is composed by only one context, such context can contain
1573 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1574 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1575 * must contain only one AVStream.
8767b80f 1576 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1577 * @param buf buffer where the SDP will be stored (must be allocated by
1578 * the caller)
8767b80f 1579 * @param size the size of the buffer
4f57fa8c 1580 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1581 */
c234d40b 1582int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe 1583
1a70d127 1584/**
49bd8e4b 1585 * Return a positive value if the given filename has one of the given
1a70d127
SS
1586 * extensions, 0 otherwise.
1587 *
1588 * @param extensions a comma-separated list of filename extensions
1589 */
1590int av_match_ext(const char *filename, const char *extensions);
1591
48f9e457
AK
1592/**
1593 * Test if the given container can store a codec.
1594 *
1595 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1596 *
1597 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1598 * A negative number if this information is not available.
1599 */
1600int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1601
abf2c2d7 1602/**
dd6d3b0e
AK
1603 * @defgroup riff_fourcc RIFF FourCCs
1604 * @{
1605 * Get the tables mapping RIFF FourCCs to libavcodec CodecIDs. The tables are
1606 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1607 * following code:
1608 * @code
1609 * uint32_t tag = MKTAG('H', '2', '6', '4');
1610 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
1611 * enum CodecID id = av_codec_get_id(table, tag);
1612 * @endcode
1613 */
1614/**
1615 * @return the table mapping RIFF FourCCs for video to libavcodec CodecID.
1616 */
1617const struct AVCodecTag *avformat_get_riff_video_tags(void);
1618/**
1619 * @return the table mapping RIFF FourCCs for audio to CodecID.
1620 */
1621const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1622/**
1623 * @}
1624 */
1625
1626/**
abf2c2d7
AK
1627 * @}
1628 */
1629
98790382 1630#endif /* AVFORMAT_AVFORMAT_H */