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