Give context to dprintf
[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 92
43d414ba
PI
93/**
94 * @warning This is a hack - the packet memory allocation stuff is broken. The
95 * packet is allocated if it was not really allocated
96 */
fb2758c8 97int av_dup_packet(AVPacket *pkt);
6fa5a56c
FB
98
99/**
100 * Free a packet
101 *
102 * @param pkt packet to free
103 */
104static inline void av_free_packet(AVPacket *pkt)
105{
342474ab 106 if (pkt && pkt->destruct) {
bb270c08 107 pkt->destruct(pkt);
342474ab 108 }
6fa5a56c 109}
de6d9b64
FB
110
111/*************************************************/
916c80e9
FB
112/* fractional numbers for exact pts handling */
113
114/* the exact value of the fractional number is: 'val + num / den'. num
115 is assumed to be such as 0 <= num < den */
116typedef struct AVFrac {
115329f1 117 int64_t val, num, den;
955ab9a4 118} AVFrac attribute_deprecated;
916c80e9 119
916c80e9 120/*************************************************/
b9a281db 121/* input/output formats */
de6d9b64 122
7caf0cc6
MN
123struct AVCodecTag;
124
de6d9b64 125struct AVFormatContext;
b9a281db 126
43d414ba 127/** this structure contains the data a format has to probe a file */
b9a281db 128typedef struct AVProbeData {
5c91a675 129 const char *filename;
b9a281db
FB
130 unsigned char *buf;
131 int buf_size;
132} AVProbeData;
133
0288a747 134#define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
de6d9b64
FB
135
136typedef struct AVFormatParameters {
c0df9d75 137 AVRational time_base;
de6d9b64
FB
138 int sample_rate;
139 int channels;
140 int width;
141 int height;
4606ac8d 142 enum PixelFormat pix_fmt;
43d414ba 143 int channel; /**< used to select dv channel */
cc58300e 144#if LIBAVFORMAT_VERSION_INT < (52<<16)
43d414ba 145 const char *device; /**< video, audio or DV device */
cc58300e 146#endif
43d414ba
PI
147 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
148 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
149 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
da24c5e3
FB
150 stream packet (only meaningful if
151 mpeg2ts_raw is TRUE */
43d414ba 152 int initial_pause:1; /**< do not begin to play the stream
fb2758c8 153 immediately (RTSP only) */
4eb72c6b 154 int prealloced_context:1;
5b6d5596
MN
155 enum CodecID video_codec_id;
156 enum CodecID audio_codec_id;
de6d9b64
FB
157} AVFormatParameters;
158
40d9c544
RD
159//! demuxer will use url_fopen, no opened file should be provided by the caller
160#define AVFMT_NOFILE 0x0001
43d414ba
PI
161#define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
162#define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
163#define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
fb025625 164 raw picture data */
43d414ba
PI
165#define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
166#define AVFMT_NOTIMESTAMPS 0x0080 /**< format doesnt need / has any timestamps */
167#define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
b9a281db
FB
168
169typedef struct AVOutputFormat {
de6d9b64
FB
170 const char *name;
171 const char *long_name;
172 const char *mime_type;
cf29452b 173 const char *extensions; /**< comma separated filename extensions */
43d414ba 174 /** size of private data so that it can be allocated in the wrapper */
b9a281db 175 int priv_data_size;
de6d9b64 176 /* output support */
43d414ba
PI
177 enum CodecID audio_codec; /**< default audio codec */
178 enum CodecID video_codec; /**< default video codec */
de6d9b64 179 int (*write_header)(struct AVFormatContext *);
e928649b 180 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 181 int (*write_trailer)(struct AVFormatContext *);
43d414ba 182 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
b9a281db 183 int flags;
43d414ba 184 /** currently only used to set pixel format if not YUV420P */
290c5fa6 185 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
fe2d6fe2 186 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
7caf0cc6
MN
187
188 /**
189 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
190 * the arrays are all CODEC_ID_NONE terminated
191 */
6c77805f 192 const struct AVCodecTag **codec_tag;
7caf0cc6 193
b9a281db
FB
194 /* private fields */
195 struct AVOutputFormat *next;
196} AVOutputFormat;
de6d9b64 197
b9a281db
FB
198typedef struct AVInputFormat {
199 const char *name;
200 const char *long_name;
43d414ba 201 /** size of private data so that it can be allocated in the wrapper */
b9a281db 202 int priv_data_size;
43d414ba 203 /** tell if a given file has a chance of being parsing by this format */
b9a281db 204 int (*read_probe)(AVProbeData *);
43d414ba 205 /** read the format header and initialize the AVFormatContext
de6d9b64 206 structure. Return 0 if OK. 'ap' if non NULL contains
b9a281db
FB
207 additionnal paramters. Only used in raw format right
208 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
209 int (*read_header)(struct AVFormatContext *,
210 AVFormatParameters *ap);
43d414ba 211 /** read one packet and put it in 'pkt'. pts and flags are also
b9a281db 212 set. 'av_new_stream' can be called only if the flag
da24c5e3 213 AVFMTCTX_NOHEADER is used. */
de6d9b64 214 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
43d414ba 215 /** close the stream. The AVFormatContext and AVStreams are not
de6d9b64
FB
216 freed by this function */
217 int (*read_close)(struct AVFormatContext *);
115329f1
DB
218 /**
219 * seek to a given timestamp relative to the frames in
3ba1438d
MN
220 * stream component stream_index
221 * @param stream_index must not be -1
115329f1 222 * @param flags selects which direction should be preferred if no exact
3ba1438d
MN
223 * match is available
224 */
115329f1 225 int (*read_seek)(struct AVFormatContext *,
3ba1438d 226 int stream_index, int64_t timestamp, int flags);
8d14a25c
MN
227 /**
228 * gets the next timestamp in AV_TIME_BASE units.
229 */
230 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
231 int64_t *pos, int64_t pos_limit);
43d414ba 232 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
de6d9b64 233 int flags;
43d414ba 234 /** if extensions are defined, then no probe is done. You should
b9a281db
FB
235 usually not use extension format guessing because it is not
236 reliable enough */
237 const char *extensions;
43d414ba 238 /** general purpose read only value that the format can use */
b9a281db 239 int value;
fb2758c8 240
43d414ba 241 /** start/resume playing - only meaningful if using a network based format
fb2758c8
FB
242 (RTSP) */
243 int (*read_play)(struct AVFormatContext *);
244
43d414ba 245 /** pause playing - only meaningful if using a network based format
fb2758c8
FB
246 (RTSP) */
247 int (*read_pause)(struct AVFormatContext *);
248
6c77805f 249 const struct AVCodecTag **codec_tag;
7caf0cc6 250
b9a281db
FB
251 /* private fields */
252 struct AVInputFormat *next;
253} AVInputFormat;
de6d9b64 254
fb2758c8
FB
255typedef struct AVIndexEntry {
256 int64_t pos;
257 int64_t timestamp;
258#define AVINDEX_KEYFRAME 0x0001
30a43f2d
MN
259 int flags:2;
260 int size:30; //yeah trying to keep the size of this small to reduce memory requirements (its 24 vs 32 byte due to possible 8byte align)
43d414ba 261 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
fb2758c8
FB
262} AVIndexEntry;
263
de6d9b64 264typedef struct AVStream {
43d414ba
PI
265 int index; /**< stream index in AVFormatContext */
266 int id; /**< format specific stream id */
267 AVCodecContext *codec; /**< codec context */
b4b87d48
MN
268 /**
269 * real base frame rate of the stream.
e3c97c3b
MN
270 * this is the lowest framerate with which all timestamps can be
271 * represented accurately (its the least common multiple of all
272 * framerates in the stream), Note, this value is just a guess!
115329f1 273 * for example if the timebase is 1/90000 and all frames have either
b4b87d48
MN
274 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
275 */
276 AVRational r_frame_rate;
de6d9b64 277 void *priv_data;
ea486ab3 278#if LIBAVFORMAT_VERSION_INT < (52<<16)
b9a281db 279 /* internal data used in av_find_stream_info() */
115329f1 280 int64_t codec_info_duration;
fb2758c8 281 int codec_info_nb_frames;
ea486ab3 282#endif
43d414ba 283 /** encoding: PTS generation when outputing stream */
1e51d801 284 AVFrac pts;
5b28c8c3
MN
285
286 /**
287 * this is the fundamental unit of time (in seconds) in terms
288 * of which frame timestamps are represented. for fixed-fps content,
289 * timebase should be 1/framerate and timestamp increments should be
290 * identically 1.
291 */
9ee91c2f 292 AVRational time_base;
43d414ba 293 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 294 /* ffmpeg.c private use */
15786dc4 295 int stream_copy; /**< if set, just copy stream */
f3356e9c 296 enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
b4aea108 297 //FIXME move stuff to a flags field?
43d414ba 298 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
1e491e29 299 * MN:dunno if thats the right place, for it */
115329f1 300 float quality;
43d414ba 301 /** decoding: position of the first frame of the component, in
ee404803 302 AV_TIME_BASE fractional seconds. */
115329f1 303 int64_t start_time;
43d414ba 304 /** decoding: duration of the stream, in AV_TIME_BASE fractional
ee404803
FB
305 seconds. */
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 */
7cbaa7ba 311 int need_parsing; ///< 1->full parsing needed, 2->only parse headers dont repack
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
PI
446/**
447 * Print nice hexa dump of a buffer
448 * @param f stream for output
449 * @param buf buffer
450 * @param size buffer size
451 */
fb2758c8 452void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
453
454/**
455 * Print on 'f' a nice dump of a packet
456 * @param f stream for output
457 * @param pkt packet to dump
458 * @param dump_payload true if the payload must be displayed too
459 */
fb2758c8 460void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 461
94988531 462void av_register_all(void);
de6d9b64 463
43d414ba 464/** codec tag <-> codec id */
6c77805f
MN
465enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
466unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
7caf0cc6 467
b9a281db 468/* media file input */
3217cb42
PI
469
470/**
471 * finds AVInputFormat based on input format's short name.
472 */
b9a281db 473AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
474
475/**
476 * Guess file format.
477 *
478 * @param is_opened whether the file is already opened, determines whether
479 * demuxers with or without AVFMT_NOFILE are probed
480 */
94988531 481AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
482
483/**
484 * Allocates all the structures needed to read an input stream.
485 * This does not open the needed codecs for decoding the stream[s].
486 */
115329f1
DB
487int av_open_input_stream(AVFormatContext **ic_ptr,
488 ByteIOContext *pb, const char *filename,
da24c5e3 489 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
490
491/**
492 * Open a media file as input. The codec are not opened. Only the file
493 * header (if present) is read.
494 *
495 * @param ic_ptr the opened media file handle is put here
496 * @param filename filename to open.
497 * @param fmt if non NULL, force the file format to use
498 * @param buf_size optional buffer size (zero if default is OK)
499 * @param ap additionnal parameters needed when opening the file (NULL if default)
500 * @return 0 if OK. AVERROR_xxx otherwise.
501 */
115329f1 502int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
503 AVInputFormat *fmt,
504 int buf_size,
505 AVFormatParameters *ap);
43d414ba 506/** no av_open for output, so applications will need this: */
bc874dae 507AVFormatContext *av_alloc_format_context(void);
b9a281db 508
3217cb42
PI
509/**
510 * Read packets of a media file to get stream information. This
511 * is useful for file formats with no headers such as MPEG. This
512 * function also computes the real frame rate in case of mpeg2 repeat
513 * frame mode.
514 * The logical file position is not changed by this function;
515 * examined packets may be buffered for later processing.
516 *
517 * @param ic media file handle
518 * @return >=0 if OK. AVERROR_xxx if error.
519 * @todo let user decide somehow what information is needed so we dont waste time geting stuff the user doesnt need
520 */
b9a281db 521int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
522
523/**
524 * Read a transport packet from a media file.
525 *
526 * This function is absolete and should never be used.
527 * Use av_read_frame() instead.
528 *
529 * @param s media file handle
530 * @param pkt is filled
531 * @return 0 if OK. AVERROR_xxx if error.
532 */
de6d9b64 533int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
534
535/**
536 * Return the next frame of a stream.
537 *
538 * The returned packet is valid
539 * until the next av_read_frame() or until av_close_input_file() and
540 * must be freed with av_free_packet. For video, the packet contains
541 * exactly one frame. For audio, it contains an integer number of
542 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
543 * data). If the audio frames have a variable size (e.g. MPEG audio),
544 * then it contains one frame.
545 *
546 * pkt->pts, pkt->dts and pkt->duration are always set to correct
a050f802 547 * values in AVStream.timebase units (and guessed if the format cannot
3217cb42
PI
548 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
549 * has B frames, so it is better to rely on pkt->dts if you do not
550 * decompress the payload.
551 *
552 * @return 0 if OK, < 0 if error or end of file.
553 */
fb2758c8 554int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
555
556/**
557 * Seek to the key frame at timestamp.
558 * 'timestamp' in 'stream_index'.
559 * @param stream_index If stream_index is (-1), a default
560 * stream is selected, and timestamp is automatically converted
561 * from AV_TIME_BASE units to the stream specific time_base.
562 * @param timestamp timestamp in AVStream.time_base units
563 * or if there is no stream specified then in AV_TIME_BASE units
564 * @param flags flags which select direction and seeking mode
565 * @return >= 0 on success
566 */
3ba1438d 567int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
3217cb42
PI
568
569/**
570 * start playing a network based stream (e.g. RTSP stream) at the
571 * current position
572 */
fb2758c8 573int av_read_play(AVFormatContext *s);
3217cb42
PI
574
575/**
576 * Pause a network based stream (e.g. RTSP stream).
577 *
578 * Use av_read_play() to resume it.
579 */
fb2758c8 580int av_read_pause(AVFormatContext *s);
3217cb42
PI
581
582/**
583 * Close a media file (but not its codecs).
584 *
585 * @param s media file handle
586 */
de6d9b64 587void av_close_input_file(AVFormatContext *s);
3217cb42
PI
588
589/**
590 * Add a new stream to a media file.
591 *
592 * Can only be called in the read_header() function. If the flag
593 * AVFMTCTX_NOHEADER is in the format context, then new streams
594 * can be added in read_packet too.
595 *
596 * @param s media file handle
597 * @param id file format dependent stream id
598 */
b9a281db 599AVStream *av_new_stream(AVFormatContext *s, int id);
3217cb42
PI
600
601/**
602 * Set the pts for a given stream.
603 *
604 * @param s stream
605 * @param pts_wrap_bits number of bits effectively used by the pts
606 * (used for wrap control, 33 is the value for MPEG)
607 * @param pts_num numerator to convert to seconds (MPEG: 1)
608 * @param pts_den denominator to convert to seconds (MPEG: 90000)
609 */
9ee91c2f 610void av_set_pts_info(AVStream *s, int pts_wrap_bits,
916c80e9 611 int pts_num, int pts_den);
de6d9b64 612
3ba1438d
MN
613#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
614#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
27a5fe5f 615#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
3ba1438d 616
b754978a 617int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
618
619/**
620 * Gets the index for a specific timestamp.
621 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
622 * the timestamp which is <= the requested one, if backward is 0
623 * then it will be >=
624 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
625 * @return < 0 if no such timestamp could be found
626 */
dc56fc38 627int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
628
629/**
630 * Add a index entry into a sorted list updateing if it is already there.
631 *
632 * @param timestamp timestamp in the timebase of the given stream
633 */
3e9245a9 634int av_add_index_entry(AVStream *st,
30a43f2d 635 int64_t pos, int64_t timestamp, int size, int distance, int flags);
3217cb42
PI
636
637/**
638 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
639 * this isnt supposed to be called directly by a user application, but by demuxers
640 * @param target_ts target timestamp in the time base of the given stream
641 * @param stream_index stream number
642 */
3ba1438d 643int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
3217cb42
PI
644
645/**
646 * Updates cur_dts of all streams based on given timestamp and AVStream.
647 *
648 * Stream ref_st unchanged, others set cur_dts in their native timebase
649 * only needed for timestamp wrapping or if (dts not set and pts!=dts)
650 * @param timestamp new dts expressed in time_base of param ref_st
651 * @param ref_st reference stream giving time_base of param timestamp
652 */
22ffac70 653void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
654
655/**
656 * Does a binary search using read_timestamp().
657 * this isnt supposed to be called directly by a user application, but by demuxers
658 * @param target_ts target timestamp in the time base of the given stream
659 * @param stream_index stream number
660 */
89ddd2a9 661int64_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 662
43d414ba 663/** media file output */
290c5fa6 664int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
665
666/**
667 * allocate the stream private data and write the stream header to an
668 * output media file
669 *
670 * @param s media file handle
671 * @return 0 if OK. AVERROR_xxx if error.
672 */
b9a281db 673int av_write_header(AVFormatContext *s);
3217cb42
PI
674
675/**
676 * Write a packet to an output media file.
677 *
678 * The packet shall contain one audio or video frame.
679 * The packet must be correctly interleaved according to the container specification,
680 * if not then av_interleaved_write_frame must be used
681 *
682 * @param s media file handle
683 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
684 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
685 */
e928649b 686int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
687
688/**
689 * Writes a packet to an output media file ensuring correct interleaving.
690 *
691 * The packet must contain one audio or video frame.
692 * If the packets are already correctly interleaved the application should
693 * call av_write_frame() instead as its slightly faster, its also important
694 * to keep in mind that completly non interleaved input will need huge amounts
695 * of memory to interleave with this, so its prefereable to interleave at the
696 * demuxer level
697 *
698 * @param s media file handle
699 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
700 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
701 */
3c895fc0 702int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
703
704/**
705 * Interleave a packet per DTS in an output media file.
706 *
707 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
708 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
709 *
710 * @param s media file handle
711 * @param out the interleaved packet will be output here
712 * @param in the input packet
713 * @param flush 1 if no further packets are available as input and all
714 * remaining packets should be output
715 * @return 1 if a packet was output, 0 if no packet could be output,
716 * < 0 if an error occured
717 */
f21c0b4c 718int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
e928649b 719
3217cb42
PI
720/**
721 * @brief Write the stream trailer to an output media file and
722 * free the file private data.
723 *
724 * @param s media file handle
725 * @return 0 if OK. AVERROR_xxx if error.
726 */
b9a281db 727int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
728
729void dump_format(AVFormatContext *ic,
115329f1 730 int index,
de6d9b64
FB
731 const char *url,
732 int is_output);
3217cb42
PI
733
734/**
735 * parses width and height out of string str.
736 */
de6d9b64 737int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
3217cb42
PI
738
739/**
740 * Converts frame rate from string to a fraction.
3217cb42 741 */
445f1b83 742int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
3217cb42
PI
743
744/**
745 * Converts date string to number of seconds since Jan 1st, 1970.
746 *
747 * @code
748 * Syntax:
749 * - If not a duration:
750 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
751 * Time is localtime unless Z is suffixed to the end. In this case GMT
752 * Return the date in micro seconds since 1970
753 *
754 * - If a duration:
755 * HH[:MM[:SS[.m...]]]
756 * S+[.m...]
757 * @endcode
758 */
0c1a9eda 759int64_t parse_date(const char *datestr, int duration);
de6d9b64 760
0c1a9eda 761int64_t av_gettime(void);
94988531 762
de6d9b64
FB
763/* ffm specific for ffserver */
764#define FFM_PACKET_SIZE 4096
765offset_t ffm_read_write_index(int fd);
766void ffm_write_write_index(int fd, offset_t pos);
767void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
768
3217cb42
PI
769/**
770 * Attempts to find a specific tag in a URL.
771 *
772 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
773 * Return 1 if found.
774 */
de6d9b64
FB
775int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
776
3217cb42
PI
777/**
778 * Returns in 'buf' the path with '%d' replaced by number.
779
780 * Also handles the '%0nd' format where 'n' is the total number
781 * of digits and '%%'.
782 *
783 * @param buf destination buffer
784 * @param buf_size destination buffer size
785 * @param path numbered sequence string
786 * @number frame number
787 * @return 0 if OK, -1 if format error.
788 */
5c07cf53
MB
789int av_get_frame_filename(char *buf, int buf_size,
790 const char *path, int number);
3217cb42
PI
791
792/**
793 * Check whether filename actually is a numbered sequence generator.
794 *
795 * @param filename possible numbered sequence string
796 * @return 1 if a valid numbered sequence string, 0 otherwise.
797 */
5c07cf53 798int av_filename_number_test(const char *filename);
96baaa6a 799
b9a281db
FB
800/* grab specific */
801int video_grab_init(void);
802int audio_init(void);
96baaa6a 803
86fd51fb
FB
804/* DV1394 */
805int dv1394_init(void);
f02be79d 806int dc1394_init(void);
fb025625
FB
807
808#ifdef HAVE_AV_CONFIG_H
f71869a4
FB
809
810#include "os_support.h"
811
fb025625
FB
812int strstart(const char *str, const char *val, const char **ptr);
813int stristart(const char *str, const char *val, const char **ptr);
814void pstrcpy(char *buf, int buf_size, const char *str);
815char *pstrcat(char *buf, int buf_size, const char *s);
fb025625 816
39f472c3
FB
817void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
818
e4e70d2e 819#ifdef __GNUC__
39f472c3
FB
820#define dynarray_add(tab, nb_ptr, elem)\
821do {\
822 typeof(tab) _tab = (tab);\
823 typeof(elem) _elem = (elem);\
824 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
825 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
826} while(0)
e4e70d2e
FH
827#else
828#define dynarray_add(tab, nb_ptr, elem)\
829do {\
830 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
831} while(0)
832#endif
39f472c3 833
f71869a4 834time_t mktimegm(struct tm *tm);
0c9fc6e1 835struct tm *brktimegm(time_t secs, struct tm *tm);
115329f1 836const char *small_strptime(const char *p, const char *fmt,
f71869a4
FB
837 struct tm *dt);
838
fb025625
FB
839struct in_addr;
840int resolve_host(struct in_addr *sin_addr, const char *hostname);
841
842void url_split(char *proto, int proto_size,
6ba5cbc6 843 char *authorization, int authorization_size,
fb025625
FB
844 char *hostname, int hostname_size,
845 int *port_ptr,
846 char *path, int path_size,
847 const char *url);
848
a941f391
FB
849int match_ext(const char *filename, const char *extensions);
850
fb025625
FB
851#endif /* HAVE_AV_CONFIG_H */
852
02d697aa
ZK
853#ifdef __cplusplus
854}
855#endif
856
fb025625 857#endif /* AVFORMAT_H */
f3356e9c 858