2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVFORMAT_AVFORMAT_H
22 #define AVFORMAT_AVFORMAT_H
26 * Return the LIBAVFORMAT_VERSION_INT constant.
28 unsigned avformat_version(void);
31 * Return the libavformat build-time configuration.
33 const char *avformat_configuration(void);
36 * Return the libavformat license.
38 const char *avformat_license(void);
41 #include <stdio.h> /* FILE */
42 #include "libavcodec/avcodec.h"
43 #include "libavutil/dict.h"
44 #include "libavutil/log.h"
47 #include "libavformat/version.h"
49 struct AVFormatContext;
53 * @defgroup metadata_api Public Metadata API
55 * The metadata API allows libavformat to export metadata tags to a client
56 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
57 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
58 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
59 * Important concepts to keep in mind:
60 * - Keys are unique; there can never be 2 tags with the same key. This is
61 * also meant semantically, i.e., a demuxer should not knowingly produce
62 * several keys that are literally different but semantically identical.
63 * E.g., key=Author5, key=Author6. In this example, all authors must be
64 * placed in the same tag.
65 * - Metadata is flat, not hierarchical; there are no subtags. If you
66 * want to store, e.g., the email address of the child of producer Alice
67 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
68 * - Several modifiers can be applied to the tag name. This is done by
69 * appending a dash character ('-') and the modifier name in the order
70 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
71 * - language -- a tag whose value is localized for a particular language
72 * is appended with the ISO 639-2/B 3-letter language code.
73 * For example: Author-ger=Michael, Author-eng=Mike
74 * The original/default language is in the unqualified "Author" tag.
75 * A demuxer should set a default if it sets any translated tag.
76 * - sorting -- a modified version of a tag that should be used for
77 * sorting will have '-sort' appended. E.g. artist="The Beatles",
78 * artist-sort="Beatles, The".
80 * - Demuxers attempt to export metadata in a generic format, however tags
81 * with no generic equivalents are left as they are stored in the container.
82 * Follows a list of generic tag names:
85 album -- name of the set this work belongs to
86 album_artist -- main creator of the set/album, if different from artist.
87 e.g. "Various Artists" for compilation albums.
88 artist -- main creator of the work
89 comment -- any additional description of the file.
90 composer -- who composed the work, if different from artist.
91 copyright -- name of copyright holder.
92 creation_time-- date when the file was created, preferably in ISO 8601.
93 date -- date when the work was created, preferably in ISO 8601.
94 disc -- number of a subset, e.g. disc in a multi-disc collection.
95 encoder -- name/settings of the software/hardware that produced the file.
96 encoded_by -- person/group who created the file.
97 filename -- original name of the file.
98 genre -- <self-evident>.
99 language -- main language in which the work is performed, preferably
100 in ISO 639-2 format. Multiple languages can be specified by
101 separating them with commas.
102 performer -- artist who performed the work, if different from artist.
103 E.g for "Also sprach Zarathustra", artist would be "Richard
104 Strauss" and performer "London Philharmonic Orchestra".
105 publisher -- name of the label/publisher.
106 service_name -- name of the service in broadcasting (channel name).
107 service_provider -- name of the service provider in broadcasting.
108 title -- name of the work.
109 track -- number of this work in the set, can be in form current/total.
110 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
113 * Look in the examples section for an application example how to use the Metadata API.
118 #if FF_API_OLD_METADATA2
120 * @defgroup old_metadata Old metadata API
121 * The following functions are deprecated, use
122 * their equivalents from libavutil/dict.h instead.
126 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
127 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
128 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
129 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
130 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
132 typedef attribute_deprecated AVDictionary AVMetadata;
133 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
135 typedef struct AVMetadataConv AVMetadataConv;
138 * Get a metadata element with matching key.
140 * @param prev Set to the previous matching element to find the next.
141 * If set to NULL the first matching element is returned.
142 * @param flags Allows case as well as suffix-insensitive comparisons.
143 * @return Found tag or NULL, changing key or value leads to undefined behavior.
145 attribute_deprecated AVDictionaryEntry *
146 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
149 * Set the given tag in *pm, overwriting an existing tag.
151 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
152 * a metadata struct is allocated and put in *pm.
153 * @param key tag key to add to *pm (will be av_strduped depending on flags)
154 * @param value tag value to add to *pm (will be av_strduped depending on flags).
155 * Passing a NULL value will cause an existing tag to be deleted.
156 * @return >= 0 on success otherwise an error code <0
158 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
161 * This function is provided for compatibility reason and currently does nothing.
163 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
164 const AVMetadataConv *s_conv);
167 * Copy metadata from one AVDictionary struct into another.
168 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
169 * this function will allocate a struct for you and put it in *dst
170 * @param src pointer to source AVDictionary struct
171 * @param flags flags to use when setting metadata in *dst
172 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
174 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
177 * Free all the memory allocated for an AVDictionary struct.
179 attribute_deprecated void av_metadata_free(AVDictionary **m);
186 /* packet functions */
190 * Allocate and read the payload of a packet and initialize its
191 * fields with default values.
194 * @param size desired payload size
195 * @return >0 (read size) if OK, AVERROR_xxx otherwise
197 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
201 * Read data and append it to the current content of the AVPacket.
202 * If pkt->size is 0 this is identical to av_get_packet.
203 * Note that this uses av_grow_packet and thus involves a realloc
204 * which is inefficient. Thus this function should only be used
205 * when there is no reasonable way to know (an upper bound of)
209 * @param size amount of data to read
210 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
211 * will not be lost even if an error occurs.
213 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
215 /*************************************************/
216 /* fractional numbers for exact pts handling */
219 * The exact value of the fractional number is: 'val + num / den'.
220 * num is assumed to be 0 <= num < den.
222 typedef struct AVFrac {
223 int64_t val, num, den;
226 /*************************************************/
227 /* input/output formats */
232 * This structure contains the data a format has to probe a file.
234 typedef struct AVProbeData {
235 const char *filename;
236 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
237 int buf_size; /**< Size of buf except extra allocated bytes */
240 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
241 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
243 typedef struct AVFormatParameters {
244 #if FF_API_FORMAT_PARAMETERS
245 attribute_deprecated AVRational time_base;
246 attribute_deprecated int sample_rate;
247 attribute_deprecated int channels;
248 attribute_deprecated int width;
249 attribute_deprecated int height;
250 attribute_deprecated enum PixelFormat pix_fmt;
251 attribute_deprecated int channel; /**< Used to select DV channel. */
252 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
253 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
254 /**< deprecated, use mpegtsraw demuxer-specific options instead */
255 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
256 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
257 immediately (RTSP only). */
258 attribute_deprecated unsigned int prealloced_context:1;
260 } AVFormatParameters;
262 //! Demuxer will use avio_open, no opened file should be provided by the caller.
263 #define AVFMT_NOFILE 0x0001
264 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
265 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
266 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
268 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
269 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
270 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
271 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
272 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
273 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
274 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
275 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
276 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
277 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */
278 #define AVFMT_TS_NONSTRICT 0x8000000 /**< Format does not require strictly
279 increasing timestamps, but they must
280 still be monotonic */
282 typedef struct AVOutputFormat {
285 * Descriptive name for the format, meant to be more human-readable
286 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
289 const char *long_name;
290 const char *mime_type;
291 const char *extensions; /**< comma-separated filename extensions */
293 * size of private data so that it can be allocated in the wrapper
297 enum CodecID audio_codec; /**< default audio codec */
298 enum CodecID video_codec; /**< default video codec */
299 int (*write_header)(struct AVFormatContext *);
300 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
301 int (*write_trailer)(struct AVFormatContext *);
303 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
304 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
305 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
311 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
312 AVPacket *in, int flush);
315 * List of supported codec_id-codec_tag pairs, ordered by "better
316 * choice first". The arrays are all terminated by CODEC_ID_NONE.
318 const struct AVCodecTag * const *codec_tag;
320 enum CodecID subtitle_codec; /**< default subtitle codec */
322 #if FF_API_OLD_METADATA2
323 const AVMetadataConv *metadata_conv;
326 const AVClass *priv_class; ///< AVClass for the private context
329 * Test if the given codec can be stored in this container.
331 * @return 1 if the codec is supported, 0 if it is not.
332 * A negative number if unknown.
334 int (*query_codec)(enum CodecID id, int std_compliance);
336 void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
337 int64_t *dts, int64_t *wall);
340 struct AVOutputFormat *next;
343 typedef struct AVInputFormat {
345 * A comma separated list of short names for the format. New names
346 * may be appended with a minor bump.
351 * Descriptive name for the format, meant to be more human-readable
352 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
355 const char *long_name;
358 * Size of private data so that it can be allocated in the wrapper.
363 * Tell if a given file has a chance of being parsed as this format.
364 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
365 * big so you do not have to check for that unless you need more.
367 int (*read_probe)(AVProbeData *);
370 * Read the format header and initialize the AVFormatContext
371 * structure. Return 0 if OK. 'ap' if non-NULL contains
372 * additional parameters. Only used in raw format right
373 * now. 'av_new_stream' should be called to create new streams.
375 int (*read_header)(struct AVFormatContext *,
376 AVFormatParameters *ap);
379 * Read one packet and put it in 'pkt'. pts and flags are also
380 * set. 'av_new_stream' can be called only if the flag
381 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
382 * background thread).
383 * @return 0 on success, < 0 on error.
384 * When returning an error, pkt must not have been allocated
385 * or must be freed before returning
387 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
390 * Close the stream. The AVFormatContext and AVStreams are not
391 * freed by this function
393 int (*read_close)(struct AVFormatContext *);
397 * Seek to a given timestamp relative to the frames in
398 * stream component stream_index.
399 * @param stream_index Must not be -1.
400 * @param flags Selects which direction should be preferred if no exact
401 * match is available.
402 * @return >= 0 on success (but not necessarily the new offset)
404 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
405 int stream_index, int64_t timestamp, int flags);
408 * Gets the next timestamp in stream[stream_index].time_base units.
409 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
411 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
412 int64_t *pos, int64_t pos_limit);
415 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS,
416 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH,
417 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK.
422 * If extensions are defined, then no probe is done. You should
423 * usually not use extension format guessing because it is not
426 const char *extensions;
429 * General purpose read-only value that the format can use.
434 * Start/resume playing - only meaningful if using a network-based format
437 int (*read_play)(struct AVFormatContext *);
440 * Pause playing - only meaningful if using a network-based format
443 int (*read_pause)(struct AVFormatContext *);
445 const struct AVCodecTag * const *codec_tag;
448 * Seek to timestamp ts.
449 * Seeking will be done so that the point from which all active streams
450 * can be presented successfully will be closest to ts and within min/max_ts.
451 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
453 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
455 #if FF_API_OLD_METADATA2
456 const AVMetadataConv *metadata_conv;
459 const AVClass *priv_class; ///< AVClass for the private context
462 struct AVInputFormat *next;
465 enum AVStreamParseType {
467 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
468 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
469 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
470 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
473 typedef struct AVIndexEntry {
475 int64_t timestamp; /**<
476 * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
477 * when seeking to this entry. That means preferable PTS on keyframe based formats.
478 * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
481 #define AVINDEX_KEYFRAME 0x0001
483 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).
484 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
487 #define AV_DISPOSITION_DEFAULT 0x0001
488 #define AV_DISPOSITION_DUB 0x0002
489 #define AV_DISPOSITION_ORIGINAL 0x0004
490 #define AV_DISPOSITION_COMMENT 0x0008
491 #define AV_DISPOSITION_LYRICS 0x0010
492 #define AV_DISPOSITION_KARAOKE 0x0020
495 * Track should be used during playback by default.
496 * Useful for subtitle track that should be displayed
497 * even when user did not explicitly ask for subtitles.
499 #define AV_DISPOSITION_FORCED 0x0040
500 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
501 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
502 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
506 * New fields can be added to the end with minor version bumps.
507 * Removal, reordering and changes to existing fields require a major
509 * sizeof(AVStream) must not be used outside libav*.
511 typedef struct AVStream {
512 int index; /**< stream index in AVFormatContext */
513 int id; /**< format-specific stream ID */
514 AVCodecContext *codec; /**< codec context */
516 * Real base framerate of the stream.
517 * This is the lowest framerate with which all timestamps can be
518 * represented accurately (it is the least common multiple of all
519 * framerates in the stream). Note, this value is just a guess!
520 * For example, if the time base is 1/90000 and all frames have either
521 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
523 AVRational r_frame_rate;
526 #if FF_API_REORDER_PRIVATE
527 /* internal data used in av_find_stream_info() */
532 * encoding: pts generation when outputting stream
537 * This is the fundamental unit of time (in seconds) in terms
538 * of which frame timestamps are represented. For fixed-fps content,
539 * time base should be 1/framerate and timestamp increments should be 1.
540 * decoding: set by libavformat
541 * encoding: set by libavformat in av_write_header
543 AVRational time_base;
544 #if FF_API_REORDER_PRIVATE
545 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
547 #if FF_API_STREAM_COPY
548 /* ffmpeg.c private use */
549 attribute_deprecated int stream_copy; /**< If set, just copy stream. */
551 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
553 #if FF_API_AVSTREAM_QUALITY
554 //FIXME move stuff to a flags field?
556 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
557 * MN: dunno if that is the right place for it
559 attribute_deprecated float quality;
563 * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
564 * Only set this if you are absolutely 100% sure that the value you set
565 * it to really is the pts of the first frame.
566 * This may be undefined (AV_NOPTS_VALUE).
567 * @note The ASF header does NOT contain a correct start_time the ASF
568 * demuxer must NOT set this.
573 * Decoding: duration of the stream, in stream time base.
574 * If a source file does not specify a duration, but does specify
575 * a bitrate, this value will be estimated from bitrate and file size.
579 #if FF_API_REORDER_PRIVATE
580 /* av_read_frame() support */
581 enum AVStreamParseType need_parsing;
582 struct AVCodecParserContext *parser;
585 int last_IP_duration;
587 /* av_seek_frame() support */
588 AVIndexEntry *index_entries; /**< Only used if the format does not
589 support seeking natively. */
590 int nb_index_entries;
591 unsigned int index_entries_allocated_size;
594 int64_t nb_frames; ///< number of frames in this stream if known or 0
596 int disposition; /**< AV_DISPOSITION_* bit field */
598 #if FF_API_REORDER_PRIVATE
599 AVProbeData probe_data;
600 #define MAX_REORDER_DELAY 16
601 int64_t pts_buffer[MAX_REORDER_DELAY+1];
605 * sample aspect ratio (0 if unknown)
606 * - encoding: Set by user.
607 * - decoding: Set by libavformat.
609 AVRational sample_aspect_ratio;
611 AVDictionary *metadata;
613 #if FF_API_REORDER_PRIVATE
614 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
615 /* external applications; try to use something else if at all possible. */
616 const uint8_t *cur_ptr;
620 // Timestamp generation support:
622 * Timestamp corresponding to the last dts sync point.
624 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
625 * a DTS is received from the underlying container. Otherwise set to
626 * AV_NOPTS_VALUE by default.
628 int64_t reference_dts;
631 * Number of packets to buffer for codec probing
632 * NOT PART OF PUBLIC API
634 #define MAX_PROBE_PACKETS 2500
638 * last packet in packet_buffer for this stream when muxing.
639 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
641 struct AVPacketList *last_in_packet_buffer;
647 AVRational avg_frame_rate;
649 /*****************************************************************
650 * All fields below this line are not part of the public API. They
651 * may not be used outside of libavformat and can be changed and
653 * New public fields should be added right above.
654 *****************************************************************
658 * Number of frames that have been demuxed during av_find_stream_info()
660 int codec_info_nb_frames;
664 * This is the MPEG-TS stream identifier +1
667 int stream_identifier;
670 * Stream informations used internally by av_find_stream_info()
672 #define MAX_STD_TIMEBASES (60*12+5)
675 int64_t duration_gcd;
677 double duration_error[2][2][MAX_STD_TIMEBASES];
678 int64_t codec_info_duration;
679 int nb_decoded_frames;
683 * flag to indicate that probing is requested
684 * NOT PART OF PUBLIC API
687 #if !FF_API_REORDER_PRIVATE
688 const uint8_t *cur_ptr;
692 // Timestamp generation support:
694 * Timestamp corresponding to the last dts sync point.
696 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
697 * a DTS is received from the underlying container. Otherwise set to
698 * AV_NOPTS_VALUE by default.
700 int64_t reference_dts;
703 int last_IP_duration;
707 * Number of packets to buffer for codec probing
709 #define MAX_PROBE_PACKETS 2500
713 * last packet in packet_buffer for this stream when muxing.
715 struct AVPacketList *last_in_packet_buffer;
716 AVProbeData probe_data;
717 #define MAX_REORDER_DELAY 16
718 int64_t pts_buffer[MAX_REORDER_DELAY+1];
719 /* av_read_frame() support */
720 enum AVStreamParseType need_parsing;
721 struct AVCodecParserContext *parser;
723 AVIndexEntry *index_entries; /**< Only used if the format does not
724 support seeking natively. */
725 int nb_index_entries;
726 unsigned int index_entries_allocated_size;
728 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
732 #define AV_PROGRAM_RUNNING 1
735 * New fields can be added to the end with minor version bumps.
736 * Removal, reordering and changes to existing fields require a major
738 * sizeof(AVProgram) must not be used outside libav*.
740 typedef struct AVProgram {
743 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
744 unsigned int *stream_index;
745 unsigned int nb_stream_indexes;
746 AVDictionary *metadata;
753 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
754 (streams are added dynamically) */
756 typedef struct AVChapter {
757 int id; ///< unique ID to identify the chapter
758 AVRational time_base; ///< time base in which the start/end timestamps are specified
759 int64_t start, end; ///< chapter start/end time in time_base units
760 AVDictionary *metadata;
764 * Format I/O context.
765 * New fields can be added to the end with minor version bumps.
766 * Removal, reordering and changes to existing fields require a major
768 * sizeof(AVFormatContext) must not be used outside libav*, use
769 * avformat_alloc_context() to create an AVFormatContext.
771 typedef struct AVFormatContext {
773 * A class for logging and AVOptions. Set by avformat_alloc_context().
774 * Exports (de)muxer private options if they exist.
776 const AVClass *av_class;
779 * Can only be iformat or oformat, not both at the same time.
781 * decoding: set by avformat_open_input().
782 * encoding: set by the user.
784 struct AVInputFormat *iformat;
785 struct AVOutputFormat *oformat;
788 * Format private data. This is an AVOptions-enabled struct
789 * if and only if iformat/oformat.priv_class is not NULL.
796 * decoding: either set by the user before avformat_open_input() (then
797 * the user must close it manually) or set by avformat_open_input().
798 * encoding: set by the user.
800 * Do NOT set this field if AVFMT_NOFILE flag is set in
801 * iformat/oformat.flags. In such a case, the (de)muxer will handle
802 * I/O in some other way and this field will be NULL.
807 * A list of all streams in the file. New streams are created with
808 * avformat_new_stream().
810 * decoding: streams are created by libavformat in avformat_open_input().
811 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also
812 * appear in av_read_frame().
813 * encoding: streams are created by the user before avformat_write_header().
815 unsigned int nb_streams;
818 char filename[1024]; /**< input or output filename */
822 * @deprecated use 'creation_time' metadata tag instead
824 attribute_deprecated int64_t timestamp;
827 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
828 #if FF_API_REORDER_PRIVATE
829 /* private data for pts handling (do not modify directly). */
831 * This buffer is only needed when packets were already buffered but
832 * not decoded, for example to get the codec parameters in MPEG
835 struct AVPacketList *packet_buffer;
839 * Decoding: position of the first frame of the component, in
840 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
841 * It is deduced from the AVStream values.
846 * Decoding: duration of the stream, in AV_TIME_BASE fractional
847 * seconds. Only set this value if you know none of the individual stream
848 * durations and also dont set any of them. This is deduced from the
849 * AVStream values if not set.
855 * decoding: total file size, 0 if unknown
857 attribute_deprecated int64_t file_size;
861 * Decoding: total stream bitrate in bit/s, 0 if not
862 * available. Never set it directly if the file_size and the
863 * duration are known as FFmpeg can compute it automatically.
867 #if FF_API_REORDER_PRIVATE
868 /* av_read_frame() support */
871 /* av_seek_frame() support */
872 int64_t data_offset; /**< offset of the first packet */
877 * use mpeg muxer private options instead
879 attribute_deprecated int mux_rate;
881 unsigned int packet_size;
883 attribute_deprecated int preload;
887 #if FF_API_LOOP_OUTPUT
888 #define AVFMT_NOOUTPUTLOOP -1
889 #define AVFMT_INFINITEOUTPUTLOOP 0
891 * number of times to loop output in formats that support it
893 * @deprecated use the 'loop' private option in the gif muxer.
895 attribute_deprecated int loop_output;
899 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
900 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
901 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
902 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
903 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
904 #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
905 #if FF_API_FLAG_RTP_HINT
906 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
908 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
909 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
910 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
911 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
912 #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)
913 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
915 #if FF_API_LOOP_INPUT
917 * @deprecated, use the 'loop' img2 demuxer private option.
919 attribute_deprecated int loop_input;
923 * decoding: size of data to probe; encoding: unused.
925 unsigned int probesize;
928 * decoding: maximum time (in AV_TIME_BASE units) during which the input should
929 * be analyzed in avformat_find_stream_info().
931 int max_analyze_duration;
936 unsigned int nb_programs;
937 AVProgram **programs;
940 * Forced video codec_id.
941 * Demuxing: Set by user.
943 enum CodecID video_codec_id;
946 * Forced audio codec_id.
947 * Demuxing: Set by user.
949 enum CodecID audio_codec_id;
952 * Forced subtitle codec_id.
953 * Demuxing: Set by user.
955 enum CodecID subtitle_codec_id;
958 * Maximum amount of memory in bytes to use for the index of each stream.
959 * If the index exceeds this size, entries will be discarded as
960 * needed to maintain a smaller size. This can lead to slower or less
961 * accurate seeking (depends on demuxer).
962 * Demuxers for which a full in-memory index is mandatory will ignore
965 * demuxing: set by user
967 unsigned int max_index_size;
970 * Maximum amount of memory in bytes to use for buffering frames
971 * obtained from realtime capture devices.
973 unsigned int max_picture_buffer;
975 unsigned int nb_chapters;
976 AVChapter **chapters;
979 * Flags to enable debugging.
982 #define FF_FDEBUG_TS 0x0001
984 #if FF_API_REORDER_PRIVATE
986 * Raw packets from the demuxer, prior to parsing and decoding.
987 * This buffer is used for buffering packets until the codec can
988 * be identified, as parsing cannot be done without knowing the
991 struct AVPacketList *raw_packet_buffer;
992 struct AVPacketList *raw_packet_buffer_end;
994 struct AVPacketList *packet_buffer_end;
997 AVDictionary *metadata;
999 #if FF_API_REORDER_PRIVATE
1001 * Remaining size available for raw_packet_buffer, in bytes.
1002 * NOT PART OF PUBLIC API
1004 #define RAW_PACKET_BUFFER_SIZE 2500000
1005 int raw_packet_buffer_remaining_size;
1009 * Start time of the stream in real world time, in microseconds
1010 * since the unix epoch (00:00 1st January 1970). That is, pts=0
1011 * in the stream was captured at this real world time.
1012 * - encoding: Set by user.
1013 * - decoding: Unused.
1015 int64_t start_time_realtime;
1018 * decoding: number of frames used to probe fps
1023 * Error recognition; higher values will detect more errors but may
1024 * misdetect some more or less valid parts as errors.
1025 * - encoding: unused
1026 * - decoding: Set by user.
1028 int error_recognition;
1031 * Custom interrupt callbacks for the I/O layer.
1033 * decoding: set by the user before avformat_open_input().
1034 * encoding: set by the user before avformat_write_header()
1035 * (mainly useful for AVFMT_NOFILE formats). The callback
1036 * should also be passed to avio_open2() if it's used to
1039 AVIOInterruptCB interrupt_callback;
1042 * Transport stream id.
1043 * This will be moved into demuxer private options. Thus no API/ABI compatibility
1048 /*****************************************************************
1049 * All fields below this line are not part of the public API. They
1050 * may not be used outside of libavformat and can be changed and
1052 * New public fields should be added right above.
1053 *****************************************************************
1055 #if !FF_API_REORDER_PRIVATE
1057 * Raw packets from the demuxer, prior to parsing and decoding.
1058 * This buffer is used for buffering packets until the codec can
1059 * be identified, as parsing cannot be done without knowing the
1062 struct AVPacketList *raw_packet_buffer;
1063 struct AVPacketList *raw_packet_buffer_end;
1065 * Remaining size available for raw_packet_buffer, in bytes.
1067 #define RAW_PACKET_BUFFER_SIZE 2500000
1068 int raw_packet_buffer_remaining_size;
1071 * This buffer is only needed when packets were already buffered but
1072 * not decoded, for example to get the codec parameters in MPEG
1075 struct AVPacketList *packet_buffer;
1076 struct AVPacketList *packet_buffer_end;
1078 /* av_read_frame() support */
1081 /* av_seek_frame() support */
1082 int64_t data_offset; /**< offset of the first packet */
1086 typedef struct AVPacketList {
1088 struct AVPacketList *next;
1092 * If f is NULL, returns the first registered input format,
1093 * if f is non-NULL, returns the next registered input format after f
1094 * or NULL if f is the last one.
1096 AVInputFormat *av_iformat_next(AVInputFormat *f);
1099 * If f is NULL, returns the first registered output format,
1100 * if f is non-NULL, returns the next registered output format after f
1101 * or NULL if f is the last one.
1103 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1105 #if FF_API_GUESS_IMG2_CODEC
1106 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
1109 /* XXX: Use automatic init with either ELF sections or C file parser */
1113 void av_register_input_format(AVInputFormat *format);
1114 void av_register_output_format(AVOutputFormat *format);
1117 * Return the output format in the list of registered output formats
1118 * which best matches the provided parameters, or return NULL if
1119 * there is no match.
1121 * @param short_name if non-NULL checks if short_name matches with the
1122 * names of the registered formats
1123 * @param filename if non-NULL checks if filename terminates with the
1124 * extensions of the registered formats
1125 * @param mime_type if non-NULL checks if mime_type matches with the
1126 * MIME type of the registered formats
1128 AVOutputFormat *av_guess_format(const char *short_name,
1129 const char *filename,
1130 const char *mime_type);
1133 * Guess the codec ID based upon muxer and filename.
1135 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1136 const char *filename, const char *mime_type,
1137 enum AVMediaType type);
1140 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1142 * @param f The file stream pointer where the dump should be sent to.
1144 * @param size buffer size
1146 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1148 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1151 * Send a nice hexadecimal dump of a buffer to the log.
1153 * @param avcl A pointer to an arbitrary struct of which the first field is a
1154 * pointer to an AVClass struct.
1155 * @param level The importance level of the message, lower values signifying
1156 * higher importance.
1158 * @param size buffer size
1160 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1162 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1165 * Send a nice dump of a packet to the specified file stream.
1167 * @param f The file stream pointer where the dump should be sent to.
1168 * @param pkt packet to dump
1169 * @param dump_payload True if the payload must be displayed, too.
1170 * @param st AVStream that the packet belongs to
1172 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1176 * Send a nice dump of a packet to the log.
1178 * @param avcl A pointer to an arbitrary struct of which the first field is a
1179 * pointer to an AVClass struct.
1180 * @param level The importance level of the message, lower values signifying
1181 * higher importance.
1182 * @param pkt packet to dump
1183 * @param dump_payload True if the payload must be displayed, too.
1184 * @param st AVStream that the packet belongs to
1186 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1190 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1191 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1196 * Initialize libavformat and register all the muxers, demuxers and
1197 * protocols. If you do not call this function, then you can select
1198 * exactly which formats you want to support.
1200 * @see av_register_input_format()
1201 * @see av_register_output_format()
1202 * @see av_register_protocol()
1204 void av_register_all(void);
1207 * Get the CodecID for the given codec tag tag.
1208 * If no codec id is found returns CODEC_ID_NONE.
1210 * @param tags list of supported codec_id-codec_tag pairs, as stored
1211 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1213 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1216 * Get the codec tag for the given codec id id.
1217 * If no codec tag is found returns 0.
1219 * @param tags list of supported codec_id-codec_tag pairs, as stored
1220 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1222 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1224 /* media file input */
1227 * Find AVInputFormat based on the short name of the input format.
1229 AVInputFormat *av_find_input_format(const char *short_name);
1232 * Guess the file format.
1234 * @param is_opened Whether the file is already opened; determines whether
1235 * demuxers with or without AVFMT_NOFILE are probed.
1237 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1240 * Guess the file format.
1242 * @param is_opened Whether the file is already opened; determines whether
1243 * demuxers with or without AVFMT_NOFILE are probed.
1244 * @param score_max A probe score larger that this is required to accept a
1245 * detection, the variable is set to the actual detection
1247 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1248 * to retry with a larger probe buffer.
1250 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1253 * Guess the file format.
1255 * @param is_opened Whether the file is already opened; determines whether
1256 * demuxers with or without AVFMT_NOFILE are probed.
1257 * @param score_ret The score of the best detection.
1259 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1262 * Probe a bytestream to determine the input format. Each time a probe returns
1263 * with a score that is too low, the probe buffer size is increased and another
1264 * attempt is made. When the maximum probe size is reached, the input format
1265 * with the highest score is returned.
1267 * @param pb the bytestream to probe
1268 * @param fmt the input format is put here
1269 * @param filename the filename of the stream
1270 * @param logctx the log context
1271 * @param offset the offset within the bytestream to probe from
1272 * @param max_probe_size the maximum probe buffer size (zero for default)
1273 * @return 0 in case of success, a negative value corresponding to an
1274 * AVERROR code otherwise
1276 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1277 const char *filename, void *logctx,
1278 unsigned int offset, unsigned int max_probe_size);
1280 #if FF_API_FORMAT_PARAMETERS
1282 * Allocate all the structures needed to read an input stream.
1283 * This does not open the needed codecs for decoding the stream[s].
1284 * @deprecated use avformat_open_input instead.
1286 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1287 AVIOContext *pb, const char *filename,
1288 AVInputFormat *fmt, AVFormatParameters *ap);
1291 * Open a media file as input. The codecs are not opened. Only the file
1292 * header (if present) is read.
1294 * @param ic_ptr The opened media file handle is put here.
1295 * @param filename filename to open
1296 * @param fmt If non-NULL, force the file format to use.
1297 * @param buf_size optional buffer size (zero if default is OK)
1298 * @param ap Additional parameters needed when opening the file
1299 * (NULL if default).
1300 * @return 0 if OK, AVERROR_xxx otherwise
1302 * @deprecated use avformat_open_input instead.
1304 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1307 AVFormatParameters *ap);
1311 * Open an input stream and read the header. The codecs are not opened.
1312 * The stream must be closed with av_close_input_file().
1314 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1315 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1316 * function and written into ps.
1317 * Note that a user-supplied AVFormatContext will be freed on failure.
1318 * @param filename Name of the stream to open.
1319 * @param fmt If non-NULL, this parameter forces a specific input format.
1320 * Otherwise the format is autodetected.
1321 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1322 * On return this parameter will be destroyed and replaced with a dict containing
1323 * options that were not found. May be NULL.
1325 * @return 0 on success, a negative AVERROR on failure.
1327 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1329 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1331 int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);
1334 * Allocate an AVFormatContext.
1335 * avformat_free_context() can be used to free the context and everything
1336 * allocated by the framework within it.
1338 AVFormatContext *avformat_alloc_context(void);
1340 #if FF_API_ALLOC_OUTPUT_CONTEXT
1342 * @deprecated deprecated in favor of avformat_alloc_output_context2()
1344 attribute_deprecated
1345 AVFormatContext *avformat_alloc_output_context(const char *format,
1346 AVOutputFormat *oformat,
1347 const char *filename);
1351 * Allocate an AVFormatContext for an output format.
1352 * avformat_free_context() can be used to free the context and
1353 * everything allocated by the framework within it.
1355 * @param *ctx is set to the created format context, or to NULL in
1357 * @param oformat format to use for allocating the context, if NULL
1358 * format_name and filename are used instead
1359 * @param format_name the name of output format to use for allocating the
1360 * context, if NULL filename is used instead
1361 * @param filename the name of the filename to use for allocating the
1362 * context, may be NULL
1363 * @return >= 0 in case of success, a negative AVERROR code in case of
1366 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1367 const char *format_name, const char *filename);
1369 #if FF_API_FORMAT_PARAMETERS
1371 * Read packets of a media file to get stream information. This
1372 * is useful for file formats with no headers such as MPEG. This
1373 * function also computes the real framerate in case of MPEG-2 repeat
1375 * The logical file position is not changed by this function;
1376 * examined packets may be buffered for later processing.
1378 * @param ic media file handle
1379 * @return >=0 if OK, AVERROR_xxx on error
1380 * @todo Let the user decide somehow what information is needed so that
1381 * we do not waste time getting stuff the user does not need.
1383 * @deprecated use avformat_find_stream_info.
1385 attribute_deprecated
1386 int av_find_stream_info(AVFormatContext *ic);
1390 * Read packets of a media file to get stream information. This
1391 * is useful for file formats with no headers such as MPEG. This
1392 * function also computes the real framerate in case of MPEG-2 repeat
1394 * The logical file position is not changed by this function;
1395 * examined packets may be buffered for later processing.
1397 * @param ic media file handle
1398 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1399 * dictionaries, where i-th member contains options for
1400 * codec corresponding to i-th stream.
1401 * On return each dictionary will be filled with options that were not found.
1402 * @return >=0 if OK, AVERROR_xxx on error
1404 * @note this function isn't guaranteed to open all the codecs, so
1405 * options being non-empty at return is a perfectly normal behavior.
1407 * @todo Let the user decide somehow what information is needed so that
1408 * we do not waste time getting stuff the user does not need.
1410 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1413 * Find the programs which belong to a given stream.
1415 * @param ic media file handle
1416 * @param last the last found program, the search will start after this
1417 * program, or from the beginning if it is NULL
1418 * @param s stream index
1419 * @return the next program which belongs to s, NULL if no program is found or
1420 * the last program is not among the programs of ic.
1422 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s);
1425 * Find the "best" stream in the file.
1426 * The best stream is determined according to various heuristics as the most
1427 * likely to be what the user expects.
1428 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1429 * default decoder for the stream's codec; streams for which no decoder can
1430 * be found are ignored.
1432 * @param ic media file handle
1433 * @param type stream type: video, audio, subtitles, etc.
1434 * @param wanted_stream_nb user-requested stream number,
1435 * or -1 for automatic selection
1436 * @param related_stream try to find a stream related (eg. in the same
1437 * program) to this one, or -1 if none
1438 * @param decoder_ret if non-NULL, returns the decoder for the
1440 * @param flags flags; none are currently defined
1441 * @return the non-negative stream number in case of success,
1442 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1444 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1445 * @note If av_find_best_stream returns successfully and decoder_ret is not
1446 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1448 int av_find_best_stream(AVFormatContext *ic,
1449 enum AVMediaType type,
1450 int wanted_stream_nb,
1452 AVCodec **decoder_ret,
1456 * Read a transport packet from a media file.
1458 * This function is obsolete and should never be used.
1459 * Use av_read_frame() instead.
1461 * @param s media file handle
1462 * @param pkt is filled
1463 * @return 0 if OK, AVERROR_xxx on error
1465 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1468 * Return the next frame of a stream.
1469 * This function returns what is stored in the file, and does not validate
1470 * that what is there are valid frames for the decoder. It will split what is
1471 * stored in the file into frames and return one for each call. It will not
1472 * omit invalid data between valid frames so as to give the decoder the maximum
1473 * information possible for decoding.
1475 * The returned packet is valid
1476 * until the next av_read_frame() or until av_close_input_file() and
1477 * must be freed with av_free_packet. For video, the packet contains
1478 * exactly one frame. For audio, it contains an integer number of
1479 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1480 * data). If the audio frames have a variable size (e.g. MPEG audio),
1481 * then it contains one frame.
1483 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1484 * values in AVStream.time_base units (and guessed if the format cannot
1485 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1486 * has B-frames, so it is better to rely on pkt->dts if you do not
1487 * decompress the payload.
1489 * @return 0 if OK, < 0 on error or end of file
1491 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1494 * Seek to the keyframe at timestamp.
1495 * 'timestamp' in 'stream_index'.
1496 * @param stream_index If stream_index is (-1), a default
1497 * stream is selected, and timestamp is automatically converted
1498 * from AV_TIME_BASE units to the stream specific time_base.
1499 * @param timestamp Timestamp in AVStream.time_base units
1500 * or, if no stream is specified, in AV_TIME_BASE units.
1501 * @param flags flags which select direction and seeking mode
1502 * @return >= 0 on success
1504 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1508 * Seek to timestamp ts.
1509 * Seeking will be done so that the point from which all active streams
1510 * can be presented successfully will be closest to ts and within min/max_ts.
1511 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1513 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1514 * are the file position (this may not be supported by all demuxers).
1515 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1516 * in the stream with stream_index (this may not be supported by all demuxers).
1517 * Otherwise all timestamps are in units of the stream selected by stream_index
1518 * or if stream_index is -1, in AV_TIME_BASE units.
1519 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1520 * keyframes (this may not be supported by all demuxers).
1522 * @param stream_index index of the stream which is used as time base reference
1523 * @param min_ts smallest acceptable timestamp
1524 * @param ts target timestamp
1525 * @param max_ts largest acceptable timestamp
1526 * @param flags flags
1527 * @return >=0 on success, error code otherwise
1529 * @note This is part of the new seek API which is still under construction.
1530 * Thus do not use this yet. It may change at any time, do not expect
1531 * ABI compatibility yet!
1533 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1536 * Start playing a network-based stream (e.g. RTSP stream) at the
1539 int av_read_play(AVFormatContext *s);
1542 * Pause a network-based stream (e.g. RTSP stream).
1544 * Use av_read_play() to resume it.
1546 int av_read_pause(AVFormatContext *s);
1549 * Free a AVFormatContext allocated by av_open_input_stream.
1550 * @param s context to free
1552 void av_close_input_stream(AVFormatContext *s);
1555 * Close a media file (but not its codecs).
1557 * @param s media file handle
1559 void av_close_input_file(AVFormatContext *s);
1562 * Free an AVFormatContext and all its streams.
1563 * @param s context to free
1565 void avformat_free_context(AVFormatContext *s);
1567 #if FF_API_NEW_STREAM
1569 * Add a new stream to a media file.
1571 * Can only be called in the read_header() function. If the flag
1572 * AVFMTCTX_NOHEADER is in the format context, then new streams
1573 * can be added in read_packet too.
1575 * @param s media file handle
1576 * @param id file-format-dependent stream ID
1578 attribute_deprecated
1579 AVStream *av_new_stream(AVFormatContext *s, int id);
1583 * Add a new stream to a media file.
1585 * When demuxing, it is called by the demuxer in read_header(). If the
1586 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1587 * be called in read_packet().
1589 * When muxing, should be called by the user before avformat_write_header().
1591 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1592 * will be initialized to use this codec. This is needed for e.g. codec-specific
1593 * defaults to be set, so codec should be provided if it is known.
1595 * @return newly created stream or NULL on error.
1597 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1599 AVProgram *av_new_program(AVFormatContext *s, int id);
1602 * Set the pts for a given stream. If the new values would be invalid
1603 * (<= 0), it leaves the AVStream unchanged.
1606 * @param pts_wrap_bits number of bits effectively used by the pts
1607 * (used for wrap control, 33 is the value for MPEG)
1608 * @param pts_num numerator to convert to seconds (MPEG: 1)
1609 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1611 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1612 unsigned int pts_num, unsigned int pts_den);
1614 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1615 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1616 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1617 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1619 int av_find_default_stream_index(AVFormatContext *s);
1622 * Get the index for a specific timestamp.
1623 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1624 * to the timestamp which is <= the requested one, if backward
1625 * is 0, then it will be >=
1626 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1627 * @return < 0 if no such timestamp could be found
1629 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1632 * Add an index entry into a sorted list. Update the entry if the list
1633 * already contains it.
1635 * @param timestamp timestamp in the time base of the given stream
1637 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1638 int size, int distance, int flags);
1640 #if FF_API_SEEK_PUBLIC
1641 attribute_deprecated
1642 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1643 int64_t target_ts, int flags);
1644 attribute_deprecated
1645 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1646 attribute_deprecated
1647 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1648 int64_t target_ts, int64_t pos_min,
1649 int64_t pos_max, int64_t pos_limit,
1650 int64_t ts_min, int64_t ts_max,
1651 int flags, int64_t *ts_ret,
1652 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1658 #if FF_API_FORMAT_PARAMETERS
1660 * @deprecated pass the options to avformat_write_header directly.
1662 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1666 * Split a URL string into components.
1668 * The pointers to buffers for storing individual components may be null,
1669 * in order to ignore that component. Buffers for components not found are
1670 * set to empty strings. If the port is not found, it is set to a negative
1673 * @param proto the buffer for the protocol
1674 * @param proto_size the size of the proto buffer
1675 * @param authorization the buffer for the authorization
1676 * @param authorization_size the size of the authorization buffer
1677 * @param hostname the buffer for the host name
1678 * @param hostname_size the size of the hostname buffer
1679 * @param port_ptr a pointer to store the port number in
1680 * @param path the buffer for the path
1681 * @param path_size the size of the path buffer
1682 * @param url the URL to split
1684 void av_url_split(char *proto, int proto_size,
1685 char *authorization, int authorization_size,
1686 char *hostname, int hostname_size,
1688 char *path, int path_size,
1692 * Allocate the stream private data and write the stream header to
1693 * an output media file.
1695 * @param s Media file handle, must be allocated with avformat_alloc_context().
1696 * Its oformat field must be set to the desired output format;
1697 * Its pb field must be set to an already openened AVIOContext.
1698 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1699 * On return this parameter will be destroyed and replaced with a dict containing
1700 * options that were not found. May be NULL.
1702 * @return 0 on success, negative AVERROR on failure.
1704 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1706 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1708 #if FF_API_FORMAT_PARAMETERS
1710 * Allocate the stream private data and write the stream header to an
1711 * output media file.
1712 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1713 * but for some formats it might also be some other time base
1715 * @param s media file handle
1716 * @return 0 if OK, AVERROR_xxx on error
1718 * @deprecated use avformat_write_header.
1720 attribute_deprecated int av_write_header(AVFormatContext *s);
1724 * Write a packet to an output media file.
1726 * The packet shall contain one audio or video frame.
1727 * The packet must be correctly interleaved according to the container
1728 * specification, if not then av_interleaved_write_frame must be used.
1730 * @param s media file handle
1731 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1733 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1735 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1738 * Write a packet to an output media file ensuring correct interleaving.
1740 * The packet must contain one audio or video frame.
1741 * If the packets are already correctly interleaved, the application should
1742 * call av_write_frame() instead as it is slightly faster. It is also important
1743 * to keep in mind that completely non-interleaved input will need huge amounts
1744 * of memory to interleave with this, so it is preferable to interleave at the
1747 * @param s media file handle
1748 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1750 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1752 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1755 * Interleave a packet per dts in an output media file.
1757 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1758 * function, so they cannot be used after it. Note that calling av_free_packet()
1759 * on them is still safe.
1761 * @param s media file handle
1762 * @param out the interleaved packet will be output here
1763 * @param pkt the input packet
1764 * @param flush 1 if no further packets are available as input and all
1765 * remaining packets should be output
1766 * @return 1 if a packet was output, 0 if no packet could be output,
1767 * < 0 if an error occurred
1769 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1770 AVPacket *pkt, int flush);
1773 * Write the stream trailer to an output media file and free the
1774 * file private data.
1776 * May only be called after a successful call to av_write_header.
1778 * @param s media file handle
1779 * @return 0 if OK, AVERROR_xxx on error
1781 int av_write_trailer(AVFormatContext *s);
1784 * Get timing information for the data currently output.
1785 * The exact meaning of "currently output" depends on the format.
1786 * It is mostly relevant for devices that have an internal buffer and/or
1787 * work in real time.
1788 * @param s media file handle
1789 * @param stream stream in the media file
1790 * @param dts[out] DTS of the last packet output for the stream, in stream
1792 * @param wall[out] absolute time when that packet whas output,
1794 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
1795 * Note: some formats or devices may not allow to measure dts and wall
1798 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
1799 int64_t *dts, int64_t *wall);
1801 #if FF_API_DUMP_FORMAT
1803 * @deprecated Deprecated in favor of av_dump_format().
1805 attribute_deprecated void dump_format(AVFormatContext *ic,
1811 void av_dump_format(AVFormatContext *ic,
1816 #if FF_API_PARSE_DATE
1818 * Parse datestr and return a corresponding number of microseconds.
1820 * @param datestr String representing a date or a duration.
1821 * See av_parse_time() for the syntax of the provided string.
1822 * @deprecated in favor of av_parse_time()
1824 attribute_deprecated
1825 int64_t parse_date(const char *datestr, int duration);
1829 * Get the current time in microseconds.
1831 int64_t av_gettime(void);
1833 #if FF_API_FIND_INFO_TAG
1835 * @deprecated use av_find_info_tag in libavutil instead.
1837 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1841 * Return in 'buf' the path with '%d' replaced by a number.
1843 * Also handles the '%0nd' format where 'n' is the total number
1844 * of digits and '%%'.
1846 * @param buf destination buffer
1847 * @param buf_size destination buffer size
1848 * @param path numbered sequence string
1849 * @param number frame number
1850 * @return 0 if OK, -1 on format error
1852 int av_get_frame_filename(char *buf, int buf_size,
1853 const char *path, int number);
1856 * Check whether filename actually is a numbered sequence generator.
1858 * @param filename possible numbered sequence string
1859 * @return 1 if a valid numbered sequence string, 0 otherwise
1861 int av_filename_number_test(const char *filename);
1864 * Generate an SDP for an RTP session.
1866 * @param ac array of AVFormatContexts describing the RTP streams. If the
1867 * array is composed by only one context, such context can contain
1868 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1869 * all the contexts in the array (an AVCodecContext per RTP stream)
1870 * must contain only one AVStream.
1871 * @param n_files number of AVCodecContexts contained in ac
1872 * @param buf buffer where the SDP will be stored (must be allocated by
1874 * @param size the size of the buffer
1875 * @return 0 if OK, AVERROR_xxx on error
1877 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1879 #if FF_API_SDP_CREATE
1880 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1884 * Return a positive value if the given filename has one of the given
1885 * extensions, 0 otherwise.
1887 * @param extensions a comma-separated list of filename extensions
1889 int av_match_ext(const char *filename, const char *extensions);
1892 * Test if the given container can store a codec.
1894 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1896 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1897 * A negative number if this information is not available.
1899 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1902 * Get the AVClass for AVFormatContext. It can be used in combination with
1903 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1905 * @see av_opt_find().
1907 const AVClass *avformat_get_class(void);
1910 * Do global initialization of network components. This is optional,
1911 * but recommended, since it avoids the overhead of implicitly
1912 * doing the setup for each session.
1914 * Calling this function will become mandatory if using network
1915 * protocols at some major version bump.
1917 int avformat_network_init(void);
1920 * Undo the initialization done by avformat_network_init.
1922 int avformat_network_deinit(void);
1924 #endif /* AVFORMAT_AVFORMAT_H */