avoptions: Return explicitly NAN or {0,0} if the option isn't found
[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 {
c0df9d75 230 AVRational time_base;
bffd4dd1
AK
231#if FF_API_FORMAT_PARAMETERS
232 attribute_deprecated int sample_rate;
233 attribute_deprecated int channels;
234#endif
de6d9b64
FB
235 int width;
236 int height;
4606ac8d 237 enum PixelFormat pix_fmt;
17a5556d 238#if FF_API_FORMAT_PARAMETERS
d20576d0 239 attribute_deprecated int channel; /**< Used to select DV channel. */
fc68a8f7 240 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
fb37d573 241 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
17a5556d
AK
242 /**< deprecated, use mpegtsraw demuxer-specific options instead */
243 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
244#endif
4f57fa8c
DB
245 unsigned int initial_pause:1; /**< Do not begin to play the stream
246 immediately (RTSP only). */
72e043dd 247 unsigned int prealloced_context:1;
de6d9b64
FB
248} AVFormatParameters;
249
22a3212e 250//! Demuxer will use avio_open, no opened file should be provided by the caller.
40d9c544 251#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
252#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
253#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
254#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
255 raw picture data. */
256#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
257#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
258#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
58ec7e00 259#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
25918212 260#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 261#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
bb62d5c1 262#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
69fa2396
VP
263#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
264#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
b9a281db
FB
265
266typedef struct AVOutputFormat {
de6d9b64 267 const char *name;
bde15e74
SS
268 /**
269 * Descriptive name for the format, meant to be more human-readable
819174fa 270 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
271 * to define it.
272 */
de6d9b64
FB
273 const char *long_name;
274 const char *mime_type;
4f57fa8c 275 const char *extensions; /**< comma-separated filename extensions */
76c56376
MN
276 /**
277 * size of private data so that it can be allocated in the wrapper
278 */
b9a281db 279 int priv_data_size;
de6d9b64 280 /* output support */
43d414ba
PI
281 enum CodecID audio_codec; /**< default audio codec */
282 enum CodecID video_codec; /**< default video codec */
de6d9b64 283 int (*write_header)(struct AVFormatContext *);
e928649b 284 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 285 int (*write_trailer)(struct AVFormatContext *);
76c56376 286 /**
89e568fe
AH
287 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
288 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
289 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
76c56376 290 */
b9a281db 291 int flags;
76c56376
MN
292 /**
293 * Currently only used to set pixel format if not YUV420P.
294 */
290c5fa6 295 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
296 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
297 AVPacket *in, int flush);
7caf0cc6
MN
298
299 /**
78cb7273 300 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 301 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 302 */
c1854592 303 const struct AVCodecTag * const *codec_tag;
7caf0cc6 304
11bf3847
AJ
305 enum CodecID subtitle_codec; /**< default subtitle codec */
306
451d566f 307#if FF_API_OLD_METADATA2
719e721a 308 const AVMetadataConv *metadata_conv;
03700d39 309#endif
f610a9f2 310
cf99e4aa
AH
311 const AVClass *priv_class; ///< AVClass for the private context
312
b9a281db
FB
313 /* private fields */
314 struct AVOutputFormat *next;
315} AVOutputFormat;
de6d9b64 316
b9a281db 317typedef struct AVInputFormat {
76c56376
MN
318 /**
319 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
320 * may be appended with a minor bump.
321 */
b9a281db 322 const char *name;
76c56376 323
bde15e74
SS
324 /**
325 * Descriptive name for the format, meant to be more human-readable
819174fa 326 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
327 * to define it.
328 */
b9a281db 329 const char *long_name;
76c56376
MN
330
331 /**
332 * Size of private data so that it can be allocated in the wrapper.
333 */
b9a281db 334 int priv_data_size;
76c56376 335
65d7d68b 336 /**
22e77e44 337 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
338 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
339 * big so you do not have to check for that unless you need more.
65d7d68b 340 */
b9a281db 341 int (*read_probe)(AVProbeData *);
76c56376
MN
342
343 /**
344 * Read the format header and initialize the AVFormatContext
345 * structure. Return 0 if OK. 'ap' if non-NULL contains
346 * additional parameters. Only used in raw format right
347 * now. 'av_new_stream' should be called to create new streams.
348 */
de6d9b64
FB
349 int (*read_header)(struct AVFormatContext *,
350 AVFormatParameters *ap);
76c56376
MN
351
352 /**
353 * Read one packet and put it in 'pkt'. pts and flags are also
354 * set. 'av_new_stream' can be called only if the flag
2899a28c
AJ
355 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
356 * background thread).
76c56376
MN
357 * @return 0 on success, < 0 on error.
358 * When returning an error, pkt must not have been allocated
359 * or must be freed before returning
360 */
de6d9b64 361 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
362
363 /**
364 * Close the stream. The AVFormatContext and AVStreams are not
365 * freed by this function
366 */
de6d9b64 367 int (*read_close)(struct AVFormatContext *);
1de2db8f 368
634e0304 369#if FF_API_READ_SEEK
115329f1 370 /**
4f57fa8c
DB
371 * Seek to a given timestamp relative to the frames in
372 * stream component stream_index.
22e77e44
DB
373 * @param stream_index Must not be -1.
374 * @param flags Selects which direction should be preferred if no exact
375 * match is available.
05ce0f11 376 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 377 */
a15c7fd6
AK
378 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
379 int stream_index, int64_t timestamp, int flags);
1de2db8f 380#endif
8d14a25c 381 /**
4f57fa8c 382 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 383 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
384 */
385 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
386 int64_t *pos, int64_t pos_limit);
76c56376
MN
387
388 /**
389 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
390 */
de6d9b64 391 int flags;
76c56376
MN
392
393 /**
394 * If extensions are defined, then no probe is done. You should
395 * usually not use extension format guessing because it is not
396 * reliable enough
397 */
b9a281db 398 const char *extensions;
76c56376
MN
399
400 /**
401 * General purpose read-only value that the format can use.
402 */
b9a281db 403 int value;
fb2758c8 404
76c56376
MN
405 /**
406 * Start/resume playing - only meaningful if using a network-based format
407 * (RTSP).
408 */
fb2758c8
FB
409 int (*read_play)(struct AVFormatContext *);
410
76c56376
MN
411 /**
412 * Pause playing - only meaningful if using a network-based format
413 * (RTSP).
414 */
fb2758c8
FB
415 int (*read_pause)(struct AVFormatContext *);
416
c1854592 417 const struct AVCodecTag * const *codec_tag;
7caf0cc6 418
1de2db8f 419 /**
49bd8e4b 420 * Seek to timestamp ts.
1de2db8f
MN
421 * Seeking will be done so that the point from which all active streams
422 * can be presented successfully will be closest to ts and within min/max_ts.
423 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
424 */
882fb0a3 425 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 426
451d566f 427#if FF_API_OLD_METADATA2
719e721a 428 const AVMetadataConv *metadata_conv;
03700d39 429#endif
f610a9f2 430
5dc82144
AK
431 const AVClass *priv_class; ///< AVClass for the private context
432
b9a281db
FB
433 /* private fields */
434 struct AVInputFormat *next;
435} AVInputFormat;
de6d9b64 436
57004ff1
AJ
437enum AVStreamParseType {
438 AVSTREAM_PARSE_NONE,
439 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 440 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 441 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 442 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
443};
444
fb2758c8
FB
445typedef struct AVIndexEntry {
446 int64_t pos;
447 int64_t timestamp;
448#define AVINDEX_KEYFRAME 0x0001
30a43f2d 449 int flags:2;
4f57fa8c
DB
450 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).
451 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
452} AVIndexEntry;
453
90c2295b
ES
454#define AV_DISPOSITION_DEFAULT 0x0001
455#define AV_DISPOSITION_DUB 0x0002
456#define AV_DISPOSITION_ORIGINAL 0x0004
457#define AV_DISPOSITION_COMMENT 0x0008
458#define AV_DISPOSITION_LYRICS 0x0010
459#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
460
461/**
462 * Track should be used during playback by default.
463 * Useful for subtitle track that should be displayed
464 * even when user did not explicitly ask for subtitles.
465 */
7a617a86 466#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
467#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
468#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 469#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
90c2295b 470
ba66ae94
MN
471/**
472 * Stream structure.
473 * New fields can be added to the end with minor version bumps.
8bfb108b 474 * Removal, reordering and changes to existing fields require a major
ba66ae94 475 * version bump.
8bfb108b 476 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 477 */
de6d9b64 478typedef struct AVStream {
43d414ba 479 int index; /**< stream index in AVFormatContext */
4f57fa8c 480 int id; /**< format-specific stream ID */
43d414ba 481 AVCodecContext *codec; /**< codec context */
b4b87d48 482 /**
22e77e44
DB
483 * Real base framerate of the stream.
484 * This is the lowest framerate with which all timestamps can be
864ff8c1 485 * represented accurately (it is the least common multiple of all
22e77e44
DB
486 * framerates in the stream). Note, this value is just a guess!
487 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 488 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
489 */
490 AVRational r_frame_rate;
de6d9b64 491 void *priv_data;
82583548 492
b9a281db 493 /* internal data used in av_find_stream_info() */
82583548 494 int64_t first_dts;
76c56376
MN
495
496 /**
497 * encoding: pts generation when outputting stream
498 */
a9fd2b19 499 struct AVFrac pts;
5b28c8c3
MN
500
501 /**
8bfb108b
DB
502 * This is the fundamental unit of time (in seconds) in terms
503 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 504 * time base should be 1/framerate and timestamp increments should be 1.
5d820db2
RD
505 * decoding: set by libavformat
506 * encoding: set by libavformat in av_write_header
5b28c8c3 507 */
9ee91c2f 508 AVRational time_base;
43d414ba 509 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 510 /* ffmpeg.c private use */
4f57fa8c
DB
511 int stream_copy; /**< If set, just copy stream. */
512 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 513
b4aea108 514 //FIXME move stuff to a flags field?
76c56376
MN
515 /**
516 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
517 * MN: dunno if that is the right place for it
518 */
115329f1 519 float quality;
76c56376 520
6d96a9b9 521 /**
8bfb108b
DB
522 * Decoding: pts of the first frame of the stream, in stream time base.
523 * Only set this if you are absolutely 100% sure that the value you set
524 * it to really is the pts of the first frame.
4854c253 525 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 526 */
115329f1 527 int64_t start_time;
76c56376 528
e26381b6 529 /**
8bfb108b 530 * Decoding: duration of the stream, in stream time base.
e26381b6 531 * If a source file does not specify a duration, but does specify
4f57fa8c 532 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 533 */
ee404803 534 int64_t duration;
fb2758c8
FB
535
536 /* av_read_frame() support */
57004ff1 537 enum AVStreamParseType need_parsing;
fb2758c8 538 struct AVCodecParserContext *parser;
6ec87caa 539
fb2758c8 540 int64_t cur_dts;
635fbcb1
MN
541 int last_IP_duration;
542 int64_t last_IP_pts;
fb2758c8 543 /* av_seek_frame() support */
4f57fa8c
DB
544 AVIndexEntry *index_entries; /**< Only used if the format does not
545 support seeking natively. */
fb2758c8 546 int nb_index_entries;
191e8ca7 547 unsigned int index_entries_allocated_size;
115329f1 548
b4b87d48 549 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 550
4f57fa8c 551 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
552
553 AVProbeData probe_data;
0d84a8f6
BC
554#define MAX_REORDER_DELAY 16
555 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
556
557 /**
558 * sample aspect ratio (0 if unknown)
559 * - encoding: Set by user.
560 * - decoding: Set by libavformat.
561 */
562 AVRational sample_aspect_ratio;
f526adaf 563
e232c252 564 AVMetadata *metadata;
3a41c2f7 565
31769dad
VP
566 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
567 /* external applications; try to use something else if at all possible. */
3a41c2f7
MN
568 const uint8_t *cur_ptr;
569 int cur_len;
570 AVPacket cur_pkt;
27ca0a79
IS
571
572 // Timestamp generation support:
573 /**
574 * Timestamp corresponding to the last dts sync point.
575 *
576 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
577 * a DTS is received from the underlying container. Otherwise set to
578 * AV_NOPTS_VALUE by default.
579 */
580 int64_t reference_dts;
86cb7e33
BC
581
582 /**
583 * Number of packets to buffer for codec probing
584 * NOT PART OF PUBLIC API
585 */
48616887 586#define MAX_PROBE_PACKETS 2500
86cb7e33 587 int probe_packets;
ddce56ef
MN
588
589 /**
e07b882b 590 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
591 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
592 */
e07b882b 593 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
594
595 /**
596 * Average framerate
597 */
598 AVRational avg_frame_rate;
6c6e6ef5
MN
599
600 /**
601 * Number of frames that have been demuxed during av_find_stream_info()
602 */
603 int codec_info_nb_frames;
fd0368e7
AJ
604
605 /**
606 * Stream informations used internally by av_find_stream_info()
607 */
608#define MAX_STD_TIMEBASES (60*12+5)
609 struct {
610 int64_t last_dts;
611 int64_t duration_gcd;
612 int duration_count;
613 double duration_error[MAX_STD_TIMEBASES];
614 int64_t codec_info_duration;
615 } *info;
de6d9b64
FB
616} AVStream;
617
15afa396
NS
618#define AV_PROGRAM_RUNNING 1
619
ba66ae94 620/**
ba66ae94 621 * New fields can be added to the end with minor version bumps.
8bfb108b 622 * Removal, reordering and changes to existing fields require a major
ba66ae94 623 * version bump.
8bfb108b 624 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 625 */
15afa396
NS
626typedef struct AVProgram {
627 int id;
15afa396
NS
628 int flags;
629 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
630 unsigned int *stream_index;
631 unsigned int nb_stream_indexes;
e232c252 632 AVMetadata *metadata;
15afa396
NS
633} AVProgram;
634
43d414ba 635#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
636 (streams are added dynamically) */
637
79d7836a 638typedef struct AVChapter {
4f57fa8c
DB
639 int id; ///< unique ID to identify the chapter
640 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 641 int64_t start, end; ///< chapter start/end time in time_base units
e232c252 642 AVMetadata *metadata;
79d7836a
AK
643} AVChapter;
644
252f17e2 645/**
4f57fa8c 646 * Format I/O context.
252f17e2 647 * New fields can be added to the end with minor version bumps.
8bfb108b 648 * Removal, reordering and changes to existing fields require a major
252f17e2 649 * version bump.
8bfb108b 650 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 651 */
de6d9b64 652typedef struct AVFormatContext {
1447aac4 653 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 654 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
655 struct AVInputFormat *iformat;
656 struct AVOutputFormat *oformat;
de6d9b64 657 void *priv_data;
ae628ec1 658 AVIOContext *pb;
db69c2e5 659 unsigned int nb_streams;
38aab35f 660 AVStream **streams;
43d414ba 661 char filename[1024]; /**< input or output filename */
de6d9b64 662 /* stream info */
4568325a 663 int64_t timestamp;
6a58e151 664
4f57fa8c
DB
665 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
666 /* private data for pts handling (do not modify directly). */
76c56376
MN
667 /**
668 * This buffer is only needed when packets were already buffered but
669 * not decoded, for example to get the codec parameters in MPEG
670 * streams.
671 */
ee404803
FB
672 struct AVPacketList *packet_buffer;
673
76c56376
MN
674 /**
675 * Decoding: position of the first frame of the component, in
676 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
677 * It is deduced from the AVStream values.
678 */
115329f1 679 int64_t start_time;
76c56376
MN
680
681 /**
682 * Decoding: duration of the stream, in AV_TIME_BASE fractional
683 * seconds. Only set this value if you know none of the individual stream
684 * durations and also dont set any of them. This is deduced from the
685 * AVStream values if not set.
686 */
ee404803 687 int64_t duration;
76c56376
MN
688
689 /**
690 * decoding: total file size, 0 if unknown
691 */
ee404803 692 int64_t file_size;
76c56376
MN
693
694 /**
695 * Decoding: total stream bitrate in bit/s, 0 if not
696 * available. Never set it directly if the file_size and the
6001dad6 697 * duration are known as Libav can compute it automatically.
76c56376 698 */
ee404803 699 int bit_rate;
fb2758c8
FB
700
701 /* av_read_frame() support */
702 AVStream *cur_st;
fb2758c8 703
fb2758c8 704 /* av_seek_frame() support */
ec906fcd 705 int64_t data_offset; /**< offset of the first packet */
115329f1 706
2db3c638 707 int mux_rate;
92400be2 708 unsigned int packet_size;
17c88cb0
MN
709 int preload;
710 int max_delay;
8108551a 711
115329f1
DB
712#define AVFMT_NOOUTPUTLOOP -1
713#define AVFMT_INFINITEOUTPUTLOOP 0
76c56376
MN
714 /**
715 * number of times to loop output in formats that support it
716 */
8108551a 717 int loop_output;
115329f1 718
30bc6613 719 int flags;
22e77e44 720#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
721#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
722#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 723#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
724#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
725#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 726#define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file
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;
de6d9b64
FB
820} AVFormatContext;
821
822typedef struct AVPacketList {
823 AVPacket pkt;
824 struct AVPacketList *next;
825} AVPacketList;
826
aeedac95
SS
827/**
828 * If f is NULL, returns the first registered input format,
22e77e44 829 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
830 * or NULL if f is the last one.
831 */
84be6e72 832AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
833
834/**
835 * If f is NULL, returns the first registered output format,
22e77e44 836 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
837 * or NULL if f is the last one.
838 */
84be6e72 839AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 840
a9bf9d8e
AK
841#if FF_API_GUESS_IMG2_CODEC
842attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
843#endif
290c5fa6 844
22e77e44
DB
845/* XXX: Use automatic init with either ELF sections or C file parser */
846/* modules. */
de6d9b64 847
b9a281db 848/* utils.c */
b9a281db
FB
849void av_register_input_format(AVInputFormat *format);
850void av_register_output_format(AVOutputFormat *format);
f48b0fa2
SS
851
852/**
49bd8e4b
MR
853 * Return the output format in the list of registered output formats
854 * which best matches the provided parameters, or return NULL if
f48b0fa2
SS
855 * there is no match.
856 *
857 * @param short_name if non-NULL checks if short_name matches with the
858 * names of the registered formats
859 * @param filename if non-NULL checks if filename terminates with the
860 * extensions of the registered formats
861 * @param mime_type if non-NULL checks if mime_type matches with the
862 * MIME type of the registered formats
863 */
a1f547b9 864AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
865 const char *filename,
866 const char *mime_type);
3217cb42
PI
867
868/**
49bd8e4b 869 * Guess the codec ID based upon muxer and filename.
3217cb42 870 */
115329f1 871enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 872 const char *filename, const char *mime_type,
72415b2a 873 enum AVMediaType type);
de6d9b64 874
3217cb42 875/**
49bd8e4b 876 * Send a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
877 *
878 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
879 * @param buf buffer
880 * @param size buffer size
750f0e1f 881 *
863c4716 882 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
3217cb42 883 */
fb2758c8 884void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
885
886/**
49bd8e4b 887 * Send a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
888 *
889 * @param avcl A pointer to an arbitrary struct of which the first field is a
890 * pointer to an AVClass struct.
891 * @param level The importance level of the message, lower values signifying
892 * higher importance.
893 * @param buf buffer
894 * @param size buffer size
895 *
863c4716 896 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
750f0e1f
PI
897 */
898void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
899
900/**
49bd8e4b 901 * Send a nice dump of a packet to the specified file stream.
750f0e1f
PI
902 *
903 * @param f The file stream pointer where the dump should be sent to.
3217cb42 904 * @param pkt packet to dump
4f57fa8c 905 * @param dump_payload True if the payload must be displayed, too.
863c4716 906 * @param st AVStream that the packet belongs to
3217cb42 907 */
863c4716
MS
908void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
909
de6d9b64 910
750f0e1f 911/**
49bd8e4b 912 * Send a nice dump of a packet to the log.
750f0e1f
PI
913 *
914 * @param avcl A pointer to an arbitrary struct of which the first field is a
915 * pointer to an AVClass struct.
916 * @param level The importance level of the message, lower values signifying
917 * higher importance.
918 * @param pkt packet to dump
4f57fa8c 919 * @param dump_payload True if the payload must be displayed, too.
863c4716 920 * @param st AVStream that the packet belongs to
750f0e1f 921 */
863c4716
MS
922void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
923 AVStream *st);
924
c5704b2b
AK
925#if FF_API_PKT_DUMP
926attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
863c4716
MS
927attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
928 int dump_payload);
17ca374c 929#endif
750f0e1f 930
4815e246 931/**
49bd8e4b 932 * Initialize libavformat and register all the muxers, demuxers and
4815e246
SS
933 * protocols. If you do not call this function, then you can select
934 * exactly which formats you want to support.
935 *
936 * @see av_register_input_format()
937 * @see av_register_output_format()
5d377501 938 * @see av_register_protocol()
4815e246 939 */
94988531 940void av_register_all(void);
de6d9b64 941
7693b93e 942/**
49bd8e4b 943 * Get the CodecID for the given codec tag tag.
7693b93e
SS
944 * If no codec id is found returns CODEC_ID_NONE.
945 *
946 * @param tags list of supported codec_id-codec_tag pairs, as stored
947 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
948 */
15545a09 949enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
7693b93e
SS
950
951/**
49bd8e4b 952 * Get the codec tag for the given codec id id.
7693b93e
SS
953 * If no codec tag is found returns 0.
954 *
955 * @param tags list of supported codec_id-codec_tag pairs, as stored
956 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
957 */
15545a09 958unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 959
b9a281db 960/* media file input */
3217cb42
PI
961
962/**
49bd8e4b 963 * Find AVInputFormat based on the short name of the input format.
3217cb42 964 */
b9a281db 965AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
966
967/**
49bd8e4b 968 * Guess the file format.
3217cb42 969 *
4f57fa8c
DB
970 * @param is_opened Whether the file is already opened; determines whether
971 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 972 */
94988531 973AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
974
975/**
49bd8e4b 976 * Guess the file format.
8e2ee182
RD
977 *
978 * @param is_opened Whether the file is already opened; determines whether
979 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
980 * @param score_max A probe score larger that this is required to accept a
981 * detection, the variable is set to the actual detection
982 * score afterwards.
983 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
984 * to retry with a larger probe buffer.
985 */
986AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
987
988/**
3940caad
AH
989 * Probe a bytestream to determine the input format. Each time a probe returns
990 * with a score that is too low, the probe buffer size is increased and another
991 * attempt is made. When the maximum probe size is reached, the input format
992 * with the highest score is returned.
993 *
994 * @param pb the bytestream to probe
995 * @param fmt the input format is put here
996 * @param filename the filename of the stream
997 * @param logctx the log context
998 * @param offset the offset within the bytestream to probe from
999 * @param max_probe_size the maximum probe buffer size (zero for default)
1000 * @return 0 in case of success, a negative value corresponding to an
1001 * AVERROR code otherwise
1002 */
ae628ec1 1003int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1004 const char *filename, void *logctx,
1005 unsigned int offset, unsigned int max_probe_size);
1006
1007/**
49bd8e4b 1008 * Allocate all the structures needed to read an input stream.
3217cb42
PI
1009 * This does not open the needed codecs for decoding the stream[s].
1010 */
115329f1 1011int av_open_input_stream(AVFormatContext **ic_ptr,
ae628ec1 1012 AVIOContext *pb, const char *filename,
da24c5e3 1013 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
1014
1015/**
49bd8e4b 1016 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
1017 * header (if present) is read.
1018 *
4f57fa8c
DB
1019 * @param ic_ptr The opened media file handle is put here.
1020 * @param filename filename to open
1021 * @param fmt If non-NULL, force the file format to use.
3217cb42 1022 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
1023 * @param ap Additional parameters needed when opening the file
1024 * (NULL if default).
4f57fa8c 1025 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 1026 */
115329f1 1027int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
1028 AVInputFormat *fmt,
1029 int buf_size,
1030 AVFormatParameters *ap);
88a28965 1031
88808c60 1032/**
49bd8e4b 1033 * Allocate an AVFormatContext.
f124b087
MS
1034 * avformat_free_context() can be used to free the context and everything
1035 * allocated by the framework within it.
88808c60 1036 */
88a28965 1037AVFormatContext *avformat_alloc_context(void);
b9a281db 1038
3217cb42 1039/**
49bd8e4b 1040 * Read packets of a media file to get stream information. This
3217cb42 1041 * is useful for file formats with no headers such as MPEG. This
22e77e44 1042 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
1043 * frame mode.
1044 * The logical file position is not changed by this function;
1045 * examined packets may be buffered for later processing.
1046 *
1047 * @param ic media file handle
4f57fa8c
DB
1048 * @return >=0 if OK, AVERROR_xxx on error
1049 * @todo Let the user decide somehow what information is needed so that
1050 * we do not waste time getting stuff the user does not need.
3217cb42 1051 */
b9a281db 1052int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
1053
1054/**
9128ae08
NG
1055 * Find the "best" stream in the file.
1056 * The best stream is determined according to various heuristics as the most
1057 * likely to be what the user expects.
1058 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1059 * default decoder for the stream's codec; streams for which no decoder can
1060 * be found are ignored.
1061 *
1062 * @param ic media file handle
1063 * @param type stream type: video, audio, subtitles, etc.
1064 * @param wanted_stream_nb user-requested stream number,
1065 * or -1 for automatic selection
1066 * @param related_stream try to find a stream related (eg. in the same
1067 * program) to this one, or -1 if none
1068 * @param decoder_ret if non-NULL, returns the decoder for the
1069 * selected stream
1070 * @param flags flags; none are currently defined
1071 * @return the non-negative stream number in case of success,
1072 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1073 * could be found,
1074 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1075 * @note If av_find_best_stream returns successfully and decoder_ret is not
1076 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1077 */
1078int av_find_best_stream(AVFormatContext *ic,
1079 enum AVMediaType type,
1080 int wanted_stream_nb,
1081 int related_stream,
1082 AVCodec **decoder_ret,
1083 int flags);
1084
1085/**
49bd8e4b 1086 * Read a transport packet from a media file.
3217cb42 1087 *
864ff8c1 1088 * This function is obsolete and should never be used.
3217cb42
PI
1089 * Use av_read_frame() instead.
1090 *
1091 * @param s media file handle
1092 * @param pkt is filled
4f57fa8c 1093 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1094 */
de6d9b64 1095int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1096
1097/**
49bd8e4b 1098 * Return the next frame of a stream.
4faf628f
MN
1099 * This function returns what is stored in the file, and does not validate
1100 * that what is there are valid frames for the decoder. It will split what is
1101 * stored in the file into frames and return one for each call. It will not
1102 * omit invalid data between valid frames so as to give the decoder the maximum
1103 * information possible for decoding.
3217cb42
PI
1104 *
1105 * The returned packet is valid
1106 * until the next av_read_frame() or until av_close_input_file() and
1107 * must be freed with av_free_packet. For video, the packet contains
1108 * exactly one frame. For audio, it contains an integer number of
1109 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1110 * data). If the audio frames have a variable size (e.g. MPEG audio),
1111 * then it contains one frame.
1112 *
1113 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1114 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1115 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1116 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1117 * decompress the payload.
1118 *
4f57fa8c 1119 * @return 0 if OK, < 0 on error or end of file
3217cb42 1120 */
fb2758c8 1121int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1122
1123/**
49bd8e4b 1124 * Seek to the keyframe at timestamp.
3217cb42
PI
1125 * 'timestamp' in 'stream_index'.
1126 * @param stream_index If stream_index is (-1), a default
1127 * stream is selected, and timestamp is automatically converted
1128 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1129 * @param timestamp Timestamp in AVStream.time_base units
1130 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1131 * @param flags flags which select direction and seeking mode
1132 * @return >= 0 on success
1133 */
78cb7273
DB
1134int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1135 int flags);
3217cb42
PI
1136
1137/**
49bd8e4b 1138 * Seek to timestamp ts.
d04768fa
MN
1139 * Seeking will be done so that the point from which all active streams
1140 * can be presented successfully will be closest to ts and within min/max_ts.
1141 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1142 *
22e77e44 1143 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1144 * are the file position (this may not be supported by all demuxers).
22e77e44 1145 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1146 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1147 * Otherwise all timestamps are in units of the stream selected by stream_index
1148 * or if stream_index is -1, in AV_TIME_BASE units.
1149 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1150 * keyframes (this may not be supported by all demuxers).
1151 *
22e77e44 1152 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1153 * @param min_ts smallest acceptable timestamp
1154 * @param ts target timestamp
1155 * @param max_ts largest acceptable timestamp
1156 * @param flags flags
32e543f8 1157 * @return >=0 on success, error code otherwise
998b6f7c 1158 *
8a4d7a30 1159 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1160 * Thus do not use this yet. It may change at any time, do not expect
1161 * ABI compatibility yet!
d04768fa
MN
1162 */
1163int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1164
1165/**
49bd8e4b 1166 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1167 * current position.
3217cb42 1168 */
fb2758c8 1169int av_read_play(AVFormatContext *s);
3217cb42
PI
1170
1171/**
49bd8e4b 1172 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1173 *
1174 * Use av_read_play() to resume it.
1175 */
fb2758c8 1176int av_read_pause(AVFormatContext *s);
3217cb42
PI
1177
1178/**
49bd8e4b 1179 * Free a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1180 * @param s context to free
1181 */
1182void av_close_input_stream(AVFormatContext *s);
1183
1184/**
49bd8e4b 1185 * Close a media file (but not its codecs).
3217cb42
PI
1186 *
1187 * @param s media file handle
1188 */
de6d9b64 1189void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1190
1191/**
f124b087
MS
1192 * Free an AVFormatContext and all its streams.
1193 * @param s context to free
1194 */
1195void avformat_free_context(AVFormatContext *s);
1196
1197/**
49bd8e4b 1198 * Add a new stream to a media file.
3217cb42
PI
1199 *
1200 * Can only be called in the read_header() function. If the flag
1201 * AVFMTCTX_NOHEADER is in the format context, then new streams
1202 * can be added in read_packet too.
1203 *
1204 * @param s media file handle
4f57fa8c 1205 * @param id file-format-dependent stream ID
3217cb42 1206 */
b9a281db 1207AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 1208AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1209
1210/**
b3190529
RD
1211 * Set the pts for a given stream. If the new values would be invalid
1212 * (<= 0), it leaves the AVStream unchanged.
3217cb42
PI
1213 *
1214 * @param s stream
1215 * @param pts_wrap_bits number of bits effectively used by the pts
1216 * (used for wrap control, 33 is the value for MPEG)
1217 * @param pts_num numerator to convert to seconds (MPEG: 1)
1218 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1219 */
9ee91c2f 1220void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1221 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1222
3ba1438d
MN
1223#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1224#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1225#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1226#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1227
b754978a 1228int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1229
1230/**
49bd8e4b 1231 * Get the index for a specific timestamp.
4f57fa8c
DB
1232 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1233 * to the timestamp which is <= the requested one, if backward
1234 * is 0, then it will be >=
3217cb42
PI
1235 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1236 * @return < 0 if no such timestamp could be found
1237 */
dc56fc38 1238int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1239
1240/**
49bd8e4b 1241 * Add an index entry into a sorted list. Update the entry if the list
4f57fa8c 1242 * already contains it.
3217cb42 1243 *
4f57fa8c 1244 * @param timestamp timestamp in the time base of the given stream
3217cb42 1245 */
78cb7273
DB
1246int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1247 int size, int distance, int flags);
3217cb42
PI
1248
1249/**
49bd8e4b 1250 * Perform a binary search using av_index_search_timestamp() and
3673f4ab 1251 * AVInputFormat.read_timestamp().
78cb7273
DB
1252 * This is not supposed to be called directly by a user application,
1253 * but by demuxers.
3217cb42
PI
1254 * @param target_ts target timestamp in the time base of the given stream
1255 * @param stream_index stream number
1256 */
78cb7273
DB
1257int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1258 int64_t target_ts, int flags);
3217cb42
PI
1259
1260/**
49bd8e4b 1261 * Update cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1262 *
4f57fa8c
DB
1263 * Stream ref_st unchanged, others set cur_dts in their native time base.
1264 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1265 * @param timestamp new dts expressed in time_base of param ref_st
1266 * @param ref_st reference stream giving time_base of param timestamp
1267 */
22ffac70 1268void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1269
1270/**
49bd8e4b 1271 * Perform a binary search using read_timestamp().
78cb7273
DB
1272 * This is not supposed to be called directly by a user application,
1273 * but by demuxers.
3217cb42
PI
1274 * @param target_ts target timestamp in the time base of the given stream
1275 * @param stream_index stream number
1276 */
78cb7273
DB
1277int64_t av_gen_search(AVFormatContext *s, int stream_index,
1278 int64_t target_ts, int64_t pos_min,
1279 int64_t pos_max, int64_t pos_limit,
1280 int64_t ts_min, int64_t ts_max,
1281 int flags, int64_t *ts_ret,
1282 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1283
76c56376
MN
1284/**
1285 * media file output
1286 */
290c5fa6 1287int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1288
1289/**
f3bfe388
MR
1290 * Split a URL string into components.
1291 *
1292 * The pointers to buffers for storing individual components may be null,
1293 * in order to ignore that component. Buffers for components not found are
1294 * set to empty strings. If the port is not found, it is set to a negative
1295 * value.
1296 *
1297 * @param proto the buffer for the protocol
1298 * @param proto_size the size of the proto buffer
1299 * @param authorization the buffer for the authorization
1300 * @param authorization_size the size of the authorization buffer
1301 * @param hostname the buffer for the host name
1302 * @param hostname_size the size of the hostname buffer
1303 * @param port_ptr a pointer to store the port number in
1304 * @param path the buffer for the path
1305 * @param path_size the size of the path buffer
1306 * @param url the URL to split
1307 */
1308void av_url_split(char *proto, int proto_size,
1309 char *authorization, int authorization_size,
1310 char *hostname, int hostname_size,
1311 int *port_ptr,
1312 char *path, int path_size,
1313 const char *url);
1314
1315/**
49bd8e4b 1316 * Allocate the stream private data and write the stream header to an
755bfeab 1317 * output media file.
5d820db2
RD
1318 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1319 * but for some formats it might also be some other time base
3217cb42
PI
1320 *
1321 * @param s media file handle
4f57fa8c 1322 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1323 */
b9a281db 1324int av_write_header(AVFormatContext *s);
3217cb42
PI
1325
1326/**
49bd8e4b 1327 * Write a packet to an output media file.
3217cb42
PI
1328 *
1329 * The packet shall contain one audio or video frame.
78cb7273
DB
1330 * The packet must be correctly interleaved according to the container
1331 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1332 *
1333 * @param s media file handle
78cb7273
DB
1334 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1335 dts/pts, ...
4f57fa8c 1336 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1337 */
e928649b 1338int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1339
1340/**
49bd8e4b 1341 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1342 *
1343 * The packet must contain one audio or video frame.
22e77e44 1344 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1345 * call av_write_frame() instead as it is slightly faster. It is also important
1346 * to keep in mind that completely non-interleaved input will need huge amounts
1347 * of memory to interleave with this, so it is preferable to interleave at the
1348 * demuxer level.
3217cb42
PI
1349 *
1350 * @param s media file handle
78cb7273
DB
1351 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1352 dts/pts, ...
4f57fa8c 1353 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1354 */
3c895fc0 1355int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1356
1357/**
49bd8e4b 1358 * Interleave a packet per dts in an output media file.
3217cb42 1359 *
78cb7273 1360 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1361 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1362 * on them is still safe.
3217cb42
PI
1363 *
1364 * @param s media file handle
1365 * @param out the interleaved packet will be output here
9a58234f 1366 * @param pkt the input packet
3217cb42
PI
1367 * @param flush 1 if no further packets are available as input and all
1368 * remaining packets should be output
1369 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1370 * < 0 if an error occurred
3217cb42 1371 */
78cb7273
DB
1372int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1373 AVPacket *pkt, int flush);
e928649b 1374
3217cb42 1375/**
49bd8e4b 1376 * Write the stream trailer to an output media file and free the
2b75bde6 1377 * file private data.
3217cb42 1378 *
dc76fe13
RD
1379 * May only be called after a successful call to av_write_header.
1380 *
3217cb42 1381 * @param s media file handle
4f57fa8c 1382 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1383 */
b9a281db 1384int av_write_trailer(AVFormatContext *s);
de6d9b64 1385
610219a5
AK
1386#if FF_API_DUMP_FORMAT
1387attribute_deprecated void dump_format(AVFormatContext *ic,
1388 int index,
1389 const char *url,
1390 int is_output);
1391#endif
1392
1393void av_dump_format(AVFormatContext *ic,
1394 int index,
1395 const char *url,
1396 int is_output);
3217cb42 1397
f6c7375a 1398#if FF_API_PARSE_DATE
3217cb42 1399/**
49bd8e4b 1400 * Parse datestr and return a corresponding number of microseconds.
f6c7375a 1401 *
f9436161 1402 * @param datestr String representing a date or a duration.
f6c7375a
SS
1403 * See av_parse_time() for the syntax of the provided string.
1404 * @deprecated in favor of av_parse_time()
3217cb42 1405 */
f6c7375a 1406attribute_deprecated
0c1a9eda 1407int64_t parse_date(const char *datestr, int duration);
f6c7375a 1408#endif
de6d9b64 1409
76c56376
MN
1410/**
1411 * Get the current time in microseconds.
1412 */
0c1a9eda 1413int64_t av_gettime(void);
94988531 1414
ab0287fc 1415#if FF_API_FIND_INFO_TAG
3217cb42 1416/**
ab0287fc 1417 * @deprecated use av_find_info_tag in libavutil instead.
3217cb42 1418 */
ab0287fc
AK
1419attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1420#endif
de6d9b64 1421
3217cb42 1422/**
49bd8e4b 1423 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1424 *
3217cb42
PI
1425 * Also handles the '%0nd' format where 'n' is the total number
1426 * of digits and '%%'.
1427 *
1428 * @param buf destination buffer
1429 * @param buf_size destination buffer size
1430 * @param path numbered sequence string
8ea0e802 1431 * @param number frame number
4f57fa8c 1432 * @return 0 if OK, -1 on format error
3217cb42 1433 */
5c07cf53
MB
1434int av_get_frame_filename(char *buf, int buf_size,
1435 const char *path, int number);
3217cb42
PI
1436
1437/**
49bd8e4b 1438 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1439 *
1440 * @param filename possible numbered sequence string
4f57fa8c 1441 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1442 */
5c07cf53 1443int av_filename_number_test(const char *filename);
96baaa6a 1444
c5388c07 1445/**
49bd8e4b 1446 * Generate an SDP for an RTP session.
c5388c07
LA
1447 *
1448 * @param ac array of AVFormatContexts describing the RTP streams. If the
1449 * array is composed by only one context, such context can contain
1450 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1451 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1452 * must contain only one AVStream.
8767b80f 1453 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1454 * @param buf buffer where the SDP will be stored (must be allocated by
1455 * the caller)
8767b80f 1456 * @param size the size of the buffer
4f57fa8c 1457 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1458 */
c234d40b 1459int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe
AK
1460
1461#if FF_API_SDP_CREATE
1462attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1463#endif
c5388c07 1464
1a70d127 1465/**
49bd8e4b 1466 * Return a positive value if the given filename has one of the given
1a70d127
SS
1467 * extensions, 0 otherwise.
1468 *
1469 * @param extensions a comma-separated list of filename extensions
1470 */
1471int av_match_ext(const char *filename, const char *extensions);
1472
98790382 1473#endif /* AVFORMAT_AVFORMAT_H */