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