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