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 31
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 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 */
117 typedef struct AVPacket {
119 * Presentation timestamp in time_base units; the time at which the
120 * decompressed packet will be presented to the user.
121 * Can be AV_NOPTS_VALUE if it is not stored in the file.
122 * pts MUST be larger or equal to dts as presentation cannot happen before
123 * decompression, unless one wants to view hex dumps. Some formats misuse
124 * the terms dts and pts/cts to mean something different. Such timestamps
125 * must be converted to true pts/dts before they are stored in AVPacket.
129 * Decompression timestamp in time_base units; the time at which the
130 * packet is decompressed.
131 * Can be AV_NOPTS_VALUE if it is not stored in the file.
139 * Duration of this packet in time_base units, 0 if unknown.
140 * Equals next_pts - this_pts in presentation order.
143 void (*destruct)(struct AVPacket *);
145 int64_t pos; ///< byte position in stream, -1 if unknown
148 * Time difference in stream time base units from the pts of this
149 * packet to the point at which the output from the decoder has converged
150 * independent from the availability of previous frames. That is, the
151 * frames are virtually identical no matter if decoding started from
152 * the very first frame or from this keyframe.
153 * Is AV_NOPTS_VALUE if unknown.
154 * This field is not the display duration of the current packet.
156 * The purpose of this field is to allow seeking in streams that have no
157 * keyframes in the conventional sense. It corresponds to the
158 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
159 * essential for some types of subtitle streams to ensure that all
160 * subtitles are correctly displayed after seeking.
162 int64_t convergence_duration;
164 #define PKT_FLAG_KEY 0x0001
166 void av_destruct_packet_nofree(AVPacket *pkt);
169 * Default packet destructor.
171 void av_destruct_packet(AVPacket *pkt);
174 * Initialize optional fields of a packet with default values.
178 void av_init_packet(AVPacket *pkt);
181 * Allocate the payload of a packet and initialize its fields with
185 * @param size wanted payload size
186 * @return 0 if OK, AVERROR_xxx otherwise
188 int av_new_packet(AVPacket *pkt, int size);
191 * Allocate and read the payload of a packet and initialize its fields with
195 * @param size desired payload size
196 * @return >0 (read size) if OK, AVERROR_xxx otherwise
198 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
201 * @warning This is a hack - the packet memory allocation stuff is broken. The
202 * packet is allocated if it was not really allocated.
204 int av_dup_packet(AVPacket *pkt);
209 * @param pkt packet to free
211 static inline void av_free_packet(AVPacket *pkt)
213 if (pkt && pkt->destruct) {
218 /*************************************************/
219 /* fractional numbers for exact pts handling */
222 * The exact value of the fractional number is: 'val + num / den'.
223 * num is assumed to be 0 <= num < den.
225 typedef struct AVFrac {
226 int64_t val, num, den;
229 /*************************************************/
230 /* input/output formats */
234 /** This structure contains the data a format has to probe a file. */
235 typedef struct AVProbeData {
236 const char *filename;
241 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
242 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
244 typedef struct AVFormatParameters {
245 AVRational time_base;
250 enum PixelFormat pix_fmt;
251 int channel; /**< Used to select DV channel. */
252 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
253 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
254 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
255 stream packet (only meaningful if
256 mpeg2ts_raw is TRUE). */
257 unsigned int initial_pause:1; /**< Do not begin to play the stream
258 immediately (RTSP only). */
259 unsigned int prealloced_context:1;
260 #if LIBAVFORMAT_VERSION_INT < (53<<16)
261 enum CodecID video_codec_id;
262 enum CodecID audio_codec_id;
264 } AVFormatParameters;
266 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
267 #define AVFMT_NOFILE 0x0001
268 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
269 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
270 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
272 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
273 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
274 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
275 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
276 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
278 typedef struct AVOutputFormat {
281 * Descriptive name for the format, meant to be more human-readable
282 * than \p name. You \e should use the NULL_IF_CONFIG_SMALL() macro
285 const char *long_name;
286 const char *mime_type;
287 const char *extensions; /**< comma-separated filename extensions */
288 /** size of private data so that it can be allocated in the wrapper */
291 enum CodecID audio_codec; /**< default audio codec */
292 enum CodecID video_codec; /**< default video codec */
293 int (*write_header)(struct AVFormatContext *);
294 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
295 int (*write_trailer)(struct AVFormatContext *);
296 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
298 /** Currently only used to set pixel format if not YUV420P. */
299 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
300 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
301 AVPacket *in, int flush);
304 * List of supported codec_id-codec_tag pairs, ordered by "better
305 * choice first". The arrays are all terminated by CODEC_ID_NONE.
307 const struct AVCodecTag * const *codec_tag;
309 enum CodecID subtitle_codec; /**< default subtitle codec */
311 const AVMetadataConv *metadata_conv;
314 struct AVOutputFormat *next;
317 typedef struct AVInputFormat {
320 * Descriptive name for the format, meant to be more human-readable
321 * than \p name. You \e should use the NULL_IF_CONFIG_SMALL() macro
324 const char *long_name;
325 /** Size of private data so that it can be allocated in the wrapper. */
328 * Tell if a given file has a chance of being parsed as this format.
329 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
330 * big so you do not have to check for that unless you need more.
332 int (*read_probe)(AVProbeData *);
333 /** Read the format header and initialize the AVFormatContext
334 structure. Return 0 if OK. 'ap' if non-NULL contains
335 additional parameters. Only used in raw format right
336 now. 'av_new_stream' should be called to create new streams. */
337 int (*read_header)(struct AVFormatContext *,
338 AVFormatParameters *ap);
339 /** Read one packet and put it in 'pkt'. pts and flags are also
340 set. 'av_new_stream' can be called only if the flag
341 AVFMTCTX_NOHEADER is used. */
342 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
343 /** Close the stream. The AVFormatContext and AVStreams are not
344 freed by this function */
345 int (*read_close)(struct AVFormatContext *);
347 #if LIBAVFORMAT_VERSION_MAJOR < 53
349 * Seek to a given timestamp relative to the frames in
350 * stream component stream_index.
351 * @param stream_index Must not be -1.
352 * @param flags Selects which direction should be preferred if no exact
353 * match is available.
354 * @return >= 0 on success (but not necessarily the new offset)
356 int (*read_seek)(struct AVFormatContext *,
357 int stream_index, int64_t timestamp, int flags);
360 * Gets the next timestamp in stream[stream_index].time_base units.
361 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
363 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
364 int64_t *pos, int64_t pos_limit);
365 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
367 /** If extensions are defined, then no probe is done. You should
368 usually not use extension format guessing because it is not
370 const char *extensions;
371 /** General purpose read-only value that the format can use. */
374 /** Start/resume playing - only meaningful if using a network-based format
376 int (*read_play)(struct AVFormatContext *);
378 /** Pause playing - only meaningful if using a network-based format
380 int (*read_pause)(struct AVFormatContext *);
382 const struct AVCodecTag * const *codec_tag;
385 * Seek to timestamp ts.
386 * Seeking will be done so that the point from which all active streams
387 * can be presented successfully will be closest to ts and within min/max_ts.
388 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
390 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
392 const AVMetadataConv *metadata_conv;
395 struct AVInputFormat *next;
398 enum AVStreamParseType {
400 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
401 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
402 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
405 typedef struct AVIndexEntry {
408 #define AVINDEX_KEYFRAME 0x0001
410 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).
411 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
414 #define AV_DISPOSITION_DEFAULT 0x0001
415 #define AV_DISPOSITION_DUB 0x0002
416 #define AV_DISPOSITION_ORIGINAL 0x0004
417 #define AV_DISPOSITION_COMMENT 0x0008
418 #define AV_DISPOSITION_LYRICS 0x0010
419 #define AV_DISPOSITION_KARAOKE 0x0020
423 * New fields can be added to the end with minor version bumps.
424 * Removal, reordering and changes to existing fields require a major
426 * sizeof(AVStream) must not be used outside libav*.
428 typedef struct AVStream {
429 int index; /**< stream index in AVFormatContext */
430 int id; /**< format-specific stream ID */
431 AVCodecContext *codec; /**< codec context */
433 * Real base framerate of the stream.
434 * This is the lowest framerate with which all timestamps can be
435 * represented accurately (it is the least common multiple of all
436 * framerates in the stream). Note, this value is just a guess!
437 * For example, if the time base is 1/90000 and all frames have either
438 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
440 AVRational r_frame_rate;
443 /* internal data used in av_find_stream_info() */
445 /** encoding: pts generation when outputting stream */
449 * This is the fundamental unit of time (in seconds) in terms
450 * of which frame timestamps are represented. For fixed-fps content,
451 * time base should be 1/framerate and timestamp increments should be 1.
453 AVRational time_base;
454 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
455 /* ffmpeg.c private use */
456 int stream_copy; /**< If set, just copy stream. */
457 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
458 //FIXME move stuff to a flags field?
459 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
460 * MN: dunno if that is the right place for it */
463 * Decoding: pts of the first frame of the stream, in stream time base.
464 * Only set this if you are absolutely 100% sure that the value you set
465 * it to really is the pts of the first frame.
466 * This may be undefined (AV_NOPTS_VALUE).
467 * @note The ASF header does NOT contain a correct start_time the ASF
468 * demuxer must NOT set this.
472 * Decoding: duration of the stream, in stream time base.
473 * If a source file does not specify a duration, but does specify
474 * a bitrate, this value will be estimated from bitrate and file size.
478 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
480 /* av_read_frame() support */
481 enum AVStreamParseType need_parsing;
482 struct AVCodecParserContext *parser;
485 int last_IP_duration;
487 /* av_seek_frame() support */
488 AVIndexEntry *index_entries; /**< Only used if the format does not
489 support seeking natively. */
490 int nb_index_entries;
491 unsigned int index_entries_allocated_size;
493 int64_t nb_frames; ///< number of frames in this stream if known or 0
495 #if LIBAVFORMAT_VERSION_INT < (53<<16)
499 char *filename; /**< source filename of the stream */
501 int disposition; /**< AV_DISPOSITION_* bit field */
503 AVProbeData probe_data;
504 #define MAX_REORDER_DELAY 16
505 int64_t pts_buffer[MAX_REORDER_DELAY+1];
508 * sample aspect ratio (0 if unknown)
509 * - encoding: Set by user.
510 * - decoding: Set by libavformat.
512 AVRational sample_aspect_ratio;
514 AVMetadata *metadata;
516 /* av_read_frame() support */
517 const uint8_t *cur_ptr;
521 // Timestamp generation support:
523 * Timestamp corresponding to the last dts sync point.
525 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
526 * a DTS is received from the underlying container. Otherwise set to
527 * AV_NOPTS_VALUE by default.
529 int64_t reference_dts;
532 #define AV_PROGRAM_RUNNING 1
535 * New fields can be added to the end with minor version bumps.
536 * Removal, reordering and changes to existing fields require a major
538 * sizeof(AVProgram) must not be used outside libav*.
540 typedef struct AVProgram {
542 char *provider_name; ///< network name for DVB streams
543 char *name; ///< service name for DVB streams
545 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
546 unsigned int *stream_index;
547 unsigned int nb_stream_indexes;
548 AVMetadata *metadata;
551 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
552 (streams are added dynamically) */
554 typedef struct AVChapter {
555 int id; ///< unique ID to identify the chapter
556 AVRational time_base; ///< time base in which the start/end timestamps are specified
557 int64_t start, end; ///< chapter start/end time in time_base units
558 char *title; ///< chapter title
559 AVMetadata *metadata;
562 #define MAX_STREAMS 20
565 * Format I/O context.
566 * New fields can be added to the end with minor version bumps.
567 * Removal, reordering and changes to existing fields require a major
569 * sizeof(AVFormatContext) must not be used outside libav*.
571 typedef struct AVFormatContext {
572 const AVClass *av_class; /**< Set by avformat_alloc_context. */
573 /* Can only be iformat or oformat, not both at the same time. */
574 struct AVInputFormat *iformat;
575 struct AVOutputFormat *oformat;
578 unsigned int nb_streams;
579 AVStream *streams[MAX_STREAMS];
580 char filename[1024]; /**< input or output filename */
588 int year; /**< ID3 year, 0 if none */
589 int track; /**< track number, 0 if none */
590 char genre[32]; /**< ID3 genre */
592 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
593 /* private data for pts handling (do not modify directly). */
594 /** This buffer is only needed when packets were already buffered but
595 not decoded, for example to get the codec parameters in MPEG
597 struct AVPacketList *packet_buffer;
599 /** Decoding: position of the first frame of the component, in
600 AV_TIME_BASE fractional seconds. NEVER set this value directly:
601 It is deduced from the AVStream values. */
603 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
604 seconds. NEVER set this value directly: it is deduced from the
607 /** decoding: total file size, 0 if unknown */
609 /** Decoding: total stream bitrate in bit/s, 0 if not
610 available. Never set it directly if the file_size and the
611 duration are known as FFmpeg can compute it automatically. */
614 /* av_read_frame() support */
616 #if LIBAVFORMAT_VERSION_INT < (53<<16)
617 const uint8_t *cur_ptr_deprecated;
618 int cur_len_deprecated;
619 AVPacket cur_pkt_deprecated;
622 /* av_seek_frame() support */
623 int64_t data_offset; /** offset of the first packet */
631 #define AVFMT_NOOUTPUTLOOP -1
632 #define AVFMT_INFINITEOUTPUTLOOP 0
633 /** number of times to loop output in formats that support it */
637 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
638 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
639 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
642 /** decoding: size of data to probe; encoding: unused. */
643 unsigned int probesize;
646 * Maximum time (in AV_TIME_BASE units) during which the input should
647 * be analyzed in av_find_stream_info().
649 int max_analyze_duration;
654 unsigned int nb_programs;
655 AVProgram **programs;
658 * Forced video codec_id.
659 * Demuxing: Set by user.
661 enum CodecID video_codec_id;
663 * Forced audio codec_id.
664 * Demuxing: Set by user.
666 enum CodecID audio_codec_id;
668 * Forced subtitle codec_id.
669 * Demuxing: Set by user.
671 enum CodecID subtitle_codec_id;
674 * Maximum amount of memory in bytes to use for the index of each stream.
675 * If the index exceeds this size, entries will be discarded as
676 * needed to maintain a smaller size. This can lead to slower or less
677 * accurate seeking (depends on demuxer).
678 * Demuxers for which a full in-memory index is mandatory will ignore
681 * demuxing: set by user
683 unsigned int max_index_size;
686 * Maximum amount of memory in bytes to use for buffering frames
687 * obtained from realtime capture devices.
689 unsigned int max_picture_buffer;
691 unsigned int nb_chapters;
692 AVChapter **chapters;
695 * Flags to enable debugging.
698 #define FF_FDEBUG_TS 0x0001
701 * Raw packets from the demuxer, prior to parsing and decoding.
702 * This buffer is used for buffering packets until the codec can
703 * be identified, as parsing cannot be done without knowing the
706 struct AVPacketList *raw_packet_buffer;
707 struct AVPacketList *raw_packet_buffer_end;
709 struct AVPacketList *packet_buffer_end;
711 AVMetadata *metadata;
714 typedef struct AVPacketList {
716 struct AVPacketList *next;
719 #if LIBAVFORMAT_VERSION_INT < (53<<16)
720 extern AVInputFormat *first_iformat;
721 extern AVOutputFormat *first_oformat;
725 * If f is NULL, returns the first registered input format,
726 * if f is non-NULL, returns the next registered input format after f
727 * or NULL if f is the last one.
729 AVInputFormat *av_iformat_next(AVInputFormat *f);
732 * If f is NULL, returns the first registered output format,
733 * if f is non-NULL, returns the next registered output format after f
734 * or NULL if f is the last one.
736 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
738 enum CodecID av_guess_image2_codec(const char *filename);
740 /* XXX: Use automatic init with either ELF sections or C file parser */
744 void av_register_input_format(AVInputFormat *format);
745 void av_register_output_format(AVOutputFormat *format);
746 AVOutputFormat *guess_stream_format(const char *short_name,
747 const char *filename,
748 const char *mime_type);
749 AVOutputFormat *guess_format(const char *short_name,
750 const char *filename,
751 const char *mime_type);
754 * Guesses the codec ID based upon muxer and filename.
756 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
757 const char *filename, const char *mime_type,
758 enum CodecType type);
761 * Send a nice hexadecimal dump of a buffer to the specified file stream.
763 * @param f The file stream pointer where the dump should be sent to.
765 * @param size buffer size
767 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
769 void av_hex_dump(FILE *f, uint8_t *buf, int size);
772 * Send a nice hexadecimal dump of a buffer to the log.
774 * @param avcl A pointer to an arbitrary struct of which the first field is a
775 * pointer to an AVClass struct.
776 * @param level The importance level of the message, lower values signifying
779 * @param size buffer size
781 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
783 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
786 * Send a nice dump of a packet to the specified file stream.
788 * @param f The file stream pointer where the dump should be sent to.
789 * @param pkt packet to dump
790 * @param dump_payload True if the payload must be displayed, too.
792 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
795 * Send a nice dump of a packet to the log.
797 * @param avcl A pointer to an arbitrary struct of which the first field is a
798 * pointer to an AVClass struct.
799 * @param level The importance level of the message, lower values signifying
801 * @param pkt packet to dump
802 * @param dump_payload True if the payload must be displayed, too.
804 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
807 * Initialize libavformat and register all the muxers, demuxers and
808 * protocols. If you do not call this function, then you can select
809 * exactly which formats you want to support.
811 * @see av_register_input_format()
812 * @see av_register_output_format()
813 * @see av_register_protocol()
815 void av_register_all(void);
817 /** codec tag <-> codec id */
818 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
819 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
821 /* media file input */
824 * Finds AVInputFormat based on the short name of the input format.
826 AVInputFormat *av_find_input_format(const char *short_name);
831 * @param is_opened Whether the file is already opened; determines whether
832 * demuxers with or without AVFMT_NOFILE are probed.
834 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
837 * Allocates all the structures needed to read an input stream.
838 * This does not open the needed codecs for decoding the stream[s].
840 int av_open_input_stream(AVFormatContext **ic_ptr,
841 ByteIOContext *pb, const char *filename,
842 AVInputFormat *fmt, AVFormatParameters *ap);
845 * Open a media file as input. The codecs are not opened. Only the file
846 * header (if present) is read.
848 * @param ic_ptr The opened media file handle is put here.
849 * @param filename filename to open
850 * @param fmt If non-NULL, force the file format to use.
851 * @param buf_size optional buffer size (zero if default is OK)
852 * @param ap Additional parameters needed when opening the file
854 * @return 0 if OK, AVERROR_xxx otherwise
856 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
859 AVFormatParameters *ap);
861 #if LIBAVFORMAT_VERSION_MAJOR < 53
863 * @deprecated Use avformat_alloc_context() instead.
865 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
869 * Allocate an AVFormatContext.
870 * Can be freed with av_free() but do not forget to free everything you
871 * explicitly allocated as well!
873 AVFormatContext *avformat_alloc_context(void);
876 * Read packets of a media file to get stream information. This
877 * is useful for file formats with no headers such as MPEG. This
878 * function also computes the real framerate in case of MPEG-2 repeat
880 * The logical file position is not changed by this function;
881 * examined packets may be buffered for later processing.
883 * @param ic media file handle
884 * @return >=0 if OK, AVERROR_xxx on error
885 * @todo Let the user decide somehow what information is needed so that
886 * we do not waste time getting stuff the user does not need.
888 int av_find_stream_info(AVFormatContext *ic);
891 * Read a transport packet from a media file.
893 * This function is obsolete and should never be used.
894 * Use av_read_frame() instead.
896 * @param s media file handle
897 * @param pkt is filled
898 * @return 0 if OK, AVERROR_xxx on error
900 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
903 * Return the next frame of a stream.
905 * The returned packet is valid
906 * until the next av_read_frame() or until av_close_input_file() and
907 * must be freed with av_free_packet. For video, the packet contains
908 * exactly one frame. For audio, it contains an integer number of
909 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
910 * data). If the audio frames have a variable size (e.g. MPEG audio),
911 * then it contains one frame.
913 * pkt->pts, pkt->dts and pkt->duration are always set to correct
914 * values in AVStream.time_base units (and guessed if the format cannot
915 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
916 * has B-frames, so it is better to rely on pkt->dts if you do not
917 * decompress the payload.
919 * @return 0 if OK, < 0 on error or end of file
921 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
924 * Seek to the keyframe at timestamp.
925 * 'timestamp' in 'stream_index'.
926 * @param stream_index If stream_index is (-1), a default
927 * stream is selected, and timestamp is automatically converted
928 * from AV_TIME_BASE units to the stream specific time_base.
929 * @param timestamp Timestamp in AVStream.time_base units
930 * or, if no stream is specified, in AV_TIME_BASE units.
931 * @param flags flags which select direction and seeking mode
932 * @return >= 0 on success
934 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
938 * Seek to timestamp ts.
939 * Seeking will be done so that the point from which all active streams
940 * can be presented successfully will be closest to ts and within min/max_ts.
941 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
943 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
944 * are the file position (this may not be supported by all demuxers).
945 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
946 * in the stream with stream_index (this may not be supported by all demuxers).
947 * Otherwise all timestamps are in units of the stream selected by stream_index
948 * or if stream_index is -1, in AV_TIME_BASE units.
949 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
950 * keyframes (this may not be supported by all demuxers).
952 * @param stream_index index of the stream which is used as time base reference
953 * @param min_ts smallest acceptable timestamp
954 * @param ts target timestamp
955 * @param max_ts largest acceptable timestamp
957 * @returns >=0 on success, error code otherwise
959 * @NOTE This is part of the new seek API which is still under construction.
960 * Thus do not use this yet. It may change at any time, do not expect
961 * ABI compatibility yet!
963 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
966 * Start playing a network-based stream (e.g. RTSP stream) at the
969 int av_read_play(AVFormatContext *s);
972 * Pause a network-based stream (e.g. RTSP stream).
974 * Use av_read_play() to resume it.
976 int av_read_pause(AVFormatContext *s);
979 * Free a AVFormatContext allocated by av_open_input_stream.
980 * @param s context to free
982 void av_close_input_stream(AVFormatContext *s);
985 * Close a media file (but not its codecs).
987 * @param s media file handle
989 void av_close_input_file(AVFormatContext *s);
992 * Add a new stream to a media file.
994 * Can only be called in the read_header() function. If the flag
995 * AVFMTCTX_NOHEADER is in the format context, then new streams
996 * can be added in read_packet too.
998 * @param s media file handle
999 * @param id file-format-dependent stream ID
1001 AVStream *av_new_stream(AVFormatContext *s, int id);
1002 AVProgram *av_new_program(AVFormatContext *s, int id);
1005 * Add a new chapter.
1006 * This function is NOT part of the public API
1007 * and should ONLY be used by demuxers.
1009 * @param s media file handle
1010 * @param id unique ID for this chapter
1011 * @param start chapter start time in time_base units
1012 * @param end chapter end time in time_base units
1013 * @param title chapter title
1015 * @return AVChapter or NULL on error
1017 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1018 int64_t start, int64_t end, const char *title);
1021 * Set the pts for a given stream.
1024 * @param pts_wrap_bits number of bits effectively used by the pts
1025 * (used for wrap control, 33 is the value for MPEG)
1026 * @param pts_num numerator to convert to seconds (MPEG: 1)
1027 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1029 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1030 int pts_num, int pts_den);
1032 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1033 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1034 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1036 int av_find_default_stream_index(AVFormatContext *s);
1039 * Gets the index for a specific timestamp.
1040 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1041 * to the timestamp which is <= the requested one, if backward
1042 * is 0, then it will be >=
1043 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1044 * @return < 0 if no such timestamp could be found
1046 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1049 * Ensures the index uses less memory than the maximum specified in
1050 * AVFormatContext.max_index_size by discarding entries if it grows
1052 * This function is not part of the public API and should only be called
1055 void ff_reduce_index(AVFormatContext *s, int stream_index);
1058 * Add an index entry into a sorted list. Update the entry if the list
1059 * already contains it.
1061 * @param timestamp timestamp in the time base of the given stream
1063 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1064 int size, int distance, int flags);
1067 * Does a binary search using av_index_search_timestamp() and
1068 * AVCodec.read_timestamp().
1069 * This is not supposed to be called directly by a user application,
1071 * @param target_ts target timestamp in the time base of the given stream
1072 * @param stream_index stream number
1074 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1075 int64_t target_ts, int flags);
1078 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1080 * Stream ref_st unchanged, others set cur_dts in their native time base.
1081 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1082 * @param timestamp new dts expressed in time_base of param ref_st
1083 * @param ref_st reference stream giving time_base of param timestamp
1085 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1088 * Does a binary search using read_timestamp().
1089 * This is not supposed to be called directly by a user application,
1091 * @param target_ts target timestamp in the time base of the given stream
1092 * @param stream_index stream number
1094 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1095 int64_t target_ts, int64_t pos_min,
1096 int64_t pos_max, int64_t pos_limit,
1097 int64_t ts_min, int64_t ts_max,
1098 int flags, int64_t *ts_ret,
1099 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1101 /** media file output */
1102 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1105 * Allocate the stream private data and write the stream header to an
1106 * output media file.
1108 * @param s media file handle
1109 * @return 0 if OK, AVERROR_xxx on error
1111 int av_write_header(AVFormatContext *s);
1114 * Write a packet to an output media file.
1116 * The packet shall contain one audio or video frame.
1117 * The packet must be correctly interleaved according to the container
1118 * specification, if not then av_interleaved_write_frame must be used.
1120 * @param s media file handle
1121 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1123 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1125 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1128 * Writes a packet to an output media file ensuring correct interleaving.
1130 * The packet must contain one audio or video frame.
1131 * If the packets are already correctly interleaved, the application should
1132 * call av_write_frame() instead as it is slightly faster. It is also important
1133 * to keep in mind that completely non-interleaved input will need huge amounts
1134 * of memory to interleave with this, so it is preferable to interleave at the
1137 * @param s media file handle
1138 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1140 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1142 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1145 * Interleave a packet per dts in an output media file.
1147 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1148 * function, so they cannot be used after it. Note that calling av_free_packet()
1149 * on them is still safe.
1151 * @param s media file handle
1152 * @param out the interleaved packet will be output here
1153 * @param in the input packet
1154 * @param flush 1 if no further packets are available as input and all
1155 * remaining packets should be output
1156 * @return 1 if a packet was output, 0 if no packet could be output,
1157 * < 0 if an error occurred
1159 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1160 AVPacket *pkt, int flush);
1163 * @brief Write the stream trailer to an output media file and
1164 * free the file private data.
1166 * May only be called after a successful call to av_write_header.
1168 * @param s media file handle
1169 * @return 0 if OK, AVERROR_xxx on error
1171 int av_write_trailer(AVFormatContext *s);
1173 void dump_format(AVFormatContext *ic,
1178 #if LIBAVFORMAT_VERSION_MAJOR < 53
1180 * Parses width and height out of string str.
1181 * @deprecated Use av_parse_video_frame_size instead.
1183 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1187 * Converts framerate from a string to a fraction.
1188 * @deprecated Use av_parse_video_frame_rate instead.
1190 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1195 * Parses \p datestr and returns a corresponding number of microseconds.
1196 * @param datestr String representing a date or a duration.
1197 * - If a date the syntax is:
1199 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1201 * Time is local time unless Z is appended, in which case it is
1202 * interpreted as UTC.
1203 * If the year-month-day part is not specified it takes the current
1205 * Returns the number of microseconds since 1st of January, 1970 up to
1206 * the time of the parsed date or INT64_MIN if \p datestr cannot be
1207 * successfully parsed.
1208 * - If a duration the syntax is:
1210 * [-]HH[:MM[:SS[.m...]]]
1213 * Returns the number of microseconds contained in a time interval
1214 * with the specified duration or INT64_MIN if \p datestr cannot be
1215 * successfully parsed.
1216 * @param duration Flag which tells how to interpret \p datestr, if
1217 * not zero \p datestr is interpreted as a duration, otherwise as a
1220 int64_t parse_date(const char *datestr, int duration);
1222 /** Gets the current time in microseconds. */
1223 int64_t av_gettime(void);
1225 /* ffm-specific for ffserver */
1226 #define FFM_PACKET_SIZE 4096
1227 int64_t ffm_read_write_index(int fd);
1228 int ffm_write_write_index(int fd, int64_t pos);
1229 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1232 * Attempts to find a specific tag in a URL.
1234 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1235 * Return 1 if found.
1237 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1240 * Returns in 'buf' the path with '%d' replaced by a number.
1242 * Also handles the '%0nd' format where 'n' is the total number
1243 * of digits and '%%'.
1245 * @param buf destination buffer
1246 * @param buf_size destination buffer size
1247 * @param path numbered sequence string
1248 * @param number frame number
1249 * @return 0 if OK, -1 on format error
1251 int av_get_frame_filename(char *buf, int buf_size,
1252 const char *path, int number);
1255 * Check whether filename actually is a numbered sequence generator.
1257 * @param filename possible numbered sequence string
1258 * @return 1 if a valid numbered sequence string, 0 otherwise
1260 int av_filename_number_test(const char *filename);
1263 * Generate an SDP for an RTP session.
1265 * @param ac array of AVFormatContexts describing the RTP streams. If the
1266 * array is composed by only one context, such context can contain
1267 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1268 * all the contexts in the array (an AVCodecContext per RTP stream)
1269 * must contain only one AVStream.
1270 * @param n_files number of AVCodecContexts contained in ac
1271 * @param buff buffer where the SDP will be stored (must be allocated by
1273 * @param size the size of the buffer
1274 * @return 0 if OK, AVERROR_xxx on error
1276 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1278 #ifdef HAVE_AV_CONFIG_H
1280 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1283 #define dynarray_add(tab, nb_ptr, elem)\
1285 __typeof__(tab) _tab = (tab);\
1286 __typeof__(elem) _elem = (elem);\
1287 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1288 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1291 #define dynarray_add(tab, nb_ptr, elem)\
1293 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1297 time_t mktimegm(struct tm *tm);
1298 struct tm *brktimegm(time_t secs, struct tm *tm);
1299 const char *small_strptime(const char *p, const char *fmt,
1303 int resolve_host(struct in_addr *sin_addr, const char *hostname);
1305 void url_split(char *proto, int proto_size,
1306 char *authorization, int authorization_size,
1307 char *hostname, int hostname_size,
1309 char *path, int path_size,
1312 int match_ext(const char *filename, const char *extensions);
1314 #endif /* HAVE_AV_CONFIG_H */
1316 #endif /* AVFORMAT_AVFORMAT_H */