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