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