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