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