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