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