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 21
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 /* packet functions */
51 typedef struct AVPacket {
53 * Presentation time stamp in time_base units.
54 * This is the time at which the decompressed packet will be presented
56 * Can be AV_NOPTS_VALUE if it is not stored in the file.
57 * pts MUST be larger or equal to dts as presentation can not happen before
58 * decompression, unless one wants to view hex dumps. Some formats misuse
59 * the terms dts and pts/cts to mean something different, these timestamps
60 * must be converted to true pts/dts before they are stored in AVPacket.
64 * Decompression time stamp in time_base units.
65 * This is the time at which the packet is decompressed.
66 * Can be AV_NOPTS_VALUE if it is not stored in the file.
73 int duration; ///< presentation duration in time_base units (0 if not available)
74 void (*destruct)(struct AVPacket *);
76 int64_t pos; ///< byte position in stream, -1 if unknown
78 #define PKT_FLAG_KEY 0x0001
80 void av_destruct_packet_nofree(AVPacket *pkt);
83 * Default packet destructor.
85 void av_destruct_packet(AVPacket *pkt);
88 * Initialize optional fields of a packet to default values.
92 void av_init_packet(AVPacket *pkt);
95 * Allocate the payload of a packet and initialize its fields to default values.
98 * @param size wanted payload size
99 * @return 0 if OK. AVERROR_xxx otherwise.
101 int av_new_packet(AVPacket *pkt, int size);
104 * Allocate and read the payload of a packet and initialize its fields to default values.
107 * @param size wanted payload size
108 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
110 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
113 * @warning This is a hack - the packet memory allocation stuff is broken. The
114 * packet is allocated if it was not really allocated
116 int av_dup_packet(AVPacket *pkt);
121 * @param pkt packet to free
123 static inline void av_free_packet(AVPacket *pkt)
125 if (pkt && pkt->destruct) {
130 /*************************************************/
131 /* fractional numbers for exact pts handling */
134 * the exact value of the fractional number is: 'val + num / den'.
135 * num is assumed to be such as 0 <= num < den
136 * @deprecated Use AVRational instead
138 typedef struct AVFrac {
139 int64_t val, num, den;
140 } AVFrac attribute_deprecated;
142 /*************************************************/
143 /* input/output formats */
147 struct AVFormatContext;
149 /** this structure contains the data a format has to probe a file */
150 typedef struct AVProbeData {
151 const char *filename;
156 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
157 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
159 typedef struct AVFormatParameters {
160 AVRational time_base;
165 enum PixelFormat pix_fmt;
166 int channel; /**< used to select dv channel */
167 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
168 unsigned int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
169 unsigned int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
170 stream packet (only meaningful if
171 mpeg2ts_raw is TRUE) */
172 unsigned int initial_pause:1; /**< do not begin to play the stream
173 immediately (RTSP only) */
174 unsigned int prealloced_context:1;
175 #if LIBAVFORMAT_VERSION_INT < (53<<16)
176 enum CodecID video_codec_id;
177 enum CodecID audio_codec_id;
179 } AVFormatParameters;
181 //! demuxer will use url_fopen, no opened file should be provided by the caller
182 #define AVFMT_NOFILE 0x0001
183 #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
184 #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
185 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
187 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
188 #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
189 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
190 #define AVFMT_TS_DISCONT 0x0200 /**< format allows timestamo discontinuities */
192 typedef struct AVOutputFormat {
195 * Descriptive name for the format, meant to be more human-readable
196 * than \p name. You \e should use the NULL_IF_CONFIG_SMALL() macro
199 const char *long_name;
200 const char *mime_type;
201 const char *extensions; /**< comma separated filename extensions */
202 /** size of private data so that it can be allocated in the wrapper */
205 enum CodecID audio_codec; /**< default audio codec */
206 enum CodecID video_codec; /**< default video codec */
207 int (*write_header)(struct AVFormatContext *);
208 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
209 int (*write_trailer)(struct AVFormatContext *);
210 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
212 /** currently only used to set pixel format if not YUV420P */
213 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
214 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
217 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
218 * the arrays are all CODEC_ID_NONE terminated
220 const struct AVCodecTag * const *codec_tag;
222 enum CodecID subtitle_codec; /**< default subtitle codec */
225 struct AVOutputFormat *next;
228 typedef struct AVInputFormat {
231 * Descriptive name for the format, meant to be more human-readable
232 * than \p name. You \e 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 by 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 paramters. 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 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
254 /** close the stream. The AVFormatContext and AVStreams are not
255 freed by this function */
256 int (*read_close)(struct AVFormatContext *);
258 * seek to a given timestamp relative to the frames in
259 * stream component stream_index
260 * @param stream_index must not be -1
261 * @param flags selects which direction should be preferred if no exact
263 * @return >= 0 on success (but not necessarily the new offset)
265 int (*read_seek)(struct AVFormatContext *,
266 int stream_index, int64_t timestamp, int flags);
268 * gets the next timestamp in stream[stream_index].time_base units.
269 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
271 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
272 int64_t *pos, int64_t pos_limit);
273 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
275 /** if extensions are defined, then no probe is done. You should
276 usually not use extension format guessing because it is not
278 const char *extensions;
279 /** general purpose read only value that the format can use */
282 /** start/resume playing - only meaningful if using a network based format
284 int (*read_play)(struct AVFormatContext *);
286 /** pause playing - only meaningful if using a network based format
288 int (*read_pause)(struct AVFormatContext *);
290 const struct AVCodecTag * const *codec_tag;
293 struct AVInputFormat *next;
296 enum AVStreamParseType {
298 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
299 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
300 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
303 typedef struct AVIndexEntry {
306 #define AVINDEX_KEYFRAME 0x0001
308 int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
309 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
312 #define AV_DISPOSITION_DEFAULT 0x0001
313 #define AV_DISPOSITION_DUB 0x0002
314 #define AV_DISPOSITION_ORIGINAL 0x0004
315 #define AV_DISPOSITION_COMMENT 0x0008
316 #define AV_DISPOSITION_LYRICS 0x0010
317 #define AV_DISPOSITION_KARAOKE 0x0020
321 * New fields can be added to the end with minor version bumps.
322 * Removal, reordering and changes to existing fields require a major
324 * sizeof(AVStream) must not be used outside libav*.
326 typedef struct AVStream {
327 int index; /**< stream index in AVFormatContext */
328 int id; /**< format specific stream id */
329 AVCodecContext *codec; /**< codec context */
331 * Real base frame rate of the stream.
332 * This is the lowest frame rate with which all timestamps can be
333 * represented accurately (it is the least common multiple of all
334 * frame rates in the stream), Note, this value is just a guess!
335 * For example if the timebase is 1/90000 and all frames have either
336 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
338 AVRational r_frame_rate;
341 /* internal data used in av_find_stream_info() */
343 /** encoding: PTS generation when outputing stream */
347 * This is the fundamental unit of time (in seconds) in terms
348 * of which frame timestamps are represented. For fixed-fps content,
349 * timebase should be 1/frame rate and timestamp increments should be
352 AVRational time_base;
353 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
354 /* ffmpeg.c private use */
355 int stream_copy; /**< if set, just copy stream */
356 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
357 //FIXME move stuff to a flags field?
358 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
359 * MN: dunno if that is the right place for it */
362 * Decoding: pts of the first frame of the stream, in stream time base.
363 * Only set this if you are absolutely 100% sure that the value you set
364 * it to really is the pts of the first frame.
365 * This may be undefined (AV_NOPTS_VALUE).
366 * @note The ASF header does NOT contain a correct start_time the ASF
367 * demuxer must NOT set this.
371 * Decoding: duration of the stream, in stream time base.
372 * If a source file does not specify a duration, but does specify
373 * a bitrate, this value will be estimates from bit rate and file size.
377 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
379 /* av_read_frame() support */
380 enum AVStreamParseType need_parsing;
381 struct AVCodecParserContext *parser;
384 int last_IP_duration;
386 /* av_seek_frame() support */
387 AVIndexEntry *index_entries; /**< only used if the format does not
388 support seeking natively */
389 int nb_index_entries;
390 unsigned int index_entries_allocated_size;
392 int64_t nb_frames; ///< number of frames in this stream if known or 0
394 #if LIBAVFORMAT_VERSION_INT < (53<<16)
398 char *filename; /**< source filename of the stream */
400 int disposition; /**< AV_DISPOSITION_* bitfield */
402 AVProbeData probe_data;
403 #define MAX_REORDER_DELAY 16
404 int64_t pts_buffer[MAX_REORDER_DELAY+1];
407 * sample aspect ratio (0 if unknown)
408 * - encoding: Set by user.
409 * - decoding: Set by libavformat.
411 AVRational sample_aspect_ratio;
414 #define AV_PROGRAM_RUNNING 1
417 * New fields can be added to the end with minor version bumps.
418 * Removal, reordering and changes to existing fields require a major
420 * sizeof(AVProgram) must not be used outside libav*.
422 typedef struct AVProgram {
424 char *provider_name; ///< Network name for DVB streams
425 char *name; ///< Service name for DVB streams
427 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
428 unsigned int *stream_index;
429 unsigned int nb_stream_indexes;
432 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
433 (streams are added dynamically) */
435 typedef struct AVChapter {
436 int id; ///< Unique id to identify the chapter
437 AVRational time_base; ///< Timebase in which the start/end timestamps are specified
438 int64_t start, end; ///< chapter start/end time in time_base units
439 char *title; ///< chapter title
442 #define MAX_STREAMS 20
445 * format I/O context.
446 * New fields can be added to the end with minor version bumps.
447 * Removal, reordering and changes to existing fields require a major
449 * sizeof(AVFormatContext) must not be used outside libav*.
451 typedef struct AVFormatContext {
452 const AVClass *av_class; /**< set by av_alloc_format_context */
453 /* can only be iformat or oformat, not both at the same time */
454 struct AVInputFormat *iformat;
455 struct AVOutputFormat *oformat;
458 unsigned int nb_streams;
459 AVStream *streams[MAX_STREAMS];
460 char filename[1024]; /**< input or output filename */
468 int year; /**< ID3 year, 0 if none */
469 int track; /**< track number, 0 if none */
470 char genre[32]; /**< ID3 genre */
472 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
473 /* private data for pts handling (do not modify directly) */
474 /** This buffer is only needed when packets were already buffered but
475 not decoded, for example to get the codec parameters in mpeg
477 struct AVPacketList *packet_buffer;
479 /** decoding: position of the first frame of the component, in
480 AV_TIME_BASE fractional seconds. NEVER set this value directly:
481 it is deduced from the AVStream values. */
483 /** decoding: duration of the stream, in AV_TIME_BASE fractional
484 seconds. NEVER set this value directly: it is deduced from the
487 /** decoding: total file size. 0 if unknown */
489 /** decoding: total stream bitrate in bit/s, 0 if not
490 available. Never set it directly if the file_size and the
491 duration are known as ffmpeg can compute it automatically. */
494 /* av_read_frame() support */
496 const uint8_t *cur_ptr;
500 /* av_seek_frame() support */
501 int64_t data_offset; /** offset of the first packet */
509 #define AVFMT_NOOUTPUTLOOP -1
510 #define AVFMT_INFINITEOUTPUTLOOP 0
511 /** number of times to loop output in formats that support it */
515 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
516 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
517 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
520 /** decoding: size of data to probe; encoding unused */
521 unsigned int probesize;
524 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
526 int max_analyze_duration;
531 unsigned int nb_programs;
532 AVProgram **programs;
535 * Forced video codec_id.
536 * demuxing: set by user
538 enum CodecID video_codec_id;
540 * Forced audio codec_id.
541 * demuxing: set by user
543 enum CodecID audio_codec_id;
545 * Forced subtitle codec_id.
546 * demuxing: set by user
548 enum CodecID subtitle_codec_id;
551 * Maximum amount of memory in bytes to use per stream for the index.
552 * If the needed index exceeds this size entries will be discarded as
553 * needed to maintain a smaller size. This can lead to slower or less
554 * accurate seeking (depends on demuxer).
555 * Demuxers for which a full in memory index is mandatory will ignore
558 * demuxing: set by user
560 unsigned int max_index_size;
563 * Maximum amount of memory in bytes to use for buffering frames
564 * obtained from real-time capture devices.
566 unsigned int max_picture_buffer;
568 unsigned int nb_chapters;
569 AVChapter **chapters;
572 * Flags to enable debuging.
575 #define FF_FDEBUG_TS 0x0001
578 * raw packets from the demuxer, prior to parsing and decoding.
579 * This buffer is used for buffering packets until the codec can
580 * be identified, as parsing cannot be done without knowing the
583 struct AVPacketList *raw_packet_buffer;
584 struct AVPacketList *raw_packet_buffer_end;
586 struct AVPacketList *packet_buffer_end;
589 typedef struct AVPacketList {
591 struct AVPacketList *next;
594 #if LIBAVFORMAT_VERSION_INT < (53<<16)
595 extern AVInputFormat *first_iformat;
596 extern AVOutputFormat *first_oformat;
599 AVInputFormat *av_iformat_next(AVInputFormat *f);
600 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
602 enum CodecID av_guess_image2_codec(const char *filename);
604 /* XXX: use automatic init with either ELF sections or C file parser */
608 void av_register_input_format(AVInputFormat *format);
609 void av_register_output_format(AVOutputFormat *format);
610 AVOutputFormat *guess_stream_format(const char *short_name,
611 const char *filename, const char *mime_type);
612 AVOutputFormat *guess_format(const char *short_name,
613 const char *filename, const char *mime_type);
616 * Guesses the codec id based upon muxer and filename.
618 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
619 const char *filename, const char *mime_type, enum CodecType type);
622 * Send a nice hexadecimal dump of a buffer to the specified file stream.
624 * @param f The file stream pointer where the dump should be sent to.
626 * @param size buffer size
628 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
630 void av_hex_dump(FILE *f, uint8_t *buf, int size);
633 * Send a nice hexadecimal dump of a buffer to the log.
635 * @param avcl A pointer to an arbitrary struct of which the first field is a
636 * pointer to an AVClass struct.
637 * @param level The importance level of the message, lower values signifying
640 * @param size buffer size
642 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
644 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
647 * Send a nice dump of a packet to the specified file stream.
649 * @param f The file stream pointer where the dump should be sent to.
650 * @param pkt packet to dump
651 * @param dump_payload true if the payload must be displayed too
653 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
656 * Send a nice dump of a packet to the log.
658 * @param avcl A pointer to an arbitrary struct of which the first field is a
659 * pointer to an AVClass struct.
660 * @param level The importance level of the message, lower values signifying
662 * @param pkt packet to dump
663 * @param dump_payload true if the payload must be displayed too
665 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
667 void av_register_all(void);
669 /** codec tag <-> codec id */
670 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
671 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
673 /* media file input */
676 * finds AVInputFormat based on input format's short name.
678 AVInputFormat *av_find_input_format(const char *short_name);
683 * @param is_opened whether the file is already opened, determines whether
684 * demuxers with or without AVFMT_NOFILE are probed
686 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
689 * Allocates all the structures needed to read an input stream.
690 * This does not open the needed codecs for decoding the stream[s].
692 int av_open_input_stream(AVFormatContext **ic_ptr,
693 ByteIOContext *pb, const char *filename,
694 AVInputFormat *fmt, AVFormatParameters *ap);
697 * Open a media file as input. The codecs are not opened. Only the file
698 * header (if present) is read.
700 * @param ic_ptr the opened media file handle is put here
701 * @param filename filename to open.
702 * @param fmt if non NULL, force the file format to use
703 * @param buf_size optional buffer size (zero if default is OK)
704 * @param ap additional parameters needed when opening the file (NULL if default)
705 * @return 0 if OK. AVERROR_xxx otherwise.
707 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
710 AVFormatParameters *ap);
712 * Allocate an AVFormatContext.
713 * Can be freed with av_free() but do not forget to free everything you
714 * explicitly allocated as well!
716 AVFormatContext *av_alloc_format_context(void);
719 * Read packets of a media file to get stream information. This
720 * is useful for file formats with no headers such as MPEG. This
721 * function also computes the real frame rate in case of mpeg2 repeat
723 * The logical file position is not changed by this function;
724 * examined packets may be buffered for later processing.
726 * @param ic media file handle
727 * @return >=0 if OK. AVERROR_xxx if error.
728 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
730 int av_find_stream_info(AVFormatContext *ic);
733 * Read a transport packet from a media file.
735 * This function is obsolete and should never be used.
736 * Use av_read_frame() instead.
738 * @param s media file handle
739 * @param pkt is filled
740 * @return 0 if OK. AVERROR_xxx if error.
742 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
745 * Return the next frame of a stream.
747 * The returned packet is valid
748 * until the next av_read_frame() or until av_close_input_file() and
749 * must be freed with av_free_packet. For video, the packet contains
750 * exactly one frame. For audio, it contains an integer number of
751 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
752 * data). If the audio frames have a variable size (e.g. MPEG audio),
753 * then it contains one frame.
755 * pkt->pts, pkt->dts and pkt->duration are always set to correct
756 * values in AVStream.timebase units (and guessed if the format cannot
757 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
758 * has B frames, so it is better to rely on pkt->dts if you do not
759 * decompress the payload.
761 * @return 0 if OK, < 0 if error or end of file.
763 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
766 * Seek to the key frame at timestamp.
767 * 'timestamp' in 'stream_index'.
768 * @param stream_index If stream_index is (-1), a default
769 * stream is selected, and timestamp is automatically converted
770 * from AV_TIME_BASE units to the stream specific time_base.
771 * @param timestamp timestamp in AVStream.time_base units
772 * or if there is no stream specified then in AV_TIME_BASE units
773 * @param flags flags which select direction and seeking mode
774 * @return >= 0 on success
776 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
779 * start playing a network based stream (e.g. RTSP stream) at the
782 int av_read_play(AVFormatContext *s);
785 * Pause a network based stream (e.g. RTSP stream).
787 * Use av_read_play() to resume it.
789 int av_read_pause(AVFormatContext *s);
792 * Free a AVFormatContext allocated by av_open_input_stream.
793 * @param s context to free
795 void av_close_input_stream(AVFormatContext *s);
798 * Close a media file (but not its codecs).
800 * @param s media file handle
802 void av_close_input_file(AVFormatContext *s);
805 * Add a new stream to a media file.
807 * Can only be called in the read_header() function. If the flag
808 * AVFMTCTX_NOHEADER is in the format context, then new streams
809 * can be added in read_packet too.
811 * @param s media file handle
812 * @param id file format dependent stream id
814 AVStream *av_new_stream(AVFormatContext *s, int id);
815 AVProgram *av_new_program(AVFormatContext *s, int id);
819 * This function is NOT part of the public API
820 * and should be ONLY used by demuxers.
822 * @param s media file handle
823 * @param id unique id for this chapter
824 * @param start chapter start time in time_base units
825 * @param end chapter end time in time_base units
826 * @param title chapter title
828 * @return AVChapter or NULL if error.
830 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base, int64_t start, int64_t end, const char *title);
833 * Set the pts for a given stream.
836 * @param pts_wrap_bits number of bits effectively used by the pts
837 * (used for wrap control, 33 is the value for MPEG)
838 * @param pts_num numerator to convert to seconds (MPEG: 1)
839 * @param pts_den denominator to convert to seconds (MPEG: 90000)
841 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
842 int pts_num, int pts_den);
844 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
845 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
846 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
848 int av_find_default_stream_index(AVFormatContext *s);
851 * Gets the index for a specific timestamp.
852 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
853 * the timestamp which is <= the requested one, if backward is 0
855 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
856 * @return < 0 if no such timestamp could be found
858 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
861 * Ensures the index uses less memory than the maximum specified in
862 * AVFormatContext.max_index_size, by discarding entries if it grows
864 * This function is not part of the public API and should only be called
867 void ff_reduce_index(AVFormatContext *s, int stream_index);
870 * Add a index entry into a sorted list updateing if it is already there.
872 * @param timestamp timestamp in the timebase of the given stream
874 int av_add_index_entry(AVStream *st,
875 int64_t pos, int64_t timestamp, int size, int distance, int flags);
878 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
879 * This is not supposed to be called directly by a user application, but by demuxers.
880 * @param target_ts target timestamp in the time base of the given stream
881 * @param stream_index stream number
883 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
886 * Updates cur_dts of all streams based on given timestamp and AVStream.
888 * Stream ref_st unchanged, others set cur_dts in their native timebase
889 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
890 * @param timestamp new dts expressed in time_base of param ref_st
891 * @param ref_st reference stream giving time_base of param timestamp
893 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
896 * Does a binary search using read_timestamp().
897 * This is not supposed to be called directly by a user application, but by demuxers.
898 * @param target_ts target timestamp in the time base of the given stream
899 * @param stream_index stream number
901 int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
903 /** media file output */
904 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
907 * Allocate the stream private data and write the stream header to an
910 * @param s media file handle
911 * @return 0 if OK. AVERROR_xxx if error.
913 int av_write_header(AVFormatContext *s);
916 * Write a packet to an output media file.
918 * The packet shall contain one audio or video frame.
919 * The packet must be correctly interleaved according to the container specification,
920 * if not then av_interleaved_write_frame must be used
922 * @param s media file handle
923 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
924 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
926 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
929 * Writes a packet to an output media file ensuring correct interleaving.
931 * The packet must contain one audio or video frame.
932 * If the packets are already correctly interleaved the application should
933 * call av_write_frame() instead as it is slightly faster. It is also important
934 * to keep in mind that completely non-interleaved input will need huge amounts
935 * of memory to interleave with this, so it is preferable to interleave at the
938 * @param s media file handle
939 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
940 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
942 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
945 * Interleave a packet per DTS in an output media file.
947 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
948 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
950 * @param s media file handle
951 * @param out the interleaved packet will be output here
952 * @param in the input packet
953 * @param flush 1 if no further packets are available as input and all
954 * remaining packets should be output
955 * @return 1 if a packet was output, 0 if no packet could be output,
956 * < 0 if an error occurred
958 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
961 * @brief Write the stream trailer to an output media file and
962 * free the file private data.
964 * @param s media file handle
965 * @return 0 if OK. AVERROR_xxx if error.
967 int av_write_trailer(AVFormatContext *s);
969 void dump_format(AVFormatContext *ic,
975 * parses width and height out of string str.
976 * @deprecated Use av_parse_video_frame_size instead.
978 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
981 * Converts frame rate from string to a fraction.
982 * @deprecated Use av_parse_video_frame_rate instead.
984 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
987 * Parses \p datestr and returns a corresponding number of microseconds.
988 * @param datestr String representing a date or a duration.
989 * - If a date the syntax is:
991 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
993 * Time is localtime unless Z is appended, in which case it is
994 * interpreted as UTC.
995 * If the year-month-day part isn't specified it takes the current
997 * Returns the number of microseconds since 1st of January, 1970 up to
998 * the time of the parsed date or INT64_MIN if \p datestr cannot be
999 * successfully parsed.
1000 * - If a duration the syntax is:
1002 * [-]HH[:MM[:SS[.m...]]]
1005 * Returns the number of microseconds contained in a time interval
1006 * with the specified duration or INT64_MIN if \p datestr cannot be
1007 * successfully parsed.
1008 * @param duration Flag which tells how to interpret \p datestr, if
1009 * not zero \p datestr is interpreted as a duration, otherwise as a
1012 int64_t parse_date(const char *datestr, int duration);
1014 int64_t av_gettime(void);
1016 /* ffm specific for ffserver */
1017 #define FFM_PACKET_SIZE 4096
1018 offset_t ffm_read_write_index(int fd);
1019 void ffm_write_write_index(int fd, offset_t pos);
1020 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
1023 * Attempts to find a specific tag in a URL.
1025 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1026 * Return 1 if found.
1028 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1031 * Returns in 'buf' the path with '%d' replaced by number.
1033 * Also handles the '%0nd' format where 'n' is the total number
1034 * of digits and '%%'.
1036 * @param buf destination buffer
1037 * @param buf_size destination buffer size
1038 * @param path numbered sequence string
1039 * @param number frame number
1040 * @return 0 if OK, -1 if format error.
1042 int av_get_frame_filename(char *buf, int buf_size,
1043 const char *path, int number);
1046 * Check whether filename actually is a numbered sequence generator.
1048 * @param filename possible numbered sequence string
1049 * @return 1 if a valid numbered sequence string, 0 otherwise.
1051 int av_filename_number_test(const char *filename);
1054 * Generate an SDP for an RTP session.
1056 * @param ac array of AVFormatContexts describing the RTP streams. If the
1057 * array is composed by only one context, such context can contain
1058 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1059 * all the contexts in the array (an AVCodecContext per RTP stream)
1060 * must contain only one AVStream
1061 * @param n_files number of AVCodecContexts contained in ac
1062 * @param buff buffer where the SDP will be stored (must be allocated by
1064 * @param size the size of the buffer
1065 * @return 0 if OK. AVERROR_xxx if error.
1067 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1069 #ifdef HAVE_AV_CONFIG_H
1071 void ff_dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
1074 #define dynarray_add(tab, nb_ptr, elem)\
1076 typeof(tab) _tab = (tab);\
1077 typeof(elem) _elem = (elem);\
1078 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1079 ff_dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
1082 #define dynarray_add(tab, nb_ptr, elem)\
1084 ff_dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
1088 time_t mktimegm(struct tm *tm);
1089 struct tm *brktimegm(time_t secs, struct tm *tm);
1090 const char *small_strptime(const char *p, const char *fmt,
1094 int resolve_host(struct in_addr *sin_addr, const char *hostname);
1096 void url_split(char *proto, int proto_size,
1097 char *authorization, int authorization_size,
1098 char *hostname, int hostname_size,
1100 char *path, int path_size,
1103 int match_ext(const char *filename, const char *extensions);
1105 #endif /* HAVE_AV_CONFIG_H */
1107 #endif /* AVFORMAT_AVFORMAT_H */