Mercurial > mm7
comparison lib/libavformat/avformat.h @ 2134:992d2e6f907d
preparation for libavcodec
author | zipi |
---|---|
date | Tue, 31 Dec 2013 14:52:14 +0000 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
2133:e378232bfd36 | 2134:992d2e6f907d |
---|---|
1 /* | |
2 * copyright (c) 2001 Fabrice Bellard | |
3 * | |
4 * This file is part of FFmpeg. | |
5 * | |
6 * FFmpeg is free software; you can redistribute it and/or | |
7 * modify it under the terms of the GNU Lesser General Public | |
8 * License as published by the Free Software Foundation; either | |
9 * version 2.1 of the License, or (at your option) any later version. | |
10 * | |
11 * FFmpeg is distributed in the hope that it will be useful, | |
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 | |
17 * License along with FFmpeg; if not, write to the Free Software | |
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
19 */ | |
20 | |
21 #ifndef AVFORMAT_AVFORMAT_H | |
22 #define AVFORMAT_AVFORMAT_H | |
23 | |
24 /** | |
25 * @file | |
26 * @ingroup libavf | |
27 * Main libavformat public API header | |
28 */ | |
29 | |
30 /** | |
31 * @defgroup libavf I/O and Muxing/Demuxing Library | |
32 * @{ | |
33 * | |
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 Libavformat 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 * | |
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 * | |
81 * @defgroup lavf_decoding Demuxing | |
82 * @{ | |
83 * Demuxers read a media file and split it into chunks of data (@em packets). A | |
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 | |
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 * | |
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 * | |
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 | |
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 * If AVPacket.buf is set on the returned packet, then the packet is | |
162 * allocated dynamically and the user may keep it indefinitely. | |
163 * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a | |
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. | |
170 * | |
171 * @section lavf_decoding_seek Seeking | |
172 * @} | |
173 * | |
174 * @defgroup lavf_encoding Muxing | |
175 * @{ | |
176 * @} | |
177 * | |
178 * @defgroup lavf_io I/O Read/Write | |
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 */ | |
200 | |
201 #include <time.h> | |
202 #include <stdio.h> /* FILE */ | |
203 #include "../libavcodec/avcodec.h" | |
204 #include "../libavutil/dict.h" | |
205 #include "../libavutil/log.h" | |
206 | |
207 #include "avio.h" | |
208 #include "version.h" | |
209 | |
210 struct AVFormatContext; | |
211 | |
212 | |
213 /** | |
214 * @defgroup metadata_api Public Metadata API | |
215 * @{ | |
216 * @ingroup libavf | |
217 * The metadata API allows libavformat to export metadata tags to a client | |
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 FFmpeg, | |
224 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata | |
225 * exported by demuxers isn't checked to be valid UTF-8 in most cases. | |
226 * | |
227 * Important concepts to keep in mind: | |
228 * - Keys are unique; there can never be 2 tags with the same key. This is | |
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. | |
233 * - Metadata is flat, not hierarchical; there are no subtags. If you | |
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. | |
236 * - Several modifiers can be applied to the tag name. This is done by | |
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. | |
239 * - language -- a tag whose value is localized for a particular language | |
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. | |
244 * - sorting -- a modified version of a tag that should be used for | |
245 * sorting will have '-sort' appended. E.g. artist="The Beatles", | |
246 * artist-sort="Beatles, The". | |
247 * | |
248 * - Demuxers attempt to export metadata in a generic format, however tags | |
249 * with no generic equivalents are left as they are stored in the container. | |
250 * Follows a list of generic tag names: | |
251 * | |
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 * | |
281 * Look in the examples section for an application example how to use the Metadata API. | |
282 * | |
283 * @} | |
284 */ | |
285 | |
286 /* packet functions */ | |
287 | |
288 | |
289 /** | |
290 * Allocate and read the payload of a packet and initialize its | |
291 * fields with default values. | |
292 * | |
293 * @param pkt packet | |
294 * @param size desired payload size | |
295 * @return >0 (read size) if OK, AVERROR_xxx otherwise | |
296 */ | |
297 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size); | |
298 | |
299 | |
300 /** | |
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. | |
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 */ | |
313 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size); | |
314 | |
315 /*************************************************/ | |
316 /* fractional numbers for exact pts handling */ | |
317 | |
318 /** | |
319 * The exact value of the fractional number is: 'val + num / den'. | |
320 * num is assumed to be 0 <= num < den. | |
321 */ | |
322 typedef struct AVFrac { | |
323 int64_t val, num, den; | |
324 } AVFrac; | |
325 | |
326 /*************************************************/ | |
327 /* input/output formats */ | |
328 | |
329 struct AVCodecTag; | |
330 | |
331 /** | |
332 * This structure contains the data a format has to probe a file. | |
333 */ | |
334 typedef struct AVProbeData { | |
335 const char *filename; | |
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 */ | |
338 } AVProbeData; | |
339 | |
340 #define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4) | |
341 #define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension | |
342 #define AVPROBE_SCORE_MAX 100 ///< maximum score | |
343 | |
344 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer | |
345 | |
346 /// Demuxer will use avio_open, no opened file should be provided by the caller. | |
347 #define AVFMT_NOFILE 0x0001 | |
348 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */ | |
349 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */ | |
350 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for | |
351 raw picture data. */ | |
352 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */ | |
353 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */ | |
354 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */ | |
355 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */ | |
356 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */ | |
357 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */ | |
358 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */ | |
359 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */ | |
360 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */ | |
361 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */ | |
362 #define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */ | |
363 #if LIBAVFORMAT_VERSION_MAJOR <= 54 | |
364 #define AVFMT_TS_NONSTRICT 0x8020000 //we try to be compatible to the ABIs of ffmpeg and major forks | |
365 #else | |
366 #define AVFMT_TS_NONSTRICT 0x20000 | |
367 #endif | |
368 /**< Format does not require strictly | |
369 increasing timestamps, but they must | |
370 still be monotonic */ | |
371 #define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative | |
372 timestamps. If not set the timestamp | |
373 will be shifted in av_write_frame and | |
374 av_interleaved_write_frame so they | |
375 start from 0. | |
376 The user or muxer can override this through | |
377 AVFormatContext.avoid_negative_ts | |
378 */ | |
379 | |
380 #define AVFMT_SEEK_TO_PTS 0x4000000 /**< Seeking is based on PTS */ | |
381 | |
382 /** | |
383 * @addtogroup lavf_encoding | |
384 * @{ | |
385 */ | |
386 typedef struct AVOutputFormat { | |
387 const char *name; | |
388 /** | |
389 * Descriptive name for the format, meant to be more human-readable | |
390 * than name. You should use the NULL_IF_CONFIG_SMALL() macro | |
391 * to define it. | |
392 */ | |
393 const char *long_name; | |
394 const char *mime_type; | |
395 const char *extensions; /**< comma-separated filename extensions */ | |
396 /* output support */ | |
397 enum AVCodecID audio_codec; /**< default audio codec */ | |
398 enum AVCodecID video_codec; /**< default video codec */ | |
399 enum AVCodecID subtitle_codec; /**< default subtitle codec */ | |
400 /** | |
401 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE, | |
402 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS, | |
403 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH, | |
404 * AVFMT_TS_NONSTRICT | |
405 */ | |
406 int flags; | |
407 | |
408 /** | |
409 * List of supported codec_id-codec_tag pairs, ordered by "better | |
410 * choice first". The arrays are all terminated by AV_CODEC_ID_NONE. | |
411 */ | |
412 const struct AVCodecTag * const *codec_tag; | |
413 | |
414 | |
415 const AVClass *priv_class; ///< AVClass for the private context | |
416 | |
417 /***************************************************************** | |
418 * No fields below this line are part of the public API. They | |
419 * may not be used outside of libavformat and can be changed and | |
420 * removed at will. | |
421 * New public fields should be added right above. | |
422 ***************************************************************** | |
423 */ | |
424 struct AVOutputFormat *next; | |
425 /** | |
426 * size of private data so that it can be allocated in the wrapper | |
427 */ | |
428 int priv_data_size; | |
429 | |
430 int (*write_header)(struct AVFormatContext *); | |
431 /** | |
432 * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags, | |
433 * pkt can be NULL in order to flush data buffered in the muxer. | |
434 * When flushing, return 0 if there still is more data to flush, | |
435 * or 1 if everything was flushed and there is no more buffered | |
436 * data. | |
437 */ | |
438 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt); | |
439 int (*write_trailer)(struct AVFormatContext *); | |
440 /** | |
441 * Currently only used to set pixel format if not YUV420P. | |
442 */ | |
443 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, | |
444 AVPacket *in, int flush); | |
445 /** | |
446 * Test if the given codec can be stored in this container. | |
447 * | |
448 * @return 1 if the codec is supported, 0 if it is not. | |
449 * A negative number if unknown. | |
450 * MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC | |
451 */ | |
452 int (*query_codec)(enum AVCodecID id, int std_compliance); | |
453 | |
454 void (*get_output_timestamp)(struct AVFormatContext *s, int stream, | |
455 int64_t *dts, int64_t *wall); | |
456 } AVOutputFormat; | |
457 /** | |
458 * @} | |
459 */ | |
460 | |
461 /** | |
462 * @addtogroup lavf_decoding | |
463 * @{ | |
464 */ | |
465 typedef struct AVInputFormat { | |
466 /** | |
467 * A comma separated list of short names for the format. New names | |
468 * may be appended with a minor bump. | |
469 */ | |
470 const char *name; | |
471 | |
472 /** | |
473 * Descriptive name for the format, meant to be more human-readable | |
474 * than name. You should use the NULL_IF_CONFIG_SMALL() macro | |
475 * to define it. | |
476 */ | |
477 const char *long_name; | |
478 | |
479 /** | |
480 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, | |
481 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, | |
482 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS. | |
483 */ | |
484 int flags; | |
485 | |
486 /** | |
487 * If extensions are defined, then no probe is done. You should | |
488 * usually not use extension format guessing because it is not | |
489 * reliable enough | |
490 */ | |
491 const char *extensions; | |
492 | |
493 const struct AVCodecTag * const *codec_tag; | |
494 | |
495 const AVClass *priv_class; ///< AVClass for the private context | |
496 | |
497 /***************************************************************** | |
498 * No fields below this line are part of the public API. They | |
499 * may not be used outside of libavformat and can be changed and | |
500 * removed at will. | |
501 * New public fields should be added right above. | |
502 ***************************************************************** | |
503 */ | |
504 struct AVInputFormat *next; | |
505 | |
506 /** | |
507 * Raw demuxers store their codec ID here. | |
508 */ | |
509 int raw_codec_id; | |
510 | |
511 /** | |
512 * Size of private data so that it can be allocated in the wrapper. | |
513 */ | |
514 int priv_data_size; | |
515 | |
516 /** | |
517 * Tell if a given file has a chance of being parsed as this format. | |
518 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes | |
519 * big so you do not have to check for that unless you need more. | |
520 */ | |
521 int (*read_probe)(AVProbeData *); | |
522 | |
523 /** | |
524 * Read the format header and initialize the AVFormatContext | |
525 * structure. Return 0 if OK. Only used in raw format right | |
526 * now. 'avformat_new_stream' should be called to create new streams. | |
527 */ | |
528 int (*read_header)(struct AVFormatContext *); | |
529 | |
530 /** | |
531 * Read one packet and put it in 'pkt'. pts and flags are also | |
532 * set. 'avformat_new_stream' can be called only if the flag | |
533 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a | |
534 * background thread). | |
535 * @return 0 on success, < 0 on error. | |
536 * When returning an error, pkt must not have been allocated | |
537 * or must be freed before returning | |
538 */ | |
539 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt); | |
540 | |
541 /** | |
542 * Close the stream. The AVFormatContext and AVStreams are not | |
543 * freed by this function | |
544 */ | |
545 int (*read_close)(struct AVFormatContext *); | |
546 | |
547 /** | |
548 * Seek to a given timestamp relative to the frames in | |
549 * stream component stream_index. | |
550 * @param stream_index Must not be -1. | |
551 * @param flags Selects which direction should be preferred if no exact | |
552 * match is available. | |
553 * @return >= 0 on success (but not necessarily the new offset) | |
554 */ | |
555 int (*read_seek)(struct AVFormatContext *, | |
556 int stream_index, int64_t timestamp, int flags); | |
557 | |
558 /** | |
559 * Get the next timestamp in stream[stream_index].time_base units. | |
560 * @return the timestamp or AV_NOPTS_VALUE if an error occurred | |
561 */ | |
562 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index, | |
563 int64_t *pos, int64_t pos_limit); | |
564 | |
565 /** | |
566 * Start/resume playing - only meaningful if using a network-based format | |
567 * (RTSP). | |
568 */ | |
569 int (*read_play)(struct AVFormatContext *); | |
570 | |
571 /** | |
572 * Pause playing - only meaningful if using a network-based format | |
573 * (RTSP). | |
574 */ | |
575 int (*read_pause)(struct AVFormatContext *); | |
576 | |
577 /** | |
578 * Seek to timestamp ts. | |
579 * Seeking will be done so that the point from which all active streams | |
580 * can be presented successfully will be closest to ts and within min/max_ts. | |
581 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
582 */ | |
583 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); | |
584 } AVInputFormat; | |
585 /** | |
586 * @} | |
587 */ | |
588 | |
589 enum AVStreamParseType { | |
590 AVSTREAM_PARSE_NONE, | |
591 AVSTREAM_PARSE_FULL, /**< full parsing and repack */ | |
592 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ | |
593 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ | |
594 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */ | |
595 AVSTREAM_PARSE_FULL_RAW=MKTAG(0,'R','A','W'), /**< full parsing and repack with timestamp and position generation by parser for raw | |
596 this assumes that each packet in the file contains no demuxer level headers and | |
597 just codec level data, otherwise position generation would fail */ | |
598 }; | |
599 | |
600 typedef struct AVIndexEntry { | |
601 int64_t pos; | |
602 int64_t timestamp; /**< | |
603 * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available | |
604 * when seeking to this entry. That means preferable PTS on keyframe based formats. | |
605 * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better | |
606 * is known | |
607 */ | |
608 #define AVINDEX_KEYFRAME 0x0001 | |
609 int flags:2; | |
610 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). | |
611 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ | |
612 } AVIndexEntry; | |
613 | |
614 #define AV_DISPOSITION_DEFAULT 0x0001 | |
615 #define AV_DISPOSITION_DUB 0x0002 | |
616 #define AV_DISPOSITION_ORIGINAL 0x0004 | |
617 #define AV_DISPOSITION_COMMENT 0x0008 | |
618 #define AV_DISPOSITION_LYRICS 0x0010 | |
619 #define AV_DISPOSITION_KARAOKE 0x0020 | |
620 | |
621 /** | |
622 * Track should be used during playback by default. | |
623 * Useful for subtitle track that should be displayed | |
624 * even when user did not explicitly ask for subtitles. | |
625 */ | |
626 #define AV_DISPOSITION_FORCED 0x0040 | |
627 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */ | |
628 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */ | |
629 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */ | |
630 /** | |
631 * The stream is stored in the file as an attached picture/"cover art" (e.g. | |
632 * APIC frame in ID3v2). The single packet associated with it will be returned | |
633 * among the first few packets read from the file unless seeking takes place. | |
634 * It can also be accessed at any time in AVStream.attached_pic. | |
635 */ | |
636 #define AV_DISPOSITION_ATTACHED_PIC 0x0400 | |
637 | |
638 /** | |
639 * Options for behavior on timestamp wrap detection. | |
640 */ | |
641 #define AV_PTS_WRAP_IGNORE 0 ///< ignore the wrap | |
642 #define AV_PTS_WRAP_ADD_OFFSET 1 ///< add the format specific offset on wrap detection | |
643 #define AV_PTS_WRAP_SUB_OFFSET -1 ///< subtract the format specific offset on wrap detection | |
644 | |
645 /** | |
646 * Stream structure. | |
647 * New fields can be added to the end with minor version bumps. | |
648 * Removal, reordering and changes to existing fields require a major | |
649 * version bump. | |
650 * sizeof(AVStream) must not be used outside libav*. | |
651 */ | |
652 typedef struct AVStream { | |
653 int index; /**< stream index in AVFormatContext */ | |
654 /** | |
655 * Format-specific stream ID. | |
656 * decoding: set by libavformat | |
657 * encoding: set by the user, replaced by libavformat if left unset | |
658 */ | |
659 int id; | |
660 /** | |
661 * Codec context associated with this stream. Allocated and freed by | |
662 * libavformat. | |
663 * | |
664 * - decoding: The demuxer exports codec information stored in the headers | |
665 * here. | |
666 * - encoding: The user sets codec information, the muxer writes it to the | |
667 * output. Mandatory fields as specified in AVCodecContext | |
668 * documentation must be set even if this AVCodecContext is | |
669 * not actually used for encoding. | |
670 */ | |
671 AVCodecContext *codec; | |
672 void *priv_data; | |
673 | |
674 /** | |
675 * encoding: pts generation when outputting stream | |
676 */ | |
677 struct AVFrac pts; | |
678 | |
679 /** | |
680 * This is the fundamental unit of time (in seconds) in terms | |
681 * of which frame timestamps are represented. | |
682 * | |
683 * decoding: set by libavformat | |
684 * encoding: set by libavformat in avformat_write_header. The muxer may use the | |
685 * user-provided value of @ref AVCodecContext.time_base "codec->time_base" | |
686 * as a hint. | |
687 */ | |
688 AVRational time_base; | |
689 | |
690 /** | |
691 * Decoding: pts of the first frame of the stream in presentation order, in stream time base. | |
692 * Only set this if you are absolutely 100% sure that the value you set | |
693 * it to really is the pts of the first frame. | |
694 * This may be undefined (AV_NOPTS_VALUE). | |
695 * @note The ASF header does NOT contain a correct start_time the ASF | |
696 * demuxer must NOT set this. | |
697 */ | |
698 int64_t start_time; | |
699 | |
700 /** | |
701 * Decoding: duration of the stream, in stream time base. | |
702 * If a source file does not specify a duration, but does specify | |
703 * a bitrate, this value will be estimated from bitrate and file size. | |
704 */ | |
705 int64_t duration; | |
706 | |
707 int64_t nb_frames; ///< number of frames in this stream if known or 0 | |
708 | |
709 int disposition; /**< AV_DISPOSITION_* bit field */ | |
710 | |
711 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. | |
712 | |
713 /** | |
714 * sample aspect ratio (0 if unknown) | |
715 * - encoding: Set by user. | |
716 * - decoding: Set by libavformat. | |
717 */ | |
718 AVRational sample_aspect_ratio; | |
719 | |
720 AVDictionary *metadata; | |
721 | |
722 /** | |
723 * Average framerate | |
724 */ | |
725 AVRational avg_frame_rate; | |
726 | |
727 /** | |
728 * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet | |
729 * will contain the attached picture. | |
730 * | |
731 * decoding: set by libavformat, must not be modified by the caller. | |
732 * encoding: unused | |
733 */ | |
734 AVPacket attached_pic; | |
735 | |
736 /** | |
737 * Real base framerate of the stream. | |
738 * This is the lowest framerate with which all timestamps can be | |
739 * represented accurately (it is the least common multiple of all | |
740 * framerates in the stream). Note, this value is just a guess! | |
741 * For example, if the time base is 1/90000 and all frames have either | |
742 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. | |
743 * | |
744 * Code outside avformat should access this field using: | |
745 * av_stream_get/set_r_frame_rate(stream) | |
746 */ | |
747 AVRational r_frame_rate; | |
748 | |
749 /***************************************************************** | |
750 * All fields below this line are not part of the public API. They | |
751 * may not be used outside of libavformat and can be changed and | |
752 * removed at will. | |
753 * New public fields should be added right above. | |
754 ***************************************************************** | |
755 */ | |
756 | |
757 /** | |
758 * Stream information used internally by av_find_stream_info() | |
759 */ | |
760 #define MAX_STD_TIMEBASES (60*12+6) | |
761 struct { | |
762 int64_t last_dts; | |
763 int64_t duration_gcd; | |
764 int duration_count; | |
765 double (*duration_error)[2][MAX_STD_TIMEBASES]; | |
766 int64_t codec_info_duration; | |
767 int64_t codec_info_duration_fields; | |
768 int found_decoder; | |
769 | |
770 int64_t last_duration; | |
771 | |
772 /** | |
773 * Those are used for average framerate estimation. | |
774 */ | |
775 int64_t fps_first_dts; | |
776 int fps_first_dts_idx; | |
777 int64_t fps_last_dts; | |
778 int fps_last_dts_idx; | |
779 | |
780 } *info; | |
781 | |
782 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ | |
783 | |
784 // Timestamp generation support: | |
785 /** | |
786 * Timestamp corresponding to the last dts sync point. | |
787 * | |
788 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and | |
789 * a DTS is received from the underlying container. Otherwise set to | |
790 * AV_NOPTS_VALUE by default. | |
791 */ | |
792 int64_t reference_dts; | |
793 int64_t first_dts; | |
794 int64_t cur_dts; | |
795 int64_t last_IP_pts; | |
796 int last_IP_duration; | |
797 | |
798 /** | |
799 * Number of packets to buffer for codec probing | |
800 */ | |
801 #define MAX_PROBE_PACKETS 2500 | |
802 int probe_packets; | |
803 | |
804 /** | |
805 * Number of frames that have been demuxed during av_find_stream_info() | |
806 */ | |
807 int codec_info_nb_frames; | |
808 | |
809 /** | |
810 * Stream Identifier | |
811 * This is the MPEG-TS stream identifier +1 | |
812 * 0 means unknown | |
813 */ | |
814 int stream_identifier; | |
815 | |
816 int64_t interleaver_chunk_size; | |
817 int64_t interleaver_chunk_duration; | |
818 | |
819 /* av_read_frame() support */ | |
820 enum AVStreamParseType need_parsing; | |
821 struct AVCodecParserContext *parser; | |
822 | |
823 /** | |
824 * last packet in packet_buffer for this stream when muxing. | |
825 */ | |
826 struct AVPacketList *last_in_packet_buffer; | |
827 AVProbeData probe_data; | |
828 #define MAX_REORDER_DELAY 16 | |
829 int64_t pts_buffer[MAX_REORDER_DELAY+1]; | |
830 | |
831 AVIndexEntry *index_entries; /**< Only used if the format does not | |
832 support seeking natively. */ | |
833 int nb_index_entries; | |
834 unsigned int index_entries_allocated_size; | |
835 | |
836 /** | |
837 * stream probing state | |
838 * -1 -> probing finished | |
839 * 0 -> no probing requested | |
840 * rest -> perform probing with request_probe being the minimum score to accept. | |
841 * NOT PART OF PUBLIC API | |
842 */ | |
843 int request_probe; | |
844 /** | |
845 * Indicates that everything up to the next keyframe | |
846 * should be discarded. | |
847 */ | |
848 int skip_to_keyframe; | |
849 | |
850 /** | |
851 * Number of samples to skip at the start of the frame decoded from the next packet. | |
852 */ | |
853 int skip_samples; | |
854 | |
855 /** | |
856 * Number of internally decoded frames, used internally in libavformat, do not access | |
857 * its lifetime differs from info which is why it is not in that structure. | |
858 */ | |
859 int nb_decoded_frames; | |
860 | |
861 /** | |
862 * Timestamp offset added to timestamps before muxing | |
863 * NOT PART OF PUBLIC API | |
864 */ | |
865 int64_t mux_ts_offset; | |
866 | |
867 /** | |
868 * Internal data to check for wrapping of the time stamp | |
869 */ | |
870 int64_t pts_wrap_reference; | |
871 | |
872 /** | |
873 * Options for behavior, when a wrap is detected. | |
874 * | |
875 * Defined by AV_PTS_WRAP_ values. | |
876 * | |
877 * If correction is enabled, there are two possibilities: | |
878 * If the first time stamp is near the wrap point, the wrap offset | |
879 * will be subtracted, which will create negative time stamps. | |
880 * Otherwise the offset will be added. | |
881 */ | |
882 int pts_wrap_behavior; | |
883 | |
884 } AVStream; | |
885 | |
886 AVRational av_stream_get_r_frame_rate(const AVStream *s); | |
887 void av_stream_set_r_frame_rate(AVStream *s, AVRational r); | |
888 | |
889 #define AV_PROGRAM_RUNNING 1 | |
890 | |
891 /** | |
892 * New fields can be added to the end with minor version bumps. | |
893 * Removal, reordering and changes to existing fields require a major | |
894 * version bump. | |
895 * sizeof(AVProgram) must not be used outside libav*. | |
896 */ | |
897 typedef struct AVProgram { | |
898 int id; | |
899 int flags; | |
900 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller | |
901 unsigned int *stream_index; | |
902 unsigned int nb_stream_indexes; | |
903 AVDictionary *metadata; | |
904 | |
905 int program_num; | |
906 int pmt_pid; | |
907 int pcr_pid; | |
908 | |
909 /***************************************************************** | |
910 * All fields below this line are not part of the public API. They | |
911 * may not be used outside of libavformat and can be changed and | |
912 * removed at will. | |
913 * New public fields should be added right above. | |
914 ***************************************************************** | |
915 */ | |
916 int64_t start_time; | |
917 int64_t end_time; | |
918 | |
919 int64_t pts_wrap_reference; ///< reference dts for wrap detection | |
920 int pts_wrap_behavior; ///< behavior on wrap detection | |
921 } AVProgram; | |
922 | |
923 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present | |
924 (streams are added dynamically) */ | |
925 | |
926 typedef struct AVChapter { | |
927 int id; ///< unique ID to identify the chapter | |
928 AVRational time_base; ///< time base in which the start/end timestamps are specified | |
929 int64_t start, end; ///< chapter start/end time in time_base units | |
930 AVDictionary *metadata; | |
931 } AVChapter; | |
932 | |
933 | |
934 /** | |
935 * The duration of a video can be estimated through various ways, and this enum can be used | |
936 * to know how the duration was estimated. | |
937 */ | |
938 enum AVDurationEstimationMethod { | |
939 AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes | |
940 AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration | |
941 AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate) | |
942 }; | |
943 | |
944 /** | |
945 * Format I/O context. | |
946 * New fields can be added to the end with minor version bumps. | |
947 * Removal, reordering and changes to existing fields require a major | |
948 * version bump. | |
949 * sizeof(AVFormatContext) must not be used outside libav*, use | |
950 * avformat_alloc_context() to create an AVFormatContext. | |
951 */ | |
952 typedef struct AVFormatContext { | |
953 /** | |
954 * A class for logging and AVOptions. Set by avformat_alloc_context(). | |
955 * Exports (de)muxer private options if they exist. | |
956 */ | |
957 const AVClass *av_class; | |
958 | |
959 /** | |
960 * Can only be iformat or oformat, not both at the same time. | |
961 * | |
962 * decoding: set by avformat_open_input(). | |
963 * encoding: set by the user. | |
964 */ | |
965 struct AVInputFormat *iformat; | |
966 struct AVOutputFormat *oformat; | |
967 | |
968 /** | |
969 * Format private data. This is an AVOptions-enabled struct | |
970 * if and only if iformat/oformat.priv_class is not NULL. | |
971 */ | |
972 void *priv_data; | |
973 | |
974 /** | |
975 * I/O context. | |
976 * | |
977 * decoding: either set by the user before avformat_open_input() (then | |
978 * the user must close it manually) or set by avformat_open_input(). | |
979 * encoding: set by the user. | |
980 * | |
981 * Do NOT set this field if AVFMT_NOFILE flag is set in | |
982 * iformat/oformat.flags. In such a case, the (de)muxer will handle | |
983 * I/O in some other way and this field will be NULL. | |
984 */ | |
985 AVIOContext *pb; | |
986 | |
987 /* stream info */ | |
988 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */ | |
989 | |
990 /** | |
991 * A list of all streams in the file. New streams are created with | |
992 * avformat_new_stream(). | |
993 * | |
994 * decoding: streams are created by libavformat in avformat_open_input(). | |
995 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also | |
996 * appear in av_read_frame(). | |
997 * encoding: streams are created by the user before avformat_write_header(). | |
998 */ | |
999 unsigned int nb_streams; | |
1000 AVStream **streams; | |
1001 | |
1002 char filename[1024]; /**< input or output filename */ | |
1003 | |
1004 /** | |
1005 * Decoding: position of the first frame of the component, in | |
1006 * AV_TIME_BASE fractional seconds. NEVER set this value directly: | |
1007 * It is deduced from the AVStream values. | |
1008 */ | |
1009 int64_t start_time; | |
1010 | |
1011 /** | |
1012 * Decoding: duration of the stream, in AV_TIME_BASE fractional | |
1013 * seconds. Only set this value if you know none of the individual stream | |
1014 * durations and also do not set any of them. This is deduced from the | |
1015 * AVStream values if not set. | |
1016 */ | |
1017 int64_t duration; | |
1018 | |
1019 /** | |
1020 * Decoding: total stream bitrate in bit/s, 0 if not | |
1021 * available. Never set it directly if the file_size and the | |
1022 * duration are known as FFmpeg can compute it automatically. | |
1023 */ | |
1024 int bit_rate; | |
1025 | |
1026 unsigned int packet_size; | |
1027 int max_delay; | |
1028 | |
1029 int flags; | |
1030 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. | |
1031 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. | |
1032 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. | |
1033 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS | |
1034 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container | |
1035 #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 | |
1036 #define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible | |
1037 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it. | |
1038 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted | |
1039 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload | |
1040 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down) | |
1041 #define AVFMT_FLAG_PRIV_OPT 0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted) | |
1042 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Don't merge side data but keep it separate. | |
1043 | |
1044 /** | |
1045 * decoding: size of data to probe; encoding: unused. | |
1046 */ | |
1047 unsigned int probesize; | |
1048 | |
1049 /** | |
1050 * decoding: maximum time (in AV_TIME_BASE units) during which the input should | |
1051 * be analyzed in avformat_find_stream_info(). | |
1052 */ | |
1053 int max_analyze_duration; | |
1054 | |
1055 const uint8_t *key; | |
1056 int keylen; | |
1057 | |
1058 unsigned int nb_programs; | |
1059 AVProgram **programs; | |
1060 | |
1061 /** | |
1062 * Forced video codec_id. | |
1063 * Demuxing: Set by user. | |
1064 */ | |
1065 enum AVCodecID video_codec_id; | |
1066 | |
1067 /** | |
1068 * Forced audio codec_id. | |
1069 * Demuxing: Set by user. | |
1070 */ | |
1071 enum AVCodecID audio_codec_id; | |
1072 | |
1073 /** | |
1074 * Forced subtitle codec_id. | |
1075 * Demuxing: Set by user. | |
1076 */ | |
1077 enum AVCodecID subtitle_codec_id; | |
1078 | |
1079 /** | |
1080 * Maximum amount of memory in bytes to use for the index of each stream. | |
1081 * If the index exceeds this size, entries will be discarded as | |
1082 * needed to maintain a smaller size. This can lead to slower or less | |
1083 * accurate seeking (depends on demuxer). | |
1084 * Demuxers for which a full in-memory index is mandatory will ignore | |
1085 * this. | |
1086 * muxing : unused | |
1087 * demuxing: set by user | |
1088 */ | |
1089 unsigned int max_index_size; | |
1090 | |
1091 /** | |
1092 * Maximum amount of memory in bytes to use for buffering frames | |
1093 * obtained from realtime capture devices. | |
1094 */ | |
1095 unsigned int max_picture_buffer; | |
1096 | |
1097 unsigned int nb_chapters; | |
1098 AVChapter **chapters; | |
1099 | |
1100 AVDictionary *metadata; | |
1101 | |
1102 /** | |
1103 * Start time of the stream in real world time, in microseconds | |
1104 * since the unix epoch (00:00 1st January 1970). That is, pts=0 | |
1105 * in the stream was captured at this real world time. | |
1106 * - encoding: Set by user. | |
1107 * - decoding: Unused. | |
1108 */ | |
1109 int64_t start_time_realtime; | |
1110 | |
1111 /** | |
1112 * decoding: number of frames used to probe fps | |
1113 */ | |
1114 int fps_probe_size; | |
1115 | |
1116 /** | |
1117 * Error recognition; higher values will detect more errors but may | |
1118 * misdetect some more or less valid parts as errors. | |
1119 * - encoding: unused | |
1120 * - decoding: Set by user. | |
1121 */ | |
1122 int error_recognition; | |
1123 | |
1124 /** | |
1125 * Custom interrupt callbacks for the I/O layer. | |
1126 * | |
1127 * decoding: set by the user before avformat_open_input(). | |
1128 * encoding: set by the user before avformat_write_header() | |
1129 * (mainly useful for AVFMT_NOFILE formats). The callback | |
1130 * should also be passed to avio_open2() if it's used to | |
1131 * open the file. | |
1132 */ | |
1133 AVIOInterruptCB interrupt_callback; | |
1134 | |
1135 /** | |
1136 * Flags to enable debugging. | |
1137 */ | |
1138 int debug; | |
1139 #define FF_FDEBUG_TS 0x0001 | |
1140 | |
1141 /** | |
1142 * Transport stream id. | |
1143 * This will be moved into demuxer private options. Thus no API/ABI compatibility | |
1144 */ | |
1145 int ts_id; | |
1146 | |
1147 /** | |
1148 * Audio preload in microseconds. | |
1149 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. | |
1150 * - encoding: Set by user via AVOptions (NO direct access) | |
1151 * - decoding: unused | |
1152 */ | |
1153 int audio_preload; | |
1154 | |
1155 /** | |
1156 * Max chunk time in microseconds. | |
1157 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. | |
1158 * - encoding: Set by user via AVOptions (NO direct access) | |
1159 * - decoding: unused | |
1160 */ | |
1161 int max_chunk_duration; | |
1162 | |
1163 /** | |
1164 * Max chunk size in bytes | |
1165 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. | |
1166 * - encoding: Set by user via AVOptions (NO direct access) | |
1167 * - decoding: unused | |
1168 */ | |
1169 int max_chunk_size; | |
1170 | |
1171 /** | |
1172 * forces the use of wallclock timestamps as pts/dts of packets | |
1173 * This has undefined results in the presence of B frames. | |
1174 * - encoding: unused | |
1175 * - decoding: Set by user via AVOptions (NO direct access) | |
1176 */ | |
1177 int use_wallclock_as_timestamps; | |
1178 | |
1179 /** | |
1180 * Avoid negative timestamps during muxing. | |
1181 * 0 -> allow negative timestamps | |
1182 * 1 -> avoid negative timestamps | |
1183 * -1 -> choose automatically (default) | |
1184 * Note, this only works when interleave_packet_per_dts is in use. | |
1185 * - encoding: Set by user via AVOptions (NO direct access) | |
1186 * - decoding: unused | |
1187 */ | |
1188 int avoid_negative_ts; | |
1189 | |
1190 /** | |
1191 * avio flags, used to force AVIO_FLAG_DIRECT. | |
1192 * - encoding: unused | |
1193 * - decoding: Set by user via AVOptions (NO direct access) | |
1194 */ | |
1195 int avio_flags; | |
1196 | |
1197 /** | |
1198 * The duration field can be estimated through various ways, and this field can be used | |
1199 * to know how the duration was estimated. | |
1200 * - encoding: unused | |
1201 * - decoding: Read by user via AVOptions (NO direct access) | |
1202 */ | |
1203 enum AVDurationEstimationMethod duration_estimation_method; | |
1204 | |
1205 /** | |
1206 * Skip initial bytes when opening stream | |
1207 * - encoding: unused | |
1208 * - decoding: Set by user via AVOptions (NO direct access) | |
1209 */ | |
1210 unsigned int skip_initial_bytes; | |
1211 | |
1212 /** | |
1213 * Correct single timestamp overflows | |
1214 * - encoding: unused | |
1215 * - decoding: Set by user via AVOPtions (NO direct access) | |
1216 */ | |
1217 unsigned int correct_ts_overflow; | |
1218 | |
1219 /** | |
1220 * Force seeking to any (also non key) frames. | |
1221 * - encoding: unused | |
1222 * - decoding: Set by user via AVOPtions (NO direct access) | |
1223 */ | |
1224 int seek2any; | |
1225 | |
1226 /** | |
1227 * Flush the I/O context after each packet. | |
1228 * - encoding: Set by user via AVOptions (NO direct access) | |
1229 * - decoding: unused | |
1230 */ | |
1231 int flush_packets; | |
1232 | |
1233 /***************************************************************** | |
1234 * All fields below this line are not part of the public API. They | |
1235 * may not be used outside of libavformat and can be changed and | |
1236 * removed at will. | |
1237 * New public fields should be added right above. | |
1238 ***************************************************************** | |
1239 */ | |
1240 | |
1241 /** | |
1242 * This buffer is only needed when packets were already buffered but | |
1243 * not decoded, for example to get the codec parameters in MPEG | |
1244 * streams. | |
1245 */ | |
1246 struct AVPacketList *packet_buffer; | |
1247 struct AVPacketList *packet_buffer_end; | |
1248 | |
1249 /* av_seek_frame() support */ | |
1250 int64_t data_offset; /**< offset of the first packet */ | |
1251 | |
1252 /** | |
1253 * Raw packets from the demuxer, prior to parsing and decoding. | |
1254 * This buffer is used for buffering packets until the codec can | |
1255 * be identified, as parsing cannot be done without knowing the | |
1256 * codec. | |
1257 */ | |
1258 struct AVPacketList *raw_packet_buffer; | |
1259 struct AVPacketList *raw_packet_buffer_end; | |
1260 /** | |
1261 * Packets split by the parser get queued here. | |
1262 */ | |
1263 struct AVPacketList *parse_queue; | |
1264 struct AVPacketList *parse_queue_end; | |
1265 /** | |
1266 * Remaining size available for raw_packet_buffer, in bytes. | |
1267 */ | |
1268 #define RAW_PACKET_BUFFER_SIZE 2500000 | |
1269 int raw_packet_buffer_remaining_size; | |
1270 | |
1271 /** | |
1272 * Offset to remap timestamps to be non-negative. | |
1273 * Expressed in timebase units. | |
1274 * @see AVStream.mux_ts_offset | |
1275 */ | |
1276 int64_t offset; | |
1277 | |
1278 /** | |
1279 * Timebase for the timestamp offset. | |
1280 */ | |
1281 AVRational offset_timebase; | |
1282 | |
1283 /** | |
1284 * IO repositioned flag. | |
1285 * This is set by avformat when the underlaying IO context read pointer | |
1286 * is repositioned, for example when doing byte based seeking. | |
1287 * Demuxers can use the flag to detect such changes. | |
1288 */ | |
1289 int io_repositioned; | |
1290 } AVFormatContext; | |
1291 | |
1292 /** | |
1293 * Returns the method used to set ctx->duration. | |
1294 * | |
1295 * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE. | |
1296 */ | |
1297 enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext* ctx); | |
1298 | |
1299 typedef struct AVPacketList { | |
1300 AVPacket pkt; | |
1301 struct AVPacketList *next; | |
1302 } AVPacketList; | |
1303 | |
1304 | |
1305 /** | |
1306 * @defgroup lavf_core Core functions | |
1307 * @ingroup libavf | |
1308 * | |
1309 * Functions for querying libavformat capabilities, allocating core structures, | |
1310 * etc. | |
1311 * @{ | |
1312 */ | |
1313 | |
1314 /** | |
1315 * Return the LIBAVFORMAT_VERSION_INT constant. | |
1316 */ | |
1317 unsigned avformat_version(void); | |
1318 | |
1319 /** | |
1320 * Return the libavformat build-time configuration. | |
1321 */ | |
1322 const char *avformat_configuration(void); | |
1323 | |
1324 /** | |
1325 * Return the libavformat license. | |
1326 */ | |
1327 const char *avformat_license(void); | |
1328 | |
1329 /** | |
1330 * Initialize libavformat and register all the muxers, demuxers and | |
1331 * protocols. If you do not call this function, then you can select | |
1332 * exactly which formats you want to support. | |
1333 * | |
1334 * @see av_register_input_format() | |
1335 * @see av_register_output_format() | |
1336 */ | |
1337 void av_register_all(void); | |
1338 | |
1339 void av_register_input_format(AVInputFormat *format); | |
1340 void av_register_output_format(AVOutputFormat *format); | |
1341 | |
1342 /** | |
1343 * Do global initialization of network components. This is optional, | |
1344 * but recommended, since it avoids the overhead of implicitly | |
1345 * doing the setup for each session. | |
1346 * | |
1347 * Calling this function will become mandatory if using network | |
1348 * protocols at some major version bump. | |
1349 */ | |
1350 int avformat_network_init(void); | |
1351 | |
1352 /** | |
1353 * Undo the initialization done by avformat_network_init. | |
1354 */ | |
1355 int avformat_network_deinit(void); | |
1356 | |
1357 /** | |
1358 * If f is NULL, returns the first registered input format, | |
1359 * if f is non-NULL, returns the next registered input format after f | |
1360 * or NULL if f is the last one. | |
1361 */ | |
1362 AVInputFormat *av_iformat_next(AVInputFormat *f); | |
1363 | |
1364 /** | |
1365 * If f is NULL, returns the first registered output format, | |
1366 * if f is non-NULL, returns the next registered output format after f | |
1367 * or NULL if f is the last one. | |
1368 */ | |
1369 AVOutputFormat *av_oformat_next(AVOutputFormat *f); | |
1370 | |
1371 /** | |
1372 * Allocate an AVFormatContext. | |
1373 * avformat_free_context() can be used to free the context and everything | |
1374 * allocated by the framework within it. | |
1375 */ | |
1376 AVFormatContext *avformat_alloc_context(void); | |
1377 | |
1378 /** | |
1379 * Free an AVFormatContext and all its streams. | |
1380 * @param s context to free | |
1381 */ | |
1382 void avformat_free_context(AVFormatContext *s); | |
1383 | |
1384 /** | |
1385 * Get the AVClass for AVFormatContext. It can be used in combination with | |
1386 * AV_OPT_SEARCH_FAKE_OBJ for examining options. | |
1387 * | |
1388 * @see av_opt_find(). | |
1389 */ | |
1390 const AVClass *avformat_get_class(void); | |
1391 | |
1392 /** | |
1393 * Add a new stream to a media file. | |
1394 * | |
1395 * When demuxing, it is called by the demuxer in read_header(). If the | |
1396 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also | |
1397 * be called in read_packet(). | |
1398 * | |
1399 * When muxing, should be called by the user before avformat_write_header(). | |
1400 * | |
1401 * @param c If non-NULL, the AVCodecContext corresponding to the new stream | |
1402 * will be initialized to use this codec. This is needed for e.g. codec-specific | |
1403 * defaults to be set, so codec should be provided if it is known. | |
1404 * | |
1405 * @return newly created stream or NULL on error. | |
1406 */ | |
1407 AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c); | |
1408 | |
1409 AVProgram *av_new_program(AVFormatContext *s, int id); | |
1410 | |
1411 /** | |
1412 * @} | |
1413 */ | |
1414 | |
1415 | |
1416 #if FF_API_PKT_DUMP | |
1417 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); | |
1418 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, | |
1419 int dump_payload); | |
1420 #endif | |
1421 | |
1422 #if FF_API_ALLOC_OUTPUT_CONTEXT | |
1423 /** | |
1424 * @deprecated deprecated in favor of avformat_alloc_output_context2() | |
1425 */ | |
1426 attribute_deprecated | |
1427 AVFormatContext *avformat_alloc_output_context(const char *format, | |
1428 AVOutputFormat *oformat, | |
1429 const char *filename); | |
1430 #endif | |
1431 | |
1432 /** | |
1433 * Allocate an AVFormatContext for an output format. | |
1434 * avformat_free_context() can be used to free the context and | |
1435 * everything allocated by the framework within it. | |
1436 * | |
1437 * @param *ctx is set to the created format context, or to NULL in | |
1438 * case of failure | |
1439 * @param oformat format to use for allocating the context, if NULL | |
1440 * format_name and filename are used instead | |
1441 * @param format_name the name of output format to use for allocating the | |
1442 * context, if NULL filename is used instead | |
1443 * @param filename the name of the filename to use for allocating the | |
1444 * context, may be NULL | |
1445 * @return >= 0 in case of success, a negative AVERROR code in case of | |
1446 * failure | |
1447 */ | |
1448 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat, | |
1449 const char *format_name, const char *filename); | |
1450 | |
1451 /** | |
1452 * @addtogroup lavf_decoding | |
1453 * @{ | |
1454 */ | |
1455 | |
1456 /** | |
1457 * Find AVInputFormat based on the short name of the input format. | |
1458 */ | |
1459 AVInputFormat *av_find_input_format(const char *short_name); | |
1460 | |
1461 /** | |
1462 * Guess the file format. | |
1463 * | |
1464 * @param is_opened Whether the file is already opened; determines whether | |
1465 * demuxers with or without AVFMT_NOFILE are probed. | |
1466 */ | |
1467 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); | |
1468 | |
1469 /** | |
1470 * Guess the file format. | |
1471 * | |
1472 * @param is_opened Whether the file is already opened; determines whether | |
1473 * demuxers with or without AVFMT_NOFILE are probed. | |
1474 * @param score_max A probe score larger that this is required to accept a | |
1475 * detection, the variable is set to the actual detection | |
1476 * score afterwards. | |
1477 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended | |
1478 * to retry with a larger probe buffer. | |
1479 */ | |
1480 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max); | |
1481 | |
1482 /** | |
1483 * Guess the file format. | |
1484 * | |
1485 * @param is_opened Whether the file is already opened; determines whether | |
1486 * demuxers with or without AVFMT_NOFILE are probed. | |
1487 * @param score_ret The score of the best detection. | |
1488 */ | |
1489 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret); | |
1490 | |
1491 /** | |
1492 * Probe a bytestream to determine the input format. Each time a probe returns | |
1493 * with a score that is too low, the probe buffer size is increased and another | |
1494 * attempt is made. When the maximum probe size is reached, the input format | |
1495 * with the highest score is returned. | |
1496 * | |
1497 * @param pb the bytestream to probe | |
1498 * @param fmt the input format is put here | |
1499 * @param filename the filename of the stream | |
1500 * @param logctx the log context | |
1501 * @param offset the offset within the bytestream to probe from | |
1502 * @param max_probe_size the maximum probe buffer size (zero for default) | |
1503 * @return 0 in case of success, a negative value corresponding to an | |
1504 * AVERROR code otherwise | |
1505 */ | |
1506 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt, | |
1507 const char *filename, void *logctx, | |
1508 unsigned int offset, unsigned int max_probe_size); | |
1509 | |
1510 /** | |
1511 * Open an input stream and read the header. The codecs are not opened. | |
1512 * The stream must be closed with av_close_input_file(). | |
1513 * | |
1514 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context). | |
1515 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this | |
1516 * function and written into ps. | |
1517 * Note that a user-supplied AVFormatContext will be freed on failure. | |
1518 * @param filename Name of the stream to open. | |
1519 * @param fmt If non-NULL, this parameter forces a specific input format. | |
1520 * Otherwise the format is autodetected. | |
1521 * @param options A dictionary filled with AVFormatContext and demuxer-private options. | |
1522 * On return this parameter will be destroyed and replaced with a dict containing | |
1523 * options that were not found. May be NULL. | |
1524 * | |
1525 * @return 0 on success, a negative AVERROR on failure. | |
1526 * | |
1527 * @note If you want to use custom IO, preallocate the format context and set its pb field. | |
1528 */ | |
1529 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options); | |
1530 | |
1531 attribute_deprecated | |
1532 int av_demuxer_open(AVFormatContext *ic); | |
1533 | |
1534 #if FF_API_FORMAT_PARAMETERS | |
1535 /** | |
1536 * Read packets of a media file to get stream information. This | |
1537 * is useful for file formats with no headers such as MPEG. This | |
1538 * function also computes the real framerate in case of MPEG-2 repeat | |
1539 * frame mode. | |
1540 * The logical file position is not changed by this function; | |
1541 * examined packets may be buffered for later processing. | |
1542 * | |
1543 * @param ic media file handle | |
1544 * @return >=0 if OK, AVERROR_xxx on error | |
1545 * @todo Let the user decide somehow what information is needed so that | |
1546 * we do not waste time getting stuff the user does not need. | |
1547 * | |
1548 * @deprecated use avformat_find_stream_info. | |
1549 */ | |
1550 attribute_deprecated | |
1551 int av_find_stream_info(AVFormatContext *ic); | |
1552 #endif | |
1553 | |
1554 /** | |
1555 * Read packets of a media file to get stream information. This | |
1556 * is useful for file formats with no headers such as MPEG. This | |
1557 * function also computes the real framerate in case of MPEG-2 repeat | |
1558 * frame mode. | |
1559 * The logical file position is not changed by this function; | |
1560 * examined packets may be buffered for later processing. | |
1561 * | |
1562 * @param ic media file handle | |
1563 * @param options If non-NULL, an ic.nb_streams long array of pointers to | |
1564 * dictionaries, where i-th member contains options for | |
1565 * codec corresponding to i-th stream. | |
1566 * On return each dictionary will be filled with options that were not found. | |
1567 * @return >=0 if OK, AVERROR_xxx on error | |
1568 * | |
1569 * @note this function isn't guaranteed to open all the codecs, so | |
1570 * options being non-empty at return is a perfectly normal behavior. | |
1571 * | |
1572 * @todo Let the user decide somehow what information is needed so that | |
1573 * we do not waste time getting stuff the user does not need. | |
1574 */ | |
1575 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options); | |
1576 | |
1577 /** | |
1578 * Find the programs which belong to a given stream. | |
1579 * | |
1580 * @param ic media file handle | |
1581 * @param last the last found program, the search will start after this | |
1582 * program, or from the beginning if it is NULL | |
1583 * @param s stream index | |
1584 * @return the next program which belongs to s, NULL if no program is found or | |
1585 * the last program is not among the programs of ic. | |
1586 */ | |
1587 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s); | |
1588 | |
1589 /** | |
1590 * Find the "best" stream in the file. | |
1591 * The best stream is determined according to various heuristics as the most | |
1592 * likely to be what the user expects. | |
1593 * If the decoder parameter is non-NULL, av_find_best_stream will find the | |
1594 * default decoder for the stream's codec; streams for which no decoder can | |
1595 * be found are ignored. | |
1596 * | |
1597 * @param ic media file handle | |
1598 * @param type stream type: video, audio, subtitles, etc. | |
1599 * @param wanted_stream_nb user-requested stream number, | |
1600 * or -1 for automatic selection | |
1601 * @param related_stream try to find a stream related (eg. in the same | |
1602 * program) to this one, or -1 if none | |
1603 * @param decoder_ret if non-NULL, returns the decoder for the | |
1604 * selected stream | |
1605 * @param flags flags; none are currently defined | |
1606 * @return the non-negative stream number in case of success, | |
1607 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type | |
1608 * could be found, | |
1609 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder | |
1610 * @note If av_find_best_stream returns successfully and decoder_ret is not | |
1611 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec. | |
1612 */ | |
1613 int av_find_best_stream(AVFormatContext *ic, | |
1614 enum AVMediaType type, | |
1615 int wanted_stream_nb, | |
1616 int related_stream, | |
1617 AVCodec **decoder_ret, | |
1618 int flags); | |
1619 | |
1620 #if FF_API_READ_PACKET | |
1621 /** | |
1622 * @deprecated use AVFMT_FLAG_NOFILLIN | AVFMT_FLAG_NOPARSE to read raw | |
1623 * unprocessed packets | |
1624 * | |
1625 * Read a transport packet from a media file. | |
1626 * | |
1627 * This function is obsolete and should never be used. | |
1628 * Use av_read_frame() instead. | |
1629 * | |
1630 * @param s media file handle | |
1631 * @param pkt is filled | |
1632 * @return 0 if OK, AVERROR_xxx on error | |
1633 */ | |
1634 attribute_deprecated | |
1635 int av_read_packet(AVFormatContext *s, AVPacket *pkt); | |
1636 #endif | |
1637 | |
1638 /** | |
1639 * Return the next frame of a stream. | |
1640 * This function returns what is stored in the file, and does not validate | |
1641 * that what is there are valid frames for the decoder. It will split what is | |
1642 * stored in the file into frames and return one for each call. It will not | |
1643 * omit invalid data between valid frames so as to give the decoder the maximum | |
1644 * information possible for decoding. | |
1645 * | |
1646 * If pkt->buf is NULL, then the packet is valid until the next | |
1647 * av_read_frame() or until av_close_input_file(). Otherwise the packet is valid | |
1648 * indefinitely. In both cases the packet must be freed with | |
1649 * av_free_packet when it is no longer needed. For video, the packet contains | |
1650 * exactly one frame. For audio, it contains an integer number of frames if each | |
1651 * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames | |
1652 * have a variable size (e.g. MPEG audio), then it contains one frame. | |
1653 * | |
1654 * pkt->pts, pkt->dts and pkt->duration are always set to correct | |
1655 * values in AVStream.time_base units (and guessed if the format cannot | |
1656 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format | |
1657 * has B-frames, so it is better to rely on pkt->dts if you do not | |
1658 * decompress the payload. | |
1659 * | |
1660 * @return 0 if OK, < 0 on error or end of file | |
1661 */ | |
1662 int av_read_frame(AVFormatContext *s, AVPacket *pkt); | |
1663 | |
1664 /** | |
1665 * Seek to the keyframe at timestamp. | |
1666 * 'timestamp' in 'stream_index'. | |
1667 * @param stream_index If stream_index is (-1), a default | |
1668 * stream is selected, and timestamp is automatically converted | |
1669 * from AV_TIME_BASE units to the stream specific time_base. | |
1670 * @param timestamp Timestamp in AVStream.time_base units | |
1671 * or, if no stream is specified, in AV_TIME_BASE units. | |
1672 * @param flags flags which select direction and seeking mode | |
1673 * @return >= 0 on success | |
1674 */ | |
1675 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, | |
1676 int flags); | |
1677 | |
1678 /** | |
1679 * Seek to timestamp ts. | |
1680 * Seeking will be done so that the point from which all active streams | |
1681 * can be presented successfully will be closest to ts and within min/max_ts. | |
1682 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. | |
1683 * | |
1684 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and | |
1685 * are the file position (this may not be supported by all demuxers). | |
1686 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames | |
1687 * in the stream with stream_index (this may not be supported by all demuxers). | |
1688 * Otherwise all timestamps are in units of the stream selected by stream_index | |
1689 * or if stream_index is -1, in AV_TIME_BASE units. | |
1690 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as | |
1691 * keyframes (this may not be supported by all demuxers). | |
1692 * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored. | |
1693 * | |
1694 * @param stream_index index of the stream which is used as time base reference | |
1695 * @param min_ts smallest acceptable timestamp | |
1696 * @param ts target timestamp | |
1697 * @param max_ts largest acceptable timestamp | |
1698 * @param flags flags | |
1699 * @return >=0 on success, error code otherwise | |
1700 * | |
1701 * @note This is part of the new seek API which is still under construction. | |
1702 * Thus do not use this yet. It may change at any time, do not expect | |
1703 * ABI compatibility yet! | |
1704 */ | |
1705 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); | |
1706 | |
1707 /** | |
1708 * Start playing a network-based stream (e.g. RTSP stream) at the | |
1709 * current position. | |
1710 */ | |
1711 int av_read_play(AVFormatContext *s); | |
1712 | |
1713 /** | |
1714 * Pause a network-based stream (e.g. RTSP stream). | |
1715 * | |
1716 * Use av_read_play() to resume it. | |
1717 */ | |
1718 int av_read_pause(AVFormatContext *s); | |
1719 | |
1720 #if FF_API_CLOSE_INPUT_FILE | |
1721 /** | |
1722 * @deprecated use avformat_close_input() | |
1723 * Close a media file (but not its codecs). | |
1724 * | |
1725 * @param s media file handle | |
1726 */ | |
1727 attribute_deprecated | |
1728 void av_close_input_file(AVFormatContext *s); | |
1729 #endif | |
1730 | |
1731 /** | |
1732 * Close an opened input AVFormatContext. Free it and all its contents | |
1733 * and set *s to NULL. | |
1734 */ | |
1735 void avformat_close_input(AVFormatContext **s); | |
1736 /** | |
1737 * @} | |
1738 */ | |
1739 | |
1740 #if FF_API_NEW_STREAM | |
1741 /** | |
1742 * Add a new stream to a media file. | |
1743 * | |
1744 * Can only be called in the read_header() function. If the flag | |
1745 * AVFMTCTX_NOHEADER is in the format context, then new streams | |
1746 * can be added in read_packet too. | |
1747 * | |
1748 * @param s media file handle | |
1749 * @param id file-format-dependent stream ID | |
1750 */ | |
1751 attribute_deprecated | |
1752 AVStream *av_new_stream(AVFormatContext *s, int id); | |
1753 #endif | |
1754 | |
1755 #if FF_API_SET_PTS_INFO | |
1756 /** | |
1757 * @deprecated this function is not supposed to be called outside of lavf | |
1758 */ | |
1759 attribute_deprecated | |
1760 void av_set_pts_info(AVStream *s, int pts_wrap_bits, | |
1761 unsigned int pts_num, unsigned int pts_den); | |
1762 #endif | |
1763 | |
1764 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward | |
1765 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes | |
1766 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes | |
1767 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number | |
1768 | |
1769 /** | |
1770 * @addtogroup lavf_encoding | |
1771 * @{ | |
1772 */ | |
1773 /** | |
1774 * Allocate the stream private data and write the stream header to | |
1775 * an output media file. | |
1776 * | |
1777 * @param s Media file handle, must be allocated with avformat_alloc_context(). | |
1778 * Its oformat field must be set to the desired output format; | |
1779 * Its pb field must be set to an already opened AVIOContext. | |
1780 * @param options An AVDictionary filled with AVFormatContext and muxer-private options. | |
1781 * On return this parameter will be destroyed and replaced with a dict containing | |
1782 * options that were not found. May be NULL. | |
1783 * | |
1784 * @return 0 on success, negative AVERROR on failure. | |
1785 * | |
1786 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next. | |
1787 */ | |
1788 int avformat_write_header(AVFormatContext *s, AVDictionary **options); | |
1789 | |
1790 /** | |
1791 * Write a packet to an output media file. | |
1792 * | |
1793 * The packet shall contain one audio or video frame. | |
1794 * The packet must be correctly interleaved according to the container | |
1795 * specification, if not then av_interleaved_write_frame must be used. | |
1796 * | |
1797 * @param s media file handle | |
1798 * @param pkt The packet, which contains the stream_index, buf/buf_size, | |
1799 * dts/pts, ... | |
1800 * This can be NULL (at any time, not just at the end), in | |
1801 * order to immediately flush data buffered within the muxer, | |
1802 * for muxers that buffer up data internally before writing it | |
1803 * to the output. | |
1804 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush | |
1805 */ | |
1806 int av_write_frame(AVFormatContext *s, AVPacket *pkt); | |
1807 | |
1808 /** | |
1809 * Write a packet to an output media file ensuring correct interleaving. | |
1810 * | |
1811 * The packet must contain one audio or video frame. | |
1812 * If the packets are already correctly interleaved, the application should | |
1813 * call av_write_frame() instead as it is slightly faster. It is also important | |
1814 * to keep in mind that completely non-interleaved input will need huge amounts | |
1815 * of memory to interleave with this, so it is preferable to interleave at the | |
1816 * demuxer level. | |
1817 * | |
1818 * @param s media file handle | |
1819 * @param pkt The packet containing the data to be written. pkt->buf must be set | |
1820 * to a valid AVBufferRef describing the packet data. Libavformat takes | |
1821 * ownership of this reference and will unref it when it sees fit. The caller | |
1822 * must not access the data through this reference after this function returns. | |
1823 * This can be NULL (at any time, not just at the end), to flush the | |
1824 * interleaving queues. | |
1825 * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the | |
1826 * index of the corresponding stream in @ref AVFormatContext.streams | |
1827 * "s.streams". | |
1828 * It is very strongly recommended that timing information (@ref AVPacket.pts | |
1829 * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to | |
1830 * correct values. | |
1831 * | |
1832 * @return 0 on success, a negative AVERROR on error. | |
1833 */ | |
1834 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); | |
1835 | |
1836 /** | |
1837 * Write the stream trailer to an output media file and free the | |
1838 * file private data. | |
1839 * | |
1840 * May only be called after a successful call to avformat_write_header. | |
1841 * | |
1842 * @param s media file handle | |
1843 * @return 0 if OK, AVERROR_xxx on error | |
1844 */ | |
1845 int av_write_trailer(AVFormatContext *s); | |
1846 | |
1847 /** | |
1848 * Return the output format in the list of registered output formats | |
1849 * which best matches the provided parameters, or return NULL if | |
1850 * there is no match. | |
1851 * | |
1852 * @param short_name if non-NULL checks if short_name matches with the | |
1853 * names of the registered formats | |
1854 * @param filename if non-NULL checks if filename terminates with the | |
1855 * extensions of the registered formats | |
1856 * @param mime_type if non-NULL checks if mime_type matches with the | |
1857 * MIME type of the registered formats | |
1858 */ | |
1859 AVOutputFormat *av_guess_format(const char *short_name, | |
1860 const char *filename, | |
1861 const char *mime_type); | |
1862 | |
1863 /** | |
1864 * Guess the codec ID based upon muxer and filename. | |
1865 */ | |
1866 enum AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, | |
1867 const char *filename, const char *mime_type, | |
1868 enum AVMediaType type); | |
1869 | |
1870 /** | |
1871 * Get timing information for the data currently output. | |
1872 * The exact meaning of "currently output" depends on the format. | |
1873 * It is mostly relevant for devices that have an internal buffer and/or | |
1874 * work in real time. | |
1875 * @param s media file handle | |
1876 * @param stream stream in the media file | |
1877 * @param[out] dts DTS of the last packet output for the stream, in stream | |
1878 * time_base units | |
1879 * @param[out] wall absolute time when that packet whas output, | |
1880 * in microsecond | |
1881 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it | |
1882 * Note: some formats or devices may not allow to measure dts and wall | |
1883 * atomically. | |
1884 */ | |
1885 int av_get_output_timestamp(struct AVFormatContext *s, int stream, | |
1886 int64_t *dts, int64_t *wall); | |
1887 | |
1888 | |
1889 /** | |
1890 * @} | |
1891 */ | |
1892 | |
1893 | |
1894 /** | |
1895 * @defgroup lavf_misc Utility functions | |
1896 * @ingroup libavf | |
1897 * @{ | |
1898 * | |
1899 * Miscellaneous utility functions related to both muxing and demuxing | |
1900 * (or neither). | |
1901 */ | |
1902 | |
1903 /** | |
1904 * Send a nice hexadecimal dump of a buffer to the specified file stream. | |
1905 * | |
1906 * @param f The file stream pointer where the dump should be sent to. | |
1907 * @param buf buffer | |
1908 * @param size buffer size | |
1909 * | |
1910 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2 | |
1911 */ | |
1912 void av_hex_dump(FILE *f, const uint8_t *buf, int size); | |
1913 | |
1914 /** | |
1915 * Send a nice hexadecimal dump of a buffer to the log. | |
1916 * | |
1917 * @param avcl A pointer to an arbitrary struct of which the first field is a | |
1918 * pointer to an AVClass struct. | |
1919 * @param level The importance level of the message, lower values signifying | |
1920 * higher importance. | |
1921 * @param buf buffer | |
1922 * @param size buffer size | |
1923 * | |
1924 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2 | |
1925 */ | |
1926 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size); | |
1927 | |
1928 /** | |
1929 * Send a nice dump of a packet to the specified file stream. | |
1930 * | |
1931 * @param f The file stream pointer where the dump should be sent to. | |
1932 * @param pkt packet to dump | |
1933 * @param dump_payload True if the payload must be displayed, too. | |
1934 * @param st AVStream that the packet belongs to | |
1935 */ | |
1936 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st); | |
1937 | |
1938 | |
1939 /** | |
1940 * Send a nice dump of a packet to the log. | |
1941 * | |
1942 * @param avcl A pointer to an arbitrary struct of which the first field is a | |
1943 * pointer to an AVClass struct. | |
1944 * @param level The importance level of the message, lower values signifying | |
1945 * higher importance. | |
1946 * @param pkt packet to dump | |
1947 * @param dump_payload True if the payload must be displayed, too. | |
1948 * @param st AVStream that the packet belongs to | |
1949 */ | |
1950 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload, | |
1951 AVStream *st); | |
1952 | |
1953 /** | |
1954 * Get the AVCodecID for the given codec tag tag. | |
1955 * If no codec id is found returns AV_CODEC_ID_NONE. | |
1956 * | |
1957 * @param tags list of supported codec_id-codec_tag pairs, as stored | |
1958 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag | |
1959 */ | |
1960 enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); | |
1961 | |
1962 /** | |
1963 * Get the codec tag for the given codec id id. | |
1964 * If no codec tag is found returns 0. | |
1965 * | |
1966 * @param tags list of supported codec_id-codec_tag pairs, as stored | |
1967 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag | |
1968 */ | |
1969 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id); | |
1970 | |
1971 /** | |
1972 * Get the codec tag for the given codec id. | |
1973 * | |
1974 * @param tags list of supported codec_id - codec_tag pairs, as stored | |
1975 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag | |
1976 * @param id codec id that should be searched for in the list | |
1977 * @param tag A pointer to the found tag | |
1978 * @return 0 if id was not found in tags, > 0 if it was found | |
1979 */ | |
1980 int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id, | |
1981 unsigned int *tag); | |
1982 | |
1983 int av_find_default_stream_index(AVFormatContext *s); | |
1984 | |
1985 /** | |
1986 * Get the index for a specific timestamp. | |
1987 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond | |
1988 * to the timestamp which is <= the requested one, if backward | |
1989 * is 0, then it will be >= | |
1990 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise | |
1991 * @return < 0 if no such timestamp could be found | |
1992 */ | |
1993 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); | |
1994 | |
1995 /** | |
1996 * Add an index entry into a sorted list. Update the entry if the list | |
1997 * already contains it. | |
1998 * | |
1999 * @param timestamp timestamp in the time base of the given stream | |
2000 */ | |
2001 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, | |
2002 int size, int distance, int flags); | |
2003 | |
2004 | |
2005 /** | |
2006 * Split a URL string into components. | |
2007 * | |
2008 * The pointers to buffers for storing individual components may be null, | |
2009 * in order to ignore that component. Buffers for components not found are | |
2010 * set to empty strings. If the port is not found, it is set to a negative | |
2011 * value. | |
2012 * | |
2013 * @param proto the buffer for the protocol | |
2014 * @param proto_size the size of the proto buffer | |
2015 * @param authorization the buffer for the authorization | |
2016 * @param authorization_size the size of the authorization buffer | |
2017 * @param hostname the buffer for the host name | |
2018 * @param hostname_size the size of the hostname buffer | |
2019 * @param port_ptr a pointer to store the port number in | |
2020 * @param path the buffer for the path | |
2021 * @param path_size the size of the path buffer | |
2022 * @param url the URL to split | |
2023 */ | |
2024 void av_url_split(char *proto, int proto_size, | |
2025 char *authorization, int authorization_size, | |
2026 char *hostname, int hostname_size, | |
2027 int *port_ptr, | |
2028 char *path, int path_size, | |
2029 const char *url); | |
2030 | |
2031 | |
2032 void av_dump_format(AVFormatContext *ic, | |
2033 int index, | |
2034 const char *url, | |
2035 int is_output); | |
2036 | |
2037 /** | |
2038 * Return in 'buf' the path with '%d' replaced by a number. | |
2039 * | |
2040 * Also handles the '%0nd' format where 'n' is the total number | |
2041 * of digits and '%%'. | |
2042 * | |
2043 * @param buf destination buffer | |
2044 * @param buf_size destination buffer size | |
2045 * @param path numbered sequence string | |
2046 * @param number frame number | |
2047 * @return 0 if OK, -1 on format error | |
2048 */ | |
2049 int av_get_frame_filename(char *buf, int buf_size, | |
2050 const char *path, int number); | |
2051 | |
2052 /** | |
2053 * Check whether filename actually is a numbered sequence generator. | |
2054 * | |
2055 * @param filename possible numbered sequence string | |
2056 * @return 1 if a valid numbered sequence string, 0 otherwise | |
2057 */ | |
2058 int av_filename_number_test(const char *filename); | |
2059 | |
2060 /** | |
2061 * Generate an SDP for an RTP session. | |
2062 * | |
2063 * Note, this overwrites the id values of AVStreams in the muxer contexts | |
2064 * for getting unique dynamic payload types. | |
2065 * | |
2066 * @param ac array of AVFormatContexts describing the RTP streams. If the | |
2067 * array is composed by only one context, such context can contain | |
2068 * multiple AVStreams (one AVStream per RTP stream). Otherwise, | |
2069 * all the contexts in the array (an AVCodecContext per RTP stream) | |
2070 * must contain only one AVStream. | |
2071 * @param n_files number of AVCodecContexts contained in ac | |
2072 * @param buf buffer where the SDP will be stored (must be allocated by | |
2073 * the caller) | |
2074 * @param size the size of the buffer | |
2075 * @return 0 if OK, AVERROR_xxx on error | |
2076 */ | |
2077 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size); | |
2078 | |
2079 /** | |
2080 * Return a positive value if the given filename has one of the given | |
2081 * extensions, 0 otherwise. | |
2082 * | |
2083 * @param extensions a comma-separated list of filename extensions | |
2084 */ | |
2085 int av_match_ext(const char *filename, const char *extensions); | |
2086 | |
2087 /** | |
2088 * Test if the given container can store a codec. | |
2089 * | |
2090 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_* | |
2091 * | |
2092 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot. | |
2093 * A negative number if this information is not available. | |
2094 */ | |
2095 int avformat_query_codec(AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance); | |
2096 | |
2097 /** | |
2098 * @defgroup riff_fourcc RIFF FourCCs | |
2099 * @{ | |
2100 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are | |
2101 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the | |
2102 * following code: | |
2103 * @code | |
2104 * uint32_t tag = MKTAG('H', '2', '6', '4'); | |
2105 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 }; | |
2106 * enum AVCodecID id = av_codec_get_id(table, tag); | |
2107 * @endcode | |
2108 */ | |
2109 /** | |
2110 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID. | |
2111 */ | |
2112 const struct AVCodecTag *avformat_get_riff_video_tags(void); | |
2113 /** | |
2114 * @return the table mapping RIFF FourCCs for audio to AVCodecID. | |
2115 */ | |
2116 const struct AVCodecTag *avformat_get_riff_audio_tags(void); | |
2117 | |
2118 /** | |
2119 * @} | |
2120 */ | |
2121 | |
2122 /** | |
2123 * Guess the sample aspect ratio of a frame, based on both the stream and the | |
2124 * frame aspect ratio. | |
2125 * | |
2126 * Since the frame aspect ratio is set by the codec but the stream aspect ratio | |
2127 * is set by the demuxer, these two may not be equal. This function tries to | |
2128 * return the value that you should use if you would like to display the frame. | |
2129 * | |
2130 * Basic logic is to use the stream aspect ratio if it is set to something sane | |
2131 * otherwise use the frame aspect ratio. This way a container setting, which is | |
2132 * usually easy to modify can override the coded value in the frames. | |
2133 * | |
2134 * @param format the format context which the stream is part of | |
2135 * @param stream the stream which the frame is part of | |
2136 * @param frame the frame with the aspect ratio to be determined | |
2137 * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea | |
2138 */ | |
2139 AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame); | |
2140 | |
2141 /** | |
2142 * Guess the frame rate, based on both the container and codec information. | |
2143 * | |
2144 * @param ctx the format context which the stream is part of | |
2145 * @param stream the stream which the frame is part of | |
2146 * @param frame the frame for which the frame rate should be determined, may be NULL | |
2147 * @return the guessed (valid) frame rate, 0/1 if no idea | |
2148 */ | |
2149 AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame); | |
2150 | |
2151 /** | |
2152 * Check if the stream st contained in s is matched by the stream specifier | |
2153 * spec. | |
2154 * | |
2155 * See the "stream specifiers" chapter in the documentation for the syntax | |
2156 * of spec. | |
2157 * | |
2158 * @return >0 if st is matched by spec; | |
2159 * 0 if st is not matched by spec; | |
2160 * AVERROR code if spec is invalid | |
2161 * | |
2162 * @note A stream specifier can match several streams in the format. | |
2163 */ | |
2164 int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st, | |
2165 const char *spec); | |
2166 | |
2167 int avformat_queue_attached_pictures(AVFormatContext *s); | |
2168 | |
2169 | |
2170 /** | |
2171 * @} | |
2172 */ | |
2173 | |
2174 #endif /* AVFORMAT_AVFORMAT_H */ |