doxy: introduce an empty structure in libavcodec
[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 */
b631fba9 277#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
b9a281db
FB
278
279typedef struct AVOutputFormat {
de6d9b64 280 const char *name;
bde15e74
SS
281 /**
282 * Descriptive name for the format, meant to be more human-readable
819174fa 283 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
284 * to define it.
285 */
de6d9b64
FB
286 const char *long_name;
287 const char *mime_type;
4f57fa8c 288 const char *extensions; /**< comma-separated filename extensions */
76c56376
MN
289 /**
290 * size of private data so that it can be allocated in the wrapper
291 */
b9a281db 292 int priv_data_size;
de6d9b64 293 /* output support */
43d414ba
PI
294 enum CodecID audio_codec; /**< default audio codec */
295 enum CodecID video_codec; /**< default video codec */
de6d9b64 296 int (*write_header)(struct AVFormatContext *);
e928649b 297 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 298 int (*write_trailer)(struct AVFormatContext *);
76c56376 299 /**
89e568fe
AH
300 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
301 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
302 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
76c56376 303 */
b9a281db 304 int flags;
76c56376
MN
305 /**
306 * Currently only used to set pixel format if not YUV420P.
307 */
290c5fa6 308 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
78cb7273
DB
309 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
310 AVPacket *in, int flush);
7caf0cc6
MN
311
312 /**
78cb7273 313 * List of supported codec_id-codec_tag pairs, ordered by "better
22e77e44 314 * choice first". The arrays are all terminated by CODEC_ID_NONE.
7caf0cc6 315 */
c1854592 316 const struct AVCodecTag * const *codec_tag;
7caf0cc6 317
11bf3847
AJ
318 enum CodecID subtitle_codec; /**< default subtitle codec */
319
451d566f 320#if FF_API_OLD_METADATA2
719e721a 321 const AVMetadataConv *metadata_conv;
03700d39 322#endif
f610a9f2 323
cf99e4aa
AH
324 const AVClass *priv_class; ///< AVClass for the private context
325
48f9e457
AK
326 /**
327 * Test if the given codec can be stored in this container.
328 *
329 * @return 1 if the codec is supported, 0 if it is not.
330 * A negative number if unknown.
331 */
332 int (*query_codec)(enum CodecID id, int std_compliance);
333
b9a281db
FB
334 /* private fields */
335 struct AVOutputFormat *next;
336} AVOutputFormat;
de6d9b64 337
b9a281db 338typedef struct AVInputFormat {
76c56376
MN
339 /**
340 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
341 * may be appended with a minor bump.
342 */
b9a281db 343 const char *name;
76c56376 344
bde15e74
SS
345 /**
346 * Descriptive name for the format, meant to be more human-readable
819174fa 347 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
348 * to define it.
349 */
b9a281db 350 const char *long_name;
76c56376
MN
351
352 /**
353 * Size of private data so that it can be allocated in the wrapper.
354 */
b9a281db 355 int priv_data_size;
76c56376 356
65d7d68b 357 /**
22e77e44 358 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
359 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
360 * big so you do not have to check for that unless you need more.
65d7d68b 361 */
b9a281db 362 int (*read_probe)(AVProbeData *);
76c56376
MN
363
364 /**
365 * Read the format header and initialize the AVFormatContext
366 * structure. Return 0 if OK. 'ap' if non-NULL contains
367 * additional parameters. Only used in raw format right
368 * now. 'av_new_stream' should be called to create new streams.
369 */
de6d9b64
FB
370 int (*read_header)(struct AVFormatContext *,
371 AVFormatParameters *ap);
76c56376
MN
372
373 /**
374 * Read one packet and put it in 'pkt'. pts and flags are also
375 * set. 'av_new_stream' can be called only if the flag
2899a28c
AJ
376 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
377 * background thread).
76c56376
MN
378 * @return 0 on success, < 0 on error.
379 * When returning an error, pkt must not have been allocated
380 * or must be freed before returning
381 */
de6d9b64 382 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
383
384 /**
385 * Close the stream. The AVFormatContext and AVStreams are not
386 * freed by this function
387 */
de6d9b64 388 int (*read_close)(struct AVFormatContext *);
1de2db8f 389
634e0304 390#if FF_API_READ_SEEK
115329f1 391 /**
4f57fa8c
DB
392 * Seek to a given timestamp relative to the frames in
393 * stream component stream_index.
22e77e44
DB
394 * @param stream_index Must not be -1.
395 * @param flags Selects which direction should be preferred if no exact
396 * match is available.
05ce0f11 397 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 398 */
a15c7fd6
AK
399 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
400 int stream_index, int64_t timestamp, int flags);
1de2db8f 401#endif
8d14a25c 402 /**
4f57fa8c 403 * Gets the next timestamp in stream[stream_index].time_base units.
d9526386 404 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
405 */
406 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
407 int64_t *pos, int64_t pos_limit);
76c56376
MN
408
409 /**
050e20ae
JR
410 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
411 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
b631fba9 412 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
76c56376 413 */
de6d9b64 414 int flags;
76c56376
MN
415
416 /**
417 * If extensions are defined, then no probe is done. You should
418 * usually not use extension format guessing because it is not
419 * reliable enough
420 */
b9a281db 421 const char *extensions;
76c56376
MN
422
423 /**
424 * General purpose read-only value that the format can use.
425 */
b9a281db 426 int value;
fb2758c8 427
76c56376
MN
428 /**
429 * Start/resume playing - only meaningful if using a network-based format
430 * (RTSP).
431 */
fb2758c8
FB
432 int (*read_play)(struct AVFormatContext *);
433
76c56376
MN
434 /**
435 * Pause playing - only meaningful if using a network-based format
436 * (RTSP).
437 */
fb2758c8
FB
438 int (*read_pause)(struct AVFormatContext *);
439
c1854592 440 const struct AVCodecTag * const *codec_tag;
7caf0cc6 441
1de2db8f 442 /**
49bd8e4b 443 * Seek to timestamp ts.
1de2db8f
MN
444 * Seeking will be done so that the point from which all active streams
445 * can be presented successfully will be closest to ts and within min/max_ts.
446 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
447 */
882fb0a3 448 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1de2db8f 449
451d566f 450#if FF_API_OLD_METADATA2
719e721a 451 const AVMetadataConv *metadata_conv;
03700d39 452#endif
f610a9f2 453
5dc82144
AK
454 const AVClass *priv_class; ///< AVClass for the private context
455
b9a281db
FB
456 /* private fields */
457 struct AVInputFormat *next;
458} AVInputFormat;
de6d9b64 459
57004ff1
AJ
460enum AVStreamParseType {
461 AVSTREAM_PARSE_NONE,
462 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 463 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 464 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 465 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
466};
467
fb2758c8
FB
468typedef struct AVIndexEntry {
469 int64_t pos;
470 int64_t timestamp;
471#define AVINDEX_KEYFRAME 0x0001
30a43f2d 472 int flags:2;
4f57fa8c
DB
473 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).
474 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
475} AVIndexEntry;
476
90c2295b
ES
477#define AV_DISPOSITION_DEFAULT 0x0001
478#define AV_DISPOSITION_DUB 0x0002
479#define AV_DISPOSITION_ORIGINAL 0x0004
480#define AV_DISPOSITION_COMMENT 0x0008
481#define AV_DISPOSITION_LYRICS 0x0010
482#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
483
484/**
485 * Track should be used during playback by default.
486 * Useful for subtitle track that should be displayed
487 * even when user did not explicitly ask for subtitles.
488 */
7a617a86 489#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
490#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
491#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 492#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
90c2295b 493
ba66ae94
MN
494/**
495 * Stream structure.
496 * New fields can be added to the end with minor version bumps.
8bfb108b 497 * Removal, reordering and changes to existing fields require a major
ba66ae94 498 * version bump.
8bfb108b 499 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 500 */
de6d9b64 501typedef struct AVStream {
43d414ba 502 int index; /**< stream index in AVFormatContext */
4f57fa8c 503 int id; /**< format-specific stream ID */
43d414ba 504 AVCodecContext *codec; /**< codec context */
b4b87d48 505 /**
22e77e44
DB
506 * Real base framerate of the stream.
507 * This is the lowest framerate with which all timestamps can be
864ff8c1 508 * represented accurately (it is the least common multiple of all
22e77e44
DB
509 * framerates in the stream). Note, this value is just a guess!
510 * For example, if the time base is 1/90000 and all frames have either
4f57fa8c 511 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
b4b87d48
MN
512 */
513 AVRational r_frame_rate;
de6d9b64 514 void *priv_data;
82583548 515
9a174562 516#if FF_API_REORDER_PRIVATE
b9a281db 517 /* internal data used in av_find_stream_info() */
82583548 518 int64_t first_dts;
9a174562 519#endif
76c56376
MN
520
521 /**
522 * encoding: pts generation when outputting stream
523 */
a9fd2b19 524 struct AVFrac pts;
5b28c8c3
MN
525
526 /**
8bfb108b
DB
527 * This is the fundamental unit of time (in seconds) in terms
528 * of which frame timestamps are represented. For fixed-fps content,
22e77e44 529 * time base should be 1/framerate and timestamp increments should be 1.
5d820db2
RD
530 * decoding: set by libavformat
531 * encoding: set by libavformat in av_write_header
5b28c8c3 532 */
9ee91c2f 533 AVRational time_base;
9a174562 534#if FF_API_REORDER_PRIVATE
43d414ba 535 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
9a174562 536#endif
3d813e4c 537#if FF_API_STREAM_COPY
a48b7a6b 538 /* ffmpeg.c private use */
3d813e4c
AK
539 attribute_deprecated int stream_copy; /**< If set, just copy stream. */
540#endif
4f57fa8c 541 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
76c56376 542
5e8d2e33 543#if FF_API_AVSTREAM_QUALITY
b4aea108 544 //FIXME move stuff to a flags field?
76c56376
MN
545 /**
546 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
547 * MN: dunno if that is the right place for it
548 */
5e8d2e33
AK
549 attribute_deprecated float quality;
550#endif
76c56376 551
6d96a9b9 552 /**
8bfb108b
DB
553 * Decoding: pts of the first frame of the stream, in stream time base.
554 * Only set this if you are absolutely 100% sure that the value you set
555 * it to really is the pts of the first frame.
4854c253 556 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 557 */
115329f1 558 int64_t start_time;
76c56376 559
e26381b6 560 /**
8bfb108b 561 * Decoding: duration of the stream, in stream time base.
e26381b6 562 * If a source file does not specify a duration, but does specify
4f57fa8c 563 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 564 */
ee404803 565 int64_t duration;
fb2758c8 566
9a174562 567#if FF_API_REORDER_PRIVATE
fb2758c8 568 /* av_read_frame() support */
57004ff1 569 enum AVStreamParseType need_parsing;
fb2758c8 570 struct AVCodecParserContext *parser;
6ec87caa 571
fb2758c8 572 int64_t cur_dts;
635fbcb1
MN
573 int last_IP_duration;
574 int64_t last_IP_pts;
fb2758c8 575 /* av_seek_frame() support */
4f57fa8c
DB
576 AVIndexEntry *index_entries; /**< Only used if the format does not
577 support seeking natively. */
fb2758c8 578 int nb_index_entries;
191e8ca7 579 unsigned int index_entries_allocated_size;
9a174562 580#endif
115329f1 581
b4b87d48 582 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 583
4f57fa8c 584 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5 585
9a174562 586#if FF_API_REORDER_PRIVATE
0bef08e5 587 AVProbeData probe_data;
0d84a8f6
BC
588#define MAX_REORDER_DELAY 16
589 int64_t pts_buffer[MAX_REORDER_DELAY+1];
9a174562 590#endif
c30a4489
AJ
591
592 /**
593 * sample aspect ratio (0 if unknown)
594 * - encoding: Set by user.
595 * - decoding: Set by libavformat.
596 */
597 AVRational sample_aspect_ratio;
f526adaf 598
d2d67e42 599 AVDictionary *metadata;
3a41c2f7 600
9a174562 601#if FF_API_REORDER_PRIVATE
31769dad
VP
602 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
603 /* external applications; try to use something else if at all possible. */
3a41c2f7
MN
604 const uint8_t *cur_ptr;
605 int cur_len;
606 AVPacket cur_pkt;
27ca0a79
IS
607
608 // Timestamp generation support:
609 /**
610 * Timestamp corresponding to the last dts sync point.
611 *
612 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
613 * a DTS is received from the underlying container. Otherwise set to
614 * AV_NOPTS_VALUE by default.
615 */
616 int64_t reference_dts;
86cb7e33
BC
617
618 /**
619 * Number of packets to buffer for codec probing
620 * NOT PART OF PUBLIC API
621 */
48616887 622#define MAX_PROBE_PACKETS 2500
86cb7e33 623 int probe_packets;
ddce56ef
MN
624
625 /**
e07b882b 626 * last packet in packet_buffer for this stream when muxing.
ddce56ef
MN
627 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
628 */
e07b882b 629 struct AVPacketList *last_in_packet_buffer;
9a174562 630#endif
02b398ef
MN
631
632 /**
633 * Average framerate
634 */
635 AVRational avg_frame_rate;
6c6e6ef5 636
9a174562
AK
637 /*****************************************************************
638 * All fields below this line are not part of the public API. They
639 * may not be used outside of libavformat and can be changed and
640 * removed at will.
641 * New public fields should be added right above.
642 *****************************************************************
643 */
644
6c6e6ef5
MN
645 /**
646 * Number of frames that have been demuxed during av_find_stream_info()
647 */
648 int codec_info_nb_frames;
fd0368e7
AJ
649
650 /**
651 * Stream informations used internally by av_find_stream_info()
652 */
653#define MAX_STD_TIMEBASES (60*12+5)
654 struct {
655 int64_t last_dts;
656 int64_t duration_gcd;
657 int duration_count;
658 double duration_error[MAX_STD_TIMEBASES];
659 int64_t codec_info_duration;
38a4be3f 660 int nb_decoded_frames;
fd0368e7 661 } *info;
9a174562
AK
662#if !FF_API_REORDER_PRIVATE
663 const uint8_t *cur_ptr;
664 int cur_len;
665 AVPacket cur_pkt;
666
667 // Timestamp generation support:
668 /**
669 * Timestamp corresponding to the last dts sync point.
670 *
671 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
672 * a DTS is received from the underlying container. Otherwise set to
673 * AV_NOPTS_VALUE by default.
674 */
675 int64_t reference_dts;
676 int64_t first_dts;
677 int64_t cur_dts;
678 int last_IP_duration;
679 int64_t last_IP_pts;
680
681 /**
682 * Number of packets to buffer for codec probing
683 */
684#define MAX_PROBE_PACKETS 2500
685 int probe_packets;
686
687 /**
688 * last packet in packet_buffer for this stream when muxing.
689 */
690 struct AVPacketList *last_in_packet_buffer;
691 AVProbeData probe_data;
692#define MAX_REORDER_DELAY 16
693 int64_t pts_buffer[MAX_REORDER_DELAY+1];
694 /* av_read_frame() support */
695 enum AVStreamParseType need_parsing;
696 struct AVCodecParserContext *parser;
697
698 AVIndexEntry *index_entries; /**< Only used if the format does not
699 support seeking natively. */
700 int nb_index_entries;
701 unsigned int index_entries_allocated_size;
702
703 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
704#endif
de6d9b64
FB
705} AVStream;
706
15afa396
NS
707#define AV_PROGRAM_RUNNING 1
708
ba66ae94 709/**
ba66ae94 710 * New fields can be added to the end with minor version bumps.
8bfb108b 711 * Removal, reordering and changes to existing fields require a major
ba66ae94 712 * version bump.
8bfb108b 713 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 714 */
15afa396
NS
715typedef struct AVProgram {
716 int id;
15afa396
NS
717 int flags;
718 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
719 unsigned int *stream_index;
720 unsigned int nb_stream_indexes;
d2d67e42 721 AVDictionary *metadata;
15afa396
NS
722} AVProgram;
723
43d414ba 724#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
725 (streams are added dynamically) */
726
79d7836a 727typedef struct AVChapter {
4f57fa8c
DB
728 int id; ///< unique ID to identify the chapter
729 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 730 int64_t start, end; ///< chapter start/end time in time_base units
d2d67e42 731 AVDictionary *metadata;
79d7836a
AK
732} AVChapter;
733
252f17e2 734/**
4f57fa8c 735 * Format I/O context.
252f17e2 736 * New fields can be added to the end with minor version bumps.
8bfb108b 737 * Removal, reordering and changes to existing fields require a major
252f17e2 738 * version bump.
83daced0
AK
739 * sizeof(AVFormatContext) must not be used outside libav*, use
740 * avformat_alloc_context() to create an AVFormatContext.
252f17e2 741 */
de6d9b64 742typedef struct AVFormatContext {
83daced0
AK
743 /**
744 * A class for logging and AVOptions. Set by avformat_alloc_context().
745 * Exports (de)muxer private options if they exist.
746 */
747 const AVClass *av_class;
748
749 /**
750 * Can only be iformat or oformat, not both at the same time.
751 *
752 * decoding: set by avformat_open_input().
753 * encoding: set by the user.
754 */
b9a281db
FB
755 struct AVInputFormat *iformat;
756 struct AVOutputFormat *oformat;
83daced0
AK
757
758 /**
759 * Format private data. This is an AVOptions-enabled struct
760 * if and only if iformat/oformat.priv_class is not NULL.
761 */
de6d9b64 762 void *priv_data;
83daced0
AK
763
764 /*
765 * I/O context.
766 *
767 * decoding: either set by the user before avformat_open_input() (then
768 * the user must close it manually) or set by avformat_open_input().
769 * encoding: set by the user.
770 *
771 * Do NOT set this field if AVFMT_NOFILE flag is set in
772 * iformat/oformat.flags. In such a case, the (de)muxer will handle
773 * I/O in some other way and this field will be NULL.
774 */
ae628ec1 775 AVIOContext *pb;
83daced0
AK
776
777 /**
778 * A list of all streams in the file. New streams are created with
779 * avformat_new_stream().
780 *
781 * decoding: streams are created by libavformat in avformat_open_input().
782 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
783 * appear in av_read_frame().
784 * encoding: streams are created by the user before avformat_write_header().
785 */
db69c2e5 786 unsigned int nb_streams;
38aab35f 787 AVStream **streams;
83daced0 788
43d414ba 789 char filename[1024]; /**< input or output filename */
de6d9b64 790 /* stream info */
5f847bf6
AK
791#if FF_API_TIMESTAMP
792 /**
793 * @deprecated use 'creation_time' metadata tag instead
794 */
795 attribute_deprecated int64_t timestamp;
796#endif
6a58e151 797
4f57fa8c 798 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
df968050 799#if FF_API_REORDER_PRIVATE
4f57fa8c 800 /* private data for pts handling (do not modify directly). */
76c56376
MN
801 /**
802 * This buffer is only needed when packets were already buffered but
803 * not decoded, for example to get the codec parameters in MPEG
804 * streams.
805 */
ee404803 806 struct AVPacketList *packet_buffer;
df968050 807#endif
ee404803 808
76c56376
MN
809 /**
810 * Decoding: position of the first frame of the component, in
811 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
812 * It is deduced from the AVStream values.
813 */
115329f1 814 int64_t start_time;
76c56376
MN
815
816 /**
817 * Decoding: duration of the stream, in AV_TIME_BASE fractional
818 * seconds. Only set this value if you know none of the individual stream
819 * durations and also dont set any of them. This is deduced from the
820 * AVStream values if not set.
821 */
ee404803 822 int64_t duration;
76c56376 823
c10731e7 824#if FF_API_FILESIZE
76c56376
MN
825 /**
826 * decoding: total file size, 0 if unknown
827 */
c10731e7
AK
828 attribute_deprecated int64_t file_size;
829#endif
76c56376
MN
830
831 /**
832 * Decoding: total stream bitrate in bit/s, 0 if not
833 * available. Never set it directly if the file_size and the
6001dad6 834 * duration are known as Libav can compute it automatically.
76c56376 835 */
ee404803 836 int bit_rate;
fb2758c8 837
df968050 838#if FF_API_REORDER_PRIVATE
fb2758c8
FB
839 /* av_read_frame() support */
840 AVStream *cur_st;
fb2758c8 841
fb2758c8 842 /* av_seek_frame() support */
ec906fcd 843 int64_t data_offset; /**< offset of the first packet */
df968050 844#endif
115329f1 845
5a9ee315
AK
846#if FF_API_MUXRATE
847 /**
848 * use mpeg muxer private options instead
849 */
850 attribute_deprecated int mux_rate;
851#endif
92400be2 852 unsigned int packet_size;
f172132f
AK
853#if FF_API_PRELOAD
854 attribute_deprecated int preload;
855#endif
17c88cb0 856 int max_delay;
8108551a 857
d31e3f7c 858#if FF_API_LOOP_OUTPUT
115329f1
DB
859#define AVFMT_NOOUTPUTLOOP -1
860#define AVFMT_INFINITEOUTPUTLOOP 0
76c56376
MN
861 /**
862 * number of times to loop output in formats that support it
d31e3f7c
AK
863 *
864 * @deprecated use the 'loop' private option in the gif muxer.
76c56376 865 */
d31e3f7c
AK
866 attribute_deprecated int loop_output;
867#endif
115329f1 868
30bc6613 869 int flags;
22e77e44 870#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
871#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
872#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 873#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
874#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
875#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
876#if FF_API_FLAG_RTP_HINT
877#define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
878#endif
05e84c95 879#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
73e8e8db 880#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
5894e1bb 881
6002fdef
AK
882#if FF_API_LOOP_INPUT
883 /**
884 * @deprecated, use the 'loop' img2 demuxer private option.
885 */
886 attribute_deprecated int loop_input;
887#endif
76c56376
MN
888
889 /**
890 * decoding: size of data to probe; encoding: unused.
891 */
9e6c9470 892 unsigned int probesize;
a44b3c4d
MN
893
894 /**
83daced0
AK
895 * decoding: maximum time (in AV_TIME_BASE units) during which the input should
896 * be analyzed in avformat_find_stream_info().
a44b3c4d
MN
897 */
898 int max_analyze_duration;
c964c2c7
RD
899
900 const uint8_t *key;
901 int keylen;
15afa396
NS
902
903 unsigned int nb_programs;
904 AVProgram **programs;
62600469
MN
905
906 /**
907 * Forced video codec_id.
4f57fa8c 908 * Demuxing: Set by user.
62600469
MN
909 */
910 enum CodecID video_codec_id;
76c56376 911
62600469
MN
912 /**
913 * Forced audio codec_id.
4f57fa8c 914 * Demuxing: Set by user.
62600469
MN
915 */
916 enum CodecID audio_codec_id;
76c56376 917
62600469
MN
918 /**
919 * Forced subtitle codec_id.
4f57fa8c 920 * Demuxing: Set by user.
62600469
MN
921 */
922 enum CodecID subtitle_codec_id;
3dea63bd
PK
923
924 /**
22e77e44
DB
925 * Maximum amount of memory in bytes to use for the index of each stream.
926 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
927 * needed to maintain a smaller size. This can lead to slower or less
928 * accurate seeking (depends on demuxer).
4f57fa8c 929 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
930 * this.
931 * muxing : unused
932 * demuxing: set by user
933 */
934 unsigned int max_index_size;
ab8ab30c
RP
935
936 /**
ffa71b2b 937 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 938 * obtained from realtime capture devices.
ab8ab30c
RP
939 */
940 unsigned int max_picture_buffer;
79d7836a 941
fbabf1e9 942 unsigned int nb_chapters;
79d7836a 943 AVChapter **chapters;
45b2b05f
MN
944
945 /**
4f57fa8c 946 * Flags to enable debugging.
45b2b05f
MN
947 */
948 int debug;
949#define FF_FDEBUG_TS 0x0001
0bef08e5 950
df968050 951#if FF_API_REORDER_PRIVATE
0bef08e5 952 /**
4f57fa8c 953 * Raw packets from the demuxer, prior to parsing and decoding.
0bef08e5
MN
954 * This buffer is used for buffering packets until the codec can
955 * be identified, as parsing cannot be done without knowing the
956 * codec.
957 */
958 struct AVPacketList *raw_packet_buffer;
5c5b1731
MR
959 struct AVPacketList *raw_packet_buffer_end;
960
961 struct AVPacketList *packet_buffer_end;
df968050 962#endif
47146dfb 963
d2d67e42 964 AVDictionary *metadata;
af122d6a 965
df968050 966#if FF_API_REORDER_PRIVATE
af122d6a
BC
967 /**
968 * Remaining size available for raw_packet_buffer, in bytes.
969 * NOT PART OF PUBLIC API
970 */
48616887 971#define RAW_PACKET_BUFFER_SIZE 2500000
af122d6a 972 int raw_packet_buffer_remaining_size;
df968050 973#endif
b8819c85
MS
974
975 /**
976 * Start time of the stream in real world time, in microseconds
977 * since the unix epoch (00:00 1st January 1970). That is, pts=0
978 * in the stream was captured at this real world time.
979 * - encoding: Set by user.
980 * - decoding: Unused.
981 */
982 int64_t start_time_realtime;
30315a8d
AC
983
984 /**
985 * decoding: number of frames used to probe fps
986 */
987 int fps_probe_size;
2f63440c
DB
988
989 /**
990 * Error recognition; higher values will detect more errors but may
991 * misdetect some more or less valid parts as errors.
992 * - encoding: unused
993 * - decoding: Set by user.
994 */
995 int error_recognition;
df968050 996
6aa0b98f
MS
997 /**
998 * Custom interrupt callbacks for the I/O layer.
999 *
1000 * decoding: set by the user before avformat_open_input().
1001 * encoding: set by the user before avformat_write_header()
1002 * (mainly useful for AVFMT_NOFILE formats). The callback
1003 * should also be passed to avio_open2() if it's used to
1004 * open the file.
1005 */
1006 AVIOInterruptCB interrupt_callback;
1007
df968050
AK
1008 /*****************************************************************
1009 * All fields below this line are not part of the public API. They
1010 * may not be used outside of libavformat and can be changed and
1011 * removed at will.
1012 * New public fields should be added right above.
1013 *****************************************************************
1014 */
1015#if !FF_API_REORDER_PRIVATE
1016 /**
1017 * Raw packets from the demuxer, prior to parsing and decoding.
1018 * This buffer is used for buffering packets until the codec can
1019 * be identified, as parsing cannot be done without knowing the
1020 * codec.
1021 */
1022 struct AVPacketList *raw_packet_buffer;
1023 struct AVPacketList *raw_packet_buffer_end;
1024 /**
1025 * Remaining size available for raw_packet_buffer, in bytes.
1026 */
1027#define RAW_PACKET_BUFFER_SIZE 2500000
1028 int raw_packet_buffer_remaining_size;
1029
1030 /**
1031 * This buffer is only needed when packets were already buffered but
1032 * not decoded, for example to get the codec parameters in MPEG
1033 * streams.
1034 */
1035 struct AVPacketList *packet_buffer;
1036 struct AVPacketList *packet_buffer_end;
1037
1038 /* av_read_frame() support */
1039 AVStream *cur_st;
1040
1041 /* av_seek_frame() support */
1042 int64_t data_offset; /**< offset of the first packet */
1043#endif
de6d9b64
FB
1044} AVFormatContext;
1045
1046typedef struct AVPacketList {
1047 AVPacket pkt;
1048 struct AVPacketList *next;
1049} AVPacketList;
1050
aeedac95
SS
1051/**
1052 * If f is NULL, returns the first registered input format,
22e77e44 1053 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
1054 * or NULL if f is the last one.
1055 */
84be6e72 1056AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
1057
1058/**
1059 * If f is NULL, returns the first registered output format,
22e77e44 1060 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
1061 * or NULL if f is the last one.
1062 */
84be6e72 1063AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 1064
a9bf9d8e
AK
1065#if FF_API_GUESS_IMG2_CODEC
1066attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
1067#endif
290c5fa6 1068
22e77e44
DB
1069/* XXX: Use automatic init with either ELF sections or C file parser */
1070/* modules. */
de6d9b64 1071
b9a281db 1072/* utils.c */
b9a281db
FB
1073void av_register_input_format(AVInputFormat *format);
1074void av_register_output_format(AVOutputFormat *format);
f48b0fa2
SS
1075
1076/**
49bd8e4b
MR
1077 * Return the output format in the list of registered output formats
1078 * which best matches the provided parameters, or return NULL if
f48b0fa2
SS
1079 * there is no match.
1080 *
1081 * @param short_name if non-NULL checks if short_name matches with the
1082 * names of the registered formats
1083 * @param filename if non-NULL checks if filename terminates with the
1084 * extensions of the registered formats
1085 * @param mime_type if non-NULL checks if mime_type matches with the
1086 * MIME type of the registered formats
1087 */
a1f547b9 1088AVOutputFormat *av_guess_format(const char *short_name,
94b1f338
SS
1089 const char *filename,
1090 const char *mime_type);
3217cb42
PI
1091
1092/**
49bd8e4b 1093 * Guess the codec ID based upon muxer and filename.
3217cb42 1094 */
115329f1 1095enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
78cb7273 1096 const char *filename, const char *mime_type,
72415b2a 1097 enum AVMediaType type);
de6d9b64 1098
3217cb42 1099/**
49bd8e4b 1100 * Send a nice hexadecimal dump of a buffer to the specified file stream.
750f0e1f
PI
1101 *
1102 * @param f The file stream pointer where the dump should be sent to.
3217cb42
PI
1103 * @param buf buffer
1104 * @param size buffer size
750f0e1f 1105 *
863c4716 1106 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
3217cb42 1107 */
fb2758c8 1108void av_hex_dump(FILE *f, uint8_t *buf, int size);
3217cb42
PI
1109
1110/**
49bd8e4b 1111 * Send a nice hexadecimal dump of a buffer to the log.
750f0e1f
PI
1112 *
1113 * @param avcl A pointer to an arbitrary struct of which the first field is a
1114 * pointer to an AVClass struct.
1115 * @param level The importance level of the message, lower values signifying
1116 * higher importance.
1117 * @param buf buffer
1118 * @param size buffer size
1119 *
863c4716 1120 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
750f0e1f
PI
1121 */
1122void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1123
1124/**
49bd8e4b 1125 * Send a nice dump of a packet to the specified file stream.
750f0e1f
PI
1126 *
1127 * @param f The file stream pointer where the dump should be sent to.
3217cb42 1128 * @param pkt packet to dump
4f57fa8c 1129 * @param dump_payload True if the payload must be displayed, too.
863c4716 1130 * @param st AVStream that the packet belongs to
3217cb42 1131 */
863c4716
MS
1132void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1133
de6d9b64 1134
750f0e1f 1135/**
49bd8e4b 1136 * Send a nice dump of a packet to the log.
750f0e1f
PI
1137 *
1138 * @param avcl A pointer to an arbitrary struct of which the first field is a
1139 * pointer to an AVClass struct.
1140 * @param level The importance level of the message, lower values signifying
1141 * higher importance.
1142 * @param pkt packet to dump
4f57fa8c 1143 * @param dump_payload True if the payload must be displayed, too.
863c4716 1144 * @param st AVStream that the packet belongs to
750f0e1f 1145 */
863c4716
MS
1146void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1147 AVStream *st);
1148
c5704b2b
AK
1149#if FF_API_PKT_DUMP
1150attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
863c4716
MS
1151attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1152 int dump_payload);
17ca374c 1153#endif
750f0e1f 1154
4815e246 1155/**
49bd8e4b 1156 * Initialize libavformat and register all the muxers, demuxers and
4815e246
SS
1157 * protocols. If you do not call this function, then you can select
1158 * exactly which formats you want to support.
1159 *
1160 * @see av_register_input_format()
1161 * @see av_register_output_format()
5d377501 1162 * @see av_register_protocol()
4815e246 1163 */
94988531 1164void av_register_all(void);
de6d9b64 1165
7693b93e 1166/**
49bd8e4b 1167 * Get the CodecID for the given codec tag tag.
7693b93e
SS
1168 * If no codec id is found returns CODEC_ID_NONE.
1169 *
1170 * @param tags list of supported codec_id-codec_tag pairs, as stored
1171 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1172 */
15545a09 1173enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
7693b93e
SS
1174
1175/**
49bd8e4b 1176 * Get the codec tag for the given codec id id.
7693b93e
SS
1177 * If no codec tag is found returns 0.
1178 *
1179 * @param tags list of supported codec_id-codec_tag pairs, as stored
1180 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1181 */
15545a09 1182unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
7caf0cc6 1183
b9a281db 1184/* media file input */
3217cb42
PI
1185
1186/**
49bd8e4b 1187 * Find AVInputFormat based on the short name of the input format.
3217cb42 1188 */
b9a281db 1189AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1190
1191/**
49bd8e4b 1192 * Guess the file format.
3217cb42 1193 *
4f57fa8c
DB
1194 * @param is_opened Whether the file is already opened; determines whether
1195 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1196 */
94988531 1197AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1198
1199/**
49bd8e4b 1200 * Guess the file format.
8e2ee182
RD
1201 *
1202 * @param is_opened Whether the file is already opened; determines whether
1203 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1204 * @param score_max A probe score larger that this is required to accept a
1205 * detection, the variable is set to the actual detection
1206 * score afterwards.
1207 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1208 * to retry with a larger probe buffer.
1209 */
1210AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1211
1212/**
3940caad
AH
1213 * Probe a bytestream to determine the input format. Each time a probe returns
1214 * with a score that is too low, the probe buffer size is increased and another
1215 * attempt is made. When the maximum probe size is reached, the input format
1216 * with the highest score is returned.
1217 *
1218 * @param pb the bytestream to probe
1219 * @param fmt the input format is put here
1220 * @param filename the filename of the stream
1221 * @param logctx the log context
1222 * @param offset the offset within the bytestream to probe from
1223 * @param max_probe_size the maximum probe buffer size (zero for default)
1224 * @return 0 in case of success, a negative value corresponding to an
1225 * AVERROR code otherwise
1226 */
ae628ec1 1227int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1228 const char *filename, void *logctx,
1229 unsigned int offset, unsigned int max_probe_size);
1230
603b8bc2 1231#if FF_API_FORMAT_PARAMETERS
3940caad 1232/**
49bd8e4b 1233 * Allocate all the structures needed to read an input stream.
3217cb42 1234 * This does not open the needed codecs for decoding the stream[s].
603b8bc2 1235 * @deprecated use avformat_open_input instead.
3217cb42 1236 */
603b8bc2 1237attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
ae628ec1 1238 AVIOContext *pb, const char *filename,
da24c5e3 1239 AVInputFormat *fmt, AVFormatParameters *ap);
3217cb42
PI
1240
1241/**
49bd8e4b 1242 * Open a media file as input. The codecs are not opened. Only the file
3217cb42
PI
1243 * header (if present) is read.
1244 *
4f57fa8c
DB
1245 * @param ic_ptr The opened media file handle is put here.
1246 * @param filename filename to open
1247 * @param fmt If non-NULL, force the file format to use.
3217cb42 1248 * @param buf_size optional buffer size (zero if default is OK)
78cb7273
DB
1249 * @param ap Additional parameters needed when opening the file
1250 * (NULL if default).
4f57fa8c 1251 * @return 0 if OK, AVERROR_xxx otherwise
603b8bc2
AK
1252 *
1253 * @deprecated use avformat_open_input instead.
3217cb42 1254 */
603b8bc2 1255attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
b9a281db
FB
1256 AVInputFormat *fmt,
1257 int buf_size,
1258 AVFormatParameters *ap);
603b8bc2 1259#endif
88a28965 1260
88808c60 1261/**
05e84c95
AK
1262 * Open an input stream and read the header. The codecs are not opened.
1263 * The stream must be closed with av_close_input_file().
1264 *
1265 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1266 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1267 * function and written into ps.
1268 * Note that a user-supplied AVFormatContext will be freed on failure.
1269 * @param filename Name of the stream to open.
1270 * @param fmt If non-NULL, this parameter forces a specific input format.
1271 * Otherwise the format is autodetected.
1272 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1273 * On return this parameter will be destroyed and replaced with a dict containing
1274 * options that were not found. May be NULL.
1275 *
1276 * @return 0 on success, a negative AVERROR on failure.
1277 *
1278 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1279 */
1280int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1281
1282/**
49bd8e4b 1283 * Allocate an AVFormatContext.
f124b087
MS
1284 * avformat_free_context() can be used to free the context and everything
1285 * allocated by the framework within it.
88808c60 1286 */
88a28965 1287AVFormatContext *avformat_alloc_context(void);
b9a281db 1288
a67c061e 1289#if FF_API_FORMAT_PARAMETERS
3217cb42 1290/**
49bd8e4b 1291 * Read packets of a media file to get stream information. This
3217cb42 1292 * is useful for file formats with no headers such as MPEG. This
22e77e44 1293 * function also computes the real framerate in case of MPEG-2 repeat
3217cb42
PI
1294 * frame mode.
1295 * The logical file position is not changed by this function;
1296 * examined packets may be buffered for later processing.
1297 *
1298 * @param ic media file handle
4f57fa8c
DB
1299 * @return >=0 if OK, AVERROR_xxx on error
1300 * @todo Let the user decide somehow what information is needed so that
1301 * we do not waste time getting stuff the user does not need.
a67c061e
AK
1302 *
1303 * @deprecated use avformat_find_stream_info.
3217cb42 1304 */
3c7fa664 1305attribute_deprecated
b9a281db 1306int av_find_stream_info(AVFormatContext *ic);
a67c061e
AK
1307#endif
1308
1309/**
1310 * Read packets of a media file to get stream information. This
1311 * is useful for file formats with no headers such as MPEG. This
1312 * function also computes the real framerate in case of MPEG-2 repeat
1313 * frame mode.
1314 * The logical file position is not changed by this function;
1315 * examined packets may be buffered for later processing.
1316 *
1317 * @param ic media file handle
1318 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1319 * dictionaries, where i-th member contains options for
1320 * codec corresponding to i-th stream.
1321 * On return each dictionary will be filled with options that were not found.
1322 * @return >=0 if OK, AVERROR_xxx on error
1323 *
1324 * @note this function isn't guaranteed to open all the codecs, so
1325 * options being non-empty at return is a perfectly normal behavior.
1326 *
1327 * @todo Let the user decide somehow what information is needed so that
1328 * we do not waste time getting stuff the user does not need.
1329 */
1330int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
3217cb42
PI
1331
1332/**
9128ae08
NG
1333 * Find the "best" stream in the file.
1334 * The best stream is determined according to various heuristics as the most
1335 * likely to be what the user expects.
1336 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1337 * default decoder for the stream's codec; streams for which no decoder can
1338 * be found are ignored.
1339 *
1340 * @param ic media file handle
1341 * @param type stream type: video, audio, subtitles, etc.
1342 * @param wanted_stream_nb user-requested stream number,
1343 * or -1 for automatic selection
1344 * @param related_stream try to find a stream related (eg. in the same
1345 * program) to this one, or -1 if none
1346 * @param decoder_ret if non-NULL, returns the decoder for the
1347 * selected stream
1348 * @param flags flags; none are currently defined
1349 * @return the non-negative stream number in case of success,
1350 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1351 * could be found,
1352 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1353 * @note If av_find_best_stream returns successfully and decoder_ret is not
1354 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1355 */
1356int av_find_best_stream(AVFormatContext *ic,
1357 enum AVMediaType type,
1358 int wanted_stream_nb,
1359 int related_stream,
1360 AVCodec **decoder_ret,
1361 int flags);
1362
1363/**
49bd8e4b 1364 * Read a transport packet from a media file.
3217cb42 1365 *
864ff8c1 1366 * This function is obsolete and should never be used.
3217cb42
PI
1367 * Use av_read_frame() instead.
1368 *
1369 * @param s media file handle
1370 * @param pkt is filled
4f57fa8c 1371 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1372 */
de6d9b64 1373int av_read_packet(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1374
1375/**
49bd8e4b 1376 * Return the next frame of a stream.
4faf628f
MN
1377 * This function returns what is stored in the file, and does not validate
1378 * that what is there are valid frames for the decoder. It will split what is
1379 * stored in the file into frames and return one for each call. It will not
1380 * omit invalid data between valid frames so as to give the decoder the maximum
1381 * information possible for decoding.
3217cb42
PI
1382 *
1383 * The returned packet is valid
1384 * until the next av_read_frame() or until av_close_input_file() and
1385 * must be freed with av_free_packet. For video, the packet contains
1386 * exactly one frame. For audio, it contains an integer number of
1387 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1388 * data). If the audio frames have a variable size (e.g. MPEG audio),
1389 * then it contains one frame.
1390 *
1391 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1392 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1393 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1394 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1395 * decompress the payload.
1396 *
4f57fa8c 1397 * @return 0 if OK, < 0 on error or end of file
3217cb42 1398 */
fb2758c8 1399int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1400
1401/**
49bd8e4b 1402 * Seek to the keyframe at timestamp.
3217cb42
PI
1403 * 'timestamp' in 'stream_index'.
1404 * @param stream_index If stream_index is (-1), a default
1405 * stream is selected, and timestamp is automatically converted
1406 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1407 * @param timestamp Timestamp in AVStream.time_base units
1408 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1409 * @param flags flags which select direction and seeking mode
1410 * @return >= 0 on success
1411 */
78cb7273
DB
1412int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1413 int flags);
3217cb42
PI
1414
1415/**
49bd8e4b 1416 * Seek to timestamp ts.
d04768fa
MN
1417 * Seeking will be done so that the point from which all active streams
1418 * can be presented successfully will be closest to ts and within min/max_ts.
1419 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1420 *
22e77e44 1421 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1422 * are the file position (this may not be supported by all demuxers).
22e77e44 1423 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1424 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1425 * Otherwise all timestamps are in units of the stream selected by stream_index
1426 * or if stream_index is -1, in AV_TIME_BASE units.
1427 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1428 * keyframes (this may not be supported by all demuxers).
1429 *
22e77e44 1430 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1431 * @param min_ts smallest acceptable timestamp
1432 * @param ts target timestamp
1433 * @param max_ts largest acceptable timestamp
1434 * @param flags flags
32e543f8 1435 * @return >=0 on success, error code otherwise
998b6f7c 1436 *
8a4d7a30 1437 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1438 * Thus do not use this yet. It may change at any time, do not expect
1439 * ABI compatibility yet!
d04768fa
MN
1440 */
1441int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1442
1443/**
49bd8e4b 1444 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1445 * current position.
3217cb42 1446 */
fb2758c8 1447int av_read_play(AVFormatContext *s);
3217cb42
PI
1448
1449/**
49bd8e4b 1450 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1451 *
1452 * Use av_read_play() to resume it.
1453 */
fb2758c8 1454int av_read_pause(AVFormatContext *s);
3217cb42
PI
1455
1456/**
49bd8e4b 1457 * Free a AVFormatContext allocated by av_open_input_stream.
2506fd54
RD
1458 * @param s context to free
1459 */
1460void av_close_input_stream(AVFormatContext *s);
1461
1462/**
49bd8e4b 1463 * Close a media file (but not its codecs).
3217cb42
PI
1464 *
1465 * @param s media file handle
1466 */
de6d9b64 1467void av_close_input_file(AVFormatContext *s);
3217cb42
PI
1468
1469/**
f124b087
MS
1470 * Free an AVFormatContext and all its streams.
1471 * @param s context to free
1472 */
1473void avformat_free_context(AVFormatContext *s);
1474
569129a6 1475#if FF_API_NEW_STREAM
f124b087 1476/**
49bd8e4b 1477 * Add a new stream to a media file.
3217cb42
PI
1478 *
1479 * Can only be called in the read_header() function. If the flag
1480 * AVFMTCTX_NOHEADER is in the format context, then new streams
1481 * can be added in read_packet too.
1482 *
1483 * @param s media file handle
4f57fa8c 1484 * @param id file-format-dependent stream ID
3217cb42 1485 */
569129a6 1486attribute_deprecated
b9a281db 1487AVStream *av_new_stream(AVFormatContext *s, int id);
569129a6
AK
1488#endif
1489
1490/**
1491 * Add a new stream to a media file.
1492 *
1493 * When demuxing, it is called by the demuxer in read_header(). If the
1494 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1495 * be called in read_packet().
1496 *
1497 * When muxing, should be called by the user before avformat_write_header().
1498 *
1499 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1500 * will be initialized to use this codec. This is needed for e.g. codec-specific
1501 * defaults to be set, so codec should be provided if it is known.
1502 *
1503 * @return newly created stream or NULL on error.
1504 */
1505AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1506
15afa396 1507AVProgram *av_new_program(AVFormatContext *s, int id);
3217cb42
PI
1508
1509/**
b3190529
RD
1510 * Set the pts for a given stream. If the new values would be invalid
1511 * (<= 0), it leaves the AVStream unchanged.
3217cb42
PI
1512 *
1513 * @param s stream
1514 * @param pts_wrap_bits number of bits effectively used by the pts
1515 * (used for wrap control, 33 is the value for MPEG)
1516 * @param pts_num numerator to convert to seconds (MPEG: 1)
1517 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1518 */
9ee91c2f 1519void av_set_pts_info(AVStream *s, int pts_wrap_bits,
dec14949 1520 unsigned int pts_num, unsigned int pts_den);
de6d9b64 1521
3ba1438d
MN
1522#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1523#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1524#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1525#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1526
b754978a 1527int av_find_default_stream_index(AVFormatContext *s);
3217cb42
PI
1528
1529/**
49bd8e4b 1530 * Get the index for a specific timestamp.
4f57fa8c
DB
1531 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1532 * to the timestamp which is <= the requested one, if backward
1533 * is 0, then it will be >=
3217cb42
PI
1534 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1535 * @return < 0 if no such timestamp could be found
1536 */
dc56fc38 1537int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3217cb42
PI
1538
1539/**
49bd8e4b 1540 * Add an index entry into a sorted list. Update the entry if the list
4f57fa8c 1541 * already contains it.
3217cb42 1542 *
4f57fa8c 1543 * @param timestamp timestamp in the time base of the given stream
3217cb42 1544 */
78cb7273
DB
1545int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1546 int size, int distance, int flags);
3217cb42 1547
a2faa951
AK
1548#if FF_API_SEEK_PUBLIC
1549attribute_deprecated
78cb7273
DB
1550int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1551 int64_t target_ts, int flags);
a2faa951 1552attribute_deprecated
22ffac70 1553void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
a2faa951 1554attribute_deprecated
78cb7273
DB
1555int64_t av_gen_search(AVFormatContext *s, int stream_index,
1556 int64_t target_ts, int64_t pos_min,
1557 int64_t pos_max, int64_t pos_limit,
1558 int64_t ts_min, int64_t ts_max,
1559 int flags, int64_t *ts_ret,
1560 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
a2faa951 1561#endif
b754978a 1562
76c56376
MN
1563/**
1564 * media file output
1565 */
25de5958
AK
1566#if FF_API_FORMAT_PARAMETERS
1567/**
1568 * @deprecated pass the options to avformat_write_header directly.
1569 */
1570attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1571#endif
3217cb42
PI
1572
1573/**
f3bfe388
MR
1574 * Split a URL string into components.
1575 *
1576 * The pointers to buffers for storing individual components may be null,
1577 * in order to ignore that component. Buffers for components not found are
1578 * set to empty strings. If the port is not found, it is set to a negative
1579 * value.
1580 *
1581 * @param proto the buffer for the protocol
1582 * @param proto_size the size of the proto buffer
1583 * @param authorization the buffer for the authorization
1584 * @param authorization_size the size of the authorization buffer
1585 * @param hostname the buffer for the host name
1586 * @param hostname_size the size of the hostname buffer
1587 * @param port_ptr a pointer to store the port number in
1588 * @param path the buffer for the path
1589 * @param path_size the size of the path buffer
1590 * @param url the URL to split
1591 */
1592void av_url_split(char *proto, int proto_size,
1593 char *authorization, int authorization_size,
1594 char *hostname, int hostname_size,
1595 int *port_ptr,
1596 char *path, int path_size,
1597 const char *url);
1598
1599/**
25de5958
AK
1600 * Allocate the stream private data and write the stream header to
1601 * an output media file.
1602 *
1603 * @param s Media file handle, must be allocated with avformat_alloc_context().
1604 * Its oformat field must be set to the desired output format;
1605 * Its pb field must be set to an already openened AVIOContext.
1606 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1607 * On return this parameter will be destroyed and replaced with a dict containing
1608 * options that were not found. May be NULL.
1609 *
1610 * @return 0 on success, negative AVERROR on failure.
1611 *
1612 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1613 */
1614int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1615
1616#if FF_API_FORMAT_PARAMETERS
1617/**
49bd8e4b 1618 * Allocate the stream private data and write the stream header to an
755bfeab 1619 * output media file.
5d820db2
RD
1620 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1621 * but for some formats it might also be some other time base
3217cb42
PI
1622 *
1623 * @param s media file handle
4f57fa8c 1624 * @return 0 if OK, AVERROR_xxx on error
25de5958
AK
1625 *
1626 * @deprecated use avformat_write_header.
3217cb42 1627 */
25de5958
AK
1628attribute_deprecated int av_write_header(AVFormatContext *s);
1629#endif
3217cb42
PI
1630
1631/**
49bd8e4b 1632 * Write a packet to an output media file.
3217cb42
PI
1633 *
1634 * The packet shall contain one audio or video frame.
78cb7273
DB
1635 * The packet must be correctly interleaved according to the container
1636 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1637 *
1638 * @param s media file handle
78cb7273
DB
1639 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1640 dts/pts, ...
4f57fa8c 1641 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1642 */
e928649b 1643int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1644
1645/**
49bd8e4b 1646 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1647 *
1648 * The packet must contain one audio or video frame.
22e77e44 1649 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1650 * call av_write_frame() instead as it is slightly faster. It is also important
1651 * to keep in mind that completely non-interleaved input will need huge amounts
1652 * of memory to interleave with this, so it is preferable to interleave at the
1653 * demuxer level.
3217cb42
PI
1654 *
1655 * @param s media file handle
78cb7273
DB
1656 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1657 dts/pts, ...
4f57fa8c 1658 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
3217cb42 1659 */
3c895fc0 1660int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1661
1662/**
49bd8e4b 1663 * Interleave a packet per dts in an output media file.
3217cb42 1664 *
78cb7273 1665 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
22e77e44 1666 * function, so they cannot be used after it. Note that calling av_free_packet()
78cb7273 1667 * on them is still safe.
3217cb42
PI
1668 *
1669 * @param s media file handle
1670 * @param out the interleaved packet will be output here
9a58234f 1671 * @param pkt the input packet
3217cb42
PI
1672 * @param flush 1 if no further packets are available as input and all
1673 * remaining packets should be output
1674 * @return 1 if a packet was output, 0 if no packet could be output,
d9526386 1675 * < 0 if an error occurred
3217cb42 1676 */
78cb7273
DB
1677int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1678 AVPacket *pkt, int flush);
e928649b 1679
3217cb42 1680/**
49bd8e4b 1681 * Write the stream trailer to an output media file and free the
2b75bde6 1682 * file private data.
3217cb42 1683 *
dc76fe13
RD
1684 * May only be called after a successful call to av_write_header.
1685 *
3217cb42 1686 * @param s media file handle
4f57fa8c 1687 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1688 */
b9a281db 1689int av_write_trailer(AVFormatContext *s);
de6d9b64 1690
610219a5
AK
1691#if FF_API_DUMP_FORMAT
1692attribute_deprecated void dump_format(AVFormatContext *ic,
1693 int index,
1694 const char *url,
1695 int is_output);
1696#endif
1697
1698void av_dump_format(AVFormatContext *ic,
1699 int index,
1700 const char *url,
1701 int is_output);
3217cb42 1702
f6c7375a 1703#if FF_API_PARSE_DATE
3217cb42 1704/**
49bd8e4b 1705 * Parse datestr and return a corresponding number of microseconds.
f6c7375a 1706 *
f9436161 1707 * @param datestr String representing a date or a duration.
f6c7375a
SS
1708 * See av_parse_time() for the syntax of the provided string.
1709 * @deprecated in favor of av_parse_time()
3217cb42 1710 */
f6c7375a 1711attribute_deprecated
0c1a9eda 1712int64_t parse_date(const char *datestr, int duration);
f6c7375a 1713#endif
de6d9b64 1714
76c56376
MN
1715/**
1716 * Get the current time in microseconds.
1717 */
0c1a9eda 1718int64_t av_gettime(void);
94988531 1719
ab0287fc 1720#if FF_API_FIND_INFO_TAG
3217cb42 1721/**
ab0287fc 1722 * @deprecated use av_find_info_tag in libavutil instead.
3217cb42 1723 */
ab0287fc
AK
1724attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1725#endif
de6d9b64 1726
3217cb42 1727/**
49bd8e4b 1728 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1729 *
3217cb42
PI
1730 * Also handles the '%0nd' format where 'n' is the total number
1731 * of digits and '%%'.
1732 *
1733 * @param buf destination buffer
1734 * @param buf_size destination buffer size
1735 * @param path numbered sequence string
8ea0e802 1736 * @param number frame number
4f57fa8c 1737 * @return 0 if OK, -1 on format error
3217cb42 1738 */
5c07cf53
MB
1739int av_get_frame_filename(char *buf, int buf_size,
1740 const char *path, int number);
3217cb42
PI
1741
1742/**
49bd8e4b 1743 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1744 *
1745 * @param filename possible numbered sequence string
4f57fa8c 1746 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1747 */
5c07cf53 1748int av_filename_number_test(const char *filename);
96baaa6a 1749
c5388c07 1750/**
49bd8e4b 1751 * Generate an SDP for an RTP session.
c5388c07
LA
1752 *
1753 * @param ac array of AVFormatContexts describing the RTP streams. If the
1754 * array is composed by only one context, such context can contain
1755 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1756 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1757 * must contain only one AVStream.
8767b80f 1758 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1759 * @param buf buffer where the SDP will be stored (must be allocated by
1760 * the caller)
8767b80f 1761 * @param size the size of the buffer
4f57fa8c 1762 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1763 */
c234d40b 1764int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe
AK
1765
1766#if FF_API_SDP_CREATE
1767attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1768#endif
c5388c07 1769
1a70d127 1770/**
49bd8e4b 1771 * Return a positive value if the given filename has one of the given
1a70d127
SS
1772 * extensions, 0 otherwise.
1773 *
1774 * @param extensions a comma-separated list of filename extensions
1775 */
1776int av_match_ext(const char *filename, const char *extensions);
1777
48f9e457
AK
1778/**
1779 * Test if the given container can store a codec.
1780 *
1781 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1782 *
1783 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1784 * A negative number if this information is not available.
1785 */
1786int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1787
fb4ca26b
AK
1788/**
1789 * Get the AVClass for AVFormatContext. It can be used in combination with
1790 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1791 *
1792 * @see av_opt_find().
1793 */
1794const AVClass *avformat_get_class(void);
1795
b6d08f40
MS
1796/**
1797 * Do global initialization of network components. This is optional,
1798 * but recommended, since it avoids the overhead of implicitly
1799 * doing the setup for each session.
1800 *
87892ef8
MS
1801 * Calling this function will become mandatory if using network
1802 * protocols at some major version bump.
b6d08f40
MS
1803 */
1804int avformat_network_init(void);
1805
1806/**
1807 * Undo the initialization done by avformat_network_init.
1808 */
1809int avformat_network_deinit(void);
1810
98790382 1811#endif /* AVFORMAT_AVFORMAT_H */