Replace some "m" constraints by MANGLE to avoid issues with some compilers not
[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
98790382
SS
21#ifndef AVFORMAT_AVFORMAT_H
22#define AVFORMAT_AVFORMAT_H
de6d9b64 23
800c289a 24#define LIBAVFORMAT_VERSION_MAJOR 52
148bcae9 25#define LIBAVFORMAT_VERSION_MINOR 59
0f943ce6 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
c97429e2 38/**
f2e77e4b
AC
39 * I return the LIBAVFORMAT_VERSION_INT constant. You got
40 * a fucking problem with that, douchebag?
c97429e2
SS
41 */
42unsigned avformat_version(void);
43
c1736936
DB
44/**
45 * Returns the libavformat build-time configuration.
46 */
41600690 47const char *avformat_configuration(void);
c1736936
DB
48
49/**
50 * Returns the libavformat license.
51 */
41600690 52const char *avformat_license(void);
c1736936 53
f71869a4 54#include <time.h>
67070e4f 55#include <stdio.h> /* FILE */
76a448ed 56#include "libavcodec/avcodec.h"
de6d9b64 57
de6d9b64
FB
58#include "avio.h"
59
f610a9f2
AJ
60struct AVFormatContext;
61
a6d18a0e
MN
62
63/*
ea29242c
MM
64 * Public Metadata API.
65 * The metadata API allows libavformat to export metadata tags to a client
61648423
AK
66 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
67 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
68 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
ea29242c
MM
69 * Important concepts to keep in mind:
70 * 1. Keys are unique; there can never be 2 tags with the same key. This is
71 * also meant semantically, i.e., a demuxer should not knowingly produce
72 * several keys that are literally different but semantically identical.
73 * E.g., key=Author5, key=Author6. In this example, all authors must be
74 * placed in the same tag.
75 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
76 * want to store, e.g., the email address of the child of producer Alice
77 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
ca76a119
AK
78 * 3. Several modifiers can be applied to the tag name. This is done by
79 * appending a dash character ('-') and the modifier name in the order
80 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
81 * a) language -- a tag whose value is localized for a particular language
82 * is appended with the ISO 639-2/B 3-letter language code.
83 * For example: Author-ger=Michael, Author-eng=Mike
84 * The original/default language is in the unqualified "Author" tag.
85 * A demuxer should set a default if it sets any translated tag.
86 * b) sorting -- a modified version of a tag that should be used for
87 * sorting will have '-sort' appended. E.g. artist="The Beatles",
88 * artist-sort="Beatles, The".
89 *
90 * 4. Tag names are normally exported exactly as stored in the container to
91 * allow lossless remuxing to the same format. For container-independent
92 * handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
93 * format. Follows a list of generic tag names:
94 *
95 * album -- name of the set this work belongs to
96 * album_artist -- main creator of the set/album, if different from artist.
97 * e.g. "Various Artists" for compilation albums.
98 * artist -- main creator of the work
99 * comment -- any additional description of the file.
100 * composer -- who composed the work, if different from artist.
101 * copyright -- name of copyright holder.
102 * date -- date when the work was created, preferably in ISO 8601.
103 * disc -- number of a subset, e.g. disc in a multi-disc collection.
104 * encoder -- name/settings of the software/hardware that produced the file.
105 * encoded_by -- person/group who created the file.
106 * filename -- original name of the file.
107 * genre -- <self-evident>.
108 * language -- main language in which the work is performed, preferably
109 * in ISO 639-2 format.
110 * performer -- artist who performed the work, if different from artist.
111 * E.g for "Also sprach Zarathustra", artist would be "Richard
112 * Strauss" and performer "London Philharmonic Orchestra".
113 * publisher -- name of the label/publisher.
114 * title -- name of the work.
115 * track -- number of this work in the set, can be in form current/total.
a6d18a0e
MN
116 */
117
48a81c0f 118#define AV_METADATA_MATCH_CASE 1
a6d18a0e 119#define AV_METADATA_IGNORE_SUFFIX 2
a181981e
MN
120#define AV_METADATA_DONT_STRDUP_KEY 4
121#define AV_METADATA_DONT_STRDUP_VAL 8
a6d18a0e
MN
122
123typedef struct {
124 char *key;
125 char *value;
bc1d2afb 126}AVMetadataTag;
a6d18a0e 127
e232c252 128typedef struct AVMetadata AVMetadata;
f610a9f2 129typedef struct AVMetadataConv AVMetadataConv;
a6d18a0e
MN
130
131/**
22e77e44
DB
132 * Gets a metadata element with matching key.
133 * @param prev Set to the previous matching element to find the next.
66b6c745 134 * If set to NULL the first matching element is returned.
22e77e44
DB
135 * @param flags Allows case as well as suffix-insensitive comparisons.
136 * @return Found tag or NULL, changing key or value leads to undefined behavior.
a6d18a0e 137 */
bc1d2afb 138AVMetadataTag *
e232c252 139av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
a6d18a0e 140
a181981e 141#if LIBAVFORMAT_VERSION_MAJOR == 52
a6d18a0e 142/**
22e77e44
DB
143 * Sets the given tag in m, overwriting an existing tag.
144 * @param key tag key to add to m (will be av_strduped)
145 * @param value tag value to add to m (will be av_strduped)
146 * @return >= 0 on success otherwise an error code <0
a6d18a0e 147 */
5ea7ce88 148int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
a181981e
MN
149#endif
150
151/**
152 * Sets the given tag in m, overwriting an existing tag.
153 * @param key tag key to add to m (will be av_strduped depending on flags)
154 * @param value tag value to add to m (will be av_strduped depending on flags)
155 * @return >= 0 on success otherwise an error code <0
156 */
157int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
a6d18a0e 158
094d9df7 159/**
d1b9adf2 160 * Converts all the metadata sets from ctx according to the source and
ca76a119
AK
161 * destination conversion tables. If one of the tables is NULL, then
162 * tags are converted to/from ffmpeg generic tag names.
f610a9f2
AJ
163 * @param d_conv destination tags format conversion table
164 * @param s_conv source tags format conversion table
165 */
166void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
167 const AVMetadataConv *s_conv);
168
169/**
22e77e44 170 * Frees all the memory allocated for an AVMetadata struct.
094d9df7
AJ
171 */
172void av_metadata_free(AVMetadata **m);
173
a6d18a0e 174
de6d9b64
FB
175/* packet functions */
176
3217cb42
PI
177
178/**
d1b9adf2
SS
179 * Allocates and reads the payload of a packet and initializes its
180 * fields with default values.
3217cb42
PI
181 *
182 * @param pkt packet
4f57fa8c
DB
183 * @param size desired payload size
184 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 185 */
2692067a 186int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
3217cb42 187
de6d9b64
FB
188
189/*************************************************/
916c80e9
FB
190/* fractional numbers for exact pts handling */
191
671adb17 192/**
4f57fa8c
DB
193 * The exact value of the fractional number is: 'val + num / den'.
194 * num is assumed to be 0 <= num < den.
4c08b2bd 195 */
916c80e9 196typedef struct AVFrac {
115329f1 197 int64_t val, num, den;
52e57500 198} AVFrac;
916c80e9 199
916c80e9 200/*************************************************/
b9a281db 201/* input/output formats */
de6d9b64 202
7caf0cc6
MN
203struct AVCodecTag;
204
4f57fa8c 205/** This structure contains the data a format has to probe a file. */
b9a281db 206typedef struct AVProbeData {
5c91a675 207 const char *filename;
e5f58f81 208 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
209 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
210} AVProbeData;
211
22e77e44 212#define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
87e87886 213#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
214
215typedef struct AVFormatParameters {
c0df9d75 216 AVRational time_base;
de6d9b64
FB
217 int sample_rate;
218 int channels;
219 int width;
220 int height;
4606ac8d 221 enum PixelFormat pix_fmt;
4f57fa8c
DB
222 int channel; /**< Used to select DV channel. */
223 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
224 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
225 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
72e043dd 226 stream packet (only meaningful if
4f57fa8c
DB
227 mpeg2ts_raw is TRUE). */
228 unsigned int initial_pause:1; /**< Do not begin to play the stream
229 immediately (RTSP only). */
72e043dd 230 unsigned int prealloced_context:1;
71957315 231#if LIBAVFORMAT_VERSION_INT < (53<<16)
5b6d5596
MN
232 enum CodecID video_codec_id;
233 enum CodecID audio_codec_id;
71957315 234#endif
de6d9b64
FB
235} AVFormatParameters;
236
4f57fa8c 237//! Demuxer will use url_fopen, no opened file should be provided by the caller.
40d9c544 238#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
239#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
240#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
241#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
242 raw picture data. */
243#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
244#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
245#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
246#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
25918212 247#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 248#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
b9a281db
FB
249
250typedef struct AVOutputFormat {
de6d9b64 251 const char *name;
bde15e74
SS
252 /**
253 * Descriptive name for the format, meant to be more human-readable
819174fa 254 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
255 * to define it.
256 */
de6d9b64
FB
257 const char *long_name;
258 const char *mime_type;
4f57fa8c 259 const char *extensions; /**< comma-separated filename extensions */
22e77e44 260 /** size of private data so that it can be allocated in the wrapper */
b9a281db 261 int priv_data_size;
de6d9b64 262 /* output support */
43d414ba
PI
263 enum CodecID audio_codec; /**< default audio codec */
264 enum CodecID video_codec; /**< default video codec */
de6d9b64 265 int (*write_header)(struct AVFormatContext *);
e928649b 266 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 267 int (*write_trailer)(struct AVFormatContext *);
43d414ba 268 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
b9a281db 269 int flags;
4f57fa8c 270 /** Currently only used to set pixel format if not YUV420P. */
290c5fa6 271 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
272 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
273 AVPacket *in, int flush);
7caf0cc6
MN
274
275 /**
78cb7273 276 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 277 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 278 */
c1854592 279 const struct AVCodecTag * const *codec_tag;
7caf0cc6 280
11bf3847
AJ
281 enum CodecID subtitle_codec; /**< default subtitle codec */
282
719e721a 283 const AVMetadataConv *metadata_conv;
f610a9f2 284
b9a281db
FB
285 /* private fields */
286 struct AVOutputFormat *next;
287} AVOutputFormat;
de6d9b64 288
b9a281db
FB
289typedef struct AVInputFormat {
290 const char *name;
bde15e74
SS
291 /**
292 * Descriptive name for the format, meant to be more human-readable
819174fa 293 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
294 * to define it.
295 */
b9a281db 296 const char *long_name;
4f57fa8c 297 /** Size of private data so that it can be allocated in the wrapper. */
b9a281db 298 int priv_data_size;
65d7d68b 299 /**
22e77e44 300 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
301 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
302 * big so you do not have to check for that unless you need more.
65d7d68b 303 */
b9a281db 304 int (*read_probe)(AVProbeData *);
4f57fa8c
DB
305 /** Read the format header and initialize the AVFormatContext
306 structure. Return 0 if OK. 'ap' if non-NULL contains
307 additional parameters. Only used in raw format right
b9a281db 308 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
309 int (*read_header)(struct AVFormatContext *,
310 AVFormatParameters *ap);
4f57fa8c 311 /** Read one packet and put it in 'pkt'. pts and flags are also
b9a281db 312 set. 'av_new_stream' can be called only if the flag
6883ebe4
RD
313 AVFMTCTX_NOHEADER is used.
314 @return 0 on success, < 0 on error.
315 When returning an error, pkt must not have been allocated
316 or must be freed before returning */
de6d9b64 317 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
4f57fa8c 318 /** Close the stream. The AVFormatContext and AVStreams are not
de6d9b64
FB
319 freed by this function */
320 int (*read_close)(struct AVFormatContext *);
1de2db8f
MN
321
322#if LIBAVFORMAT_VERSION_MAJOR < 53
115329f1 323 /**
4f57fa8c
DB
324 * Seek to a given timestamp relative to the frames in
325 * stream component stream_index.
22e77e44
DB
326 * @param stream_index Must not be -1.
327 * @param flags Selects which direction should be preferred if no exact
328 * match is available.
05ce0f11 329 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 330 */
115329f1 331 int (*read_seek)(struct AVFormatContext *,
3ba1438d 332 int stream_index, int64_t timestamp, int flags);
1de2db8f 333#endif
8d14a25c 334 /**
4f57fa8c 335 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 336 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
337 */
338 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
339 int64_t *pos, int64_t pos_limit);
4f57fa8c 340 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
de6d9b64 341 int flags;
4f57fa8c 342 /** If extensions are defined, then no probe is done. You should
b9a281db
FB
343 usually not use extension format guessing because it is not
344 reliable enough */
345 const char *extensions;
4f57fa8c 346 /** General purpose read-only value that the format can use. */
b9a281db 347 int value;
fb2758c8 348
d1b9adf2 349 /** Starts/resumes playing - only meaningful if using a network-based format
4f57fa8c 350 (RTSP). */
fb2758c8
FB
351 int (*read_play)(struct AVFormatContext *);
352
d1b9adf2 353 /** Pauses playing - only meaningful if using a network-based format
4f57fa8c 354 (RTSP). */
fb2758c8
FB
355 int (*read_pause)(struct AVFormatContext *);
356
c1854592 357 const struct AVCodecTag * const *codec_tag;
7caf0cc6 358
1de2db8f 359 /**
d1b9adf2 360 * Seeks to timestamp ts.
1de2db8f
MN
361 * Seeking will be done so that the point from which all active streams
362 * can be presented successfully will be closest to ts and within min/max_ts.
363 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
364 */
882fb0a3 365 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 366
719e721a 367 const AVMetadataConv *metadata_conv;
f610a9f2 368
b9a281db
FB
369 /* private fields */
370 struct AVInputFormat *next;
371} AVInputFormat;
de6d9b64 372
57004ff1
AJ
373enum AVStreamParseType {
374 AVSTREAM_PARSE_NONE,
375 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 376 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 377 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
57004ff1
AJ
378};
379
fb2758c8
FB
380typedef struct AVIndexEntry {
381 int64_t pos;
382 int64_t timestamp;
383#define AVINDEX_KEYFRAME 0x0001
30a43f2d 384 int flags:2;
4f57fa8c
DB
385 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
386 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
387} AVIndexEntry;
388
90c2295b
ES
389#define AV_DISPOSITION_DEFAULT 0x0001
390#define AV_DISPOSITION_DUB 0x0002
391#define AV_DISPOSITION_ORIGINAL 0x0004
392#define AV_DISPOSITION_COMMENT 0x0008
393#define AV_DISPOSITION_LYRICS 0x0010
394#define AV_DISPOSITION_KARAOKE 0x0020
395
ba66ae94
MN
396/**
397 * Stream structure.
398 * New fields can be added to the end with minor version bumps.
8bfb108b 399 * Removal, reordering and changes to existing fields require a major
ba66ae94 400 * version bump.
8bfb108b 401 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 402 */
de6d9b64 403typedef struct AVStream {
43d414ba 404 int index; /**< stream index in AVFormatContext */
4f57fa8c 405 int id; /**< format-specific stream ID */
43d414ba 406 AVCodecContext *codec; /**< codec context */
b4b87d48 407 /**
22e77e44
DB
408 * Real base framerate of the stream.
409 * This is the lowest framerate with which all timestamps can be
864ff8c1 410 * represented accurately (it is the least common multiple of all
22e77e44
DB
411 * framerates in the stream). Note, this value is just a guess!
412 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 413 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
414 */
415 AVRational r_frame_rate;
de6d9b64 416 void *priv_data;
82583548 417
b9a281db 418 /* internal data used in av_find_stream_info() */
82583548 419 int64_t first_dts;
4f57fa8c 420 /** encoding: pts generation when outputting stream */
a9fd2b19 421 struct AVFrac pts;
5b28c8c3
MN
422
423 /**
8bfb108b
DB
424 * This is the fundamental unit of time (in seconds) in terms
425 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 426 * time base should be 1/framerate and timestamp increments should be 1.
5b28c8c3 427 */
9ee91c2f 428 AVRational time_base;
43d414ba 429 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 430 /* ffmpeg.c private use */
4f57fa8c
DB
431 int stream_copy; /**< If set, just copy stream. */
432 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
b4aea108 433 //FIXME move stuff to a flags field?
4f57fa8c 434 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
755bfeab 435 * MN: dunno if that is the right place for it */
115329f1 436 float quality;
6d96a9b9 437 /**
8bfb108b
DB
438 * Decoding: pts of the first frame of the stream, in stream time base.
439 * Only set this if you are absolutely 100% sure that the value you set
440 * it to really is the pts of the first frame.
4854c253 441 * This may be undefined (AV_NOPTS_VALUE).
8bfb108b
DB
442 * @note The ASF header does NOT contain a correct start_time the ASF
443 * demuxer must NOT set this.
6d96a9b9 444 */
115329f1 445 int64_t start_time;
e26381b6 446 /**
8bfb108b 447 * Decoding: duration of the stream, in stream time base.
e26381b6 448 * If a source file does not specify a duration, but does specify
4f57fa8c 449 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 450 */
ee404803 451 int64_t duration;
fb2758c8 452
827f7e28 453#if LIBAVFORMAT_VERSION_INT < (53<<16)
7e030c47 454 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
827f7e28 455#endif
09730260 456
fb2758c8 457 /* av_read_frame() support */
57004ff1 458 enum AVStreamParseType need_parsing;
fb2758c8 459 struct AVCodecParserContext *parser;
6ec87caa 460
fb2758c8 461 int64_t cur_dts;
635fbcb1
MN
462 int last_IP_duration;
463 int64_t last_IP_pts;
fb2758c8 464 /* av_seek_frame() support */
4f57fa8c
DB
465 AVIndexEntry *index_entries; /**< Only used if the format does not
466 support seeking natively. */
fb2758c8 467 int nb_index_entries;
191e8ca7 468 unsigned int index_entries_allocated_size;
115329f1 469
b4b87d48 470 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 471
0d84a8f6
BC
472#if LIBAVFORMAT_VERSION_INT < (53<<16)
473 int64_t unused[4+1];
f8d7c9d3
ES
474
475 char *filename; /**< source filename of the stream */
827f7e28 476#endif
90c2295b 477
4f57fa8c 478 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
479
480 AVProbeData probe_data;
0d84a8f6
BC
481#define MAX_REORDER_DELAY 16
482 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
483
484 /**
485 * sample aspect ratio (0 if unknown)
486 * - encoding: Set by user.
487 * - decoding: Set by libavformat.
488 */
489 AVRational sample_aspect_ratio;
f526adaf 490
e232c252 491 AVMetadata *metadata;
3a41c2f7
MN
492
493 /* av_read_frame() support */
494 const uint8_t *cur_ptr;
495 int cur_len;
496 AVPacket cur_pkt;
27ca0a79
IS
497
498 // Timestamp generation support:
499 /**
500 * Timestamp corresponding to the last dts sync point.
501 *
502 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
503 * a DTS is received from the underlying container. Otherwise set to
504 * AV_NOPTS_VALUE by default.
505 */
506 int64_t reference_dts;
86cb7e33
BC
507
508 /**
509 * Number of packets to buffer for codec probing
510 * NOT PART OF PUBLIC API
511 */
48616887 512#define MAX_PROBE_PACKETS 2500
86cb7e33 513 int probe_packets;
ddce56ef
MN
514
515 /**
e07b882b 516 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
517 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
518 */
e07b882b 519 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
520
521 /**
522 * Average framerate
523 */
524 AVRational avg_frame_rate;
6c6e6ef5
MN
525
526 /**
527 * Number of frames that have been demuxed during av_find_stream_info()
528 */
529 int codec_info_nb_frames;
de6d9b64
FB
530} AVStream;
531
15afa396
NS
532#define AV_PROGRAM_RUNNING 1
533
ba66ae94 534/**
ba66ae94 535 * New fields can be added to the end with minor version bumps.
8bfb108b 536 * Removal, reordering and changes to existing fields require a major
ba66ae94 537 * version bump.
8bfb108b 538 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 539 */
15afa396
NS
540typedef struct AVProgram {
541 int id;
827f7e28 542#if LIBAVFORMAT_VERSION_INT < (53<<16)
4f57fa8c
DB
543 char *provider_name; ///< network name for DVB streams
544 char *name; ///< service name for DVB streams
827f7e28 545#endif
15afa396
NS
546 int flags;
547 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
548 unsigned int *stream_index;
549 unsigned int nb_stream_indexes;
e232c252 550 AVMetadata *metadata;
15afa396
NS
551} AVProgram;
552
43d414ba 553#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
554 (streams are added dynamically) */
555
79d7836a 556typedef struct AVChapter {
4f57fa8c
DB
557 int id; ///< unique ID to identify the chapter
558 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 559 int64_t start, end; ///< chapter start/end time in time_base units
827f7e28 560#if LIBAVFORMAT_VERSION_INT < (53<<16)
c2fb6be4 561 char *title; ///< chapter title
827f7e28 562#endif
e232c252 563 AVMetadata *metadata;
79d7836a
AK
564} AVChapter;
565
ad5cc780 566#if LIBAVFORMAT_VERSION_MAJOR < 53
de6d9b64 567#define MAX_STREAMS 20
ad5cc780
JM
568#else
569#define MAX_STREAMS 100
570#endif
de6d9b64 571
252f17e2 572/**
4f57fa8c 573 * Format I/O context.
252f17e2 574 * New fields can be added to the end with minor version bumps.
8bfb108b 575 * Removal, reordering and changes to existing fields require a major
252f17e2 576 * version bump.
8bfb108b 577 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 578 */
de6d9b64 579typedef struct AVFormatContext {
1447aac4 580 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 581 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
582 struct AVInputFormat *iformat;
583 struct AVOutputFormat *oformat;
de6d9b64 584 void *priv_data;
899681cd 585 ByteIOContext *pb;
db69c2e5 586 unsigned int nb_streams;
de6d9b64 587 AVStream *streams[MAX_STREAMS];
43d414ba 588 char filename[1024]; /**< input or output filename */
de6d9b64 589 /* stream info */
4568325a 590 int64_t timestamp;
827f7e28 591#if LIBAVFORMAT_VERSION_INT < (53<<16)
de6d9b64
FB
592 char title[512];
593 char author[512];
594 char copyright[512];
595 char comment[512];
6a58e151 596 char album[512];
43d414ba
PI
597 int year; /**< ID3 year, 0 if none */
598 int track; /**< track number, 0 if none */
599 char genre[32]; /**< ID3 genre */
827f7e28 600#endif
6a58e151 601
4f57fa8c
DB
602 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
603 /* private data for pts handling (do not modify directly). */
43d414ba 604 /** This buffer is only needed when packets were already buffered but
4f57fa8c
DB
605 not decoded, for example to get the codec parameters in MPEG
606 streams. */
ee404803
FB
607 struct AVPacketList *packet_buffer;
608
4f57fa8c 609 /** Decoding: position of the first frame of the component, in
ee404803 610 AV_TIME_BASE fractional seconds. NEVER set this value directly:
4f57fa8c 611 It is deduced from the AVStream values. */
115329f1 612 int64_t start_time;
4f57fa8c 613 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
ee404803
FB
614 seconds. NEVER set this value directly: it is deduced from the
615 AVStream values. */
616 int64_t duration;
4f57fa8c 617 /** decoding: total file size, 0 if unknown */
ee404803 618 int64_t file_size;
4f57fa8c 619 /** Decoding: total stream bitrate in bit/s, 0 if not
ee404803 620 available. Never set it directly if the file_size and the
22e77e44 621 duration are known as FFmpeg can compute it automatically. */
ee404803 622 int bit_rate;
fb2758c8
FB
623
624 /* av_read_frame() support */
625 AVStream *cur_st;
3a41c2f7
MN
626#if LIBAVFORMAT_VERSION_INT < (53<<16)
627 const uint8_t *cur_ptr_deprecated;
628 int cur_len_deprecated;
629 AVPacket cur_pkt_deprecated;
630#endif
fb2758c8 631
fb2758c8 632 /* av_seek_frame() support */
43d414ba 633 int64_t data_offset; /** offset of the first packet */
fb2758c8 634 int index_built;
115329f1 635
2db3c638 636 int mux_rate;
92400be2 637 unsigned int packet_size;
17c88cb0
MN
638 int preload;
639 int max_delay;
8108551a 640
115329f1
DB
641#define AVFMT_NOOUTPUTLOOP -1
642#define AVFMT_INFINITEOUTPUTLOOP 0
43d414ba 643 /** number of times to loop output in formats that support it */
8108551a 644 int loop_output;
115329f1 645
30bc6613 646 int flags;
22e77e44 647#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
648#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
649#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 650#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
651#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
652#define AVFMT_FLAG_NOPARSE 0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
5894e1bb
VP
653
654 int loop_input;
22e77e44 655 /** decoding: size of data to probe; encoding: unused. */
9e6c9470 656 unsigned int probesize;
a44b3c4d
MN
657
658 /**
4f57fa8c
DB
659 * Maximum time (in AV_TIME_BASE units) during which the input should
660 * be analyzed in av_find_stream_info().
a44b3c4d
MN
661 */
662 int max_analyze_duration;
c964c2c7
RD
663
664 const uint8_t *key;
665 int keylen;
15afa396
NS
666
667 unsigned int nb_programs;
668 AVProgram **programs;
62600469
MN
669
670 /**
671 * Forced video codec_id.
4f57fa8c 672 * Demuxing: Set by user.
62600469
MN
673 */
674 enum CodecID video_codec_id;
675 /**
676 * Forced audio codec_id.
4f57fa8c 677 * Demuxing: Set by user.
62600469
MN
678 */
679 enum CodecID audio_codec_id;
680 /**
681 * Forced subtitle codec_id.
4f57fa8c 682 * Demuxing: Set by user.
62600469
MN
683 */
684 enum CodecID subtitle_codec_id;
3dea63bd
PK
685
686 /**
22e77e44
DB
687 * Maximum amount of memory in bytes to use for the index of each stream.
688 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
689 * needed to maintain a smaller size. This can lead to slower or less
690 * accurate seeking (depends on demuxer).
4f57fa8c 691 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
692 * this.
693 * muxing : unused
694 * demuxing: set by user
695 */
696 unsigned int max_index_size;
ab8ab30c
RP
697
698 /**
ffa71b2b 699 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 700 * obtained from realtime capture devices.
ab8ab30c
RP
701 */
702 unsigned int max_picture_buffer;
79d7836a 703
fbabf1e9 704 unsigned int nb_chapters;
79d7836a 705 AVChapter **chapters;
45b2b05f
MN
706
707 /**
4f57fa8c 708 * Flags to enable debugging.
45b2b05f
MN
709 */
710 int debug;
711#define FF_FDEBUG_TS 0x0001
0bef08e5
MN
712
713 /**
4f57fa8c 714 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
715 * This buffer is used for buffering packets until the codec can
716 * be identified, as parsing cannot be done without knowing the
717 * codec.
718 */
719 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
720 struct AVPacketList *raw_packet_buffer_end;
721
722 struct AVPacketList *packet_buffer_end;
47146dfb 723
e232c252 724 AVMetadata *metadata;
af122d6a
BC
725
726 /**
727 * Remaining size available for raw_packet_buffer, in bytes.
728 * NOT PART OF PUBLIC API
729 */
48616887 730#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 731 int raw_packet_buffer_remaining_size;
b8819c85
MS
732
733 /**
734 * Start time of the stream in real world time, in microseconds
735 * since the unix epoch (00:00 1st January 1970). That is, pts=0
736 * in the stream was captured at this real world time.
737 * - encoding: Set by user.
738 * - decoding: Unused.
739 */
740 int64_t start_time_realtime;
de6d9b64
FB
741} AVFormatContext;
742
743typedef struct AVPacketList {
744 AVPacket pkt;
745 struct AVPacketList *next;
746} AVPacketList;
747
84be6e72 748#if LIBAVFORMAT_VERSION_INT < (53<<16)
b9a281db
FB
749extern AVInputFormat *first_iformat;
750extern AVOutputFormat *first_oformat;
84be6e72
MN
751#endif
752
aeedac95
SS
753/**
754 * If f is NULL, returns the first registered input format,
22e77e44 755 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
756 * or NULL if f is the last one.
757 */
84be6e72 758AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
759
760/**
761 * If f is NULL, returns the first registered output format,
22e77e44 762 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
763 * or NULL if f is the last one.
764 */
84be6e72 765AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 766
5b6d5596 767enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 768
22e77e44
DB
769/* XXX: Use automatic init with either ELF sections or C file parser */
770/* modules. */
de6d9b64 771
b9a281db 772/* utils.c */
b9a281db
FB
773void av_register_input_format(AVInputFormat *format);
774void av_register_output_format(AVOutputFormat *format);
1642ee43
SS
775#if LIBAVFORMAT_VERSION_MAJOR < 53
776attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
78cb7273
DB
777 const char *filename,
778 const char *mime_type);
a1f547b9
SS
779
780/**
781 * @deprecated Use av_guess_format() instead.
782 */
783attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
784 const char *filename,
785 const char *mime_type);
1642ee43 786#endif
f48b0fa2
SS
787
788/**
789 * Returns the output format in the list of registered output formats
790 * which best matches the provided parameters, or returns NULL if
791 * there is no match.
792 *
793 * @param short_name if non-NULL checks if short_name matches with the
794 * names of the registered formats
795 * @param filename if non-NULL checks if filename terminates with the
796 * extensions of the registered formats
797 * @param mime_type if non-NULL checks if mime_type matches with the
798 * MIME type of the registered formats
799 */
a1f547b9 800AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
801 const char *filename,
802 const char *mime_type);
3217cb42
PI
803
804/**
4f57fa8c 805 * Guesses the codec ID based upon muxer and filename.
3217cb42 806 */
115329f1 807enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 808 const char *filename, const char *mime_type,
72415b2a 809 enum AVMediaType type);
de6d9b64 810
3217cb42 811/**
d1b9adf2 812 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
813 *
814 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
815 * @param buf buffer
816 * @param size buffer size
750f0e1f
PI
817 *
818 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 819 */
fb2758c8 820void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
821
822/**
d1b9adf2 823 * Sends a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
824 *
825 * @param avcl A pointer to an arbitrary struct of which the first field is a
826 * pointer to an AVClass struct.
827 * @param level The importance level of the message, lower values signifying
828 * higher importance.
829 * @param buf buffer
830 * @param size buffer size
831 *
832 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
833 */
834void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
835
836/**
d1b9adf2 837 * Sends a nice dump of a packet to the specified file stream.
750f0e1f
PI
838 *
839 * @param f The file stream pointer where the dump should be sent to.
3217cb42 840 * @param pkt packet to dump
4f57fa8c 841 * @param dump_payload True if the payload must be displayed, too.
3217cb42 842 */
fb2758c8 843void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 844
750f0e1f 845/**
d1b9adf2 846 * Sends a nice dump of a packet to the log.
750f0e1f
PI
847 *
848 * @param avcl A pointer to an arbitrary struct of which the first field is a
849 * pointer to an AVClass struct.
850 * @param level The importance level of the message, lower values signifying
851 * higher importance.
852 * @param pkt packet to dump
4f57fa8c 853 * @param dump_payload True if the payload must be displayed, too.
750f0e1f
PI
854 */
855void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
856
4815e246 857/**
d1b9adf2 858 * Initializes libavformat and registers all the muxers, demuxers and
4815e246
SS
859 * protocols. If you do not call this function, then you can select
860 * exactly which formats you want to support.
861 *
862 * @see av_register_input_format()
863 * @see av_register_output_format()
5d377501 864 * @see av_register_protocol()
4815e246 865 */
94988531 866void av_register_all(void);
de6d9b64 867
43d414ba 868/** codec tag <-> codec id */
15545a09
SS
869enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
870unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 871
b9a281db 872/* media file input */
3217cb42
PI
873
874/**
4f57fa8c 875 * Finds AVInputFormat based on the short name of the input format.
3217cb42 876 */
b9a281db 877AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
878
879/**
d1b9adf2 880 * Guesses the file format.
3217cb42 881 *
4f57fa8c
DB
882 * @param is_opened Whether the file is already opened; determines whether
883 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 884 */
94988531 885AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
886
887/**
888 * Allocates all the structures needed to read an input stream.
889 * This does not open the needed codecs for decoding the stream[s].
890 */
115329f1
DB
891int av_open_input_stream(AVFormatContext **ic_ptr,
892 ByteIOContext *pb, const char *filename,
da24c5e3 893 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
894
895/**
d1b9adf2 896 * Opens a media file as input. The codecs are not opened. Only the file
3217cb42
PI
897 * header (if present) is read.
898 *
4f57fa8c
DB
899 * @param ic_ptr The opened media file handle is put here.
900 * @param filename filename to open
901 * @param fmt If non-NULL, force the file format to use.
3217cb42 902 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
903 * @param ap Additional parameters needed when opening the file
904 * (NULL if default).
4f57fa8c 905 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 906 */
115329f1 907int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
908 AVInputFormat *fmt,
909 int buf_size,
910 AVFormatParameters *ap);
88a28965
SS
911
912#if LIBAVFORMAT_VERSION_MAJOR < 53
913/**
914 * @deprecated Use avformat_alloc_context() instead.
915 */
916attribute_deprecated AVFormatContext *av_alloc_format_context(void);
917#endif
918
88808c60 919/**
d1b9adf2 920 * Allocates an AVFormatContext.
5d81d641 921 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
922 * explicitly allocated as well!
923 */
88a28965 924AVFormatContext *avformat_alloc_context(void);
b9a281db 925
3217cb42 926/**
d1b9adf2 927 * Reads packets of a media file to get stream information. This
3217cb42 928 * is useful for file formats with no headers such as MPEG. This
22e77e44 929 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
930 * frame mode.
931 * The logical file position is not changed by this function;
932 * examined packets may be buffered for later processing.
933 *
934 * @param ic media file handle
4f57fa8c
DB
935 * @return >=0 if OK, AVERROR_xxx on error
936 * @todo Let the user decide somehow what information is needed so that
937 * we do not waste time getting stuff the user does not need.
3217cb42 938 */
b9a281db 939int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
940
941/**
d1b9adf2 942 * Reads a transport packet from a media file.
3217cb42 943 *
864ff8c1 944 * This function is obsolete and should never be used.
3217cb42
PI
945 * Use av_read_frame() instead.
946 *
947 * @param s media file handle
948 * @param pkt is filled
4f57fa8c 949 * @return 0 if OK, AVERROR_xxx on error
3217cb42 950 */
de6d9b64 951int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
952
953/**
d1b9adf2 954 * Returns the next frame of a stream.
3217cb42
PI
955 *
956 * The returned packet is valid
957 * until the next av_read_frame() or until av_close_input_file() and
958 * must be freed with av_free_packet. For video, the packet contains
959 * exactly one frame. For audio, it contains an integer number of
960 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
961 * data). If the audio frames have a variable size (e.g. MPEG audio),
962 * then it contains one frame.
963 *
964 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 965 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
966 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
967 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
968 * decompress the payload.
969 *
4f57fa8c 970 * @return 0 if OK, < 0 on error or end of file
3217cb42 971 */
fb2758c8 972int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
973
974/**
d1b9adf2 975 * Seeks to the keyframe at timestamp.
3217cb42
PI
976 * 'timestamp' in 'stream_index'.
977 * @param stream_index If stream_index is (-1), a default
978 * stream is selected, and timestamp is automatically converted
979 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
980 * @param timestamp Timestamp in AVStream.time_base units
981 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
982 * @param flags flags which select direction and seeking mode
983 * @return >= 0 on success
984 */
78cb7273
DB
985int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
986 int flags);
3217cb42
PI
987
988/**
d1b9adf2 989 * Seeks to timestamp ts.
d04768fa
MN
990 * Seeking will be done so that the point from which all active streams
991 * can be presented successfully will be closest to ts and within min/max_ts.
992 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
993 *
22e77e44 994 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 995 * are the file position (this may not be supported by all demuxers).
22e77e44 996 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 997 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
998 * Otherwise all timestamps are in units of the stream selected by stream_index
999 * or if stream_index is -1, in AV_TIME_BASE units.
1000 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1001 * keyframes (this may not be supported by all demuxers).
1002 *
22e77e44 1003 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1004 * @param min_ts smallest acceptable timestamp
1005 * @param ts target timestamp
1006 * @param max_ts largest acceptable timestamp
1007 * @param flags flags
32e543f8 1008 * @return >=0 on success, error code otherwise
998b6f7c 1009 *
22e77e44
DB
1010 * @NOTE This is part of the new seek API which is still under construction.
1011 * Thus do not use this yet. It may change at any time, do not expect
1012 * ABI compatibility yet!
d04768fa
MN
1013 */
1014int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1015
1016/**
d1b9adf2 1017 * Starts playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1018 * current position.
3217cb42 1019 */
fb2758c8 1020int av_read_play(AVFormatContext *s);
3217cb42
PI
1021
1022/**
d1b9adf2 1023 * Pauses a network-based stream (e.g. RTSP stream).
3217cb42
PI
1024 *
1025 * Use av_read_play() to resume it.
1026 */
fb2758c8 1027int av_read_pause(AVFormatContext *s);
3217cb42
PI
1028
1029/**
d1b9adf2 1030 * Frees a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1031 * @param s context to free
1032 */
1033void av_close_input_stream(AVFormatContext *s);
1034
1035/**
d1b9adf2 1036 * Closes a media file (but not its codecs).
3217cb42
PI
1037 *
1038 * @param s media file handle
1039 */
de6d9b64 1040void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1041
1042/**
d1b9adf2 1043 * Adds a new stream to a media file.
3217cb42
PI
1044 *
1045 * Can only be called in the read_header() function. If the flag
1046 * AVFMTCTX_NOHEADER is in the format context, then new streams
1047 * can be added in read_packet too.
1048 *
1049 * @param s media file handle
4f57fa8c 1050 * @param id file-format-dependent stream ID
3217cb42 1051 */
b9a281db 1052AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 1053AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1054
1055/**
d1b9adf2 1056 * Adds a new chapter.
79d7836a 1057 * This function is NOT part of the public API
4f57fa8c 1058 * and should ONLY be used by demuxers.
79d7836a
AK
1059 *
1060 * @param s media file handle
4f57fa8c 1061 * @param id unique ID for this chapter
abd2256d
MN
1062 * @param start chapter start time in time_base units
1063 * @param end chapter end time in time_base units
79d7836a 1064 * @param title chapter title
5c37f43a 1065 *
4f57fa8c 1066 * @return AVChapter or NULL on error
79d7836a 1067 */
78cb7273
DB
1068AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1069 int64_t start, int64_t end, const char *title);
79d7836a
AK
1070
1071/**
d1b9adf2 1072 * Sets the pts for a given stream.
3217cb42
PI
1073 *
1074 * @param s stream
1075 * @param pts_wrap_bits number of bits effectively used by the pts
1076 * (used for wrap control, 33 is the value for MPEG)
1077 * @param pts_num numerator to convert to seconds (MPEG: 1)
1078 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1079 */
9ee91c2f 1080void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1081 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1082
3ba1438d
MN
1083#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1084#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1085#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1086#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1087
b754978a 1088int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1089
1090/**
1091 * Gets the index for a specific timestamp.
4f57fa8c
DB
1092 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1093 * to the timestamp which is <= the requested one, if backward
1094 * is 0, then it will be >=
3217cb42
PI
1095 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1096 * @return < 0 if no such timestamp could be found
1097 */
dc56fc38 1098int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1099
1100/**
3dea63bd 1101 * Ensures the index uses less memory than the maximum specified in
22e77e44 1102 * AVFormatContext.max_index_size by discarding entries if it grows
3dea63bd
PK
1103 * too large.
1104 * This function is not part of the public API and should only be called
1105 * by demuxers.
1106 */
1107void ff_reduce_index(AVFormatContext *s, int stream_index);
1108
1109/**
d1b9adf2 1110 * Adds an index entry into a sorted list. Updates the entry if the list
4f57fa8c 1111 * already contains it.
3217cb42 1112 *
4f57fa8c 1113 * @param timestamp timestamp in the time base of the given stream
3217cb42 1114 */
78cb7273
DB
1115int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1116 int size, int distance, int flags);
3217cb42
PI
1117
1118/**
78cb7273
DB
1119 * Does a binary search using av_index_search_timestamp() and
1120 * AVCodec.read_timestamp().
1121 * This is not supposed to be called directly by a user application,
1122 * but by demuxers.
3217cb42
PI
1123 * @param target_ts target timestamp in the time base of the given stream
1124 * @param stream_index stream number
1125 */
78cb7273
DB
1126int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1127 int64_t target_ts, int flags);
3217cb42
PI
1128
1129/**
4f57fa8c 1130 * Updates cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1131 *
4f57fa8c
DB
1132 * Stream ref_st unchanged, others set cur_dts in their native time base.
1133 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1134 * @param timestamp new dts expressed in time_base of param ref_st
1135 * @param ref_st reference stream giving time_base of param timestamp
1136 */
22ffac70 1137void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1138
1139/**
1140 * Does a binary search using read_timestamp().
78cb7273
DB
1141 * This is not supposed to be called directly by a user application,
1142 * but by demuxers.
3217cb42
PI
1143 * @param target_ts target timestamp in the time base of the given stream
1144 * @param stream_index stream number
1145 */
78cb7273
DB
1146int64_t av_gen_search(AVFormatContext *s, int stream_index,
1147 int64_t target_ts, int64_t pos_min,
1148 int64_t pos_max, int64_t pos_limit,
1149 int64_t ts_min, int64_t ts_max,
1150 int flags, int64_t *ts_ret,
1151 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1152
43d414ba 1153/** media file output */
290c5fa6 1154int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1155
1156/**
d1b9adf2 1157 * Allocates the stream private data and writes the stream header to an
755bfeab 1158 * output media file.
3217cb42
PI
1159 *
1160 * @param s media file handle
4f57fa8c 1161 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1162 */
b9a281db 1163int av_write_header(AVFormatContext *s);
3217cb42
PI
1164
1165/**
d1b9adf2 1166 * Writes a packet to an output media file.
3217cb42
PI
1167 *
1168 * The packet shall contain one audio or video frame.
78cb7273
DB
1169 * The packet must be correctly interleaved according to the container
1170 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1171 *
1172 * @param s media file handle
78cb7273
DB
1173 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1174 dts/pts, ...
4f57fa8c 1175 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1176 */
e928649b 1177int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1178
1179/**
1180 * Writes a packet to an output media file ensuring correct interleaving.
1181 *
1182 * The packet must contain one audio or video frame.
22e77e44 1183 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1184 * call av_write_frame() instead as it is slightly faster. It is also important
1185 * to keep in mind that completely non-interleaved input will need huge amounts
1186 * of memory to interleave with this, so it is preferable to interleave at the
1187 * demuxer level.
3217cb42
PI
1188 *
1189 * @param s media file handle
78cb7273
DB
1190 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1191 dts/pts, ...
4f57fa8c 1192 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1193 */
3c895fc0 1194int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1195
1196/**
d1b9adf2 1197 * Interleaves a packet per dts in an output media file.
3217cb42 1198 *
78cb7273 1199 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1200 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1201 * on them is still safe.
3217cb42
PI
1202 *
1203 * @param s media file handle
1204 * @param out the interleaved packet will be output here
1205 * @param in the input packet
1206 * @param flush 1 if no further packets are available as input and all
1207 * remaining packets should be output
1208 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1209 * < 0 if an error occurred
3217cb42 1210 */
78cb7273
DB
1211int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1212 AVPacket *pkt, int flush);
e928649b 1213
3217cb42 1214/**
2b75bde6
SS
1215 * Writes the stream trailer to an output media file and frees the
1216 * file private data.
3217cb42 1217 *
dc76fe13
RD
1218 * May only be called after a successful call to av_write_header.
1219 *
3217cb42 1220 * @param s media file handle
4f57fa8c 1221 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1222 */
b9a281db 1223int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
1224
1225void dump_format(AVFormatContext *ic,
115329f1 1226 int index,
de6d9b64
FB
1227 const char *url,
1228 int is_output);
3217cb42 1229
1ca9133f 1230#if LIBAVFORMAT_VERSION_MAJOR < 53
3217cb42 1231/**
4f57fa8c 1232 * Parses width and height out of string str.
26ef3220 1233 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 1234 */
78cb7273
DB
1235attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1236 const char *str);
3217cb42
PI
1237
1238/**
22e77e44 1239 * Converts framerate from a string to a fraction.
26ef3220 1240 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 1241 */
78cb7273
DB
1242attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1243 const char *arg);
1ca9133f 1244#endif
3217cb42
PI
1245
1246/**
819174fa 1247 * Parses datestr and returns a corresponding number of microseconds.
f9436161
SS
1248 * @param datestr String representing a date or a duration.
1249 * - If a date the syntax is:
3217cb42 1250 * @code
3217cb42 1251 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
3217cb42 1252 * @endcode
4f57fa8c 1253 * Time is local time unless Z is appended, in which case it is
f9436161 1254 * interpreted as UTC.
4f57fa8c 1255 * If the year-month-day part is not specified it takes the current
f9436161
SS
1256 * year-month-day.
1257 * Returns the number of microseconds since 1st of January, 1970 up to
819174fa 1258 * the time of the parsed date or INT64_MIN if datestr cannot be
f9436161
SS
1259 * successfully parsed.
1260 * - If a duration the syntax is:
1261 * @code
1262 * [-]HH[:MM[:SS[.m...]]]
1263 * [-]S+[.m...]
1264 * @endcode
1265 * Returns the number of microseconds contained in a time interval
819174fa 1266 * with the specified duration or INT64_MIN if datestr cannot be
7338d368 1267 * successfully parsed.
819174fa
SS
1268 * @param duration Flag which tells how to interpret datestr, if
1269 * not zero datestr is interpreted as a duration, otherwise as a
f9436161 1270 * date.
3217cb42 1271 */
0c1a9eda 1272int64_t parse_date(const char *datestr, int duration);
de6d9b64 1273
fff5e687 1274/** Gets the current time in microseconds. */
0c1a9eda 1275int64_t av_gettime(void);
94988531 1276
4f57fa8c 1277/* ffm-specific for ffserver */
de6d9b64 1278#define FFM_PACKET_SIZE 4096
bc5c918e 1279int64_t ffm_read_write_index(int fd);
6fcce4f9 1280int ffm_write_write_index(int fd, int64_t pos);
bc5c918e 1281void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
de6d9b64 1282
3217cb42
PI
1283/**
1284 * Attempts to find a specific tag in a URL.
1285 *
1286 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1287 * Return 1 if found.
1288 */
de6d9b64
FB
1289int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1290
3217cb42 1291/**
22e77e44 1292 * Returns in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1293 *
3217cb42
PI
1294 * Also handles the '%0nd' format where 'n' is the total number
1295 * of digits and '%%'.
1296 *
1297 * @param buf destination buffer
1298 * @param buf_size destination buffer size
1299 * @param path numbered sequence string
8ea0e802 1300 * @param number frame number
4f57fa8c 1301 * @return 0 if OK, -1 on format error
3217cb42 1302 */
5c07cf53
MB
1303int av_get_frame_filename(char *buf, int buf_size,
1304 const char *path, int number);
3217cb42
PI
1305
1306/**
d1b9adf2 1307 * Checks whether filename actually is a numbered sequence generator.
3217cb42
PI
1308 *
1309 * @param filename possible numbered sequence string
4f57fa8c 1310 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1311 */
5c07cf53 1312int av_filename_number_test(const char *filename);
96baaa6a 1313
c5388c07 1314/**
d1b9adf2 1315 * Generates an SDP for an RTP session.
c5388c07
LA
1316 *
1317 * @param ac array of AVFormatContexts describing the RTP streams. If the
1318 * array is composed by only one context, such context can contain
1319 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1320 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1321 * must contain only one AVStream.
8767b80f
LA
1322 * @param n_files number of AVCodecContexts contained in ac
1323 * @param buff buffer where the SDP will be stored (must be allocated by
4f57fa8c 1324 * the caller)
8767b80f 1325 * @param size the size of the buffer
4f57fa8c 1326 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1327 */
8767b80f 1328int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 1329
fb025625 1330#ifdef HAVE_AV_CONFIG_H
f71869a4 1331
2db5da97 1332void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
39f472c3 1333
e4e70d2e 1334#ifdef __GNUC__
39f472c3
FB
1335#define dynarray_add(tab, nb_ptr, elem)\
1336do {\
72ab9d7f
DP
1337 __typeof__(tab) _tab = (tab);\
1338 __typeof__(elem) _elem = (elem);\
39f472c3 1339 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
2db5da97 1340 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
39f472c3 1341} while(0)
e4e70d2e
FH
1342#else
1343#define dynarray_add(tab, nb_ptr, elem)\
1344do {\
2db5da97 1345 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
e4e70d2e
FH
1346} while(0)
1347#endif
39f472c3 1348
f71869a4 1349time_t mktimegm(struct tm *tm);
0c9fc6e1 1350struct tm *brktimegm(time_t secs, struct tm *tm);
115329f1 1351const char *small_strptime(const char *p, const char *fmt,
f71869a4
FB
1352 struct tm *dt);
1353
002a6d0e 1354/**
a3303178
SS
1355 * Returns a positive value if the given filename has one of the given
1356 * extensions, 0 otherwise.
1357 *
1358 * @param extensions a comma-separated list of filename extensions
1359 */
8eb631fa 1360int av_match_ext(const char *filename, const char *extensions);
a941f391 1361
fb025625
FB
1362#endif /* HAVE_AV_CONFIG_H */
1363
98790382 1364#endif /* AVFORMAT_AVFORMAT_H */