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