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