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