avplay: add support for seeking to chapter marks
[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 *
10fa4ff7
AK
69 * @section lavf_options Passing options to (de)muxers
70 * Lavf allows to configure muxers and demuxers using the @ref avoptions
71 * mechanism. Generic (format-independent) libavformat options are provided by
72 * AVFormatContext, they can be examined from a user program by calling
73 * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass
74 * from avformat_get_class()). Private (format-specific) options are provided by
75 * AVFormatContext.priv_data if and only if AVInputFormat.priv_class /
76 * AVOutputFormat.priv_class of the corresponding format struct is non-NULL.
77 * Further options may be provided by the @ref AVFormatContext.pb "I/O context",
78 * if its AVClass is non-NULL, and the protocols layer. See the discussion on
79 * nesting in @ref avoptions documentation to learn how to access those.
80 *
e361b508
LB
81 * @defgroup lavf_decoding Demuxing
82 * @{
59826cab 83 * Demuxers read a media file and split it into chunks of data (@em packets). A
dca9c81d
AK
84 * @ref AVPacket "packet" contains one or more encoded frames which belongs to a
85 * single elementary stream. In the lavf API this process is represented by the
59826cab
AK
86 * avformat_open_input() function for opening a file, av_read_frame() for
87 * reading a single packet and finally avformat_close_input(), which does the
88 * cleanup.
89 *
90 * @section lavf_decoding_open Opening a media file
91 * The minimum information required to open a file is its URL or filename, which
92 * is passed to avformat_open_input(), as in the following code:
93 * @code
94 * const char *url = "in.mp3";
95 * AVFormatContext *s = NULL;
96 * int ret = avformat_open_input(&s, url, NULL, NULL);
97 * if (ret < 0)
98 * abort();
99 * @endcode
100 * The above code attempts to allocate an AVFormatContext, open the
101 * specified file (autodetecting the format) and read the header, exporting the
102 * information stored there into s. Some formats do not have a header or do not
103 * store enough information there, so it is recommended that you call the
104 * avformat_find_stream_info() function which tries to read and decode a few
105 * frames to find missing information.
106 *
107 * In some cases you might want to preallocate an AVFormatContext yourself with
108 * avformat_alloc_context() and do some tweaking on it before passing it to
109 * avformat_open_input(). One such case is when you want to use custom functions
110 * for reading input data instead of lavf internal I/O layer.
111 * To do that, create your own AVIOContext with avio_alloc_context(), passing
112 * your reading callbacks to it. Then set the @em pb field of your
113 * AVFormatContext to newly created AVIOContext.
114 *
10fa4ff7
AK
115 * Since the format of the opened file is in general not known until after
116 * avformat_open_input() has returned, it is not possible to set demuxer private
117 * options on a preallocated context. Instead, the options should be passed to
118 * avformat_open_input() wrapped in an AVDictionary:
119 * @code
120 * AVDictionary *options = NULL;
121 * av_dict_set(&options, "video_size", "640x480", 0);
122 * av_dict_set(&options, "pixel_format", "rgb24", 0);
123 *
124 * if (avformat_open_input(&s, url, NULL, &options) < 0)
125 * abort();
126 * av_dict_free(&options);
127 * @endcode
128 * This code passes the private options 'video_size' and 'pixel_format' to the
129 * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it
130 * cannot know how to interpret raw video data otherwise. If the format turns
131 * out to be something different than raw video, those options will not be
132 * recognized by the demuxer and therefore will not be applied. Such unrecognized
133 * options are then returned in the options dictionary (recognized options are
134 * consumed). The calling program can handle such unrecognized options as it
135 * wishes, e.g.
136 * @code
137 * AVDictionaryEntry *e;
138 * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) {
139 * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key);
140 * abort();
141 * }
142 * @endcode
143 *
59826cab
AK
144 * After you have finished reading the file, you must close it with
145 * avformat_close_input(). It will free everything associated with the file.
146 *
147 * @section lavf_decoding_read Reading from an opened file
f58b8cc3
AK
148 * Reading data from an opened AVFormatContext is done by repeatedly calling
149 * av_read_frame() on it. Each call, if successful, will return an AVPacket
150 * containing encoded data for one AVStream, identified by
151 * AVPacket.stream_index. This packet may be passed straight into the libavcodec
152 * decoding functions avcodec_decode_video2(), avcodec_decode_audio4() or
153 * avcodec_decode_subtitle2() if the caller wishes to decode the data.
154 *
155 * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be
156 * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for
157 * pts/dts, 0 for duration) if the stream does not provide them. The timing
158 * information will be in AVStream.time_base units, i.e. it has to be
159 * multiplied by the timebase to convert them to seconds.
160 *
1afddbe5 161 * If AVPacket.buf is set on the returned packet, then the packet is
717a4509 162 * allocated dynamically and the user may keep it indefinitely.
1afddbe5 163 * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a
717a4509
AK
164 * static storage somewhere inside the demuxer and the packet is only valid
165 * until the next av_read_frame() call or closing the file. If the caller
166 * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy
167 * of it.
168 * In both cases, the packet must be freed with av_free_packet() when it is no
169 * longer needed.
59826cab
AK
170 *
171 * @section lavf_decoding_seek Seeking
e361b508
LB
172 * @}
173 *
174 * @defgroup lavf_encoding Muxing
175 * @{
176 * @}
177 *
e4f4a1f9 178 * @defgroup lavf_io I/O Read/Write
e361b508
LB
179 * @{
180 * @}
181 *
182 * @defgroup lavf_codec Demuxers
183 * @{
184 * @defgroup lavf_codec_native Native Demuxers
185 * @{
186 * @}
187 * @defgroup lavf_codec_wrappers External library wrappers
188 * @{
189 * @}
190 * @}
191 * @defgroup lavf_protos I/O Protocols
192 * @{
193 * @}
194 * @defgroup lavf_internal Internal
195 * @{
196 * @}
197 * @}
198 *
199 */
072e3efd 200
f71869a4 201#include <time.h>
67070e4f 202#include <stdio.h> /* FILE */
76a448ed 203#include "libavcodec/avcodec.h"
d9f80ea2 204#include "libavutil/dict.h"
abc78a5a 205#include "libavutil/log.h"
de6d9b64 206
de6d9b64 207#include "avio.h"
50196a98 208#include "libavformat/version.h"
de6d9b64 209
f610a9f2
AJ
210struct AVFormatContext;
211
a6d18a0e 212
1a53a438
RT
213/**
214 * @defgroup metadata_api Public Metadata API
215 * @{
b262a059 216 * @ingroup libavf
ea29242c 217 * The metadata API allows libavformat to export metadata tags to a client
28b4c06b
AK
218 * application when demuxing. Conversely it allows a client application to
219 * set metadata when muxing.
220 *
221 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
222 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
223 * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
224 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
61648423 225 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
28b4c06b 226 *
ea29242c 227 * Important concepts to keep in mind:
1a53a438 228 * - Keys are unique; there can never be 2 tags with the same key. This is
ea29242c
MM
229 * also meant semantically, i.e., a demuxer should not knowingly produce
230 * several keys that are literally different but semantically identical.
231 * E.g., key=Author5, key=Author6. In this example, all authors must be
232 * placed in the same tag.
1a53a438 233 * - Metadata is flat, not hierarchical; there are no subtags. If you
ea29242c
MM
234 * want to store, e.g., the email address of the child of producer Alice
235 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
1a53a438 236 * - Several modifiers can be applied to the tag name. This is done by
ca76a119
AK
237 * appending a dash character ('-') and the modifier name in the order
238 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
1a53a438 239 * - language -- a tag whose value is localized for a particular language
ca76a119
AK
240 * is appended with the ISO 639-2/B 3-letter language code.
241 * For example: Author-ger=Michael, Author-eng=Mike
242 * The original/default language is in the unqualified "Author" tag.
243 * A demuxer should set a default if it sets any translated tag.
1a53a438 244 * - sorting -- a modified version of a tag that should be used for
ca76a119
AK
245 * sorting will have '-sort' appended. E.g. artist="The Beatles",
246 * artist-sort="Beatles, The".
247 *
1a53a438 248 * - Demuxers attempt to export metadata in a generic format, however tags
03700d39
AK
249 * with no generic equivalents are left as they are stored in the container.
250 * Follows a list of generic tag names:
ca76a119 251 *
1a53a438
RT
252 @verbatim
253 album -- name of the set this work belongs to
254 album_artist -- main creator of the set/album, if different from artist.
255 e.g. "Various Artists" for compilation albums.
256 artist -- main creator of the work
257 comment -- any additional description of the file.
258 composer -- who composed the work, if different from artist.
259 copyright -- name of copyright holder.
260 creation_time-- date when the file was created, preferably in ISO 8601.
261 date -- date when the work was created, preferably in ISO 8601.
262 disc -- number of a subset, e.g. disc in a multi-disc collection.
263 encoder -- name/settings of the software/hardware that produced the file.
264 encoded_by -- person/group who created the file.
265 filename -- original name of the file.
266 genre -- <self-evident>.
267 language -- main language in which the work is performed, preferably
268 in ISO 639-2 format. Multiple languages can be specified by
269 separating them with commas.
270 performer -- artist who performed the work, if different from artist.
271 E.g for "Also sprach Zarathustra", artist would be "Richard
272 Strauss" and performer "London Philharmonic Orchestra".
273 publisher -- name of the label/publisher.
274 service_name -- name of the service in broadcasting (channel name).
275 service_provider -- name of the service provider in broadcasting.
276 title -- name of the work.
277 track -- number of this work in the set, can be in form current/total.
278 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
279 @endverbatim
280 *
12489443
RT
281 * Look in the examples section for an application example how to use the Metadata API.
282 *
1a53a438 283 * @}
a6d18a0e
MN
284 */
285
de6d9b64
FB
286/* packet functions */
287
3217cb42
PI
288
289/**
49bd8e4b 290 * Allocate and read the payload of a packet and initialize its
d1b9adf2 291 * fields with default values.
3217cb42
PI
292 *
293 * @param pkt packet
4f57fa8c
DB
294 * @param size desired payload size
295 * @return >0 (read size) if OK, AVERROR_xxx otherwise
3217cb42 296 */
ae628ec1 297int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
3217cb42 298
de6d9b64 299
6bfc2683 300/**
fa8cc126
RD
301 * Read data and append it to the current content of the AVPacket.
302 * If pkt->size is 0 this is identical to av_get_packet.
6bfc2683
RD
303 * Note that this uses av_grow_packet and thus involves a realloc
304 * which is inefficient. Thus this function should only be used
305 * when there is no reasonable way to know (an upper bound of)
306 * the final size.
307 *
308 * @param pkt packet
309 * @param size amount of data to read
310 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
311 * will not be lost even if an error occurs.
312 */
ae628ec1 313int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
6bfc2683 314
de6d9b64 315/*************************************************/
916c80e9
FB
316/* fractional numbers for exact pts handling */
317
671adb17 318/**
4f57fa8c
DB
319 * The exact value of the fractional number is: 'val + num / den'.
320 * num is assumed to be 0 <= num < den.
4c08b2bd 321 */
916c80e9 322typedef struct AVFrac {
115329f1 323 int64_t val, num, den;
52e57500 324} AVFrac;
916c80e9 325
916c80e9 326/*************************************************/
b9a281db 327/* input/output formats */
de6d9b64 328
7caf0cc6
MN
329struct AVCodecTag;
330
76c56376
MN
331/**
332 * This structure contains the data a format has to probe a file.
333 */
b9a281db 334typedef struct AVProbeData {
5c91a675 335 const char *filename;
e5f58f81 336 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
337 int buf_size; /**< Size of buf except extra allocated bytes */
b9a281db
FB
338} AVProbeData;
339
e0f8be64
DB
340#define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension
341#define AVPROBE_SCORE_MAX 100 ///< maximum score
342
87e87886 343#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
de6d9b64 344
c68fafe0 345/// Demuxer will use avio_open, no opened file should be provided by the caller.
40d9c544 346#define AVFMT_NOFILE 0x0001
4f57fa8c
DB
347#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
348#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
349#define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
350 raw picture data. */
351#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
352#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
353#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
58ec7e00 354#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
25918212 355#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
ab5a0175 356#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
bb62d5c1 357#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
a5f88736
DB
358#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */
359#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */
b631fba9 360#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
f1caf01d 361#define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */
e9cef897
JZ
362#define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly
363 increasing timestamps, but they must
364 still be monotonic */
c2cb01d4
LB
365#define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative
366 timestamps. If not set the timestamp
367 will be shifted in av_write_frame and
368 av_interleaved_write_frame so they
369 start from 0. */
b9a281db 370
489a7b07
AK
371/**
372 * @addtogroup lavf_encoding
373 * @{
374 */
b9a281db 375typedef struct AVOutputFormat {
de6d9b64 376 const char *name;
bde15e74
SS
377 /**
378 * Descriptive name for the format, meant to be more human-readable
819174fa 379 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
380 * to define it.
381 */
de6d9b64
FB
382 const char *long_name;
383 const char *mime_type;
4f57fa8c 384 const char *extensions; /**< comma-separated filename extensions */
183eaa9a 385 /* output support */
36ef5369
AK
386 enum AVCodecID audio_codec; /**< default audio codec */
387 enum AVCodecID video_codec; /**< default video codec */
388 enum AVCodecID subtitle_codec; /**< default subtitle codec */
183eaa9a
AK
389 /**
390 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
391 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
e9cef897
JZ
392 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH,
393 * AVFMT_TS_NONSTRICT
183eaa9a
AK
394 */
395 int flags;
396
397 /**
398 * List of supported codec_id-codec_tag pairs, ordered by "better
36ef5369 399 * choice first". The arrays are all terminated by AV_CODEC_ID_NONE.
183eaa9a
AK
400 */
401 const struct AVCodecTag * const *codec_tag;
402
403
404 const AVClass *priv_class; ///< AVClass for the private context
405
406 /*****************************************************************
407 * No fields below this line are part of the public API. They
408 * may not be used outside of libavformat and can be changed and
409 * removed at will.
410 * New public fields should be added right above.
411 *****************************************************************
412 */
413 struct AVOutputFormat *next;
76c56376
MN
414 /**
415 * size of private data so that it can be allocated in the wrapper
416 */
b9a281db 417 int priv_data_size;
183eaa9a 418
de6d9b64 419 int (*write_header)(struct AVFormatContext *);
f1caf01d
MS
420 /**
421 * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags,
422 * pkt can be NULL in order to flush data buffered in the muxer.
423 * When flushing, return 0 if there still is more data to flush,
424 * or 1 if everything was flushed and there is no more buffered
425 * data.
426 */
e928649b 427 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 428 int (*write_trailer)(struct AVFormatContext *);
76c56376 429 /**
76c56376
MN
430 * Currently only used to set pixel format if not YUV420P.
431 */
78cb7273
DB
432 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
433 AVPacket *in, int flush);
48f9e457
AK
434 /**
435 * Test if the given codec can be stored in this container.
436 *
437 * @return 1 if the codec is supported, 0 if it is not.
438 * A negative number if unknown.
439 */
36ef5369 440 int (*query_codec)(enum AVCodecID id, int std_compliance);
b9a281db 441} AVOutputFormat;
489a7b07
AK
442/**
443 * @}
444 */
de6d9b64 445
370f27de
AK
446/**
447 * @addtogroup lavf_decoding
448 * @{
449 */
b9a281db 450typedef struct AVInputFormat {
76c56376
MN
451 /**
452 * A comma separated list of short names for the format. New names
ac3ccbc0
AC
453 * may be appended with a minor bump.
454 */
b9a281db 455 const char *name;
76c56376 456
bde15e74
SS
457 /**
458 * Descriptive name for the format, meant to be more human-readable
819174fa 459 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
bde15e74
SS
460 * to define it.
461 */
b9a281db 462 const char *long_name;
76c56376
MN
463
464 /**
183eaa9a
AK
465 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
466 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
467 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
468 */
469 int flags;
470
471 /**
472 * If extensions are defined, then no probe is done. You should
473 * usually not use extension format guessing because it is not
474 * reliable enough
475 */
476 const char *extensions;
477
478 const struct AVCodecTag * const *codec_tag;
479
480 const AVClass *priv_class; ///< AVClass for the private context
481
482 /*****************************************************************
483 * No fields below this line are part of the public API. They
484 * may not be used outside of libavformat and can be changed and
485 * removed at will.
486 * New public fields should be added right above.
487 *****************************************************************
488 */
489 struct AVInputFormat *next;
490
491 /**
f7fe41a0 492 * Raw demuxers store their codec ID here.
183eaa9a 493 */
f7fe41a0 494 int raw_codec_id;
183eaa9a
AK
495
496 /**
76c56376
MN
497 * Size of private data so that it can be allocated in the wrapper.
498 */
b9a281db 499 int priv_data_size;
76c56376 500
65d7d68b 501 /**
22e77e44 502 * Tell if a given file has a chance of being parsed as this format.
5d81d641
DB
503 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
504 * big so you do not have to check for that unless you need more.
65d7d68b 505 */
b9a281db 506 int (*read_probe)(AVProbeData *);
76c56376
MN
507
508 /**
509 * Read the format header and initialize the AVFormatContext
6b8b0fe2
LB
510 * structure. Return 0 if OK. Only used in raw format right
511 * now. 'avformat_new_stream' should be called to create new streams.
76c56376 512 */
6e9651d1 513 int (*read_header)(struct AVFormatContext *);
76c56376
MN
514
515 /**
516 * Read one packet and put it in 'pkt'. pts and flags are also
6b8b0fe2 517 * set. 'avformat_new_stream' can be called only if the flag
2899a28c
AJ
518 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
519 * background thread).
76c56376
MN
520 * @return 0 on success, < 0 on error.
521 * When returning an error, pkt must not have been allocated
522 * or must be freed before returning
523 */
de6d9b64 524 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
76c56376
MN
525
526 /**
527 * Close the stream. The AVFormatContext and AVStreams are not
528 * freed by this function
529 */
de6d9b64 530 int (*read_close)(struct AVFormatContext *);
1de2db8f 531
115329f1 532 /**
4f57fa8c
DB
533 * Seek to a given timestamp relative to the frames in
534 * stream component stream_index.
22e77e44
DB
535 * @param stream_index Must not be -1.
536 * @param flags Selects which direction should be preferred if no exact
537 * match is available.
05ce0f11 538 * @return >= 0 on success (but not necessarily the new offset)
3ba1438d 539 */
e5c70815
AK
540 int (*read_seek)(struct AVFormatContext *,
541 int stream_index, int64_t timestamp, int flags);
542
8d14a25c 543 /**
58c42af7 544 * Get the next timestamp in stream[stream_index].time_base units.
d9526386 545 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
8d14a25c
MN
546 */
547 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
548 int64_t *pos, int64_t pos_limit);
76c56376
MN
549
550 /**
76c56376
MN
551 * Start/resume playing - only meaningful if using a network-based format
552 * (RTSP).
553 */
fb2758c8
FB
554 int (*read_play)(struct AVFormatContext *);
555
76c56376
MN
556 /**
557 * Pause playing - only meaningful if using a network-based format
558 * (RTSP).
559 */
fb2758c8
FB
560 int (*read_pause)(struct AVFormatContext *);
561
1de2db8f 562 /**
49bd8e4b 563 * Seek to timestamp ts.
1de2db8f
MN
564 * Seeking will be done so that the point from which all active streams
565 * can be presented successfully will be closest to ts and within min/max_ts.
566 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
567 */
882fb0a3 568 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
b9a281db 569} AVInputFormat;
370f27de
AK
570/**
571 * @}
572 */
de6d9b64 573
57004ff1
AJ
574enum AVStreamParseType {
575 AVSTREAM_PARSE_NONE,
576 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
4f57fa8c 577 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
78cb7273 578 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
74a6df59 579 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
57004ff1
AJ
580};
581
fb2758c8
FB
582typedef struct AVIndexEntry {
583 int64_t pos;
584 int64_t timestamp;
585#define AVINDEX_KEYFRAME 0x0001
30a43f2d 586 int flags:2;
4f57fa8c
DB
587 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).
588 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
fb2758c8
FB
589} AVIndexEntry;
590
90c2295b
ES
591#define AV_DISPOSITION_DEFAULT 0x0001
592#define AV_DISPOSITION_DUB 0x0002
593#define AV_DISPOSITION_ORIGINAL 0x0004
594#define AV_DISPOSITION_COMMENT 0x0008
595#define AV_DISPOSITION_LYRICS 0x0010
596#define AV_DISPOSITION_KARAOKE 0x0020
76c56376
MN
597
598/**
599 * Track should be used during playback by default.
600 * Useful for subtitle track that should be displayed
601 * even when user did not explicitly ask for subtitles.
602 */
7a617a86 603#define AV_DISPOSITION_FORCED 0x0040
12c14cd4
PR
604#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
605#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
24a83bd1 606#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
dd2a4bcf
AK
607/**
608 * The stream is stored in the file as an attached picture/"cover art" (e.g.
609 * APIC frame in ID3v2). The single packet associated with it will be returned
610 * among the first few packets read from the file unless seeking takes place.
611 * It can also be accessed at any time in AVStream.attached_pic.
612 */
613#define AV_DISPOSITION_ATTACHED_PIC 0x0400
90c2295b 614
ba66ae94
MN
615/**
616 * Stream structure.
617 * New fields can be added to the end with minor version bumps.
8bfb108b 618 * Removal, reordering and changes to existing fields require a major
ba66ae94 619 * version bump.
8bfb108b 620 * sizeof(AVStream) must not be used outside libav*.
ba66ae94 621 */
de6d9b64 622typedef struct AVStream {
43d414ba 623 int index; /**< stream index in AVFormatContext */
e20ad71e
MS
624 /**
625 * Format-specific stream ID.
626 * decoding: set by libavformat
3b4296f4 627 * encoding: set by the user, replaced by libavformat if left unset
e20ad71e
MS
628 */
629 int id;
967923ab
AK
630 /**
631 * Codec context associated with this stream. Allocated and freed by
632 * libavformat.
633 *
634 * - decoding: The demuxer exports codec information stored in the headers
635 * here.
636 * - encoding: The user sets codec information, the muxer writes it to the
637 * output. Mandatory fields as specified in AVCodecContext
638 * documentation must be set even if this AVCodecContext is
639 * not actually used for encoding.
640 */
641 AVCodecContext *codec;
de6d9b64 642 void *priv_data;
82583548 643
76c56376
MN
644 /**
645 * encoding: pts generation when outputting stream
646 */
a9fd2b19 647 struct AVFrac pts;
5b28c8c3
MN
648
649 /**
8bfb108b 650 * This is the fundamental unit of time (in seconds) in terms
e44ada12
AK
651 * of which frame timestamps are represented.
652 *
5d820db2 653 * decoding: set by libavformat
0af1fe84 654 * encoding: set by libavformat in avformat_write_header. The muxer may use the
e44ada12
AK
655 * user-provided value of @ref AVCodecContext.time_base "codec->time_base"
656 * as a hint.
5b28c8c3 657 */
9ee91c2f 658 AVRational time_base;
76c56376 659
6d96a9b9 660 /**
8bfb108b
DB
661 * Decoding: pts of the first frame of the stream, in stream time base.
662 * Only set this if you are absolutely 100% sure that the value you set
663 * it to really is the pts of the first frame.
4854c253 664 * This may be undefined (AV_NOPTS_VALUE).
6d96a9b9 665 */
115329f1 666 int64_t start_time;
76c56376 667
e26381b6 668 /**
8bfb108b 669 * Decoding: duration of the stream, in stream time base.
e26381b6 670 * If a source file does not specify a duration, but does specify
4f57fa8c 671 * a bitrate, this value will be estimated from bitrate and file size.
e26381b6 672 */
ee404803 673 int64_t duration;
fb2758c8 674
b4b87d48 675 int64_t nb_frames; ///< number of frames in this stream if known or 0
504ee036 676
4f57fa8c 677 int disposition; /**< AV_DISPOSITION_* bit field */
0bef08e5 678
ee42df8a
LB
679 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
680
c30a4489
AJ
681 /**
682 * sample aspect ratio (0 if unknown)
683 * - encoding: Set by user.
684 * - decoding: Set by libavformat.
685 */
686 AVRational sample_aspect_ratio;
f526adaf 687
d2d67e42 688 AVDictionary *metadata;
3a41c2f7 689
02b398ef
MN
690 /**
691 * Average framerate
692 */
693 AVRational avg_frame_rate;
6c6e6ef5 694
dd2a4bcf
AK
695 /**
696 * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet
697 * will contain the attached picture.
698 *
699 * decoding: set by libavformat, must not be modified by the caller.
700 * encoding: unused
701 */
702 AVPacket attached_pic;
703
9a174562
AK
704 /*****************************************************************
705 * All fields below this line are not part of the public API. They
706 * may not be used outside of libavformat and can be changed and
707 * removed at will.
708 * New public fields should be added right above.
709 *****************************************************************
710 */
711
6c6e6ef5 712 /**
da9cea77 713 * Stream information used internally by av_find_stream_info()
fd0368e7
AJ
714 */
715#define MAX_STD_TIMEBASES (60*12+5)
716 struct {
38a4be3f 717 int nb_decoded_frames;
8c1d6ac6 718 int found_decoder;
fe1c1198
AK
719
720 /**
721 * Those are used for average framerate estimation.
722 */
723 int64_t fps_first_dts;
724 int fps_first_dts_idx;
725 int64_t fps_last_dts;
726 int fps_last_dts_idx;
727
fd0368e7 728 } *info;
ee42df8a 729
ee42df8a 730 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
9a174562 731
8b64c2ba
AK
732#if FF_API_REFERENCE_DTS
733 /* a hack to keep ABI compatibility for avconv, which accesses parser even
734 * though it should not */
735 int64_t do_not_use;
736#endif
9a174562 737 // Timestamp generation support:
9a174562
AK
738 int64_t first_dts;
739 int64_t cur_dts;
9a174562 740 int64_t last_IP_pts;
ee42df8a 741 int last_IP_duration;
9a174562
AK
742
743 /**
744 * Number of packets to buffer for codec probing
745 */
746#define MAX_PROBE_PACKETS 2500
747 int probe_packets;
748
749 /**
ee42df8a
LB
750 * Number of frames that have been demuxed during av_find_stream_info()
751 */
752 int codec_info_nb_frames;
753
754 /* av_read_frame() support */
755 enum AVStreamParseType need_parsing;
756 struct AVCodecParserContext *parser;
757
758 /**
9a174562
AK
759 * last packet in packet_buffer for this stream when muxing.
760 */
761 struct AVPacketList *last_in_packet_buffer;
762 AVProbeData probe_data;
763#define MAX_REORDER_DELAY 16
764 int64_t pts_buffer[MAX_REORDER_DELAY+1];
9a174562
AK
765
766 AVIndexEntry *index_entries; /**< Only used if the format does not
767 support seeking natively. */
768 int nb_index_entries;
769 unsigned int index_entries_allocated_size;
de6d9b64
FB
770} AVStream;
771
15afa396
NS
772#define AV_PROGRAM_RUNNING 1
773
ba66ae94 774/**
ba66ae94 775 * New fields can be added to the end with minor version bumps.
8bfb108b 776 * Removal, reordering and changes to existing fields require a major
ba66ae94 777 * version bump.
8bfb108b 778 * sizeof(AVProgram) must not be used outside libav*.
ba66ae94 779 */
15afa396
NS
780typedef struct AVProgram {
781 int id;
15afa396
NS
782 int flags;
783 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
526efa10
NS
784 unsigned int *stream_index;
785 unsigned int nb_stream_indexes;
d2d67e42 786 AVDictionary *metadata;
15afa396
NS
787} AVProgram;
788
43d414ba 789#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
da24c5e3
FB
790 (streams are added dynamically) */
791
79d7836a 792typedef struct AVChapter {
4f57fa8c
DB
793 int id; ///< unique ID to identify the chapter
794 AVRational time_base; ///< time base in which the start/end timestamps are specified
8931e7b4 795 int64_t start, end; ///< chapter start/end time in time_base units
d2d67e42 796 AVDictionary *metadata;
79d7836a
AK
797} AVChapter;
798
33c859c1
AK
799typedef struct AVFormatInternal AVFormatInternal;
800
252f17e2 801/**
4f57fa8c 802 * Format I/O context.
252f17e2 803 * New fields can be added to the end with minor version bumps.
8bfb108b 804 * Removal, reordering and changes to existing fields require a major
252f17e2 805 * version bump.
83daced0
AK
806 * sizeof(AVFormatContext) must not be used outside libav*, use
807 * avformat_alloc_context() to create an AVFormatContext.
252f17e2 808 */
de6d9b64 809typedef struct AVFormatContext {
83daced0
AK
810 /**
811 * A class for logging and AVOptions. Set by avformat_alloc_context().
812 * Exports (de)muxer private options if they exist.
813 */
814 const AVClass *av_class;
815
816 /**
817 * Can only be iformat or oformat, not both at the same time.
818 *
819 * decoding: set by avformat_open_input().
820 * encoding: set by the user.
821 */
b9a281db
FB
822 struct AVInputFormat *iformat;
823 struct AVOutputFormat *oformat;
83daced0
AK
824
825 /**
826 * Format private data. This is an AVOptions-enabled struct
827 * if and only if iformat/oformat.priv_class is not NULL.
828 */
de6d9b64 829 void *priv_data;
83daced0 830
1432c1c4 831 /**
83daced0
AK
832 * I/O context.
833 *
834 * decoding: either set by the user before avformat_open_input() (then
835 * the user must close it manually) or set by avformat_open_input().
836 * encoding: set by the user.
837 *
838 * Do NOT set this field if AVFMT_NOFILE flag is set in
839 * iformat/oformat.flags. In such a case, the (de)muxer will handle
840 * I/O in some other way and this field will be NULL.
841 */
ae628ec1 842 AVIOContext *pb;
83daced0 843
ee42df8a
LB
844 /* stream info */
845 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
846
83daced0
AK
847 /**
848 * A list of all streams in the file. New streams are created with
849 * avformat_new_stream().
850 *
851 * decoding: streams are created by libavformat in avformat_open_input().
852 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
853 * appear in av_read_frame().
854 * encoding: streams are created by the user before avformat_write_header().
855 */
db69c2e5 856 unsigned int nb_streams;
38aab35f 857 AVStream **streams;
83daced0 858
43d414ba 859 char filename[1024]; /**< input or output filename */
ee404803 860
76c56376
MN
861 /**
862 * Decoding: position of the first frame of the component, in
863 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
864 * It is deduced from the AVStream values.
865 */
115329f1 866 int64_t start_time;
76c56376
MN
867
868 /**
869 * Decoding: duration of the stream, in AV_TIME_BASE fractional
870 * seconds. Only set this value if you know none of the individual stream
da9cea77 871 * durations and also do not set any of them. This is deduced from the
76c56376
MN
872 * AVStream values if not set.
873 */
ee404803 874 int64_t duration;
76c56376 875
76c56376
MN
876 /**
877 * Decoding: total stream bitrate in bit/s, 0 if not
878 * available. Never set it directly if the file_size and the
6001dad6 879 * duration are known as Libav can compute it automatically.
76c56376 880 */
ee404803 881 int bit_rate;
fb2758c8 882
92400be2 883 unsigned int packet_size;
17c88cb0 884 int max_delay;
8108551a 885
30bc6613 886 int flags;
22e77e44 887#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
4f57fa8c
DB
888#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
889#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
c55806e3 890#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
fe8344a2
MN
891#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
892#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
681ed000 893#define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible
05e84c95 894#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
73e8e8db 895#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
596e5d47 896#define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet.
5894e1bb 897
76c56376
MN
898 /**
899 * decoding: size of data to probe; encoding: unused.
900 */
9e6c9470 901 unsigned int probesize;
a44b3c4d
MN
902
903 /**
83daced0
AK
904 * decoding: maximum time (in AV_TIME_BASE units) during which the input should
905 * be analyzed in avformat_find_stream_info().
a44b3c4d
MN
906 */
907 int max_analyze_duration;
c964c2c7
RD
908
909 const uint8_t *key;
910 int keylen;
15afa396
NS
911
912 unsigned int nb_programs;
913 AVProgram **programs;
62600469
MN
914
915 /**
916 * Forced video codec_id.
4f57fa8c 917 * Demuxing: Set by user.
62600469 918 */
36ef5369 919 enum AVCodecID video_codec_id;
76c56376 920
62600469
MN
921 /**
922 * Forced audio codec_id.
4f57fa8c 923 * Demuxing: Set by user.
62600469 924 */
36ef5369 925 enum AVCodecID audio_codec_id;
76c56376 926
62600469
MN
927 /**
928 * Forced subtitle codec_id.
4f57fa8c 929 * Demuxing: Set by user.
62600469 930 */
36ef5369 931 enum AVCodecID subtitle_codec_id;
3dea63bd
PK
932
933 /**
22e77e44
DB
934 * Maximum amount of memory in bytes to use for the index of each stream.
935 * If the index exceeds this size, entries will be discarded as
3dea63bd
PK
936 * needed to maintain a smaller size. This can lead to slower or less
937 * accurate seeking (depends on demuxer).
4f57fa8c 938 * Demuxers for which a full in-memory index is mandatory will ignore
3dea63bd
PK
939 * this.
940 * muxing : unused
941 * demuxing: set by user
942 */
943 unsigned int max_index_size;
ab8ab30c
RP
944
945 /**
ffa71b2b 946 * Maximum amount of memory in bytes to use for buffering frames
4f57fa8c 947 * obtained from realtime capture devices.
ab8ab30c
RP
948 */
949 unsigned int max_picture_buffer;
79d7836a 950
26b241c0
JS
951 /**
952 * Number of chapters in AVChapter array.
953 * When muxing, chapters are normally written in the file header,
954 * so nb_chapters should normally be initialized before write_header
955 * is called. Some muxers (e.g. mov and mkv) can also write chapters
956 * in the trailer. To write chapters in the trailer, nb_chapters
957 * must be zero when write_header is called and non-zero when
958 * write_trailer is called.
959 * muxing : set by user
960 * demuxing: set by libavformat
961 */
fbabf1e9 962 unsigned int nb_chapters;
79d7836a 963 AVChapter **chapters;
45b2b05f 964
d2d67e42 965 AVDictionary *metadata;
af122d6a 966
b8819c85
MS
967 /**
968 * Start time of the stream in real world time, in microseconds
969 * since the unix epoch (00:00 1st January 1970). That is, pts=0
970 * in the stream was captured at this real world time.
971 * - encoding: Set by user.
972 * - decoding: Unused.
973 */
974 int64_t start_time_realtime;
30315a8d
AC
975
976 /**
977 * decoding: number of frames used to probe fps
978 */
979 int fps_probe_size;
2f63440c
DB
980
981 /**
982 * Error recognition; higher values will detect more errors but may
983 * misdetect some more or less valid parts as errors.
984 * - encoding: unused
985 * - decoding: Set by user.
986 */
987 int error_recognition;
df968050 988
6aa0b98f
MS
989 /**
990 * Custom interrupt callbacks for the I/O layer.
991 *
992 * decoding: set by the user before avformat_open_input().
993 * encoding: set by the user before avformat_write_header()
994 * (mainly useful for AVFMT_NOFILE formats). The callback
995 * should also be passed to avio_open2() if it's used to
996 * open the file.
997 */
998 AVIOInterruptCB interrupt_callback;
999
ee42df8a
LB
1000 /**
1001 * Flags to enable debugging.
1002 */
1003 int debug;
1004#define FF_FDEBUG_TS 0x0001
d9ae1031
LB
1005
1006 /**
1007 * Maximum buffering duration for interleaving.
1008 *
1009 * To ensure all the streams are interleaved correctly,
1010 * av_interleaved_write_frame() will wait until it has at least one packet
1011 * for each stream before actually writing any packets to the output file.
1012 * When some streams are "sparse" (i.e. there are large gaps between
1013 * successive packets), this can result in excessive buffering.
1014 *
1015 * This field specifies the maximum difference between the timestamps of the
1016 * first and the last packet in the muxing queue, above which libavformat
1017 * will output a packet regardless of whether it has queued a packet for all
1018 * the streams.
1019 *
1020 * Muxing only, set by the caller before avformat_write_header().
1021 */
1022 int64_t max_interleave_delta;
1023
df968050
AK
1024 /*****************************************************************
1025 * All fields below this line are not part of the public API. They
1026 * may not be used outside of libavformat and can be changed and
1027 * removed at will.
1028 * New public fields should be added right above.
1029 *****************************************************************
1030 */
df968050
AK
1031
1032 /**
1033 * This buffer is only needed when packets were already buffered but
1034 * not decoded, for example to get the codec parameters in MPEG
1035 * streams.
1036 */
1037 struct AVPacketList *packet_buffer;
1038 struct AVPacketList *packet_buffer_end;
1039
df968050
AK
1040 /* av_seek_frame() support */
1041 int64_t data_offset; /**< offset of the first packet */
ee42df8a
LB
1042
1043 /**
1044 * Raw packets from the demuxer, prior to parsing and decoding.
1045 * This buffer is used for buffering packets until the codec can
1046 * be identified, as parsing cannot be done without knowing the
1047 * codec.
1048 */
1049 struct AVPacketList *raw_packet_buffer;
1050 struct AVPacketList *raw_packet_buffer_end;
1051 /**
27c7ca9c
AK
1052 * Packets split by the parser get queued here.
1053 */
1054 struct AVPacketList *parse_queue;
1055 struct AVPacketList *parse_queue_end;
1056 /**
ee42df8a
LB
1057 * Remaining size available for raw_packet_buffer, in bytes.
1058 */
1059#define RAW_PACKET_BUFFER_SIZE 2500000
1060 int raw_packet_buffer_remaining_size;
c2cb01d4
LB
1061
1062 /**
1063 * Offset to remap timestamps to be non-negative.
1064 * Expressed in timebase units.
1065 */
1066 int64_t offset;
1067
1068 /**
1069 * Timebase for the timestamp offset.
1070 */
1071 AVRational offset_timebase;
1072
33c859c1
AK
1073 /**
1074 * An opaque field for libavformat internal usage.
1075 * Must not be accessed in any way by callers.
1076 */
1077 AVFormatInternal *internal;
de6d9b64
FB
1078} AVFormatContext;
1079
1080typedef struct AVPacketList {
1081 AVPacket pkt;
1082 struct AVPacketList *next;
1083} AVPacketList;
1084
469c62d0
AK
1085
1086/**
1087 * @defgroup lavf_core Core functions
1088 * @ingroup libavf
1089 *
1090 * Functions for querying libavformat capabilities, allocating core structures,
1091 * etc.
1092 * @{
1093 */
1094
1095/**
1096 * Return the LIBAVFORMAT_VERSION_INT constant.
1097 */
1098unsigned avformat_version(void);
1099
1100/**
1101 * Return the libavformat build-time configuration.
1102 */
1103const char *avformat_configuration(void);
1104
1105/**
1106 * Return the libavformat license.
1107 */
1108const char *avformat_license(void);
1109
1110/**
1111 * Initialize libavformat and register all the muxers, demuxers and
1112 * protocols. If you do not call this function, then you can select
1113 * exactly which formats you want to support.
1114 *
1115 * @see av_register_input_format()
1116 * @see av_register_output_format()
1117 * @see av_register_protocol()
1118 */
1119void av_register_all(void);
1120
1121void av_register_input_format(AVInputFormat *format);
1122void av_register_output_format(AVOutputFormat *format);
1123
1124/**
1125 * Do global initialization of network components. This is optional,
1126 * but recommended, since it avoids the overhead of implicitly
1127 * doing the setup for each session.
1128 *
1129 * Calling this function will become mandatory if using network
1130 * protocols at some major version bump.
1131 */
1132int avformat_network_init(void);
1133
1134/**
1135 * Undo the initialization done by avformat_network_init.
1136 */
1137int avformat_network_deinit(void);
1138
aeedac95
SS
1139/**
1140 * If f is NULL, returns the first registered input format,
22e77e44 1141 * if f is non-NULL, returns the next registered input format after f
aeedac95
SS
1142 * or NULL if f is the last one.
1143 */
84be6e72 1144AVInputFormat *av_iformat_next(AVInputFormat *f);
aeedac95
SS
1145
1146/**
1147 * If f is NULL, returns the first registered output format,
22e77e44 1148 * if f is non-NULL, returns the next registered output format after f
aeedac95
SS
1149 * or NULL if f is the last one.
1150 */
84be6e72 1151AVOutputFormat *av_oformat_next(AVOutputFormat *f);
de6d9b64 1152
469c62d0
AK
1153/**
1154 * Allocate an AVFormatContext.
1155 * avformat_free_context() can be used to free the context and everything
1156 * allocated by the framework within it.
1157 */
1158AVFormatContext *avformat_alloc_context(void);
1159
1160/**
1161 * Free an AVFormatContext and all its streams.
1162 * @param s context to free
1163 */
1164void avformat_free_context(AVFormatContext *s);
1165
1166/**
1167 * Get the AVClass for AVFormatContext. It can be used in combination with
1168 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1169 *
1170 * @see av_opt_find().
1171 */
1172const AVClass *avformat_get_class(void);
1173
1174/**
1175 * Add a new stream to a media file.
1176 *
1177 * When demuxing, it is called by the demuxer in read_header(). If the
1178 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1179 * be called in read_packet().
1180 *
1181 * When muxing, should be called by the user before avformat_write_header().
1182 *
1183 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1184 * will be initialized to use this codec. This is needed for e.g. codec-specific
1185 * defaults to be set, so codec should be provided if it is known.
1186 *
1187 * @return newly created stream or NULL on error.
1188 */
1189AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1190
1191AVProgram *av_new_program(AVFormatContext *s, int id);
1192
1193/**
1194 * @}
1195 */
1196
1197
370f27de 1198/**
370f27de
AK
1199 * @addtogroup lavf_decoding
1200 * @{
1201 */
3217cb42
PI
1202
1203/**
49bd8e4b 1204 * Find AVInputFormat based on the short name of the input format.
3217cb42 1205 */
b9a281db 1206AVInputFormat *av_find_input_format(const char *short_name);
3217cb42
PI
1207
1208/**
49bd8e4b 1209 * Guess the file format.
3217cb42 1210 *
4f57fa8c
DB
1211 * @param is_opened Whether the file is already opened; determines whether
1212 * demuxers with or without AVFMT_NOFILE are probed.
3217cb42 1213 */
94988531 1214AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
3217cb42
PI
1215
1216/**
49bd8e4b 1217 * Guess the file format.
8e2ee182
RD
1218 *
1219 * @param is_opened Whether the file is already opened; determines whether
1220 * demuxers with or without AVFMT_NOFILE are probed.
c99d506b
RD
1221 * @param score_max A probe score larger that this is required to accept a
1222 * detection, the variable is set to the actual detection
1223 * score afterwards.
1224 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
8e2ee182
RD
1225 * to retry with a larger probe buffer.
1226 */
1227AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1228
1229/**
3940caad
AH
1230 * Probe a bytestream to determine the input format. Each time a probe returns
1231 * with a score that is too low, the probe buffer size is increased and another
1232 * attempt is made. When the maximum probe size is reached, the input format
1233 * with the highest score is returned.
1234 *
1235 * @param pb the bytestream to probe
1236 * @param fmt the input format is put here
1237 * @param filename the filename of the stream
1238 * @param logctx the log context
1239 * @param offset the offset within the bytestream to probe from
1240 * @param max_probe_size the maximum probe buffer size (zero for default)
1241 * @return 0 in case of success, a negative value corresponding to an
1242 * AVERROR code otherwise
1243 */
ae628ec1 1244int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
3940caad
AH
1245 const char *filename, void *logctx,
1246 unsigned int offset, unsigned int max_probe_size);
1247
88808c60 1248/**
05e84c95 1249 * Open an input stream and read the header. The codecs are not opened.
64af59bc 1250 * The stream must be closed with avformat_close_input().
05e84c95
AK
1251 *
1252 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1253 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1254 * function and written into ps.
1255 * Note that a user-supplied AVFormatContext will be freed on failure.
1256 * @param filename Name of the stream to open.
1257 * @param fmt If non-NULL, this parameter forces a specific input format.
1258 * Otherwise the format is autodetected.
1259 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1260 * On return this parameter will be destroyed and replaced with a dict containing
1261 * options that were not found. May be NULL.
1262 *
1263 * @return 0 on success, a negative AVERROR on failure.
1264 *
1265 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1266 */
1267int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1268
a67c061e
AK
1269/**
1270 * Read packets of a media file to get stream information. This
1271 * is useful for file formats with no headers such as MPEG. This
1272 * function also computes the real framerate in case of MPEG-2 repeat
1273 * frame mode.
1274 * The logical file position is not changed by this function;
1275 * examined packets may be buffered for later processing.
1276 *
1277 * @param ic media file handle
1278 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1279 * dictionaries, where i-th member contains options for
1280 * codec corresponding to i-th stream.
1281 * On return each dictionary will be filled with options that were not found.
1282 * @return >=0 if OK, AVERROR_xxx on error
1283 *
1284 * @note this function isn't guaranteed to open all the codecs, so
1285 * options being non-empty at return is a perfectly normal behavior.
1286 *
1287 * @todo Let the user decide somehow what information is needed so that
1288 * we do not waste time getting stuff the user does not need.
1289 */
1290int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
3217cb42
PI
1291
1292/**
9128ae08
NG
1293 * Find the "best" stream in the file.
1294 * The best stream is determined according to various heuristics as the most
1295 * likely to be what the user expects.
1296 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1297 * default decoder for the stream's codec; streams for which no decoder can
1298 * be found are ignored.
1299 *
1300 * @param ic media file handle
1301 * @param type stream type: video, audio, subtitles, etc.
1302 * @param wanted_stream_nb user-requested stream number,
1303 * or -1 for automatic selection
1304 * @param related_stream try to find a stream related (eg. in the same
1305 * program) to this one, or -1 if none
1306 * @param decoder_ret if non-NULL, returns the decoder for the
1307 * selected stream
1308 * @param flags flags; none are currently defined
1309 * @return the non-negative stream number in case of success,
1310 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1311 * could be found,
1312 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1313 * @note If av_find_best_stream returns successfully and decoder_ret is not
1314 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1315 */
1316int av_find_best_stream(AVFormatContext *ic,
1317 enum AVMediaType type,
1318 int wanted_stream_nb,
1319 int related_stream,
1320 AVCodec **decoder_ret,
1321 int flags);
1322
3217cb42 1323/**
49bd8e4b 1324 * Return the next frame of a stream.
4faf628f
MN
1325 * This function returns what is stored in the file, and does not validate
1326 * that what is there are valid frames for the decoder. It will split what is
1327 * stored in the file into frames and return one for each call. It will not
1328 * omit invalid data between valid frames so as to give the decoder the maximum
1329 * information possible for decoding.
3217cb42 1330 *
1afddbe5 1331 * If pkt->buf is NULL, then the packet is valid until the next
64af59bc
DB
1332 * av_read_frame() or until avformat_close_input(). Otherwise the packet
1333 * is valid indefinitely. In both cases the packet must be freed with
717a4509
AK
1334 * av_free_packet when it is no longer needed. For video, the packet contains
1335 * exactly one frame. For audio, it contains an integer number of frames if each
1336 * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames
1337 * have a variable size (e.g. MPEG audio), then it contains one frame.
3217cb42
PI
1338 *
1339 * pkt->pts, pkt->dts and pkt->duration are always set to correct
22e77e44 1340 * values in AVStream.time_base units (and guessed if the format cannot
4f57fa8c
DB
1341 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1342 * has B-frames, so it is better to rely on pkt->dts if you do not
3217cb42
PI
1343 * decompress the payload.
1344 *
4f57fa8c 1345 * @return 0 if OK, < 0 on error or end of file
3217cb42 1346 */
fb2758c8 1347int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1348
1349/**
49bd8e4b 1350 * Seek to the keyframe at timestamp.
3217cb42
PI
1351 * 'timestamp' in 'stream_index'.
1352 * @param stream_index If stream_index is (-1), a default
1353 * stream is selected, and timestamp is automatically converted
1354 * from AV_TIME_BASE units to the stream specific time_base.
4f57fa8c
DB
1355 * @param timestamp Timestamp in AVStream.time_base units
1356 * or, if no stream is specified, in AV_TIME_BASE units.
3217cb42
PI
1357 * @param flags flags which select direction and seeking mode
1358 * @return >= 0 on success
1359 */
78cb7273
DB
1360int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1361 int flags);
3217cb42
PI
1362
1363/**
49bd8e4b 1364 * Seek to timestamp ts.
d04768fa
MN
1365 * Seeking will be done so that the point from which all active streams
1366 * can be presented successfully will be closest to ts and within min/max_ts.
1367 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1368 *
22e77e44 1369 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
d04768fa 1370 * are the file position (this may not be supported by all demuxers).
22e77e44 1371 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
d04768fa 1372 * in the stream with stream_index (this may not be supported by all demuxers).
22e77e44
DB
1373 * Otherwise all timestamps are in units of the stream selected by stream_index
1374 * or if stream_index is -1, in AV_TIME_BASE units.
1375 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
d04768fa
MN
1376 * keyframes (this may not be supported by all demuxers).
1377 *
22e77e44 1378 * @param stream_index index of the stream which is used as time base reference
d04768fa
MN
1379 * @param min_ts smallest acceptable timestamp
1380 * @param ts target timestamp
1381 * @param max_ts largest acceptable timestamp
1382 * @param flags flags
32e543f8 1383 * @return >=0 on success, error code otherwise
998b6f7c 1384 *
8a4d7a30 1385 * @note This is part of the new seek API which is still under construction.
22e77e44
DB
1386 * Thus do not use this yet. It may change at any time, do not expect
1387 * ABI compatibility yet!
d04768fa
MN
1388 */
1389int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1390
1391/**
49bd8e4b 1392 * Start playing a network-based stream (e.g. RTSP stream) at the
4f57fa8c 1393 * current position.
3217cb42 1394 */
fb2758c8 1395int av_read_play(AVFormatContext *s);
3217cb42
PI
1396
1397/**
49bd8e4b 1398 * Pause a network-based stream (e.g. RTSP stream).
3217cb42
PI
1399 *
1400 * Use av_read_play() to resume it.
1401 */
fb2758c8 1402int av_read_pause(AVFormatContext *s);
3217cb42 1403
52660454
AK
1404/**
1405 * Close an opened input AVFormatContext. Free it and all its contents
1406 * and set *s to NULL.
1407 */
1408void avformat_close_input(AVFormatContext **s);
370f27de
AK
1409/**
1410 * @}
1411 */
3217cb42 1412
3ba1438d
MN
1413#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1414#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
4f57fa8c 1415#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
2bf74f49 1416#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
3ba1438d 1417
3217cb42 1418/**
489a7b07
AK
1419 * @addtogroup lavf_encoding
1420 * @{
1421 */
f3bfe388 1422/**
25de5958
AK
1423 * Allocate the stream private data and write the stream header to
1424 * an output media file.
1425 *
1426 * @param s Media file handle, must be allocated with avformat_alloc_context().
1427 * Its oformat field must be set to the desired output format;
a5f88736 1428 * Its pb field must be set to an already opened AVIOContext.
25de5958
AK
1429 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1430 * On return this parameter will be destroyed and replaced with a dict containing
1431 * options that were not found. May be NULL.
1432 *
1433 * @return 0 on success, negative AVERROR on failure.
1434 *
1435 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1436 */
1437int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1438
3217cb42 1439/**
49bd8e4b 1440 * Write a packet to an output media file.
3217cb42
PI
1441 *
1442 * The packet shall contain one audio or video frame.
78cb7273
DB
1443 * The packet must be correctly interleaved according to the container
1444 * specification, if not then av_interleaved_write_frame must be used.
3217cb42
PI
1445 *
1446 * @param s media file handle
78cb7273 1447 * @param pkt The packet, which contains the stream_index, buf/buf_size,
f1caf01d
MS
1448 * dts/pts, ...
1449 * This can be NULL (at any time, not just at the end), in
1450 * order to immediately flush data buffered within the muxer,
1451 * for muxers that buffer up data internally before writing it
1452 * to the output.
1453 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush
3217cb42 1454 */
e928649b 1455int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42
PI
1456
1457/**
49bd8e4b 1458 * Write a packet to an output media file ensuring correct interleaving.
3217cb42
PI
1459 *
1460 * The packet must contain one audio or video frame.
22e77e44 1461 * If the packets are already correctly interleaved, the application should
90b5b51e
DB
1462 * call av_write_frame() instead as it is slightly faster. It is also important
1463 * to keep in mind that completely non-interleaved input will need huge amounts
1464 * of memory to interleave with this, so it is preferable to interleave at the
1465 * demuxer level.
3217cb42
PI
1466 *
1467 * @param s media file handle
1afddbe5
AK
1468 * @param pkt The packet containing the data to be written. pkt->buf must be set
1469 * to a valid AVBufferRef describing the packet data. Libavformat takes
1470 * ownership of this reference and will unref it when it sees fit. The caller
1471 * must not access the data through this reference after this function returns.
9221efef
AK
1472 * This can be NULL (at any time, not just at the end), to flush the
1473 * interleaving queues.
f97cb451
AK
1474 * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the
1475 * index of the corresponding stream in @ref AVFormatContext.streams
1476 * "s.streams".
1477 * It is very strongly recommended that timing information (@ref AVPacket.pts
1478 * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to
1479 * correct values.
1480 *
1481 * @return 0 on success, a negative AVERROR on error.
3217cb42 1482 */
3c895fc0 1483int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
3217cb42 1484
3217cb42 1485/**
49bd8e4b 1486 * Write the stream trailer to an output media file and free the
2b75bde6 1487 * file private data.
3217cb42 1488 *
0af1fe84 1489 * May only be called after a successful call to avformat_write_header.
dc76fe13 1490 *
3217cb42 1491 * @param s media file handle
4f57fa8c 1492 * @return 0 if OK, AVERROR_xxx on error
3217cb42 1493 */
b9a281db 1494int av_write_trailer(AVFormatContext *s);
c8dffc02
AK
1495
1496/**
1497 * Return the output format in the list of registered output formats
1498 * which best matches the provided parameters, or return NULL if
1499 * there is no match.
1500 *
1501 * @param short_name if non-NULL checks if short_name matches with the
1502 * names of the registered formats
1503 * @param filename if non-NULL checks if filename terminates with the
1504 * extensions of the registered formats
1505 * @param mime_type if non-NULL checks if mime_type matches with the
1506 * MIME type of the registered formats
1507 */
1508AVOutputFormat *av_guess_format(const char *short_name,
1509 const char *filename,
1510 const char *mime_type);
1511
1512/**
1513 * Guess the codec ID based upon muxer and filename.
1514 */
36ef5369 1515enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
c8dffc02
AK
1516 const char *filename, const char *mime_type,
1517 enum AVMediaType type);
1518
489a7b07
AK
1519/**
1520 * @}
1521 */
de6d9b64 1522
abf2c2d7
AK
1523
1524/**
1525 * @defgroup lavf_misc Utility functions
1526 * @ingroup libavf
1527 * @{
1528 *
511cf612 1529 * Miscellaneous utility functions related to both muxing and demuxing
abf2c2d7
AK
1530 * (or neither).
1531 */
1532
1533/**
1534 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1535 *
1536 * @param f The file stream pointer where the dump should be sent to.
1537 * @param buf buffer
1538 * @param size buffer size
1539 *
1540 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1541 */
d3c40a7d 1542void av_hex_dump(FILE *f, const uint8_t *buf, int size);
abf2c2d7
AK
1543
1544/**
1545 * Send a nice hexadecimal dump of a buffer to the log.
1546 *
1547 * @param avcl A pointer to an arbitrary struct of which the first field is a
1548 * pointer to an AVClass struct.
1549 * @param level The importance level of the message, lower values signifying
1550 * higher importance.
1551 * @param buf buffer
1552 * @param size buffer size
1553 *
1554 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1555 */
d3c40a7d 1556void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size);
abf2c2d7
AK
1557
1558/**
1559 * Send a nice dump of a packet to the specified file stream.
1560 *
1561 * @param f The file stream pointer where the dump should be sent to.
1562 * @param pkt packet to dump
1563 * @param dump_payload True if the payload must be displayed, too.
1564 * @param st AVStream that the packet belongs to
1565 */
1566void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1567
1568
1569/**
1570 * Send a nice dump of a packet to the log.
1571 *
1572 * @param avcl A pointer to an arbitrary struct of which the first field is a
1573 * pointer to an AVClass struct.
1574 * @param level The importance level of the message, lower values signifying
1575 * higher importance.
1576 * @param pkt packet to dump
1577 * @param dump_payload True if the payload must be displayed, too.
1578 * @param st AVStream that the packet belongs to
1579 */
1580void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1581 AVStream *st);
1582
1583/**
36ef5369
AK
1584 * Get the AVCodecID for the given codec tag tag.
1585 * If no codec id is found returns AV_CODEC_ID_NONE.
abf2c2d7
AK
1586 *
1587 * @param tags list of supported codec_id-codec_tag pairs, as stored
1588 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1589 */
36ef5369 1590enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
abf2c2d7
AK
1591
1592/**
1593 * Get the codec tag for the given codec id id.
1594 * If no codec tag is found returns 0.
1595 *
1596 * @param tags list of supported codec_id-codec_tag pairs, as stored
1597 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1598 */
36ef5369 1599unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id);
abf2c2d7
AK
1600
1601int av_find_default_stream_index(AVFormatContext *s);
1602
1603/**
1604 * Get the index for a specific timestamp.
1605 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1606 * to the timestamp which is <= the requested one, if backward
1607 * is 0, then it will be >=
1608 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1609 * @return < 0 if no such timestamp could be found
1610 */
1611int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1612
1613/**
1614 * Add an index entry into a sorted list. Update the entry if the list
1615 * already contains it.
1616 *
1617 * @param timestamp timestamp in the time base of the given stream
1618 */
1619int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1620 int size, int distance, int flags);
1621
1622
1623/**
1624 * Split a URL string into components.
1625 *
1626 * The pointers to buffers for storing individual components may be null,
1627 * in order to ignore that component. Buffers for components not found are
1628 * set to empty strings. If the port is not found, it is set to a negative
1629 * value.
1630 *
1631 * @param proto the buffer for the protocol
1632 * @param proto_size the size of the proto buffer
1633 * @param authorization the buffer for the authorization
1634 * @param authorization_size the size of the authorization buffer
1635 * @param hostname the buffer for the host name
1636 * @param hostname_size the size of the hostname buffer
1637 * @param port_ptr a pointer to store the port number in
1638 * @param path the buffer for the path
1639 * @param path_size the size of the path buffer
1640 * @param url the URL to split
1641 */
1642void av_url_split(char *proto, int proto_size,
1643 char *authorization, int authorization_size,
1644 char *hostname, int hostname_size,
1645 int *port_ptr,
1646 char *path, int path_size,
1647 const char *url);
1648
610219a5
AK
1649
1650void av_dump_format(AVFormatContext *ic,
1651 int index,
1652 const char *url,
1653 int is_output);
3217cb42 1654
3217cb42 1655/**
49bd8e4b 1656 * Return in 'buf' the path with '%d' replaced by a number.
4f57fa8c 1657 *
3217cb42
PI
1658 * Also handles the '%0nd' format where 'n' is the total number
1659 * of digits and '%%'.
1660 *
1661 * @param buf destination buffer
1662 * @param buf_size destination buffer size
1663 * @param path numbered sequence string
8ea0e802 1664 * @param number frame number
4f57fa8c 1665 * @return 0 if OK, -1 on format error
3217cb42 1666 */
5c07cf53
MB
1667int av_get_frame_filename(char *buf, int buf_size,
1668 const char *path, int number);
3217cb42
PI
1669
1670/**
49bd8e4b 1671 * Check whether filename actually is a numbered sequence generator.
3217cb42
PI
1672 *
1673 * @param filename possible numbered sequence string
4f57fa8c 1674 * @return 1 if a valid numbered sequence string, 0 otherwise
3217cb42 1675 */
5c07cf53 1676int av_filename_number_test(const char *filename);
96baaa6a 1677
c5388c07 1678/**
49bd8e4b 1679 * Generate an SDP for an RTP session.
c5388c07 1680 *
8034130e
LB
1681 * Note, this overwrites the id values of AVStreams in the muxer contexts
1682 * for getting unique dynamic payload types.
1683 *
c5388c07
LA
1684 * @param ac array of AVFormatContexts describing the RTP streams. If the
1685 * array is composed by only one context, such context can contain
1686 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1687 * all the contexts in the array (an AVCodecContext per RTP stream)
4f57fa8c 1688 * must contain only one AVStream.
8767b80f 1689 * @param n_files number of AVCodecContexts contained in ac
c234d40b
AK
1690 * @param buf buffer where the SDP will be stored (must be allocated by
1691 * the caller)
8767b80f 1692 * @param size the size of the buffer
4f57fa8c 1693 * @return 0 if OK, AVERROR_xxx on error
c5388c07 1694 */
c234d40b 1695int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
c3675dfe 1696
1a70d127 1697/**
49bd8e4b 1698 * Return a positive value if the given filename has one of the given
1a70d127
SS
1699 * extensions, 0 otherwise.
1700 *
1701 * @param extensions a comma-separated list of filename extensions
1702 */
1703int av_match_ext(const char *filename, const char *extensions);
1704
48f9e457
AK
1705/**
1706 * Test if the given container can store a codec.
1707 *
1708 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1709 *
1710 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1711 * A negative number if this information is not available.
1712 */
36ef5369 1713int avformat_query_codec(AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance);
48f9e457 1714
abf2c2d7 1715/**
dd6d3b0e
AK
1716 * @defgroup riff_fourcc RIFF FourCCs
1717 * @{
36ef5369 1718 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are
dd6d3b0e
AK
1719 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the
1720 * following code:
1721 * @code
1722 * uint32_t tag = MKTAG('H', '2', '6', '4');
1723 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 };
36ef5369 1724 * enum AVCodecID id = av_codec_get_id(table, tag);
dd6d3b0e
AK
1725 * @endcode
1726 */
1727/**
36ef5369 1728 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID.
dd6d3b0e
AK
1729 */
1730const struct AVCodecTag *avformat_get_riff_video_tags(void);
1731/**
36ef5369 1732 * @return the table mapping RIFF FourCCs for audio to AVCodecID.
dd6d3b0e
AK
1733 */
1734const struct AVCodecTag *avformat_get_riff_audio_tags(void);
1735/**
1736 * @}
1737 */
1738
1739/**
abf2c2d7
AK
1740 * @}
1741 */
1742
98790382 1743#endif /* AVFORMAT_AVFORMAT_H */