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_TS_NONSTRICT 0x8000 /**< Format does not require strictly
278 increasing timestamps, but they must
279 still be monotonic */
281 typedef struct AVOutputFormat {
284 * Descriptive name for the format, meant to be more human-readable
285 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
288 const char *long_name;
289 const char *mime_type;
290 const char *extensions; /**< comma-separated filename extensions */
292 * size of private data so that it can be allocated in the wrapper
296 enum CodecID audio_codec; /**< default audio codec */
297 enum CodecID video_codec; /**< default video codec */
298 int (*write_header)(struct AVFormatContext *);
299 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
300 int (*write_trailer)(struct AVFormatContext *);
302 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
303 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
304 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
310 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
311 AVPacket *in, int flush);
314 * List of supported codec_id-codec_tag pairs, ordered by "better
315 * choice first". The arrays are all terminated by CODEC_ID_NONE.
317 const struct AVCodecTag * const *codec_tag;
319 enum CodecID subtitle_codec; /**< default subtitle codec */
321 #if FF_API_OLD_METADATA2
322 const AVMetadataConv *metadata_conv;
325 const AVClass *priv_class; ///< AVClass for the private context
328 * Test if the given codec can be stored in this container.
330 * @return 1 if the codec is supported, 0 if it is not.
331 * A negative number if unknown.
333 int (*query_codec)(enum CodecID id, int std_compliance);
335 void (*get_output_timestamp)(struct AVFormatContext *s, int stream,
336 int64_t *dts, int64_t *wall);
339 struct AVOutputFormat *next;
342 typedef struct AVInputFormat {
344 * A comma separated list of short names for the format. New names
345 * may be appended with a minor bump.
350 * Descriptive name for the format, meant to be more human-readable
351 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
354 const char *long_name;
357 * Size of private data so that it can be allocated in the wrapper.
362 * Tell if a given file has a chance of being parsed as this format.
363 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
364 * big so you do not have to check for that unless you need more.
366 int (*read_probe)(AVProbeData *);
369 * Read the format header and initialize the AVFormatContext
370 * structure. Return 0 if OK. 'ap' if non-NULL contains
371 * additional parameters. Only used in raw format right
372 * now. 'av_new_stream' should be called to create new streams.
374 int (*read_header)(struct AVFormatContext *,
375 AVFormatParameters *ap);
378 * Read one packet and put it in 'pkt'. pts and flags are also
379 * set. 'av_new_stream' can be called only if the flag
380 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
381 * background thread).
382 * @return 0 on success, < 0 on error.
383 * When returning an error, pkt must not have been allocated
384 * or must be freed before returning
386 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
389 * Close the stream. The AVFormatContext and AVStreams are not
390 * freed by this function
392 int (*read_close)(struct AVFormatContext *);
396 * Seek to a given timestamp relative to the frames in
397 * stream component stream_index.
398 * @param stream_index Must not be -1.
399 * @param flags Selects which direction should be preferred if no exact
400 * match is available.
401 * @return >= 0 on success (but not necessarily the new offset)
403 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
404 int stream_index, int64_t timestamp, int flags);
407 * Gets the next timestamp in stream[stream_index].time_base units.
408 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
410 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
411 int64_t *pos, int64_t pos_limit);
414 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
419 * If extensions are defined, then no probe is done. You should
420 * usually not use extension format guessing because it is not
423 const char *extensions;
426 * General purpose read-only value that the format can use.
431 * Start/resume playing - only meaningful if using a network-based format
434 int (*read_play)(struct AVFormatContext *);
437 * Pause playing - only meaningful if using a network-based format
440 int (*read_pause)(struct AVFormatContext *);
442 const struct AVCodecTag * const *codec_tag;
445 * Seek to timestamp ts.
446 * Seeking will be done so that the point from which all active streams
447 * can be presented successfully will be closest to ts and within min/max_ts.
448 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
450 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
452 #if FF_API_OLD_METADATA2
453 const AVMetadataConv *metadata_conv;
456 const AVClass *priv_class; ///< AVClass for the private context
459 struct AVInputFormat *next;
462 enum AVStreamParseType {
464 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
465 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
466 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
467 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
470 typedef struct AVIndexEntry {
472 int64_t timestamp; /**<
473 * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available
474 * when seeking to this entry. That means preferable PTS on keyframe based formats.
475 * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better
478 #define AVINDEX_KEYFRAME 0x0001
480 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).
481 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
484 #define AV_DISPOSITION_DEFAULT 0x0001
485 #define AV_DISPOSITION_DUB 0x0002
486 #define AV_DISPOSITION_ORIGINAL 0x0004
487 #define AV_DISPOSITION_COMMENT 0x0008
488 #define AV_DISPOSITION_LYRICS 0x0010
489 #define AV_DISPOSITION_KARAOKE 0x0020
492 * Track should be used during playback by default.
493 * Useful for subtitle track that should be displayed
494 * even when user did not explicitly ask for subtitles.
496 #define AV_DISPOSITION_FORCED 0x0040
497 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
498 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
499 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
503 * New fields can be added to the end with minor version bumps.
504 * Removal, reordering and changes to existing fields require a major
506 * sizeof(AVStream) must not be used outside libav*.
508 typedef struct AVStream {
509 int index; /**< stream index in AVFormatContext */
510 int id; /**< format-specific stream ID */
511 AVCodecContext *codec; /**< codec context */
513 * Real base framerate of the stream.
514 * This is the lowest framerate with which all timestamps can be
515 * represented accurately (it is the least common multiple of all
516 * framerates in the stream). Note, this value is just a guess!
517 * For example, if the time base is 1/90000 and all frames have either
518 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
520 AVRational r_frame_rate;
523 /* internal data used in av_find_stream_info() */
527 * encoding: pts generation when outputting stream
532 * This is the fundamental unit of time (in seconds) in terms
533 * of which frame timestamps are represented. For fixed-fps content,
534 * time base should be 1/framerate and timestamp increments should be 1.
535 * decoding: set by libavformat
536 * encoding: set by libavformat in av_write_header
538 AVRational time_base;
539 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
540 /* ffmpeg.c private use */
541 int stream_copy; /**< If set, just copy stream. */
542 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
544 #if FF_API_AVSTREAM_QUALITY
545 //FIXME move stuff to a flags field?
547 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
548 * MN: dunno if that is the right place for it
550 attribute_deprecated float quality;
554 * Decoding: pts of the first frame of the stream in presentation order, in stream time base.
555 * Only set this if you are absolutely 100% sure that the value you set
556 * it to really is the pts of the first frame.
557 * This may be undefined (AV_NOPTS_VALUE).
558 * @note The ASF header does NOT contain a correct start_time the ASF
559 * demuxer must NOT set this.
564 * Decoding: duration of the stream, in stream time base.
565 * If a source file does not specify a duration, but does specify
566 * a bitrate, this value will be estimated from bitrate and file size.
570 /* av_read_frame() support */
571 enum AVStreamParseType need_parsing;
572 struct AVCodecParserContext *parser;
575 int last_IP_duration;
577 /* av_seek_frame() support */
578 AVIndexEntry *index_entries; /**< Only used if the format does not
579 support seeking natively. */
580 int nb_index_entries;
581 unsigned int index_entries_allocated_size;
583 int64_t nb_frames; ///< number of frames in this stream if known or 0
585 int disposition; /**< AV_DISPOSITION_* bit field */
587 AVProbeData probe_data;
588 #define MAX_REORDER_DELAY 16
589 int64_t pts_buffer[MAX_REORDER_DELAY+1];
592 * sample aspect ratio (0 if unknown)
593 * - encoding: Set by user.
594 * - decoding: Set by libavformat.
596 AVRational sample_aspect_ratio;
598 AVDictionary *metadata;
600 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
601 /* external applications; try to use something else if at all possible. */
602 const uint8_t *cur_ptr;
606 // Timestamp generation support:
608 * Timestamp corresponding to the last dts sync point.
610 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
611 * a DTS is received from the underlying container. Otherwise set to
612 * AV_NOPTS_VALUE by default.
614 int64_t reference_dts;
617 * Number of packets to buffer for codec probing
618 * NOT PART OF PUBLIC API
620 #define MAX_PROBE_PACKETS 2500
624 * last packet in packet_buffer for this stream when muxing.
625 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
627 struct AVPacketList *last_in_packet_buffer;
632 AVRational avg_frame_rate;
635 * Number of frames that have been demuxed during av_find_stream_info()
637 int codec_info_nb_frames;
641 * This is the MPEG-TS stream identifier +1
644 int stream_identifier;
647 * Stream informations used internally by av_find_stream_info()
649 #define MAX_STD_TIMEBASES (60*12+5)
652 int64_t duration_gcd;
654 double duration_error[2][2][MAX_STD_TIMEBASES];
655 int64_t codec_info_duration;
659 * flag to indicate that probing is requested
660 * NOT PART OF PUBLIC API
665 #define AV_PROGRAM_RUNNING 1
668 * New fields can be added to the end with minor version bumps.
669 * Removal, reordering and changes to existing fields require a major
671 * sizeof(AVProgram) must not be used outside libav*.
673 typedef struct AVProgram {
676 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
677 unsigned int *stream_index;
678 unsigned int nb_stream_indexes;
679 AVDictionary *metadata;
686 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
687 (streams are added dynamically) */
689 typedef struct AVChapter {
690 int id; ///< unique ID to identify the chapter
691 AVRational time_base; ///< time base in which the start/end timestamps are specified
692 int64_t start, end; ///< chapter start/end time in time_base units
693 AVDictionary *metadata;
697 * Format I/O context.
698 * New fields can be added to the end with minor version bumps.
699 * Removal, reordering and changes to existing fields require a major
701 * sizeof(AVFormatContext) must not be used outside libav*.
703 typedef struct AVFormatContext {
704 const AVClass *av_class; /**< Set by avformat_alloc_context. */
705 /* Can only be iformat or oformat, not both at the same time. */
706 struct AVInputFormat *iformat;
707 struct AVOutputFormat *oformat;
710 unsigned int nb_streams;
712 char filename[1024]; /**< input or output filename */
716 * @deprecated use 'creation_time' metadata tag instead
718 attribute_deprecated int64_t timestamp;
721 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
722 /* private data for pts handling (do not modify directly). */
724 * This buffer is only needed when packets were already buffered but
725 * not decoded, for example to get the codec parameters in MPEG
728 struct AVPacketList *packet_buffer;
731 * Decoding: position of the first frame of the component, in
732 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
733 * It is deduced from the AVStream values.
738 * Decoding: duration of the stream, in AV_TIME_BASE fractional
739 * seconds. Only set this value if you know none of the individual stream
740 * durations and also dont set any of them. This is deduced from the
741 * AVStream values if not set.
746 * decoding: total file size, 0 if unknown
751 * Decoding: total stream bitrate in bit/s, 0 if not
752 * available. Never set it directly if the file_size and the
753 * duration are known as FFmpeg can compute it automatically.
757 /* av_read_frame() support */
760 /* av_seek_frame() support */
761 int64_t data_offset; /**< offset of the first packet */
764 unsigned int packet_size;
768 #if FF_API_LOOP_OUTPUT
769 #define AVFMT_NOOUTPUTLOOP -1
770 #define AVFMT_INFINITEOUTPUTLOOP 0
772 * number of times to loop output in formats that support it
774 * @deprecated use the 'loop' private option in the gif muxer.
776 attribute_deprecated int loop_output;
780 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
781 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
782 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
783 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
784 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
785 #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
786 #if FF_API_FLAG_RTP_HINT
787 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
789 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
790 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted
791 #define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload
792 #define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
793 #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)
794 #define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Dont merge side data but keep it seperate.
796 #if FF_API_LOOP_INPUT
798 * @deprecated, use the 'loop' img2 demuxer private option.
800 attribute_deprecated int loop_input;
804 * decoding: size of data to probe; encoding: unused.
806 unsigned int probesize;
809 * Maximum time (in AV_TIME_BASE units) during which the input should
810 * be analyzed in av_find_stream_info().
812 int max_analyze_duration;
817 unsigned int nb_programs;
818 AVProgram **programs;
821 * Forced video codec_id.
822 * Demuxing: Set by user.
824 enum CodecID video_codec_id;
827 * Forced audio codec_id.
828 * Demuxing: Set by user.
830 enum CodecID audio_codec_id;
833 * Forced subtitle codec_id.
834 * Demuxing: Set by user.
836 enum CodecID subtitle_codec_id;
839 * Maximum amount of memory in bytes to use for the index of each stream.
840 * If the index exceeds this size, entries will be discarded as
841 * needed to maintain a smaller size. This can lead to slower or less
842 * accurate seeking (depends on demuxer).
843 * Demuxers for which a full in-memory index is mandatory will ignore
846 * demuxing: set by user
848 unsigned int max_index_size;
851 * Maximum amount of memory in bytes to use for buffering frames
852 * obtained from realtime capture devices.
854 unsigned int max_picture_buffer;
856 unsigned int nb_chapters;
857 AVChapter **chapters;
860 * Flags to enable debugging.
863 #define FF_FDEBUG_TS 0x0001
866 * Raw packets from the demuxer, prior to parsing and decoding.
867 * This buffer is used for buffering packets until the codec can
868 * be identified, as parsing cannot be done without knowing the
871 struct AVPacketList *raw_packet_buffer;
872 struct AVPacketList *raw_packet_buffer_end;
874 struct AVPacketList *packet_buffer_end;
876 AVDictionary *metadata;
879 * Remaining size available for raw_packet_buffer, in bytes.
880 * NOT PART OF PUBLIC API
882 #define RAW_PACKET_BUFFER_SIZE 2500000
883 int raw_packet_buffer_remaining_size;
886 * Start time of the stream in real world time, in microseconds
887 * since the unix epoch (00:00 1st January 1970). That is, pts=0
888 * in the stream was captured at this real world time.
889 * - encoding: Set by user.
890 * - decoding: Unused.
892 int64_t start_time_realtime;
895 * decoding: number of frames used to probe fps
900 * Error recognition; higher values will detect more errors but may
901 * misdetect some more or less valid parts as errors.
903 * - decoding: Set by user.
905 int error_recognition;
908 * Transport stream id.
909 * This will be moved into demuxer private options. Thus no API/ABI compatibility
914 typedef struct AVPacketList {
916 struct AVPacketList *next;
920 * If f is NULL, returns the first registered input format,
921 * if f is non-NULL, returns the next registered input format after f
922 * or NULL if f is the last one.
924 AVInputFormat *av_iformat_next(AVInputFormat *f);
927 * If f is NULL, returns the first registered output format,
928 * if f is non-NULL, returns the next registered output format after f
929 * or NULL if f is the last one.
931 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
933 #if FF_API_GUESS_IMG2_CODEC
934 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
937 /* XXX: Use automatic init with either ELF sections or C file parser */
941 void av_register_input_format(AVInputFormat *format);
942 void av_register_output_format(AVOutputFormat *format);
945 * Return the output format in the list of registered output formats
946 * which best matches the provided parameters, or return NULL if
949 * @param short_name if non-NULL checks if short_name matches with the
950 * names of the registered formats
951 * @param filename if non-NULL checks if filename terminates with the
952 * extensions of the registered formats
953 * @param mime_type if non-NULL checks if mime_type matches with the
954 * MIME type of the registered formats
956 AVOutputFormat *av_guess_format(const char *short_name,
957 const char *filename,
958 const char *mime_type);
961 * Guess the codec ID based upon muxer and filename.
963 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
964 const char *filename, const char *mime_type,
965 enum AVMediaType type);
968 * Send a nice hexadecimal dump of a buffer to the specified file stream.
970 * @param f The file stream pointer where the dump should be sent to.
972 * @param size buffer size
974 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
976 void av_hex_dump(FILE *f, uint8_t *buf, int size);
979 * Send a nice hexadecimal dump of a buffer to the log.
981 * @param avcl A pointer to an arbitrary struct of which the first field is a
982 * pointer to an AVClass struct.
983 * @param level The importance level of the message, lower values signifying
986 * @param size buffer size
988 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
990 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
993 * Send a nice dump of a packet to the specified file stream.
995 * @param f The file stream pointer where the dump should be sent to.
996 * @param pkt packet to dump
997 * @param dump_payload True if the payload must be displayed, too.
998 * @param st AVStream that the packet belongs to
1000 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
1004 * Send a nice dump of a packet to the log.
1006 * @param avcl A pointer to an arbitrary struct of which the first field is a
1007 * pointer to an AVClass struct.
1008 * @param level The importance level of the message, lower values signifying
1009 * higher importance.
1010 * @param pkt packet to dump
1011 * @param dump_payload True if the payload must be displayed, too.
1012 * @param st AVStream that the packet belongs to
1014 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
1018 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1019 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1024 * Initialize libavformat and register all the muxers, demuxers and
1025 * protocols. If you do not call this function, then you can select
1026 * exactly which formats you want to support.
1028 * @see av_register_input_format()
1029 * @see av_register_output_format()
1030 * @see av_register_protocol()
1032 void av_register_all(void);
1035 * Get the CodecID for the given codec tag tag.
1036 * If no codec id is found returns CODEC_ID_NONE.
1038 * @param tags list of supported codec_id-codec_tag pairs, as stored
1039 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1041 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1044 * Get the codec tag for the given codec id id.
1045 * If no codec tag is found returns 0.
1047 * @param tags list of supported codec_id-codec_tag pairs, as stored
1048 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1050 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1052 /* media file input */
1055 * Find AVInputFormat based on the short name of the input format.
1057 AVInputFormat *av_find_input_format(const char *short_name);
1060 * Guess the file format.
1062 * @param is_opened Whether the file is already opened; determines whether
1063 * demuxers with or without AVFMT_NOFILE are probed.
1065 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1068 * Guess the file format.
1070 * @param is_opened Whether the file is already opened; determines whether
1071 * demuxers with or without AVFMT_NOFILE are probed.
1072 * @param score_max A probe score larger that this is required to accept a
1073 * detection, the variable is set to the actual detection
1075 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1076 * to retry with a larger probe buffer.
1078 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1081 * Guess the file format.
1083 * @param is_opened Whether the file is already opened; determines whether
1084 * demuxers with or without AVFMT_NOFILE are probed.
1085 * @param score_ret The score of the best detection.
1087 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
1090 * Probe a bytestream to determine the input format. Each time a probe returns
1091 * with a score that is too low, the probe buffer size is increased and another
1092 * attempt is made. When the maximum probe size is reached, the input format
1093 * with the highest score is returned.
1095 * @param pb the bytestream to probe
1096 * @param fmt the input format is put here
1097 * @param filename the filename of the stream
1098 * @param logctx the log context
1099 * @param offset the offset within the bytestream to probe from
1100 * @param max_probe_size the maximum probe buffer size (zero for default)
1101 * @return 0 in case of success, a negative value corresponding to an
1102 * AVERROR code otherwise
1104 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1105 const char *filename, void *logctx,
1106 unsigned int offset, unsigned int max_probe_size);
1108 #if FF_API_FORMAT_PARAMETERS
1110 * Allocate all the structures needed to read an input stream.
1111 * This does not open the needed codecs for decoding the stream[s].
1112 * @deprecated use avformat_open_input instead.
1114 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1115 AVIOContext *pb, const char *filename,
1116 AVInputFormat *fmt, AVFormatParameters *ap);
1119 * Open a media file as input. The codecs are not opened. Only the file
1120 * header (if present) is read.
1122 * @param ic_ptr The opened media file handle is put here.
1123 * @param filename filename to open
1124 * @param fmt If non-NULL, force the file format to use.
1125 * @param buf_size optional buffer size (zero if default is OK)
1126 * @param ap Additional parameters needed when opening the file
1127 * (NULL if default).
1128 * @return 0 if OK, AVERROR_xxx otherwise
1130 * @deprecated use avformat_open_input instead.
1132 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1135 AVFormatParameters *ap);
1139 * Open an input stream and read the header. The codecs are not opened.
1140 * The stream must be closed with av_close_input_file().
1142 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1143 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1144 * function and written into ps.
1145 * Note that a user-supplied AVFormatContext will be freed on failure.
1146 * @param filename Name of the stream to open.
1147 * @param fmt If non-NULL, this parameter forces a specific input format.
1148 * Otherwise the format is autodetected.
1149 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1150 * On return this parameter will be destroyed and replaced with a dict containing
1151 * options that were not found. May be NULL.
1153 * @return 0 on success, a negative AVERROR on failure.
1155 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1157 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1159 int av_demuxer_open(AVFormatContext *ic, AVFormatParameters *ap);
1162 * Allocate an AVFormatContext.
1163 * avformat_free_context() can be used to free the context and everything
1164 * allocated by the framework within it.
1166 AVFormatContext *avformat_alloc_context(void);
1168 #if FF_API_ALLOC_OUTPUT_CONTEXT
1170 * @deprecated deprecated in favor of avformat_alloc_output_context2()
1172 attribute_deprecated
1173 AVFormatContext *avformat_alloc_output_context(const char *format,
1174 AVOutputFormat *oformat,
1175 const char *filename);
1179 * Allocate an AVFormatContext for an output format.
1180 * avformat_free_context() can be used to free the context and
1181 * everything allocated by the framework within it.
1183 * @param *ctx is set to the created format context, or to NULL in
1185 * @param oformat format to use for allocating the context, if NULL
1186 * format_name and filename are used instead
1187 * @param format_name the name of output format to use for allocating the
1188 * context, if NULL filename is used instead
1189 * @param filename the name of the filename to use for allocating the
1190 * context, may be NULL
1191 * @return >= 0 in case of success, a negative AVERROR code in case of
1194 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat,
1195 const char *format_name, const char *filename);
1197 #if FF_API_FORMAT_PARAMETERS
1199 * Read packets of a media file to get stream information. This
1200 * is useful for file formats with no headers such as MPEG. This
1201 * function also computes the real framerate in case of MPEG-2 repeat
1203 * The logical file position is not changed by this function;
1204 * examined packets may be buffered for later processing.
1206 * @param ic media file handle
1207 * @return >=0 if OK, AVERROR_xxx on error
1208 * @todo Let the user decide somehow what information is needed so that
1209 * we do not waste time getting stuff the user does not need.
1211 * @deprecated use avformat_find_stream_info.
1213 attribute_deprecated
1214 int av_find_stream_info(AVFormatContext *ic);
1218 * Read packets of a media file to get stream information. This
1219 * is useful for file formats with no headers such as MPEG. This
1220 * function also computes the real framerate in case of MPEG-2 repeat
1222 * The logical file position is not changed by this function;
1223 * examined packets may be buffered for later processing.
1225 * @param ic media file handle
1226 * @param options If non-NULL, an ic.nb_streams long array of pointers to
1227 * dictionaries, where i-th member contains options for
1228 * codec corresponding to i-th stream.
1229 * On return each dictionary will be filled with options that were not found.
1230 * @return >=0 if OK, AVERROR_xxx on error
1232 * @note this function isn't guaranteed to open all the codecs, so
1233 * options being non-empty at return is a perfectly normal behavior.
1235 * @todo Let the user decide somehow what information is needed so that
1236 * we do not waste time getting stuff the user does not need.
1238 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options);
1241 * Find the programs which belong to a given stream.
1243 * @param ic media file handle
1244 * @param last the last found program, the search will start after this
1245 * program, or from the beginning if it is NULL
1246 * @param s stream index
1247 * @return the next program which belongs to s, NULL if no program is found or
1248 * the last program is not among the programs of ic.
1250 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s);
1253 * Find the "best" stream in the file.
1254 * The best stream is determined according to various heuristics as the most
1255 * likely to be what the user expects.
1256 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1257 * default decoder for the stream's codec; streams for which no decoder can
1258 * be found are ignored.
1260 * @param ic media file handle
1261 * @param type stream type: video, audio, subtitles, etc.
1262 * @param wanted_stream_nb user-requested stream number,
1263 * or -1 for automatic selection
1264 * @param related_stream try to find a stream related (eg. in the same
1265 * program) to this one, or -1 if none
1266 * @param decoder_ret if non-NULL, returns the decoder for the
1268 * @param flags flags; none are currently defined
1269 * @return the non-negative stream number in case of success,
1270 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1272 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1273 * @note If av_find_best_stream returns successfully and decoder_ret is not
1274 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1276 int av_find_best_stream(AVFormatContext *ic,
1277 enum AVMediaType type,
1278 int wanted_stream_nb,
1280 AVCodec **decoder_ret,
1284 * Read a transport packet from a media file.
1286 * This function is obsolete and should never be used.
1287 * Use av_read_frame() instead.
1289 * @param s media file handle
1290 * @param pkt is filled
1291 * @return 0 if OK, AVERROR_xxx on error
1293 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1296 * Return the next frame of a stream.
1297 * This function returns what is stored in the file, and does not validate
1298 * that what is there are valid frames for the decoder. It will split what is
1299 * stored in the file into frames and return one for each call. It will not
1300 * omit invalid data between valid frames so as to give the decoder the maximum
1301 * information possible for decoding.
1303 * The returned packet is valid
1304 * until the next av_read_frame() or until av_close_input_file() and
1305 * must be freed with av_free_packet. For video, the packet contains
1306 * exactly one frame. For audio, it contains an integer number of
1307 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1308 * data). If the audio frames have a variable size (e.g. MPEG audio),
1309 * then it contains one frame.
1311 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1312 * values in AVStream.time_base units (and guessed if the format cannot
1313 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1314 * has B-frames, so it is better to rely on pkt->dts if you do not
1315 * decompress the payload.
1317 * @return 0 if OK, < 0 on error or end of file
1319 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1322 * Seek to the keyframe at timestamp.
1323 * 'timestamp' in 'stream_index'.
1324 * @param stream_index If stream_index is (-1), a default
1325 * stream is selected, and timestamp is automatically converted
1326 * from AV_TIME_BASE units to the stream specific time_base.
1327 * @param timestamp Timestamp in AVStream.time_base units
1328 * or, if no stream is specified, in AV_TIME_BASE units.
1329 * @param flags flags which select direction and seeking mode
1330 * @return >= 0 on success
1332 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1336 * Seek to timestamp ts.
1337 * Seeking will be done so that the point from which all active streams
1338 * can be presented successfully will be closest to ts and within min/max_ts.
1339 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1341 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1342 * are the file position (this may not be supported by all demuxers).
1343 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1344 * in the stream with stream_index (this may not be supported by all demuxers).
1345 * Otherwise all timestamps are in units of the stream selected by stream_index
1346 * or if stream_index is -1, in AV_TIME_BASE units.
1347 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1348 * keyframes (this may not be supported by all demuxers).
1350 * @param stream_index index of the stream which is used as time base reference
1351 * @param min_ts smallest acceptable timestamp
1352 * @param ts target timestamp
1353 * @param max_ts largest acceptable timestamp
1354 * @param flags flags
1355 * @return >=0 on success, error code otherwise
1357 * @note This is part of the new seek API which is still under construction.
1358 * Thus do not use this yet. It may change at any time, do not expect
1359 * ABI compatibility yet!
1361 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1364 * Start playing a network-based stream (e.g. RTSP stream) at the
1367 int av_read_play(AVFormatContext *s);
1370 * Pause a network-based stream (e.g. RTSP stream).
1372 * Use av_read_play() to resume it.
1374 int av_read_pause(AVFormatContext *s);
1377 * Free a AVFormatContext allocated by av_open_input_stream.
1378 * @param s context to free
1380 void av_close_input_stream(AVFormatContext *s);
1383 * Close a media file (but not its codecs).
1385 * @param s media file handle
1387 void av_close_input_file(AVFormatContext *s);
1390 * Free an AVFormatContext and all its streams.
1391 * @param s context to free
1393 void avformat_free_context(AVFormatContext *s);
1396 * Add a new stream to a media file.
1398 * Can only be called in the read_header() function. If the flag
1399 * AVFMTCTX_NOHEADER is in the format context, then new streams
1400 * can be added in read_packet too.
1402 * @param s media file handle
1403 * @param id file-format-dependent stream ID
1405 AVStream *av_new_stream(AVFormatContext *s, int id);
1406 AVProgram *av_new_program(AVFormatContext *s, int id);
1409 * Set the pts for a given stream. If the new values would be invalid
1410 * (<= 0), it leaves the AVStream unchanged.
1413 * @param pts_wrap_bits number of bits effectively used by the pts
1414 * (used for wrap control, 33 is the value for MPEG)
1415 * @param pts_num numerator to convert to seconds (MPEG: 1)
1416 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1418 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1419 unsigned int pts_num, unsigned int pts_den);
1421 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1422 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1423 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1424 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1426 int av_find_default_stream_index(AVFormatContext *s);
1429 * Get the index for a specific timestamp.
1430 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1431 * to the timestamp which is <= the requested one, if backward
1432 * is 0, then it will be >=
1433 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1434 * @return < 0 if no such timestamp could be found
1436 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1439 * Add an index entry into a sorted list. Update the entry if the list
1440 * already contains it.
1442 * @param timestamp timestamp in the time base of the given stream
1444 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1445 int size, int distance, int flags);
1448 * Perform a binary search using av_index_search_timestamp() and
1449 * AVInputFormat.read_timestamp().
1450 * This is not supposed to be called directly by a user application,
1452 * @param target_ts target timestamp in the time base of the given stream
1453 * @param stream_index stream number
1455 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1456 int64_t target_ts, int flags);
1459 * Update cur_dts of all streams based on the given timestamp and AVStream.
1461 * Stream ref_st unchanged, others set cur_dts in their native time base.
1462 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1463 * @param timestamp new dts expressed in time_base of param ref_st
1464 * @param ref_st reference stream giving time_base of param timestamp
1466 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1469 * Perform a binary search using read_timestamp().
1470 * This is not supposed to be called directly by a user application,
1472 * @param target_ts target timestamp in the time base of the given stream
1473 * @param stream_index stream number
1475 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1476 int64_t target_ts, int64_t pos_min,
1477 int64_t pos_max, int64_t pos_limit,
1478 int64_t ts_min, int64_t ts_max,
1479 int flags, int64_t *ts_ret,
1480 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1485 #if FF_API_FORMAT_PARAMETERS
1487 * @deprecated pass the options to avformat_write_header directly.
1489 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1493 * Split a URL string into components.
1495 * The pointers to buffers for storing individual components may be null,
1496 * in order to ignore that component. Buffers for components not found are
1497 * set to empty strings. If the port is not found, it is set to a negative
1500 * @param proto the buffer for the protocol
1501 * @param proto_size the size of the proto buffer
1502 * @param authorization the buffer for the authorization
1503 * @param authorization_size the size of the authorization buffer
1504 * @param hostname the buffer for the host name
1505 * @param hostname_size the size of the hostname buffer
1506 * @param port_ptr a pointer to store the port number in
1507 * @param path the buffer for the path
1508 * @param path_size the size of the path buffer
1509 * @param url the URL to split
1511 void av_url_split(char *proto, int proto_size,
1512 char *authorization, int authorization_size,
1513 char *hostname, int hostname_size,
1515 char *path, int path_size,
1519 * Allocate the stream private data and write the stream header to
1520 * an output media file.
1522 * @param s Media file handle, must be allocated with avformat_alloc_context().
1523 * Its oformat field must be set to the desired output format;
1524 * Its pb field must be set to an already openened AVIOContext.
1525 * @param options An AVDictionary filled with AVFormatContext and muxer-private options.
1526 * On return this parameter will be destroyed and replaced with a dict containing
1527 * options that were not found. May be NULL.
1529 * @return 0 on success, negative AVERROR on failure.
1531 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next.
1533 int avformat_write_header(AVFormatContext *s, AVDictionary **options);
1535 #if FF_API_FORMAT_PARAMETERS
1537 * Allocate the stream private data and write the stream header to an
1538 * output media file.
1539 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1540 * but for some formats it might also be some other time base
1542 * @param s media file handle
1543 * @return 0 if OK, AVERROR_xxx on error
1545 * @deprecated use avformat_write_header.
1547 attribute_deprecated int av_write_header(AVFormatContext *s);
1551 * Write a packet to an output media file.
1553 * The packet shall contain one audio or video frame.
1554 * The packet must be correctly interleaved according to the container
1555 * specification, if not then av_interleaved_write_frame must be used.
1557 * @param s media file handle
1558 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1560 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1562 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1565 * Write a packet to an output media file ensuring correct interleaving.
1567 * The packet must contain one audio or video frame.
1568 * If the packets are already correctly interleaved, the application should
1569 * call av_write_frame() instead as it is slightly faster. It is also important
1570 * to keep in mind that completely non-interleaved input will need huge amounts
1571 * of memory to interleave with this, so it is preferable to interleave at the
1574 * @param s media file handle
1575 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1577 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1579 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1582 * Interleave a packet per dts in an output media file.
1584 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1585 * function, so they cannot be used after it. Note that calling av_free_packet()
1586 * on them is still safe.
1588 * @param s media file handle
1589 * @param out the interleaved packet will be output here
1590 * @param pkt the input packet
1591 * @param flush 1 if no further packets are available as input and all
1592 * remaining packets should be output
1593 * @return 1 if a packet was output, 0 if no packet could be output,
1594 * < 0 if an error occurred
1596 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1597 AVPacket *pkt, int flush);
1600 * Write the stream trailer to an output media file and free the
1601 * file private data.
1603 * May only be called after a successful call to av_write_header.
1605 * @param s media file handle
1606 * @return 0 if OK, AVERROR_xxx on error
1608 int av_write_trailer(AVFormatContext *s);
1611 * Get timing information for the data currently output.
1612 * The exact meaning of "currently output" depends on the format.
1613 * It is mostly relevant for devices that have an internal buffer and/or
1614 * work in real time.
1615 * @param s media file handle
1616 * @param stream stream in the media file
1617 * @param dts[out] DTS of the last packet output for the stream, in stream
1619 * @param wall[out] absolute time when that packet whas output,
1621 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it
1622 * Note: some formats or devices may not allow to measure dts and wall
1625 int av_get_output_timestamp(struct AVFormatContext *s, int stream,
1626 int64_t *dts, int64_t *wall);
1628 #if FF_API_DUMP_FORMAT
1630 * @deprecated Deprecated in favor of av_dump_format().
1632 attribute_deprecated void dump_format(AVFormatContext *ic,
1638 void av_dump_format(AVFormatContext *ic,
1643 #if FF_API_PARSE_DATE
1645 * Parse datestr and return a corresponding number of microseconds.
1647 * @param datestr String representing a date or a duration.
1648 * See av_parse_time() for the syntax of the provided string.
1649 * @deprecated in favor of av_parse_time()
1651 attribute_deprecated
1652 int64_t parse_date(const char *datestr, int duration);
1656 * Get the current time in microseconds.
1658 int64_t av_gettime(void);
1660 #if FF_API_FIND_INFO_TAG
1662 * @deprecated use av_find_info_tag in libavutil instead.
1664 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1668 * Return in 'buf' the path with '%d' replaced by a number.
1670 * Also handles the '%0nd' format where 'n' is the total number
1671 * of digits and '%%'.
1673 * @param buf destination buffer
1674 * @param buf_size destination buffer size
1675 * @param path numbered sequence string
1676 * @param number frame number
1677 * @return 0 if OK, -1 on format error
1679 int av_get_frame_filename(char *buf, int buf_size,
1680 const char *path, int number);
1683 * Check whether filename actually is a numbered sequence generator.
1685 * @param filename possible numbered sequence string
1686 * @return 1 if a valid numbered sequence string, 0 otherwise
1688 int av_filename_number_test(const char *filename);
1691 * Generate an SDP for an RTP session.
1693 * @param ac array of AVFormatContexts describing the RTP streams. If the
1694 * array is composed by only one context, such context can contain
1695 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1696 * all the contexts in the array (an AVCodecContext per RTP stream)
1697 * must contain only one AVStream.
1698 * @param n_files number of AVCodecContexts contained in ac
1699 * @param buf buffer where the SDP will be stored (must be allocated by
1701 * @param size the size of the buffer
1702 * @return 0 if OK, AVERROR_xxx on error
1704 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1706 #if FF_API_SDP_CREATE
1707 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1711 * Return a positive value if the given filename has one of the given
1712 * extensions, 0 otherwise.
1714 * @param extensions a comma-separated list of filename extensions
1716 int av_match_ext(const char *filename, const char *extensions);
1719 * Test if the given container can store a codec.
1721 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_*
1723 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot.
1724 * A negative number if this information is not available.
1726 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance);
1729 * Get the AVClass for AVFormatContext. It can be used in combination with
1730 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
1732 * @see av_opt_find().
1734 const AVClass *avformat_get_class(void);
1736 #endif /* AVFORMAT_AVFORMAT_H */