ff_add_hfyu_median_prediction_mmx2
[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
88a28965 25#define LIBAVFORMAT_VERSION_MINOR 26
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.
214 * @deprecated Use AVRational instead.
671adb17 215*/
916c80e9 216typedef struct AVFrac {
115329f1 217 int64_t val, num, den;
52e57500 218} AVFrac;
916c80e9 219
916c80e9 220/*************************************************/
b9a281db 221/* input/output formats */
de6d9b64 222
7caf0cc6
MN
223struct AVCodecTag;
224
de6d9b64 225struct AVFormatContext;
b9a281db 226
4f57fa8c 227/** This structure contains the data a format has to probe a file. */
b9a281db 228typedef struct AVProbeData {
5c91a675 229 const char *filename;
b9a281db
FB
230 unsigned char *buf;
231 int buf_size;
232} AVProbeData;
233
4f57fa8c 234#define AVPROBE_SCORE_MAX 100 ///< Maximum score, half of that is used for file-extension-based detection.
87e87886 235#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
236
237typedef struct AVFormatParameters {
c0df9d75 238 AVRational time_base;
de6d9b64
FB
239 int sample_rate;
240 int channels;
241 int width;
242 int height;
4606ac8d 243 enum PixelFormat pix_fmt;
4f57fa8c
DB
244 int channel; /**< Used to select DV channel. */
245 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
246 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
247 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
72e043dd 248 stream packet (only meaningful if
4f57fa8c
DB
249 mpeg2ts_raw is TRUE). */
250 unsigned int initial_pause:1; /**< Do not begin to play the stream
251 immediately (RTSP only). */
72e043dd 252 unsigned int prealloced_context:1;
71957315 253#if LIBAVFORMAT_VERSION_INT < (53<<16)
5b6d5596
MN
254 enum CodecID video_codec_id;
255 enum CodecID audio_codec_id;
71957315 256#endif
de6d9b64
FB
257} AVFormatParameters;
258
4f57fa8c 259//! Demuxer will use url_fopen, no opened file should be provided by the caller.
40d9c544 260#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
261#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
262#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
263#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
264 raw picture data. */
265#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
266#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
267#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
268#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
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 {
4f57fa8c
DB
539 const AVClass *av_class; /**< Set by av_alloc_format_context. */
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
691AVInputFormat *av_iformat_next(AVInputFormat *f);
692AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 693
5b6d5596 694enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 695
b9a281db
FB
696/* XXX: use automatic init with either ELF sections or C file parser */
697/* modules */
de6d9b64 698
b9a281db 699/* utils.c */
b9a281db
FB
700void av_register_input_format(AVInputFormat *format);
701void av_register_output_format(AVOutputFormat *format);
115329f1 702AVOutputFormat *guess_stream_format(const char *short_name,
78cb7273
DB
703 const char *filename,
704 const char *mime_type);
115329f1 705AVOutputFormat *guess_format(const char *short_name,
78cb7273
DB
706 const char *filename,
707 const char *mime_type);
3217cb42
PI
708
709/**
4f57fa8c 710 * Guesses the codec ID based upon muxer and filename.
3217cb42 711 */
115329f1 712enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273
DB
713 const char *filename, const char *mime_type,
714 enum CodecType type);
de6d9b64 715
3217cb42 716/**
750f0e1f
PI
717 * Send a nice hexadecimal dump of a buffer to the specified file stream.
718 *
719 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
720 * @param buf buffer
721 * @param size buffer size
750f0e1f
PI
722 *
723 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 724 */
fb2758c8 725void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
726
727/**
750f0e1f
PI
728 * Send a nice hexadecimal dump of a buffer to the log.
729 *
730 * @param avcl A pointer to an arbitrary struct of which the first field is a
731 * pointer to an AVClass struct.
732 * @param level The importance level of the message, lower values signifying
733 * higher importance.
734 * @param buf buffer
735 * @param size buffer size
736 *
737 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
738 */
739void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
740
741/**
742 * Send a nice dump of a packet to the specified file stream.
743 *
744 * @param f The file stream pointer where the dump should be sent to.
3217cb42 745 * @param pkt packet to dump
4f57fa8c 746 * @param dump_payload True if the payload must be displayed, too.
3217cb42 747 */
fb2758c8 748void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 749
750f0e1f
PI
750/**
751 * Send a nice dump of a packet to the log.
752 *
753 * @param avcl A pointer to an arbitrary struct of which the first field is a
754 * pointer to an AVClass struct.
755 * @param level The importance level of the message, lower values signifying
756 * higher importance.
757 * @param pkt packet to dump
4f57fa8c 758 * @param dump_payload True if the payload must be displayed, too.
750f0e1f
PI
759 */
760void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
761
4815e246
SS
762/**
763 * Initialize libavformat and register all the muxers, demuxers and
764 * protocols. If you do not call this function, then you can select
765 * exactly which formats you want to support.
766 *
767 * @see av_register_input_format()
768 * @see av_register_output_format()
769 * @see register_protocol()
770 */
94988531 771void av_register_all(void);
de6d9b64 772
43d414ba 773/** codec tag <-> codec id */
15545a09
SS
774enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
775unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 776
b9a281db 777/* media file input */
3217cb42
PI
778
779/**
4f57fa8c 780 * Finds AVInputFormat based on the short name of the input format.
3217cb42 781 */
b9a281db 782AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
783
784/**
785 * Guess file format.
786 *
4f57fa8c
DB
787 * @param is_opened Whether the file is already opened; determines whether
788 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 789 */
94988531 790AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
791
792/**
793 * Allocates all the structures needed to read an input stream.
794 * This does not open the needed codecs for decoding the stream[s].
795 */
115329f1
DB
796int av_open_input_stream(AVFormatContext **ic_ptr,
797 ByteIOContext *pb, const char *filename,
da24c5e3 798 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
799
800/**
864ff8c1 801 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
802 * header (if present) is read.
803 *
4f57fa8c
DB
804 * @param ic_ptr The opened media file handle is put here.
805 * @param filename filename to open
806 * @param fmt If non-NULL, force the file format to use.
3217cb42 807 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
808 * @param ap Additional parameters needed when opening the file
809 * (NULL if default).
4f57fa8c 810 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 811 */
115329f1 812int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
813 AVInputFormat *fmt,
814 int buf_size,
815 AVFormatParameters *ap);
88a28965
SS
816
817#if LIBAVFORMAT_VERSION_MAJOR < 53
818/**
819 * @deprecated Use avformat_alloc_context() instead.
820 */
821attribute_deprecated AVFormatContext *av_alloc_format_context(void);
822#endif
823
88808c60
MN
824/**
825 * Allocate an AVFormatContext.
5d81d641 826 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
827 * explicitly allocated as well!
828 */
88a28965 829AVFormatContext *avformat_alloc_context(void);
b9a281db 830
3217cb42
PI
831/**
832 * Read packets of a media file to get stream information. This
833 * is useful for file formats with no headers such as MPEG. This
4f57fa8c 834 * function also computes the real frame rate in case of MPEG-2 repeat
3217cb42
PI
835 * frame mode.
836 * The logical file position is not changed by this function;
837 * examined packets may be buffered for later processing.
838 *
839 * @param ic media file handle
4f57fa8c
DB
840 * @return >=0 if OK, AVERROR_xxx on error
841 * @todo Let the user decide somehow what information is needed so that
842 * we do not waste time getting stuff the user does not need.
3217cb42 843 */
b9a281db 844int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
845
846/**
847 * Read a transport packet from a media file.
848 *
864ff8c1 849 * This function is obsolete and should never be used.
3217cb42
PI
850 * Use av_read_frame() instead.
851 *
852 * @param s media file handle
853 * @param pkt is filled
4f57fa8c 854 * @return 0 if OK, AVERROR_xxx on error
3217cb42 855 */
de6d9b64 856int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
857
858/**
859 * Return the next frame of a stream.
860 *
861 * The returned packet is valid
862 * until the next av_read_frame() or until av_close_input_file() and
863 * must be freed with av_free_packet. For video, the packet contains
864 * exactly one frame. For audio, it contains an integer number of
865 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
866 * data). If the audio frames have a variable size (e.g. MPEG audio),
867 * then it contains one frame.
868 *
869 * pkt->pts, pkt->dts and pkt->duration are always set to correct
a050f802 870 * values in AVStream.timebase units (and guessed if the format cannot
4f57fa8c
DB
871 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
872 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
873 * decompress the payload.
874 *
4f57fa8c 875 * @return 0 if OK, < 0 on error or end of file
3217cb42 876 */
fb2758c8 877int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
878
879/**
880 * Seek to the key frame at timestamp.
881 * 'timestamp' in 'stream_index'.
882 * @param stream_index If stream_index is (-1), a default
883 * stream is selected, and timestamp is automatically converted
884 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
885 * @param timestamp Timestamp in AVStream.time_base units
886 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
887 * @param flags flags which select direction and seeking mode
888 * @return >= 0 on success
889 */
78cb7273
DB
890int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
891 int flags);
3217cb42
PI
892
893/**
4f57fa8c
DB
894 * Start playing a network based stream (e.g. RTSP stream) at the
895 * current position.
3217cb42 896 */
fb2758c8 897int av_read_play(AVFormatContext *s);
3217cb42
PI
898
899/**
900 * Pause a network based stream (e.g. RTSP stream).
901 *
902 * Use av_read_play() to resume it.
903 */
fb2758c8 904int av_read_pause(AVFormatContext *s);
3217cb42
PI
905
906/**
2506fd54
RD
907 * Free a AVFormatContext allocated by av_open_input_stream.
908 * @param s context to free
909 */
910void av_close_input_stream(AVFormatContext *s);
911
912/**
3217cb42
PI
913 * Close a media file (but not its codecs).
914 *
915 * @param s media file handle
916 */
de6d9b64 917void av_close_input_file(AVFormatContext *s);
3217cb42
PI
918
919/**
920 * Add a new stream to a media file.
921 *
922 * Can only be called in the read_header() function. If the flag
923 * AVFMTCTX_NOHEADER is in the format context, then new streams
924 * can be added in read_packet too.
925 *
926 * @param s media file handle
4f57fa8c 927 * @param id file-format-dependent stream ID
3217cb42 928 */
b9a281db 929AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 930AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
931
932/**
79d7836a
AK
933 * Add a new chapter.
934 * This function is NOT part of the public API
4f57fa8c 935 * and should ONLY be used by demuxers.
79d7836a
AK
936 *
937 * @param s media file handle
4f57fa8c 938 * @param id unique ID for this chapter
abd2256d
MN
939 * @param start chapter start time in time_base units
940 * @param end chapter end time in time_base units
79d7836a 941 * @param title chapter title
5c37f43a 942 *
4f57fa8c 943 * @return AVChapter or NULL on error
79d7836a 944 */
78cb7273
DB
945AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
946 int64_t start, int64_t end, const char *title);
79d7836a
AK
947
948/**
3217cb42
PI
949 * Set the pts for a given stream.
950 *
951 * @param s stream
952 * @param pts_wrap_bits number of bits effectively used by the pts
953 * (used for wrap control, 33 is the value for MPEG)
954 * @param pts_num numerator to convert to seconds (MPEG: 1)
955 * @param pts_den denominator to convert to seconds (MPEG: 90000)
956 */
9ee91c2f 957void av_set_pts_info(AVStream *s, int pts_wrap_bits,
916c80e9 958 int pts_num, int pts_den);
de6d9b64 959
3ba1438d
MN
960#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
961#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 962#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
3ba1438d 963
b754978a 964int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
965
966/**
967 * Gets the index for a specific timestamp.
4f57fa8c
DB
968 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
969 * to the timestamp which is <= the requested one, if backward
970 * is 0, then it will be >=
3217cb42
PI
971 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
972 * @return < 0 if no such timestamp could be found
973 */
dc56fc38 974int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
975
976/**
3dea63bd
PK
977 * Ensures the index uses less memory than the maximum specified in
978 * AVFormatContext.max_index_size, by discarding entries if it grows
979 * too large.
980 * This function is not part of the public API and should only be called
981 * by demuxers.
982 */
983void ff_reduce_index(AVFormatContext *s, int stream_index);
984
985/**
4f57fa8c
DB
986 * Add an index entry into a sorted list. Update the entry if the list
987 * already contains it.
3217cb42 988 *
4f57fa8c 989 * @param timestamp timestamp in the time base of the given stream
3217cb42 990 */
78cb7273
DB
991int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
992 int size, int distance, int flags);
3217cb42
PI
993
994/**
78cb7273
DB
995 * Does a binary search using av_index_search_timestamp() and
996 * AVCodec.read_timestamp().
997 * This is not supposed to be called directly by a user application,
998 * but by demuxers.
3217cb42
PI
999 * @param target_ts target timestamp in the time base of the given stream
1000 * @param stream_index stream number
1001 */
78cb7273
DB
1002int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1003 int64_t target_ts, int flags);
3217cb42
PI
1004
1005/**
4f57fa8c 1006 * Updates cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1007 *
4f57fa8c
DB
1008 * Stream ref_st unchanged, others set cur_dts in their native time base.
1009 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1010 * @param timestamp new dts expressed in time_base of param ref_st
1011 * @param ref_st reference stream giving time_base of param timestamp
1012 */
22ffac70 1013void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1014
1015/**
1016 * Does a binary search using read_timestamp().
78cb7273
DB
1017 * This is not supposed to be called directly by a user application,
1018 * but by demuxers.
3217cb42
PI
1019 * @param target_ts target timestamp in the time base of the given stream
1020 * @param stream_index stream number
1021 */
78cb7273
DB
1022int64_t av_gen_search(AVFormatContext *s, int stream_index,
1023 int64_t target_ts, int64_t pos_min,
1024 int64_t pos_max, int64_t pos_limit,
1025 int64_t ts_min, int64_t ts_max,
1026 int flags, int64_t *ts_ret,
1027 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1028
43d414ba 1029/** media file output */
290c5fa6 1030int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1031
1032/**
755bfeab
DB
1033 * Allocate the stream private data and write the stream header to an
1034 * output media file.
3217cb42
PI
1035 *
1036 * @param s media file handle
4f57fa8c 1037 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1038 */
b9a281db 1039int av_write_header(AVFormatContext *s);
3217cb42
PI
1040
1041/**
1042 * Write a packet to an output media file.
1043 *
1044 * The packet shall contain one audio or video frame.
78cb7273
DB
1045 * The packet must be correctly interleaved according to the container
1046 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1047 *
1048 * @param s media file handle
78cb7273
DB
1049 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1050 dts/pts, ...
4f57fa8c 1051 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1052 */
e928649b 1053int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1054
1055/**
1056 * Writes a packet to an output media file ensuring correct interleaving.
1057 *
1058 * The packet must contain one audio or video frame.
1059 * If the packets are already correctly interleaved the application should
90b5b51e
DB
1060 * call av_write_frame() instead as it is slightly faster. It is also important
1061 * to keep in mind that completely non-interleaved input will need huge amounts
1062 * of memory to interleave with this, so it is preferable to interleave at the
1063 * demuxer level.
3217cb42
PI
1064 *
1065 * @param s media file handle
78cb7273
DB
1066 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1067 dts/pts, ...
4f57fa8c 1068 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1069 */
3c895fc0 1070int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1071
1072/**
4f57fa8c 1073 * Interleave a packet per dts in an output media file.
3217cb42 1074 *
78cb7273
DB
1075 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1076 * function, so they cannot be used after it, note calling av_free_packet()
1077 * on them is still safe.
3217cb42
PI
1078 *
1079 * @param s media file handle
1080 * @param out the interleaved packet will be output here
1081 * @param in the input packet
1082 * @param flush 1 if no further packets are available as input and all
1083 * remaining packets should be output
1084 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1085 * < 0 if an error occurred
3217cb42 1086 */
78cb7273
DB
1087int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1088 AVPacket *pkt, int flush);
e928649b 1089
3217cb42 1090/**
88b2027e
BC
1091 * Add packet to AVFormatContext->packet_buffer list, determining its
1092 * interleaved position using compare() function argument.
1093 *
1094 * This function is not part of the public API and should only be called
1095 * by muxers using their own interleave function.
1096 */
1097void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
1098 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
1099
1100/**
3217cb42
PI
1101 * @brief Write the stream trailer to an output media file and
1102 * free the file private data.
1103 *
dc76fe13
RD
1104 * May only be called after a successful call to av_write_header.
1105 *
3217cb42 1106 * @param s media file handle
4f57fa8c 1107 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1108 */
b9a281db 1109int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
1110
1111void dump_format(AVFormatContext *ic,
115329f1 1112 int index,
de6d9b64
FB
1113 const char *url,
1114 int is_output);
3217cb42 1115
1ca9133f 1116#if LIBAVFORMAT_VERSION_MAJOR < 53
3217cb42 1117/**
4f57fa8c 1118 * Parses width and height out of string str.
26ef3220 1119 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 1120 */
78cb7273
DB
1121attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1122 const char *str);
3217cb42
PI
1123
1124/**
1125 * Converts frame rate from string to a fraction.
26ef3220 1126 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 1127 */
78cb7273
DB
1128attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1129 const char *arg);
1ca9133f 1130#endif
3217cb42
PI
1131
1132/**
f9436161
SS
1133 * Parses \p datestr and returns a corresponding number of microseconds.
1134 * @param datestr String representing a date or a duration.
1135 * - If a date the syntax is:
3217cb42 1136 * @code
3217cb42 1137 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
3217cb42 1138 * @endcode
4f57fa8c 1139 * Time is local time unless Z is appended, in which case it is
f9436161 1140 * interpreted as UTC.
4f57fa8c 1141 * If the year-month-day part is not specified it takes the current
f9436161
SS
1142 * year-month-day.
1143 * Returns the number of microseconds since 1st of January, 1970 up to
1144 * the time of the parsed date or INT64_MIN if \p datestr cannot be
1145 * successfully parsed.
1146 * - If a duration the syntax is:
1147 * @code
1148 * [-]HH[:MM[:SS[.m...]]]
1149 * [-]S+[.m...]
1150 * @endcode
1151 * Returns the number of microseconds contained in a time interval
1152 * with the specified duration or INT64_MIN if \p datestr cannot be
7338d368 1153 * successfully parsed.
f9436161
SS
1154 * @param duration Flag which tells how to interpret \p datestr, if
1155 * not zero \p datestr is interpreted as a duration, otherwise as a
1156 * date.
3217cb42 1157 */
0c1a9eda 1158int64_t parse_date(const char *datestr, int duration);
de6d9b64 1159
fff5e687 1160/** Gets the current time in microseconds. */
0c1a9eda 1161int64_t av_gettime(void);
94988531 1162
4f57fa8c 1163/* ffm-specific for ffserver */
de6d9b64 1164#define FFM_PACKET_SIZE 4096
bc5c918e
DB
1165int64_t ffm_read_write_index(int fd);
1166void ffm_write_write_index(int fd, int64_t pos);
1167void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
de6d9b64 1168
3217cb42
PI
1169/**
1170 * Attempts to find a specific tag in a URL.
1171 *
1172 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1173 * Return 1 if found.
1174 */
de6d9b64
FB
1175int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1176
3217cb42
PI
1177/**
1178 * Returns in 'buf' the path with '%d' replaced by number.
4f57fa8c 1179 *
3217cb42
PI
1180 * Also handles the '%0nd' format where 'n' is the total number
1181 * of digits and '%%'.
1182 *
1183 * @param buf destination buffer
1184 * @param buf_size destination buffer size
1185 * @param path numbered sequence string
8ea0e802 1186 * @param number frame number
4f57fa8c 1187 * @return 0 if OK, -1 on format error
3217cb42 1188 */
5c07cf53
MB
1189int av_get_frame_filename(char *buf, int buf_size,
1190 const char *path, int number);
3217cb42
PI
1191
1192/**
1193 * Check whether filename actually is a numbered sequence generator.
1194 *
1195 * @param filename possible numbered sequence string
4f57fa8c 1196 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1197 */
5c07cf53 1198int av_filename_number_test(const char *filename);
96baaa6a 1199
c5388c07
LA
1200/**
1201 * Generate an SDP for an RTP session.
1202 *
1203 * @param ac array of AVFormatContexts describing the RTP streams. If the
1204 * array is composed by only one context, such context can contain
1205 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1206 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1207 * must contain only one AVStream.
8767b80f
LA
1208 * @param n_files number of AVCodecContexts contained in ac
1209 * @param buff buffer where the SDP will be stored (must be allocated by
4f57fa8c 1210 * the caller)
8767b80f 1211 * @param size the size of the buffer
4f57fa8c 1212 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1213 */
8767b80f 1214int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 1215
fb025625 1216#ifdef HAVE_AV_CONFIG_H
f71869a4 1217
2db5da97 1218void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
39f472c3 1219
e4e70d2e 1220#ifdef __GNUC__
39f472c3
FB
1221#define dynarray_add(tab, nb_ptr, elem)\
1222do {\
72ab9d7f
DP
1223 __typeof__(tab) _tab = (tab);\
1224 __typeof__(elem) _elem = (elem);\
39f472c3 1225 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
2db5da97 1226 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
39f472c3 1227} while(0)
e4e70d2e
FH
1228#else
1229#define dynarray_add(tab, nb_ptr, elem)\
1230do {\
2db5da97 1231 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
e4e70d2e
FH
1232} while(0)
1233#endif
39f472c3 1234
f71869a4 1235time_t mktimegm(struct tm *tm);
0c9fc6e1 1236struct tm *brktimegm(time_t secs, struct tm *tm);
115329f1 1237const char *small_strptime(const char *p, const char *fmt,
f71869a4
FB
1238 struct tm *dt);
1239
fb025625
FB
1240struct in_addr;
1241int resolve_host(struct in_addr *sin_addr, const char *hostname);
1242
1243void url_split(char *proto, int proto_size,
6ba5cbc6 1244 char *authorization, int authorization_size,
fb025625
FB
1245 char *hostname, int hostname_size,
1246 int *port_ptr,
1247 char *path, int path_size,
1248 const char *url);
1249
a941f391
FB
1250int match_ext(const char *filename, const char *extensions);
1251
fb025625
FB
1252#endif /* HAVE_AV_CONFIG_H */
1253
98790382 1254#endif /* AVFORMAT_AVFORMAT_H */