Move metadata API from lavf to lavu.
[libav.git] / libavformat / avformat.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav 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 *
2912e87a 11 * Libav 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
2912e87a 17 * License along with Libav; 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
072e3efd 24
c97429e2 25/**
7ed0a77f 26 * Return the LIBAVFORMAT_VERSION_INT constant.
c97429e2
SS
27 */
28unsigned avformat_version(void);
29
c1736936 30/**
49bd8e4b 31 * Return the libavformat build-time configuration.
c1736936 32 */
41600690 33const char *avformat_configuration(void);
c1736936
DB
34
35/**
49bd8e4b 36 * Return the libavformat license.
c1736936 37 */
41600690 38const char *avformat_license(void);
c1736936 39
f71869a4 40#include <time.h>
67070e4f 41#include <stdio.h> /* FILE */
76a448ed 42#include "libavcodec/avcodec.h"
d9f80ea2 43#include "libavutil/dict.h"
de6d9b64 44
de6d9b64 45#include "avio.h"
50196a98 46#include "libavformat/version.h"
de6d9b64 47
f610a9f2
AJ
48struct AVFormatContext;
49
a6d18a0e
MN
50
51/*
ea29242c
MM
52 * Public Metadata API.
53 * The metadata API allows libavformat to export metadata tags to a client
2912e87a 54 * application using a sequence of key/value pairs. Like all strings in Libav,
61648423
AK
55 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
56 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
ea29242c
MM
57 * Important concepts to keep in mind:
58 * 1. Keys are unique; there can never be 2 tags with the same key. This is
59 * also meant semantically, i.e., a demuxer should not knowingly produce
60 * several keys that are literally different but semantically identical.
61 * E.g., key=Author5, key=Author6. In this example, all authors must be
62 * placed in the same tag.
63 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
64 * want to store, e.g., the email address of the child of producer Alice
65 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
ca76a119
AK
66 * 3. Several modifiers can be applied to the tag name. This is done by
67 * appending a dash character ('-') and the modifier name in the order
68 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
69 * a) language -- a tag whose value is localized for a particular language
70 * is appended with the ISO 639-2/B 3-letter language code.
71 * For example: Author-ger=Michael, Author-eng=Mike
72 * The original/default language is in the unqualified "Author" tag.
73 * A demuxer should set a default if it sets any translated tag.
74 * b) sorting -- a modified version of a tag that should be used for
75 * sorting will have '-sort' appended. E.g. artist="The Beatles",
76 * artist-sort="Beatles, The".
77 *
03700d39
AK
78 * 4. Demuxers attempt to export metadata in a generic format, however tags
79 * with no generic equivalents are left as they are stored in the container.
80 * Follows a list of generic tag names:
ca76a119
AK
81 *
82 * album -- name of the set this work belongs to
83 * album_artist -- main creator of the set/album, if different from artist.
84 * e.g. "Various Artists" for compilation albums.
85 * artist -- main creator of the work
86 * comment -- any additional description of the file.
87 * composer -- who composed the work, if different from artist.
88 * copyright -- name of copyright holder.
29c5c590 89 * creation_time-- date when the file was created, preferably in ISO 8601.
ca76a119
AK
90 * date -- date when the work was created, preferably in ISO 8601.
91 * disc -- number of a subset, e.g. disc in a multi-disc collection.
92 * encoder -- name/settings of the software/hardware that produced the file.
93 * encoded_by -- person/group who created the file.
94 * filename -- original name of the file.
95 * genre -- <self-evident>.
96 * language -- main language in which the work is performed, preferably
c9256246
AH
97 * in ISO 639-2 format. Multiple languages can be specified by
98 * separating them with commas.
ca76a119
AK
99 * performer -- artist who performed the work, if different from artist.
100 * E.g for "Also sprach Zarathustra", artist would be "Richard
101 * Strauss" and performer "London Philharmonic Orchestra".
102 * publisher -- name of the label/publisher.
69688e71
GC
103 * service_name -- name of the service in broadcasting (channel name).
104 * service_provider -- name of the service provider in broadcasting.
ca76a119
AK
105 * title -- name of the work.
106 * track -- number of this work in the set, can be in form current/total.
fe8e0394 107 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
a6d18a0e
MN
108 */
109
d9f80ea2
AK
110#if FF_API_OLD_METADATA2
111/**
112 * @defgroup old_metadata Old metadata API
113 * The following functions are deprecated, use
114 * their equivalents from libavutil/dict.h instead.
115 * @{
116 */
a6d18a0e 117
d9f80ea2
AK
118#define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
119#define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
120#define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
121#define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
122#define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
123
124typedef attribute_deprecated AVDictionary AVMetadata;
125typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
a6d18a0e 126
f610a9f2 127typedef struct AVMetadataConv AVMetadataConv;
a6d18a0e
MN
128
129/**
49bd8e4b 130 * Get a metadata element with matching key.
26cc5310 131 *
22e77e44 132 * @param prev Set to the previous matching element to find the next.
66b6c745 133 * If set to NULL the first matching element is returned.
22e77e44
DB
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 */
d9f80ea2
AK
137attribute_deprecated AVDictionaryEntry *
138av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
a6d18a0e 139
a181981e 140/**
32e6f246 141 * Set the given tag in *pm, overwriting an existing tag.
26cc5310 142 *
983ec304
SS
143 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
144 * a metadata struct is allocated and put in *pm.
32e6f246
SS
145 * @param key tag key to add to *pm (will be av_strduped depending on flags)
146 * @param value tag value to add to *pm (will be av_strduped depending on flags).
160c896c 147 * Passing a NULL value will cause an existing tag to be deleted.
a181981e
MN
148 * @return >= 0 on success otherwise an error code <0
149 */
d9f80ea2 150attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
a6d18a0e 151
094d9df7 152/**
03700d39 153 * This function is provided for compatibility reason and currently does nothing.
f610a9f2 154 */
03700d39
AK
155attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
156 const AVMetadataConv *s_conv);
f610a9f2
AJ
157
158/**
d9f80ea2
AK
159 * Copy metadata from one AVDictionary struct into another.
160 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
7f88a5bf 161 * this function will allocate a struct for you and put it in *dst
d9f80ea2 162 * @param src pointer to source AVDictionary struct
7f88a5bf
RB
163 * @param flags flags to use when setting metadata in *dst
164 * @note metadata is read using the AV_METADATA_IGNORE_SUFFIX flag
165 */
d9f80ea2 166attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
7f88a5bf
RB
167
168/**
d9f80ea2 169 * Free all the memory allocated for an AVDictionary struct.
094d9df7 170 */
d9f80ea2
AK
171attribute_deprecated void av_metadata_free(AVDictionary **m);
172/**
173 * @}
174 */
175#endif
094d9df7 176
a6d18a0e 177
de6d9b64
FB
178/* packet functions */
179
3217cb42
PI
180
181/**
49bd8e4b 182 * Allocate and read the payload of a packet and initialize its
d1b9adf2 183 * fields with default values.
3217cb42
PI
184 *
185 * @param pkt packet
4f57fa8c
DB
186 * @param size desired payload size
187 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 188 */
ae628ec1 189int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
3217cb42 190
de6d9b64 191
6bfc2683 192/**
fa8cc126
RD
193 * Read data and append it to the current content of the AVPacket.
194 * If pkt->size is 0 this is identical to av_get_packet.
6bfc2683
RD
195 * Note that this uses av_grow_packet and thus involves a realloc
196 * which is inefficient. Thus this function should only be used
197 * when there is no reasonable way to know (an upper bound of)
198 * the final size.
199 *
200 * @param pkt packet
201 * @param size amount of data to read
202 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
203 * will not be lost even if an error occurs.
204 */
ae628ec1 205int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
6bfc2683 206
de6d9b64 207/*************************************************/
916c80e9
FB
208/* fractional numbers for exact pts handling */
209
671adb17 210/**
4f57fa8c
DB
211 * The exact value of the fractional number is: 'val + num / den'.
212 * num is assumed to be 0 <= num < den.
4c08b2bd 213 */
916c80e9 214typedef struct AVFrac {
115329f1 215 int64_t val, num, den;
52e57500 216} AVFrac;
916c80e9 217
916c80e9 218/*************************************************/
b9a281db 219/* input/output formats */
de6d9b64 220
7caf0cc6
MN
221struct AVCodecTag;
222
76c56376
MN
223/**
224 * This structure contains the data a format has to probe a file.
225 */
b9a281db 226typedef struct AVProbeData {
5c91a675 227 const char *filename;
e5f58f81 228 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
229 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
230} AVProbeData;
231
22e77e44 232#define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
87e87886 233#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
234
235typedef struct AVFormatParameters {
bffd4dd1 236#if FF_API_FORMAT_PARAMETERS
b2592ea4 237 attribute_deprecated AVRational time_base;
bffd4dd1
AK
238 attribute_deprecated int sample_rate;
239 attribute_deprecated int channels;
89d1b7f4
AK
240 attribute_deprecated int width;
241 attribute_deprecated int height;
f91ccb1d 242 attribute_deprecated enum PixelFormat pix_fmt;
d20576d0 243 attribute_deprecated int channel; /**< Used to select DV channel. */
fc68a8f7 244 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
fb37d573 245 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
17a5556d
AK
246 /**< deprecated, use mpegtsraw demuxer-specific options instead */
247 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
4779f593
AK
248 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
249 immediately (RTSP only). */
17a5556d 250#endif
72e043dd 251 unsigned int prealloced_context:1;
de6d9b64
FB
252} AVFormatParameters;
253
22a3212e 254//! Demuxer will use avio_open, no opened file should be provided by the caller.
40d9c544 255#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
256#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
257#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
258#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
259 raw picture data. */
260#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
261#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
262#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
58ec7e00 263#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
25918212 264#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 265#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
bb62d5c1 266#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
69fa2396
VP
267#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
268#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
b9a281db
FB
269
270typedef struct AVOutputFormat {
de6d9b64 271 const char *name;
bde15e74
SS
272 /**
273 * Descriptive name for the format, meant to be more human-readable
819174fa 274 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
275 * to define it.
276 */
de6d9b64
FB
277 const char *long_name;
278 const char *mime_type;
4f57fa8c 279 const char *extensions; /**< comma-separated filename extensions */
76c56376
MN
280 /**
281 * size of private data so that it can be allocated in the wrapper
282 */
b9a281db 283 int priv_data_size;
de6d9b64 284 /* output support */
43d414ba
PI
285 enum CodecID audio_codec; /**< default audio codec */
286 enum CodecID video_codec; /**< default video codec */
de6d9b64 287 int (*write_header)(struct AVFormatContext *);
e928649b 288 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 289 int (*write_trailer)(struct AVFormatContext *);
76c56376 290 /**
89e568fe
AH
291 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
292 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
293 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
76c56376 294 */
b9a281db 295 int flags;
76c56376
MN
296 /**
297 * Currently only used to set pixel format if not YUV420P.
298 */
290c5fa6 299 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
300 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
301 AVPacket *in, int flush);
7caf0cc6
MN
302
303 /**
78cb7273 304 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 305 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 306 */
c1854592 307 const struct AVCodecTag * const *codec_tag;
7caf0cc6 308
11bf3847
AJ
309 enum CodecID subtitle_codec; /**< default subtitle codec */
310
451d566f 311#if FF_API_OLD_METADATA2
719e721a 312 const AVMetadataConv *metadata_conv;
03700d39 313#endif
f610a9f2 314
cf99e4aa
AH
315 const AVClass *priv_class; ///< AVClass for the private context
316
b9a281db
FB
317 /* private fields */
318 struct AVOutputFormat *next;
319} AVOutputFormat;
de6d9b64 320
b9a281db 321typedef struct AVInputFormat {
76c56376
MN
322 /**
323 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
324 * may be appended with a minor bump.
325 */
b9a281db 326 const char *name;
76c56376 327
bde15e74
SS
328 /**
329 * Descriptive name for the format, meant to be more human-readable
819174fa 330 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
331 * to define it.
332 */
b9a281db 333 const char *long_name;
76c56376
MN
334
335 /**
336 * Size of private data so that it can be allocated in the wrapper.
337 */
b9a281db 338 int priv_data_size;
76c56376 339
65d7d68b 340 /**
22e77e44 341 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
342 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
343 * big so you do not have to check for that unless you need more.
65d7d68b 344 */
b9a281db 345 int (*read_probe)(AVProbeData *);
76c56376
MN
346
347 /**
348 * Read the format header and initialize the AVFormatContext
349 * structure. Return 0 if OK. 'ap' if non-NULL contains
350 * additional parameters. Only used in raw format right
351 * now. 'av_new_stream' should be called to create new streams.
352 */
de6d9b64
FB
353 int (*read_header)(struct AVFormatContext *,
354 AVFormatParameters *ap);
76c56376
MN
355
356 /**
357 * Read one packet and put it in 'pkt'. pts and flags are also
358 * set. 'av_new_stream' can be called only if the flag
2899a28c
AJ
359 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
360 * background thread).
76c56376
MN
361 * @return 0 on success, < 0 on error.
362 * When returning an error, pkt must not have been allocated
363 * or must be freed before returning
364 */
de6d9b64 365 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
366
367 /**
368 * Close the stream. The AVFormatContext and AVStreams are not
369 * freed by this function
370 */
de6d9b64 371 int (*read_close)(struct AVFormatContext *);
1de2db8f 372
634e0304 373#if FF_API_READ_SEEK
115329f1 374 /**
4f57fa8c
DB
375 * Seek to a given timestamp relative to the frames in
376 * stream component stream_index.
22e77e44
DB
377 * @param stream_index Must not be -1.
378 * @param flags Selects which direction should be preferred if no exact
379 * match is available.
05ce0f11 380 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 381 */
a15c7fd6
AK
382 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
383 int stream_index, int64_t timestamp, int flags);
1de2db8f 384#endif
8d14a25c 385 /**
4f57fa8c 386 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 387 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
388 */
389 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
390 int64_t *pos, int64_t pos_limit);
76c56376
MN
391
392 /**
393 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
394 */
de6d9b64 395 int flags;
76c56376
MN
396
397 /**
398 * If extensions are defined, then no probe is done. You should
399 * usually not use extension format guessing because it is not
400 * reliable enough
401 */
b9a281db 402 const char *extensions;
76c56376
MN
403
404 /**
405 * General purpose read-only value that the format can use.
406 */
b9a281db 407 int value;
fb2758c8 408
76c56376
MN
409 /**
410 * Start/resume playing - only meaningful if using a network-based format
411 * (RTSP).
412 */
fb2758c8
FB
413 int (*read_play)(struct AVFormatContext *);
414
76c56376
MN
415 /**
416 * Pause playing - only meaningful if using a network-based format
417 * (RTSP).
418 */
fb2758c8
FB
419 int (*read_pause)(struct AVFormatContext *);
420
c1854592 421 const struct AVCodecTag * const *codec_tag;
7caf0cc6 422
1de2db8f 423 /**
49bd8e4b 424 * Seek to timestamp ts.
1de2db8f
MN
425 * Seeking will be done so that the point from which all active streams
426 * can be presented successfully will be closest to ts and within min/max_ts.
427 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
428 */
882fb0a3 429 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 430
451d566f 431#if FF_API_OLD_METADATA2
719e721a 432 const AVMetadataConv *metadata_conv;
03700d39 433#endif
f610a9f2 434
5dc82144
AK
435 const AVClass *priv_class; ///< AVClass for the private context
436
b9a281db
FB
437 /* private fields */
438 struct AVInputFormat *next;
439} AVInputFormat;
de6d9b64 440
57004ff1
AJ
441enum AVStreamParseType {
442 AVSTREAM_PARSE_NONE,
443 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 444 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 445 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 446 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
447};
448
fb2758c8
FB
449typedef struct AVIndexEntry {
450 int64_t pos;
451 int64_t timestamp;
452#define AVINDEX_KEYFRAME 0x0001
30a43f2d 453 int flags:2;
4f57fa8c
DB
454 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).
455 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
456} AVIndexEntry;
457
90c2295b
ES
458#define AV_DISPOSITION_DEFAULT 0x0001
459#define AV_DISPOSITION_DUB 0x0002
460#define AV_DISPOSITION_ORIGINAL 0x0004
461#define AV_DISPOSITION_COMMENT 0x0008
462#define AV_DISPOSITION_LYRICS 0x0010
463#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
464
465/**
466 * Track should be used during playback by default.
467 * Useful for subtitle track that should be displayed
468 * even when user did not explicitly ask for subtitles.
469 */
7a617a86 470#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
471#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
472#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 473#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
90c2295b 474
ba66ae94
MN
475/**
476 * Stream structure.
477 * New fields can be added to the end with minor version bumps.
8bfb108b 478 * Removal, reordering and changes to existing fields require a major
ba66ae94 479 * version bump.
8bfb108b 480 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 481 */
de6d9b64 482typedef struct AVStream {
43d414ba 483 int index; /**< stream index in AVFormatContext */
4f57fa8c 484 int id; /**< format-specific stream ID */
43d414ba 485 AVCodecContext *codec; /**< codec context */
b4b87d48 486 /**
22e77e44
DB
487 * Real base framerate of the stream.
488 * This is the lowest framerate with which all timestamps can be
864ff8c1 489 * represented accurately (it is the least common multiple of all
22e77e44
DB
490 * framerates in the stream). Note, this value is just a guess!
491 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 492 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
493 */
494 AVRational r_frame_rate;
de6d9b64 495 void *priv_data;
82583548 496
b9a281db 497 /* internal data used in av_find_stream_info() */
82583548 498 int64_t first_dts;
76c56376
MN
499
500 /**
501 * encoding: pts generation when outputting stream
502 */
a9fd2b19 503 struct AVFrac pts;
5b28c8c3
MN
504
505 /**
8bfb108b
DB
506 * This is the fundamental unit of time (in seconds) in terms
507 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 508 * time base should be 1/framerate and timestamp increments should be 1.
5d820db2
RD
509 * decoding: set by libavformat
510 * encoding: set by libavformat in av_write_header
5b28c8c3 511 */
9ee91c2f 512 AVRational time_base;
43d414ba 513 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 514 /* ffmpeg.c private use */
4f57fa8c
DB
515 int stream_copy; /**< If set, just copy stream. */
516 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 517
b4aea108 518 //FIXME move stuff to a flags field?
76c56376
MN
519 /**
520 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
521 * MN: dunno if that is the right place for it
522 */
115329f1 523 float quality;
76c56376 524
6d96a9b9 525 /**
8bfb108b
DB
526 * Decoding: pts of the first frame of the stream, in stream time base.
527 * Only set this if you are absolutely 100% sure that the value you set
528 * it to really is the pts of the first frame.
4854c253 529 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 530 */
115329f1 531 int64_t start_time;
76c56376 532
e26381b6 533 /**
8bfb108b 534 * Decoding: duration of the stream, in stream time base.
e26381b6 535 * If a source file does not specify a duration, but does specify
4f57fa8c 536 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 537 */
ee404803 538 int64_t duration;
fb2758c8
FB
539
540 /* av_read_frame() support */
57004ff1 541 enum AVStreamParseType need_parsing;
fb2758c8 542 struct AVCodecParserContext *parser;
6ec87caa 543
fb2758c8 544 int64_t cur_dts;
635fbcb1
MN
545 int last_IP_duration;
546 int64_t last_IP_pts;
fb2758c8 547 /* av_seek_frame() support */
4f57fa8c
DB
548 AVIndexEntry *index_entries; /**< Only used if the format does not
549 support seeking natively. */
fb2758c8 550 int nb_index_entries;
191e8ca7 551 unsigned int index_entries_allocated_size;
115329f1 552
b4b87d48 553 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 554
4f57fa8c 555 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
556
557 AVProbeData probe_data;
0d84a8f6
BC
558#define MAX_REORDER_DELAY 16
559 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
560
561 /**
562 * sample aspect ratio (0 if unknown)
563 * - encoding: Set by user.
564 * - decoding: Set by libavformat.
565 */
566 AVRational sample_aspect_ratio;
f526adaf 567
e232c252 568 AVMetadata *metadata;
3a41c2f7 569
31769dad
VP
570 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
571 /* external applications; try to use something else if at all possible. */
3a41c2f7
MN
572 const uint8_t *cur_ptr;
573 int cur_len;
574 AVPacket cur_pkt;
27ca0a79
IS
575
576 // Timestamp generation support:
577 /**
578 * Timestamp corresponding to the last dts sync point.
579 *
580 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
581 * a DTS is received from the underlying container. Otherwise set to
582 * AV_NOPTS_VALUE by default.
583 */
584 int64_t reference_dts;
86cb7e33
BC
585
586 /**
587 * Number of packets to buffer for codec probing
588 * NOT PART OF PUBLIC API
589 */
48616887 590#define MAX_PROBE_PACKETS 2500
86cb7e33 591 int probe_packets;
ddce56ef
MN
592
593 /**
e07b882b 594 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
595 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
596 */
e07b882b 597 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
598
599 /**
600 * Average framerate
601 */
602 AVRational avg_frame_rate;
6c6e6ef5
MN
603
604 /**
605 * Number of frames that have been demuxed during av_find_stream_info()
606 */
607 int codec_info_nb_frames;
fd0368e7
AJ
608
609 /**
610 * Stream informations used internally by av_find_stream_info()
611 */
612#define MAX_STD_TIMEBASES (60*12+5)
613 struct {
614 int64_t last_dts;
615 int64_t duration_gcd;
616 int duration_count;
617 double duration_error[MAX_STD_TIMEBASES];
618 int64_t codec_info_duration;
619 } *info;
de6d9b64
FB
620} AVStream;
621
15afa396
NS
622#define AV_PROGRAM_RUNNING 1
623
ba66ae94 624/**
ba66ae94 625 * New fields can be added to the end with minor version bumps.
8bfb108b 626 * Removal, reordering and changes to existing fields require a major
ba66ae94 627 * version bump.
8bfb108b 628 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 629 */
15afa396
NS
630typedef struct AVProgram {
631 int id;
15afa396
NS
632 int flags;
633 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
634 unsigned int *stream_index;
635 unsigned int nb_stream_indexes;
e232c252 636 AVMetadata *metadata;
15afa396
NS
637} AVProgram;
638
43d414ba 639#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
640 (streams are added dynamically) */
641
79d7836a 642typedef struct AVChapter {
4f57fa8c
DB
643 int id; ///< unique ID to identify the chapter
644 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 645 int64_t start, end; ///< chapter start/end time in time_base units
e232c252 646 AVMetadata *metadata;
79d7836a
AK
647} AVChapter;
648
252f17e2 649/**
4f57fa8c 650 * Format I/O context.
252f17e2 651 * New fields can be added to the end with minor version bumps.
8bfb108b 652 * Removal, reordering and changes to existing fields require a major
252f17e2 653 * version bump.
8bfb108b 654 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 655 */
de6d9b64 656typedef struct AVFormatContext {
1447aac4 657 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 658 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
659 struct AVInputFormat *iformat;
660 struct AVOutputFormat *oformat;
de6d9b64 661 void *priv_data;
ae628ec1 662 AVIOContext *pb;
db69c2e5 663 unsigned int nb_streams;
38aab35f 664 AVStream **streams;
43d414ba 665 char filename[1024]; /**< input or output filename */
de6d9b64 666 /* stream info */
4568325a 667 int64_t timestamp;
6a58e151 668
4f57fa8c
DB
669 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
670 /* private data for pts handling (do not modify directly). */
76c56376
MN
671 /**
672 * This buffer is only needed when packets were already buffered but
673 * not decoded, for example to get the codec parameters in MPEG
674 * streams.
675 */
ee404803
FB
676 struct AVPacketList *packet_buffer;
677
76c56376
MN
678 /**
679 * Decoding: position of the first frame of the component, in
680 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
681 * It is deduced from the AVStream values.
682 */
115329f1 683 int64_t start_time;
76c56376
MN
684
685 /**
686 * Decoding: duration of the stream, in AV_TIME_BASE fractional
687 * seconds. Only set this value if you know none of the individual stream
688 * durations and also dont set any of them. This is deduced from the
689 * AVStream values if not set.
690 */
ee404803 691 int64_t duration;
76c56376
MN
692
693 /**
694 * decoding: total file size, 0 if unknown
695 */
ee404803 696 int64_t file_size;
76c56376
MN
697
698 /**
699 * Decoding: total stream bitrate in bit/s, 0 if not
700 * available. Never set it directly if the file_size and the
6001dad6 701 * duration are known as Libav can compute it automatically.
76c56376 702 */
ee404803 703 int bit_rate;
fb2758c8
FB
704
705 /* av_read_frame() support */
706 AVStream *cur_st;
fb2758c8 707
fb2758c8 708 /* av_seek_frame() support */
ec906fcd 709 int64_t data_offset; /**< offset of the first packet */
115329f1 710
2db3c638 711 int mux_rate;
92400be2 712 unsigned int packet_size;
17c88cb0
MN
713 int preload;
714 int max_delay;
8108551a 715
115329f1
DB
716#define AVFMT_NOOUTPUTLOOP -1
717#define AVFMT_INFINITEOUTPUTLOOP 0
76c56376
MN
718 /**
719 * number of times to loop output in formats that support it
720 */
8108551a 721 int loop_output;
115329f1 722
30bc6613 723 int flags;
22e77e44 724#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
725#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
726#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 727#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
728#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
729#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
28734ac9
MS
730#if FF_API_FLAG_RTP_HINT
731#define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
732#endif
5894e1bb
VP
733
734 int loop_input;
76c56376
MN
735
736 /**
737 * decoding: size of data to probe; encoding: unused.
738 */
9e6c9470 739 unsigned int probesize;
a44b3c4d
MN
740
741 /**
4f57fa8c
DB
742 * Maximum time (in AV_TIME_BASE units) during which the input should
743 * be analyzed in av_find_stream_info().
a44b3c4d
MN
744 */
745 int max_analyze_duration;
c964c2c7
RD
746
747 const uint8_t *key;
748 int keylen;
15afa396
NS
749
750 unsigned int nb_programs;
751 AVProgram **programs;
62600469
MN
752
753 /**
754 * Forced video codec_id.
4f57fa8c 755 * Demuxing: Set by user.
62600469
MN
756 */
757 enum CodecID video_codec_id;
76c56376 758
62600469
MN
759 /**
760 * Forced audio codec_id.
4f57fa8c 761 * Demuxing: Set by user.
62600469
MN
762 */
763 enum CodecID audio_codec_id;
76c56376 764
62600469
MN
765 /**
766 * Forced subtitle codec_id.
4f57fa8c 767 * Demuxing: Set by user.
62600469
MN
768 */
769 enum CodecID subtitle_codec_id;
3dea63bd
PK
770
771 /**
22e77e44
DB
772 * Maximum amount of memory in bytes to use for the index of each stream.
773 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
774 * needed to maintain a smaller size. This can lead to slower or less
775 * accurate seeking (depends on demuxer).
4f57fa8c 776 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
777 * this.
778 * muxing : unused
779 * demuxing: set by user
780 */
781 unsigned int max_index_size;
ab8ab30c
RP
782
783 /**
ffa71b2b 784 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 785 * obtained from realtime capture devices.
ab8ab30c
RP
786 */
787 unsigned int max_picture_buffer;
79d7836a 788
fbabf1e9 789 unsigned int nb_chapters;
79d7836a 790 AVChapter **chapters;
45b2b05f
MN
791
792 /**
4f57fa8c 793 * Flags to enable debugging.
45b2b05f
MN
794 */
795 int debug;
796#define FF_FDEBUG_TS 0x0001
0bef08e5
MN
797
798 /**
4f57fa8c 799 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
800 * This buffer is used for buffering packets until the codec can
801 * be identified, as parsing cannot be done without knowing the
802 * codec.
803 */
804 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
805 struct AVPacketList *raw_packet_buffer_end;
806
807 struct AVPacketList *packet_buffer_end;
47146dfb 808
e232c252 809 AVMetadata *metadata;
af122d6a
BC
810
811 /**
812 * Remaining size available for raw_packet_buffer, in bytes.
813 * NOT PART OF PUBLIC API
814 */
48616887 815#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 816 int raw_packet_buffer_remaining_size;
b8819c85
MS
817
818 /**
819 * Start time of the stream in real world time, in microseconds
820 * since the unix epoch (00:00 1st January 1970). That is, pts=0
821 * in the stream was captured at this real world time.
822 * - encoding: Set by user.
823 * - decoding: Unused.
824 */
825 int64_t start_time_realtime;
30315a8d
AC
826
827 /**
828 * decoding: number of frames used to probe fps
829 */
830 int fps_probe_size;
de6d9b64
FB
831} AVFormatContext;
832
833typedef struct AVPacketList {
834 AVPacket pkt;
835 struct AVPacketList *next;
836} AVPacketList;
837
aeedac95
SS
838/**
839 * If f is NULL, returns the first registered input format,
22e77e44 840 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
841 * or NULL if f is the last one.
842 */
84be6e72 843AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
844
845/**
846 * If f is NULL, returns the first registered output format,
22e77e44 847 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
848 * or NULL if f is the last one.
849 */
84be6e72 850AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 851
a9bf9d8e
AK
852#if FF_API_GUESS_IMG2_CODEC
853attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
854#endif
290c5fa6 855
22e77e44
DB
856/* XXX: Use automatic init with either ELF sections or C file parser */
857/* modules. */
de6d9b64 858
b9a281db 859/* utils.c */
b9a281db
FB
860void av_register_input_format(AVInputFormat *format);
861void av_register_output_format(AVOutputFormat *format);
f48b0fa2
SS
862
863/**
49bd8e4b
MR
864 * Return the output format in the list of registered output formats
865 * which best matches the provided parameters, or return NULL if
f48b0fa2
SS
866 * there is no match.
867 *
868 * @param short_name if non-NULL checks if short_name matches with the
869 * names of the registered formats
870 * @param filename if non-NULL checks if filename terminates with the
871 * extensions of the registered formats
872 * @param mime_type if non-NULL checks if mime_type matches with the
873 * MIME type of the registered formats
874 */
a1f547b9 875AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
876 const char *filename,
877 const char *mime_type);
3217cb42
PI
878
879/**
49bd8e4b 880 * Guess the codec ID based upon muxer and filename.
3217cb42 881 */
115329f1 882enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 883 const char *filename, const char *mime_type,
72415b2a 884 enum AVMediaType type);
de6d9b64 885
3217cb42 886/**
49bd8e4b 887 * Send a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
888 *
889 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
890 * @param buf buffer
891 * @param size buffer size
750f0e1f 892 *
863c4716 893 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
3217cb42 894 */
fb2758c8 895void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
896
897/**
49bd8e4b 898 * Send a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
899 *
900 * @param avcl A pointer to an arbitrary struct of which the first field is a
901 * pointer to an AVClass struct.
902 * @param level The importance level of the message, lower values signifying
903 * higher importance.
904 * @param buf buffer
905 * @param size buffer size
906 *
863c4716 907 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
750f0e1f
PI
908 */
909void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
910
911/**
49bd8e4b 912 * Send a nice dump of a packet to the specified file stream.
750f0e1f
PI
913 *
914 * @param f The file stream pointer where the dump should be sent to.
3217cb42 915 * @param pkt packet to dump
4f57fa8c 916 * @param dump_payload True if the payload must be displayed, too.
863c4716 917 * @param st AVStream that the packet belongs to
3217cb42 918 */
863c4716
MS
919void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
920
de6d9b64 921
750f0e1f 922/**
49bd8e4b 923 * Send a nice dump of a packet to the log.
750f0e1f
PI
924 *
925 * @param avcl A pointer to an arbitrary struct of which the first field is a
926 * pointer to an AVClass struct.
927 * @param level The importance level of the message, lower values signifying
928 * higher importance.
929 * @param pkt packet to dump
4f57fa8c 930 * @param dump_payload True if the payload must be displayed, too.
863c4716 931 * @param st AVStream that the packet belongs to
750f0e1f 932 */
863c4716
MS
933void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
934 AVStream *st);
935
c5704b2b
AK
936#if FF_API_PKT_DUMP
937attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
863c4716
MS
938attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
939 int dump_payload);
17ca374c 940#endif
750f0e1f 941
4815e246 942/**
49bd8e4b 943 * Initialize libavformat and register all the muxers, demuxers and
4815e246
SS
944 * protocols. If you do not call this function, then you can select
945 * exactly which formats you want to support.
946 *
947 * @see av_register_input_format()
948 * @see av_register_output_format()
5d377501 949 * @see av_register_protocol()
4815e246 950 */
94988531 951void av_register_all(void);
de6d9b64 952
7693b93e 953/**
49bd8e4b 954 * Get the CodecID for the given codec tag tag.
7693b93e
SS
955 * If no codec id is found returns CODEC_ID_NONE.
956 *
957 * @param tags list of supported codec_id-codec_tag pairs, as stored
958 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
959 */
15545a09 960enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
7693b93e
SS
961
962/**
49bd8e4b 963 * Get the codec tag for the given codec id id.
7693b93e
SS
964 * If no codec tag is found returns 0.
965 *
966 * @param tags list of supported codec_id-codec_tag pairs, as stored
967 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
968 */
15545a09 969unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 970
b9a281db 971/* media file input */
3217cb42
PI
972
973/**
49bd8e4b 974 * Find AVInputFormat based on the short name of the input format.
3217cb42 975 */
b9a281db 976AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
977
978/**
49bd8e4b 979 * Guess the file format.
3217cb42 980 *
4f57fa8c
DB
981 * @param is_opened Whether the file is already opened; determines whether
982 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 983 */
94988531 984AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
985
986/**
49bd8e4b 987 * Guess the file format.
8e2ee182
RD
988 *
989 * @param is_opened Whether the file is already opened; determines whether
990 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
991 * @param score_max A probe score larger that this is required to accept a
992 * detection, the variable is set to the actual detection
993 * score afterwards.
994 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
995 * to retry with a larger probe buffer.
996 */
997AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
998
999/**
3940caad
AH
1000 * Probe a bytestream to determine the input format. Each time a probe returns
1001 * with a score that is too low, the probe buffer size is increased and another
1002 * attempt is made. When the maximum probe size is reached, the input format
1003 * with the highest score is returned.
1004 *
1005 * @param pb the bytestream to probe
1006 * @param fmt the input format is put here
1007 * @param filename the filename of the stream
1008 * @param logctx the log context
1009 * @param offset the offset within the bytestream to probe from
1010 * @param max_probe_size the maximum probe buffer size (zero for default)
1011 * @return 0 in case of success, a negative value corresponding to an
1012 * AVERROR code otherwise
1013 */
ae628ec1 1014int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1015 const char *filename, void *logctx,
1016 unsigned int offset, unsigned int max_probe_size);
1017
1018/**
49bd8e4b 1019 * Allocate all the structures needed to read an input stream.
3217cb42
PI
1020 * This does not open the needed codecs for decoding the stream[s].
1021 */
115329f1 1022int av_open_input_stream(AVFormatContext **ic_ptr,
ae628ec1 1023 AVIOContext *pb, const char *filename,
da24c5e3 1024 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
1025
1026/**
49bd8e4b 1027 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
1028 * header (if present) is read.
1029 *
4f57fa8c
DB
1030 * @param ic_ptr The opened media file handle is put here.
1031 * @param filename filename to open
1032 * @param fmt If non-NULL, force the file format to use.
3217cb42 1033 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
1034 * @param ap Additional parameters needed when opening the file
1035 * (NULL if default).
4f57fa8c 1036 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 1037 */
115329f1 1038int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
1039 AVInputFormat *fmt,
1040 int buf_size,
1041 AVFormatParameters *ap);
88a28965 1042
88808c60 1043/**
49bd8e4b 1044 * Allocate an AVFormatContext.
f124b087
MS
1045 * avformat_free_context() can be used to free the context and everything
1046 * allocated by the framework within it.
88808c60 1047 */
88a28965 1048AVFormatContext *avformat_alloc_context(void);
b9a281db 1049
3217cb42 1050/**
49bd8e4b 1051 * Read packets of a media file to get stream information. This
3217cb42 1052 * is useful for file formats with no headers such as MPEG. This
22e77e44 1053 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
1054 * frame mode.
1055 * The logical file position is not changed by this function;
1056 * examined packets may be buffered for later processing.
1057 *
1058 * @param ic media file handle
4f57fa8c
DB
1059 * @return >=0 if OK, AVERROR_xxx on error
1060 * @todo Let the user decide somehow what information is needed so that
1061 * we do not waste time getting stuff the user does not need.
3217cb42 1062 */
b9a281db 1063int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
1064
1065/**
9128ae08
NG
1066 * Find the "best" stream in the file.
1067 * The best stream is determined according to various heuristics as the most
1068 * likely to be what the user expects.
1069 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1070 * default decoder for the stream's codec; streams for which no decoder can
1071 * be found are ignored.
1072 *
1073 * @param ic media file handle
1074 * @param type stream type: video, audio, subtitles, etc.
1075 * @param wanted_stream_nb user-requested stream number,
1076 * or -1 for automatic selection
1077 * @param related_stream try to find a stream related (eg. in the same
1078 * program) to this one, or -1 if none
1079 * @param decoder_ret if non-NULL, returns the decoder for the
1080 * selected stream
1081 * @param flags flags; none are currently defined
1082 * @return the non-negative stream number in case of success,
1083 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1084 * could be found,
1085 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1086 * @note If av_find_best_stream returns successfully and decoder_ret is not
1087 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1088 */
1089int av_find_best_stream(AVFormatContext *ic,
1090 enum AVMediaType type,
1091 int wanted_stream_nb,
1092 int related_stream,
1093 AVCodec **decoder_ret,
1094 int flags);
1095
1096/**
49bd8e4b 1097 * Read a transport packet from a media file.
3217cb42 1098 *
864ff8c1 1099 * This function is obsolete and should never be used.
3217cb42
PI
1100 * Use av_read_frame() instead.
1101 *
1102 * @param s media file handle
1103 * @param pkt is filled
4f57fa8c 1104 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1105 */
de6d9b64 1106int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1107
1108/**
49bd8e4b 1109 * Return the next frame of a stream.
4faf628f
MN
1110 * This function returns what is stored in the file, and does not validate
1111 * that what is there are valid frames for the decoder. It will split what is
1112 * stored in the file into frames and return one for each call. It will not
1113 * omit invalid data between valid frames so as to give the decoder the maximum
1114 * information possible for decoding.
3217cb42
PI
1115 *
1116 * The returned packet is valid
1117 * until the next av_read_frame() or until av_close_input_file() and
1118 * must be freed with av_free_packet. For video, the packet contains
1119 * exactly one frame. For audio, it contains an integer number of
1120 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1121 * data). If the audio frames have a variable size (e.g. MPEG audio),
1122 * then it contains one frame.
1123 *
1124 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1125 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1126 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1127 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1128 * decompress the payload.
1129 *
4f57fa8c 1130 * @return 0 if OK, < 0 on error or end of file
3217cb42 1131 */
fb2758c8 1132int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1133
1134/**
49bd8e4b 1135 * Seek to the keyframe at timestamp.
3217cb42
PI
1136 * 'timestamp' in 'stream_index'.
1137 * @param stream_index If stream_index is (-1), a default
1138 * stream is selected, and timestamp is automatically converted
1139 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1140 * @param timestamp Timestamp in AVStream.time_base units
1141 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1142 * @param flags flags which select direction and seeking mode
1143 * @return >= 0 on success
1144 */
78cb7273
DB
1145int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1146 int flags);
3217cb42
PI
1147
1148/**
49bd8e4b 1149 * Seek to timestamp ts.
d04768fa
MN
1150 * Seeking will be done so that the point from which all active streams
1151 * can be presented successfully will be closest to ts and within min/max_ts.
1152 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1153 *
22e77e44 1154 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1155 * are the file position (this may not be supported by all demuxers).
22e77e44 1156 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1157 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1158 * Otherwise all timestamps are in units of the stream selected by stream_index
1159 * or if stream_index is -1, in AV_TIME_BASE units.
1160 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1161 * keyframes (this may not be supported by all demuxers).
1162 *
22e77e44 1163 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1164 * @param min_ts smallest acceptable timestamp
1165 * @param ts target timestamp
1166 * @param max_ts largest acceptable timestamp
1167 * @param flags flags
32e543f8 1168 * @return >=0 on success, error code otherwise
998b6f7c 1169 *
8a4d7a30 1170 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1171 * Thus do not use this yet. It may change at any time, do not expect
1172 * ABI compatibility yet!
d04768fa
MN
1173 */
1174int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1175
1176/**
49bd8e4b 1177 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1178 * current position.
3217cb42 1179 */
fb2758c8 1180int av_read_play(AVFormatContext *s);
3217cb42
PI
1181
1182/**
49bd8e4b 1183 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1184 *
1185 * Use av_read_play() to resume it.
1186 */
fb2758c8 1187int av_read_pause(AVFormatContext *s);
3217cb42
PI
1188
1189/**
49bd8e4b 1190 * Free a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1191 * @param s context to free
1192 */
1193void av_close_input_stream(AVFormatContext *s);
1194
1195/**
49bd8e4b 1196 * Close a media file (but not its codecs).
3217cb42
PI
1197 *
1198 * @param s media file handle
1199 */
de6d9b64 1200void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1201
1202/**
f124b087
MS
1203 * Free an AVFormatContext and all its streams.
1204 * @param s context to free
1205 */
1206void avformat_free_context(AVFormatContext *s);
1207
1208/**
49bd8e4b 1209 * Add a new stream to a media file.
3217cb42
PI
1210 *
1211 * Can only be called in the read_header() function. If the flag
1212 * AVFMTCTX_NOHEADER is in the format context, then new streams
1213 * can be added in read_packet too.
1214 *
1215 * @param s media file handle
4f57fa8c 1216 * @param id file-format-dependent stream ID
3217cb42 1217 */
b9a281db 1218AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 1219AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1220
1221/**
b3190529
RD
1222 * Set the pts for a given stream. If the new values would be invalid
1223 * (<= 0), it leaves the AVStream unchanged.
3217cb42
PI
1224 *
1225 * @param s stream
1226 * @param pts_wrap_bits number of bits effectively used by the pts
1227 * (used for wrap control, 33 is the value for MPEG)
1228 * @param pts_num numerator to convert to seconds (MPEG: 1)
1229 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1230 */
9ee91c2f 1231void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1232 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1233
3ba1438d
MN
1234#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1235#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1236#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1237#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1238
b754978a 1239int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1240
1241/**
49bd8e4b 1242 * Get the index for a specific timestamp.
4f57fa8c
DB
1243 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1244 * to the timestamp which is <= the requested one, if backward
1245 * is 0, then it will be >=
3217cb42
PI
1246 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1247 * @return < 0 if no such timestamp could be found
1248 */
dc56fc38 1249int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1250
1251/**
49bd8e4b 1252 * Add an index entry into a sorted list. Update the entry if the list
4f57fa8c 1253 * already contains it.
3217cb42 1254 *
4f57fa8c 1255 * @param timestamp timestamp in the time base of the given stream
3217cb42 1256 */
78cb7273
DB
1257int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1258 int size, int distance, int flags);
3217cb42
PI
1259
1260/**
49bd8e4b 1261 * Perform a binary search using av_index_search_timestamp() and
3673f4ab 1262 * AVInputFormat.read_timestamp().
78cb7273
DB
1263 * This is not supposed to be called directly by a user application,
1264 * but by demuxers.
3217cb42
PI
1265 * @param target_ts target timestamp in the time base of the given stream
1266 * @param stream_index stream number
1267 */
78cb7273
DB
1268int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1269 int64_t target_ts, int flags);
3217cb42
PI
1270
1271/**
49bd8e4b 1272 * Update cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1273 *
4f57fa8c
DB
1274 * Stream ref_st unchanged, others set cur_dts in their native time base.
1275 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1276 * @param timestamp new dts expressed in time_base of param ref_st
1277 * @param ref_st reference stream giving time_base of param timestamp
1278 */
22ffac70 1279void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1280
1281/**
49bd8e4b 1282 * Perform a binary search using read_timestamp().
78cb7273
DB
1283 * This is not supposed to be called directly by a user application,
1284 * but by demuxers.
3217cb42
PI
1285 * @param target_ts target timestamp in the time base of the given stream
1286 * @param stream_index stream number
1287 */
78cb7273
DB
1288int64_t av_gen_search(AVFormatContext *s, int stream_index,
1289 int64_t target_ts, int64_t pos_min,
1290 int64_t pos_max, int64_t pos_limit,
1291 int64_t ts_min, int64_t ts_max,
1292 int flags, int64_t *ts_ret,
1293 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1294
76c56376
MN
1295/**
1296 * media file output
1297 */
290c5fa6 1298int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1299
1300/**
f3bfe388
MR
1301 * Split a URL string into components.
1302 *
1303 * The pointers to buffers for storing individual components may be null,
1304 * in order to ignore that component. Buffers for components not found are
1305 * set to empty strings. If the port is not found, it is set to a negative
1306 * value.
1307 *
1308 * @param proto the buffer for the protocol
1309 * @param proto_size the size of the proto buffer
1310 * @param authorization the buffer for the authorization
1311 * @param authorization_size the size of the authorization buffer
1312 * @param hostname the buffer for the host name
1313 * @param hostname_size the size of the hostname buffer
1314 * @param port_ptr a pointer to store the port number in
1315 * @param path the buffer for the path
1316 * @param path_size the size of the path buffer
1317 * @param url the URL to split
1318 */
1319void av_url_split(char *proto, int proto_size,
1320 char *authorization, int authorization_size,
1321 char *hostname, int hostname_size,
1322 int *port_ptr,
1323 char *path, int path_size,
1324 const char *url);
1325
1326/**
49bd8e4b 1327 * Allocate the stream private data and write the stream header to an
755bfeab 1328 * output media file.
5d820db2
RD
1329 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1330 * but for some formats it might also be some other time base
3217cb42
PI
1331 *
1332 * @param s media file handle
4f57fa8c 1333 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1334 */
b9a281db 1335int av_write_header(AVFormatContext *s);
3217cb42
PI
1336
1337/**
49bd8e4b 1338 * Write a packet to an output media file.
3217cb42
PI
1339 *
1340 * The packet shall contain one audio or video frame.
78cb7273
DB
1341 * The packet must be correctly interleaved according to the container
1342 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1343 *
1344 * @param s media file handle
78cb7273
DB
1345 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1346 dts/pts, ...
4f57fa8c 1347 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1348 */
e928649b 1349int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1350
1351/**
49bd8e4b 1352 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1353 *
1354 * The packet must contain one audio or video frame.
22e77e44 1355 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1356 * call av_write_frame() instead as it is slightly faster. It is also important
1357 * to keep in mind that completely non-interleaved input will need huge amounts
1358 * of memory to interleave with this, so it is preferable to interleave at the
1359 * demuxer level.
3217cb42
PI
1360 *
1361 * @param s media file handle
78cb7273
DB
1362 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1363 dts/pts, ...
4f57fa8c 1364 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1365 */
3c895fc0 1366int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1367
1368/**
49bd8e4b 1369 * Interleave a packet per dts in an output media file.
3217cb42 1370 *
78cb7273 1371 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1372 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1373 * on them is still safe.
3217cb42
PI
1374 *
1375 * @param s media file handle
1376 * @param out the interleaved packet will be output here
9a58234f 1377 * @param pkt the input packet
3217cb42
PI
1378 * @param flush 1 if no further packets are available as input and all
1379 * remaining packets should be output
1380 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1381 * < 0 if an error occurred
3217cb42 1382 */
78cb7273
DB
1383int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1384 AVPacket *pkt, int flush);
e928649b 1385
3217cb42 1386/**
49bd8e4b 1387 * Write the stream trailer to an output media file and free the
2b75bde6 1388 * file private data.
3217cb42 1389 *
dc76fe13
RD
1390 * May only be called after a successful call to av_write_header.
1391 *
3217cb42 1392 * @param s media file handle
4f57fa8c 1393 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1394 */
b9a281db 1395int av_write_trailer(AVFormatContext *s);
de6d9b64 1396
610219a5
AK
1397#if FF_API_DUMP_FORMAT
1398attribute_deprecated void dump_format(AVFormatContext *ic,
1399 int index,
1400 const char *url,
1401 int is_output);
1402#endif
1403
1404void av_dump_format(AVFormatContext *ic,
1405 int index,
1406 const char *url,
1407 int is_output);
3217cb42 1408
f6c7375a 1409#if FF_API_PARSE_DATE
3217cb42 1410/**
49bd8e4b 1411 * Parse datestr and return a corresponding number of microseconds.
f6c7375a 1412 *
f9436161 1413 * @param datestr String representing a date or a duration.
f6c7375a
SS
1414 * See av_parse_time() for the syntax of the provided string.
1415 * @deprecated in favor of av_parse_time()
3217cb42 1416 */
f6c7375a 1417attribute_deprecated
0c1a9eda 1418int64_t parse_date(const char *datestr, int duration);
f6c7375a 1419#endif
de6d9b64 1420
76c56376
MN
1421/**
1422 * Get the current time in microseconds.
1423 */
0c1a9eda 1424int64_t av_gettime(void);
94988531 1425
ab0287fc 1426#if FF_API_FIND_INFO_TAG
3217cb42 1427/**
ab0287fc 1428 * @deprecated use av_find_info_tag in libavutil instead.
3217cb42 1429 */
ab0287fc
AK
1430attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1431#endif
de6d9b64 1432
3217cb42 1433/**
49bd8e4b 1434 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1435 *
3217cb42
PI
1436 * Also handles the '%0nd' format where 'n' is the total number
1437 * of digits and '%%'.
1438 *
1439 * @param buf destination buffer
1440 * @param buf_size destination buffer size
1441 * @param path numbered sequence string
8ea0e802 1442 * @param number frame number
4f57fa8c 1443 * @return 0 if OK, -1 on format error
3217cb42 1444 */
5c07cf53
MB
1445int av_get_frame_filename(char *buf, int buf_size,
1446 const char *path, int number);
3217cb42
PI
1447
1448/**
49bd8e4b 1449 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1450 *
1451 * @param filename possible numbered sequence string
4f57fa8c 1452 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1453 */
5c07cf53 1454int av_filename_number_test(const char *filename);
96baaa6a 1455
c5388c07 1456/**
49bd8e4b 1457 * Generate an SDP for an RTP session.
c5388c07
LA
1458 *
1459 * @param ac array of AVFormatContexts describing the RTP streams. If the
1460 * array is composed by only one context, such context can contain
1461 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1462 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1463 * must contain only one AVStream.
8767b80f 1464 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1465 * @param buf buffer where the SDP will be stored (must be allocated by
1466 * the caller)
8767b80f 1467 * @param size the size of the buffer
4f57fa8c 1468 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1469 */
c234d40b 1470int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe
AK
1471
1472#if FF_API_SDP_CREATE
1473attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1474#endif
c5388c07 1475
1a70d127 1476/**
49bd8e4b 1477 * Return a positive value if the given filename has one of the given
1a70d127
SS
1478 * extensions, 0 otherwise.
1479 *
1480 * @param extensions a comma-separated list of filename extensions
1481 */
1482int av_match_ext(const char *filename, const char *extensions);
1483
98790382 1484#endif /* AVFORMAT_AVFORMAT_H */