Schedule refreshes from a thread that actually knows the PTS.
[libav.git] / libavformat / avformat.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVFORMAT_AVFORMAT_H
22#define AVFORMAT_AVFORMAT_H
de6d9b64 23
800c289a 24#define LIBAVFORMAT_VERSION_MAJOR 52
40da0b36 25#define LIBAVFORMAT_VERSION_MINOR 49
7c3c53c8 26#define LIBAVFORMAT_VERSION_MICRO 0
e97ac1e6 27
800c289a
MR
28#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29 LIBAVFORMAT_VERSION_MINOR, \
30 LIBAVFORMAT_VERSION_MICRO)
31#define LIBAVFORMAT_VERSION AV_VERSION(LIBAVFORMAT_VERSION_MAJOR, \
32 LIBAVFORMAT_VERSION_MINOR, \
33 LIBAVFORMAT_VERSION_MICRO)
5aa083ee 34#define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
8026c3b5 35
5aa083ee 36#define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
4b1f4f23 37
c97429e2 38/**
f2e77e4b
AC
39 * I return the LIBAVFORMAT_VERSION_INT constant. You got
40 * a fucking problem with that, douchebag?
c97429e2
SS
41 */
42unsigned avformat_version(void);
43
c1736936
DB
44/**
45 * Returns the libavformat build-time configuration.
46 */
41600690 47const char *avformat_configuration(void);
c1736936
DB
48
49/**
50 * Returns the libavformat license.
51 */
41600690 52const char *avformat_license(void);
c1736936 53
f71869a4 54#include <time.h>
67070e4f 55#include <stdio.h> /* FILE */
76a448ed 56#include "libavcodec/avcodec.h"
de6d9b64 57
de6d9b64
FB
58#include "avio.h"
59
f610a9f2
AJ
60struct AVFormatContext;
61
a6d18a0e
MN
62
63/*
ea29242c
MM
64 * Public Metadata API.
65 * The metadata API allows libavformat to export metadata tags to a client
66 * application using a sequence of key/value pairs.
67 * Important concepts to keep in mind:
68 * 1. Keys are unique; there can never be 2 tags with the same key. This is
69 * also meant semantically, i.e., a demuxer should not knowingly produce
70 * several keys that are literally different but semantically identical.
71 * E.g., key=Author5, key=Author6. In this example, all authors must be
72 * placed in the same tag.
73 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
74 * want to store, e.g., the email address of the child of producer Alice
75 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
76 * 3. A tag whose value is localized for a particular language is appended
7e030c47 77 * with a dash character ('-') and the ISO 639-2/B 3-letter language code.
ea29242c
MM
78 * For example: Author-ger=Michael, Author-eng=Mike
79 * The original/default language is in the unqualified "Author" tag.
a6d18a0e
MN
80 * A demuxer should set a default if it sets any translated tag.
81 */
82
48a81c0f 83#define AV_METADATA_MATCH_CASE 1
a6d18a0e 84#define AV_METADATA_IGNORE_SUFFIX 2
a181981e
MN
85#define AV_METADATA_DONT_STRDUP_KEY 4
86#define AV_METADATA_DONT_STRDUP_VAL 8
a6d18a0e
MN
87
88typedef struct {
89 char *key;
90 char *value;
bc1d2afb 91}AVMetadataTag;
a6d18a0e 92
e232c252 93typedef struct AVMetadata AVMetadata;
f610a9f2 94typedef struct AVMetadataConv AVMetadataConv;
a6d18a0e
MN
95
96/**
22e77e44
DB
97 * Gets a metadata element with matching key.
98 * @param prev Set to the previous matching element to find the next.
99 * @param flags Allows case as well as suffix-insensitive comparisons.
100 * @return Found tag or NULL, changing key or value leads to undefined behavior.
a6d18a0e 101 */
bc1d2afb 102AVMetadataTag *
e232c252 103av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
a6d18a0e 104
a181981e 105#if LIBAVFORMAT_VERSION_MAJOR == 52
a6d18a0e 106/**
22e77e44
DB
107 * Sets the given tag in m, overwriting an existing tag.
108 * @param key tag key to add to m (will be av_strduped)
109 * @param value tag value to add to m (will be av_strduped)
110 * @return >= 0 on success otherwise an error code <0
a6d18a0e 111 */
5ea7ce88 112int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
a181981e
MN
113#endif
114
115/**
116 * Sets the given tag in m, overwriting an existing tag.
117 * @param key tag key to add to m (will be av_strduped depending on flags)
118 * @param value tag value to add to m (will be av_strduped depending on flags)
119 * @return >= 0 on success otherwise an error code <0
120 */
121int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
a6d18a0e 122
094d9df7 123/**
d1b9adf2 124 * Converts all the metadata sets from ctx according to the source and
f610a9f2
AJ
125 * destination conversion tables.
126 * @param d_conv destination tags format conversion table
127 * @param s_conv source tags format conversion table
128 */
129void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
130 const AVMetadataConv *s_conv);
131
132/**
22e77e44 133 * Frees all the memory allocated for an AVMetadata struct.
094d9df7
AJ
134 */
135void av_metadata_free(AVMetadata **m);
136
a6d18a0e 137
de6d9b64
FB
138/* packet functions */
139
3217cb42
PI
140
141/**
d1b9adf2
SS
142 * Allocates and reads the payload of a packet and initializes its
143 * fields with default values.
3217cb42
PI
144 *
145 * @param pkt packet
4f57fa8c
DB
146 * @param size desired payload size
147 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 148 */
2692067a 149int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
3217cb42 150
de6d9b64
FB
151
152/*************************************************/
916c80e9
FB
153/* fractional numbers for exact pts handling */
154
671adb17 155/**
4f57fa8c
DB
156 * The exact value of the fractional number is: 'val + num / den'.
157 * num is assumed to be 0 <= num < den.
4c08b2bd 158 */
916c80e9 159typedef struct AVFrac {
115329f1 160 int64_t val, num, den;
52e57500 161} AVFrac;
916c80e9 162
916c80e9 163/*************************************************/
b9a281db 164/* input/output formats */
de6d9b64 165
7caf0cc6
MN
166struct AVCodecTag;
167
4f57fa8c 168/** This structure contains the data a format has to probe a file. */
b9a281db 169typedef struct AVProbeData {
5c91a675 170 const char *filename;
e5f58f81 171 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
172 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
173} AVProbeData;
174
22e77e44 175#define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
87e87886 176#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
177
178typedef struct AVFormatParameters {
c0df9d75 179 AVRational time_base;
de6d9b64
FB
180 int sample_rate;
181 int channels;
182 int width;
183 int height;
4606ac8d 184 enum PixelFormat pix_fmt;
4f57fa8c
DB
185 int channel; /**< Used to select DV channel. */
186 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
187 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
188 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
72e043dd 189 stream packet (only meaningful if
4f57fa8c
DB
190 mpeg2ts_raw is TRUE). */
191 unsigned int initial_pause:1; /**< Do not begin to play the stream
192 immediately (RTSP only). */
72e043dd 193 unsigned int prealloced_context:1;
71957315 194#if LIBAVFORMAT_VERSION_INT < (53<<16)
5b6d5596
MN
195 enum CodecID video_codec_id;
196 enum CodecID audio_codec_id;
71957315 197#endif
de6d9b64
FB
198} AVFormatParameters;
199
4f57fa8c 200//! Demuxer will use url_fopen, no opened file should be provided by the caller.
40d9c544 201#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
202#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
203#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
204#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
205 raw picture data. */
206#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
207#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
208#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
209#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
25918212 210#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
b9a281db
FB
211
212typedef struct AVOutputFormat {
de6d9b64 213 const char *name;
bde15e74
SS
214 /**
215 * Descriptive name for the format, meant to be more human-readable
819174fa 216 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
217 * to define it.
218 */
de6d9b64
FB
219 const char *long_name;
220 const char *mime_type;
4f57fa8c 221 const char *extensions; /**< comma-separated filename extensions */
22e77e44 222 /** size of private data so that it can be allocated in the wrapper */
b9a281db 223 int priv_data_size;
de6d9b64 224 /* output support */
43d414ba
PI
225 enum CodecID audio_codec; /**< default audio codec */
226 enum CodecID video_codec; /**< default video codec */
de6d9b64 227 int (*write_header)(struct AVFormatContext *);
e928649b 228 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 229 int (*write_trailer)(struct AVFormatContext *);
43d414ba 230 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
b9a281db 231 int flags;
4f57fa8c 232 /** Currently only used to set pixel format if not YUV420P. */
290c5fa6 233 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
234 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
235 AVPacket *in, int flush);
7caf0cc6
MN
236
237 /**
78cb7273 238 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 239 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 240 */
c1854592 241 const struct AVCodecTag * const *codec_tag;
7caf0cc6 242
11bf3847
AJ
243 enum CodecID subtitle_codec; /**< default subtitle codec */
244
719e721a 245 const AVMetadataConv *metadata_conv;
f610a9f2 246
b9a281db
FB
247 /* private fields */
248 struct AVOutputFormat *next;
249} AVOutputFormat;
de6d9b64 250
b9a281db
FB
251typedef struct AVInputFormat {
252 const char *name;
bde15e74
SS
253 /**
254 * Descriptive name for the format, meant to be more human-readable
819174fa 255 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
256 * to define it.
257 */
b9a281db 258 const char *long_name;
4f57fa8c 259 /** Size of private data so that it can be allocated in the wrapper. */
b9a281db 260 int priv_data_size;
65d7d68b 261 /**
22e77e44 262 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
263 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
264 * big so you do not have to check for that unless you need more.
65d7d68b 265 */
b9a281db 266 int (*read_probe)(AVProbeData *);
4f57fa8c
DB
267 /** Read the format header and initialize the AVFormatContext
268 structure. Return 0 if OK. 'ap' if non-NULL contains
269 additional parameters. Only used in raw format right
b9a281db 270 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
271 int (*read_header)(struct AVFormatContext *,
272 AVFormatParameters *ap);
4f57fa8c 273 /** Read one packet and put it in 'pkt'. pts and flags are also
b9a281db 274 set. 'av_new_stream' can be called only if the flag
6883ebe4
RD
275 AVFMTCTX_NOHEADER is used.
276 @return 0 on success, < 0 on error.
277 When returning an error, pkt must not have been allocated
278 or must be freed before returning */
de6d9b64 279 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
4f57fa8c 280 /** Close the stream. The AVFormatContext and AVStreams are not
de6d9b64
FB
281 freed by this function */
282 int (*read_close)(struct AVFormatContext *);
1de2db8f
MN
283
284#if LIBAVFORMAT_VERSION_MAJOR < 53
115329f1 285 /**
4f57fa8c
DB
286 * Seek to a given timestamp relative to the frames in
287 * stream component stream_index.
22e77e44
DB
288 * @param stream_index Must not be -1.
289 * @param flags Selects which direction should be preferred if no exact
290 * match is available.
05ce0f11 291 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 292 */
115329f1 293 int (*read_seek)(struct AVFormatContext *,
3ba1438d 294 int stream_index, int64_t timestamp, int flags);
1de2db8f 295#endif
8d14a25c 296 /**
4f57fa8c 297 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 298 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
299 */
300 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
301 int64_t *pos, int64_t pos_limit);
4f57fa8c 302 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
de6d9b64 303 int flags;
4f57fa8c 304 /** If extensions are defined, then no probe is done. You should
b9a281db
FB
305 usually not use extension format guessing because it is not
306 reliable enough */
307 const char *extensions;
4f57fa8c 308 /** General purpose read-only value that the format can use. */
b9a281db 309 int value;
fb2758c8 310
d1b9adf2 311 /** Starts/resumes playing - only meaningful if using a network-based format
4f57fa8c 312 (RTSP). */
fb2758c8
FB
313 int (*read_play)(struct AVFormatContext *);
314
d1b9adf2 315 /** Pauses playing - only meaningful if using a network-based format
4f57fa8c 316 (RTSP). */
fb2758c8
FB
317 int (*read_pause)(struct AVFormatContext *);
318
c1854592 319 const struct AVCodecTag * const *codec_tag;
7caf0cc6 320
1de2db8f 321 /**
d1b9adf2 322 * Seeks to timestamp ts.
1de2db8f
MN
323 * Seeking will be done so that the point from which all active streams
324 * can be presented successfully will be closest to ts and within min/max_ts.
325 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
326 */
882fb0a3 327 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 328
719e721a 329 const AVMetadataConv *metadata_conv;
f610a9f2 330
b9a281db
FB
331 /* private fields */
332 struct AVInputFormat *next;
333} AVInputFormat;
de6d9b64 334
57004ff1
AJ
335enum AVStreamParseType {
336 AVSTREAM_PARSE_NONE,
337 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 338 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 339 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
57004ff1
AJ
340};
341
fb2758c8
FB
342typedef struct AVIndexEntry {
343 int64_t pos;
344 int64_t timestamp;
345#define AVINDEX_KEYFRAME 0x0001
30a43f2d 346 int flags:2;
4f57fa8c
DB
347 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).
348 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
349} AVIndexEntry;
350
90c2295b
ES
351#define AV_DISPOSITION_DEFAULT 0x0001
352#define AV_DISPOSITION_DUB 0x0002
353#define AV_DISPOSITION_ORIGINAL 0x0004
354#define AV_DISPOSITION_COMMENT 0x0008
355#define AV_DISPOSITION_LYRICS 0x0010
356#define AV_DISPOSITION_KARAOKE 0x0020
357
ba66ae94
MN
358/**
359 * Stream structure.
360 * New fields can be added to the end with minor version bumps.
8bfb108b 361 * Removal, reordering and changes to existing fields require a major
ba66ae94 362 * version bump.
8bfb108b 363 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 364 */
de6d9b64 365typedef struct AVStream {
43d414ba 366 int index; /**< stream index in AVFormatContext */
4f57fa8c 367 int id; /**< format-specific stream ID */
43d414ba 368 AVCodecContext *codec; /**< codec context */
b4b87d48 369 /**
22e77e44
DB
370 * Real base framerate of the stream.
371 * This is the lowest framerate with which all timestamps can be
864ff8c1 372 * represented accurately (it is the least common multiple of all
22e77e44
DB
373 * framerates in the stream). Note, this value is just a guess!
374 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 375 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
376 */
377 AVRational r_frame_rate;
de6d9b64 378 void *priv_data;
82583548 379
b9a281db 380 /* internal data used in av_find_stream_info() */
82583548 381 int64_t first_dts;
4f57fa8c 382 /** encoding: pts generation when outputting stream */
a9fd2b19 383 struct AVFrac pts;
5b28c8c3
MN
384
385 /**
8bfb108b
DB
386 * This is the fundamental unit of time (in seconds) in terms
387 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 388 * time base should be 1/framerate and timestamp increments should be 1.
5b28c8c3 389 */
9ee91c2f 390 AVRational time_base;
43d414ba 391 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 392 /* ffmpeg.c private use */
4f57fa8c
DB
393 int stream_copy; /**< If set, just copy stream. */
394 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
b4aea108 395 //FIXME move stuff to a flags field?
4f57fa8c 396 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
755bfeab 397 * MN: dunno if that is the right place for it */
115329f1 398 float quality;
6d96a9b9 399 /**
8bfb108b
DB
400 * Decoding: pts of the first frame of the stream, in stream time base.
401 * Only set this if you are absolutely 100% sure that the value you set
402 * it to really is the pts of the first frame.
4854c253 403 * This may be undefined (AV_NOPTS_VALUE).
8bfb108b
DB
404 * @note The ASF header does NOT contain a correct start_time the ASF
405 * demuxer must NOT set this.
6d96a9b9 406 */
115329f1 407 int64_t start_time;
e26381b6 408 /**
8bfb108b 409 * Decoding: duration of the stream, in stream time base.
e26381b6 410 * If a source file does not specify a duration, but does specify
4f57fa8c 411 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 412 */
ee404803 413 int64_t duration;
fb2758c8 414
827f7e28 415#if LIBAVFORMAT_VERSION_INT < (53<<16)
7e030c47 416 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
827f7e28 417#endif
09730260 418
fb2758c8 419 /* av_read_frame() support */
57004ff1 420 enum AVStreamParseType need_parsing;
fb2758c8 421 struct AVCodecParserContext *parser;
6ec87caa 422
fb2758c8 423 int64_t cur_dts;
635fbcb1
MN
424 int last_IP_duration;
425 int64_t last_IP_pts;
fb2758c8 426 /* av_seek_frame() support */
4f57fa8c
DB
427 AVIndexEntry *index_entries; /**< Only used if the format does not
428 support seeking natively. */
fb2758c8 429 int nb_index_entries;
191e8ca7 430 unsigned int index_entries_allocated_size;
115329f1 431
b4b87d48 432 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 433
0d84a8f6
BC
434#if LIBAVFORMAT_VERSION_INT < (53<<16)
435 int64_t unused[4+1];
f8d7c9d3
ES
436
437 char *filename; /**< source filename of the stream */
827f7e28 438#endif
90c2295b 439
4f57fa8c 440 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
441
442 AVProbeData probe_data;
0d84a8f6
BC
443#define MAX_REORDER_DELAY 16
444 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
445
446 /**
447 * sample aspect ratio (0 if unknown)
448 * - encoding: Set by user.
449 * - decoding: Set by libavformat.
450 */
451 AVRational sample_aspect_ratio;
f526adaf 452
e232c252 453 AVMetadata *metadata;
3a41c2f7
MN
454
455 /* av_read_frame() support */
456 const uint8_t *cur_ptr;
457 int cur_len;
458 AVPacket cur_pkt;
27ca0a79
IS
459
460 // Timestamp generation support:
461 /**
462 * Timestamp corresponding to the last dts sync point.
463 *
464 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
465 * a DTS is received from the underlying container. Otherwise set to
466 * AV_NOPTS_VALUE by default.
467 */
468 int64_t reference_dts;
86cb7e33
BC
469
470 /**
471 * Number of packets to buffer for codec probing
472 * NOT PART OF PUBLIC API
473 */
48616887 474#define MAX_PROBE_PACKETS 2500
86cb7e33 475 int probe_packets;
ddce56ef
MN
476
477 /**
e07b882b 478 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
479 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
480 */
e07b882b 481 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
482
483 /**
484 * Average framerate
485 */
486 AVRational avg_frame_rate;
de6d9b64
FB
487} AVStream;
488
15afa396
NS
489#define AV_PROGRAM_RUNNING 1
490
ba66ae94 491/**
ba66ae94 492 * New fields can be added to the end with minor version bumps.
8bfb108b 493 * Removal, reordering and changes to existing fields require a major
ba66ae94 494 * version bump.
8bfb108b 495 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 496 */
15afa396
NS
497typedef struct AVProgram {
498 int id;
827f7e28 499#if LIBAVFORMAT_VERSION_INT < (53<<16)
4f57fa8c
DB
500 char *provider_name; ///< network name for DVB streams
501 char *name; ///< service name for DVB streams
827f7e28 502#endif
15afa396
NS
503 int flags;
504 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
505 unsigned int *stream_index;
506 unsigned int nb_stream_indexes;
e232c252 507 AVMetadata *metadata;
15afa396
NS
508} AVProgram;
509
43d414ba 510#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
511 (streams are added dynamically) */
512
79d7836a 513typedef struct AVChapter {
4f57fa8c
DB
514 int id; ///< unique ID to identify the chapter
515 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 516 int64_t start, end; ///< chapter start/end time in time_base units
827f7e28 517#if LIBAVFORMAT_VERSION_INT < (53<<16)
c2fb6be4 518 char *title; ///< chapter title
827f7e28 519#endif
e232c252 520 AVMetadata *metadata;
79d7836a
AK
521} AVChapter;
522
ad5cc780 523#if LIBAVFORMAT_VERSION_MAJOR < 53
de6d9b64 524#define MAX_STREAMS 20
ad5cc780
JM
525#else
526#define MAX_STREAMS 100
527#endif
de6d9b64 528
252f17e2 529/**
4f57fa8c 530 * Format I/O context.
252f17e2 531 * New fields can be added to the end with minor version bumps.
8bfb108b 532 * Removal, reordering and changes to existing fields require a major
252f17e2 533 * version bump.
8bfb108b 534 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 535 */
de6d9b64 536typedef struct AVFormatContext {
1447aac4 537 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 538 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
539 struct AVInputFormat *iformat;
540 struct AVOutputFormat *oformat;
de6d9b64 541 void *priv_data;
899681cd 542 ByteIOContext *pb;
db69c2e5 543 unsigned int nb_streams;
de6d9b64 544 AVStream *streams[MAX_STREAMS];
43d414ba 545 char filename[1024]; /**< input or output filename */
de6d9b64 546 /* stream info */
4568325a 547 int64_t timestamp;
827f7e28 548#if LIBAVFORMAT_VERSION_INT < (53<<16)
de6d9b64
FB
549 char title[512];
550 char author[512];
551 char copyright[512];
552 char comment[512];
6a58e151 553 char album[512];
43d414ba
PI
554 int year; /**< ID3 year, 0 if none */
555 int track; /**< track number, 0 if none */
556 char genre[32]; /**< ID3 genre */
827f7e28 557#endif
6a58e151 558
4f57fa8c
DB
559 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
560 /* private data for pts handling (do not modify directly). */
43d414ba 561 /** This buffer is only needed when packets were already buffered but
4f57fa8c
DB
562 not decoded, for example to get the codec parameters in MPEG
563 streams. */
ee404803
FB
564 struct AVPacketList *packet_buffer;
565
4f57fa8c 566 /** Decoding: position of the first frame of the component, in
ee404803 567 AV_TIME_BASE fractional seconds. NEVER set this value directly:
4f57fa8c 568 It is deduced from the AVStream values. */
115329f1 569 int64_t start_time;
4f57fa8c 570 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
ee404803
FB
571 seconds. NEVER set this value directly: it is deduced from the
572 AVStream values. */
573 int64_t duration;
4f57fa8c 574 /** decoding: total file size, 0 if unknown */
ee404803 575 int64_t file_size;
4f57fa8c 576 /** Decoding: total stream bitrate in bit/s, 0 if not
ee404803 577 available. Never set it directly if the file_size and the
22e77e44 578 duration are known as FFmpeg can compute it automatically. */
ee404803 579 int bit_rate;
fb2758c8
FB
580
581 /* av_read_frame() support */
582 AVStream *cur_st;
3a41c2f7
MN
583#if LIBAVFORMAT_VERSION_INT < (53<<16)
584 const uint8_t *cur_ptr_deprecated;
585 int cur_len_deprecated;
586 AVPacket cur_pkt_deprecated;
587#endif
fb2758c8 588
fb2758c8 589 /* av_seek_frame() support */
43d414ba 590 int64_t data_offset; /** offset of the first packet */
fb2758c8 591 int index_built;
115329f1 592
2db3c638 593 int mux_rate;
92400be2 594 unsigned int packet_size;
17c88cb0
MN
595 int preload;
596 int max_delay;
8108551a 597
115329f1
DB
598#define AVFMT_NOOUTPUTLOOP -1
599#define AVFMT_INFINITEOUTPUTLOOP 0
43d414ba 600 /** number of times to loop output in formats that support it */
8108551a 601 int loop_output;
115329f1 602
30bc6613 603 int flags;
22e77e44 604#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
605#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
606#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 607#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
5894e1bb
VP
608
609 int loop_input;
22e77e44 610 /** decoding: size of data to probe; encoding: unused. */
9e6c9470 611 unsigned int probesize;
a44b3c4d
MN
612
613 /**
4f57fa8c
DB
614 * Maximum time (in AV_TIME_BASE units) during which the input should
615 * be analyzed in av_find_stream_info().
a44b3c4d
MN
616 */
617 int max_analyze_duration;
c964c2c7
RD
618
619 const uint8_t *key;
620 int keylen;
15afa396
NS
621
622 unsigned int nb_programs;
623 AVProgram **programs;
62600469
MN
624
625 /**
626 * Forced video codec_id.
4f57fa8c 627 * Demuxing: Set by user.
62600469
MN
628 */
629 enum CodecID video_codec_id;
630 /**
631 * Forced audio codec_id.
4f57fa8c 632 * Demuxing: Set by user.
62600469
MN
633 */
634 enum CodecID audio_codec_id;
635 /**
636 * Forced subtitle codec_id.
4f57fa8c 637 * Demuxing: Set by user.
62600469
MN
638 */
639 enum CodecID subtitle_codec_id;
3dea63bd
PK
640
641 /**
22e77e44
DB
642 * Maximum amount of memory in bytes to use for the index of each stream.
643 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
644 * needed to maintain a smaller size. This can lead to slower or less
645 * accurate seeking (depends on demuxer).
4f57fa8c 646 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
647 * this.
648 * muxing : unused
649 * demuxing: set by user
650 */
651 unsigned int max_index_size;
ab8ab30c
RP
652
653 /**
ffa71b2b 654 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 655 * obtained from realtime capture devices.
ab8ab30c
RP
656 */
657 unsigned int max_picture_buffer;
79d7836a 658
fbabf1e9 659 unsigned int nb_chapters;
79d7836a 660 AVChapter **chapters;
45b2b05f
MN
661
662 /**
4f57fa8c 663 * Flags to enable debugging.
45b2b05f
MN
664 */
665 int debug;
666#define FF_FDEBUG_TS 0x0001
0bef08e5
MN
667
668 /**
4f57fa8c 669 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
670 * This buffer is used for buffering packets until the codec can
671 * be identified, as parsing cannot be done without knowing the
672 * codec.
673 */
674 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
675 struct AVPacketList *raw_packet_buffer_end;
676
677 struct AVPacketList *packet_buffer_end;
47146dfb 678
e232c252 679 AVMetadata *metadata;
af122d6a
BC
680
681 /**
682 * Remaining size available for raw_packet_buffer, in bytes.
683 * NOT PART OF PUBLIC API
684 */
48616887 685#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 686 int raw_packet_buffer_remaining_size;
de6d9b64
FB
687} AVFormatContext;
688
689typedef struct AVPacketList {
690 AVPacket pkt;
691 struct AVPacketList *next;
692} AVPacketList;
693
84be6e72 694#if LIBAVFORMAT_VERSION_INT < (53<<16)
b9a281db
FB
695extern AVInputFormat *first_iformat;
696extern AVOutputFormat *first_oformat;
84be6e72
MN
697#endif
698
aeedac95
SS
699/**
700 * If f is NULL, returns the first registered input format,
22e77e44 701 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
702 * or NULL if f is the last one.
703 */
84be6e72 704AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
705
706/**
707 * If f is NULL, returns the first registered output format,
22e77e44 708 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
709 * or NULL if f is the last one.
710 */
84be6e72 711AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 712
5b6d5596 713enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 714
22e77e44
DB
715/* XXX: Use automatic init with either ELF sections or C file parser */
716/* modules. */
de6d9b64 717
b9a281db 718/* utils.c */
b9a281db
FB
719void av_register_input_format(AVInputFormat *format);
720void av_register_output_format(AVOutputFormat *format);
1642ee43
SS
721#if LIBAVFORMAT_VERSION_MAJOR < 53
722attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
78cb7273
DB
723 const char *filename,
724 const char *mime_type);
a1f547b9
SS
725
726/**
727 * @deprecated Use av_guess_format() instead.
728 */
729attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
730 const char *filename,
731 const char *mime_type);
1642ee43 732#endif
f48b0fa2
SS
733
734/**
735 * Returns the output format in the list of registered output formats
736 * which best matches the provided parameters, or returns NULL if
737 * there is no match.
738 *
739 * @param short_name if non-NULL checks if short_name matches with the
740 * names of the registered formats
741 * @param filename if non-NULL checks if filename terminates with the
742 * extensions of the registered formats
743 * @param mime_type if non-NULL checks if mime_type matches with the
744 * MIME type of the registered formats
745 */
a1f547b9 746AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
747 const char *filename,
748 const char *mime_type);
3217cb42
PI
749
750/**
4f57fa8c 751 * Guesses the codec ID based upon muxer and filename.
3217cb42 752 */
115329f1 753enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273
DB
754 const char *filename, const char *mime_type,
755 enum CodecType type);
de6d9b64 756
3217cb42 757/**
d1b9adf2 758 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
759 *
760 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
761 * @param buf buffer
762 * @param size buffer size
750f0e1f
PI
763 *
764 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 765 */
fb2758c8 766void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
767
768/**
d1b9adf2 769 * Sends a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
770 *
771 * @param avcl A pointer to an arbitrary struct of which the first field is a
772 * pointer to an AVClass struct.
773 * @param level The importance level of the message, lower values signifying
774 * higher importance.
775 * @param buf buffer
776 * @param size buffer size
777 *
778 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
779 */
780void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
781
782/**
d1b9adf2 783 * Sends a nice dump of a packet to the specified file stream.
750f0e1f
PI
784 *
785 * @param f The file stream pointer where the dump should be sent to.
3217cb42 786 * @param pkt packet to dump
4f57fa8c 787 * @param dump_payload True if the payload must be displayed, too.
3217cb42 788 */
fb2758c8 789void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 790
750f0e1f 791/**
d1b9adf2 792 * Sends a nice dump of a packet to the log.
750f0e1f
PI
793 *
794 * @param avcl A pointer to an arbitrary struct of which the first field is a
795 * pointer to an AVClass struct.
796 * @param level The importance level of the message, lower values signifying
797 * higher importance.
798 * @param pkt packet to dump
4f57fa8c 799 * @param dump_payload True if the payload must be displayed, too.
750f0e1f
PI
800 */
801void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
802
4815e246 803/**
d1b9adf2 804 * Initializes libavformat and registers all the muxers, demuxers and
4815e246
SS
805 * protocols. If you do not call this function, then you can select
806 * exactly which formats you want to support.
807 *
808 * @see av_register_input_format()
809 * @see av_register_output_format()
5d377501 810 * @see av_register_protocol()
4815e246 811 */
94988531 812void av_register_all(void);
de6d9b64 813
43d414ba 814/** codec tag <-> codec id */
15545a09
SS
815enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
816unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 817
b9a281db 818/* media file input */
3217cb42
PI
819
820/**
4f57fa8c 821 * Finds AVInputFormat based on the short name of the input format.
3217cb42 822 */
b9a281db 823AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
824
825/**
d1b9adf2 826 * Guesses the file format.
3217cb42 827 *
4f57fa8c
DB
828 * @param is_opened Whether the file is already opened; determines whether
829 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 830 */
94988531 831AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
832
833/**
834 * Allocates all the structures needed to read an input stream.
835 * This does not open the needed codecs for decoding the stream[s].
836 */
115329f1
DB
837int av_open_input_stream(AVFormatContext **ic_ptr,
838 ByteIOContext *pb, const char *filename,
da24c5e3 839 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
840
841/**
d1b9adf2 842 * Opens a media file as input. The codecs are not opened. Only the file
3217cb42
PI
843 * header (if present) is read.
844 *
4f57fa8c
DB
845 * @param ic_ptr The opened media file handle is put here.
846 * @param filename filename to open
847 * @param fmt If non-NULL, force the file format to use.
3217cb42 848 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
849 * @param ap Additional parameters needed when opening the file
850 * (NULL if default).
4f57fa8c 851 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 852 */
115329f1 853int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
854 AVInputFormat *fmt,
855 int buf_size,
856 AVFormatParameters *ap);
88a28965
SS
857
858#if LIBAVFORMAT_VERSION_MAJOR < 53
859/**
860 * @deprecated Use avformat_alloc_context() instead.
861 */
862attribute_deprecated AVFormatContext *av_alloc_format_context(void);
863#endif
864
88808c60 865/**
d1b9adf2 866 * Allocates an AVFormatContext.
5d81d641 867 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
868 * explicitly allocated as well!
869 */
88a28965 870AVFormatContext *avformat_alloc_context(void);
b9a281db 871
3217cb42 872/**
d1b9adf2 873 * Reads packets of a media file to get stream information. This
3217cb42 874 * is useful for file formats with no headers such as MPEG. This
22e77e44 875 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
876 * frame mode.
877 * The logical file position is not changed by this function;
878 * examined packets may be buffered for later processing.
879 *
880 * @param ic media file handle
4f57fa8c
DB
881 * @return >=0 if OK, AVERROR_xxx on error
882 * @todo Let the user decide somehow what information is needed so that
883 * we do not waste time getting stuff the user does not need.
3217cb42 884 */
b9a281db 885int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
886
887/**
d1b9adf2 888 * Reads a transport packet from a media file.
3217cb42 889 *
864ff8c1 890 * This function is obsolete and should never be used.
3217cb42
PI
891 * Use av_read_frame() instead.
892 *
893 * @param s media file handle
894 * @param pkt is filled
4f57fa8c 895 * @return 0 if OK, AVERROR_xxx on error
3217cb42 896 */
de6d9b64 897int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
898
899/**
d1b9adf2 900 * Returns the next frame of a stream.
3217cb42
PI
901 *
902 * The returned packet is valid
903 * until the next av_read_frame() or until av_close_input_file() and
904 * must be freed with av_free_packet. For video, the packet contains
905 * exactly one frame. For audio, it contains an integer number of
906 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
907 * data). If the audio frames have a variable size (e.g. MPEG audio),
908 * then it contains one frame.
909 *
910 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 911 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
912 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
913 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
914 * decompress the payload.
915 *
4f57fa8c 916 * @return 0 if OK, < 0 on error or end of file
3217cb42 917 */
fb2758c8 918int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
919
920/**
d1b9adf2 921 * Seeks to the keyframe at timestamp.
3217cb42
PI
922 * 'timestamp' in 'stream_index'.
923 * @param stream_index If stream_index is (-1), a default
924 * stream is selected, and timestamp is automatically converted
925 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
926 * @param timestamp Timestamp in AVStream.time_base units
927 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
928 * @param flags flags which select direction and seeking mode
929 * @return >= 0 on success
930 */
78cb7273
DB
931int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
932 int flags);
3217cb42
PI
933
934/**
d1b9adf2 935 * Seeks to timestamp ts.
d04768fa
MN
936 * Seeking will be done so that the point from which all active streams
937 * can be presented successfully will be closest to ts and within min/max_ts.
938 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
939 *
22e77e44 940 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 941 * are the file position (this may not be supported by all demuxers).
22e77e44 942 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 943 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
944 * Otherwise all timestamps are in units of the stream selected by stream_index
945 * or if stream_index is -1, in AV_TIME_BASE units.
946 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
947 * keyframes (this may not be supported by all demuxers).
948 *
22e77e44 949 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
950 * @param min_ts smallest acceptable timestamp
951 * @param ts target timestamp
952 * @param max_ts largest acceptable timestamp
953 * @param flags flags
954 * @returns >=0 on success, error code otherwise
998b6f7c 955 *
22e77e44
DB
956 * @NOTE This is part of the new seek API which is still under construction.
957 * Thus do not use this yet. It may change at any time, do not expect
958 * ABI compatibility yet!
d04768fa
MN
959 */
960int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
961
962/**
d1b9adf2 963 * Starts playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 964 * current position.
3217cb42 965 */
fb2758c8 966int av_read_play(AVFormatContext *s);
3217cb42
PI
967
968/**
d1b9adf2 969 * Pauses a network-based stream (e.g. RTSP stream).
3217cb42
PI
970 *
971 * Use av_read_play() to resume it.
972 */
fb2758c8 973int av_read_pause(AVFormatContext *s);
3217cb42
PI
974
975/**
d1b9adf2 976 * Frees a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
977 * @param s context to free
978 */
979void av_close_input_stream(AVFormatContext *s);
980
981/**
d1b9adf2 982 * Closes a media file (but not its codecs).
3217cb42
PI
983 *
984 * @param s media file handle
985 */
de6d9b64 986void av_close_input_file(AVFormatContext *s);
3217cb42
PI
987
988/**
d1b9adf2 989 * Adds a new stream to a media file.
3217cb42
PI
990 *
991 * Can only be called in the read_header() function. If the flag
992 * AVFMTCTX_NOHEADER is in the format context, then new streams
993 * can be added in read_packet too.
994 *
995 * @param s media file handle
4f57fa8c 996 * @param id file-format-dependent stream ID
3217cb42 997 */
b9a281db 998AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 999AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1000
1001/**
d1b9adf2 1002 * Adds a new chapter.
79d7836a 1003 * This function is NOT part of the public API
4f57fa8c 1004 * and should ONLY be used by demuxers.
79d7836a
AK
1005 *
1006 * @param s media file handle
4f57fa8c 1007 * @param id unique ID for this chapter
abd2256d
MN
1008 * @param start chapter start time in time_base units
1009 * @param end chapter end time in time_base units
79d7836a 1010 * @param title chapter title
5c37f43a 1011 *
4f57fa8c 1012 * @return AVChapter or NULL on error
79d7836a 1013 */
78cb7273
DB
1014AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1015 int64_t start, int64_t end, const char *title);
79d7836a
AK
1016
1017/**
d1b9adf2 1018 * Sets the pts for a given stream.
3217cb42
PI
1019 *
1020 * @param s stream
1021 * @param pts_wrap_bits number of bits effectively used by the pts
1022 * (used for wrap control, 33 is the value for MPEG)
1023 * @param pts_num numerator to convert to seconds (MPEG: 1)
1024 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1025 */
9ee91c2f 1026void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1027 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1028
3ba1438d
MN
1029#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1030#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1031#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1032#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1033
b754978a 1034int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1035
1036/**
1037 * Gets the index for a specific timestamp.
4f57fa8c
DB
1038 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1039 * to the timestamp which is <= the requested one, if backward
1040 * is 0, then it will be >=
3217cb42
PI
1041 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1042 * @return < 0 if no such timestamp could be found
1043 */
dc56fc38 1044int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1045
1046/**
3dea63bd 1047 * Ensures the index uses less memory than the maximum specified in
22e77e44 1048 * AVFormatContext.max_index_size by discarding entries if it grows
3dea63bd
PK
1049 * too large.
1050 * This function is not part of the public API and should only be called
1051 * by demuxers.
1052 */
1053void ff_reduce_index(AVFormatContext *s, int stream_index);
1054
1055/**
d1b9adf2 1056 * Adds an index entry into a sorted list. Updates the entry if the list
4f57fa8c 1057 * already contains it.
3217cb42 1058 *
4f57fa8c 1059 * @param timestamp timestamp in the time base of the given stream
3217cb42 1060 */
78cb7273
DB
1061int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1062 int size, int distance, int flags);
3217cb42
PI
1063
1064/**
78cb7273
DB
1065 * Does a binary search using av_index_search_timestamp() and
1066 * AVCodec.read_timestamp().
1067 * This is not supposed to be called directly by a user application,
1068 * but by demuxers.
3217cb42
PI
1069 * @param target_ts target timestamp in the time base of the given stream
1070 * @param stream_index stream number
1071 */
78cb7273
DB
1072int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1073 int64_t target_ts, int flags);
3217cb42
PI
1074
1075/**
4f57fa8c 1076 * Updates cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1077 *
4f57fa8c
DB
1078 * Stream ref_st unchanged, others set cur_dts in their native time base.
1079 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1080 * @param timestamp new dts expressed in time_base of param ref_st
1081 * @param ref_st reference stream giving time_base of param timestamp
1082 */
22ffac70 1083void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1084
1085/**
1086 * Does a binary search using read_timestamp().
78cb7273
DB
1087 * This is not supposed to be called directly by a user application,
1088 * but by demuxers.
3217cb42
PI
1089 * @param target_ts target timestamp in the time base of the given stream
1090 * @param stream_index stream number
1091 */
78cb7273
DB
1092int64_t av_gen_search(AVFormatContext *s, int stream_index,
1093 int64_t target_ts, int64_t pos_min,
1094 int64_t pos_max, int64_t pos_limit,
1095 int64_t ts_min, int64_t ts_max,
1096 int flags, int64_t *ts_ret,
1097 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1098
43d414ba 1099/** media file output */
290c5fa6 1100int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1101
1102/**
d1b9adf2 1103 * Allocates the stream private data and writes the stream header to an
755bfeab 1104 * output media file.
3217cb42
PI
1105 *
1106 * @param s media file handle
4f57fa8c 1107 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1108 */
b9a281db 1109int av_write_header(AVFormatContext *s);
3217cb42
PI
1110
1111/**
d1b9adf2 1112 * Writes a packet to an output media file.
3217cb42
PI
1113 *
1114 * The packet shall contain one audio or video frame.
78cb7273
DB
1115 * The packet must be correctly interleaved according to the container
1116 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1117 *
1118 * @param s media file handle
78cb7273
DB
1119 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1120 dts/pts, ...
4f57fa8c 1121 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1122 */
e928649b 1123int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1124
1125/**
1126 * Writes a packet to an output media file ensuring correct interleaving.
1127 *
1128 * The packet must contain one audio or video frame.
22e77e44 1129 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1130 * call av_write_frame() instead as it is slightly faster. It is also important
1131 * to keep in mind that completely non-interleaved input will need huge amounts
1132 * of memory to interleave with this, so it is preferable to interleave at the
1133 * demuxer level.
3217cb42
PI
1134 *
1135 * @param s media file handle
78cb7273
DB
1136 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1137 dts/pts, ...
4f57fa8c 1138 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1139 */
3c895fc0 1140int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1141
1142/**
d1b9adf2 1143 * Interleaves a packet per dts in an output media file.
3217cb42 1144 *
78cb7273 1145 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1146 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1147 * on them is still safe.
3217cb42
PI
1148 *
1149 * @param s media file handle
1150 * @param out the interleaved packet will be output here
1151 * @param in the input packet
1152 * @param flush 1 if no further packets are available as input and all
1153 * remaining packets should be output
1154 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1155 * < 0 if an error occurred
3217cb42 1156 */
78cb7273
DB
1157int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1158 AVPacket *pkt, int flush);
e928649b 1159
3217cb42 1160/**
2b75bde6
SS
1161 * Writes the stream trailer to an output media file and frees the
1162 * file private data.
3217cb42 1163 *
dc76fe13
RD
1164 * May only be called after a successful call to av_write_header.
1165 *
3217cb42 1166 * @param s media file handle
4f57fa8c 1167 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1168 */
b9a281db 1169int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
1170
1171void dump_format(AVFormatContext *ic,
115329f1 1172 int index,
de6d9b64
FB
1173 const char *url,
1174 int is_output);
3217cb42 1175
1ca9133f 1176#if LIBAVFORMAT_VERSION_MAJOR < 53
3217cb42 1177/**
4f57fa8c 1178 * Parses width and height out of string str.
26ef3220 1179 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 1180 */
78cb7273
DB
1181attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1182 const char *str);
3217cb42
PI
1183
1184/**
22e77e44 1185 * Converts framerate from a string to a fraction.
26ef3220 1186 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 1187 */
78cb7273
DB
1188attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1189 const char *arg);
1ca9133f 1190#endif
3217cb42
PI
1191
1192/**
819174fa 1193 * Parses datestr and returns a corresponding number of microseconds.
f9436161
SS
1194 * @param datestr String representing a date or a duration.
1195 * - If a date the syntax is:
3217cb42 1196 * @code
3217cb42 1197 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
3217cb42 1198 * @endcode
4f57fa8c 1199 * Time is local time unless Z is appended, in which case it is
f9436161 1200 * interpreted as UTC.
4f57fa8c 1201 * If the year-month-day part is not specified it takes the current
f9436161
SS
1202 * year-month-day.
1203 * Returns the number of microseconds since 1st of January, 1970 up to
819174fa 1204 * the time of the parsed date or INT64_MIN if datestr cannot be
f9436161
SS
1205 * successfully parsed.
1206 * - If a duration the syntax is:
1207 * @code
1208 * [-]HH[:MM[:SS[.m...]]]
1209 * [-]S+[.m...]
1210 * @endcode
1211 * Returns the number of microseconds contained in a time interval
819174fa 1212 * with the specified duration or INT64_MIN if datestr cannot be
7338d368 1213 * successfully parsed.
819174fa
SS
1214 * @param duration Flag which tells how to interpret datestr, if
1215 * not zero datestr is interpreted as a duration, otherwise as a
f9436161 1216 * date.
3217cb42 1217 */
0c1a9eda 1218int64_t parse_date(const char *datestr, int duration);
de6d9b64 1219
fff5e687 1220/** Gets the current time in microseconds. */
0c1a9eda 1221int64_t av_gettime(void);
94988531 1222
4f57fa8c 1223/* ffm-specific for ffserver */
de6d9b64 1224#define FFM_PACKET_SIZE 4096
bc5c918e 1225int64_t ffm_read_write_index(int fd);
6fcce4f9 1226int ffm_write_write_index(int fd, int64_t pos);
bc5c918e 1227void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
de6d9b64 1228
3217cb42
PI
1229/**
1230 * Attempts to find a specific tag in a URL.
1231 *
1232 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1233 * Return 1 if found.
1234 */
de6d9b64
FB
1235int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1236
3217cb42 1237/**
22e77e44 1238 * Returns in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1239 *
3217cb42
PI
1240 * Also handles the '%0nd' format where 'n' is the total number
1241 * of digits and '%%'.
1242 *
1243 * @param buf destination buffer
1244 * @param buf_size destination buffer size
1245 * @param path numbered sequence string
8ea0e802 1246 * @param number frame number
4f57fa8c 1247 * @return 0 if OK, -1 on format error
3217cb42 1248 */
5c07cf53
MB
1249int av_get_frame_filename(char *buf, int buf_size,
1250 const char *path, int number);
3217cb42
PI
1251
1252/**
d1b9adf2 1253 * Checks whether filename actually is a numbered sequence generator.
3217cb42
PI
1254 *
1255 * @param filename possible numbered sequence string
4f57fa8c 1256 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1257 */
5c07cf53 1258int av_filename_number_test(const char *filename);
96baaa6a 1259
c5388c07 1260/**
d1b9adf2 1261 * Generates an SDP for an RTP session.
c5388c07
LA
1262 *
1263 * @param ac array of AVFormatContexts describing the RTP streams. If the
1264 * array is composed by only one context, such context can contain
1265 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1266 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1267 * must contain only one AVStream.
8767b80f
LA
1268 * @param n_files number of AVCodecContexts contained in ac
1269 * @param buff buffer where the SDP will be stored (must be allocated by
4f57fa8c 1270 * the caller)
8767b80f 1271 * @param size the size of the buffer
4f57fa8c 1272 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1273 */
8767b80f 1274int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 1275
fb025625 1276#ifdef HAVE_AV_CONFIG_H
f71869a4 1277
2db5da97 1278void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
39f472c3 1279
e4e70d2e 1280#ifdef __GNUC__
39f472c3
FB
1281#define dynarray_add(tab, nb_ptr, elem)\
1282do {\
72ab9d7f
DP
1283 __typeof__(tab) _tab = (tab);\
1284 __typeof__(elem) _elem = (elem);\
39f472c3 1285 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
2db5da97 1286 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
39f472c3 1287} while(0)
e4e70d2e
FH
1288#else
1289#define dynarray_add(tab, nb_ptr, elem)\
1290do {\
2db5da97 1291 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
e4e70d2e
FH
1292} while(0)
1293#endif
39f472c3 1294
f71869a4 1295time_t mktimegm(struct tm *tm);
0c9fc6e1 1296struct tm *brktimegm(time_t secs, struct tm *tm);
115329f1 1297const char *small_strptime(const char *p, const char *fmt,
f71869a4
FB
1298 struct tm *dt);
1299
fb025625 1300struct in_addr;
f1888474
MS
1301/* Deprecated, use getaddrinfo instead. */
1302attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname);
fb025625
FB
1303
1304void url_split(char *proto, int proto_size,
6ba5cbc6 1305 char *authorization, int authorization_size,
fb025625
FB
1306 char *hostname, int hostname_size,
1307 int *port_ptr,
1308 char *path, int path_size,
1309 const char *url);
1310
8eb631fa
SS
1311#if LIBAVFORMAT_VERSION_MAJOR < 53
1312/**
1313 * @deprecated Use av_match_ext() instead.
1314 */
1315attribute_deprecated int match_ext(const char *filename, const char *extensions);
1316#endif
1317
a3303178
SS
1318/**
1319 * Returns a positive value if the given filename has one of the given
1320 * extensions, 0 otherwise.
1321 *
1322 * @param extensions a comma-separated list of filename extensions
1323 */
8eb631fa 1324int av_match_ext(const char *filename, const char *extensions);
a941f391 1325
fb025625
FB
1326#endif /* HAVE_AV_CONFIG_H */
1327
98790382 1328#endif /* AVFORMAT_AVFORMAT_H */