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