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