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