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