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