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