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