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