Add a av_grow_packet function, to be used by code that merges
[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
44594cc7 25#define LIBAVFORMAT_VERSION_MINOR 84
8878e3b2 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
25ae798c
AJ
38/**
39 * Those FF_API_* defines are not part of public API.
40 * They may change, break or disappear at any time.
41 */
54036be1 42#ifndef FF_API_MAX_STREAMS
ed09233f 43#define FF_API_MAX_STREAMS (LIBAVFORMAT_VERSION_MAJOR < 53)
072e3efd 44#endif
54036be1 45#ifndef FF_API_OLD_METADATA
ed09233f 46#define FF_API_OLD_METADATA (LIBAVFORMAT_VERSION_MAJOR < 53)
dd872bf4 47#endif
404eba44 48#ifndef FF_API_URL_CLASS
ed09233f 49#define FF_API_URL_CLASS (LIBAVFORMAT_VERSION_MAJOR >= 53)
404eba44 50#endif
364cacc7 51#ifndef FF_API_URL_RESETBUF
ed09233f 52#define FF_API_URL_RESETBUF (LIBAVFORMAT_VERSION_MAJOR < 53)
364cacc7 53#endif
838b27b4 54#ifndef FF_API_REGISTER_PROTOCOL
ed09233f 55#define FF_API_REGISTER_PROTOCOL (LIBAVFORMAT_VERSION_MAJOR < 53)
838b27b4 56#endif
198ac67f 57#ifndef FF_API_GUESS_FORMAT
ed09233f 58#define FF_API_GUESS_FORMAT (LIBAVFORMAT_VERSION_MAJOR < 53)
198ac67f 59#endif
8ef30ac1 60#ifndef FF_API_UDP_GET_FILE
ed09233f 61#define FF_API_UDP_GET_FILE (LIBAVFORMAT_VERSION_MAJOR < 53)
8ef30ac1 62#endif
88e44314 63#ifndef FF_API_URL_SPLIT
ed09233f 64#define FF_API_URL_SPLIT (LIBAVFORMAT_VERSION_MAJOR < 53)
88e44314 65#endif
ca51d86c
AJ
66#ifndef FF_API_ALLOC_FORMAT_CONTEXT
67#define FF_API_ALLOC_FORMAT_CONTEXT (LIBAVFORMAT_VERSION_MAJOR < 53)
68#endif
d87a521c
AJ
69#ifndef FF_API_PARSE_FRAME_PARAM
70#define FF_API_PARSE_FRAME_PARAM (LIBAVFORMAT_VERSION_MAJOR < 53)
71#endif
634e0304
AJ
72#ifndef FF_API_READ_SEEK
73#define FF_API_READ_SEEK (LIBAVFORMAT_VERSION_MAJOR < 54)
74#endif
d1742ff7
AJ
75#ifndef FF_API_LAVF_UNUSED
76#define FF_API_LAVF_UNUSED (LIBAVFORMAT_VERSION_MAJOR < 53)
77#endif
0139fdea
AJ
78#ifndef FF_API_PARAMETERS_CODEC_ID
79#define FF_API_PARAMETERS_CODEC_ID (LIBAVFORMAT_VERSION_MAJOR < 53)
80#endif
114c9a59
AJ
81#ifndef FF_API_FIRST_FORMAT
82#define FF_API_FIRST_FORMAT (LIBAVFORMAT_VERSION_MAJOR < 53)
83#endif
13728334
AJ
84#ifndef FF_API_SYMVER
85#define FF_API_SYMVER (LIBAVFORMAT_VERSION_MAJOR < 53)
86#endif
072e3efd 87
c97429e2 88/**
f2e77e4b
AC
89 * I return the LIBAVFORMAT_VERSION_INT constant. You got
90 * a fucking problem with that, douchebag?
c97429e2
SS
91 */
92unsigned avformat_version(void);
93
c1736936 94/**
49bd8e4b 95 * Return the libavformat build-time configuration.
c1736936 96 */
41600690 97const char *avformat_configuration(void);
c1736936
DB
98
99/**
49bd8e4b 100 * Return the libavformat license.
c1736936 101 */
41600690 102const char *avformat_license(void);
c1736936 103
f71869a4 104#include <time.h>
67070e4f 105#include <stdio.h> /* FILE */
76a448ed 106#include "libavcodec/avcodec.h"
de6d9b64 107
de6d9b64
FB
108#include "avio.h"
109
f610a9f2
AJ
110struct AVFormatContext;
111
a6d18a0e
MN
112
113/*
ea29242c
MM
114 * Public Metadata API.
115 * The metadata API allows libavformat to export metadata tags to a client
61648423
AK
116 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
117 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
118 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
ea29242c
MM
119 * Important concepts to keep in mind:
120 * 1. Keys are unique; there can never be 2 tags with the same key. This is
121 * also meant semantically, i.e., a demuxer should not knowingly produce
122 * several keys that are literally different but semantically identical.
123 * E.g., key=Author5, key=Author6. In this example, all authors must be
124 * placed in the same tag.
125 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
126 * want to store, e.g., the email address of the child of producer Alice
127 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
ca76a119
AK
128 * 3. Several modifiers can be applied to the tag name. This is done by
129 * appending a dash character ('-') and the modifier name in the order
130 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
131 * a) language -- a tag whose value is localized for a particular language
132 * is appended with the ISO 639-2/B 3-letter language code.
133 * For example: Author-ger=Michael, Author-eng=Mike
134 * The original/default language is in the unqualified "Author" tag.
135 * A demuxer should set a default if it sets any translated tag.
136 * b) sorting -- a modified version of a tag that should be used for
137 * sorting will have '-sort' appended. E.g. artist="The Beatles",
138 * artist-sort="Beatles, The".
139 *
03700d39
AK
140 * 4. Demuxers attempt to export metadata in a generic format, however tags
141 * with no generic equivalents are left as they are stored in the container.
142 * Follows a list of generic tag names:
ca76a119
AK
143 *
144 * album -- name of the set this work belongs to
145 * album_artist -- main creator of the set/album, if different from artist.
146 * e.g. "Various Artists" for compilation albums.
147 * artist -- main creator of the work
148 * comment -- any additional description of the file.
149 * composer -- who composed the work, if different from artist.
150 * copyright -- name of copyright holder.
151 * date -- date when the work was created, preferably in ISO 8601.
152 * disc -- number of a subset, e.g. disc in a multi-disc collection.
153 * encoder -- name/settings of the software/hardware that produced the file.
154 * encoded_by -- person/group who created the file.
155 * filename -- original name of the file.
156 * genre -- <self-evident>.
157 * language -- main language in which the work is performed, preferably
158 * in ISO 639-2 format.
159 * performer -- artist who performed the work, if different from artist.
160 * E.g for "Also sprach Zarathustra", artist would be "Richard
161 * Strauss" and performer "London Philharmonic Orchestra".
162 * publisher -- name of the label/publisher.
163 * title -- name of the work.
164 * track -- number of this work in the set, can be in form current/total.
a6d18a0e
MN
165 */
166
48a81c0f 167#define AV_METADATA_MATCH_CASE 1
a6d18a0e 168#define AV_METADATA_IGNORE_SUFFIX 2
a181981e
MN
169#define AV_METADATA_DONT_STRDUP_KEY 4
170#define AV_METADATA_DONT_STRDUP_VAL 8
56a8242f 171#define AV_METADATA_DONT_OVERWRITE 16 ///< Don't overwrite existing tags.
a6d18a0e
MN
172
173typedef struct {
174 char *key;
175 char *value;
bc1d2afb 176}AVMetadataTag;
a6d18a0e 177
e232c252 178typedef struct AVMetadata AVMetadata;
03700d39 179#if FF_API_OLD_METADATA
f610a9f2 180typedef struct AVMetadataConv AVMetadataConv;
03700d39 181#endif
a6d18a0e
MN
182
183/**
49bd8e4b 184 * Get a metadata element with matching key.
26cc5310 185 *
22e77e44 186 * @param prev Set to the previous matching element to find the next.
66b6c745 187 * If set to NULL the first matching element is returned.
22e77e44
DB
188 * @param flags Allows case as well as suffix-insensitive comparisons.
189 * @return Found tag or NULL, changing key or value leads to undefined behavior.
a6d18a0e 190 */
bc1d2afb 191AVMetadataTag *
e232c252 192av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
a6d18a0e 193
54036be1 194#if FF_API_OLD_METADATA
a6d18a0e 195/**
32e6f246 196 * Set the given tag in *pm, overwriting an existing tag.
26cc5310 197 *
983ec304
SS
198 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
199 * a metadata struct is allocated and put in *pm.
32e6f246
SS
200 * @param key tag key to add to *pm (will be av_strduped)
201 * @param value tag value to add to *pm (will be av_strduped)
22e77e44 202 * @return >= 0 on success otherwise an error code <0
2ef6c124 203 * @deprecated Use av_metadata_set2() instead.
a6d18a0e 204 */
2ef6c124 205attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
a181981e
MN
206#endif
207
208/**
32e6f246 209 * Set the given tag in *pm, overwriting an existing tag.
26cc5310 210 *
983ec304
SS
211 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
212 * a metadata struct is allocated and put in *pm.
32e6f246
SS
213 * @param key tag key to add to *pm (will be av_strduped depending on flags)
214 * @param value tag value to add to *pm (will be av_strduped depending on flags).
160c896c 215 * Passing a NULL value will cause an existing tag to be deleted.
a181981e
MN
216 * @return >= 0 on success otherwise an error code <0
217 */
218int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
a6d18a0e 219
03700d39 220#if FF_API_OLD_METADATA
094d9df7 221/**
03700d39 222 * This function is provided for compatibility reason and currently does nothing.
f610a9f2 223 */
03700d39
AK
224attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
225 const AVMetadataConv *s_conv);
226#endif
f610a9f2
AJ
227
228/**
49bd8e4b 229 * Free all the memory allocated for an AVMetadata struct.
094d9df7
AJ
230 */
231void av_metadata_free(AVMetadata **m);
232
a6d18a0e 233
de6d9b64
FB
234/* packet functions */
235
3217cb42
PI
236
237/**
49bd8e4b 238 * Allocate and read the payload of a packet and initialize its
d1b9adf2 239 * fields with default values.
3217cb42
PI
240 *
241 * @param pkt packet
4f57fa8c
DB
242 * @param size desired payload size
243 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 244 */
2692067a 245int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
3217cb42 246
de6d9b64
FB
247
248/*************************************************/
916c80e9
FB
249/* fractional numbers for exact pts handling */
250
671adb17 251/**
4f57fa8c
DB
252 * The exact value of the fractional number is: 'val + num / den'.
253 * num is assumed to be 0 <= num < den.
4c08b2bd 254 */
916c80e9 255typedef struct AVFrac {
115329f1 256 int64_t val, num, den;
52e57500 257} AVFrac;
916c80e9 258
916c80e9 259/*************************************************/
b9a281db 260/* input/output formats */
de6d9b64 261
7caf0cc6
MN
262struct AVCodecTag;
263
76c56376
MN
264/**
265 * This structure contains the data a format has to probe a file.
266 */
b9a281db 267typedef struct AVProbeData {
5c91a675 268 const char *filename;
e5f58f81 269 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
270 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
271} AVProbeData;
272
22e77e44 273#define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
87e87886 274#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64
FB
275
276typedef struct AVFormatParameters {
c0df9d75 277 AVRational time_base;
de6d9b64
FB
278 int sample_rate;
279 int channels;
280 int width;
281 int height;
4606ac8d 282 enum PixelFormat pix_fmt;
4f57fa8c
DB
283 int channel; /**< Used to select DV channel. */
284 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
285 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
286 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
72e043dd 287 stream packet (only meaningful if
4f57fa8c
DB
288 mpeg2ts_raw is TRUE). */
289 unsigned int initial_pause:1; /**< Do not begin to play the stream
290 immediately (RTSP only). */
72e043dd 291 unsigned int prealloced_context:1;
0139fdea 292#if FF_API_PARAMETERS_CODEC_ID
a15c7fd6
AK
293 attribute_deprecated enum CodecID video_codec_id;
294 attribute_deprecated enum CodecID audio_codec_id;
71957315 295#endif
de6d9b64
FB
296} AVFormatParameters;
297
4f57fa8c 298//! Demuxer will use url_fopen, no opened file should be provided by the caller.
40d9c544 299#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
300#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
301#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
302#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
303 raw picture data. */
304#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
305#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
306#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
307#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
25918212 308#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 309#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
b9a281db
FB
310
311typedef struct AVOutputFormat {
de6d9b64 312 const char *name;
bde15e74
SS
313 /**
314 * Descriptive name for the format, meant to be more human-readable
819174fa 315 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
316 * to define it.
317 */
de6d9b64
FB
318 const char *long_name;
319 const char *mime_type;
4f57fa8c 320 const char *extensions; /**< comma-separated filename extensions */
76c56376
MN
321 /**
322 * size of private data so that it can be allocated in the wrapper
323 */
b9a281db 324 int priv_data_size;
de6d9b64 325 /* output support */
43d414ba
PI
326 enum CodecID audio_codec; /**< default audio codec */
327 enum CodecID video_codec; /**< default video codec */
de6d9b64 328 int (*write_header)(struct AVFormatContext *);
e928649b 329 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 330 int (*write_trailer)(struct AVFormatContext *);
76c56376
MN
331 /**
332 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
333 */
b9a281db 334 int flags;
76c56376
MN
335 /**
336 * Currently only used to set pixel format if not YUV420P.
337 */
290c5fa6 338 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
339 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
340 AVPacket *in, int flush);
7caf0cc6
MN
341
342 /**
78cb7273 343 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 344 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 345 */
c1854592 346 const struct AVCodecTag * const *codec_tag;
7caf0cc6 347
11bf3847
AJ
348 enum CodecID subtitle_codec; /**< default subtitle codec */
349
03700d39 350#if FF_API_OLD_METADATA
719e721a 351 const AVMetadataConv *metadata_conv;
03700d39 352#endif
f610a9f2 353
b9a281db
FB
354 /* private fields */
355 struct AVOutputFormat *next;
356} AVOutputFormat;
de6d9b64 357
b9a281db 358typedef struct AVInputFormat {
76c56376
MN
359 /**
360 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
361 * may be appended with a minor bump.
362 */
b9a281db 363 const char *name;
76c56376 364
bde15e74
SS
365 /**
366 * Descriptive name for the format, meant to be more human-readable
819174fa 367 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
368 * to define it.
369 */
b9a281db 370 const char *long_name;
76c56376
MN
371
372 /**
373 * Size of private data so that it can be allocated in the wrapper.
374 */
b9a281db 375 int priv_data_size;
76c56376 376
65d7d68b 377 /**
22e77e44 378 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
379 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
380 * big so you do not have to check for that unless you need more.
65d7d68b 381 */
b9a281db 382 int (*read_probe)(AVProbeData *);
76c56376
MN
383
384 /**
385 * Read the format header and initialize the AVFormatContext
386 * structure. Return 0 if OK. 'ap' if non-NULL contains
387 * additional parameters. Only used in raw format right
388 * now. 'av_new_stream' should be called to create new streams.
389 */
de6d9b64
FB
390 int (*read_header)(struct AVFormatContext *,
391 AVFormatParameters *ap);
76c56376
MN
392
393 /**
394 * Read one packet and put it in 'pkt'. pts and flags are also
395 * set. 'av_new_stream' can be called only if the flag
2899a28c
AJ
396 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
397 * background thread).
76c56376
MN
398 * @return 0 on success, < 0 on error.
399 * When returning an error, pkt must not have been allocated
400 * or must be freed before returning
401 */
de6d9b64 402 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
403
404 /**
405 * Close the stream. The AVFormatContext and AVStreams are not
406 * freed by this function
407 */
de6d9b64 408 int (*read_close)(struct AVFormatContext *);
1de2db8f 409
634e0304 410#if FF_API_READ_SEEK
115329f1 411 /**
4f57fa8c
DB
412 * Seek to a given timestamp relative to the frames in
413 * stream component stream_index.
22e77e44
DB
414 * @param stream_index Must not be -1.
415 * @param flags Selects which direction should be preferred if no exact
416 * match is available.
05ce0f11 417 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 418 */
a15c7fd6
AK
419 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
420 int stream_index, int64_t timestamp, int flags);
1de2db8f 421#endif
8d14a25c 422 /**
4f57fa8c 423 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 424 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
425 */
426 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
427 int64_t *pos, int64_t pos_limit);
76c56376
MN
428
429 /**
430 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
431 */
de6d9b64 432 int flags;
76c56376
MN
433
434 /**
435 * If extensions are defined, then no probe is done. You should
436 * usually not use extension format guessing because it is not
437 * reliable enough
438 */
b9a281db 439 const char *extensions;
76c56376
MN
440
441 /**
442 * General purpose read-only value that the format can use.
443 */
b9a281db 444 int value;
fb2758c8 445
76c56376
MN
446 /**
447 * Start/resume playing - only meaningful if using a network-based format
448 * (RTSP).
449 */
fb2758c8
FB
450 int (*read_play)(struct AVFormatContext *);
451
76c56376
MN
452 /**
453 * Pause playing - only meaningful if using a network-based format
454 * (RTSP).
455 */
fb2758c8
FB
456 int (*read_pause)(struct AVFormatContext *);
457
c1854592 458 const struct AVCodecTag * const *codec_tag;
7caf0cc6 459
1de2db8f 460 /**
49bd8e4b 461 * Seek to timestamp ts.
1de2db8f
MN
462 * Seeking will be done so that the point from which all active streams
463 * can be presented successfully will be closest to ts and within min/max_ts.
464 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
465 */
882fb0a3 466 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 467
03700d39 468#if FF_API_OLD_METADATA
719e721a 469 const AVMetadataConv *metadata_conv;
03700d39 470#endif
f610a9f2 471
b9a281db
FB
472 /* private fields */
473 struct AVInputFormat *next;
474} AVInputFormat;
de6d9b64 475
57004ff1
AJ
476enum AVStreamParseType {
477 AVSTREAM_PARSE_NONE,
478 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 479 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 480 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 481 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
482};
483
fb2758c8
FB
484typedef struct AVIndexEntry {
485 int64_t pos;
486 int64_t timestamp;
487#define AVINDEX_KEYFRAME 0x0001
30a43f2d 488 int flags:2;
4f57fa8c
DB
489 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).
490 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
491} AVIndexEntry;
492
90c2295b
ES
493#define AV_DISPOSITION_DEFAULT 0x0001
494#define AV_DISPOSITION_DUB 0x0002
495#define AV_DISPOSITION_ORIGINAL 0x0004
496#define AV_DISPOSITION_COMMENT 0x0008
497#define AV_DISPOSITION_LYRICS 0x0010
498#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
499
500/**
501 * Track should be used during playback by default.
502 * Useful for subtitle track that should be displayed
503 * even when user did not explicitly ask for subtitles.
504 */
7a617a86 505#define AV_DISPOSITION_FORCED 0x0040
90c2295b 506
ba66ae94
MN
507/**
508 * Stream structure.
509 * New fields can be added to the end with minor version bumps.
8bfb108b 510 * Removal, reordering and changes to existing fields require a major
ba66ae94 511 * version bump.
8bfb108b 512 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 513 */
de6d9b64 514typedef struct AVStream {
43d414ba 515 int index; /**< stream index in AVFormatContext */
4f57fa8c 516 int id; /**< format-specific stream ID */
43d414ba 517 AVCodecContext *codec; /**< codec context */
b4b87d48 518 /**
22e77e44
DB
519 * Real base framerate of the stream.
520 * This is the lowest framerate with which all timestamps can be
864ff8c1 521 * represented accurately (it is the least common multiple of all
22e77e44
DB
522 * framerates in the stream). Note, this value is just a guess!
523 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 524 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
525 */
526 AVRational r_frame_rate;
de6d9b64 527 void *priv_data;
82583548 528
b9a281db 529 /* internal data used in av_find_stream_info() */
82583548 530 int64_t first_dts;
76c56376
MN
531
532 /**
533 * encoding: pts generation when outputting stream
534 */
a9fd2b19 535 struct AVFrac pts;
5b28c8c3
MN
536
537 /**
8bfb108b
DB
538 * This is the fundamental unit of time (in seconds) in terms
539 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 540 * time base should be 1/framerate and timestamp increments should be 1.
5b28c8c3 541 */
9ee91c2f 542 AVRational time_base;
43d414ba 543 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
a48b7a6b 544 /* ffmpeg.c private use */
4f57fa8c
DB
545 int stream_copy; /**< If set, just copy stream. */
546 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 547
b4aea108 548 //FIXME move stuff to a flags field?
76c56376
MN
549 /**
550 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
551 * MN: dunno if that is the right place for it
552 */
115329f1 553 float quality;
76c56376 554
6d96a9b9 555 /**
8bfb108b
DB
556 * Decoding: pts of the first frame of the stream, in stream time base.
557 * Only set this if you are absolutely 100% sure that the value you set
558 * it to really is the pts of the first frame.
4854c253 559 * This may be undefined (AV_NOPTS_VALUE).
8bfb108b
DB
560 * @note The ASF header does NOT contain a correct start_time the ASF
561 * demuxer must NOT set this.
6d96a9b9 562 */
115329f1 563 int64_t start_time;
76c56376 564
e26381b6 565 /**
8bfb108b 566 * Decoding: duration of the stream, in stream time base.
e26381b6 567 * If a source file does not specify a duration, but does specify
4f57fa8c 568 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 569 */
ee404803 570 int64_t duration;
fb2758c8 571
54036be1 572#if FF_API_OLD_METADATA
a15c7fd6 573 attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
827f7e28 574#endif
09730260 575
fb2758c8 576 /* av_read_frame() support */
57004ff1 577 enum AVStreamParseType need_parsing;
fb2758c8 578 struct AVCodecParserContext *parser;
6ec87caa 579
fb2758c8 580 int64_t cur_dts;
635fbcb1
MN
581 int last_IP_duration;
582 int64_t last_IP_pts;
fb2758c8 583 /* av_seek_frame() support */
4f57fa8c
DB
584 AVIndexEntry *index_entries; /**< Only used if the format does not
585 support seeking natively. */
fb2758c8 586 int nb_index_entries;
191e8ca7 587 unsigned int index_entries_allocated_size;
115329f1 588
b4b87d48 589 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 590
d1742ff7 591#if FF_API_LAVF_UNUSED
a15c7fd6 592 attribute_deprecated int64_t unused[4+1];
dd872bf4 593#endif
f8d7c9d3 594
54036be1 595#if FF_API_OLD_METADATA
a15c7fd6 596 attribute_deprecated char *filename; /**< source filename of the stream */
827f7e28 597#endif
90c2295b 598
4f57fa8c 599 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5
MN
600
601 AVProbeData probe_data;
0d84a8f6
BC
602#define MAX_REORDER_DELAY 16
603 int64_t pts_buffer[MAX_REORDER_DELAY+1];
c30a4489
AJ
604
605 /**
606 * sample aspect ratio (0 if unknown)
607 * - encoding: Set by user.
608 * - decoding: Set by libavformat.
609 */
610 AVRational sample_aspect_ratio;
f526adaf 611
e232c252 612 AVMetadata *metadata;
3a41c2f7 613
31769dad
VP
614 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
615 /* external applications; try to use something else if at all possible. */
3a41c2f7
MN
616 const uint8_t *cur_ptr;
617 int cur_len;
618 AVPacket cur_pkt;
27ca0a79
IS
619
620 // Timestamp generation support:
621 /**
622 * Timestamp corresponding to the last dts sync point.
623 *
624 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
625 * a DTS is received from the underlying container. Otherwise set to
626 * AV_NOPTS_VALUE by default.
627 */
628 int64_t reference_dts;
86cb7e33
BC
629
630 /**
631 * Number of packets to buffer for codec probing
632 * NOT PART OF PUBLIC API
633 */
48616887 634#define MAX_PROBE_PACKETS 2500
86cb7e33 635 int probe_packets;
ddce56ef
MN
636
637 /**
e07b882b 638 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
639 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
640 */
e07b882b 641 struct AVPacketList *last_in_packet_buffer;
02b398ef
MN
642
643 /**
644 * Average framerate
645 */
646 AVRational avg_frame_rate;
6c6e6ef5
MN
647
648 /**
649 * Number of frames that have been demuxed during av_find_stream_info()
650 */
651 int codec_info_nb_frames;
fd0368e7
AJ
652
653 /**
654 * Stream informations used internally by av_find_stream_info()
655 */
656#define MAX_STD_TIMEBASES (60*12+5)
657 struct {
658 int64_t last_dts;
659 int64_t duration_gcd;
660 int duration_count;
661 double duration_error[MAX_STD_TIMEBASES];
662 int64_t codec_info_duration;
663 } *info;
de6d9b64
FB
664} AVStream;
665
15afa396
NS
666#define AV_PROGRAM_RUNNING 1
667
ba66ae94 668/**
ba66ae94 669 * New fields can be added to the end with minor version bumps.
8bfb108b 670 * Removal, reordering and changes to existing fields require a major
ba66ae94 671 * version bump.
8bfb108b 672 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 673 */
15afa396
NS
674typedef struct AVProgram {
675 int id;
54036be1 676#if FF_API_OLD_METADATA
a15c7fd6
AK
677 attribute_deprecated char *provider_name; ///< network name for DVB streams
678 attribute_deprecated char *name; ///< service name for DVB streams
827f7e28 679#endif
15afa396
NS
680 int flags;
681 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
682 unsigned int *stream_index;
683 unsigned int nb_stream_indexes;
e232c252 684 AVMetadata *metadata;
15afa396
NS
685} AVProgram;
686
43d414ba 687#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
688 (streams are added dynamically) */
689
79d7836a 690typedef struct AVChapter {
4f57fa8c
DB
691 int id; ///< unique ID to identify the chapter
692 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 693 int64_t start, end; ///< chapter start/end time in time_base units
54036be1 694#if FF_API_OLD_METADATA
a15c7fd6 695 attribute_deprecated char *title; ///< chapter title
827f7e28 696#endif
e232c252 697 AVMetadata *metadata;
79d7836a
AK
698} AVChapter;
699
54036be1 700#if FF_API_MAX_STREAMS
de6d9b64 701#define MAX_STREAMS 20
ad5cc780 702#endif
de6d9b64 703
252f17e2 704/**
4f57fa8c 705 * Format I/O context.
252f17e2 706 * New fields can be added to the end with minor version bumps.
8bfb108b 707 * Removal, reordering and changes to existing fields require a major
252f17e2 708 * version bump.
8bfb108b 709 * sizeof(AVFormatContext) must not be used outside libav*.
252f17e2 710 */
de6d9b64 711typedef struct AVFormatContext {
1447aac4 712 const AVClass *av_class; /**< Set by avformat_alloc_context. */
4f57fa8c 713 /* Can only be iformat or oformat, not both at the same time. */
b9a281db
FB
714 struct AVInputFormat *iformat;
715 struct AVOutputFormat *oformat;
de6d9b64 716 void *priv_data;
899681cd 717 ByteIOContext *pb;
db69c2e5 718 unsigned int nb_streams;
61138c43 719#if FF_API_MAX_STREAMS
de6d9b64 720 AVStream *streams[MAX_STREAMS];
38aab35f
AJ
721#else
722 AVStream **streams;
723#endif
43d414ba 724 char filename[1024]; /**< input or output filename */
de6d9b64 725 /* stream info */
4568325a 726 int64_t timestamp;
54036be1 727#if FF_API_OLD_METADATA
a15c7fd6
AK
728 attribute_deprecated char title[512];
729 attribute_deprecated char author[512];
730 attribute_deprecated char copyright[512];
731 attribute_deprecated char comment[512];
732 attribute_deprecated char album[512];
733 attribute_deprecated int year; /**< ID3 year, 0 if none */
734 attribute_deprecated int track; /**< track number, 0 if none */
735 attribute_deprecated char genre[32]; /**< ID3 genre */
827f7e28 736#endif
6a58e151 737
4f57fa8c
DB
738 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
739 /* private data for pts handling (do not modify directly). */
76c56376
MN
740 /**
741 * This buffer is only needed when packets were already buffered but
742 * not decoded, for example to get the codec parameters in MPEG
743 * streams.
744 */
ee404803
FB
745 struct AVPacketList *packet_buffer;
746
76c56376
MN
747 /**
748 * Decoding: position of the first frame of the component, in
749 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
750 * It is deduced from the AVStream values.
751 */
115329f1 752 int64_t start_time;
76c56376
MN
753
754 /**
755 * Decoding: duration of the stream, in AV_TIME_BASE fractional
756 * seconds. Only set this value if you know none of the individual stream
757 * durations and also dont set any of them. This is deduced from the
758 * AVStream values if not set.
759 */
ee404803 760 int64_t duration;
76c56376
MN
761
762 /**
763 * decoding: total file size, 0 if unknown
764 */
ee404803 765 int64_t file_size;
76c56376
MN
766
767 /**
768 * Decoding: total stream bitrate in bit/s, 0 if not
769 * available. Never set it directly if the file_size and the
770 * duration are known as FFmpeg can compute it automatically.
771 */
ee404803 772 int bit_rate;
fb2758c8
FB
773
774 /* av_read_frame() support */
775 AVStream *cur_st;
d1742ff7 776#if FF_API_LAVF_UNUSED
3a41c2f7
MN
777 const uint8_t *cur_ptr_deprecated;
778 int cur_len_deprecated;
779 AVPacket cur_pkt_deprecated;
780#endif
fb2758c8 781
fb2758c8 782 /* av_seek_frame() support */
ec906fcd 783 int64_t data_offset; /**< offset of the first packet */
fb2758c8 784 int index_built;
115329f1 785
2db3c638 786 int mux_rate;
92400be2 787 unsigned int packet_size;
17c88cb0
MN
788 int preload;
789 int max_delay;
8108551a 790
115329f1
DB
791#define AVFMT_NOOUTPUTLOOP -1
792#define AVFMT_INFINITEOUTPUTLOOP 0
76c56376
MN
793 /**
794 * number of times to loop output in formats that support it
795 */
8108551a 796 int loop_output;
115329f1 797
30bc6613 798 int flags;
22e77e44 799#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
800#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
801#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 802#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
803#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
804#define AVFMT_FLAG_NOPARSE 0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
796ac233 805#define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file
5894e1bb
VP
806
807 int loop_input;
76c56376
MN
808
809 /**
810 * decoding: size of data to probe; encoding: unused.
811 */
9e6c9470 812 unsigned int probesize;
a44b3c4d
MN
813
814 /**
4f57fa8c
DB
815 * Maximum time (in AV_TIME_BASE units) during which the input should
816 * be analyzed in av_find_stream_info().
a44b3c4d
MN
817 */
818 int max_analyze_duration;
c964c2c7
RD
819
820 const uint8_t *key;
821 int keylen;
15afa396
NS
822
823 unsigned int nb_programs;
824 AVProgram **programs;
62600469
MN
825
826 /**
827 * Forced video codec_id.
4f57fa8c 828 * Demuxing: Set by user.
62600469
MN
829 */
830 enum CodecID video_codec_id;
76c56376 831
62600469
MN
832 /**
833 * Forced audio codec_id.
4f57fa8c 834 * Demuxing: Set by user.
62600469
MN
835 */
836 enum CodecID audio_codec_id;
76c56376 837
62600469
MN
838 /**
839 * Forced subtitle codec_id.
4f57fa8c 840 * Demuxing: Set by user.
62600469
MN
841 */
842 enum CodecID subtitle_codec_id;
3dea63bd
PK
843
844 /**
22e77e44
DB
845 * Maximum amount of memory in bytes to use for the index of each stream.
846 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
847 * needed to maintain a smaller size. This can lead to slower or less
848 * accurate seeking (depends on demuxer).
4f57fa8c 849 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
850 * this.
851 * muxing : unused
852 * demuxing: set by user
853 */
854 unsigned int max_index_size;
ab8ab30c
RP
855
856 /**
ffa71b2b 857 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 858 * obtained from realtime capture devices.
ab8ab30c
RP
859 */
860 unsigned int max_picture_buffer;
79d7836a 861
fbabf1e9 862 unsigned int nb_chapters;
79d7836a 863 AVChapter **chapters;
45b2b05f
MN
864
865 /**
4f57fa8c 866 * Flags to enable debugging.
45b2b05f
MN
867 */
868 int debug;
869#define FF_FDEBUG_TS 0x0001
0bef08e5
MN
870
871 /**
4f57fa8c 872 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
873 * This buffer is used for buffering packets until the codec can
874 * be identified, as parsing cannot be done without knowing the
875 * codec.
876 */
877 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
878 struct AVPacketList *raw_packet_buffer_end;
879
880 struct AVPacketList *packet_buffer_end;
47146dfb 881
e232c252 882 AVMetadata *metadata;
af122d6a
BC
883
884 /**
885 * Remaining size available for raw_packet_buffer, in bytes.
886 * NOT PART OF PUBLIC API
887 */
48616887 888#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 889 int raw_packet_buffer_remaining_size;
b8819c85
MS
890
891 /**
892 * Start time of the stream in real world time, in microseconds
893 * since the unix epoch (00:00 1st January 1970). That is, pts=0
894 * in the stream was captured at this real world time.
895 * - encoding: Set by user.
896 * - decoding: Unused.
897 */
898 int64_t start_time_realtime;
de6d9b64
FB
899} AVFormatContext;
900
901typedef struct AVPacketList {
902 AVPacket pkt;
903 struct AVPacketList *next;
904} AVPacketList;
905
114c9a59 906#if FF_API_FIRST_FORMAT
a15c7fd6
AK
907attribute_deprecated extern AVInputFormat *first_iformat;
908attribute_deprecated extern AVOutputFormat *first_oformat;
84be6e72
MN
909#endif
910
aeedac95
SS
911/**
912 * If f is NULL, returns the first registered input format,
22e77e44 913 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
914 * or NULL if f is the last one.
915 */
84be6e72 916AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
917
918/**
919 * If f is NULL, returns the first registered output format,
22e77e44 920 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
921 * or NULL if f is the last one.
922 */
84be6e72 923AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 924
5b6d5596 925enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6 926
22e77e44
DB
927/* XXX: Use automatic init with either ELF sections or C file parser */
928/* modules. */
de6d9b64 929
b9a281db 930/* utils.c */
b9a281db
FB
931void av_register_input_format(AVInputFormat *format);
932void av_register_output_format(AVOutputFormat *format);
198ac67f 933#if FF_API_GUESS_FORMAT
1642ee43 934attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
78cb7273
DB
935 const char *filename,
936 const char *mime_type);
a1f547b9
SS
937
938/**
939 * @deprecated Use av_guess_format() instead.
940 */
941attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
942 const char *filename,
943 const char *mime_type);
1642ee43 944#endif
f48b0fa2
SS
945
946/**
49bd8e4b
MR
947 * Return the output format in the list of registered output formats
948 * which best matches the provided parameters, or return NULL if
f48b0fa2
SS
949 * there is no match.
950 *
951 * @param short_name if non-NULL checks if short_name matches with the
952 * names of the registered formats
953 * @param filename if non-NULL checks if filename terminates with the
954 * extensions of the registered formats
955 * @param mime_type if non-NULL checks if mime_type matches with the
956 * MIME type of the registered formats
957 */
a1f547b9 958AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
959 const char *filename,
960 const char *mime_type);
3217cb42
PI
961
962/**
49bd8e4b 963 * Guess the codec ID based upon muxer and filename.
3217cb42 964 */
115329f1 965enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 966 const char *filename, const char *mime_type,
72415b2a 967 enum AVMediaType type);
de6d9b64 968
3217cb42 969/**
49bd8e4b 970 * Send a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
971 *
972 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
973 * @param buf buffer
974 * @param size buffer size
750f0e1f
PI
975 *
976 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
3217cb42 977 */
fb2758c8 978void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
979
980/**
49bd8e4b 981 * Send a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
982 *
983 * @param avcl A pointer to an arbitrary struct of which the first field is a
984 * pointer to an AVClass struct.
985 * @param level The importance level of the message, lower values signifying
986 * higher importance.
987 * @param buf buffer
988 * @param size buffer size
989 *
990 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
991 */
992void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
993
994/**
49bd8e4b 995 * Send a nice dump of a packet to the specified file stream.
750f0e1f
PI
996 *
997 * @param f The file stream pointer where the dump should be sent to.
3217cb42 998 * @param pkt packet to dump
4f57fa8c 999 * @param dump_payload True if the payload must be displayed, too.
3217cb42 1000 */
fb2758c8 1001void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 1002
750f0e1f 1003/**
49bd8e4b 1004 * Send a nice dump of a packet to the log.
750f0e1f
PI
1005 *
1006 * @param avcl A pointer to an arbitrary struct of which the first field is a
1007 * pointer to an AVClass struct.
1008 * @param level The importance level of the message, lower values signifying
1009 * higher importance.
1010 * @param pkt packet to dump
4f57fa8c 1011 * @param dump_payload True if the payload must be displayed, too.
750f0e1f
PI
1012 */
1013void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1014
4815e246 1015/**
49bd8e4b 1016 * Initialize libavformat and register all the muxers, demuxers and
4815e246
SS
1017 * protocols. If you do not call this function, then you can select
1018 * exactly which formats you want to support.
1019 *
1020 * @see av_register_input_format()
1021 * @see av_register_output_format()
5d377501 1022 * @see av_register_protocol()
4815e246 1023 */
94988531 1024void av_register_all(void);
de6d9b64 1025
7693b93e 1026/**
49bd8e4b 1027 * Get the CodecID for the given codec tag tag.
7693b93e
SS
1028 * If no codec id is found returns CODEC_ID_NONE.
1029 *
1030 * @param tags list of supported codec_id-codec_tag pairs, as stored
1031 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1032 */
15545a09 1033enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
7693b93e
SS
1034
1035/**
49bd8e4b 1036 * Get the codec tag for the given codec id id.
7693b93e
SS
1037 * If no codec tag is found returns 0.
1038 *
1039 * @param tags list of supported codec_id-codec_tag pairs, as stored
1040 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1041 */
15545a09 1042unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 1043
b9a281db 1044/* media file input */
3217cb42
PI
1045
1046/**
49bd8e4b 1047 * Find AVInputFormat based on the short name of the input format.
3217cb42 1048 */
b9a281db 1049AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1050
1051/**
49bd8e4b 1052 * Guess the file format.
3217cb42 1053 *
4f57fa8c
DB
1054 * @param is_opened Whether the file is already opened; determines whether
1055 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1056 */
94988531 1057AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1058
1059/**
49bd8e4b 1060 * Guess the file format.
8e2ee182
RD
1061 *
1062 * @param is_opened Whether the file is already opened; determines whether
1063 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1064 * @param score_max A probe score larger that this is required to accept a
1065 * detection, the variable is set to the actual detection
1066 * score afterwards.
1067 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1068 * to retry with a larger probe buffer.
1069 */
1070AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1071
1072/**
49bd8e4b 1073 * Allocate all the structures needed to read an input stream.
3217cb42
PI
1074 * This does not open the needed codecs for decoding the stream[s].
1075 */
115329f1
DB
1076int av_open_input_stream(AVFormatContext **ic_ptr,
1077 ByteIOContext *pb, const char *filename,
da24c5e3 1078 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
1079
1080/**
49bd8e4b 1081 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
1082 * header (if present) is read.
1083 *
4f57fa8c
DB
1084 * @param ic_ptr The opened media file handle is put here.
1085 * @param filename filename to open
1086 * @param fmt If non-NULL, force the file format to use.
3217cb42 1087 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
1088 * @param ap Additional parameters needed when opening the file
1089 * (NULL if default).
4f57fa8c 1090 * @return 0 if OK, AVERROR_xxx otherwise
3217cb42 1091 */
115329f1 1092int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
1093 AVInputFormat *fmt,
1094 int buf_size,
1095 AVFormatParameters *ap);
88a28965 1096
ca51d86c 1097#if FF_API_ALLOC_FORMAT_CONTEXT
88a28965
SS
1098/**
1099 * @deprecated Use avformat_alloc_context() instead.
1100 */
1101attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1102#endif
1103
88808c60 1104/**
49bd8e4b 1105 * Allocate an AVFormatContext.
5d81d641 1106 * Can be freed with av_free() but do not forget to free everything you
88808c60
MN
1107 * explicitly allocated as well!
1108 */
88a28965 1109AVFormatContext *avformat_alloc_context(void);
b9a281db 1110
3217cb42 1111/**
49bd8e4b 1112 * Read packets of a media file to get stream information. This
3217cb42 1113 * is useful for file formats with no headers such as MPEG. This
22e77e44 1114 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
1115 * frame mode.
1116 * The logical file position is not changed by this function;
1117 * examined packets may be buffered for later processing.
1118 *
1119 * @param ic media file handle
4f57fa8c
DB
1120 * @return >=0 if OK, AVERROR_xxx on error
1121 * @todo Let the user decide somehow what information is needed so that
1122 * we do not waste time getting stuff the user does not need.
3217cb42 1123 */
b9a281db 1124int av_find_stream_info(AVFormatContext *ic);
3217cb42
PI
1125
1126/**
49bd8e4b 1127 * Read a transport packet from a media file.
3217cb42 1128 *
864ff8c1 1129 * This function is obsolete and should never be used.
3217cb42
PI
1130 * Use av_read_frame() instead.
1131 *
1132 * @param s media file handle
1133 * @param pkt is filled
4f57fa8c 1134 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1135 */
de6d9b64 1136int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1137
1138/**
49bd8e4b 1139 * Return the next frame of a stream.
4faf628f
MN
1140 * This function returns what is stored in the file, and does not validate
1141 * that what is there are valid frames for the decoder. It will split what is
1142 * stored in the file into frames and return one for each call. It will not
1143 * omit invalid data between valid frames so as to give the decoder the maximum
1144 * information possible for decoding.
3217cb42
PI
1145 *
1146 * The returned packet is valid
1147 * until the next av_read_frame() or until av_close_input_file() and
1148 * must be freed with av_free_packet. For video, the packet contains
1149 * exactly one frame. For audio, it contains an integer number of
1150 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1151 * data). If the audio frames have a variable size (e.g. MPEG audio),
1152 * then it contains one frame.
1153 *
1154 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1155 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1156 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1157 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1158 * decompress the payload.
1159 *
4f57fa8c 1160 * @return 0 if OK, < 0 on error or end of file
3217cb42 1161 */
fb2758c8 1162int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1163
1164/**
49bd8e4b 1165 * Seek to the keyframe at timestamp.
3217cb42
PI
1166 * 'timestamp' in 'stream_index'.
1167 * @param stream_index If stream_index is (-1), a default
1168 * stream is selected, and timestamp is automatically converted
1169 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1170 * @param timestamp Timestamp in AVStream.time_base units
1171 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1172 * @param flags flags which select direction and seeking mode
1173 * @return >= 0 on success
1174 */
78cb7273
DB
1175int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1176 int flags);
3217cb42
PI
1177
1178/**
49bd8e4b 1179 * Seek to timestamp ts.
d04768fa
MN
1180 * Seeking will be done so that the point from which all active streams
1181 * can be presented successfully will be closest to ts and within min/max_ts.
1182 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1183 *
22e77e44 1184 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1185 * are the file position (this may not be supported by all demuxers).
22e77e44 1186 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1187 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1188 * Otherwise all timestamps are in units of the stream selected by stream_index
1189 * or if stream_index is -1, in AV_TIME_BASE units.
1190 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1191 * keyframes (this may not be supported by all demuxers).
1192 *
22e77e44 1193 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1194 * @param min_ts smallest acceptable timestamp
1195 * @param ts target timestamp
1196 * @param max_ts largest acceptable timestamp
1197 * @param flags flags
32e543f8 1198 * @return >=0 on success, error code otherwise
998b6f7c 1199 *
8a4d7a30 1200 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1201 * Thus do not use this yet. It may change at any time, do not expect
1202 * ABI compatibility yet!
d04768fa
MN
1203 */
1204int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1205
1206/**
49bd8e4b 1207 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1208 * current position.
3217cb42 1209 */
fb2758c8 1210int av_read_play(AVFormatContext *s);
3217cb42
PI
1211
1212/**
49bd8e4b 1213 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1214 *
1215 * Use av_read_play() to resume it.
1216 */
fb2758c8 1217int av_read_pause(AVFormatContext *s);
3217cb42
PI
1218
1219/**
49bd8e4b 1220 * Free a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1221 * @param s context to free
1222 */
1223void av_close_input_stream(AVFormatContext *s);
1224
1225/**
49bd8e4b 1226 * Close a media file (but not its codecs).
3217cb42
PI
1227 *
1228 * @param s media file handle
1229 */
de6d9b64 1230void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1231
1232/**
49bd8e4b 1233 * Add a new stream to a media file.
3217cb42
PI
1234 *
1235 * Can only be called in the read_header() function. If the flag
1236 * AVFMTCTX_NOHEADER is in the format context, then new streams
1237 * can be added in read_packet too.
1238 *
1239 * @param s media file handle
4f57fa8c 1240 * @param id file-format-dependent stream ID
3217cb42 1241 */
b9a281db 1242AVStream *av_new_stream(AVFormatContext *s, int id);
15afa396 1243AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1244
1245/**
49bd8e4b 1246 * Add a new chapter.
79d7836a 1247 * This function is NOT part of the public API
4f57fa8c 1248 * and should ONLY be used by demuxers.
79d7836a
AK
1249 *
1250 * @param s media file handle
4f57fa8c 1251 * @param id unique ID for this chapter
abd2256d
MN
1252 * @param start chapter start time in time_base units
1253 * @param end chapter end time in time_base units
79d7836a 1254 * @param title chapter title
5c37f43a 1255 *
4f57fa8c 1256 * @return AVChapter or NULL on error
79d7836a 1257 */
78cb7273
DB
1258AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1259 int64_t start, int64_t end, const char *title);
79d7836a
AK
1260
1261/**
49bd8e4b 1262 * Set the pts for a given stream.
3217cb42
PI
1263 *
1264 * @param s stream
1265 * @param pts_wrap_bits number of bits effectively used by the pts
1266 * (used for wrap control, 33 is the value for MPEG)
1267 * @param pts_num numerator to convert to seconds (MPEG: 1)
1268 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1269 */
9ee91c2f 1270void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1271 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1272
3ba1438d
MN
1273#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1274#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1275#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1276#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1277
b754978a 1278int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1279
1280/**
49bd8e4b 1281 * Get the index for a specific timestamp.
4f57fa8c
DB
1282 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1283 * to the timestamp which is <= the requested one, if backward
1284 * is 0, then it will be >=
3217cb42
PI
1285 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1286 * @return < 0 if no such timestamp could be found
1287 */
dc56fc38 1288int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1289
1290/**
49bd8e4b 1291 * Ensure the index uses less memory than the maximum specified in
22e77e44 1292 * AVFormatContext.max_index_size by discarding entries if it grows
3dea63bd
PK
1293 * too large.
1294 * This function is not part of the public API and should only be called
1295 * by demuxers.
1296 */
1297void ff_reduce_index(AVFormatContext *s, int stream_index);
1298
1299/**
49bd8e4b 1300 * Add an index entry into a sorted list. Update the entry if the list
4f57fa8c 1301 * already contains it.
3217cb42 1302 *
4f57fa8c 1303 * @param timestamp timestamp in the time base of the given stream
3217cb42 1304 */
78cb7273
DB
1305int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1306 int size, int distance, int flags);
3217cb42
PI
1307
1308/**
49bd8e4b 1309 * Perform a binary search using av_index_search_timestamp() and
3673f4ab 1310 * AVInputFormat.read_timestamp().
78cb7273
DB
1311 * This is not supposed to be called directly by a user application,
1312 * but by demuxers.
3217cb42
PI
1313 * @param target_ts target timestamp in the time base of the given stream
1314 * @param stream_index stream number
1315 */
78cb7273
DB
1316int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1317 int64_t target_ts, int flags);
3217cb42
PI
1318
1319/**
49bd8e4b 1320 * Update cur_dts of all streams based on the given timestamp and AVStream.
3217cb42 1321 *
4f57fa8c
DB
1322 * Stream ref_st unchanged, others set cur_dts in their native time base.
1323 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
3217cb42
PI
1324 * @param timestamp new dts expressed in time_base of param ref_st
1325 * @param ref_st reference stream giving time_base of param timestamp
1326 */
22ffac70 1327void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
3217cb42
PI
1328
1329/**
49bd8e4b 1330 * Perform a binary search using read_timestamp().
78cb7273
DB
1331 * This is not supposed to be called directly by a user application,
1332 * but by demuxers.
3217cb42
PI
1333 * @param target_ts target timestamp in the time base of the given stream
1334 * @param stream_index stream number
1335 */
78cb7273
DB
1336int64_t av_gen_search(AVFormatContext *s, int stream_index,
1337 int64_t target_ts, int64_t pos_min,
1338 int64_t pos_max, int64_t pos_limit,
1339 int64_t ts_min, int64_t ts_max,
1340 int flags, int64_t *ts_ret,
1341 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
b754978a 1342
76c56376
MN
1343/**
1344 * media file output
1345 */
290c5fa6 1346int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
3217cb42
PI
1347
1348/**
f3bfe388
MR
1349 * Split a URL string into components.
1350 *
1351 * The pointers to buffers for storing individual components may be null,
1352 * in order to ignore that component. Buffers for components not found are
1353 * set to empty strings. If the port is not found, it is set to a negative
1354 * value.
1355 *
1356 * @param proto the buffer for the protocol
1357 * @param proto_size the size of the proto buffer
1358 * @param authorization the buffer for the authorization
1359 * @param authorization_size the size of the authorization buffer
1360 * @param hostname the buffer for the host name
1361 * @param hostname_size the size of the hostname buffer
1362 * @param port_ptr a pointer to store the port number in
1363 * @param path the buffer for the path
1364 * @param path_size the size of the path buffer
1365 * @param url the URL to split
1366 */
1367void av_url_split(char *proto, int proto_size,
1368 char *authorization, int authorization_size,
1369 char *hostname, int hostname_size,
1370 int *port_ptr,
1371 char *path, int path_size,
1372 const char *url);
1373
1374/**
49bd8e4b 1375 * Allocate the stream private data and write the stream header to an
755bfeab 1376 * output media file.
3217cb42
PI
1377 *
1378 * @param s media file handle
4f57fa8c 1379 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1380 */
b9a281db 1381int av_write_header(AVFormatContext *s);
3217cb42
PI
1382
1383/**
49bd8e4b 1384 * Write a packet to an output media file.
3217cb42
PI
1385 *
1386 * The packet shall contain one audio or video frame.
78cb7273
DB
1387 * The packet must be correctly interleaved according to the container
1388 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1389 *
1390 * @param s media file handle
78cb7273
DB
1391 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1392 dts/pts, ...
4f57fa8c 1393 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1394 */
e928649b 1395int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1396
1397/**
49bd8e4b 1398 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1399 *
1400 * The packet must contain one audio or video frame.
22e77e44 1401 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1402 * call av_write_frame() instead as it is slightly faster. It is also important
1403 * to keep in mind that completely non-interleaved input will need huge amounts
1404 * of memory to interleave with this, so it is preferable to interleave at the
1405 * demuxer level.
3217cb42
PI
1406 *
1407 * @param s media file handle
78cb7273
DB
1408 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1409 dts/pts, ...
4f57fa8c 1410 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1411 */
3c895fc0 1412int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1413
1414/**
49bd8e4b 1415 * Interleave a packet per dts in an output media file.
3217cb42 1416 *
78cb7273 1417 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1418 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1419 * on them is still safe.
3217cb42
PI
1420 *
1421 * @param s media file handle
1422 * @param out the interleaved packet will be output here
9a58234f 1423 * @param pkt the input packet
3217cb42
PI
1424 * @param flush 1 if no further packets are available as input and all
1425 * remaining packets should be output
1426 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1427 * < 0 if an error occurred
3217cb42 1428 */
78cb7273
DB
1429int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1430 AVPacket *pkt, int flush);
e928649b 1431
3217cb42 1432/**
49bd8e4b 1433 * Write the stream trailer to an output media file and free the
2b75bde6 1434 * file private data.
3217cb42 1435 *
dc76fe13
RD
1436 * May only be called after a successful call to av_write_header.
1437 *
3217cb42 1438 * @param s media file handle
4f57fa8c 1439 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1440 */
b9a281db 1441int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
1442
1443void dump_format(AVFormatContext *ic,
115329f1 1444 int index,
de6d9b64
FB
1445 const char *url,
1446 int is_output);
3217cb42 1447
d87a521c 1448#if FF_API_PARSE_FRAME_PARAM
3217cb42 1449/**
49bd8e4b 1450 * Parse width and height out of string str.
26ef3220 1451 * @deprecated Use av_parse_video_frame_size instead.
3217cb42 1452 */
78cb7273
DB
1453attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1454 const char *str);
3217cb42
PI
1455
1456/**
49bd8e4b 1457 * Convert framerate from a string to a fraction.
26ef3220 1458 * @deprecated Use av_parse_video_frame_rate instead.
3217cb42 1459 */
78cb7273
DB
1460attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1461 const char *arg);
1ca9133f 1462#endif
3217cb42
PI
1463
1464/**
49bd8e4b 1465 * Parse datestr and return a corresponding number of microseconds.
f9436161
SS
1466 * @param datestr String representing a date or a duration.
1467 * - If a date the syntax is:
3217cb42 1468 * @code
fcd10c4f 1469 * now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
3217cb42 1470 * @endcode
fcd10c4f 1471 * If the value is "now" it takes the current time.
4f57fa8c 1472 * Time is local time unless Z is appended, in which case it is
f9436161 1473 * interpreted as UTC.
4f57fa8c 1474 * If the year-month-day part is not specified it takes the current
f9436161 1475 * year-month-day.
49bd8e4b 1476 * @return the number of microseconds since 1st of January, 1970 up to
819174fa 1477 * the time of the parsed date or INT64_MIN if datestr cannot be
f9436161
SS
1478 * successfully parsed.
1479 * - If a duration the syntax is:
1480 * @code
1481 * [-]HH[:MM[:SS[.m...]]]
1482 * [-]S+[.m...]
1483 * @endcode
49bd8e4b 1484 * @return the number of microseconds contained in a time interval
819174fa 1485 * with the specified duration or INT64_MIN if datestr cannot be
7338d368 1486 * successfully parsed.
819174fa
SS
1487 * @param duration Flag which tells how to interpret datestr, if
1488 * not zero datestr is interpreted as a duration, otherwise as a
f9436161 1489 * date.
3217cb42 1490 */
0c1a9eda 1491int64_t parse_date(const char *datestr, int duration);
de6d9b64 1492
76c56376
MN
1493/**
1494 * Get the current time in microseconds.
1495 */
0c1a9eda 1496int64_t av_gettime(void);
94988531 1497
4f57fa8c 1498/* ffm-specific for ffserver */
de6d9b64 1499#define FFM_PACKET_SIZE 4096
bc5c918e 1500int64_t ffm_read_write_index(int fd);
6fcce4f9 1501int ffm_write_write_index(int fd, int64_t pos);
bc5c918e 1502void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
de6d9b64 1503
3217cb42 1504/**
49bd8e4b 1505 * Attempt to find a specific tag in a URL.
3217cb42
PI
1506 *
1507 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1508 * Return 1 if found.
1509 */
de6d9b64
FB
1510int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1511
3217cb42 1512/**
49bd8e4b 1513 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1514 *
3217cb42
PI
1515 * Also handles the '%0nd' format where 'n' is the total number
1516 * of digits and '%%'.
1517 *
1518 * @param buf destination buffer
1519 * @param buf_size destination buffer size
1520 * @param path numbered sequence string
8ea0e802 1521 * @param number frame number
4f57fa8c 1522 * @return 0 if OK, -1 on format error
3217cb42 1523 */
5c07cf53
MB
1524int av_get_frame_filename(char *buf, int buf_size,
1525 const char *path, int number);
3217cb42
PI
1526
1527/**
49bd8e4b 1528 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1529 *
1530 * @param filename possible numbered sequence string
4f57fa8c 1531 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1532 */
5c07cf53 1533int av_filename_number_test(const char *filename);
96baaa6a 1534
c5388c07 1535/**
49bd8e4b 1536 * Generate an SDP for an RTP session.
c5388c07
LA
1537 *
1538 * @param ac array of AVFormatContexts describing the RTP streams. If the
1539 * array is composed by only one context, such context can contain
1540 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1541 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1542 * must contain only one AVStream.
8767b80f
LA
1543 * @param n_files number of AVCodecContexts contained in ac
1544 * @param buff buffer where the SDP will be stored (must be allocated by
4f57fa8c 1545 * the caller)
8767b80f 1546 * @param size the size of the buffer
4f57fa8c 1547 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1548 */
8767b80f 1549int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
c5388c07 1550
1a70d127 1551/**
49bd8e4b 1552 * Return a positive value if the given filename has one of the given
1a70d127
SS
1553 * extensions, 0 otherwise.
1554 *
1555 * @param extensions a comma-separated list of filename extensions
1556 */
1557int av_match_ext(const char *filename, const char *extensions);
1558
98790382 1559#endif /* AVFORMAT_AVFORMAT_H */