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