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