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