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 77
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 * I return the LIBAVFORMAT_VERSION_INT constant. You got
40 * a fucking problem with that, douchebag?
42 unsigned avformat_version(void);
45 * Return the libavformat build-time configuration.
47 const char *avformat_configuration(void);
50 * Return the libavformat license.
52 const char *avformat_license(void);
55 #include <stdio.h> /* FILE */
56 #include "libavcodec/avcodec.h"
60 struct AVFormatContext;
64 * Public Metadata API.
65 * The metadata API allows libavformat to export metadata tags to a client
66 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
67 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
68 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
69 * Important concepts to keep in mind:
70 * 1. Keys are unique; there can never be 2 tags with the same key. This is
71 * also meant semantically, i.e., a demuxer should not knowingly produce
72 * several keys that are literally different but semantically identical.
73 * E.g., key=Author5, key=Author6. In this example, all authors must be
74 * placed in the same tag.
75 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
76 * want to store, e.g., the email address of the child of producer Alice
77 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
78 * 3. Several modifiers can be applied to the tag name. This is done by
79 * appending a dash character ('-') and the modifier name in the order
80 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
81 * a) language -- a tag whose value is localized for a particular language
82 * is appended with the ISO 639-2/B 3-letter language code.
83 * For example: Author-ger=Michael, Author-eng=Mike
84 * The original/default language is in the unqualified "Author" tag.
85 * A demuxer should set a default if it sets any translated tag.
86 * b) sorting -- a modified version of a tag that should be used for
87 * sorting will have '-sort' appended. E.g. artist="The Beatles",
88 * artist-sort="Beatles, The".
90 * 4. Tag names are normally exported exactly as stored in the container to
91 * allow lossless remuxing to the same format. For container-independent
92 * handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
93 * format. Follows a list of generic tag names:
95 * album -- name of the set this work belongs to
96 * album_artist -- main creator of the set/album, if different from artist.
97 * e.g. "Various Artists" for compilation albums.
98 * artist -- main creator of the work
99 * comment -- any additional description of the file.
100 * composer -- who composed the work, if different from artist.
101 * copyright -- name of copyright holder.
102 * date -- date when the work was created, preferably in ISO 8601.
103 * disc -- number of a subset, e.g. disc in a multi-disc collection.
104 * encoder -- name/settings of the software/hardware that produced the file.
105 * encoded_by -- person/group who created the file.
106 * filename -- original name of the file.
107 * genre -- <self-evident>.
108 * language -- main language in which the work is performed, preferably
109 * in ISO 639-2 format.
110 * performer -- artist who performed the work, if different from artist.
111 * E.g for "Also sprach Zarathustra", artist would be "Richard
112 * Strauss" and performer "London Philharmonic Orchestra".
113 * publisher -- name of the label/publisher.
114 * title -- name of the work.
115 * track -- number of this work in the set, can be in form current/total.
118 #define AV_METADATA_MATCH_CASE 1
119 #define AV_METADATA_IGNORE_SUFFIX 2
120 #define AV_METADATA_DONT_STRDUP_KEY 4
121 #define AV_METADATA_DONT_STRDUP_VAL 8
122 #define AV_METADATA_DONT_OVERWRITE 16 ///< Don't overwrite existing tags.
129 typedef struct AVMetadata AVMetadata;
130 typedef struct AVMetadataConv AVMetadataConv;
133 * Get a metadata element with matching key.
134 * @param prev Set to the previous matching element to find the next.
135 * If set to NULL the first matching element is returned.
136 * @param flags Allows case as well as suffix-insensitive comparisons.
137 * @return Found tag or NULL, changing key or value leads to undefined behavior.
140 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
142 #if LIBAVFORMAT_VERSION_MAJOR == 52
144 * Set the given tag in m, overwriting an existing tag.
145 * @param key tag key to add to m (will be av_strduped)
146 * @param value tag value to add to m (will be av_strduped)
147 * @return >= 0 on success otherwise an error code <0
148 * @deprecated Use av_metadata_set2() instead.
150 attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
154 * Set the given tag in m, overwriting an existing tag.
155 * @param key tag key to add to m (will be av_strduped depending on flags)
156 * @param value tag value to add to m (will be av_strduped depending on flags).
157 * Passing a NULL value will cause an existing tag to be deleted.
158 * @return >= 0 on success otherwise an error code <0
160 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
163 * Convert all the metadata sets from ctx according to the source and
164 * destination conversion tables. If one of the tables is NULL, then
165 * tags are converted to/from ffmpeg generic tag names.
166 * @param d_conv destination tags format conversion table
167 * @param s_conv source tags format conversion table
169 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
170 const AVMetadataConv *s_conv);
173 * Free all the memory allocated for an AVMetadata struct.
175 void av_metadata_free(AVMetadata **m);
178 /* packet functions */
182 * Allocate and read the payload of a packet and initialize its
183 * fields with default values.
186 * @param size desired payload size
187 * @return >0 (read size) if OK, AVERROR_xxx otherwise
189 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
192 /*************************************************/
193 /* fractional numbers for exact pts handling */
196 * The exact value of the fractional number is: 'val + num / den'.
197 * num is assumed to be 0 <= num < den.
199 typedef struct AVFrac {
200 int64_t val, num, den;
203 /*************************************************/
204 /* input/output formats */
209 * This structure contains the data a format has to probe a file.
211 typedef struct AVProbeData {
212 const char *filename;
213 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
214 int buf_size; /**< Size of buf except extra allocated bytes */
217 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
218 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
220 typedef struct AVFormatParameters {
221 AVRational time_base;
226 enum PixelFormat pix_fmt;
227 int channel; /**< Used to select DV channel. */
228 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
229 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
230 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
231 stream packet (only meaningful if
232 mpeg2ts_raw is TRUE). */
233 unsigned int initial_pause:1; /**< Do not begin to play the stream
234 immediately (RTSP only). */
235 unsigned int prealloced_context:1;
236 #if LIBAVFORMAT_VERSION_INT < (53<<16)
237 enum CodecID video_codec_id;
238 enum CodecID audio_codec_id;
240 } AVFormatParameters;
242 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
243 #define AVFMT_NOFILE 0x0001
244 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
245 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
246 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
248 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
249 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
250 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
251 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
252 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
253 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
255 typedef struct AVOutputFormat {
258 * Descriptive name for the format, meant to be more human-readable
259 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
262 const char *long_name;
263 const char *mime_type;
264 const char *extensions; /**< comma-separated filename extensions */
266 * size of private data so that it can be allocated in the wrapper
270 enum CodecID audio_codec; /**< default audio codec */
271 enum CodecID video_codec; /**< default video codec */
272 int (*write_header)(struct AVFormatContext *);
273 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
274 int (*write_trailer)(struct AVFormatContext *);
276 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
280 * Currently only used to set pixel format if not YUV420P.
282 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
283 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
284 AVPacket *in, int flush);
287 * List of supported codec_id-codec_tag pairs, ordered by "better
288 * choice first". The arrays are all terminated by CODEC_ID_NONE.
290 const struct AVCodecTag * const *codec_tag;
292 enum CodecID subtitle_codec; /**< default subtitle codec */
294 const AVMetadataConv *metadata_conv;
297 struct AVOutputFormat *next;
300 typedef struct AVInputFormat {
302 * A comma separated list of short names for the format. New names
303 * may be appended with a minor bump.
308 * Descriptive name for the format, meant to be more human-readable
309 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
312 const char *long_name;
315 * Size of private data so that it can be allocated in the wrapper.
320 * Tell if a given file has a chance of being parsed as this format.
321 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
322 * big so you do not have to check for that unless you need more.
324 int (*read_probe)(AVProbeData *);
327 * Read the format header and initialize the AVFormatContext
328 * structure. Return 0 if OK. 'ap' if non-NULL contains
329 * additional parameters. Only used in raw format right
330 * now. 'av_new_stream' should be called to create new streams.
332 int (*read_header)(struct AVFormatContext *,
333 AVFormatParameters *ap);
336 * Read one packet and put it in 'pkt'. pts and flags are also
337 * set. 'av_new_stream' can be called only if the flag
338 * AVFMTCTX_NOHEADER is used.
339 * @return 0 on success, < 0 on error.
340 * When returning an error, pkt must not have been allocated
341 * or must be freed before returning
343 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
346 * Close the stream. The AVFormatContext and AVStreams are not
347 * freed by this function
349 int (*read_close)(struct AVFormatContext *);
351 #if LIBAVFORMAT_VERSION_MAJOR < 53
353 * Seek to a given timestamp relative to the frames in
354 * stream component stream_index.
355 * @param stream_index Must not be -1.
356 * @param flags Selects which direction should be preferred if no exact
357 * match is available.
358 * @return >= 0 on success (but not necessarily the new offset)
360 int (*read_seek)(struct AVFormatContext *,
361 int stream_index, int64_t timestamp, int flags);
364 * Gets the next timestamp in stream[stream_index].time_base units.
365 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
367 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
368 int64_t *pos, int64_t pos_limit);
371 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
376 * If extensions are defined, then no probe is done. You should
377 * usually not use extension format guessing because it is not
380 const char *extensions;
383 * General purpose read-only value that the format can use.
388 * Start/resume playing - only meaningful if using a network-based format
391 int (*read_play)(struct AVFormatContext *);
394 * Pause playing - only meaningful if using a network-based format
397 int (*read_pause)(struct AVFormatContext *);
399 const struct AVCodecTag * const *codec_tag;
402 * Seek to timestamp ts.
403 * Seeking will be done so that the point from which all active streams
404 * can be presented successfully will be closest to ts and within min/max_ts.
405 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
407 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
409 const AVMetadataConv *metadata_conv;
412 struct AVInputFormat *next;
415 enum AVStreamParseType {
417 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
418 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
419 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
420 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
423 typedef struct AVIndexEntry {
426 #define AVINDEX_KEYFRAME 0x0001
428 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).
429 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
432 #define AV_DISPOSITION_DEFAULT 0x0001
433 #define AV_DISPOSITION_DUB 0x0002
434 #define AV_DISPOSITION_ORIGINAL 0x0004
435 #define AV_DISPOSITION_COMMENT 0x0008
436 #define AV_DISPOSITION_LYRICS 0x0010
437 #define AV_DISPOSITION_KARAOKE 0x0020
440 * Track should be used during playback by default.
441 * Useful for subtitle track that should be displayed
442 * even when user did not explicitly ask for subtitles.
444 #define AV_DISPOSITION_FORCED 0x0040
448 * New fields can be added to the end with minor version bumps.
449 * Removal, reordering and changes to existing fields require a major
451 * sizeof(AVStream) must not be used outside libav*.
453 typedef struct AVStream {
454 int index; /**< stream index in AVFormatContext */
455 int id; /**< format-specific stream ID */
456 AVCodecContext *codec; /**< codec context */
458 * Real base framerate of the stream.
459 * This is the lowest framerate with which all timestamps can be
460 * represented accurately (it is the least common multiple of all
461 * framerates in the stream). Note, this value is just a guess!
462 * For example, if the time base is 1/90000 and all frames have either
463 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
465 AVRational r_frame_rate;
468 /* internal data used in av_find_stream_info() */
472 * encoding: pts generation when outputting stream
477 * This is the fundamental unit of time (in seconds) in terms
478 * of which frame timestamps are represented. For fixed-fps content,
479 * time base should be 1/framerate and timestamp increments should be 1.
481 AVRational time_base;
482 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
483 /* ffmpeg.c private use */
484 int stream_copy; /**< If set, just copy stream. */
485 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
487 //FIXME move stuff to a flags field?
489 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
490 * MN: dunno if that is the right place for it
495 * Decoding: pts of the first frame of the stream, in stream time base.
496 * Only set this if you are absolutely 100% sure that the value you set
497 * it to really is the pts of the first frame.
498 * This may be undefined (AV_NOPTS_VALUE).
499 * @note The ASF header does NOT contain a correct start_time the ASF
500 * demuxer must NOT set this.
505 * Decoding: duration of the stream, in stream time base.
506 * If a source file does not specify a duration, but does specify
507 * a bitrate, this value will be estimated from bitrate and file size.
511 #if LIBAVFORMAT_VERSION_INT < (53<<16)
512 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
515 /* av_read_frame() support */
516 enum AVStreamParseType need_parsing;
517 struct AVCodecParserContext *parser;
520 int last_IP_duration;
522 /* av_seek_frame() support */
523 AVIndexEntry *index_entries; /**< Only used if the format does not
524 support seeking natively. */
525 int nb_index_entries;
526 unsigned int index_entries_allocated_size;
528 int64_t nb_frames; ///< number of frames in this stream if known or 0
530 #if LIBAVFORMAT_VERSION_INT < (53<<16)
533 char *filename; /**< source filename of the stream */
536 int disposition; /**< AV_DISPOSITION_* bit field */
538 AVProbeData probe_data;
539 #define MAX_REORDER_DELAY 16
540 int64_t pts_buffer[MAX_REORDER_DELAY+1];
543 * sample aspect ratio (0 if unknown)
544 * - encoding: Set by user.
545 * - decoding: Set by libavformat.
547 AVRational sample_aspect_ratio;
549 AVMetadata *metadata;
551 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
552 /* external applications; try to use something else if at all possible. */
553 const uint8_t *cur_ptr;
557 // Timestamp generation support:
559 * Timestamp corresponding to the last dts sync point.
561 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
562 * a DTS is received from the underlying container. Otherwise set to
563 * AV_NOPTS_VALUE by default.
565 int64_t reference_dts;
568 * Number of packets to buffer for codec probing
569 * NOT PART OF PUBLIC API
571 #define MAX_PROBE_PACKETS 2500
575 * last packet in packet_buffer for this stream when muxing.
576 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
578 struct AVPacketList *last_in_packet_buffer;
583 AVRational avg_frame_rate;
586 * Number of frames that have been demuxed during av_find_stream_info()
588 int codec_info_nb_frames;
591 #define AV_PROGRAM_RUNNING 1
594 * New fields can be added to the end with minor version bumps.
595 * Removal, reordering and changes to existing fields require a major
597 * sizeof(AVProgram) must not be used outside libav*.
599 typedef struct AVProgram {
601 #if LIBAVFORMAT_VERSION_INT < (53<<16)
602 char *provider_name; ///< network name for DVB streams
603 char *name; ///< service name for DVB streams
606 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
607 unsigned int *stream_index;
608 unsigned int nb_stream_indexes;
609 AVMetadata *metadata;
612 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
613 (streams are added dynamically) */
615 typedef struct AVChapter {
616 int id; ///< unique ID to identify the chapter
617 AVRational time_base; ///< time base in which the start/end timestamps are specified
618 int64_t start, end; ///< chapter start/end time in time_base units
619 #if LIBAVFORMAT_VERSION_INT < (53<<16)
620 char *title; ///< chapter title
622 AVMetadata *metadata;
625 #if LIBAVFORMAT_VERSION_MAJOR < 53
626 #define MAX_STREAMS 20
630 * Format I/O context.
631 * New fields can be added to the end with minor version bumps.
632 * Removal, reordering and changes to existing fields require a major
634 * sizeof(AVFormatContext) must not be used outside libav*.
636 typedef struct AVFormatContext {
637 const AVClass *av_class; /**< Set by avformat_alloc_context. */
638 /* Can only be iformat or oformat, not both at the same time. */
639 struct AVInputFormat *iformat;
640 struct AVOutputFormat *oformat;
643 unsigned int nb_streams;
644 AVStream *streams[MAX_STREAMS];
645 char filename[1024]; /**< input or output filename */
648 #if LIBAVFORMAT_VERSION_INT < (53<<16)
654 int year; /**< ID3 year, 0 if none */
655 int track; /**< track number, 0 if none */
656 char genre[32]; /**< ID3 genre */
659 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
660 /* private data for pts handling (do not modify directly). */
662 * This buffer is only needed when packets were already buffered but
663 * not decoded, for example to get the codec parameters in MPEG
666 struct AVPacketList *packet_buffer;
669 * Decoding: position of the first frame of the component, in
670 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
671 * It is deduced from the AVStream values.
676 * Decoding: duration of the stream, in AV_TIME_BASE fractional
677 * seconds. Only set this value if you know none of the individual stream
678 * durations and also dont set any of them. This is deduced from the
679 * AVStream values if not set.
684 * decoding: total file size, 0 if unknown
689 * Decoding: total stream bitrate in bit/s, 0 if not
690 * available. Never set it directly if the file_size and the
691 * duration are known as FFmpeg can compute it automatically.
695 /* av_read_frame() support */
697 #if LIBAVFORMAT_VERSION_INT < (53<<16)
698 const uint8_t *cur_ptr_deprecated;
699 int cur_len_deprecated;
700 AVPacket cur_pkt_deprecated;
703 /* av_seek_frame() support */
704 int64_t data_offset; /** offset of the first packet */
708 unsigned int packet_size;
712 #define AVFMT_NOOUTPUTLOOP -1
713 #define AVFMT_INFINITEOUTPUTLOOP 0
715 * number of times to loop output in formats that support it
720 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
721 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
722 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
723 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
724 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
725 #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
726 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Add RTP hinting to the output file
731 * decoding: size of data to probe; encoding: unused.
733 unsigned int probesize;
736 * Maximum time (in AV_TIME_BASE units) during which the input should
737 * be analyzed in av_find_stream_info().
739 int max_analyze_duration;
744 unsigned int nb_programs;
745 AVProgram **programs;
748 * Forced video codec_id.
749 * Demuxing: Set by user.
751 enum CodecID video_codec_id;
754 * Forced audio codec_id.
755 * Demuxing: Set by user.
757 enum CodecID audio_codec_id;
760 * Forced subtitle codec_id.
761 * Demuxing: Set by user.
763 enum CodecID subtitle_codec_id;
766 * Maximum amount of memory in bytes to use for the index of each stream.
767 * If the index exceeds this size, entries will be discarded as
768 * needed to maintain a smaller size. This can lead to slower or less
769 * accurate seeking (depends on demuxer).
770 * Demuxers for which a full in-memory index is mandatory will ignore
773 * demuxing: set by user
775 unsigned int max_index_size;
778 * Maximum amount of memory in bytes to use for buffering frames
779 * obtained from realtime capture devices.
781 unsigned int max_picture_buffer;
783 unsigned int nb_chapters;
784 AVChapter **chapters;
787 * Flags to enable debugging.
790 #define FF_FDEBUG_TS 0x0001
793 * Raw packets from the demuxer, prior to parsing and decoding.
794 * This buffer is used for buffering packets until the codec can
795 * be identified, as parsing cannot be done without knowing the
798 struct AVPacketList *raw_packet_buffer;
799 struct AVPacketList *raw_packet_buffer_end;
801 struct AVPacketList *packet_buffer_end;
803 AVMetadata *metadata;
806 * Remaining size available for raw_packet_buffer, in bytes.
807 * NOT PART OF PUBLIC API
809 #define RAW_PACKET_BUFFER_SIZE 2500000
810 int raw_packet_buffer_remaining_size;
813 * Start time of the stream in real world time, in microseconds
814 * since the unix epoch (00:00 1st January 1970). That is, pts=0
815 * in the stream was captured at this real world time.
816 * - encoding: Set by user.
817 * - decoding: Unused.
819 int64_t start_time_realtime;
822 typedef struct AVPacketList {
824 struct AVPacketList *next;
827 #if LIBAVFORMAT_VERSION_INT < (53<<16)
828 extern AVInputFormat *first_iformat;
829 extern AVOutputFormat *first_oformat;
833 * If f is NULL, returns the first registered input format,
834 * if f is non-NULL, returns the next registered input format after f
835 * or NULL if f is the last one.
837 AVInputFormat *av_iformat_next(AVInputFormat *f);
840 * If f is NULL, returns the first registered output format,
841 * if f is non-NULL, returns the next registered output format after f
842 * or NULL if f is the last one.
844 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
846 enum CodecID av_guess_image2_codec(const char *filename);
848 /* XXX: Use automatic init with either ELF sections or C file parser */
852 void av_register_input_format(AVInputFormat *format);
853 void av_register_output_format(AVOutputFormat *format);
854 #if LIBAVFORMAT_VERSION_MAJOR < 53
855 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
856 const char *filename,
857 const char *mime_type);
860 * @deprecated Use av_guess_format() instead.
862 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
863 const char *filename,
864 const char *mime_type);
868 * Return the output format in the list of registered output formats
869 * which best matches the provided parameters, or return NULL if
872 * @param short_name if non-NULL checks if short_name matches with the
873 * names of the registered formats
874 * @param filename if non-NULL checks if filename terminates with the
875 * extensions of the registered formats
876 * @param mime_type if non-NULL checks if mime_type matches with the
877 * MIME type of the registered formats
879 AVOutputFormat *av_guess_format(const char *short_name,
880 const char *filename,
881 const char *mime_type);
884 * Guess the codec ID based upon muxer and filename.
886 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
887 const char *filename, const char *mime_type,
888 enum AVMediaType type);
891 * Send a nice hexadecimal dump of a buffer to the specified file stream.
893 * @param f The file stream pointer where the dump should be sent to.
895 * @param size buffer size
897 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
899 void av_hex_dump(FILE *f, uint8_t *buf, int size);
902 * Send a nice hexadecimal dump of a buffer to the log.
904 * @param avcl A pointer to an arbitrary struct of which the first field is a
905 * pointer to an AVClass struct.
906 * @param level The importance level of the message, lower values signifying
909 * @param size buffer size
911 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
913 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
916 * Send a nice dump of a packet to the specified file stream.
918 * @param f The file stream pointer where the dump should be sent to.
919 * @param pkt packet to dump
920 * @param dump_payload True if the payload must be displayed, too.
922 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
925 * Send a nice dump of a packet to the log.
927 * @param avcl A pointer to an arbitrary struct of which the first field is a
928 * pointer to an AVClass struct.
929 * @param level The importance level of the message, lower values signifying
931 * @param pkt packet to dump
932 * @param dump_payload True if the payload must be displayed, too.
934 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
937 * Initialize libavformat and register all the muxers, demuxers and
938 * protocols. If you do not call this function, then you can select
939 * exactly which formats you want to support.
941 * @see av_register_input_format()
942 * @see av_register_output_format()
943 * @see av_register_protocol()
945 void av_register_all(void);
948 * Get the CodecID for the given codec tag tag.
949 * If no codec id is found returns CODEC_ID_NONE.
951 * @param tags list of supported codec_id-codec_tag pairs, as stored
952 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
954 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
957 * Get the codec tag for the given codec id id.
958 * If no codec tag is found returns 0.
960 * @param tags list of supported codec_id-codec_tag pairs, as stored
961 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
963 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
965 /* media file input */
968 * Find AVInputFormat based on the short name of the input format.
970 AVInputFormat *av_find_input_format(const char *short_name);
973 * Guess the file format.
975 * @param is_opened Whether the file is already opened; determines whether
976 * demuxers with or without AVFMT_NOFILE are probed.
978 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
981 * Guess the file format.
983 * @param is_opened Whether the file is already opened; determines whether
984 * demuxers with or without AVFMT_NOFILE are probed.
985 * @param score_max A probe score larger that this is required to accept a
986 * detection, the variable is set to the actual detection
988 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
989 * to retry with a larger probe buffer.
991 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
994 * Allocate all the structures needed to read an input stream.
995 * This does not open the needed codecs for decoding the stream[s].
997 int av_open_input_stream(AVFormatContext **ic_ptr,
998 ByteIOContext *pb, const char *filename,
999 AVInputFormat *fmt, AVFormatParameters *ap);
1002 * Open a media file as input. The codecs are not opened. Only the file
1003 * header (if present) is read.
1005 * @param ic_ptr The opened media file handle is put here.
1006 * @param filename filename to open
1007 * @param fmt If non-NULL, force the file format to use.
1008 * @param buf_size optional buffer size (zero if default is OK)
1009 * @param ap Additional parameters needed when opening the file
1010 * (NULL if default).
1011 * @return 0 if OK, AVERROR_xxx otherwise
1013 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1016 AVFormatParameters *ap);
1018 #if LIBAVFORMAT_VERSION_MAJOR < 53
1020 * @deprecated Use avformat_alloc_context() instead.
1022 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1026 * Allocate an AVFormatContext.
1027 * Can be freed with av_free() but do not forget to free everything you
1028 * explicitly allocated as well!
1030 AVFormatContext *avformat_alloc_context(void);
1033 * Read packets of a media file to get stream information. This
1034 * is useful for file formats with no headers such as MPEG. This
1035 * function also computes the real framerate in case of MPEG-2 repeat
1037 * The logical file position is not changed by this function;
1038 * examined packets may be buffered for later processing.
1040 * @param ic media file handle
1041 * @return >=0 if OK, AVERROR_xxx on error
1042 * @todo Let the user decide somehow what information is needed so that
1043 * we do not waste time getting stuff the user does not need.
1045 int av_find_stream_info(AVFormatContext *ic);
1048 * Read a transport packet from a media file.
1050 * This function is obsolete and should never be used.
1051 * Use av_read_frame() instead.
1053 * @param s media file handle
1054 * @param pkt is filled
1055 * @return 0 if OK, AVERROR_xxx on error
1057 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1060 * Return the next frame of a stream.
1062 * The returned packet is valid
1063 * until the next av_read_frame() or until av_close_input_file() and
1064 * must be freed with av_free_packet. For video, the packet contains
1065 * exactly one frame. For audio, it contains an integer number of
1066 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1067 * data). If the audio frames have a variable size (e.g. MPEG audio),
1068 * then it contains one frame.
1070 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1071 * values in AVStream.time_base units (and guessed if the format cannot
1072 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1073 * has B-frames, so it is better to rely on pkt->dts if you do not
1074 * decompress the payload.
1076 * @return 0 if OK, < 0 on error or end of file
1078 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1081 * Seek to the keyframe at timestamp.
1082 * 'timestamp' in 'stream_index'.
1083 * @param stream_index If stream_index is (-1), a default
1084 * stream is selected, and timestamp is automatically converted
1085 * from AV_TIME_BASE units to the stream specific time_base.
1086 * @param timestamp Timestamp in AVStream.time_base units
1087 * or, if no stream is specified, in AV_TIME_BASE units.
1088 * @param flags flags which select direction and seeking mode
1089 * @return >= 0 on success
1091 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1095 * Seek to timestamp ts.
1096 * Seeking will be done so that the point from which all active streams
1097 * can be presented successfully will be closest to ts and within min/max_ts.
1098 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1100 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1101 * are the file position (this may not be supported by all demuxers).
1102 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1103 * in the stream with stream_index (this may not be supported by all demuxers).
1104 * Otherwise all timestamps are in units of the stream selected by stream_index
1105 * or if stream_index is -1, in AV_TIME_BASE units.
1106 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1107 * keyframes (this may not be supported by all demuxers).
1109 * @param stream_index index of the stream which is used as time base reference
1110 * @param min_ts smallest acceptable timestamp
1111 * @param ts target timestamp
1112 * @param max_ts largest acceptable timestamp
1113 * @param flags flags
1114 * @return >=0 on success, error code otherwise
1116 * @note This is part of the new seek API which is still under construction.
1117 * Thus do not use this yet. It may change at any time, do not expect
1118 * ABI compatibility yet!
1120 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1123 * Start playing a network-based stream (e.g. RTSP stream) at the
1126 int av_read_play(AVFormatContext *s);
1129 * Pause a network-based stream (e.g. RTSP stream).
1131 * Use av_read_play() to resume it.
1133 int av_read_pause(AVFormatContext *s);
1136 * Free a AVFormatContext allocated by av_open_input_stream.
1137 * @param s context to free
1139 void av_close_input_stream(AVFormatContext *s);
1142 * Close a media file (but not its codecs).
1144 * @param s media file handle
1146 void av_close_input_file(AVFormatContext *s);
1149 * Add a new stream to a media file.
1151 * Can only be called in the read_header() function. If the flag
1152 * AVFMTCTX_NOHEADER is in the format context, then new streams
1153 * can be added in read_packet too.
1155 * @param s media file handle
1156 * @param id file-format-dependent stream ID
1158 AVStream *av_new_stream(AVFormatContext *s, int id);
1159 AVProgram *av_new_program(AVFormatContext *s, int id);
1162 * Add a new chapter.
1163 * This function is NOT part of the public API
1164 * and should ONLY be used by demuxers.
1166 * @param s media file handle
1167 * @param id unique ID for this chapter
1168 * @param start chapter start time in time_base units
1169 * @param end chapter end time in time_base units
1170 * @param title chapter title
1172 * @return AVChapter or NULL on error
1174 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1175 int64_t start, int64_t end, const char *title);
1178 * Set the pts for a given stream.
1181 * @param pts_wrap_bits number of bits effectively used by the pts
1182 * (used for wrap control, 33 is the value for MPEG)
1183 * @param pts_num numerator to convert to seconds (MPEG: 1)
1184 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1186 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1187 unsigned int pts_num, unsigned int pts_den);
1189 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1190 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1191 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1192 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1194 int av_find_default_stream_index(AVFormatContext *s);
1197 * Get the index for a specific timestamp.
1198 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1199 * to the timestamp which is <= the requested one, if backward
1200 * is 0, then it will be >=
1201 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1202 * @return < 0 if no such timestamp could be found
1204 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1207 * Ensure the index uses less memory than the maximum specified in
1208 * AVFormatContext.max_index_size by discarding entries if it grows
1210 * This function is not part of the public API and should only be called
1213 void ff_reduce_index(AVFormatContext *s, int stream_index);
1216 * Add an index entry into a sorted list. Update the entry if the list
1217 * already contains it.
1219 * @param timestamp timestamp in the time base of the given stream
1221 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1222 int size, int distance, int flags);
1225 * Perform a binary search using av_index_search_timestamp() and
1226 * AVInputFormat.read_timestamp().
1227 * This is not supposed to be called directly by a user application,
1229 * @param target_ts target timestamp in the time base of the given stream
1230 * @param stream_index stream number
1232 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1233 int64_t target_ts, int flags);
1236 * Update cur_dts of all streams based on the given timestamp and AVStream.
1238 * Stream ref_st unchanged, others set cur_dts in their native time base.
1239 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1240 * @param timestamp new dts expressed in time_base of param ref_st
1241 * @param ref_st reference stream giving time_base of param timestamp
1243 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1246 * Perform a binary search using read_timestamp().
1247 * This is not supposed to be called directly by a user application,
1249 * @param target_ts target timestamp in the time base of the given stream
1250 * @param stream_index stream number
1252 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1253 int64_t target_ts, int64_t pos_min,
1254 int64_t pos_max, int64_t pos_limit,
1255 int64_t ts_min, int64_t ts_max,
1256 int flags, int64_t *ts_ret,
1257 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1262 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1265 * Split a URL string into components.
1267 * The pointers to buffers for storing individual components may be null,
1268 * in order to ignore that component. Buffers for components not found are
1269 * set to empty strings. If the port is not found, it is set to a negative
1272 * @param proto the buffer for the protocol
1273 * @param proto_size the size of the proto buffer
1274 * @param authorization the buffer for the authorization
1275 * @param authorization_size the size of the authorization buffer
1276 * @param hostname the buffer for the host name
1277 * @param hostname_size the size of the hostname buffer
1278 * @param port_ptr a pointer to store the port number in
1279 * @param path the buffer for the path
1280 * @param path_size the size of the path buffer
1281 * @param url the URL to split
1283 void av_url_split(char *proto, int proto_size,
1284 char *authorization, int authorization_size,
1285 char *hostname, int hostname_size,
1287 char *path, int path_size,
1291 * Allocate the stream private data and write the stream header to an
1292 * output media file.
1294 * @param s media file handle
1295 * @return 0 if OK, AVERROR_xxx on error
1297 int av_write_header(AVFormatContext *s);
1300 * Write a packet to an output media file.
1302 * The packet shall contain one audio or video frame.
1303 * The packet must be correctly interleaved according to the container
1304 * specification, if not then av_interleaved_write_frame must be used.
1306 * @param s media file handle
1307 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1309 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1311 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1314 * Write a packet to an output media file ensuring correct interleaving.
1316 * The packet must contain one audio or video frame.
1317 * If the packets are already correctly interleaved, the application should
1318 * call av_write_frame() instead as it is slightly faster. It is also important
1319 * to keep in mind that completely non-interleaved input will need huge amounts
1320 * of memory to interleave with this, so it is preferable to interleave at the
1323 * @param s media file handle
1324 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1326 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1328 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1331 * Interleave a packet per dts in an output media file.
1333 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1334 * function, so they cannot be used after it. Note that calling av_free_packet()
1335 * on them is still safe.
1337 * @param s media file handle
1338 * @param out the interleaved packet will be output here
1339 * @param pkt the input packet
1340 * @param flush 1 if no further packets are available as input and all
1341 * remaining packets should be output
1342 * @return 1 if a packet was output, 0 if no packet could be output,
1343 * < 0 if an error occurred
1345 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1346 AVPacket *pkt, int flush);
1349 * Write the stream trailer to an output media file and free the
1350 * file private data.
1352 * May only be called after a successful call to av_write_header.
1354 * @param s media file handle
1355 * @return 0 if OK, AVERROR_xxx on error
1357 int av_write_trailer(AVFormatContext *s);
1359 void dump_format(AVFormatContext *ic,
1364 #if LIBAVFORMAT_VERSION_MAJOR < 53
1366 * Parse width and height out of string str.
1367 * @deprecated Use av_parse_video_frame_size instead.
1369 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1373 * Convert framerate from a string to a fraction.
1374 * @deprecated Use av_parse_video_frame_rate instead.
1376 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1381 * Parse datestr and return a corresponding number of microseconds.
1382 * @param datestr String representing a date or a duration.
1383 * - If a date the syntax is:
1385 * now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1387 * If the value is "now" it takes the current time.
1388 * Time is local time unless Z is appended, in which case it is
1389 * interpreted as UTC.
1390 * If the year-month-day part is not specified it takes the current
1392 * @return the number of microseconds since 1st of January, 1970 up to
1393 * the time of the parsed date or INT64_MIN if datestr cannot be
1394 * successfully parsed.
1395 * - If a duration the syntax is:
1397 * [-]HH[:MM[:SS[.m...]]]
1400 * @return the number of microseconds contained in a time interval
1401 * with the specified duration or INT64_MIN if datestr cannot be
1402 * successfully parsed.
1403 * @param duration Flag which tells how to interpret datestr, if
1404 * not zero datestr is interpreted as a duration, otherwise as a
1407 int64_t parse_date(const char *datestr, int duration);
1410 * Get the current time in microseconds.
1412 int64_t av_gettime(void);
1414 /* ffm-specific for ffserver */
1415 #define FFM_PACKET_SIZE 4096
1416 int64_t ffm_read_write_index(int fd);
1417 int ffm_write_write_index(int fd, int64_t pos);
1418 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1421 * Attempt to find a specific tag in a URL.
1423 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1424 * Return 1 if found.
1426 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1429 * Return in 'buf' the path with '%d' replaced by a number.
1431 * Also handles the '%0nd' format where 'n' is the total number
1432 * of digits and '%%'.
1434 * @param buf destination buffer
1435 * @param buf_size destination buffer size
1436 * @param path numbered sequence string
1437 * @param number frame number
1438 * @return 0 if OK, -1 on format error
1440 int av_get_frame_filename(char *buf, int buf_size,
1441 const char *path, int number);
1444 * Check whether filename actually is a numbered sequence generator.
1446 * @param filename possible numbered sequence string
1447 * @return 1 if a valid numbered sequence string, 0 otherwise
1449 int av_filename_number_test(const char *filename);
1452 * Generate an SDP for an RTP session.
1454 * @param ac array of AVFormatContexts describing the RTP streams. If the
1455 * array is composed by only one context, such context can contain
1456 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1457 * all the contexts in the array (an AVCodecContext per RTP stream)
1458 * must contain only one AVStream.
1459 * @param n_files number of AVCodecContexts contained in ac
1460 * @param buff buffer where the SDP will be stored (must be allocated by
1462 * @param size the size of the buffer
1463 * @return 0 if OK, AVERROR_xxx on error
1465 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1468 * Return a positive value if the given filename has one of the given
1469 * extensions, 0 otherwise.
1471 * @param extensions a comma-separated list of filename extensions
1473 int av_match_ext(const char *filename, const char *extensions);
1475 #endif /* AVFORMAT_AVFORMAT_H */