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