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
24 #define LIBAVFORMAT_VERSION_MAJOR 52
25 #define LIBAVFORMAT_VERSION_MINOR 34
26 #define LIBAVFORMAT_VERSION_MICRO 0
28 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29 LIBAVFORMAT_VERSION_MINOR, \
30 LIBAVFORMAT_VERSION_MICRO)
31 #define LIBAVFORMAT_VERSION AV_VERSION(LIBAVFORMAT_VERSION_MAJOR, \
32 LIBAVFORMAT_VERSION_MINOR, \
33 LIBAVFORMAT_VERSION_MICRO)
34 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
36 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
39 * Returns the LIBAVFORMAT_VERSION_INT constant.
41 unsigned avformat_version(void);
44 #include <stdio.h> /* FILE */
45 #include "libavcodec/avcodec.h"
49 struct AVFormatContext
;
53 * Public Metadata API.
54 * The metadata API allows libavformat to export metadata tags to a client
55 * application using a sequence of key/value pairs.
56 * Important concepts to keep in mind:
57 * 1. Keys are unique; there can never be 2 tags with the same key. This is
58 * also meant semantically, i.e., a demuxer should not knowingly produce
59 * several keys that are literally different but semantically identical.
60 * E.g., key=Author5, key=Author6. In this example, all authors must be
61 * placed in the same tag.
62 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
63 * want to store, e.g., the email address of the child of producer Alice
64 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
65 * 3. A tag whose value is localized for a particular language is appended
66 * with a dash character ('-') and the ISO 639-2/B 3-letter language code.
67 * For example: Author-ger=Michael, Author-eng=Mike
68 * The original/default language is in the unqualified "Author" tag.
69 * A demuxer should set a default if it sets any translated tag.
72 #define AV_METADATA_MATCH_CASE 1
73 #define AV_METADATA_IGNORE_SUFFIX 2
80 typedef struct AVMetadata AVMetadata
;
81 typedef struct AVMetadataConv AVMetadataConv
;
84 * Gets a metadata element with matching key.
85 * @param prev Set to the previous matching element to find the next.
86 * @param flags Allows case as well as suffix-insensitive comparisons.
87 * @return Found tag or NULL, changing key or value leads to undefined behavior.
90 av_metadata_get(AVMetadata
*m
, const char *key
, const AVMetadataTag
*prev
, int flags
);
93 * Sets the given tag in m, overwriting an existing tag.
94 * @param key tag key to add to m (will be av_strduped)
95 * @param value tag value to add to m (will be av_strduped)
96 * @return >= 0 on success otherwise an error code <0
98 int av_metadata_set(AVMetadata
**pm
, const char *key
, const char *value
);
101 * Convert all the metadata sets from ctx according to the source and
102 * destination conversion tables.
103 * @param d_conv destination tags format conversion table
104 * @param s_conv source tags format conversion table
106 void av_metadata_conv(struct AVFormatContext
*ctx
,const AVMetadataConv
*d_conv
,
107 const AVMetadataConv
*s_conv
);
110 * Frees all the memory allocated for an AVMetadata struct.
112 void av_metadata_free(AVMetadata
**m
);
115 /* packet functions */
119 * Allocate and read the payload of a packet and initialize its fields with
123 * @param size desired payload size
124 * @return >0 (read size) if OK, AVERROR_xxx otherwise
126 int av_get_packet(ByteIOContext
*s
, AVPacket
*pkt
, int size
);
129 /*************************************************/
130 /* fractional numbers for exact pts handling */
133 * The exact value of the fractional number is: 'val + num / den'.
134 * num is assumed to be 0 <= num < den.
136 typedef struct AVFrac
{
137 int64_t val
, num
, den
;
140 /*************************************************/
141 /* input/output formats */
145 /** This structure contains the data a format has to probe a file. */
146 typedef struct AVProbeData
{
147 const char *filename
;
152 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
153 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
155 typedef struct AVFormatParameters
{
156 AVRational time_base
;
161 enum PixelFormat pix_fmt
;
162 int channel
; /**< Used to select DV channel. */
163 const char *standard
; /**< TV standard, NTSC, PAL, SECAM */
164 unsigned int mpeg2ts_raw
:1; /**< Force raw MPEG-2 transport stream output, if possible. */
165 unsigned int mpeg2ts_compute_pcr
:1; /**< Compute exact PCR for each transport
166 stream packet (only meaningful if
167 mpeg2ts_raw is TRUE). */
168 unsigned int initial_pause
:1; /**< Do not begin to play the stream
169 immediately (RTSP only). */
170 unsigned int prealloced_context
:1;
171 #if LIBAVFORMAT_VERSION_INT < (53<<16)
172 enum CodecID video_codec_id
;
173 enum CodecID audio_codec_id
;
175 } AVFormatParameters
;
177 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
178 #define AVFMT_NOFILE 0x0001
179 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
180 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
181 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
183 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
184 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
185 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
186 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
187 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
189 typedef struct AVOutputFormat
{
192 * Descriptive name for the format, meant to be more human-readable
193 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
196 const char *long_name
;
197 const char *mime_type
;
198 const char *extensions
; /**< comma-separated filename extensions */
199 /** size of private data so that it can be allocated in the wrapper */
202 enum CodecID audio_codec
; /**< default audio codec */
203 enum CodecID video_codec
; /**< default video codec */
204 int (*write_header
)(struct AVFormatContext
*);
205 int (*write_packet
)(struct AVFormatContext
*, AVPacket
*pkt
);
206 int (*write_trailer
)(struct AVFormatContext
*);
207 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
209 /** Currently only used to set pixel format if not YUV420P. */
210 int (*set_parameters
)(struct AVFormatContext
*, AVFormatParameters
*);
211 int (*interleave_packet
)(struct AVFormatContext
*, AVPacket
*out
,
212 AVPacket
*in
, int flush
);
215 * List of supported codec_id-codec_tag pairs, ordered by "better
216 * choice first". The arrays are all terminated by CODEC_ID_NONE.
218 const struct AVCodecTag
* const *codec_tag
;
220 enum CodecID subtitle_codec
; /**< default subtitle codec */
222 const AVMetadataConv
*metadata_conv
;
225 struct AVOutputFormat
*next
;
228 typedef struct AVInputFormat
{
231 * Descriptive name for the format, meant to be more human-readable
232 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
235 const char *long_name
;
236 /** Size of private data so that it can be allocated in the wrapper. */
239 * Tell if a given file has a chance of being parsed as this format.
240 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
241 * big so you do not have to check for that unless you need more.
243 int (*read_probe
)(AVProbeData
*);
244 /** Read the format header and initialize the AVFormatContext
245 structure. Return 0 if OK. 'ap' if non-NULL contains
246 additional parameters. Only used in raw format right
247 now. 'av_new_stream' should be called to create new streams. */
248 int (*read_header
)(struct AVFormatContext
*,
249 AVFormatParameters
*ap
);
250 /** Read one packet and put it in 'pkt'. pts and flags are also
251 set. 'av_new_stream' can be called only if the flag
252 AVFMTCTX_NOHEADER is used.
253 @return 0 on success, < 0 on error.
254 When returning an error, pkt must not have been allocated
255 or must be freed before returning */
256 int (*read_packet
)(struct AVFormatContext
*, AVPacket
*pkt
);
257 /** Close the stream. The AVFormatContext and AVStreams are not
258 freed by this function */
259 int (*read_close
)(struct AVFormatContext
*);
261 #if LIBAVFORMAT_VERSION_MAJOR < 53
263 * Seek to a given timestamp relative to the frames in
264 * stream component stream_index.
265 * @param stream_index Must not be -1.
266 * @param flags Selects which direction should be preferred if no exact
267 * match is available.
268 * @return >= 0 on success (but not necessarily the new offset)
270 int (*read_seek
)(struct AVFormatContext
*,
271 int stream_index
, int64_t timestamp
, int flags
);
274 * Gets the next timestamp in stream[stream_index].time_base units.
275 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
277 int64_t (*read_timestamp
)(struct AVFormatContext
*s
, int stream_index
,
278 int64_t *pos
, int64_t pos_limit
);
279 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
281 /** If extensions are defined, then no probe is done. You should
282 usually not use extension format guessing because it is not
284 const char *extensions
;
285 /** General purpose read-only value that the format can use. */
288 /** Start/resume playing - only meaningful if using a network-based format
290 int (*read_play
)(struct AVFormatContext
*);
292 /** Pause playing - only meaningful if using a network-based format
294 int (*read_pause
)(struct AVFormatContext
*);
296 const struct AVCodecTag
* const *codec_tag
;
299 * Seek to timestamp ts.
300 * Seeking will be done so that the point from which all active streams
301 * can be presented successfully will be closest to ts and within min/max_ts.
302 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
304 int (*read_seek2
)(struct AVFormatContext
*s
, int stream_index
, int64_t min_ts
, int64_t ts
, int64_t max_ts
, int flags
);
306 const AVMetadataConv
*metadata_conv
;
309 struct AVInputFormat
*next
;
312 enum AVStreamParseType
{
314 AVSTREAM_PARSE_FULL
, /**< full parsing and repack */
315 AVSTREAM_PARSE_HEADERS
, /**< Only parse headers, do not repack. */
316 AVSTREAM_PARSE_TIMESTAMPS
, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
319 typedef struct AVIndexEntry
{
322 #define AVINDEX_KEYFRAME 0x0001
324 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).
325 int min_distance
; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
328 #define AV_DISPOSITION_DEFAULT 0x0001
329 #define AV_DISPOSITION_DUB 0x0002
330 #define AV_DISPOSITION_ORIGINAL 0x0004
331 #define AV_DISPOSITION_COMMENT 0x0008
332 #define AV_DISPOSITION_LYRICS 0x0010
333 #define AV_DISPOSITION_KARAOKE 0x0020
337 * New fields can be added to the end with minor version bumps.
338 * Removal, reordering and changes to existing fields require a major
340 * sizeof(AVStream) must not be used outside libav*.
342 typedef struct AVStream
{
343 int index
; /**< stream index in AVFormatContext */
344 int id
; /**< format-specific stream ID */
345 AVCodecContext
*codec
; /**< codec context */
347 * Real base framerate of the stream.
348 * This is the lowest framerate with which all timestamps can be
349 * represented accurately (it is the least common multiple of all
350 * framerates in the stream). Note, this value is just a guess!
351 * For example, if the time base is 1/90000 and all frames have either
352 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
354 AVRational r_frame_rate
;
357 /* internal data used in av_find_stream_info() */
359 /** encoding: pts generation when outputting stream */
363 * This is the fundamental unit of time (in seconds) in terms
364 * of which frame timestamps are represented. For fixed-fps content,
365 * time base should be 1/framerate and timestamp increments should be 1.
367 AVRational time_base
;
368 int pts_wrap_bits
; /**< number of bits in pts (used for wrapping control) */
369 /* ffmpeg.c private use */
370 int stream_copy
; /**< If set, just copy stream. */
371 enum AVDiscard discard
; ///< Selects which packets can be discarded at will and do not need to be demuxed.
372 //FIXME move stuff to a flags field?
373 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
374 * MN: dunno if that is the right place for it */
377 * Decoding: pts of the first frame of the stream, in stream time base.
378 * Only set this if you are absolutely 100% sure that the value you set
379 * it to really is the pts of the first frame.
380 * This may be undefined (AV_NOPTS_VALUE).
381 * @note The ASF header does NOT contain a correct start_time the ASF
382 * demuxer must NOT set this.
386 * Decoding: duration of the stream, in stream time base.
387 * If a source file does not specify a duration, but does specify
388 * a bitrate, this value will be estimated from bitrate and file size.
392 #if LIBAVFORMAT_VERSION_INT < (53<<16)
393 char language
[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
396 /* av_read_frame() support */
397 enum AVStreamParseType need_parsing
;
398 struct AVCodecParserContext
*parser
;
401 int last_IP_duration
;
403 /* av_seek_frame() support */
404 AVIndexEntry
*index_entries
; /**< Only used if the format does not
405 support seeking natively. */
406 int nb_index_entries
;
407 unsigned int index_entries_allocated_size
;
409 int64_t nb_frames
; ///< number of frames in this stream if known or 0
411 #if LIBAVFORMAT_VERSION_INT < (53<<16)
414 char *filename
; /**< source filename of the stream */
417 int disposition
; /**< AV_DISPOSITION_* bit field */
419 AVProbeData probe_data
;
420 #define MAX_REORDER_DELAY 16
421 int64_t pts_buffer
[MAX_REORDER_DELAY
+1];
424 * sample aspect ratio (0 if unknown)
425 * - encoding: Set by user.
426 * - decoding: Set by libavformat.
428 AVRational sample_aspect_ratio
;
430 AVMetadata
*metadata
;
432 /* av_read_frame() support */
433 const uint8_t *cur_ptr
;
437 // Timestamp generation support:
439 * Timestamp corresponding to the last dts sync point.
441 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
442 * a DTS is received from the underlying container. Otherwise set to
443 * AV_NOPTS_VALUE by default.
445 int64_t reference_dts
;
448 * Number of packets to buffer for codec probing
449 * NOT PART OF PUBLIC API
451 #define MAX_PROBE_PACKETS 100
455 #define AV_PROGRAM_RUNNING 1
458 * New fields can be added to the end with minor version bumps.
459 * Removal, reordering and changes to existing fields require a major
461 * sizeof(AVProgram) must not be used outside libav*.
463 typedef struct AVProgram
{
465 #if LIBAVFORMAT_VERSION_INT < (53<<16)
466 char *provider_name
; ///< network name for DVB streams
467 char *name
; ///< service name for DVB streams
470 enum AVDiscard discard
; ///< selects which program to discard and which to feed to the caller
471 unsigned int *stream_index
;
472 unsigned int nb_stream_indexes
;
473 AVMetadata
*metadata
;
476 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
477 (streams are added dynamically) */
479 typedef struct AVChapter
{
480 int id
; ///< unique ID to identify the chapter
481 AVRational time_base
; ///< time base in which the start/end timestamps are specified
482 int64_t start
, end
; ///< chapter start/end time in time_base units
483 #if LIBAVFORMAT_VERSION_INT < (53<<16)
484 char *title
; ///< chapter title
486 AVMetadata
*metadata
;
489 #define MAX_STREAMS 20
492 * Format I/O context.
493 * New fields can be added to the end with minor version bumps.
494 * Removal, reordering and changes to existing fields require a major
496 * sizeof(AVFormatContext) must not be used outside libav*.
498 typedef struct AVFormatContext
{
499 const AVClass
*av_class
; /**< Set by avformat_alloc_context. */
500 /* Can only be iformat or oformat, not both at the same time. */
501 struct AVInputFormat
*iformat
;
502 struct AVOutputFormat
*oformat
;
505 unsigned int nb_streams
;
506 AVStream
*streams
[MAX_STREAMS
];
507 char filename
[1024]; /**< input or output filename */
510 #if LIBAVFORMAT_VERSION_INT < (53<<16)
516 int year
; /**< ID3 year, 0 if none */
517 int track
; /**< track number, 0 if none */
518 char genre
[32]; /**< ID3 genre */
521 int ctx_flags
; /**< Format-specific flags, see AVFMTCTX_xx */
522 /* private data for pts handling (do not modify directly). */
523 /** This buffer is only needed when packets were already buffered but
524 not decoded, for example to get the codec parameters in MPEG
526 struct AVPacketList
*packet_buffer
;
528 /** Decoding: position of the first frame of the component, in
529 AV_TIME_BASE fractional seconds. NEVER set this value directly:
530 It is deduced from the AVStream values. */
532 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
533 seconds. NEVER set this value directly: it is deduced from the
536 /** decoding: total file size, 0 if unknown */
538 /** Decoding: total stream bitrate in bit/s, 0 if not
539 available. Never set it directly if the file_size and the
540 duration are known as FFmpeg can compute it automatically. */
543 /* av_read_frame() support */
545 #if LIBAVFORMAT_VERSION_INT < (53<<16)
546 const uint8_t *cur_ptr_deprecated
;
547 int cur_len_deprecated
;
548 AVPacket cur_pkt_deprecated
;
551 /* av_seek_frame() support */
552 int64_t data_offset
; /** offset of the first packet */
560 #define AVFMT_NOOUTPUTLOOP -1
561 #define AVFMT_INFINITEOUTPUTLOOP 0
562 /** number of times to loop output in formats that support it */
566 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
567 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
568 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
571 /** decoding: size of data to probe; encoding: unused. */
572 unsigned int probesize
;
575 * Maximum time (in AV_TIME_BASE units) during which the input should
576 * be analyzed in av_find_stream_info().
578 int max_analyze_duration
;
583 unsigned int nb_programs
;
584 AVProgram
**programs
;
587 * Forced video codec_id.
588 * Demuxing: Set by user.
590 enum CodecID video_codec_id
;
592 * Forced audio codec_id.
593 * Demuxing: Set by user.
595 enum CodecID audio_codec_id
;
597 * Forced subtitle codec_id.
598 * Demuxing: Set by user.
600 enum CodecID subtitle_codec_id
;
603 * Maximum amount of memory in bytes to use for the index of each stream.
604 * If the index exceeds this size, entries will be discarded as
605 * needed to maintain a smaller size. This can lead to slower or less
606 * accurate seeking (depends on demuxer).
607 * Demuxers for which a full in-memory index is mandatory will ignore
610 * demuxing: set by user
612 unsigned int max_index_size
;
615 * Maximum amount of memory in bytes to use for buffering frames
616 * obtained from realtime capture devices.
618 unsigned int max_picture_buffer
;
620 unsigned int nb_chapters
;
621 AVChapter
**chapters
;
624 * Flags to enable debugging.
627 #define FF_FDEBUG_TS 0x0001
630 * Raw packets from the demuxer, prior to parsing and decoding.
631 * This buffer is used for buffering packets until the codec can
632 * be identified, as parsing cannot be done without knowing the
635 struct AVPacketList
*raw_packet_buffer
;
636 struct AVPacketList
*raw_packet_buffer_end
;
638 struct AVPacketList
*packet_buffer_end
;
640 AVMetadata
*metadata
;
643 typedef struct AVPacketList
{
645 struct AVPacketList
*next
;
648 #if LIBAVFORMAT_VERSION_INT < (53<<16)
649 extern AVInputFormat
*first_iformat
;
650 extern AVOutputFormat
*first_oformat
;
654 * If f is NULL, returns the first registered input format,
655 * if f is non-NULL, returns the next registered input format after f
656 * or NULL if f is the last one.
658 AVInputFormat
*av_iformat_next(AVInputFormat
*f
);
661 * If f is NULL, returns the first registered output format,
662 * if f is non-NULL, returns the next registered output format after f
663 * or NULL if f is the last one.
665 AVOutputFormat
*av_oformat_next(AVOutputFormat
*f
);
667 enum CodecID
av_guess_image2_codec(const char *filename
);
669 /* XXX: Use automatic init with either ELF sections or C file parser */
673 void av_register_input_format(AVInputFormat
*format
);
674 void av_register_output_format(AVOutputFormat
*format
);
675 AVOutputFormat
*guess_stream_format(const char *short_name
,
676 const char *filename
,
677 const char *mime_type
);
678 AVOutputFormat
*guess_format(const char *short_name
,
679 const char *filename
,
680 const char *mime_type
);
683 * Guesses the codec ID based upon muxer and filename.
685 enum CodecID
av_guess_codec(AVOutputFormat
*fmt
, const char *short_name
,
686 const char *filename
, const char *mime_type
,
687 enum CodecType type
);
690 * Send a nice hexadecimal dump of a buffer to the specified file stream.
692 * @param f The file stream pointer where the dump should be sent to.
694 * @param size buffer size
696 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
698 void av_hex_dump(FILE *f
, uint8_t *buf
, int size
);
701 * Send a nice hexadecimal dump of a buffer to the log.
703 * @param avcl A pointer to an arbitrary struct of which the first field is a
704 * pointer to an AVClass struct.
705 * @param level The importance level of the message, lower values signifying
708 * @param size buffer size
710 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
712 void av_hex_dump_log(void *avcl
, int level
, uint8_t *buf
, int size
);
715 * Send a nice dump of a packet to the specified file stream.
717 * @param f The file stream pointer where the dump should be sent to.
718 * @param pkt packet to dump
719 * @param dump_payload True if the payload must be displayed, too.
721 void av_pkt_dump(FILE *f
, AVPacket
*pkt
, int dump_payload
);
724 * Send a nice dump of a packet to the log.
726 * @param avcl A pointer to an arbitrary struct of which the first field is a
727 * pointer to an AVClass struct.
728 * @param level The importance level of the message, lower values signifying
730 * @param pkt packet to dump
731 * @param dump_payload True if the payload must be displayed, too.
733 void av_pkt_dump_log(void *avcl
, int level
, AVPacket
*pkt
, int dump_payload
);
736 * Initialize libavformat and register all the muxers, demuxers and
737 * protocols. If you do not call this function, then you can select
738 * exactly which formats you want to support.
740 * @see av_register_input_format()
741 * @see av_register_output_format()
742 * @see av_register_protocol()
744 void av_register_all(void);
746 /** codec tag <-> codec id */
747 enum CodecID
av_codec_get_id(const struct AVCodecTag
* const *tags
, unsigned int tag
);
748 unsigned int av_codec_get_tag(const struct AVCodecTag
* const *tags
, enum CodecID id
);
750 /* media file input */
753 * Finds AVInputFormat based on the short name of the input format.
755 AVInputFormat
*av_find_input_format(const char *short_name
);
760 * @param is_opened Whether the file is already opened; determines whether
761 * demuxers with or without AVFMT_NOFILE are probed.
763 AVInputFormat
*av_probe_input_format(AVProbeData
*pd
, int is_opened
);
766 * Allocates all the structures needed to read an input stream.
767 * This does not open the needed codecs for decoding the stream[s].
769 int av_open_input_stream(AVFormatContext
**ic_ptr
,
770 ByteIOContext
*pb
, const char *filename
,
771 AVInputFormat
*fmt
, AVFormatParameters
*ap
);
774 * Open a media file as input. The codecs are not opened. Only the file
775 * header (if present) is read.
777 * @param ic_ptr The opened media file handle is put here.
778 * @param filename filename to open
779 * @param fmt If non-NULL, force the file format to use.
780 * @param buf_size optional buffer size (zero if default is OK)
781 * @param ap Additional parameters needed when opening the file
783 * @return 0 if OK, AVERROR_xxx otherwise
785 int av_open_input_file(AVFormatContext
**ic_ptr
, const char *filename
,
788 AVFormatParameters
*ap
);
790 #if LIBAVFORMAT_VERSION_MAJOR < 53
792 * @deprecated Use avformat_alloc_context() instead.
794 attribute_deprecated AVFormatContext
*av_alloc_format_context(void);
798 * Allocate an AVFormatContext.
799 * Can be freed with av_free() but do not forget to free everything you
800 * explicitly allocated as well!
802 AVFormatContext
*avformat_alloc_context(void);
805 * Read packets of a media file to get stream information. This
806 * is useful for file formats with no headers such as MPEG. This
807 * function also computes the real framerate in case of MPEG-2 repeat
809 * The logical file position is not changed by this function;
810 * examined packets may be buffered for later processing.
812 * @param ic media file handle
813 * @return >=0 if OK, AVERROR_xxx on error
814 * @todo Let the user decide somehow what information is needed so that
815 * we do not waste time getting stuff the user does not need.
817 int av_find_stream_info(AVFormatContext
*ic
);
820 * Read a transport packet from a media file.
822 * This function is obsolete and should never be used.
823 * Use av_read_frame() instead.
825 * @param s media file handle
826 * @param pkt is filled
827 * @return 0 if OK, AVERROR_xxx on error
829 int av_read_packet(AVFormatContext
*s
, AVPacket
*pkt
);
832 * Return the next frame of a stream.
834 * The returned packet is valid
835 * until the next av_read_frame() or until av_close_input_file() and
836 * must be freed with av_free_packet. For video, the packet contains
837 * exactly one frame. For audio, it contains an integer number of
838 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
839 * data). If the audio frames have a variable size (e.g. MPEG audio),
840 * then it contains one frame.
842 * pkt->pts, pkt->dts and pkt->duration are always set to correct
843 * values in AVStream.time_base units (and guessed if the format cannot
844 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
845 * has B-frames, so it is better to rely on pkt->dts if you do not
846 * decompress the payload.
848 * @return 0 if OK, < 0 on error or end of file
850 int av_read_frame(AVFormatContext
*s
, AVPacket
*pkt
);
853 * Seek to the keyframe at timestamp.
854 * 'timestamp' in 'stream_index'.
855 * @param stream_index If stream_index is (-1), a default
856 * stream is selected, and timestamp is automatically converted
857 * from AV_TIME_BASE units to the stream specific time_base.
858 * @param timestamp Timestamp in AVStream.time_base units
859 * or, if no stream is specified, in AV_TIME_BASE units.
860 * @param flags flags which select direction and seeking mode
861 * @return >= 0 on success
863 int av_seek_frame(AVFormatContext
*s
, int stream_index
, int64_t timestamp
,
867 * Seek to timestamp ts.
868 * Seeking will be done so that the point from which all active streams
869 * can be presented successfully will be closest to ts and within min/max_ts.
870 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
872 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
873 * are the file position (this may not be supported by all demuxers).
874 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
875 * in the stream with stream_index (this may not be supported by all demuxers).
876 * Otherwise all timestamps are in units of the stream selected by stream_index
877 * or if stream_index is -1, in AV_TIME_BASE units.
878 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
879 * keyframes (this may not be supported by all demuxers).
881 * @param stream_index index of the stream which is used as time base reference
882 * @param min_ts smallest acceptable timestamp
883 * @param ts target timestamp
884 * @param max_ts largest acceptable timestamp
886 * @returns >=0 on success, error code otherwise
888 * @NOTE This is part of the new seek API which is still under construction.
889 * Thus do not use this yet. It may change at any time, do not expect
890 * ABI compatibility yet!
892 int avformat_seek_file(AVFormatContext
*s
, int stream_index
, int64_t min_ts
, int64_t ts
, int64_t max_ts
, int flags
);
895 * Start playing a network-based stream (e.g. RTSP stream) at the
898 int av_read_play(AVFormatContext
*s
);
901 * Pause a network-based stream (e.g. RTSP stream).
903 * Use av_read_play() to resume it.
905 int av_read_pause(AVFormatContext
*s
);
908 * Free a AVFormatContext allocated by av_open_input_stream.
909 * @param s context to free
911 void av_close_input_stream(AVFormatContext
*s
);
914 * Close a media file (but not its codecs).
916 * @param s media file handle
918 void av_close_input_file(AVFormatContext
*s
);
921 * Add a new stream to a media file.
923 * Can only be called in the read_header() function. If the flag
924 * AVFMTCTX_NOHEADER is in the format context, then new streams
925 * can be added in read_packet too.
927 * @param s media file handle
928 * @param id file-format-dependent stream ID
930 AVStream
*av_new_stream(AVFormatContext
*s
, int id
);
931 AVProgram
*av_new_program(AVFormatContext
*s
, int id
);
935 * This function is NOT part of the public API
936 * and should ONLY be used by demuxers.
938 * @param s media file handle
939 * @param id unique ID for this chapter
940 * @param start chapter start time in time_base units
941 * @param end chapter end time in time_base units
942 * @param title chapter title
944 * @return AVChapter or NULL on error
946 AVChapter
*ff_new_chapter(AVFormatContext
*s
, int id
, AVRational time_base
,
947 int64_t start
, int64_t end
, const char *title
);
950 * Set the pts for a given stream.
953 * @param pts_wrap_bits number of bits effectively used by the pts
954 * (used for wrap control, 33 is the value for MPEG)
955 * @param pts_num numerator to convert to seconds (MPEG: 1)
956 * @param pts_den denominator to convert to seconds (MPEG: 90000)
958 void av_set_pts_info(AVStream
*s
, int pts_wrap_bits
,
959 int pts_num
, int pts_den
);
961 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
962 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
963 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
965 int av_find_default_stream_index(AVFormatContext
*s
);
968 * Gets the index for a specific timestamp.
969 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
970 * to the timestamp which is <= the requested one, if backward
971 * is 0, then it will be >=
972 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
973 * @return < 0 if no such timestamp could be found
975 int av_index_search_timestamp(AVStream
*st
, int64_t timestamp
, int flags
);
978 * Ensures the index uses less memory than the maximum specified in
979 * AVFormatContext.max_index_size by discarding entries if it grows
981 * This function is not part of the public API and should only be called
984 void ff_reduce_index(AVFormatContext
*s
, int stream_index
);
987 * Add an index entry into a sorted list. Update the entry if the list
988 * already contains it.
990 * @param timestamp timestamp in the time base of the given stream
992 int av_add_index_entry(AVStream
*st
, int64_t pos
, int64_t timestamp
,
993 int size
, int distance
, int flags
);
996 * Does a binary search using av_index_search_timestamp() and
997 * AVCodec.read_timestamp().
998 * This is not supposed to be called directly by a user application,
1000 * @param target_ts target timestamp in the time base of the given stream
1001 * @param stream_index stream number
1003 int av_seek_frame_binary(AVFormatContext
*s
, int stream_index
,
1004 int64_t target_ts
, int flags
);
1007 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1009 * Stream ref_st unchanged, others set cur_dts in their native time base.
1010 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1011 * @param timestamp new dts expressed in time_base of param ref_st
1012 * @param ref_st reference stream giving time_base of param timestamp
1014 void av_update_cur_dts(AVFormatContext
*s
, AVStream
*ref_st
, int64_t timestamp
);
1017 * Does a binary search using read_timestamp().
1018 * This is not supposed to be called directly by a user application,
1020 * @param target_ts target timestamp in the time base of the given stream
1021 * @param stream_index stream number
1023 int64_t av_gen_search(AVFormatContext
*s
, int stream_index
,
1024 int64_t target_ts
, int64_t pos_min
,
1025 int64_t pos_max
, int64_t pos_limit
,
1026 int64_t ts_min
, int64_t ts_max
,
1027 int flags
, int64_t *ts_ret
,
1028 int64_t (*read_timestamp
)(struct AVFormatContext
*, int , int64_t *, int64_t ));
1030 /** media file output */
1031 int av_set_parameters(AVFormatContext
*s
, AVFormatParameters
*ap
);
1034 * Allocate the stream private data and write the stream header to an
1035 * output media file.
1037 * @param s media file handle
1038 * @return 0 if OK, AVERROR_xxx on error
1040 int av_write_header(AVFormatContext
*s
);
1043 * Write a packet to an output media file.
1045 * The packet shall contain one audio or video frame.
1046 * The packet must be correctly interleaved according to the container
1047 * specification, if not then av_interleaved_write_frame must be used.
1049 * @param s media file handle
1050 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1052 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1054 int av_write_frame(AVFormatContext
*s
, AVPacket
*pkt
);
1057 * Writes a packet to an output media file ensuring correct interleaving.
1059 * The packet must contain one audio or video frame.
1060 * If the packets are already correctly interleaved, the application should
1061 * call av_write_frame() instead as it is slightly faster. It is also important
1062 * to keep in mind that completely non-interleaved input will need huge amounts
1063 * of memory to interleave with this, so it is preferable to interleave at the
1066 * @param s media file handle
1067 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1069 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1071 int av_interleaved_write_frame(AVFormatContext
*s
, AVPacket
*pkt
);
1074 * Interleave a packet per dts in an output media file.
1076 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1077 * function, so they cannot be used after it. Note that calling av_free_packet()
1078 * on them is still safe.
1080 * @param s media file handle
1081 * @param out the interleaved packet will be output here
1082 * @param in the input packet
1083 * @param flush 1 if no further packets are available as input and all
1084 * remaining packets should be output
1085 * @return 1 if a packet was output, 0 if no packet could be output,
1086 * < 0 if an error occurred
1088 int av_interleave_packet_per_dts(AVFormatContext
*s
, AVPacket
*out
,
1089 AVPacket
*pkt
, int flush
);
1092 * @brief Write the stream trailer to an output media file and
1093 * free the file private data.
1095 * May only be called after a successful call to av_write_header.
1097 * @param s media file handle
1098 * @return 0 if OK, AVERROR_xxx on error
1100 int av_write_trailer(AVFormatContext
*s
);
1102 void dump_format(AVFormatContext
*ic
,
1107 #if LIBAVFORMAT_VERSION_MAJOR < 53
1109 * Parses width and height out of string str.
1110 * @deprecated Use av_parse_video_frame_size instead.
1112 attribute_deprecated
int parse_image_size(int *width_ptr
, int *height_ptr
,
1116 * Converts framerate from a string to a fraction.
1117 * @deprecated Use av_parse_video_frame_rate instead.
1119 attribute_deprecated
int parse_frame_rate(int *frame_rate
, int *frame_rate_base
,
1124 * Parses datestr and returns a corresponding number of microseconds.
1125 * @param datestr String representing a date or a duration.
1126 * - If a date the syntax is:
1128 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1130 * Time is local time unless Z is appended, in which case it is
1131 * interpreted as UTC.
1132 * If the year-month-day part is not specified it takes the current
1134 * Returns the number of microseconds since 1st of January, 1970 up to
1135 * the time of the parsed date or INT64_MIN if datestr cannot be
1136 * successfully parsed.
1137 * - If a duration the syntax is:
1139 * [-]HH[:MM[:SS[.m...]]]
1142 * Returns the number of microseconds contained in a time interval
1143 * with the specified duration or INT64_MIN if datestr cannot be
1144 * successfully parsed.
1145 * @param duration Flag which tells how to interpret datestr, if
1146 * not zero datestr is interpreted as a duration, otherwise as a
1149 int64_t parse_date(const char *datestr
, int duration
);
1151 /** Gets the current time in microseconds. */
1152 int64_t av_gettime(void);
1154 /* ffm-specific for ffserver */
1155 #define FFM_PACKET_SIZE 4096
1156 int64_t ffm_read_write_index(int fd
);
1157 int ffm_write_write_index(int fd
, int64_t pos
);
1158 void ffm_set_write_index(AVFormatContext
*s
, int64_t pos
, int64_t file_size
);
1161 * Attempts to find a specific tag in a URL.
1163 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1164 * Return 1 if found.
1166 int find_info_tag(char *arg
, int arg_size
, const char *tag1
, const char *info
);
1169 * Returns in 'buf' the path with '%d' replaced by a number.
1171 * Also handles the '%0nd' format where 'n' is the total number
1172 * of digits and '%%'.
1174 * @param buf destination buffer
1175 * @param buf_size destination buffer size
1176 * @param path numbered sequence string
1177 * @param number frame number
1178 * @return 0 if OK, -1 on format error
1180 int av_get_frame_filename(char *buf
, int buf_size
,
1181 const char *path
, int number
);
1184 * Check whether filename actually is a numbered sequence generator.
1186 * @param filename possible numbered sequence string
1187 * @return 1 if a valid numbered sequence string, 0 otherwise
1189 int av_filename_number_test(const char *filename
);
1192 * Generate an SDP for an RTP session.
1194 * @param ac array of AVFormatContexts describing the RTP streams. If the
1195 * array is composed by only one context, such context can contain
1196 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1197 * all the contexts in the array (an AVCodecContext per RTP stream)
1198 * must contain only one AVStream.
1199 * @param n_files number of AVCodecContexts contained in ac
1200 * @param buff buffer where the SDP will be stored (must be allocated by
1202 * @param size the size of the buffer
1203 * @return 0 if OK, AVERROR_xxx on error
1205 int avf_sdp_create(AVFormatContext
*ac
[], int n_files
, char *buff
, int size
);
1207 #ifdef HAVE_AV_CONFIG_H
1209 void ff_dynarray_add(intptr_t **tab_ptr
, int *nb_ptr
, intptr_t elem
);
1212 #define dynarray_add(tab, nb_ptr, elem)\
1214 __typeof__(tab) _tab = (tab);\
1215 __typeof__(elem) _elem = (elem);\
1216 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1217 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1220 #define dynarray_add(tab, nb_ptr, elem)\
1222 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1226 time_t mktimegm(struct tm
*tm
);
1227 struct tm
*brktimegm(time_t secs
, struct tm
*tm
);
1228 const char *small_strptime(const char *p
, const char *fmt
,
1232 int resolve_host(struct in_addr
*sin_addr
, const char *hostname
);
1234 void url_split(char *proto
, int proto_size
,
1235 char *authorization
, int authorization_size
,
1236 char *hostname
, int hostname_size
,
1238 char *path
, int path_size
,
1242 * Returns a positive value if the given filename has one of the given
1243 * extensions, 0 otherwise.
1245 * @param extensions a comma-separated list of filename extensions
1247 int match_ext(const char *filename
, const char *extensions
);
1249 #endif /* HAVE_AV_CONFIG_H */
1251 #endif /* AVFORMAT_AVFORMAT_H */