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