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