Fix a bunch of common typos.
[libav.git] / libavformat / avformat.h
1 /*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of Libav.
5 *
6 * Libav 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 * Libav 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 Libav; 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 * @defgroup lavf_decoding Demuxing
35 * @{
36 * @}
37 *
38 * @defgroup lavf_encoding Muxing
39 * @{
40 * @}
41 *
42 * @defgroup lavf_io I/O Read/Write
43 * @{
44 * @}
45 *
46 * @defgroup lavf_codec Demuxers
47 * @{
48 * @defgroup lavf_codec_native Native Demuxers
49 * @{
50 * @}
51 * @defgroup lavf_codec_wrappers External library wrappers
52 * @{
53 * @}
54 * @}
55 * @defgroup lavf_protos I/O Protocols
56 * @{
57 * @}
58 * @defgroup lavf_internal Internal
59 * @{
60 * @}
61 * @}
62 *
63 */
64
65 /**
66 * Return the LIBAVFORMAT_VERSION_INT constant.
67 */
68 unsigned avformat_version(void);
69
70 /**
71 * Return the libavformat build-time configuration.
72 */
73 const char *avformat_configuration(void);
74
75 /**
76 * Return the libavformat license.
77 */
78 const char *avformat_license(void);
79
80 #include <time.h>
81 #include <stdio.h> /* FILE */
82 #include "libavcodec/avcodec.h"
83 #include "libavutil/dict.h"
84 #include "libavutil/log.h"
85
86 #include "avio.h"
87 #include "libavformat/version.h"
88
89 struct AVFormatContext;
90
91
92 /**
93 * @defgroup metadata_api Public Metadata API
94 * @{
95 * @ingroup libavf
96 * The metadata API allows libavformat to export metadata tags to a client
97 * application when demuxing. Conversely it allows a client application to
98 * set metadata when muxing.
99 *
100 * Metadata is exported or set as pairs of key/value strings in the 'metadata'
101 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs
102 * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav,
103 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata
104 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
105 *
106 * Important concepts to keep in mind:
107 * - Keys are unique; there can never be 2 tags with the same key. This is
108 * also meant semantically, i.e., a demuxer should not knowingly produce
109 * several keys that are literally different but semantically identical.
110 * E.g., key=Author5, key=Author6. In this example, all authors must be
111 * placed in the same tag.
112 * - Metadata is flat, not hierarchical; there are no subtags. If you
113 * want to store, e.g., the email address of the child of producer Alice
114 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
115 * - Several modifiers can be applied to the tag name. This is done by
116 * appending a dash character ('-') and the modifier name in the order
117 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
118 * - language -- a tag whose value is localized for a particular language
119 * is appended with the ISO 639-2/B 3-letter language code.
120 * For example: Author-ger=Michael, Author-eng=Mike
121 * The original/default language is in the unqualified "Author" tag.
122 * A demuxer should set a default if it sets any translated tag.
123 * - sorting -- a modified version of a tag that should be used for
124 * sorting will have '-sort' appended. E.g. artist="The Beatles",
125 * artist-sort="Beatles, The".
126 *
127 * - Demuxers attempt to export metadata in a generic format, however tags
128 * with no generic equivalents are left as they are stored in the container.
129 * Follows a list of generic tag names:
130 *
131 @verbatim
132 album -- name of the set this work belongs to
133 album_artist -- main creator of the set/album, if different from artist.
134 e.g. "Various Artists" for compilation albums.
135 artist -- main creator of the work
136 comment -- any additional description of the file.
137 composer -- who composed the work, if different from artist.
138 copyright -- name of copyright holder.
139 creation_time-- date when the file was created, preferably in ISO 8601.
140 date -- date when the work was created, preferably in ISO 8601.
141 disc -- number of a subset, e.g. disc in a multi-disc collection.
142 encoder -- name/settings of the software/hardware that produced the file.
143 encoded_by -- person/group who created the file.
144 filename -- original name of the file.
145 genre -- <self-evident>.
146 language -- main language in which the work is performed, preferably
147 in ISO 639-2 format. Multiple languages can be specified by
148 separating them with commas.
149 performer -- artist who performed the work, if different from artist.
150 E.g for "Also sprach Zarathustra", artist would be "Richard
151 Strauss" and performer "London Philharmonic Orchestra".
152 publisher -- name of the label/publisher.
153 service_name -- name of the service in broadcasting (channel name).
154 service_provider -- name of the service provider in broadcasting.
155 title -- name of the work.
156 track -- number of this work in the set, can be in form current/total.
157 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
158 @endverbatim
159 *
160 * Look in the examples section for an application example how to use the Metadata API.
161 *
162 * @}
163 */
164
165 #if FF_API_OLD_METADATA2
166 /**
167 * @defgroup old_metadata Old metadata API
168 * The following functions are deprecated, use
169 * their equivalents from libavutil/dict.h instead.
170 * @{
171 */
172
173 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
174 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
175 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
176 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
177 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
178
179 typedef attribute_deprecated AVDictionary AVMetadata;
180 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
181
182 typedef struct AVMetadataConv AVMetadataConv;
183
184 /**
185 * Get a metadata element with matching key.
186 *
187 * @param prev Set to the previous matching element to find the next.
188 * If set to NULL the first matching element is returned.
189 * @param flags Allows case as well as suffix-insensitive comparisons.
190 * @return Found tag or NULL, changing key or value leads to undefined behavior.
191 */
192 attribute_deprecated AVDictionaryEntry *
193 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
194
195 /**
196 * Set the given tag in *pm, overwriting an existing tag.
197 *
198 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
199 * a metadata struct is allocated and put in *pm.
200 * @param key tag key to add to *pm (will be av_strduped depending on flags)
201 * @param value tag value to add to *pm (will be av_strduped depending on flags).
202 * Passing a NULL value will cause an existing tag to be deleted.
203 * @return >= 0 on success otherwise an error code <0
204 */
205 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
206
207 /**
208 * This function is provided for compatibility reason and currently does nothing.
209 */
210 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
211 const AVMetadataConv *s_conv);
212
213 /**
214 * Copy metadata from one AVDictionary struct into another.
215 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
216 * this function will allocate a struct for you and put it in *dst
217 * @param src pointer to source AVDictionary struct
218 * @param flags flags to use when setting metadata in *dst
219 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
220 */
221 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
222
223 /**
224 * Free all the memory allocated for an AVDictionary struct.
225 */
226 attribute_deprecated void av_metadata_free(AVDictionary **m);
227 /**
228 * @}
229 */
230 #endif
231
232
233 /* packet functions */
234
235
236 /**
237 * Allocate and read the payload of a packet and initialize its
238 * fields with default values.
239 *
240 * @param pkt packet
241 * @param size desired payload size
242 * @return >0 (read size) if OK, AVERROR_xxx otherwise
243 */
244 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
245
246
247 /**
248 * Read data and append it to the current content of the AVPacket.
249 * If pkt->size is 0 this is identical to av_get_packet.
250 * Note that this uses av_grow_packet and thus involves a realloc
251 * which is inefficient. Thus this function should only be used
252 * when there is no reasonable way to know (an upper bound of)
253 * the final size.
254 *
255 * @param pkt packet
256 * @param size amount of data to read
257 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
258 * will not be lost even if an error occurs.
259 */
260 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
261
262 /*************************************************/
263 /* fractional numbers for exact pts handling */
264
265 /**
266 * The exact value of the fractional number is: 'val + num / den'.
267 * num is assumed to be 0 <= num < den.
268 */
269 typedef struct AVFrac {
270 int64_t val, num, den;
271 } AVFrac;
272
273 /*************************************************/
274 /* input/output formats */
275
276 struct AVCodecTag;
277
278 /**
279 * This structure contains the data a format has to probe a file.
280 */
281 typedef struct AVProbeData {
282 const char *filename;
283 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
284 int buf_size; /**< Size of buf except extra allocated bytes */
285 } AVProbeData;
286
287 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
288 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
289
290 typedef struct AVFormatParameters {
291 #if FF_API_FORMAT_PARAMETERS
292 attribute_deprecated AVRational time_base;
293 attribute_deprecated int sample_rate;
294 attribute_deprecated int channels;
295 attribute_deprecated int width;
296 attribute_deprecated int height;
297 attribute_deprecated enum PixelFormat pix_fmt;
298 attribute_deprecated int channel; /**< Used to select DV channel. */
299 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
300 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
301 /**< deprecated, use mpegtsraw demuxer-specific options instead */
302 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
303 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
304 immediately (RTSP only). */
305 attribute_deprecated unsigned int prealloced_context:1;
306 #endif
307 } AVFormatParameters;
308
309 /// Demuxer will use avio_open, no opened file should be provided by the caller.
310 #define AVFMT_NOFILE 0x0001
311 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
312 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
313 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
314 raw picture data. */
315 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
316 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
317 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
318 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
319 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
320 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
321 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
322 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
323 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
324 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
325
326 /**
327 * @addtogroup lavf_encoding
328 * @{
329 */
330 typedef struct AVOutputFormat {
331 const char *name;
332 /**
333 * Descriptive name for the format, meant to be more human-readable
334 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
335 * to define it.
336 */
337 const char *long_name;
338 const char *mime_type;
339 const char *extensions; /**< comma-separated filename extensions */
340 /**
341 * size of private data so that it can be allocated in the wrapper
342 */
343 int priv_data_size;
344 /* output support */
345 enum CodecID audio_codec; /**< default audio codec */
346 enum CodecID video_codec; /**< default video codec */
347 int (*write_header)(struct AVFormatContext *);
348 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
349 int (*write_trailer)(struct AVFormatContext *);
350 /**
351 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
352 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
353 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
354 */
355 int flags;
356 /**
357 * Currently only used to set pixel format if not YUV420P.
358 */
359 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
360 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
361 AVPacket *in, int flush);
362
363 /**
364 * List of supported codec_id-codec_tag pairs, ordered by "better
365 * choice first". The arrays are all terminated by CODEC_ID_NONE.
366 */
367 const struct AVCodecTag * const *codec_tag;
368
369 enum CodecID subtitle_codec; /**< default subtitle codec */
370
371 #if FF_API_OLD_METADATA2
372 const AVMetadataConv *metadata_conv;
373 #endif
374
375 const AVClass *priv_class; ///< AVClass for the private context
376
377 /**
378 * Test if the given codec can be stored in this container.
379 *
380 * @return 1 if the codec is supported, 0 if it is not.
381 * A negative number if unknown.
382 */
383 int (*query_codec)(enum CodecID id, int std_compliance);
384
385 /* private fields */
386 struct AVOutputFormat *next;
387 } AVOutputFormat;
388 /**
389 * @}
390 */
391
392 /**
393 * @addtogroup lavf_decoding
394 * @{
395 */
396 typedef struct AVInputFormat {
397 /**
398 * A comma separated list of short names for the format. New names
399 * may be appended with a minor bump.
400 */
401 const char *name;
402
403 /**
404 * Descriptive name for the format, meant to be more human-readable
405 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
406 * to define it.
407 */
408 const char *long_name;
409
410 /**
411 * Size of private data so that it can be allocated in the wrapper.
412 */
413 int priv_data_size;
414
415 /**
416 * Tell if a given file has a chance of being parsed as this format.
417 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
418 * big so you do not have to check for that unless you need more.
419 */
420 int (*read_probe)(AVProbeData *);
421
422 /**
423 * Read the format header and initialize the AVFormatContext
424 * structure. Return 0 if OK. 'ap' if non-NULL contains
425 * additional parameters. Only used in raw format right
426 * now. 'av_new_stream' should be called to create new streams.
427 */
428 int (*read_header)(struct AVFormatContext *,
429 AVFormatParameters *ap);
430
431 /**
432 * Read one packet and put it in 'pkt'. pts and flags are also
433 * set. 'av_new_stream' can be called only if the flag
434 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
435 * background thread).
436 * @return 0 on success, < 0 on error.
437 * When returning an error, pkt must not have been allocated
438 * or must be freed before returning
439 */
440 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
441
442 /**
443 * Close the stream. The AVFormatContext and AVStreams are not
444 * freed by this function
445 */
446 int (*read_close)(struct AVFormatContext *);
447
448 #if FF_API_READ_SEEK
449 /**
450 * Seek to a given timestamp relative to the frames in
451 * stream component stream_index.
452 * @param stream_index Must not be -1.
453 * @param flags Selects which direction should be preferred if no exact
454 * match is available.
455 * @return >= 0 on success (but not necessarily the new offset)
456 */
457 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
458 int stream_index, int64_t timestamp, int flags);
459 #endif
460 /**
461 * Gets the next timestamp in stream[stream_index].time_base units.
462 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
463 */
464 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
465 int64_t *pos, int64_t pos_limit);
466
467 /**
468 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
469 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
470 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
471 */
472 int flags;
473
474 /**
475 * If extensions are defined, then no probe is done. You should
476 * usually not use extension format guessing because it is not
477 * reliable enough
478 */
479 const char *extensions;
480
481 /**
482 * General purpose read-only value that the format can use.
483 */
484 int value;
485
486 /**
487 * Start/resume playing - only meaningful if using a network-based format
488 * (RTSP).
489 */
490 int (*read_play)(struct AVFormatContext *);
491
492 /**
493 * Pause playing - only meaningful if using a network-based format
494 * (RTSP).
495 */
496 int (*read_pause)(struct AVFormatContext *);
497
498 const struct AVCodecTag * const *codec_tag;
499
500 /**
501 * Seek to timestamp ts.
502 * Seeking will be done so that the point from which all active streams
503 * can be presented successfully will be closest to ts and within min/max_ts.
504 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
505 */
506 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
507
508 #if FF_API_OLD_METADATA2
509 const AVMetadataConv *metadata_conv;
510 #endif
511
512 const AVClass *priv_class; ///< AVClass for the private context
513
514 /* private fields */
515 struct AVInputFormat *next;
516 } AVInputFormat;
517 /**
518 * @}
519 */
520
521 enum AVStreamParseType {
522 AVSTREAM_PARSE_NONE,
523 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
524 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
525 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
526 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
527 };
528
529 typedef struct AVIndexEntry {
530 int64_t pos;
531 int64_t timestamp;
532 #define AVINDEX_KEYFRAME 0x0001
533 int flags:2;
534 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).
535 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
536 } AVIndexEntry;
537
538 #define AV_DISPOSITION_DEFAULT 0x0001
539 #define AV_DISPOSITION_DUB 0x0002
540 #define AV_DISPOSITION_ORIGINAL 0x0004
541 #define AV_DISPOSITION_COMMENT 0x0008
542 #define AV_DISPOSITION_LYRICS 0x0010
543 #define AV_DISPOSITION_KARAOKE 0x0020
544
545 /**
546 * Track should be used during playback by default.
547 * Useful for subtitle track that should be displayed
548 * even when user did not explicitly ask for subtitles.
549 */
550 #define AV_DISPOSITION_FORCED 0x0040
551 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
552 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
553 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
554
555 /**
556 * Stream structure.
557 * New fields can be added to the end with minor version bumps.
558 * Removal, reordering and changes to existing fields require a major
559 * version bump.
560 * sizeof(AVStream) must not be used outside libav*.
561 */
562 typedef struct AVStream {
563 int index; /**< stream index in AVFormatContext */
564 int id; /**< format-specific stream ID */
565 AVCodecContext *codec; /**< codec context */
566 /**
567 * Real base framerate of the stream.
568 * This is the lowest framerate with which all timestamps can be
569 * represented accurately (it is the least common multiple of all
570 * framerates in the stream). Note, this value is just a guess!
571 * For example, if the time base is 1/90000 and all frames have either
572 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
573 */
574 AVRational r_frame_rate;
575 void *priv_data;
576
577 #if FF_API_REORDER_PRIVATE
578 /* internal data used in av_find_stream_info() */
579 int64_t first_dts;
580 #endif
581
582 /**
583 * encoding: pts generation when outputting stream
584 */
585 struct AVFrac pts;
586
587 /**
588 * This is the fundamental unit of time (in seconds) in terms
589 * of which frame timestamps are represented. For fixed-fps content,
590 * time base should be 1/framerate and timestamp increments should be 1.
591 * decoding: set by libavformat
592 * encoding: set by libavformat in av_write_header
593 */
594 AVRational time_base;
595 #if FF_API_REORDER_PRIVATE
596 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
597 #endif
598 #if FF_API_STREAM_COPY
599 /* ffmpeg.c private use */
600 attribute_deprecated int stream_copy; /**< If set, just copy stream. */
601 #endif
602 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
603
604 #if FF_API_AVSTREAM_QUALITY
605 //FIXME move stuff to a flags field?
606 /**
607 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
608 * MN: dunno if that is the right place for it
609 */
610 attribute_deprecated float quality;
611 #endif
612
613 /**
614 * Decoding: pts of the first frame of the stream, in stream time base.
615 * Only set this if you are absolutely 100% sure that the value you set
616 * it to really is the pts of the first frame.
617 * This may be undefined (AV_NOPTS_VALUE).
618 */
619 int64_t start_time;
620
621 /**
622 * Decoding: duration of the stream, in stream time base.
623 * If a source file does not specify a duration, but does specify
624 * a bitrate, this value will be estimated from bitrate and file size.
625 */
626 int64_t duration;
627
628 #if FF_API_REORDER_PRIVATE
629 /* av_read_frame() support */
630 enum AVStreamParseType need_parsing;
631 struct AVCodecParserContext *parser;
632
633 int64_t cur_dts;
634 int last_IP_duration;
635 int64_t last_IP_pts;
636 /* av_seek_frame() support */
637 AVIndexEntry *index_entries; /**< Only used if the format does not
638 support seeking natively. */
639 int nb_index_entries;
640 unsigned int index_entries_allocated_size;
641 #endif
642
643 int64_t nb_frames; ///< number of frames in this stream if known or 0
644
645 int disposition; /**< AV_DISPOSITION_* bit field */
646
647 #if FF_API_REORDER_PRIVATE
648 AVProbeData probe_data;
649 #define MAX_REORDER_DELAY 16
650 int64_t pts_buffer[MAX_REORDER_DELAY+1];
651 #endif
652
653 /**
654 * sample aspect ratio (0 if unknown)
655 * - encoding: Set by user.
656 * - decoding: Set by libavformat.
657 */
658 AVRational sample_aspect_ratio;
659
660 AVDictionary *metadata;
661
662 #if FF_API_REORDER_PRIVATE
663 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
664 /* external applications; try to use something else if at all possible. */
665 const uint8_t *cur_ptr;
666 int cur_len;
667 AVPacket cur_pkt;
668
669 // Timestamp generation support:
670 /**
671 * Timestamp corresponding to the last dts sync point.
672 *
673 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
674 * a DTS is received from the underlying container. Otherwise set to
675 * AV_NOPTS_VALUE by default.
676 */
677 int64_t reference_dts;
678
679 /**
680 * Number of packets to buffer for codec probing
681 * NOT PART OF PUBLIC API
682 */
683 #define MAX_PROBE_PACKETS 2500
684 int probe_packets;
685
686 /**
687 * last packet in packet_buffer for this stream when muxing.
688 * Used internally, NOT PART OF PUBLIC API, do not read or
689 * write from outside of libav*
690 */
691 struct AVPacketList *last_in_packet_buffer;
692 #endif
693
694 /**
695 * Average framerate
696 */
697 AVRational avg_frame_rate;
698
699 /*****************************************************************
700 * All fields below this line are not part of the public API. They
701 * may not be used outside of libavformat and can be changed and
702 * removed at will.
703 * New public fields should be added right above.
704 *****************************************************************
705 */
706
707 /**
708 * Number of frames that have been demuxed during av_find_stream_info()
709 */
710 int codec_info_nb_frames;
711
712 /**
713 * Stream information used internally by av_find_stream_info()
714 */
715 #define MAX_STD_TIMEBASES (60*12+5)
716 struct {
717 int64_t last_dts;
718 int64_t duration_gcd;
719 int duration_count;
720 double duration_error[MAX_STD_TIMEBASES];
721 int64_t codec_info_duration;
722 int nb_decoded_frames;
723 } *info;
724 #if !FF_API_REORDER_PRIVATE
725 const uint8_t *cur_ptr;
726 int cur_len;
727 AVPacket cur_pkt;
728
729 // Timestamp generation support:
730 /**
731 * Timestamp corresponding to the last dts sync point.
732 *
733 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
734 * a DTS is received from the underlying container. Otherwise set to
735 * AV_NOPTS_VALUE by default.
736 */
737 int64_t reference_dts;
738 int64_t first_dts;
739 int64_t cur_dts;
740 int last_IP_duration;
741 int64_t last_IP_pts;
742
743 /**
744 * Number of packets to buffer for codec probing
745 */
746 #define MAX_PROBE_PACKETS 2500
747 int probe_packets;
748
749 /**
750 * last packet in packet_buffer for this stream when muxing.
751 */
752 struct AVPacketList *last_in_packet_buffer;
753 AVProbeData probe_data;
754 #define MAX_REORDER_DELAY 16
755 int64_t pts_buffer[MAX_REORDER_DELAY+1];
756 /* av_read_frame() support */
757 enum AVStreamParseType need_parsing;
758 struct AVCodecParserContext *parser;
759
760 AVIndexEntry *index_entries; /**< Only used if the format does not
761 support seeking natively. */
762 int nb_index_entries;
763 unsigned int index_entries_allocated_size;
764
765 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
766 #endif
767 } AVStream;
768
769 #define AV_PROGRAM_RUNNING 1
770
771 /**
772 * New fields can be added to the end with minor version bumps.
773 * Removal, reordering and changes to existing fields require a major
774 * version bump.
775 * sizeof(AVProgram) must not be used outside libav*.
776 */
777 typedef struct AVProgram {
778 int id;
779 int flags;
780 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
781 unsigned int *stream_index;
782 unsigned int nb_stream_indexes;
783 AVDictionary *metadata;
784 } AVProgram;
785
786 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
787 (streams are added dynamically) */
788
789 typedef struct AVChapter {
790 int id; ///< unique ID to identify the chapter
791 AVRational time_base; ///< time base in which the start/end timestamps are specified
792 int64_t start, end; ///< chapter start/end time in time_base units
793 AVDictionary *metadata;
794 } AVChapter;
795
796 /**
797 * Format I/O context.
798 * New fields can be added to the end with minor version bumps.
799 * Removal, reordering and changes to existing fields require a major
800 * version bump.
801 * sizeof(AVFormatContext) must not be used outside libav*, use
802 * avformat_alloc_context() to create an AVFormatContext.
803 */
804 typedef struct AVFormatContext {
805 /**
806 * A class for logging and AVOptions. Set by avformat_alloc_context().
807 * Exports (de)muxer private options if they exist.
808 */
809 const AVClass *av_class;
810
811 /**
812 * Can only be iformat or oformat, not both at the same time.
813 *
814 * decoding: set by avformat_open_input().
815 * encoding: set by the user.
816 */
817 struct AVInputFormat *iformat;
818 struct AVOutputFormat *oformat;
819
820 /**
821 * Format private data. This is an AVOptions-enabled struct
822 * if and only if iformat/oformat.priv_class is not NULL.
823 */
824 void *priv_data;
825
826 /*
827 * I/O context.
828 *
829 * decoding: either set by the user before avformat_open_input() (then
830 * the user must close it manually) or set by avformat_open_input().
831 * encoding: set by the user.
832 *
833 * Do NOT set this field if AVFMT_NOFILE flag is set in
834 * iformat/oformat.flags. In such a case, the (de)muxer will handle
835 * I/O in some other way and this field will be NULL.
836 */
837 AVIOContext *pb;
838
839 /**
840 * A list of all streams in the file. New streams are created with
841 * avformat_new_stream().
842 *
843 * decoding: streams are created by libavformat in avformat_open_input().
844 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
845 * appear in av_read_frame().
846 * encoding: streams are created by the user before avformat_write_header().
847 */
848 unsigned int nb_streams;
849 AVStream **streams;
850
851 char filename[1024]; /**< input or output filename */
852 /* stream info */
853 #if FF_API_TIMESTAMP
854 /**
855 * @deprecated use 'creation_time' metadata tag instead
856 */
857 attribute_deprecated int64_t timestamp;
858 #endif
859
860 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
861 #if FF_API_REORDER_PRIVATE
862 /* private data for pts handling (do not modify directly). */
863 /**
864 * This buffer is only needed when packets were already buffered but
865 * not decoded, for example to get the codec parameters in MPEG
866 * streams.
867 */
868 struct AVPacketList *packet_buffer;
869 #endif
870
871 /**
872 * Decoding: position of the first frame of the component, in
873 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
874 * It is deduced from the AVStream values.
875 */
876 int64_t start_time;
877
878 /**
879 * Decoding: duration of the stream, in AV_TIME_BASE fractional
880 * seconds. Only set this value if you know none of the individual stream
881 * durations and also do not set any of them. This is deduced from the
882 * AVStream values if not set.
883 */
884 int64_t duration;
885
886 #if FF_API_FILESIZE
887 /**
888 * decoding: total file size, 0 if unknown
889 */
890 attribute_deprecated int64_t file_size;
891 #endif
892
893 /**
894 * Decoding: total stream bitrate in bit/s, 0 if not
895 * available. Never set it directly if the file_size and the
896 * duration are known as Libav can compute it automatically.
897 */
898 int bit_rate;
899
900 #if FF_API_REORDER_PRIVATE
901 /* av_read_frame() support */
902 AVStream *cur_st;
903
904 /* av_seek_frame() support */
905 int64_t data_offset; /**< offset of the first packet */
906 #endif
907
908 #if FF_API_MUXRATE
909 /**
910 * use mpeg muxer private options instead
911 */
912 attribute_deprecated int mux_rate;
913 #endif
914 unsigned int packet_size;
915 #if FF_API_PRELOAD
916 attribute_deprecated int preload;
917 #endif
918 int max_delay;
919
920 #if FF_API_LOOP_OUTPUT
921 #define AVFMT_NOOUTPUTLOOP -1
922 #define AVFMT_INFINITEOUTPUTLOOP 0
923 /**
924 * number of times to loop output in formats that support it
925 *
926 * @deprecated use the 'loop' private option in the gif muxer.
927 */
928 attribute_deprecated int loop_output;
929 #endif
930
931 int flags;
932 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
933 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
934 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
935 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
936 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
937 #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
938 #if FF_API_FLAG_RTP_HINT
939 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
940 #endif
941 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
942 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
943
944 #if FF_API_LOOP_INPUT
945 /**
946 * @deprecated, use the 'loop' img2 demuxer private option.
947 */
948 attribute_deprecated int loop_input;
949 #endif
950
951 /**
952 * decoding: size of data to probe; encoding: unused.
953 */
954 unsigned int probesize;
955
956 /**
957 * decoding: maximum time (in AV_TIME_BASE units) during which the input should
958 * be analyzed in avformat_find_stream_info().
959 */
960 int max_analyze_duration;
961
962 const uint8_t *key;
963 int keylen;
964
965 unsigned int nb_programs;
966 AVProgram **programs;
967
968 /**
969 * Forced video codec_id.
970 * Demuxing: Set by user.
971 */
972 enum CodecID video_codec_id;
973
974 /**
975 * Forced audio codec_id.
976 * Demuxing: Set by user.
977 */
978 enum CodecID audio_codec_id;
979
980 /**
981 * Forced subtitle codec_id.
982 * Demuxing: Set by user.
983 */
984 enum CodecID subtitle_codec_id;
985
986 /**
987 * Maximum amount of memory in bytes to use for the index of each stream.
988 * If the index exceeds this size, entries will be discarded as
989 * needed to maintain a smaller size. This can lead to slower or less
990 * accurate seeking (depends on demuxer).
991 * Demuxers for which a full in-memory index is mandatory will ignore
992 * this.
993 * muxing : unused
994 * demuxing: set by user
995 */
996 unsigned int max_index_size;
997
998 /**
999 * Maximum amount of memory in bytes to use for buffering frames
1000 * obtained from realtime capture devices.
1001 */
1002 unsigned int max_picture_buffer;
1003
1004 unsigned int nb_chapters;
1005 AVChapter **chapters;
1006
1007 /**
1008 * Flags to enable debugging.
1009 */
1010 int debug;
1011 #define FF_FDEBUG_TS 0x0001
1012
1013 #if FF_API_REORDER_PRIVATE
1014 /**
1015 * Raw packets from the demuxer, prior to parsing and decoding.
1016 * This buffer is used for buffering packets until the codec can
1017 * be identified, as parsing cannot be done without knowing the
1018 * codec.
1019 */
1020 struct AVPacketList *raw_packet_buffer;
1021 struct AVPacketList *raw_packet_buffer_end;
1022
1023 struct AVPacketList *packet_buffer_end;
1024 #endif
1025
1026 AVDictionary *metadata;
1027
1028 #if FF_API_REORDER_PRIVATE
1029 /**
1030 * Remaining size available for raw_packet_buffer, in bytes.
1031 * NOT PART OF PUBLIC API
1032 */
1033 #define RAW_PACKET_BUFFER_SIZE 2500000
1034 int raw_packet_buffer_remaining_size;
1035 #endif
1036
1037 /**
1038 * Start time of the stream in real world time, in microseconds
1039 * since the unix epoch (00:00 1st January 1970). That is, pts=0
1040 * in the stream was captured at this real world time.
1041 * - encoding: Set by user.
1042 * - decoding: Unused.
1043 */
1044 int64_t start_time_realtime;
1045
1046 /**
1047 * decoding: number of frames used to probe fps
1048 */
1049 int fps_probe_size;
1050
1051 /**
1052 * Error recognition; higher values will detect more errors but may
1053 * misdetect some more or less valid parts as errors.
1054 * - encoding: unused
1055 * - decoding: Set by user.
1056 */
1057 int error_recognition;
1058
1059 /**
1060 * Custom interrupt callbacks for the I/O layer.
1061 *
1062 * decoding: set by the user before avformat_open_input().
1063 * encoding: set by the user before avformat_write_header()
1064 * (mainly useful for AVFMT_NOFILE formats). The callback
1065 * should also be passed to avio_open2() if it's used to
1066 * open the file.
1067 */
1068 AVIOInterruptCB interrupt_callback;
1069
1070 /*****************************************************************
1071 * All fields below this line are not part of the public API. They
1072 * may not be used outside of libavformat and can be changed and
1073 * removed at will.
1074 * New public fields should be added right above.
1075 *****************************************************************
1076 */
1077 #if !FF_API_REORDER_PRIVATE
1078 /**
1079 * Raw packets from the demuxer, prior to parsing and decoding.
1080 * This buffer is used for buffering packets until the codec can
1081 * be identified, as parsing cannot be done without knowing the
1082 * codec.
1083 */
1084 struct AVPacketList *raw_packet_buffer;
1085 struct AVPacketList *raw_packet_buffer_end;
1086 /**
1087 * Remaining size available for raw_packet_buffer, in bytes.
1088 */
1089 #define RAW_PACKET_BUFFER_SIZE 2500000
1090 int raw_packet_buffer_remaining_size;
1091
1092 /**
1093 * This buffer is only needed when packets were already buffered but
1094 * not decoded, for example to get the codec parameters in MPEG
1095 * streams.
1096 */
1097 struct AVPacketList *packet_buffer;
1098 struct AVPacketList *packet_buffer_end;
1099
1100 /* av_read_frame() support */
1101 AVStream *cur_st;
1102
1103 /* av_seek_frame() support */
1104 int64_t data_offset; /**< offset of the first packet */
1105 #endif
1106 } AVFormatContext;
1107
1108 typedef struct AVPacketList {
1109 AVPacket pkt;
1110 struct AVPacketList *next;
1111 } AVPacketList;
1112
1113 /**
1114 * If f is NULL, returns the first registered input format,
1115 * if f is non-NULL, returns the next registered input format after f
1116 * or NULL if f is the last one.
1117 */
1118 AVInputFormat *av_iformat_next(AVInputFormat *f);
1119
1120 /**
1121 * If f is NULL, returns the first registered output format,
1122 * if f is non-NULL, returns the next registered output format after f
1123 * or NULL if f is the last one.
1124 */
1125 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1126
1127 #if FF_API_GUESS_IMG2_CODEC
1128 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
1129 #endif
1130
1131 /* XXX: Use automatic init with either ELF sections or C file parser */
1132 /* modules. */
1133
1134 /* utils.c */
1135 void av_register_input_format(AVInputFormat *format);
1136 void av_register_output_format(AVOutputFormat *format);
1137
1138 /**
1139 * Return the output format in the list of registered output formats
1140 * which best matches the provided parameters, or return NULL if
1141 * there is no match.
1142 *
1143 * @param short_name if non-NULL checks if short_name matches with the
1144 * names of the registered formats
1145 * @param filename if non-NULL checks if filename terminates with the
1146 * extensions of the registered formats
1147 * @param mime_type if non-NULL checks if mime_type matches with the
1148 * MIME type of the registered formats
1149 */
1150 AVOutputFormat *av_guess_format(const char *short_name,
1151 const char *filename,
1152 const char *mime_type);
1153
1154 /**
1155 * Guess the codec ID based upon muxer and filename.
1156 */
1157 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1158 const char *filename, const char *mime_type,
1159 enum AVMediaType type);
1160
1161 /**
1162 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1163 *
1164 * @param f The file stream pointer where the dump should be sent to.
1165 * @param buf buffer
1166 * @param size buffer size
1167 *
1168 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1169 */
1170 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1171
1172 /**
1173 * Send a nice hexadecimal dump of a buffer to the log.
1174 *
1175 * @param avcl A pointer to an arbitrary struct of which the first field is a
1176 * pointer to an AVClass struct.
1177 * @param level The importance level of the message, lower values signifying
1178 * higher importance.
1179 * @param buf buffer
1180 * @param size buffer size
1181 *
1182 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1183 */
1184 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1185
1186 /**
1187 * Send a nice dump of a packet to the specified file stream.
1188 *
1189 * @param f The file stream pointer where the dump should be sent to.
1190 * @param pkt packet to dump
1191 * @param dump_payload True if the payload must be displayed, too.
1192 * @param st AVStream that the packet belongs to
1193 */
1194 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1195
1196
1197 /**
1198 * Send a nice dump of a packet to the log.
1199 *
1200 * @param avcl A pointer to an arbitrary struct of which the first field is a
1201 * pointer to an AVClass struct.
1202 * @param level The importance level of the message, lower values signifying
1203 * higher importance.
1204 * @param pkt packet to dump
1205 * @param dump_payload True if the payload must be displayed, too.
1206 * @param st AVStream that the packet belongs to
1207 */
1208 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1209 AVStream *st);
1210
1211 #if FF_API_PKT_DUMP
1212 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1213 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1214 int dump_payload);
1215 #endif
1216
1217 /**
1218 * Initialize libavformat and register all the muxers, demuxers and
1219 * protocols. If you do not call this function, then you can select
1220 * exactly which formats you want to support.
1221 *
1222 * @see av_register_input_format()
1223 * @see av_register_output_format()
1224 * @see av_register_protocol()
1225 */
1226 void av_register_all(void);
1227
1228 /**
1229 * Get the CodecID for the given codec tag tag.
1230 * If no codec id is found returns CODEC_ID_NONE.
1231 *
1232 * @param tags list of supported codec_id-codec_tag pairs, as stored
1233 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1234 */
1235 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1236
1237 /**
1238 * Get the codec tag for the given codec id id.
1239 * If no codec tag is found returns 0.
1240 *
1241 * @param tags list of supported codec_id-codec_tag pairs, as stored
1242 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1243 */
1244 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1245
1246 /**
1247 * Allocate an AVFormatContext.
1248 * avformat_free_context() can be used to free the context and everything
1249 * allocated by the framework within it.
1250 */
1251 AVFormatContext *avformat_alloc_context(void);
1252
1253 /**
1254 * @addtogroup lavf_decoding
1255 * @{
1256 */
1257
1258 /**
1259 * Find AVInputFormat based on the short name of the input format.
1260 */
1261 AVInputFormat *av_find_input_format(const char *short_name);
1262
1263 /**
1264 * Guess the file format.
1265 *
1266 * @param is_opened Whether the file is already opened; determines whether
1267 * demuxers with or without AVFMT_NOFILE are probed.
1268 */
1269 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1270
1271 /**
1272 * Guess the file format.
1273 *
1274 * @param is_opened Whether the file is already opened; determines whether
1275 * demuxers with or without AVFMT_NOFILE are probed.
1276 * @param score_max A probe score larger that this is required to accept a
1277 * detection, the variable is set to the actual detection
1278 * score afterwards.
1279 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1280 * to retry with a larger probe buffer.
1281 */
1282 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1283
1284 /**
1285 * Probe a bytestream to determine the input format. Each time a probe returns
1286 * with a score that is too low, the probe buffer size is increased and another
1287 * attempt is made. When the maximum probe size is reached, the input format
1288 * with the highest score is returned.
1289 *
1290 * @param pb the bytestream to probe
1291 * @param fmt the input format is put here
1292 * @param filename the filename of the stream
1293 * @param logctx the log context
1294 * @param offset the offset within the bytestream to probe from
1295 * @param max_probe_size the maximum probe buffer size (zero for default)
1296 * @return 0 in case of success, a negative value corresponding to an
1297 * AVERROR code otherwise
1298 */
1299 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1300 const char *filename, void *logctx,
1301 unsigned int offset, unsigned int max_probe_size);
1302
1303 #if FF_API_FORMAT_PARAMETERS
1304 /**
1305 * Allocate all the structures needed to read an input stream.
1306 * This does not open the needed codecs for decoding the stream[s].
1307 * @deprecated use avformat_open_input instead.
1308 */
1309 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1310 AVIOContext *pb, const char *filename,
1311 AVInputFormat *fmt, AVFormatParameters *ap);
1312
1313 /**
1314 * Open a media file as input. The codecs are not opened. Only the file
1315 * header (if present) is read.
1316 *
1317 * @param ic_ptr The opened media file handle is put here.
1318 * @param filename filename to open
1319 * @param fmt If non-NULL, force the file format to use.
1320 * @param buf_size optional buffer size (zero if default is OK)
1321 * @param ap Additional parameters needed when opening the file
1322 * (NULL if default).
1323 * @return 0 if OK, AVERROR_xxx otherwise
1324 *
1325 * @deprecated use avformat_open_input instead.
1326 */
1327 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1328 AVInputFormat *fmt,
1329 int buf_size,
1330 AVFormatParameters *ap);
1331 #endif
1332
1333 /**
1334 * Open an input stream and read the header. The codecs are not opened.
1335 * The stream must be closed with av_close_input_file().
1336 *
1337 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1338 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1339 * function and written into ps.
1340 * Note that a user-supplied AVFormatContext will be freed on failure.
1341 * @param filename Name of the stream to open.
1342 * @param fmt If non-NULL, this parameter forces a specific input format.
1343 * Otherwise the format is autodetected.
1344 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1345 * On return this parameter will be destroyed and replaced with a dict containing
1346 * options that were not found. May be NULL.
1347 *
1348 * @return 0 on success, a negative AVERROR on failure.
1349 *
1350 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1351 */
1352 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1353
1354 #if FF_API_FORMAT_PARAMETERS
1355 /**
1356 * Read packets of a media file to get stream information. This
1357 * is useful for file formats with no headers such as MPEG. This
1358 * function also computes the real framerate in case of MPEG-2 repeat
1359 * frame mode.
1360 * The logical file position is not changed by this function;
1361 * examined packets may be buffered for later processing.
1362 *
1363 * @param ic media file handle
1364 * @return >=0 if OK, AVERROR_xxx on error
1365 * @todo Let the user decide somehow what information is needed so that
1366 * we do not waste time getting stuff the user does not need.
1367 *
1368 * @deprecated use avformat_find_stream_info.
1369 */
1370 attribute_deprecated
1371 int av_find_stream_info(AVFormatContext *ic);
1372 #endif
1373
1374 /**
1375 * Read packets of a media file to get stream information. This
1376 * is useful for file formats with no headers such as MPEG. This
1377 * function also computes the real framerate in case of MPEG-2 repeat
1378 * frame mode.
1379 * The logical file position is not changed by this function;
1380 * examined packets may be buffered for later processing.
1381 *
1382 * @param ic media file handle
1383 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1384 * dictionaries, where i-th member contains options for
1385 * codec corresponding to i-th stream.
1386 * On return each dictionary will be filled with options that were not found.
1387 * @return >=0 if OK, AVERROR_xxx on error
1388 *
1389 * @note this function isn't guaranteed to open all the codecs, so
1390 * options being non-empty at return is a perfectly normal behavior.
1391 *
1392 * @todo Let the user decide somehow what information is needed so that
1393 * we do not waste time getting stuff the user does not need.
1394 */
1395 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1396
1397 /**
1398 * Find the "best" stream in the file.
1399 * The best stream is determined according to various heuristics as the most
1400 * likely to be what the user expects.
1401 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1402 * default decoder for the stream's codec; streams for which no decoder can
1403 * be found are ignored.
1404 *
1405 * @param ic media file handle
1406 * @param type stream type: video, audio, subtitles, etc.
1407 * @param wanted_stream_nb user-requested stream number,
1408 * or -1 for automatic selection
1409 * @param related_stream try to find a stream related (eg. in the same
1410 * program) to this one, or -1 if none
1411 * @param decoder_ret if non-NULL, returns the decoder for the
1412 * selected stream
1413 * @param flags flags; none are currently defined
1414 * @return the non-negative stream number in case of success,
1415 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1416 * could be found,
1417 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1418 * @note If av_find_best_stream returns successfully and decoder_ret is not
1419 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1420 */
1421 int av_find_best_stream(AVFormatContext *ic,
1422 enum AVMediaType type,
1423 int wanted_stream_nb,
1424 int related_stream,
1425 AVCodec **decoder_ret,
1426 int flags);
1427
1428 /**
1429 * Read a transport packet from a media file.
1430 *
1431 * This function is obsolete and should never be used.
1432 * Use av_read_frame() instead.
1433 *
1434 * @param s media file handle
1435 * @param pkt is filled
1436 * @return 0 if OK, AVERROR_xxx on error
1437 */
1438 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1439
1440 /**
1441 * Return the next frame of a stream.
1442 * This function returns what is stored in the file, and does not validate
1443 * that what is there are valid frames for the decoder. It will split what is
1444 * stored in the file into frames and return one for each call. It will not
1445 * omit invalid data between valid frames so as to give the decoder the maximum
1446 * information possible for decoding.
1447 *
1448 * The returned packet is valid
1449 * until the next av_read_frame() or until av_close_input_file() and
1450 * must be freed with av_free_packet. For video, the packet contains
1451 * exactly one frame. For audio, it contains an integer number of
1452 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1453 * data). If the audio frames have a variable size (e.g. MPEG audio),
1454 * then it contains one frame.
1455 *
1456 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1457 * values in AVStream.time_base units (and guessed if the format cannot
1458 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1459 * has B-frames, so it is better to rely on pkt->dts if you do not
1460 * decompress the payload.
1461 *
1462 * @return 0 if OK, < 0 on error or end of file
1463 */
1464 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1465
1466 /**
1467 * Seek to the keyframe at timestamp.
1468 * 'timestamp' in 'stream_index'.
1469 * @param stream_index If stream_index is (-1), a default
1470 * stream is selected, and timestamp is automatically converted
1471 * from AV_TIME_BASE units to the stream specific time_base.
1472 * @param timestamp Timestamp in AVStream.time_base units
1473 * or, if no stream is specified, in AV_TIME_BASE units.
1474 * @param flags flags which select direction and seeking mode
1475 * @return >= 0 on success
1476 */
1477 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1478 int flags);
1479
1480 /**
1481 * Seek to timestamp ts.
1482 * Seeking will be done so that the point from which all active streams
1483 * can be presented successfully will be closest to ts and within min/max_ts.
1484 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1485 *
1486 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1487 * are the file position (this may not be supported by all demuxers).
1488 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1489 * in the stream with stream_index (this may not be supported by all demuxers).
1490 * Otherwise all timestamps are in units of the stream selected by stream_index
1491 * or if stream_index is -1, in AV_TIME_BASE units.
1492 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1493 * keyframes (this may not be supported by all demuxers).
1494 *
1495 * @param stream_index index of the stream which is used as time base reference
1496 * @param min_ts smallest acceptable timestamp
1497 * @param ts target timestamp
1498 * @param max_ts largest acceptable timestamp
1499 * @param flags flags
1500 * @return >=0 on success, error code otherwise
1501 *
1502 * @note This is part of the new seek API which is still under construction.
1503 * Thus do not use this yet. It may change at any time, do not expect
1504 * ABI compatibility yet!
1505 */
1506 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1507
1508 /**
1509 * Start playing a network-based stream (e.g. RTSP stream) at the
1510 * current position.
1511 */
1512 int av_read_play(AVFormatContext *s);
1513
1514 /**
1515 * Pause a network-based stream (e.g. RTSP stream).
1516 *
1517 * Use av_read_play() to resume it.
1518 */
1519 int av_read_pause(AVFormatContext *s);
1520
1521 /**
1522 * Free a AVFormatContext allocated by av_open_input_stream.
1523 * @param s context to free
1524 */
1525 void av_close_input_stream(AVFormatContext *s);
1526
1527 /**
1528 * Close a media file (but not its codecs).
1529 *
1530 * @param s media file handle
1531 */
1532 void av_close_input_file(AVFormatContext *s);
1533 /**
1534 * @}
1535 */
1536
1537 /**
1538 * Free an AVFormatContext and all its streams.
1539 * @param s context to free
1540 */
1541 void avformat_free_context(AVFormatContext *s);
1542
1543 #if FF_API_NEW_STREAM
1544 /**
1545 * Add a new stream to a media file.
1546 *
1547 * Can only be called in the read_header() function. If the flag
1548 * AVFMTCTX_NOHEADER is in the format context, then new streams
1549 * can be added in read_packet too.
1550 *
1551 * @param s media file handle
1552 * @param id file-format-dependent stream ID
1553 */
1554 attribute_deprecated
1555 AVStream *av_new_stream(AVFormatContext *s, int id);
1556 #endif
1557
1558 /**
1559 * Add a new stream to a media file.
1560 *
1561 * When demuxing, it is called by the demuxer in read_header(). If the
1562 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1563 * be called in read_packet().
1564 *
1565 * When muxing, should be called by the user before avformat_write_header().
1566 *
1567 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1568 * will be initialized to use this codec. This is needed for e.g. codec-specific
1569 * defaults to be set, so codec should be provided if it is known.
1570 *
1571 * @return newly created stream or NULL on error.
1572 */
1573 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1574
1575 AVProgram *av_new_program(AVFormatContext *s, int id);
1576
1577 #if FF_API_SET_PTS_INFO
1578 /**
1579 * @deprecated this function is not supposed to be called outside of lavf
1580 */
1581 attribute_deprecated
1582 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1583 unsigned int pts_num, unsigned int pts_den);
1584 #endif
1585
1586 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1587 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1588 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1589 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1590
1591 int av_find_default_stream_index(AVFormatContext *s);
1592
1593 /**
1594 * Get the index for a specific timestamp.
1595 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1596 * to the timestamp which is <= the requested one, if backward
1597 * is 0, then it will be >=
1598 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1599 * @return < 0 if no such timestamp could be found
1600 */
1601 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1602
1603 /**
1604 * Add an index entry into a sorted list. Update the entry if the list
1605 * already contains it.
1606 *
1607 * @param timestamp timestamp in the time base of the given stream
1608 */
1609 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1610 int size, int distance, int flags);
1611
1612 #if FF_API_SEEK_PUBLIC
1613 attribute_deprecated
1614 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1615 int64_t target_ts, int flags);
1616 attribute_deprecated
1617 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1618 attribute_deprecated
1619 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1620 int64_t target_ts, int64_t pos_min,
1621 int64_t pos_max, int64_t pos_limit,
1622 int64_t ts_min, int64_t ts_max,
1623 int flags, int64_t *ts_ret,
1624 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1625 #endif
1626
1627 #if FF_API_FORMAT_PARAMETERS
1628 /**
1629 * @deprecated pass the options to avformat_write_header directly.
1630 */
1631 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1632 #endif
1633
1634 /**
1635 * Split a URL string into components.
1636 *
1637 * The pointers to buffers for storing individual components may be null,
1638 * in order to ignore that component. Buffers for components not found are
1639 * set to empty strings. If the port is not found, it is set to a negative
1640 * value.
1641 *
1642 * @param proto the buffer for the protocol
1643 * @param proto_size the size of the proto buffer
1644 * @param authorization the buffer for the authorization
1645 * @param authorization_size the size of the authorization buffer
1646 * @param hostname the buffer for the host name
1647 * @param hostname_size the size of the hostname buffer
1648 * @param port_ptr a pointer to store the port number in
1649 * @param path the buffer for the path
1650 * @param path_size the size of the path buffer
1651 * @param url the URL to split
1652 */
1653 void av_url_split(char *proto, int proto_size,
1654 char *authorization, int authorization_size,
1655 char *hostname, int hostname_size,
1656 int *port_ptr,
1657 char *path, int path_size,
1658 const char *url);
1659 /**
1660 * @addtogroup lavf_encoding
1661 * @{
1662 */
1663 /**
1664 * Allocate the stream private data and write the stream header to
1665 * an output media file.
1666 *
1667 * @param s Media file handle, must be allocated with avformat_alloc_context().
1668 * Its oformat field must be set to the desired output format;
1669 * Its pb field must be set to an already openened AVIOContext.
1670 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1671 * On return this parameter will be destroyed and replaced with a dict containing
1672 * options that were not found. May be NULL.
1673 *
1674 * @return 0 on success, negative AVERROR on failure.
1675 *
1676 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1677 */
1678 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1679
1680 #if FF_API_FORMAT_PARAMETERS
1681 /**
1682 * Allocate the stream private data and write the stream header to an
1683 * output media file.
1684 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1685 * but for some formats it might also be some other time base
1686 *
1687 * @param s media file handle
1688 * @return 0 if OK, AVERROR_xxx on error
1689 *
1690 * @deprecated use avformat_write_header.
1691 */
1692 attribute_deprecated int av_write_header(AVFormatContext *s);
1693 #endif
1694
1695 /**
1696 * Write a packet to an output media file.
1697 *
1698 * The packet shall contain one audio or video frame.
1699 * The packet must be correctly interleaved according to the container
1700 * specification, if not then av_interleaved_write_frame must be used.
1701 *
1702 * @param s media file handle
1703 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1704 dts/pts, ...
1705 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1706 */
1707 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1708
1709 /**
1710 * Write a packet to an output media file ensuring correct interleaving.
1711 *
1712 * The packet must contain one audio or video frame.
1713 * If the packets are already correctly interleaved, the application should
1714 * call av_write_frame() instead as it is slightly faster. It is also important
1715 * to keep in mind that completely non-interleaved input will need huge amounts
1716 * of memory to interleave with this, so it is preferable to interleave at the
1717 * demuxer level.
1718 *
1719 * @param s media file handle
1720 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1721 dts/pts, ...
1722 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1723 */
1724 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1725
1726 /**
1727 * Interleave a packet per dts in an output media file.
1728 *
1729 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1730 * function, so they cannot be used after it. Note that calling av_free_packet()
1731 * on them is still safe.
1732 *
1733 * @param s media file handle
1734 * @param out the interleaved packet will be output here
1735 * @param pkt the input packet
1736 * @param flush 1 if no further packets are available as input and all
1737 * remaining packets should be output
1738 * @return 1 if a packet was output, 0 if no packet could be output,
1739 * < 0 if an error occurred
1740 */
1741 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1742 AVPacket *pkt, int flush);
1743
1744 /**
1745 * Write the stream trailer to an output media file and free the
1746 * file private data.
1747 *
1748 * May only be called after a successful call to av_write_header.
1749 *
1750 * @param s media file handle
1751 * @return 0 if OK, AVERROR_xxx on error
1752 */
1753 int av_write_trailer(AVFormatContext *s);
1754 /**
1755 * @}
1756 */
1757
1758 #if FF_API_DUMP_FORMAT
1759 attribute_deprecated void dump_format(AVFormatContext *ic,
1760 int index,
1761 const char *url,
1762 int is_output);
1763 #endif
1764
1765 void av_dump_format(AVFormatContext *ic,
1766 int index,
1767 const char *url,
1768 int is_output);
1769
1770 #if FF_API_PARSE_DATE
1771 /**
1772 * Parse datestr and return a corresponding number of microseconds.
1773 *
1774 * @param datestr String representing a date or a duration.
1775 * See av_parse_time() for the syntax of the provided string.
1776 * @deprecated in favor of av_parse_time()
1777 */
1778 attribute_deprecated
1779 int64_t parse_date(const char *datestr, int duration);
1780 #endif
1781
1782 /**
1783 * Get the current time in microseconds.
1784 */
1785 int64_t av_gettime(void);
1786
1787 #if FF_API_FIND_INFO_TAG
1788 /**
1789 * @deprecated use av_find_info_tag in libavutil instead.
1790 */
1791 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1792 #endif
1793
1794 /**
1795 * Return in 'buf' the path with '%d' replaced by a number.
1796 *
1797 * Also handles the '%0nd' format where 'n' is the total number
1798 * of digits and '%%'.
1799 *
1800 * @param buf destination buffer
1801 * @param buf_size destination buffer size
1802 * @param path numbered sequence string
1803 * @param number frame number
1804 * @return 0 if OK, -1 on format error
1805 */
1806 int av_get_frame_filename(char *buf, int buf_size,
1807 const char *path, int number);
1808
1809 /**
1810 * Check whether filename actually is a numbered sequence generator.
1811 *
1812 * @param filename possible numbered sequence string
1813 * @return 1 if a valid numbered sequence string, 0 otherwise
1814 */
1815 int av_filename_number_test(const char *filename);
1816
1817 /**
1818 * Generate an SDP for an RTP session.
1819 *
1820 * @param ac array of AVFormatContexts describing the RTP streams. If the
1821 * array is composed by only one context, such context can contain
1822 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1823 * all the contexts in the array (an AVCodecContext per RTP stream)
1824 * must contain only one AVStream.
1825 * @param n_files number of AVCodecContexts contained in ac
1826 * @param buf buffer where the SDP will be stored (must be allocated by
1827 * the caller)
1828 * @param size the size of the buffer
1829 * @return 0 if OK, AVERROR_xxx on error
1830 */
1831 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1832
1833 #if FF_API_SDP_CREATE
1834 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1835 #endif
1836
1837 /**
1838 * Return a positive value if the given filename has one of the given
1839 * extensions, 0 otherwise.
1840 *
1841 * @param extensions a comma-separated list of filename extensions
1842 */
1843 int av_match_ext(const char *filename, const char *extensions);
1844
1845 /**
1846 * Test if the given container can store a codec.
1847 *
1848 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1849 *
1850 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1851 * A negative number if this information is not available.
1852 */
1853 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1854
1855 /**
1856 * Get the AVClass for AVFormatContext. It can be used in combination with
1857 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1858 *
1859 * @see av_opt_find().
1860 */
1861 const AVClass *avformat_get_class(void);
1862
1863 /**
1864 * Do global initialization of network components. This is optional,
1865 * but recommended, since it avoids the overhead of implicitly
1866 * doing the setup for each session.
1867 *
1868 * Calling this function will become mandatory if using network
1869 * protocols at some major version bump.
1870 */
1871 int avformat_network_init(void);
1872
1873 /**
1874 * Undo the initialization done by avformat_network_init.
1875 */
1876 int avformat_network_deinit(void);
1877
1878 #endif /* AVFORMAT_AVFORMAT_H */