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