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