Update pathscale compiler detection
[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
f7cf0f31 25#define LIBAVFORMAT_VERSION_MINOR 78
0c41d554 26#define LIBAVFORMAT_VERSION_MICRO 5
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
366 * AVFMTCTX_NOHEADER is used.
367 * @return 0 on success, < 0 on error.
368 * When returning an error, pkt must not have been allocated
369 * or must be freed before returning
370 */
de6d9b64 371 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
372
373 /**
374 * Close the stream. The AVFormatContext and AVStreams are not
375 * freed by this function
376 */
de6d9b64 377 int (*read_close)(struct AVFormatContext *);
1de2db8f
MN
378
379#if LIBAVFORMAT_VERSION_MAJOR < 53
115329f1 380 /**
4f57fa8c
DB
381 * Seek to a given timestamp relative to the frames in
382 * stream component stream_index.
22e77e44
DB
383 * @param stream_index Must not be -1.
384 * @param flags Selects which direction should be preferred if no exact
385 * match is available.
05ce0f11 386 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 387 */
115329f1 388 int (*read_seek)(struct AVFormatContext *,
3ba1438d 389 int stream_index, int64_t timestamp, int flags);
1de2db8f 390#endif
8d14a25c 391 /**
4f57fa8c 392 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 393 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
394 */
395 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
396 int64_t *pos, int64_t pos_limit);
76c56376
MN
397
398 /**
399 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
400 */
de6d9b64 401 int flags;
76c56376
MN
402
403 /**
404 * If extensions are defined, then no probe is done. You should
405 * usually not use extension format guessing because it is not
406 * reliable enough
407 */
b9a281db 408 const char *extensions;
76c56376
MN
409
410 /**
411 * General purpose read-only value that the format can use.
412 */
b9a281db 413 int value;
fb2758c8 414
76c56376
MN
415 /**
416 * Start/resume playing - only meaningful if using a network-based format
417 * (RTSP).
418 */
fb2758c8
FB
419 int (*read_play)(struct AVFormatContext *);
420
76c56376
MN
421 /**
422 * Pause playing - only meaningful if using a network-based format
423 * (RTSP).
424 */
fb2758c8
FB
425 int (*read_pause)(struct AVFormatContext *);
426
c1854592 427 const struct AVCodecTag * const *codec_tag;
7caf0cc6 428
1de2db8f 429 /**
49bd8e4b 430 * Seek to timestamp ts.
1de2db8f
MN
431 * Seeking will be done so that the point from which all active streams
432 * can be presented successfully will be closest to ts and within min/max_ts.
433 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
434 */
882fb0a3 435 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 436
719e721a 437 const AVMetadataConv *metadata_conv;
f610a9f2 438
b9a281db
FB
439 /* private fields */
440 struct AVInputFormat *next;
441} AVInputFormat;
de6d9b64 442
57004ff1
AJ
443enum AVStreamParseType {
444 AVSTREAM_PARSE_NONE,
445 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 446 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 447 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 448 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
449};
450
fb2758c8
FB
451typedef struct AVIndexEntry {
452 int64_t pos;
453 int64_t timestamp;
454#define AVINDEX_KEYFRAME 0x0001
30a43f2d 455 int flags:2;
4f57fa8c
DB
456 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).
457 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
458} AVIndexEntry;
459
90c2295b
ES
460#define AV_DISPOSITION_DEFAULT 0x0001
461#define AV_DISPOSITION_DUB 0x0002
462#define AV_DISPOSITION_ORIGINAL 0x0004
463#define AV_DISPOSITION_COMMENT 0x0008
464#define AV_DISPOSITION_LYRICS 0x0010
465#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
466
467/**
468 * Track should be used during playback by default.
469 * Useful for subtitle track that should be displayed
470 * even when user did not explicitly ask for subtitles.
471 */
7a617a86 472#define AV_DISPOSITION_FORCED 0x0040
90c2295b 473
ba66ae94
MN
474/**
475 * Stream structure.
476 * New fields can be added to the end with minor version bumps.
8bfb108b 477 * Removal, reordering and changes to existing fields require a major
ba66ae94 478 * version bump.
8bfb108b 479 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 480 */
de6d9b64 481typedef struct AVStream {
43d414ba 482 int index; /**< stream index in AVFormatContext */
4f57fa8c 483 int id; /**< format-specific stream ID */
43d414ba 484 AVCodecContext *codec; /**< codec context */
b4b87d48 485 /**
22e77e44
DB
486 * Real base framerate of the stream.
487 * This is the lowest framerate with which all timestamps can be
864ff8c1 488 * represented accurately (it is the least common multiple of all
22e77e44
DB
489 * framerates in the stream). Note, this value is just a guess!
490 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 491 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
492 */
493 AVRational r_frame_rate;
de6d9b64 494 void *priv_data;
82583548 495
b9a281db 496 /* internal data used in av_find_stream_info() */
82583548 497 int64_t first_dts;
76c56376
MN
498
499 /**
500 * encoding: pts generation when outputting stream
501 */
a9fd2b19 502 struct AVFrac pts;
5b28c8c3
MN
503
504 /**
8bfb108b
DB
505 * This is the fundamental unit of time (in seconds) in terms
506 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 507 * time base should be 1/framerate and timestamp increments should be 1.
5b28c8c3 508 */
9ee91c2f 509 AVRational time_base;
43d414ba 510 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 511 /* ffmpeg.c private use */
4f57fa8c
DB
512 int stream_copy; /**< If set, just copy stream. */
513 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 514
b4aea108 515 //FIXME move stuff to a flags field?
76c56376
MN
516 /**
517 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
518 * MN: dunno if that is the right place for it
519 */
115329f1 520 float quality;
76c56376 521
6d96a9b9 522 /**
8bfb108b
DB
523 * Decoding: pts of the first frame of the stream, in stream time base.
524 * Only set this if you are absolutely 100% sure that the value you set
525 * it to really is the pts of the first frame.
4854c253 526 * This may be undefined (AV_NOPTS_VALUE).
8bfb108b
DB
527 * @note The ASF header does NOT contain a correct start_time the ASF
528 * demuxer must NOT set this.
6d96a9b9 529 */
115329f1 530 int64_t start_time;
76c56376 531
e26381b6 532 /**
8bfb108b 533 * Decoding: duration of the stream, in stream time base.
e26381b6 534 * If a source file does not specify a duration, but does specify
4f57fa8c 535 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 536 */
ee404803 537 int64_t duration;
fb2758c8 538
54036be1 539#if FF_API_OLD_METADATA
ec906fcd 540 char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
827f7e28 541#endif
09730260 542
fb2758c8 543 /* av_read_frame() support */
57004ff1 544 enum AVStreamParseType need_parsing;
fb2758c8 545 struct AVCodecParserContext *parser;
6ec87caa 546
fb2758c8 547 int64_t cur_dts;
635fbcb1
MN
548 int last_IP_duration;
549 int64_t last_IP_pts;
fb2758c8 550 /* av_seek_frame() support */
4f57fa8c
DB
551 AVIndexEntry *index_entries; /**< Only used if the format does not
552 support seeking natively. */
fb2758c8 553 int nb_index_entries;
191e8ca7 554 unsigned int index_entries_allocated_size;
115329f1 555
b4b87d48 556 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 557
0d84a8f6
BC
558#if LIBAVFORMAT_VERSION_INT < (53<<16)
559 int64_t unused[4+1];
dd872bf4 560#endif
f8d7c9d3 561
54036be1 562#if FF_API_OLD_METADATA
f8d7c9d3 563 char *filename; /**< source filename of the stream */
827f7e28 564#endif
90c2295b 565
4f57fa8c 566 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
567
568 AVProbeData probe_data;
0d84a8f6
BC
569#define MAX_REORDER_DELAY 16
570 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
571
572 /**
573 * sample aspect ratio (0 if unknown)
574 * - encoding: Set by user.
575 * - decoding: Set by libavformat.
576 */
577 AVRational sample_aspect_ratio;
f526adaf 578
e232c252 579 AVMetadata *metadata;
3a41c2f7 580
31769dad
VP
581 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
582 /* external applications; try to use something else if at all possible. */
3a41c2f7
MN
583 const uint8_t *cur_ptr;
584 int cur_len;
585 AVPacket cur_pkt;
27ca0a79
IS
586
587 // Timestamp generation support:
588 /**
589 * Timestamp corresponding to the last dts sync point.
590 *
591 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
592 * a DTS is received from the underlying container. Otherwise set to
593 * AV_NOPTS_VALUE by default.
594 */
595 int64_t reference_dts;
86cb7e33
BC
596
597 /**
598 * Number of packets to buffer for codec probing
599 * NOT PART OF PUBLIC API
600 */
48616887 601#define MAX_PROBE_PACKETS 2500
86cb7e33 602 int probe_packets;
ddce56ef
MN
603
604 /**
e07b882b 605 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
606 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
607 */
e07b882b 608 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
609
610 /**
611 * Average framerate
612 */
613 AVRational avg_frame_rate;
6c6e6ef5
MN
614
615 /**
616 * Number of frames that have been demuxed during av_find_stream_info()
617 */
618 int codec_info_nb_frames;
de6d9b64
FB
619} AVStream;
620
15afa396
NS
621#define AV_PROGRAM_RUNNING 1
622
ba66ae94 623/**
ba66ae94 624 * New fields can be added to the end with minor version bumps.
8bfb108b 625 * Removal, reordering and changes to existing fields require a major
ba66ae94 626 * version bump.
8bfb108b 627 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 628 */
15afa396
NS
629typedef struct AVProgram {
630 int id;
54036be1 631#if FF_API_OLD_METADATA
4f57fa8c
DB
632 char *provider_name; ///< network name for DVB streams
633 char *name; ///< service name for DVB streams
827f7e28 634#endif
15afa396
NS
635 int flags;
636 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
637 unsigned int *stream_index;
638 unsigned int nb_stream_indexes;
e232c252 639 AVMetadata *metadata;
15afa396
NS
640} AVProgram;
641
43d414ba 642#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
643 (streams are added dynamically) */
644
79d7836a 645typedef struct AVChapter {
4f57fa8c
DB
646 int id; ///< unique ID to identify the chapter
647 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 648 int64_t start, end; ///< chapter start/end time in time_base units
54036be1 649#if FF_API_OLD_METADATA
c2fb6be4 650 char *title; ///< chapter title
827f7e28 651#endif
e232c252 652 AVMetadata *metadata;
79d7836a
AK
653} AVChapter;
654
54036be1 655#if FF_API_MAX_STREAMS
de6d9b64 656#define MAX_STREAMS 20
ad5cc780 657#endif
de6d9b64 658
252f17e2 659/**
4f57fa8c 660 * Format I/O context.
252f17e2 661 * New fields can be added to the end with minor version bumps.
8bfb108b 662 * Removal, reordering and changes to existing fields require a major
252f17e2 663 * version bump.
8bfb108b 664 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 665 */
de6d9b64 666typedef struct AVFormatContext {
1447aac4 667 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 668 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
669 struct AVInputFormat *iformat;
670 struct AVOutputFormat *oformat;
de6d9b64 671 void *priv_data;
899681cd 672 ByteIOContext *pb;
db69c2e5 673 unsigned int nb_streams;
de6d9b64 674 AVStream *streams[MAX_STREAMS];
43d414ba 675 char filename[1024]; /**< input or output filename */
de6d9b64 676 /* stream info */
4568325a 677 int64_t timestamp;
54036be1 678#if FF_API_OLD_METADATA
de6d9b64
FB
679 char title[512];
680 char author[512];
681 char copyright[512];
682 char comment[512];
6a58e151 683 char album[512];
43d414ba
PI
684 int year; /**< ID3 year, 0 if none */
685 int track; /**< track number, 0 if none */
686 char genre[32]; /**< ID3 genre */
827f7e28 687#endif
6a58e151 688
4f57fa8c
DB
689 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
690 /* private data for pts handling (do not modify directly). */
76c56376
MN
691 /**
692 * This buffer is only needed when packets were already buffered but
693 * not decoded, for example to get the codec parameters in MPEG
694 * streams.
695 */
ee404803
FB
696 struct AVPacketList *packet_buffer;
697
76c56376
MN
698 /**
699 * Decoding: position of the first frame of the component, in
700 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
701 * It is deduced from the AVStream values.
702 */
115329f1 703 int64_t start_time;
76c56376
MN
704
705 /**
706 * Decoding: duration of the stream, in AV_TIME_BASE fractional
707 * seconds. Only set this value if you know none of the individual stream
708 * durations and also dont set any of them. This is deduced from the
709 * AVStream values if not set.
710 */
ee404803 711 int64_t duration;
76c56376
MN
712
713 /**
714 * decoding: total file size, 0 if unknown
715 */
ee404803 716 int64_t file_size;
76c56376
MN
717
718 /**
719 * Decoding: total stream bitrate in bit/s, 0 if not
720 * available. Never set it directly if the file_size and the
721 * duration are known as FFmpeg can compute it automatically.
722 */
ee404803 723 int bit_rate;
fb2758c8
FB
724
725 /* av_read_frame() support */
726 AVStream *cur_st;
3a41c2f7
MN
727#if LIBAVFORMAT_VERSION_INT < (53<<16)
728 const uint8_t *cur_ptr_deprecated;
729 int cur_len_deprecated;
730 AVPacket cur_pkt_deprecated;
731#endif
fb2758c8 732
fb2758c8 733 /* av_seek_frame() support */
ec906fcd 734 int64_t data_offset; /**< offset of the first packet */
fb2758c8 735 int index_built;
115329f1 736
2db3c638 737 int mux_rate;
92400be2 738 unsigned int packet_size;
17c88cb0
MN
739 int preload;
740 int max_delay;
8108551a 741
115329f1
DB
742#define AVFMT_NOOUTPUTLOOP -1
743#define AVFMT_INFINITEOUTPUTLOOP 0
76c56376
MN
744 /**
745 * number of times to loop output in formats that support it
746 */
8108551a 747 int loop_output;
115329f1 748
30bc6613 749 int flags;
22e77e44 750#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
751#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
752#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 753#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
754#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
755#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 756#define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file
5894e1bb
VP
757
758 int loop_input;
76c56376
MN
759
760 /**
761 * decoding: size of data to probe; encoding: unused.
762 */
9e6c9470 763 unsigned int probesize;
a44b3c4d
MN
764
765 /**
4f57fa8c
DB
766 * Maximum time (in AV_TIME_BASE units) during which the input should
767 * be analyzed in av_find_stream_info().
a44b3c4d
MN
768 */
769 int max_analyze_duration;
c964c2c7
RD
770
771 const uint8_t *key;
772 int keylen;
15afa396
NS
773
774 unsigned int nb_programs;
775 AVProgram **programs;
62600469
MN
776
777 /**
778 * Forced video codec_id.
4f57fa8c 779 * Demuxing: Set by user.
62600469
MN
780 */
781 enum CodecID video_codec_id;
76c56376 782
62600469
MN
783 /**
784 * Forced audio codec_id.
4f57fa8c 785 * Demuxing: Set by user.
62600469
MN
786 */
787 enum CodecID audio_codec_id;
76c56376 788
62600469
MN
789 /**
790 * Forced subtitle codec_id.
4f57fa8c 791 * Demuxing: Set by user.
62600469
MN
792 */
793 enum CodecID subtitle_codec_id;
3dea63bd
PK
794
795 /**
22e77e44
DB
796 * Maximum amount of memory in bytes to use for the index of each stream.
797 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
798 * needed to maintain a smaller size. This can lead to slower or less
799 * accurate seeking (depends on demuxer).
4f57fa8c 800 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
801 * this.
802 * muxing : unused
803 * demuxing: set by user
804 */
805 unsigned int max_index_size;
ab8ab30c
RP
806
807 /**
ffa71b2b 808 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 809 * obtained from realtime capture devices.
ab8ab30c
RP
810 */
811 unsigned int max_picture_buffer;
79d7836a 812
fbabf1e9 813 unsigned int nb_chapters;
79d7836a 814 AVChapter **chapters;
45b2b05f
MN
815
816 /**
4f57fa8c 817 * Flags to enable debugging.
45b2b05f
MN
818 */
819 int debug;
820#define FF_FDEBUG_TS 0x0001
0bef08e5
MN
821
822 /**
4f57fa8c 823 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
824 * This buffer is used for buffering packets until the codec can
825 * be identified, as parsing cannot be done without knowing the
826 * codec.
827 */
828 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
829 struct AVPacketList *raw_packet_buffer_end;
830
831 struct AVPacketList *packet_buffer_end;
47146dfb 832
e232c252 833 AVMetadata *metadata;
af122d6a
BC
834
835 /**
836 * Remaining size available for raw_packet_buffer, in bytes.
837 * NOT PART OF PUBLIC API
838 */
48616887 839#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 840 int raw_packet_buffer_remaining_size;
b8819c85
MS
841
842 /**
843 * Start time of the stream in real world time, in microseconds
844 * since the unix epoch (00:00 1st January 1970). That is, pts=0
845 * in the stream was captured at this real world time.
846 * - encoding: Set by user.
847 * - decoding: Unused.
848 */
849 int64_t start_time_realtime;
de6d9b64
FB
850} AVFormatContext;
851
852typedef struct AVPacketList {
853 AVPacket pkt;
854 struct AVPacketList *next;
855} AVPacketList;
856
84be6e72 857#if LIBAVFORMAT_VERSION_INT < (53<<16)
b9a281db
FB
858extern AVInputFormat *first_iformat;
859extern AVOutputFormat *first_oformat;
84be6e72
MN
860#endif
861
aeedac95
SS
862/**
863 * If f is NULL, returns the first registered input format,
22e77e44 864 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
865 * or NULL if f is the last one.
866 */
84be6e72 867AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
868
869/**
870 * If f is NULL, returns the first registered output format,
22e77e44 871 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
872 * or NULL if f is the last one.
873 */
84be6e72 874AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 875
5b6d5596 876enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 877
22e77e44
DB
878/* XXX: Use automatic init with either ELF sections or C file parser */
879/* modules. */
de6d9b64 880
b9a281db 881/* utils.c */
b9a281db
FB
882void av_register_input_format(AVInputFormat *format);
883void av_register_output_format(AVOutputFormat *format);
1642ee43
SS
884#if LIBAVFORMAT_VERSION_MAJOR < 53
885attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
78cb7273
DB
886 const char *filename,
887 const char *mime_type);
a1f547b9
SS
888
889/**
890 * @deprecated Use av_guess_format() instead.
891 */
892attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
893 const char *filename,
894 const char *mime_type);
1642ee43 895#endif
f48b0fa2
SS
896
897/**
49bd8e4b
MR
898 * Return the output format in the list of registered output formats
899 * which best matches the provided parameters, or return NULL if
f48b0fa2
SS
900 * there is no match.
901 *
902 * @param short_name if non-NULL checks if short_name matches with the
903 * names of the registered formats
904 * @param filename if non-NULL checks if filename terminates with the
905 * extensions of the registered formats
906 * @param mime_type if non-NULL checks if mime_type matches with the
907 * MIME type of the registered formats
908 */
a1f547b9 909AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
910 const char *filename,
911 const char *mime_type);
3217cb42
PI
912
913/**
49bd8e4b 914 * Guess the codec ID based upon muxer and filename.
3217cb42 915 */
115329f1 916enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 917 const char *filename, const char *mime_type,
72415b2a 918 enum AVMediaType type);
de6d9b64 919
3217cb42 920/**
49bd8e4b 921 * Send a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
922 *
923 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
924 * @param buf buffer
925 * @param size buffer size
750f0e1f
PI
926 *
927 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 928 */
fb2758c8 929void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
930
931/**
49bd8e4b 932 * Send a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
933 *
934 * @param avcl A pointer to an arbitrary struct of which the first field is a
935 * pointer to an AVClass struct.
936 * @param level The importance level of the message, lower values signifying
937 * higher importance.
938 * @param buf buffer
939 * @param size buffer size
940 *
941 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
942 */
943void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
944
945/**
49bd8e4b 946 * Send a nice dump of a packet to the specified file stream.
750f0e1f
PI
947 *
948 * @param f The file stream pointer where the dump should be sent to.
3217cb42 949 * @param pkt packet to dump
4f57fa8c 950 * @param dump_payload True if the payload must be displayed, too.
3217cb42 951 */
fb2758c8 952void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 953
750f0e1f 954/**
49bd8e4b 955 * Send a nice dump of a packet to the log.
750f0e1f
PI
956 *
957 * @param avcl A pointer to an arbitrary struct of which the first field is a
958 * pointer to an AVClass struct.
959 * @param level The importance level of the message, lower values signifying
960 * higher importance.
961 * @param pkt packet to dump
4f57fa8c 962 * @param dump_payload True if the payload must be displayed, too.
750f0e1f
PI
963 */
964void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
965
4815e246 966/**
49bd8e4b 967 * Initialize libavformat and register all the muxers, demuxers and
4815e246
SS
968 * protocols. If you do not call this function, then you can select
969 * exactly which formats you want to support.
970 *
971 * @see av_register_input_format()
972 * @see av_register_output_format()
5d377501 973 * @see av_register_protocol()
4815e246 974 */
94988531 975void av_register_all(void);
de6d9b64 976
7693b93e 977/**
49bd8e4b 978 * Get the CodecID for the given codec tag tag.
7693b93e
SS
979 * If no codec id is found returns CODEC_ID_NONE.
980 *
981 * @param tags list of supported codec_id-codec_tag pairs, as stored
982 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
983 */
15545a09 984enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
7693b93e
SS
985
986/**
49bd8e4b 987 * Get the codec tag for the given codec id id.
7693b93e
SS
988 * If no codec tag is found returns 0.
989 *
990 * @param tags list of supported codec_id-codec_tag pairs, as stored
991 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
992 */
15545a09 993unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 994
b9a281db 995/* media file input */
3217cb42
PI
996
997/**
49bd8e4b 998 * Find AVInputFormat based on the short name of the input format.
3217cb42 999 */
b9a281db 1000AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1001
1002/**
49bd8e4b 1003 * Guess the file format.
3217cb42 1004 *
4f57fa8c
DB
1005 * @param is_opened Whether the file is already opened; determines whether
1006 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1007 */
94988531 1008AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1009
1010/**
49bd8e4b 1011 * Guess the file format.
8e2ee182
RD
1012 *
1013 * @param is_opened Whether the file is already opened; determines whether
1014 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1015 * @param score_max A probe score larger that this is required to accept a
1016 * detection, the variable is set to the actual detection
1017 * score afterwards.
1018 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1019 * to retry with a larger probe buffer.
1020 */
1021AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1022
1023/**
49bd8e4b 1024 * Allocate all the structures needed to read an input stream.
3217cb42
PI
1025 * This does not open the needed codecs for decoding the stream[s].
1026 */
115329f1
DB
1027int av_open_input_stream(AVFormatContext **ic_ptr,
1028 ByteIOContext *pb, const char *filename,
da24c5e3 1029 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
1030
1031/**
49bd8e4b 1032 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
1033 * header (if present) is read.
1034 *
4f57fa8c
DB
1035 * @param ic_ptr The opened media file handle is put here.
1036 * @param filename filename to open
1037 * @param fmt If non-NULL, force the file format to use.
3217cb42 1038 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
1039 * @param ap Additional parameters needed when opening the file
1040 * (NULL if default).
4f57fa8c 1041 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 1042 */
115329f1 1043int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
1044 AVInputFormat *fmt,
1045 int buf_size,
1046 AVFormatParameters *ap);
88a28965
SS
1047
1048#if LIBAVFORMAT_VERSION_MAJOR < 53
1049/**
1050 * @deprecated Use avformat_alloc_context() instead.
1051 */
1052attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1053#endif
1054
88808c60 1055/**
49bd8e4b 1056 * Allocate an AVFormatContext.
5d81d641 1057 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
1058 * explicitly allocated as well!
1059 */
88a28965 1060AVFormatContext *avformat_alloc_context(void);
b9a281db 1061
3217cb42 1062/**
49bd8e4b 1063 * Read packets of a media file to get stream information. This
3217cb42 1064 * is useful for file formats with no headers such as MPEG. This
22e77e44 1065 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
1066 * frame mode.
1067 * The logical file position is not changed by this function;
1068 * examined packets may be buffered for later processing.
1069 *
1070 * @param ic media file handle
4f57fa8c
DB
1071 * @return >=0 if OK, AVERROR_xxx on error
1072 * @todo Let the user decide somehow what information is needed so that
1073 * we do not waste time getting stuff the user does not need.
3217cb42 1074 */
b9a281db 1075int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
1076
1077/**
49bd8e4b 1078 * Read a transport packet from a media file.
3217cb42 1079 *
864ff8c1 1080 * This function is obsolete and should never be used.
3217cb42
PI
1081 * Use av_read_frame() instead.
1082 *
1083 * @param s media file handle
1084 * @param pkt is filled
4f57fa8c 1085 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1086 */
de6d9b64 1087int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1088
1089/**
49bd8e4b 1090 * Return the next frame of a stream.
3217cb42
PI
1091 *
1092 * The returned packet is valid
1093 * until the next av_read_frame() or until av_close_input_file() and
1094 * must be freed with av_free_packet. For video, the packet contains
1095 * exactly one frame. For audio, it contains an integer number of
1096 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1097 * data). If the audio frames have a variable size (e.g. MPEG audio),
1098 * then it contains one frame.
1099 *
1100 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1101 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1102 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1103 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1104 * decompress the payload.
1105 *
4f57fa8c 1106 * @return 0 if OK, < 0 on error or end of file
3217cb42 1107 */
fb2758c8 1108int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1109
1110/**
49bd8e4b 1111 * Seek to the keyframe at timestamp.
3217cb42
PI
1112 * 'timestamp' in 'stream_index'.
1113 * @param stream_index If stream_index is (-1), a default
1114 * stream is selected, and timestamp is automatically converted
1115 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1116 * @param timestamp Timestamp in AVStream.time_base units
1117 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1118 * @param flags flags which select direction and seeking mode
1119 * @return >= 0 on success
1120 */
78cb7273
DB
1121int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1122 int flags);
3217cb42
PI
1123
1124/**
49bd8e4b 1125 * Seek to timestamp ts.
d04768fa
MN
1126 * Seeking will be done so that the point from which all active streams
1127 * can be presented successfully will be closest to ts and within min/max_ts.
1128 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1129 *
22e77e44 1130 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1131 * are the file position (this may not be supported by all demuxers).
22e77e44 1132 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1133 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1134 * Otherwise all timestamps are in units of the stream selected by stream_index
1135 * or if stream_index is -1, in AV_TIME_BASE units.
1136 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1137 * keyframes (this may not be supported by all demuxers).
1138 *
22e77e44 1139 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1140 * @param min_ts smallest acceptable timestamp
1141 * @param ts target timestamp
1142 * @param max_ts largest acceptable timestamp
1143 * @param flags flags
32e543f8 1144 * @return >=0 on success, error code otherwise
998b6f7c 1145 *
8a4d7a30 1146 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1147 * Thus do not use this yet. It may change at any time, do not expect
1148 * ABI compatibility yet!
d04768fa
MN
1149 */
1150int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1151
1152/**
49bd8e4b 1153 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1154 * current position.
3217cb42 1155 */
fb2758c8 1156int av_read_play(AVFormatContext *s);
3217cb42
PI
1157
1158/**
49bd8e4b 1159 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1160 *
1161 * Use av_read_play() to resume it.
1162 */
fb2758c8 1163int av_read_pause(AVFormatContext *s);
3217cb42
PI
1164
1165/**
49bd8e4b 1166 * Free a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1167 * @param s context to free
1168 */
1169void av_close_input_stream(AVFormatContext *s);
1170
1171/**
49bd8e4b 1172 * Close a media file (but not its codecs).
3217cb42
PI
1173 *
1174 * @param s media file handle
1175 */
de6d9b64 1176void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1177
1178/**
49bd8e4b 1179 * Add a new stream to a media file.
3217cb42
PI
1180 *
1181 * Can only be called in the read_header() function. If the flag
1182 * AVFMTCTX_NOHEADER is in the format context, then new streams
1183 * can be added in read_packet too.
1184 *
1185 * @param s media file handle
4f57fa8c 1186 * @param id file-format-dependent stream ID
3217cb42 1187 */
b9a281db 1188AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 1189AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1190
1191/**
49bd8e4b 1192 * Add a new chapter.
79d7836a 1193 * This function is NOT part of the public API
4f57fa8c 1194 * and should ONLY be used by demuxers.
79d7836a
AK
1195 *
1196 * @param s media file handle
4f57fa8c 1197 * @param id unique ID for this chapter
abd2256d
MN
1198 * @param start chapter start time in time_base units
1199 * @param end chapter end time in time_base units
79d7836a 1200 * @param title chapter title
5c37f43a 1201 *
4f57fa8c 1202 * @return AVChapter or NULL on error
79d7836a 1203 */
78cb7273
DB
1204AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1205 int64_t start, int64_t end, const char *title);
79d7836a
AK
1206
1207/**
49bd8e4b 1208 * Set the pts for a given stream.
3217cb42
PI
1209 *
1210 * @param s stream
1211 * @param pts_wrap_bits number of bits effectively used by the pts
1212 * (used for wrap control, 33 is the value for MPEG)
1213 * @param pts_num numerator to convert to seconds (MPEG: 1)
1214 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1215 */
9ee91c2f 1216void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1217 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1218
3ba1438d
MN
1219#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1220#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1221#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1222#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1223
b754978a 1224int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1225
1226/**
49bd8e4b 1227 * Get the index for a specific timestamp.
4f57fa8c
DB
1228 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1229 * to the timestamp which is <= the requested one, if backward
1230 * is 0, then it will be >=
3217cb42
PI
1231 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1232 * @return < 0 if no such timestamp could be found
1233 */
dc56fc38 1234int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1235
1236/**
49bd8e4b 1237 * Ensure the index uses less memory than the maximum specified in
22e77e44 1238 * AVFormatContext.max_index_size by discarding entries if it grows
3dea63bd
PK
1239 * too large.
1240 * This function is not part of the public API and should only be called
1241 * by demuxers.
1242 */
1243void ff_reduce_index(AVFormatContext *s, int stream_index);
1244
1245/**
49bd8e4b 1246 * Add an index entry into a sorted list. Update the entry if the list
4f57fa8c 1247 * already contains it.
3217cb42 1248 *
4f57fa8c 1249 * @param timestamp timestamp in the time base of the given stream
3217cb42 1250 */
78cb7273
DB
1251int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1252 int size, int distance, int flags);
3217cb42
PI
1253
1254/**
49bd8e4b 1255 * Perform a binary search using av_index_search_timestamp() and
3673f4ab 1256 * AVInputFormat.read_timestamp().
78cb7273
DB
1257 * This is not supposed to be called directly by a user application,
1258 * but by demuxers.
3217cb42
PI
1259 * @param target_ts target timestamp in the time base of the given stream
1260 * @param stream_index stream number
1261 */
78cb7273
DB
1262int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1263 int64_t target_ts, int flags);
3217cb42
PI
1264
1265/**
49bd8e4b 1266 * Update cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1267 *
4f57fa8c
DB
1268 * Stream ref_st unchanged, others set cur_dts in their native time base.
1269 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1270 * @param timestamp new dts expressed in time_base of param ref_st
1271 * @param ref_st reference stream giving time_base of param timestamp
1272 */
22ffac70 1273void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1274
1275/**
49bd8e4b 1276 * Perform a binary search using read_timestamp().
78cb7273
DB
1277 * This is not supposed to be called directly by a user application,
1278 * but by demuxers.
3217cb42
PI
1279 * @param target_ts target timestamp in the time base of the given stream
1280 * @param stream_index stream number
1281 */
78cb7273
DB
1282int64_t av_gen_search(AVFormatContext *s, int stream_index,
1283 int64_t target_ts, int64_t pos_min,
1284 int64_t pos_max, int64_t pos_limit,
1285 int64_t ts_min, int64_t ts_max,
1286 int flags, int64_t *ts_ret,
1287 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1288
76c56376
MN
1289/**
1290 * media file output
1291 */
290c5fa6 1292int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1293
1294/**
f3bfe388
MR
1295 * Split a URL string into components.
1296 *
1297 * The pointers to buffers for storing individual components may be null,
1298 * in order to ignore that component. Buffers for components not found are
1299 * set to empty strings. If the port is not found, it is set to a negative
1300 * value.
1301 *
1302 * @param proto the buffer for the protocol
1303 * @param proto_size the size of the proto buffer
1304 * @param authorization the buffer for the authorization
1305 * @param authorization_size the size of the authorization buffer
1306 * @param hostname the buffer for the host name
1307 * @param hostname_size the size of the hostname buffer
1308 * @param port_ptr a pointer to store the port number in
1309 * @param path the buffer for the path
1310 * @param path_size the size of the path buffer
1311 * @param url the URL to split
1312 */
1313void av_url_split(char *proto, int proto_size,
1314 char *authorization, int authorization_size,
1315 char *hostname, int hostname_size,
1316 int *port_ptr,
1317 char *path, int path_size,
1318 const char *url);
1319
1320/**
49bd8e4b 1321 * Allocate the stream private data and write the stream header to an
755bfeab 1322 * output media file.
3217cb42
PI
1323 *
1324 * @param s media file handle
4f57fa8c 1325 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1326 */
b9a281db 1327int av_write_header(AVFormatContext *s);
3217cb42
PI
1328
1329/**
49bd8e4b 1330 * Write a packet to an output media file.
3217cb42
PI
1331 *
1332 * The packet shall contain one audio or video frame.
78cb7273
DB
1333 * The packet must be correctly interleaved according to the container
1334 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1335 *
1336 * @param s media file handle
78cb7273
DB
1337 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1338 dts/pts, ...
4f57fa8c 1339 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1340 */
e928649b 1341int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1342
1343/**
49bd8e4b 1344 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1345 *
1346 * The packet must contain one audio or video frame.
22e77e44 1347 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1348 * call av_write_frame() instead as it is slightly faster. It is also important
1349 * to keep in mind that completely non-interleaved input will need huge amounts
1350 * of memory to interleave with this, so it is preferable to interleave at the
1351 * demuxer level.
3217cb42
PI
1352 *
1353 * @param s media file handle
78cb7273
DB
1354 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1355 dts/pts, ...
4f57fa8c 1356 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1357 */
3c895fc0 1358int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1359
1360/**
49bd8e4b 1361 * Interleave a packet per dts in an output media file.
3217cb42 1362 *
78cb7273 1363 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1364 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1365 * on them is still safe.
3217cb42
PI
1366 *
1367 * @param s media file handle
1368 * @param out the interleaved packet will be output here
9a58234f 1369 * @param pkt the input packet
3217cb42
PI
1370 * @param flush 1 if no further packets are available as input and all
1371 * remaining packets should be output
1372 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1373 * < 0 if an error occurred
3217cb42 1374 */
78cb7273
DB
1375int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1376 AVPacket *pkt, int flush);
e928649b 1377
3217cb42 1378/**
49bd8e4b 1379 * Write the stream trailer to an output media file and free the
2b75bde6 1380 * file private data.
3217cb42 1381 *
dc76fe13
RD
1382 * May only be called after a successful call to av_write_header.
1383 *
3217cb42 1384 * @param s media file handle
4f57fa8c 1385 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1386 */
b9a281db 1387int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
1388
1389void dump_format(AVFormatContext *ic,
115329f1 1390 int index,
de6d9b64
FB
1391 const char *url,
1392 int is_output);
3217cb42 1393
1ca9133f 1394#if LIBAVFORMAT_VERSION_MAJOR < 53
3217cb42 1395/**
49bd8e4b 1396 * Parse width and height out of string str.
26ef3220 1397 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 1398 */
78cb7273
DB
1399attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1400 const char *str);
3217cb42
PI
1401
1402/**
49bd8e4b 1403 * Convert framerate from a string to a fraction.
26ef3220 1404 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 1405 */
78cb7273
DB
1406attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1407 const char *arg);
1ca9133f 1408#endif
3217cb42
PI
1409
1410/**
49bd8e4b 1411 * Parse datestr and return a corresponding number of microseconds.
f9436161
SS
1412 * @param datestr String representing a date or a duration.
1413 * - If a date the syntax is:
3217cb42 1414 * @code
fcd10c4f 1415 * now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
3217cb42 1416 * @endcode
fcd10c4f 1417 * If the value is "now" it takes the current time.
4f57fa8c 1418 * Time is local time unless Z is appended, in which case it is
f9436161 1419 * interpreted as UTC.
4f57fa8c 1420 * If the year-month-day part is not specified it takes the current
f9436161 1421 * year-month-day.
49bd8e4b 1422 * @return the number of microseconds since 1st of January, 1970 up to
819174fa 1423 * the time of the parsed date or INT64_MIN if datestr cannot be
f9436161
SS
1424 * successfully parsed.
1425 * - If a duration the syntax is:
1426 * @code
1427 * [-]HH[:MM[:SS[.m...]]]
1428 * [-]S+[.m...]
1429 * @endcode
49bd8e4b 1430 * @return the number of microseconds contained in a time interval
819174fa 1431 * with the specified duration or INT64_MIN if datestr cannot be
7338d368 1432 * successfully parsed.
819174fa
SS
1433 * @param duration Flag which tells how to interpret datestr, if
1434 * not zero datestr is interpreted as a duration, otherwise as a
f9436161 1435 * date.
3217cb42 1436 */
0c1a9eda 1437int64_t parse_date(const char *datestr, int duration);
de6d9b64 1438
76c56376
MN
1439/**
1440 * Get the current time in microseconds.
1441 */
0c1a9eda 1442int64_t av_gettime(void);
94988531 1443
4f57fa8c 1444/* ffm-specific for ffserver */
de6d9b64 1445#define FFM_PACKET_SIZE 4096
bc5c918e 1446int64_t ffm_read_write_index(int fd);
6fcce4f9 1447int ffm_write_write_index(int fd, int64_t pos);
bc5c918e 1448void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
de6d9b64 1449
3217cb42 1450/**
49bd8e4b 1451 * Attempt to find a specific tag in a URL.
3217cb42
PI
1452 *
1453 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1454 * Return 1 if found.
1455 */
de6d9b64
FB
1456int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1457
3217cb42 1458/**
49bd8e4b 1459 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1460 *
3217cb42
PI
1461 * Also handles the '%0nd' format where 'n' is the total number
1462 * of digits and '%%'.
1463 *
1464 * @param buf destination buffer
1465 * @param buf_size destination buffer size
1466 * @param path numbered sequence string
8ea0e802 1467 * @param number frame number
4f57fa8c 1468 * @return 0 if OK, -1 on format error
3217cb42 1469 */
5c07cf53
MB
1470int av_get_frame_filename(char *buf, int buf_size,
1471 const char *path, int number);
3217cb42
PI
1472
1473/**
49bd8e4b 1474 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1475 *
1476 * @param filename possible numbered sequence string
4f57fa8c 1477 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1478 */
5c07cf53 1479int av_filename_number_test(const char *filename);
96baaa6a 1480
c5388c07 1481/**
49bd8e4b 1482 * Generate an SDP for an RTP session.
c5388c07
LA
1483 *
1484 * @param ac array of AVFormatContexts describing the RTP streams. If the
1485 * array is composed by only one context, such context can contain
1486 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1487 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1488 * must contain only one AVStream.
8767b80f
LA
1489 * @param n_files number of AVCodecContexts contained in ac
1490 * @param buff buffer where the SDP will be stored (must be allocated by
4f57fa8c 1491 * the caller)
8767b80f 1492 * @param size the size of the buffer
4f57fa8c 1493 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1494 */
8767b80f 1495int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 1496
1a70d127 1497/**
49bd8e4b 1498 * Return a positive value if the given filename has one of the given
1a70d127
SS
1499 * extensions, 0 otherwise.
1500 *
1501 * @param extensions a comma-separated list of filename extensions
1502 */
1503int av_match_ext(const char *filename, const char *extensions);
1504
98790382 1505#endif /* AVFORMAT_AVFORMAT_H */