Update copyright and text
[libav.git] / libavformat / avformat.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg 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 *
b78e7197 11 * FFmpeg 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
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
5b21bdab
DB
21#ifndef FFMPEG_AVFORMAT_H
22#define FFMPEG_AVFORMAT_H
de6d9b64 23
800c289a 24#define LIBAVFORMAT_VERSION_MAJOR 52
3a027f5e 25#define LIBAVFORMAT_VERSION_MINOR 13
800c289a 26#define LIBAVFORMAT_VERSION_MICRO 0
e97ac1e6 27
800c289a
MR
28#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29 LIBAVFORMAT_VERSION_MINOR, \
30 LIBAVFORMAT_VERSION_MICRO)
31#define LIBAVFORMAT_VERSION AV_VERSION(LIBAVFORMAT_VERSION_MAJOR, \
32 LIBAVFORMAT_VERSION_MINOR, \
33 LIBAVFORMAT_VERSION_MICRO)
5aa083ee 34#define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
8026c3b5 35
5aa083ee 36#define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
4b1f4f23 37
f71869a4 38#include <time.h>
67070e4f 39#include <stdio.h> /* FILE */
76a448ed 40#include "libavcodec/avcodec.h"
de6d9b64 41
de6d9b64
FB
42#include "avio.h"
43
44/* packet functions */
45
46typedef struct AVPacket {
2692067a
MN
47 int64_t pts; ///< presentation time stamp in time_base units
48 int64_t dts; ///< decompression time stamp in time_base units
0c1a9eda 49 uint8_t *data;
6fa5a56c
FB
50 int size;
51 int stream_index;
52 int flags;
2692067a 53 int duration; ///< presentation duration in time_base units (0 if not available)
6fa5a56c
FB
54 void (*destruct)(struct AVPacket *);
55 void *priv;
2692067a 56 int64_t pos; ///< byte position in stream, -1 if unknown
115329f1 57} AVPacket;
6fa5a56c
FB
58#define PKT_FLAG_KEY 0x0001
59
63dd1377 60void av_destruct_packet_nofree(AVPacket *pkt);
3217cb42
PI
61
62/**
63 * Default packet destructor.
64 */
90ad92b3 65void av_destruct_packet(AVPacket *pkt);
63dd1377 66
05abfce9
RP
67/**
68 * Initialize optional fields of a packet to default values.
69 *
70 * @param pkt packet
71 */
659596f0 72void av_init_packet(AVPacket *pkt);
de6d9b64 73
3217cb42 74/**
ac3967c1 75 * Allocate the payload of a packet and initialize its fields to default values.
3217cb42
PI
76 *
77 * @param pkt packet
78 * @param size wanted payload size
79 * @return 0 if OK. AVERROR_xxx otherwise.
80 */
de6d9b64 81int av_new_packet(AVPacket *pkt, int size);
3217cb42
PI
82
83/**
ac3967c1 84 * Allocate and read the payload of a packet and initialize its fields to default values.
3217cb42
PI
85 *
86 * @param pkt packet
87 * @param size wanted payload size
88 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
89 */
2692067a 90int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
3217cb42 91
43d414ba
PI
92/**
93 * @warning This is a hack - the packet memory allocation stuff is broken. The
94 * packet is allocated if it was not really allocated
95 */
fb2758c8 96int av_dup_packet(AVPacket *pkt);
6fa5a56c
FB
97
98/**
99 * Free a packet
100 *
101 * @param pkt packet to free
102 */
103static inline void av_free_packet(AVPacket *pkt)
104{
342474ab 105 if (pkt && pkt->destruct) {
bb270c08 106 pkt->destruct(pkt);
342474ab 107 }
6fa5a56c 108}
de6d9b64
FB
109
110/*************************************************/
916c80e9
FB
111/* fractional numbers for exact pts handling */
112
671adb17
MC
113/**
114 * the exact value of the fractional number is: 'val + num / den'.
115 * num is assumed to be such as 0 <= num < den
116 * @deprecated Use AVRational instead
117*/
916c80e9 118typedef struct AVFrac {
115329f1 119 int64_t val, num, den;
955ab9a4 120} AVFrac attribute_deprecated;
916c80e9 121
916c80e9 122/*************************************************/
b9a281db 123/* input/output formats */
de6d9b64 124
7caf0cc6
MN
125struct AVCodecTag;
126
de6d9b64 127struct AVFormatContext;
b9a281db 128
43d414ba 129/** this structure contains the data a format has to probe a file */
b9a281db 130typedef struct AVProbeData {
5c91a675 131 const char *filename;
b9a281db
FB
132 unsigned char *buf;
133 int buf_size;
134} AVProbeData;
135
0288a747 136#define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
87e87886 137#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
138
139typedef struct AVFormatParameters {
c0df9d75 140 AVRational time_base;
de6d9b64
FB
141 int sample_rate;
142 int channels;
143 int width;
144 int height;
4606ac8d 145 enum PixelFormat pix_fmt;
43d414ba 146 int channel; /**< used to select dv channel */
43d414ba
PI
147 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
148 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
149 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
da24c5e3 150 stream packet (only meaningful if
864ff8c1 151 mpeg2ts_raw is TRUE) */
43d414ba 152 int initial_pause:1; /**< do not begin to play the stream
fb2758c8 153 immediately (RTSP only) */
4eb72c6b 154 int prealloced_context:1;
71957315 155#if LIBAVFORMAT_VERSION_INT < (53<<16)
5b6d5596
MN
156 enum CodecID video_codec_id;
157 enum CodecID audio_codec_id;
71957315 158#endif
de6d9b64
FB
159} AVFormatParameters;
160
40d9c544
RD
161//! demuxer will use url_fopen, no opened file should be provided by the caller
162#define AVFMT_NOFILE 0x0001
43d414ba
PI
163#define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
164#define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
165#define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
fb025625 166 raw picture data */
43d414ba 167#define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
755bfeab 168#define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
43d414ba 169#define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
b9a281db
FB
170
171typedef struct AVOutputFormat {
de6d9b64
FB
172 const char *name;
173 const char *long_name;
174 const char *mime_type;
cf29452b 175 const char *extensions; /**< comma separated filename extensions */
43d414ba 176 /** size of private data so that it can be allocated in the wrapper */
b9a281db 177 int priv_data_size;
de6d9b64 178 /* output support */
43d414ba
PI
179 enum CodecID audio_codec; /**< default audio codec */
180 enum CodecID video_codec; /**< default video codec */
de6d9b64 181 int (*write_header)(struct AVFormatContext *);
e928649b 182 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 183 int (*write_trailer)(struct AVFormatContext *);
43d414ba 184 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
b9a281db 185 int flags;
43d414ba 186 /** currently only used to set pixel format if not YUV420P */
290c5fa6 187 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
fe2d6fe2 188 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
7caf0cc6
MN
189
190 /**
191 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
192 * the arrays are all CODEC_ID_NONE terminated
193 */
6c77805f 194 const struct AVCodecTag **codec_tag;
7caf0cc6 195
11bf3847
AJ
196 enum CodecID subtitle_codec; /**< default subtitle codec */
197
b9a281db
FB
198 /* private fields */
199 struct AVOutputFormat *next;
200} AVOutputFormat;
de6d9b64 201
b9a281db
FB
202typedef struct AVInputFormat {
203 const char *name;
204 const char *long_name;
43d414ba 205 /** size of private data so that it can be allocated in the wrapper */
b9a281db 206 int priv_data_size;
65d7d68b 207 /**
5d81d641
DB
208 * Tell if a given file has a chance of being parsed by this format.
209 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
210 * big so you do not have to check for that unless you need more.
65d7d68b 211 */
b9a281db 212 int (*read_probe)(AVProbeData *);
43d414ba 213 /** read the format header and initialize the AVFormatContext
de6d9b64 214 structure. Return 0 if OK. 'ap' if non NULL contains
e42dba48 215 additional paramters. Only used in raw format right
b9a281db 216 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
217 int (*read_header)(struct AVFormatContext *,
218 AVFormatParameters *ap);
43d414ba 219 /** read one packet and put it in 'pkt'. pts and flags are also
b9a281db 220 set. 'av_new_stream' can be called only if the flag
da24c5e3 221 AVFMTCTX_NOHEADER is used. */
de6d9b64 222 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
43d414ba 223 /** close the stream. The AVFormatContext and AVStreams are not
de6d9b64
FB
224 freed by this function */
225 int (*read_close)(struct AVFormatContext *);
115329f1
DB
226 /**
227 * seek to a given timestamp relative to the frames in
3ba1438d
MN
228 * stream component stream_index
229 * @param stream_index must not be -1
115329f1 230 * @param flags selects which direction should be preferred if no exact
3ba1438d 231 * match is available
05ce0f11 232 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 233 */
115329f1 234 int (*read_seek)(struct AVFormatContext *,
3ba1438d 235 int stream_index, int64_t timestamp, int flags);
8d14a25c 236 /**
2576a9ec 237 * gets the next timestamp in stream[stream_index].time_base units.
d9526386 238 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
239 */
240 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
241 int64_t *pos, int64_t pos_limit);
43d414ba 242 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
de6d9b64 243 int flags;
43d414ba 244 /** if extensions are defined, then no probe is done. You should
b9a281db
FB
245 usually not use extension format guessing because it is not
246 reliable enough */
247 const char *extensions;
43d414ba 248 /** general purpose read only value that the format can use */
b9a281db 249 int value;
fb2758c8 250
43d414ba 251 /** start/resume playing - only meaningful if using a network based format
fb2758c8
FB
252 (RTSP) */
253 int (*read_play)(struct AVFormatContext *);
254
43d414ba 255 /** pause playing - only meaningful if using a network based format
fb2758c8
FB
256 (RTSP) */
257 int (*read_pause)(struct AVFormatContext *);
258
6c77805f 259 const struct AVCodecTag **codec_tag;
7caf0cc6 260
b9a281db
FB
261 /* private fields */
262 struct AVInputFormat *next;
263} AVInputFormat;
de6d9b64 264
57004ff1
AJ
265enum AVStreamParseType {
266 AVSTREAM_PARSE_NONE,
267 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
268 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
269 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
270};
271
fb2758c8
FB
272typedef struct AVIndexEntry {
273 int64_t pos;
274 int64_t timestamp;
275#define AVINDEX_KEYFRAME 0x0001
30a43f2d 276 int flags:2;
90b5b51e 277 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
43d414ba 278 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
fb2758c8
FB
279} AVIndexEntry;
280
90c2295b
ES
281#define AV_DISPOSITION_DEFAULT 0x0001
282#define AV_DISPOSITION_DUB 0x0002
283#define AV_DISPOSITION_ORIGINAL 0x0004
284#define AV_DISPOSITION_COMMENT 0x0008
285#define AV_DISPOSITION_LYRICS 0x0010
286#define AV_DISPOSITION_KARAOKE 0x0020
287
ba66ae94
MN
288/**
289 * Stream structure.
290 * New fields can be added to the end with minor version bumps.
8bfb108b 291 * Removal, reordering and changes to existing fields require a major
ba66ae94 292 * version bump.
8bfb108b 293 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 294 */
de6d9b64 295typedef struct AVStream {
43d414ba
PI
296 int index; /**< stream index in AVFormatContext */
297 int id; /**< format specific stream id */
298 AVCodecContext *codec; /**< codec context */
b4b87d48 299 /**
8bfb108b
DB
300 * Real base frame rate of the stream.
301 * This is the lowest frame rate with which all timestamps can be
864ff8c1 302 * represented accurately (it is the least common multiple of all
8bfb108b
DB
303 * frame rates in the stream), Note, this value is just a guess!
304 * For example if the timebase is 1/90000 and all frames have either
305 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
b4b87d48
MN
306 */
307 AVRational r_frame_rate;
de6d9b64 308 void *priv_data;
82583548 309
b9a281db 310 /* internal data used in av_find_stream_info() */
82583548 311 int64_t first_dts;
43d414ba 312 /** encoding: PTS generation when outputing stream */
a9fd2b19 313 struct AVFrac pts;
5b28c8c3
MN
314
315 /**
8bfb108b
DB
316 * This is the fundamental unit of time (in seconds) in terms
317 * of which frame timestamps are represented. For fixed-fps content,
318 * timebase should be 1/frame rate and timestamp increments should be
5b28c8c3
MN
319 * identically 1.
320 */
9ee91c2f 321 AVRational time_base;
43d414ba 322 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 323 /* ffmpeg.c private use */
15786dc4 324 int stream_copy; /**< if set, just copy stream */
755bfeab 325 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
b4aea108 326 //FIXME move stuff to a flags field?
43d414ba 327 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
755bfeab 328 * MN: dunno if that is the right place for it */
115329f1 329 float quality;
6d96a9b9 330 /**
8bfb108b
DB
331 * Decoding: pts of the first frame of the stream, in stream time base.
332 * Only set this if you are absolutely 100% sure that the value you set
333 * it to really is the pts of the first frame.
4854c253 334 * This may be undefined (AV_NOPTS_VALUE).
8bfb108b
DB
335 * @note The ASF header does NOT contain a correct start_time the ASF
336 * demuxer must NOT set this.
6d96a9b9 337 */
115329f1 338 int64_t start_time;
e26381b6 339 /**
8bfb108b 340 * Decoding: duration of the stream, in stream time base.
e26381b6
NB
341 * If a source file does not specify a duration, but does specify
342 * a bitrate, this value will be estimates from bit rate and file size.
343 */
ee404803 344 int64_t duration;
fb2758c8 345
43d414ba 346 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
09730260 347
fb2758c8 348 /* av_read_frame() support */
57004ff1 349 enum AVStreamParseType need_parsing;
fb2758c8 350 struct AVCodecParserContext *parser;
6ec87caa 351
fb2758c8 352 int64_t cur_dts;
635fbcb1
MN
353 int last_IP_duration;
354 int64_t last_IP_pts;
fb2758c8 355 /* av_seek_frame() support */
43d414ba 356 AVIndexEntry *index_entries; /**< only used if the format does not
fb2758c8
FB
357 support seeking natively */
358 int nb_index_entries;
191e8ca7 359 unsigned int index_entries_allocated_size;
115329f1 360
b4b87d48 361 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036
MN
362
363#define MAX_REORDER_DELAY 4
364 int64_t pts_buffer[MAX_REORDER_DELAY+1];
f8d7c9d3
ES
365
366 char *filename; /**< source filename of the stream */
90c2295b
ES
367
368 int disposition; /**< AV_DISPOSITION_* bitfield */
de6d9b64
FB
369} AVStream;
370
15afa396
NS
371#define AV_PROGRAM_RUNNING 1
372
ba66ae94 373/**
ba66ae94 374 * New fields can be added to the end with minor version bumps.
8bfb108b 375 * Removal, reordering and changes to existing fields require a major
ba66ae94 376 * version bump.
8bfb108b 377 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 378 */
15afa396
NS
379typedef struct AVProgram {
380 int id;
381 char *provider_name; ///< Network name for DVB streams
382 char *name; ///< Service name for DVB streams
383 int flags;
384 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
385 unsigned int *stream_index;
386 unsigned int nb_stream_indexes;
15afa396
NS
387} AVProgram;
388
43d414ba 389#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
390 (streams are added dynamically) */
391
de6d9b64
FB
392#define MAX_STREAMS 20
393
252f17e2
MN
394/**
395 * format I/O context.
396 * New fields can be added to the end with minor version bumps.
8bfb108b 397 * Removal, reordering and changes to existing fields require a major
252f17e2 398 * version bump.
8bfb108b 399 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 400 */
de6d9b64 401typedef struct AVFormatContext {
43d414ba 402 const AVClass *av_class; /**< set by av_alloc_format_context */
b9a281db
FB
403 /* can only be iformat or oformat, not both at the same time */
404 struct AVInputFormat *iformat;
405 struct AVOutputFormat *oformat;
de6d9b64 406 void *priv_data;
899681cd 407 ByteIOContext *pb;
db69c2e5 408 unsigned int nb_streams;
de6d9b64 409 AVStream *streams[MAX_STREAMS];
43d414ba 410 char filename[1024]; /**< input or output filename */
de6d9b64 411 /* stream info */
4568325a 412 int64_t timestamp;
de6d9b64
FB
413 char title[512];
414 char author[512];
415 char copyright[512];
416 char comment[512];
6a58e151 417 char album[512];
43d414ba
PI
418 int year; /**< ID3 year, 0 if none */
419 int track; /**< track number, 0 if none */
420 char genre[32]; /**< ID3 genre */
6a58e151 421
43d414ba 422 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
916c80e9 423 /* private data for pts handling (do not modify directly) */
43d414ba 424 /** This buffer is only needed when packets were already buffered but
de6d9b64
FB
425 not decoded, for example to get the codec parameters in mpeg
426 streams */
ee404803
FB
427 struct AVPacketList *packet_buffer;
428
43d414ba 429 /** decoding: position of the first frame of the component, in
ee404803
FB
430 AV_TIME_BASE fractional seconds. NEVER set this value directly:
431 it is deduced from the AVStream values. */
115329f1 432 int64_t start_time;
43d414ba 433 /** decoding: duration of the stream, in AV_TIME_BASE fractional
ee404803
FB
434 seconds. NEVER set this value directly: it is deduced from the
435 AVStream values. */
436 int64_t duration;
43d414ba 437 /** decoding: total file size. 0 if unknown */
ee404803 438 int64_t file_size;
43d414ba 439 /** decoding: total stream bitrate in bit/s, 0 if not
ee404803
FB
440 available. Never set it directly if the file_size and the
441 duration are known as ffmpeg can compute it automatically. */
442 int bit_rate;
fb2758c8
FB
443
444 /* av_read_frame() support */
445 AVStream *cur_st;
446 const uint8_t *cur_ptr;
447 int cur_len;
448 AVPacket cur_pkt;
449
fb2758c8 450 /* av_seek_frame() support */
43d414ba 451 int64_t data_offset; /** offset of the first packet */
fb2758c8 452 int index_built;
115329f1 453
2db3c638
MN
454 int mux_rate;
455 int packet_size;
17c88cb0
MN
456 int preload;
457 int max_delay;
8108551a 458
115329f1
DB
459#define AVFMT_NOOUTPUTLOOP -1
460#define AVFMT_INFINITEOUTPUTLOOP 0
43d414ba 461 /** number of times to loop output in formats that support it */
8108551a 462 int loop_output;
115329f1 463
30bc6613
MN
464 int flags;
465#define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
2c00106c 466#define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
bf09c2e2 467#define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
5894e1bb
VP
468
469 int loop_input;
43d414ba 470 /** decoding: size of data to probe; encoding unused */
9e6c9470 471 unsigned int probesize;
a44b3c4d
MN
472
473 /**
474 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
475 */
476 int max_analyze_duration;
c964c2c7
RD
477
478 const uint8_t *key;
479 int keylen;
15afa396
NS
480
481 unsigned int nb_programs;
482 AVProgram **programs;
62600469
MN
483
484 /**
485 * Forced video codec_id.
486 * demuxing: set by user
487 */
488 enum CodecID video_codec_id;
489 /**
490 * Forced audio codec_id.
491 * demuxing: set by user
492 */
493 enum CodecID audio_codec_id;
494 /**
495 * Forced subtitle codec_id.
496 * demuxing: set by user
497 */
498 enum CodecID subtitle_codec_id;
3dea63bd
PK
499
500 /**
501 * Maximum amount of memory in bytes to use per stream for the index.
502 * If the needed index exceeds this size entries will be discarded as
503 * needed to maintain a smaller size. This can lead to slower or less
504 * accurate seeking (depends on demuxer).
505 * Demuxers for which a full in memory index is mandatory will ignore
506 * this.
507 * muxing : unused
508 * demuxing: set by user
509 */
510 unsigned int max_index_size;
ab8ab30c
RP
511
512 /**
ffa71b2b 513 * Maximum amount of memory in bytes to use for buffering frames
ab8ab30c
RP
514 * obtained from real-time capture devices.
515 */
516 unsigned int max_picture_buffer;
de6d9b64
FB
517} AVFormatContext;
518
519typedef struct AVPacketList {
520 AVPacket pkt;
521 struct AVPacketList *next;
522} AVPacketList;
523
84be6e72 524#if LIBAVFORMAT_VERSION_INT < (53<<16)
b9a281db
FB
525extern AVInputFormat *first_iformat;
526extern AVOutputFormat *first_oformat;
84be6e72
MN
527#endif
528
529AVInputFormat *av_iformat_next(AVInputFormat *f);
530AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 531
5b6d5596 532enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 533
b9a281db
FB
534/* XXX: use automatic init with either ELF sections or C file parser */
535/* modules */
de6d9b64 536
b9a281db 537/* utils.c */
b9a281db
FB
538void av_register_input_format(AVInputFormat *format);
539void av_register_output_format(AVOutputFormat *format);
115329f1 540AVOutputFormat *guess_stream_format(const char *short_name,
36ada60c 541 const char *filename, const char *mime_type);
115329f1 542AVOutputFormat *guess_format(const char *short_name,
b9a281db 543 const char *filename, const char *mime_type);
3217cb42
PI
544
545/**
546 * Guesses the codec id based upon muxer and filename.
547 */
115329f1 548enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
5b6d5596 549 const char *filename, const char *mime_type, enum CodecType type);
de6d9b64 550
3217cb42 551/**
750f0e1f
PI
552 * Send a nice hexadecimal dump of a buffer to the specified file stream.
553 *
554 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
555 * @param buf buffer
556 * @param size buffer size
750f0e1f
PI
557 *
558 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 559 */
fb2758c8 560void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
561
562/**
750f0e1f
PI
563 * Send a nice hexadecimal dump of a buffer to the log.
564 *
565 * @param avcl A pointer to an arbitrary struct of which the first field is a
566 * pointer to an AVClass struct.
567 * @param level The importance level of the message, lower values signifying
568 * higher importance.
569 * @param buf buffer
570 * @param size buffer size
571 *
572 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
573 */
574void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
575
576/**
577 * Send a nice dump of a packet to the specified file stream.
578 *
579 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
580 * @param pkt packet to dump
581 * @param dump_payload true if the payload must be displayed too
582 */
fb2758c8 583void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 584
750f0e1f
PI
585/**
586 * Send a nice dump of a packet to the log.
587 *
588 * @param avcl A pointer to an arbitrary struct of which the first field is a
589 * pointer to an AVClass struct.
590 * @param level The importance level of the message, lower values signifying
591 * higher importance.
592 * @param pkt packet to dump
593 * @param dump_payload true if the payload must be displayed too
594 */
595void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
596
94988531 597void av_register_all(void);
de6d9b64 598
43d414ba 599/** codec tag <-> codec id */
6c77805f
MN
600enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
601unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
7caf0cc6 602
b9a281db 603/* media file input */
3217cb42
PI
604
605/**
606 * finds AVInputFormat based on input format's short name.
607 */
b9a281db 608AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
609
610/**
611 * Guess file format.
612 *
613 * @param is_opened whether the file is already opened, determines whether
614 * demuxers with or without AVFMT_NOFILE are probed
615 */
94988531 616AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
617
618/**
619 * Allocates all the structures needed to read an input stream.
620 * This does not open the needed codecs for decoding the stream[s].
621 */
115329f1
DB
622int av_open_input_stream(AVFormatContext **ic_ptr,
623 ByteIOContext *pb, const char *filename,
da24c5e3 624 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
625
626/**
864ff8c1 627 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
628 * header (if present) is read.
629 *
630 * @param ic_ptr the opened media file handle is put here
631 * @param filename filename to open.
632 * @param fmt if non NULL, force the file format to use
633 * @param buf_size optional buffer size (zero if default is OK)
e42dba48 634 * @param ap additional parameters needed when opening the file (NULL if default)
3217cb42
PI
635 * @return 0 if OK. AVERROR_xxx otherwise.
636 */
115329f1 637int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
638 AVInputFormat *fmt,
639 int buf_size,
640 AVFormatParameters *ap);
88808c60
MN
641/**
642 * Allocate an AVFormatContext.
5d81d641 643 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
644 * explicitly allocated as well!
645 */
bc874dae 646AVFormatContext *av_alloc_format_context(void);
b9a281db 647
3217cb42
PI
648/**
649 * Read packets of a media file to get stream information. This
650 * is useful for file formats with no headers such as MPEG. This
651 * function also computes the real frame rate in case of mpeg2 repeat
652 * frame mode.
653 * The logical file position is not changed by this function;
654 * examined packets may be buffered for later processing.
655 *
656 * @param ic media file handle
657 * @return >=0 if OK. AVERROR_xxx if error.
4e8988a3 658 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
3217cb42 659 */
b9a281db 660int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
661
662/**
663 * Read a transport packet from a media file.
664 *
864ff8c1 665 * This function is obsolete and should never be used.
3217cb42
PI
666 * Use av_read_frame() instead.
667 *
668 * @param s media file handle
669 * @param pkt is filled
670 * @return 0 if OK. AVERROR_xxx if error.
671 */
de6d9b64 672int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
673
674/**
675 * Return the next frame of a stream.
676 *
677 * The returned packet is valid
678 * until the next av_read_frame() or until av_close_input_file() and
679 * must be freed with av_free_packet. For video, the packet contains
680 * exactly one frame. For audio, it contains an integer number of
681 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
682 * data). If the audio frames have a variable size (e.g. MPEG audio),
683 * then it contains one frame.
684 *
685 * pkt->pts, pkt->dts and pkt->duration are always set to correct
a050f802 686 * values in AVStream.timebase units (and guessed if the format cannot
3217cb42
PI
687 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
688 * has B frames, so it is better to rely on pkt->dts if you do not
689 * decompress the payload.
690 *
691 * @return 0 if OK, < 0 if error or end of file.
692 */
fb2758c8 693int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
694
695/**
696 * Seek to the key frame at timestamp.
697 * 'timestamp' in 'stream_index'.
698 * @param stream_index If stream_index is (-1), a default
699 * stream is selected, and timestamp is automatically converted
700 * from AV_TIME_BASE units to the stream specific time_base.
701 * @param timestamp timestamp in AVStream.time_base units
702 * or if there is no stream specified then in AV_TIME_BASE units
703 * @param flags flags which select direction and seeking mode
704 * @return >= 0 on success
705 */
3ba1438d 706int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
3217cb42
PI
707
708/**
709 * start playing a network based stream (e.g. RTSP stream) at the
710 * current position
711 */
fb2758c8 712int av_read_play(AVFormatContext *s);
3217cb42
PI
713
714/**
715 * Pause a network based stream (e.g. RTSP stream).
716 *
717 * Use av_read_play() to resume it.
718 */
fb2758c8 719int av_read_pause(AVFormatContext *s);
3217cb42
PI
720
721/**
2506fd54
RD
722 * Free a AVFormatContext allocated by av_open_input_stream.
723 * @param s context to free
724 */
725void av_close_input_stream(AVFormatContext *s);
726
727/**
3217cb42
PI
728 * Close a media file (but not its codecs).
729 *
730 * @param s media file handle
731 */
de6d9b64 732void av_close_input_file(AVFormatContext *s);
3217cb42
PI
733
734/**
735 * Add a new stream to a media file.
736 *
737 * Can only be called in the read_header() function. If the flag
738 * AVFMTCTX_NOHEADER is in the format context, then new streams
739 * can be added in read_packet too.
740 *
741 * @param s media file handle
742 * @param id file format dependent stream id
743 */
b9a281db 744AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 745AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
746
747/**
748 * Set the pts for a given stream.
749 *
750 * @param s stream
751 * @param pts_wrap_bits number of bits effectively used by the pts
752 * (used for wrap control, 33 is the value for MPEG)
753 * @param pts_num numerator to convert to seconds (MPEG: 1)
754 * @param pts_den denominator to convert to seconds (MPEG: 90000)
755 */
9ee91c2f 756void av_set_pts_info(AVStream *s, int pts_wrap_bits,
916c80e9 757 int pts_num, int pts_den);
de6d9b64 758
3ba1438d
MN
759#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
760#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
27a5fe5f 761#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
3ba1438d 762
b754978a 763int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
764
765/**
766 * Gets the index for a specific timestamp.
767 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
768 * the timestamp which is <= the requested one, if backward is 0
769 * then it will be >=
770 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
771 * @return < 0 if no such timestamp could be found
772 */
dc56fc38 773int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
774
775/**
3dea63bd
PK
776 * Ensures the index uses less memory than the maximum specified in
777 * AVFormatContext.max_index_size, by discarding entries if it grows
778 * too large.
779 * This function is not part of the public API and should only be called
780 * by demuxers.
781 */
782void ff_reduce_index(AVFormatContext *s, int stream_index);
783
784/**
3217cb42
PI
785 * Add a index entry into a sorted list updateing if it is already there.
786 *
787 * @param timestamp timestamp in the timebase of the given stream
788 */
3e9245a9 789int av_add_index_entry(AVStream *st,
30a43f2d 790 int64_t pos, int64_t timestamp, int size, int distance, int flags);
3217cb42
PI
791
792/**
793 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
755bfeab 794 * This is not supposed to be called directly by a user application, but by demuxers.
3217cb42
PI
795 * @param target_ts target timestamp in the time base of the given stream
796 * @param stream_index stream number
797 */
3ba1438d 798int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
3217cb42
PI
799
800/**
801 * Updates cur_dts of all streams based on given timestamp and AVStream.
802 *
803 * Stream ref_st unchanged, others set cur_dts in their native timebase
755bfeab 804 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
805 * @param timestamp new dts expressed in time_base of param ref_st
806 * @param ref_st reference stream giving time_base of param timestamp
807 */
22ffac70 808void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
809
810/**
811 * Does a binary search using read_timestamp().
755bfeab 812 * This is not supposed to be called directly by a user application, but by demuxers.
3217cb42
PI
813 * @param target_ts target timestamp in the time base of the given stream
814 * @param stream_index stream number
815 */
89ddd2a9 816int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 817
43d414ba 818/** media file output */
290c5fa6 819int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
820
821/**
755bfeab
DB
822 * Allocate the stream private data and write the stream header to an
823 * output media file.
3217cb42
PI
824 *
825 * @param s media file handle
826 * @return 0 if OK. AVERROR_xxx if error.
827 */
b9a281db 828int av_write_header(AVFormatContext *s);
3217cb42
PI
829
830/**
831 * Write a packet to an output media file.
832 *
833 * The packet shall contain one audio or video frame.
834 * The packet must be correctly interleaved according to the container specification,
835 * if not then av_interleaved_write_frame must be used
836 *
837 * @param s media file handle
838 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
839 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
840 */
e928649b 841int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
842
843/**
844 * Writes a packet to an output media file ensuring correct interleaving.
845 *
846 * The packet must contain one audio or video frame.
847 * If the packets are already correctly interleaved the application should
90b5b51e
DB
848 * call av_write_frame() instead as it is slightly faster. It is also important
849 * to keep in mind that completely non-interleaved input will need huge amounts
850 * of memory to interleave with this, so it is preferable to interleave at the
851 * demuxer level.
3217cb42
PI
852 *
853 * @param s media file handle
854 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
855 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
856 */
3c895fc0 857int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
858
859/**
860 * Interleave a packet per DTS in an output media file.
861 *
862 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
863 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
864 *
865 * @param s media file handle
866 * @param out the interleaved packet will be output here
867 * @param in the input packet
868 * @param flush 1 if no further packets are available as input and all
869 * remaining packets should be output
870 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 871 * < 0 if an error occurred
3217cb42 872 */
f21c0b4c 873int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
e928649b 874
3217cb42
PI
875/**
876 * @brief Write the stream trailer to an output media file and
877 * free the file private data.
878 *
879 * @param s media file handle
880 * @return 0 if OK. AVERROR_xxx if error.
881 */
b9a281db 882int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
883
884void dump_format(AVFormatContext *ic,
115329f1 885 int index,
de6d9b64
FB
886 const char *url,
887 int is_output);
3217cb42
PI
888
889/**
890 * parses width and height out of string str.
26ef3220 891 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 892 */
26ef3220 893attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
3217cb42
PI
894
895/**
896 * Converts frame rate from string to a fraction.
26ef3220 897 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 898 */
26ef3220 899attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
3217cb42
PI
900
901/**
f9436161
SS
902 * Parses \p datestr and returns a corresponding number of microseconds.
903 * @param datestr String representing a date or a duration.
904 * - If a date the syntax is:
3217cb42 905 * @code
3217cb42 906 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
3217cb42 907 * @endcode
f9436161
SS
908 * Time is localtime unless Z is appended, in which case it is
909 * interpreted as UTC.
910 * If the year-month-day part isn't specified it takes the current
911 * year-month-day.
912 * Returns the number of microseconds since 1st of January, 1970 up to
913 * the time of the parsed date or INT64_MIN if \p datestr cannot be
914 * successfully parsed.
915 * - If a duration the syntax is:
916 * @code
917 * [-]HH[:MM[:SS[.m...]]]
918 * [-]S+[.m...]
919 * @endcode
920 * Returns the number of microseconds contained in a time interval
921 * with the specified duration or INT64_MIN if \p datestr cannot be
7338d368 922 * successfully parsed.
f9436161
SS
923 * @param duration Flag which tells how to interpret \p datestr, if
924 * not zero \p datestr is interpreted as a duration, otherwise as a
925 * date.
3217cb42 926 */
0c1a9eda 927int64_t parse_date(const char *datestr, int duration);
de6d9b64 928
0c1a9eda 929int64_t av_gettime(void);
94988531 930
de6d9b64
FB
931/* ffm specific for ffserver */
932#define FFM_PACKET_SIZE 4096
933offset_t ffm_read_write_index(int fd);
934void ffm_write_write_index(int fd, offset_t pos);
935void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
936
3217cb42
PI
937/**
938 * Attempts to find a specific tag in a URL.
939 *
940 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
941 * Return 1 if found.
942 */
de6d9b64
FB
943int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
944
3217cb42
PI
945/**
946 * Returns in 'buf' the path with '%d' replaced by number.
947
948 * Also handles the '%0nd' format where 'n' is the total number
949 * of digits and '%%'.
950 *
951 * @param buf destination buffer
952 * @param buf_size destination buffer size
953 * @param path numbered sequence string
8ea0e802 954 * @param number frame number
3217cb42
PI
955 * @return 0 if OK, -1 if format error.
956 */
5c07cf53
MB
957int av_get_frame_filename(char *buf, int buf_size,
958 const char *path, int number);
3217cb42
PI
959
960/**
961 * Check whether filename actually is a numbered sequence generator.
962 *
963 * @param filename possible numbered sequence string
964 * @return 1 if a valid numbered sequence string, 0 otherwise.
965 */
5c07cf53 966int av_filename_number_test(const char *filename);
96baaa6a 967
c5388c07
LA
968/**
969 * Generate an SDP for an RTP session.
970 *
971 * @param ac array of AVFormatContexts describing the RTP streams. If the
972 * array is composed by only one context, such context can contain
973 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
974 * all the contexts in the array (an AVCodecContext per RTP stream)
975 * must contain only one AVStream
8767b80f
LA
976 * @param n_files number of AVCodecContexts contained in ac
977 * @param buff buffer where the SDP will be stored (must be allocated by
978 * the caller
979 * @param size the size of the buffer
980 * @return 0 if OK. AVERROR_xxx if error.
c5388c07 981 */
8767b80f 982int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 983
fb025625 984#ifdef HAVE_AV_CONFIG_H
f71869a4 985
903a2e86 986void ff_dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
39f472c3 987
e4e70d2e 988#ifdef __GNUC__
39f472c3
FB
989#define dynarray_add(tab, nb_ptr, elem)\
990do {\
991 typeof(tab) _tab = (tab);\
992 typeof(elem) _elem = (elem);\
993 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
903a2e86 994 ff_dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
39f472c3 995} while(0)
e4e70d2e
FH
996#else
997#define dynarray_add(tab, nb_ptr, elem)\
998do {\
903a2e86 999 ff_dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
e4e70d2e
FH
1000} while(0)
1001#endif
39f472c3 1002
f71869a4 1003time_t mktimegm(struct tm *tm);
0c9fc6e1 1004struct tm *brktimegm(time_t secs, struct tm *tm);
115329f1 1005const char *small_strptime(const char *p, const char *fmt,
f71869a4
FB
1006 struct tm *dt);
1007
fb025625
FB
1008struct in_addr;
1009int resolve_host(struct in_addr *sin_addr, const char *hostname);
1010
1011void url_split(char *proto, int proto_size,
6ba5cbc6 1012 char *authorization, int authorization_size,
fb025625
FB
1013 char *hostname, int hostname_size,
1014 int *port_ptr,
1015 char *path, int path_size,
1016 const char *url);
1017
a941f391
FB
1018int match_ext(const char *filename, const char *extensions);
1019
fb025625
FB
1020#endif /* HAVE_AV_CONFIG_H */
1021
5b21bdab 1022#endif /* FFMPEG_AVFORMAT_H */