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;
682 * flag to indicate that probing is requested
683 * NOT PART OF PUBLIC API
686 #if !FF_API_REORDER_PRIVATE
687 const uint8_t *cur_ptr;
691 // Timestamp generation support:
693 * Timestamp corresponding to the last dts sync point.
695 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
696 * a DTS is received from the underlying container. Otherwise set to
697 * AV_NOPTS_VALUE by default.
699 int64_t reference_dts;
702 int last_IP_duration;
706 * Number of packets to buffer for codec probing
708 #define MAX_PROBE_PACKETS 2500
712 * last packet in packet_buffer for this stream when muxing.
714 struct AVPacketList *last_in_packet_buffer;
715 AVProbeData probe_data;
716 #define MAX_REORDER_DELAY 16
717 int64_t pts_buffer[MAX_REORDER_DELAY+1];
718 /* av_read_frame() support */
719 enum AVStreamParseType need_parsing;
720 struct AVCodecParserContext *parser;
722 AVIndexEntry *index_entries; /**< Only used if the format does not
723 support seeking natively. */
724 int nb_index_entries;
725 unsigned int index_entries_allocated_size;
727 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
731 #define AV_PROGRAM_RUNNING 1
734 * New fields can be added to the end with minor version bumps.
735 * Removal, reordering and changes to existing fields require a major
737 * sizeof(AVProgram) must not be used outside libav*.
739 typedef struct AVProgram {
742 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
743 unsigned int *stream_index;
744 unsigned int nb_stream_indexes;
745 AVDictionary *metadata;
752 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
753 (streams are added dynamically) */
755 typedef struct AVChapter {
756 int id; ///< unique ID to identify the chapter
757 AVRational time_base; ///< time base in which the start/end timestamps are specified
758 int64_t start, end; ///< chapter start/end time in time_base units
759 AVDictionary *metadata;
763 * Format I/O context.
764 * New fields can be added to the end with minor version bumps.
765 * Removal, reordering and changes to existing fields require a major
767 * sizeof(AVFormatContext) must not be used outside libav*.
769 typedef struct AVFormatContext {
770 const AVClass *av_class; /**< Set by avformat_alloc_context. */
771 /* Can only be iformat or oformat, not both at the same time. */
772 struct AVInputFormat *iformat;
773 struct AVOutputFormat *oformat;
776 unsigned int nb_streams;
778 char filename[1024]; /**< input or output filename */
782 * @deprecated use 'creation_time' metadata tag instead
784 attribute_deprecated int64_t timestamp;
787 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
788 #if FF_API_REORDER_PRIVATE
789 /* private data for pts handling (do not modify directly). */
791 * This buffer is only needed when packets were already buffered but
792 * not decoded, for example to get the codec parameters in MPEG
795 struct AVPacketList *packet_buffer;
799 * Decoding: position of the first frame of the component, in
800 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
801 * It is deduced from the AVStream values.
806 * Decoding: duration of the stream, in AV_TIME_BASE fractional
807 * seconds. Only set this value if you know none of the individual stream
808 * durations and also dont set any of them. This is deduced from the
809 * AVStream values if not set.
815 * decoding: total file size, 0 if unknown
817 attribute_deprecated int64_t file_size;
821 * Decoding: total stream bitrate in bit/s, 0 if not
822 * available. Never set it directly if the file_size and the
823 * duration are known as FFmpeg can compute it automatically.
827 #if FF_API_REORDER_PRIVATE
828 /* av_read_frame() support */
831 /* av_seek_frame() support */
832 int64_t data_offset; /**< offset of the first packet */
837 * use mpeg muxer private options instead
839 attribute_deprecated int mux_rate;
841 unsigned int packet_size;
843 attribute_deprecated int preload;
847 #if FF_API_LOOP_OUTPUT
848 #define AVFMT_NOOUTPUTLOOP -1
849 #define AVFMT_INFINITEOUTPUTLOOP 0
851 * number of times to loop output in formats that support it
853 * @deprecated use the 'loop' private option in the gif muxer.
855 attribute_deprecated int loop_output;
859 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
860 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
861 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
862 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
863 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
864 #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
865 #if FF_API_FLAG_RTP_HINT
866 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
868 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
869 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
870 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
871 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
872 #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)
873 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
875 #if FF_API_LOOP_INPUT
877 * @deprecated, use the 'loop' img2 demuxer private option.
879 attribute_deprecated int loop_input;
883 * decoding: size of data to probe; encoding: unused.
885 unsigned int probesize;
888 * Maximum time (in AV_TIME_BASE units) during which the input should
889 * be analyzed in av_find_stream_info().
891 int max_analyze_duration;
896 unsigned int nb_programs;
897 AVProgram **programs;
900 * Forced video codec_id.
901 * Demuxing: Set by user.
903 enum CodecID video_codec_id;
906 * Forced audio codec_id.
907 * Demuxing: Set by user.
909 enum CodecID audio_codec_id;
912 * Forced subtitle codec_id.
913 * Demuxing: Set by user.
915 enum CodecID subtitle_codec_id;
918 * Maximum amount of memory in bytes to use for the index of each stream.
919 * If the index exceeds this size, entries will be discarded as
920 * needed to maintain a smaller size. This can lead to slower or less
921 * accurate seeking (depends on demuxer).
922 * Demuxers for which a full in-memory index is mandatory will ignore
925 * demuxing: set by user
927 unsigned int max_index_size;
930 * Maximum amount of memory in bytes to use for buffering frames
931 * obtained from realtime capture devices.
933 unsigned int max_picture_buffer;
935 unsigned int nb_chapters;
936 AVChapter **chapters;
939 * Flags to enable debugging.
942 #define FF_FDEBUG_TS 0x0001
944 #if FF_API_REORDER_PRIVATE
946 * Raw packets from the demuxer, prior to parsing and decoding.
947 * This buffer is used for buffering packets until the codec can
948 * be identified, as parsing cannot be done without knowing the
951 struct AVPacketList *raw_packet_buffer;
952 struct AVPacketList *raw_packet_buffer_end;
954 struct AVPacketList *packet_buffer_end;
957 AVDictionary *metadata;
959 #if FF_API_REORDER_PRIVATE
961 * Remaining size available for raw_packet_buffer, in bytes.
962 * NOT PART OF PUBLIC API
964 #define RAW_PACKET_BUFFER_SIZE 2500000
965 int raw_packet_buffer_remaining_size;
969 * Start time of the stream in real world time, in microseconds
970 * since the unix epoch (00:00 1st January 1970). That is, pts=0
971 * in the stream was captured at this real world time.
972 * - encoding: Set by user.
973 * - decoding: Unused.
975 int64_t start_time_realtime;
978 * decoding: number of frames used to probe fps
983 * Error recognition; higher values will detect more errors but may
984 * misdetect some more or less valid parts as errors.
986 * - decoding: Set by user.
988 int error_recognition;
991 * Transport stream id.
992 * This will be moved into demuxer private options. Thus no API/ABI compatibility
996 /*****************************************************************
997 * All fields below this line are not part of the public API. They
998 * may not be used outside of libavformat and can be changed and
1000 * New public fields should be added right above.
1001 *****************************************************************
1003 #if !FF_API_REORDER_PRIVATE
1005 * Raw packets from the demuxer, prior to parsing and decoding.
1006 * This buffer is used for buffering packets until the codec can
1007 * be identified, as parsing cannot be done without knowing the
1010 struct AVPacketList *raw_packet_buffer;
1011 struct AVPacketList *raw_packet_buffer_end;
1013 * Remaining size available for raw_packet_buffer, in bytes.
1015 #define RAW_PACKET_BUFFER_SIZE 2500000
1016 int raw_packet_buffer_remaining_size;
1019 * This buffer is only needed when packets were already buffered but
1020 * not decoded, for example to get the codec parameters in MPEG
1023 struct AVPacketList *packet_buffer;
1024 struct AVPacketList *packet_buffer_end;
1026 /* av_read_frame() support */
1029 /* av_seek_frame() support */
1030 int64_t data_offset; /**< offset of the first packet */
1034 typedef struct AVPacketList {
1036 struct AVPacketList *next;
1040 * If f is NULL, returns the first registered input format,
1041 * if f is non-NULL, returns the next registered input format after f
1042 * or NULL if f is the last one.
1044 AVInputFormat *av_iformat_next(AVInputFormat *f);
1047 * If f is NULL, returns the first registered output format,
1048 * if f is non-NULL, returns the next registered output format after f
1049 * or NULL if f is the last one.
1051 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
1053 #if FF_API_GUESS_IMG2_CODEC
1054 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
1057 /* XXX: Use automatic init with either ELF sections or C file parser */
1061 void av_register_input_format(AVInputFormat *format);
1062 void av_register_output_format(AVOutputFormat *format);
1065 * Return the output format in the list of registered output formats
1066 * which best matches the provided parameters, or return NULL if
1067 * there is no match.
1069 * @param short_name if non-NULL checks if short_name matches with the
1070 * names of the registered formats
1071 * @param filename if non-NULL checks if filename terminates with the
1072 * extensions of the registered formats
1073 * @param mime_type if non-NULL checks if mime_type matches with the
1074 * MIME type of the registered formats
1076 AVOutputFormat *av_guess_format(const char *short_name,
1077 const char *filename,
1078 const char *mime_type);
1081 * Guess the codec ID based upon muxer and filename.
1083 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
1084 const char *filename, const char *mime_type,
1085 enum AVMediaType type);
1088 * Send a nice hexadecimal dump of a buffer to the specified file stream.
1090 * @param f The file stream pointer where the dump should be sent to.
1092 * @param size buffer size
1094 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
1096 void av_hex_dump(FILE *f, uint8_t *buf, int size);
1099 * Send a nice hexadecimal dump of a buffer to the log.
1101 * @param avcl A pointer to an arbitrary struct of which the first field is a
1102 * pointer to an AVClass struct.
1103 * @param level The importance level of the message, lower values signifying
1104 * higher importance.
1106 * @param size buffer size
1108 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
1110 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1113 * Send a nice dump of a packet to the specified file stream.
1115 * @param f The file stream pointer where the dump should be sent to.
1116 * @param pkt packet to dump
1117 * @param dump_payload True if the payload must be displayed, too.
1118 * @param st AVStream that the packet belongs to
1120 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1124 * Send a nice dump of a packet to the log.
1126 * @param avcl A pointer to an arbitrary struct of which the first field is a
1127 * pointer to an AVClass struct.
1128 * @param level The importance level of the message, lower values signifying
1129 * higher importance.
1130 * @param pkt packet to dump
1131 * @param dump_payload True if the payload must be displayed, too.
1132 * @param st AVStream that the packet belongs to
1134 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1138 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1139 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1144 * Initialize libavformat and register all the muxers, demuxers and
1145 * protocols. If you do not call this function, then you can select
1146 * exactly which formats you want to support.
1148 * @see av_register_input_format()
1149 * @see av_register_output_format()
1150 * @see av_register_protocol()
1152 void av_register_all(void);
1155 * Get the CodecID for the given codec tag tag.
1156 * If no codec id is found returns CODEC_ID_NONE.
1158 * @param tags list of supported codec_id-codec_tag pairs, as stored
1159 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1161 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1164 * Get the codec tag for the given codec id id.
1165 * If no codec tag is found returns 0.
1167 * @param tags list of supported codec_id-codec_tag pairs, as stored
1168 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1170 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1172 /* media file input */
1175 * Find AVInputFormat based on the short name of the input format.
1177 AVInputFormat *av_find_input_format(const char *short_name);
1180 * Guess the file format.
1182 * @param is_opened Whether the file is already opened; determines whether
1183 * demuxers with or without AVFMT_NOFILE are probed.
1185 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1188 * Guess the file format.
1190 * @param is_opened Whether the file is already opened; determines whether
1191 * demuxers with or without AVFMT_NOFILE are probed.
1192 * @param score_max A probe score larger that this is required to accept a
1193 * detection, the variable is set to the actual detection
1195 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1196 * to retry with a larger probe buffer.
1198 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1201 * Guess the file format.
1203 * @param is_opened Whether the file is already opened; determines whether
1204 * demuxers with or without AVFMT_NOFILE are probed.
1205 * @param score_ret The score of the best detection.
1207 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1210 * Probe a bytestream to determine the input format. Each time a probe returns
1211 * with a score that is too low, the probe buffer size is increased and another
1212 * attempt is made. When the maximum probe size is reached, the input format
1213 * with the highest score is returned.
1215 * @param pb the bytestream to probe
1216 * @param fmt the input format is put here
1217 * @param filename the filename of the stream
1218 * @param logctx the log context
1219 * @param offset the offset within the bytestream to probe from
1220 * @param max_probe_size the maximum probe buffer size (zero for default)
1221 * @return 0 in case of success, a negative value corresponding to an
1222 * AVERROR code otherwise
1224 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1225 const char *filename, void *logctx,
1226 unsigned int offset, unsigned int max_probe_size);
1228 #if FF_API_FORMAT_PARAMETERS
1230 * Allocate all the structures needed to read an input stream.
1231 * This does not open the needed codecs for decoding the stream[s].
1232 * @deprecated use avformat_open_input instead.
1234 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1235 AVIOContext *pb, const char *filename,
1236 AVInputFormat *fmt, AVFormatParameters *ap);
1239 * Open a media file as input. The codecs are not opened. Only the file
1240 * header (if present) is read.
1242 * @param ic_ptr The opened media file handle is put here.
1243 * @param filename filename to open
1244 * @param fmt If non-NULL, force the file format to use.
1245 * @param buf_size optional buffer size (zero if default is OK)
1246 * @param ap Additional parameters needed when opening the file
1247 * (NULL if default).
1248 * @return 0 if OK, AVERROR_xxx otherwise
1250 * @deprecated use avformat_open_input instead.
1252 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1255 AVFormatParameters *ap);
1259 * Open an input stream and read the header. The codecs are not opened.
1260 * The stream must be closed with av_close_input_file().
1262 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1263 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1264 * function and written into ps.
1265 * Note that a user-supplied AVFormatContext will be freed on failure.
1266 * @param filename Name of the stream to open.
1267 * @param fmt If non-NULL, this parameter forces a specific input format.
1268 * Otherwise the format is autodetected.
1269 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1270 * On return this parameter will be destroyed and replaced with a dict containing
1271 * options that were not found. May be NULL.
1273 * @return 0 on success, a negative AVERROR on failure.
1275 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1277 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1279 int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);
1282 * Allocate an AVFormatContext.
1283 * avformat_free_context() can be used to free the context and everything
1284 * allocated by the framework within it.
1286 AVFormatContext *avformat_alloc_context(void);
1288 #if FF_API_ALLOC_OUTPUT_CONTEXT
1290 * @deprecated deprecated in favor of avformat_alloc_output_context2()
1292 attribute_deprecated
1293 AVFormatContext *avformat_alloc_output_context(const char *format,
1294 AVOutputFormat *oformat,
1295 const char *filename);
1299 * Allocate an AVFormatContext for an output format.
1300 * avformat_free_context() can be used to free the context and
1301 * everything allocated by the framework within it.
1303 * @param *ctx is set to the created format context, or to NULL in
1305 * @param oformat format to use for allocating the context, if NULL
1306 * format_name and filename are used instead
1307 * @param format_name the name of output format to use for allocating the
1308 * context, if NULL filename is used instead
1309 * @param filename the name of the filename to use for allocating the
1310 * context, may be NULL
1311 * @return >= 0 in case of success, a negative AVERROR code in case of
1314 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1315 const char *format_name, const char *filename);
1317 #if FF_API_FORMAT_PARAMETERS
1319 * Read packets of a media file to get stream information. This
1320 * is useful for file formats with no headers such as MPEG. This
1321 * function also computes the real framerate in case of MPEG-2 repeat
1323 * The logical file position is not changed by this function;
1324 * examined packets may be buffered for later processing.
1326 * @param ic media file handle
1327 * @return >=0 if OK, AVERROR_xxx on error
1328 * @todo Let the user decide somehow what information is needed so that
1329 * we do not waste time getting stuff the user does not need.
1331 * @deprecated use avformat_find_stream_info.
1333 attribute_deprecated
1334 int av_find_stream_info(AVFormatContext *ic);
1338 * Read packets of a media file to get stream information. This
1339 * is useful for file formats with no headers such as MPEG. This
1340 * function also computes the real framerate in case of MPEG-2 repeat
1342 * The logical file position is not changed by this function;
1343 * examined packets may be buffered for later processing.
1345 * @param ic media file handle
1346 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1347 * dictionaries, where i-th member contains options for
1348 * codec corresponding to i-th stream.
1349 * On return each dictionary will be filled with options that were not found.
1350 * @return >=0 if OK, AVERROR_xxx on error
1352 * @note this function isn't guaranteed to open all the codecs, so
1353 * options being non-empty at return is a perfectly normal behavior.
1355 * @todo Let the user decide somehow what information is needed so that
1356 * we do not waste time getting stuff the user does not need.
1358 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1361 * Find the programs which belong to a given stream.
1363 * @param ic media file handle
1364 * @param last the last found program, the search will start after this
1365 * program, or from the beginning if it is NULL
1366 * @param s stream index
1367 * @return the next program which belongs to s, NULL if no program is found or
1368 * the last program is not among the programs of ic.
1370 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s);
1373 * Find the "best" stream in the file.
1374 * The best stream is determined according to various heuristics as the most
1375 * likely to be what the user expects.
1376 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1377 * default decoder for the stream's codec; streams for which no decoder can
1378 * be found are ignored.
1380 * @param ic media file handle
1381 * @param type stream type: video, audio, subtitles, etc.
1382 * @param wanted_stream_nb user-requested stream number,
1383 * or -1 for automatic selection
1384 * @param related_stream try to find a stream related (eg. in the same
1385 * program) to this one, or -1 if none
1386 * @param decoder_ret if non-NULL, returns the decoder for the
1388 * @param flags flags; none are currently defined
1389 * @return the non-negative stream number in case of success,
1390 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1392 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1393 * @note If av_find_best_stream returns successfully and decoder_ret is not
1394 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1396 int av_find_best_stream(AVFormatContext *ic,
1397 enum AVMediaType type,
1398 int wanted_stream_nb,
1400 AVCodec **decoder_ret,
1404 * Read a transport packet from a media file.
1406 * This function is obsolete and should never be used.
1407 * Use av_read_frame() instead.
1409 * @param s media file handle
1410 * @param pkt is filled
1411 * @return 0 if OK, AVERROR_xxx on error
1413 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1416 * Return the next frame of a stream.
1417 * This function returns what is stored in the file, and does not validate
1418 * that what is there are valid frames for the decoder. It will split what is
1419 * stored in the file into frames and return one for each call. It will not
1420 * omit invalid data between valid frames so as to give the decoder the maximum
1421 * information possible for decoding.
1423 * The returned packet is valid
1424 * until the next av_read_frame() or until av_close_input_file() and
1425 * must be freed with av_free_packet. For video, the packet contains
1426 * exactly one frame. For audio, it contains an integer number of
1427 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1428 * data). If the audio frames have a variable size (e.g. MPEG audio),
1429 * then it contains one frame.
1431 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1432 * values in AVStream.time_base units (and guessed if the format cannot
1433 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1434 * has B-frames, so it is better to rely on pkt->dts if you do not
1435 * decompress the payload.
1437 * @return 0 if OK, < 0 on error or end of file
1439 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1442 * Seek to the keyframe at timestamp.
1443 * 'timestamp' in 'stream_index'.
1444 * @param stream_index If stream_index is (-1), a default
1445 * stream is selected, and timestamp is automatically converted
1446 * from AV_TIME_BASE units to the stream specific time_base.
1447 * @param timestamp Timestamp in AVStream.time_base units
1448 * or, if no stream is specified, in AV_TIME_BASE units.
1449 * @param flags flags which select direction and seeking mode
1450 * @return >= 0 on success
1452 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1456 * Seek to timestamp ts.
1457 * Seeking will be done so that the point from which all active streams
1458 * can be presented successfully will be closest to ts and within min/max_ts.
1459 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1461 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1462 * are the file position (this may not be supported by all demuxers).
1463 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1464 * in the stream with stream_index (this may not be supported by all demuxers).
1465 * Otherwise all timestamps are in units of the stream selected by stream_index
1466 * or if stream_index is -1, in AV_TIME_BASE units.
1467 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1468 * keyframes (this may not be supported by all demuxers).
1470 * @param stream_index index of the stream which is used as time base reference
1471 * @param min_ts smallest acceptable timestamp
1472 * @param ts target timestamp
1473 * @param max_ts largest acceptable timestamp
1474 * @param flags flags
1475 * @return >=0 on success, error code otherwise
1477 * @note This is part of the new seek API which is still under construction.
1478 * Thus do not use this yet. It may change at any time, do not expect
1479 * ABI compatibility yet!
1481 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1484 * Start playing a network-based stream (e.g. RTSP stream) at the
1487 int av_read_play(AVFormatContext *s);
1490 * Pause a network-based stream (e.g. RTSP stream).
1492 * Use av_read_play() to resume it.
1494 int av_read_pause(AVFormatContext *s);
1497 * Free a AVFormatContext allocated by av_open_input_stream.
1498 * @param s context to free
1500 void av_close_input_stream(AVFormatContext *s);
1503 * Close a media file (but not its codecs).
1505 * @param s media file handle
1507 void av_close_input_file(AVFormatContext *s);
1510 * Free an AVFormatContext and all its streams.
1511 * @param s context to free
1513 void avformat_free_context(AVFormatContext *s);
1515 #if FF_API_NEW_STREAM
1517 * Add a new stream to a media file.
1519 * Can only be called in the read_header() function. If the flag
1520 * AVFMTCTX_NOHEADER is in the format context, then new streams
1521 * can be added in read_packet too.
1523 * @param s media file handle
1524 * @param id file-format-dependent stream ID
1526 attribute_deprecated
1527 AVStream *av_new_stream(AVFormatContext *s, int id);
1531 * Add a new stream to a media file.
1533 * When demuxing, it is called by the demuxer in read_header(). If the
1534 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also
1535 * be called in read_packet().
1537 * When muxing, should be called by the user before avformat_write_header().
1539 * @param c If non-NULL, the AVCodecContext corresponding to the new stream
1540 * will be initialized to use this codec. This is needed for e.g. codec-specific
1541 * defaults to be set, so codec should be provided if it is known.
1543 * @return newly created stream or NULL on error.
1545 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c);
1547 AVProgram *av_new_program(AVFormatContext *s, int id);
1550 * Set the pts for a given stream. If the new values would be invalid
1551 * (<= 0), it leaves the AVStream unchanged.
1554 * @param pts_wrap_bits number of bits effectively used by the pts
1555 * (used for wrap control, 33 is the value for MPEG)
1556 * @param pts_num numerator to convert to seconds (MPEG: 1)
1557 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1559 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1560 unsigned int pts_num, unsigned int pts_den);
1562 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1563 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1564 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1565 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1567 int av_find_default_stream_index(AVFormatContext *s);
1570 * Get the index for a specific timestamp.
1571 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1572 * to the timestamp which is <= the requested one, if backward
1573 * is 0, then it will be >=
1574 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1575 * @return < 0 if no such timestamp could be found
1577 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1580 * Add an index entry into a sorted list. Update the entry if the list
1581 * already contains it.
1583 * @param timestamp timestamp in the time base of the given stream
1585 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1586 int size, int distance, int flags);
1588 #if FF_API_SEEK_PUBLIC
1589 attribute_deprecated
1590 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1591 int64_t target_ts, int flags);
1592 attribute_deprecated
1593 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1594 attribute_deprecated
1595 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1596 int64_t target_ts, int64_t pos_min,
1597 int64_t pos_max, int64_t pos_limit,
1598 int64_t ts_min, int64_t ts_max,
1599 int flags, int64_t *ts_ret,
1600 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1606 #if FF_API_FORMAT_PARAMETERS
1608 * @deprecated pass the options to avformat_write_header directly.
1610 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1614 * Split a URL string into components.
1616 * The pointers to buffers for storing individual components may be null,
1617 * in order to ignore that component. Buffers for components not found are
1618 * set to empty strings. If the port is not found, it is set to a negative
1621 * @param proto the buffer for the protocol
1622 * @param proto_size the size of the proto buffer
1623 * @param authorization the buffer for the authorization
1624 * @param authorization_size the size of the authorization buffer
1625 * @param hostname the buffer for the host name
1626 * @param hostname_size the size of the hostname buffer
1627 * @param port_ptr a pointer to store the port number in
1628 * @param path the buffer for the path
1629 * @param path_size the size of the path buffer
1630 * @param url the URL to split
1632 void av_url_split(char *proto, int proto_size,
1633 char *authorization, int authorization_size,
1634 char *hostname, int hostname_size,
1636 char *path, int path_size,
1640 * Allocate the stream private data and write the stream header to
1641 * an output media file.
1643 * @param s Media file handle, must be allocated with avformat_alloc_context().
1644 * Its oformat field must be set to the desired output format;
1645 * Its pb field must be set to an already openened AVIOContext.
1646 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1647 * On return this parameter will be destroyed and replaced with a dict containing
1648 * options that were not found. May be NULL.
1650 * @return 0 on success, negative AVERROR on failure.
1652 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1654 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1656 #if FF_API_FORMAT_PARAMETERS
1658 * Allocate the stream private data and write the stream header to an
1659 * output media file.
1660 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1661 * but for some formats it might also be some other time base
1663 * @param s media file handle
1664 * @return 0 if OK, AVERROR_xxx on error
1666 * @deprecated use avformat_write_header.
1668 attribute_deprecated int av_write_header(AVFormatContext *s);
1672 * Write a packet to an output media file.
1674 * The packet shall contain one audio or video frame.
1675 * The packet must be correctly interleaved according to the container
1676 * specification, if not then av_interleaved_write_frame must be used.
1678 * @param s media file handle
1679 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1681 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1683 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1686 * Write a packet to an output media file ensuring correct interleaving.
1688 * The packet must contain one audio or video frame.
1689 * If the packets are already correctly interleaved, the application should
1690 * call av_write_frame() instead as it is slightly faster. It is also important
1691 * to keep in mind that completely non-interleaved input will need huge amounts
1692 * of memory to interleave with this, so it is preferable to interleave at the
1695 * @param s media file handle
1696 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1698 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1700 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1703 * Interleave a packet per dts in an output media file.
1705 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1706 * function, so they cannot be used after it. Note that calling av_free_packet()
1707 * on them is still safe.
1709 * @param s media file handle
1710 * @param out the interleaved packet will be output here
1711 * @param pkt the input packet
1712 * @param flush 1 if no further packets are available as input and all
1713 * remaining packets should be output
1714 * @return 1 if a packet was output, 0 if no packet could be output,
1715 * < 0 if an error occurred
1717 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1718 AVPacket *pkt, int flush);
1721 * Write the stream trailer to an output media file and free the
1722 * file private data.
1724 * May only be called after a successful call to av_write_header.
1726 * @param s media file handle
1727 * @return 0 if OK, AVERROR_xxx on error
1729 int av_write_trailer(AVFormatContext *s);
1732 * Get timing information for the data currently output.
1733 * The exact meaning of "currently output" depends on the format.
1734 * It is mostly relevant for devices that have an internal buffer and/or
1735 * work in real time.
1736 * @param s media file handle
1737 * @param stream stream in the media file
1738 * @param dts[out] DTS of the last packet output for the stream, in stream
1740 * @param wall[out] absolute time when that packet whas output,
1742 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
1743 * Note: some formats or devices may not allow to measure dts and wall
1746 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
1747 int64_t *dts, int64_t *wall);
1749 #if FF_API_DUMP_FORMAT
1751 * @deprecated Deprecated in favor of av_dump_format().
1753 attribute_deprecated void dump_format(AVFormatContext *ic,
1759 void av_dump_format(AVFormatContext *ic,
1764 #if FF_API_PARSE_DATE
1766 * Parse datestr and return a corresponding number of microseconds.
1768 * @param datestr String representing a date or a duration.
1769 * See av_parse_time() for the syntax of the provided string.
1770 * @deprecated in favor of av_parse_time()
1772 attribute_deprecated
1773 int64_t parse_date(const char *datestr, int duration);
1777 * Get the current time in microseconds.
1779 int64_t av_gettime(void);
1781 #if FF_API_FIND_INFO_TAG
1783 * @deprecated use av_find_info_tag in libavutil instead.
1785 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1789 * Return in 'buf' the path with '%d' replaced by a number.
1791 * Also handles the '%0nd' format where 'n' is the total number
1792 * of digits and '%%'.
1794 * @param buf destination buffer
1795 * @param buf_size destination buffer size
1796 * @param path numbered sequence string
1797 * @param number frame number
1798 * @return 0 if OK, -1 on format error
1800 int av_get_frame_filename(char *buf, int buf_size,
1801 const char *path, int number);
1804 * Check whether filename actually is a numbered sequence generator.
1806 * @param filename possible numbered sequence string
1807 * @return 1 if a valid numbered sequence string, 0 otherwise
1809 int av_filename_number_test(const char *filename);
1812 * Generate an SDP for an RTP session.
1814 * @param ac array of AVFormatContexts describing the RTP streams. If the
1815 * array is composed by only one context, such context can contain
1816 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1817 * all the contexts in the array (an AVCodecContext per RTP stream)
1818 * must contain only one AVStream.
1819 * @param n_files number of AVCodecContexts contained in ac
1820 * @param buf buffer where the SDP will be stored (must be allocated by
1822 * @param size the size of the buffer
1823 * @return 0 if OK, AVERROR_xxx on error
1825 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1827 #if FF_API_SDP_CREATE
1828 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1832 * Return a positive value if the given filename has one of the given
1833 * extensions, 0 otherwise.
1835 * @param extensions a comma-separated list of filename extensions
1837 int av_match_ext(const char *filename, const char *extensions);
1840 * Test if the given container can store a codec.
1842 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1844 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1845 * A negative number if this information is not available.
1847 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1850 * Get the AVClass for AVFormatContext. It can be used in combination with
1851 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1853 * @see av_opt_find().
1855 const AVClass *avformat_get_class(void);
1857 #endif /* AVFORMAT_AVFORMAT_H */