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 FFMPEG_AVFORMAT_H
22 #define FFMPEG_AVFORMAT_H
24 #define LIBAVFORMAT_VERSION_MAJOR 52
25 #define LIBAVFORMAT_VERSION_MINOR 9
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 #include <stdio.h> /* FILE */
40 #include "libavcodec/avcodec.h"
44 /* packet functions */
46 typedef struct AVPacket {
47 int64_t pts; ///< presentation time stamp in time_base units
48 int64_t dts; ///< decompression time stamp in time_base units
53 int duration; ///< presentation duration in time_base units (0 if not available)
54 void (*destruct)(struct AVPacket *);
56 int64_t pos; ///< byte position in stream, -1 if unknown
58 #define PKT_FLAG_KEY 0x0001
60 void av_destruct_packet_nofree(AVPacket *pkt);
63 * Default packet destructor.
65 void av_destruct_packet(AVPacket *pkt);
68 * Initialize optional fields of a packet to default values.
72 void av_init_packet(AVPacket *pkt);
75 * Allocate the payload of a packet and initialize its fields to default values.
78 * @param size wanted payload size
79 * @return 0 if OK. AVERROR_xxx otherwise.
81 int av_new_packet(AVPacket *pkt, int size);
84 * Allocate and read the payload of a packet and initialize its fields to default values.
87 * @param size wanted payload size
88 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
90 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
93 * @warning This is a hack - the packet memory allocation stuff is broken. The
94 * packet is allocated if it was not really allocated
96 int av_dup_packet(AVPacket *pkt);
101 * @param pkt packet to free
103 static inline void av_free_packet(AVPacket *pkt)
105 if (pkt && pkt->destruct) {
110 /*************************************************/
111 /* fractional numbers for exact pts handling */
114 * the exact value of the fractional number is: 'val + num / den'.
115 * num is assumed to be such as 0 <= num < den
116 * @deprecated Use AVRational instead
118 typedef struct AVFrac {
119 int64_t val, num, den;
120 } AVFrac attribute_deprecated;
122 /*************************************************/
123 /* input/output formats */
127 struct AVFormatContext;
129 /** this structure contains the data a format has to probe a file */
130 typedef struct AVProbeData {
131 const char *filename;
136 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
137 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
139 typedef struct AVFormatParameters {
140 AVRational time_base;
145 enum PixelFormat pix_fmt;
146 int channel; /**< used to select dv channel */
147 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
148 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
149 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
150 stream packet (only meaningful if
151 mpeg2ts_raw is TRUE) */
152 int initial_pause:1; /**< do not begin to play the stream
153 immediately (RTSP only) */
154 int prealloced_context:1;
155 #if LIBAVFORMAT_VERSION_INT < (53<<16)
156 enum CodecID video_codec_id;
157 enum CodecID audio_codec_id;
159 } AVFormatParameters;
161 //! demuxer will use url_fopen, no opened file should be provided by the caller
162 #define AVFMT_NOFILE 0x0001
163 #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
164 #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
165 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
167 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
168 #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
169 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
171 typedef struct AVOutputFormat {
173 const char *long_name;
174 const char *mime_type;
175 const char *extensions; /**< comma separated filename extensions */
176 /** size of private data so that it can be allocated in the wrapper */
179 enum CodecID audio_codec; /**< default audio codec */
180 enum CodecID video_codec; /**< default video codec */
181 int (*write_header)(struct AVFormatContext *);
182 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
183 int (*write_trailer)(struct AVFormatContext *);
184 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
186 /** currently only used to set pixel format if not YUV420P */
187 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
188 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
191 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
192 * the arrays are all CODEC_ID_NONE terminated
194 const struct AVCodecTag **codec_tag;
196 enum CodecID subtitle_codec; /**< default subtitle codec */
199 struct AVOutputFormat *next;
202 typedef struct AVInputFormat {
204 const char *long_name;
205 /** size of private data so that it can be allocated in the wrapper */
208 * Tell if a given file has a chance of being parsed by this format.
209 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
210 * big so you do not have to check for that unless you need more.
212 int (*read_probe)(AVProbeData *);
213 /** read the format header and initialize the AVFormatContext
214 structure. Return 0 if OK. 'ap' if non NULL contains
215 additional paramters. Only used in raw format right
216 now. 'av_new_stream' should be called to create new streams. */
217 int (*read_header)(struct AVFormatContext *,
218 AVFormatParameters *ap);
219 /** read one packet and put it in 'pkt'. pts and flags are also
220 set. 'av_new_stream' can be called only if the flag
221 AVFMTCTX_NOHEADER is used. */
222 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
223 /** close the stream. The AVFormatContext and AVStreams are not
224 freed by this function */
225 int (*read_close)(struct AVFormatContext *);
227 * seek to a given timestamp relative to the frames in
228 * stream component stream_index
229 * @param stream_index must not be -1
230 * @param flags selects which direction should be preferred if no exact
232 * @return >= 0 on success (but not necessarily the new offset)
234 int (*read_seek)(struct AVFormatContext *,
235 int stream_index, int64_t timestamp, int flags);
237 * gets the next timestamp in stream[stream_index].time_base units.
238 * @return the timestamp or AV_NOPTS_VALUE if an error occured
240 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
241 int64_t *pos, int64_t pos_limit);
242 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
244 /** if extensions are defined, then no probe is done. You should
245 usually not use extension format guessing because it is not
247 const char *extensions;
248 /** general purpose read only value that the format can use */
251 /** start/resume playing - only meaningful if using a network based format
253 int (*read_play)(struct AVFormatContext *);
255 /** pause playing - only meaningful if using a network based format
257 int (*read_pause)(struct AVFormatContext *);
259 const struct AVCodecTag **codec_tag;
262 struct AVInputFormat *next;
265 enum AVStreamParseType {
267 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
268 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
269 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
272 typedef struct AVIndexEntry {
275 #define AVINDEX_KEYFRAME 0x0001
277 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).
278 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
281 #define AV_DISPOSITION_DEFAULT 0x0001
282 #define AV_DISPOSITION_DUB 0x0002
283 #define AV_DISPOSITION_ORIGINAL 0x0004
284 #define AV_DISPOSITION_COMMENT 0x0008
285 #define AV_DISPOSITION_LYRICS 0x0010
286 #define AV_DISPOSITION_KARAOKE 0x0020
290 * New fields can be added to the end with minor version bumps.
291 * Removal, reordering and changes to existing fields require a major
293 * sizeof(AVStream) must not be used outside libav*.
295 typedef struct AVStream {
296 int index; /**< stream index in AVFormatContext */
297 int id; /**< format specific stream id */
298 AVCodecContext *codec; /**< codec context */
300 * Real base frame rate of the stream.
301 * This is the lowest frame rate with which all timestamps can be
302 * represented accurately (it is the least common multiple of all
303 * frame rates in the stream), Note, this value is just a guess!
304 * For example if the timebase is 1/90000 and all frames have either
305 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
307 AVRational r_frame_rate;
310 /* internal data used in av_find_stream_info() */
312 /** encoding: PTS generation when outputing stream */
316 * This is the fundamental unit of time (in seconds) in terms
317 * of which frame timestamps are represented. For fixed-fps content,
318 * timebase should be 1/frame rate and timestamp increments should be
321 AVRational time_base;
322 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
323 /* ffmpeg.c private use */
324 int stream_copy; /**< if set, just copy stream */
325 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
326 //FIXME move stuff to a flags field?
327 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
328 * MN: dunno if that is the right place for it */
331 * Decoding: pts of the first frame of the stream, in stream time base.
332 * Only set this if you are absolutely 100% sure that the value you set
333 * it to really is the pts of the first frame.
334 * This may be undefined (AV_NOPTS_VALUE).
335 * @note The ASF header does NOT contain a correct start_time the ASF
336 * demuxer must NOT set this.
340 * Decoding: duration of the stream, in stream time base.
341 * If a source file does not specify a duration, but does specify
342 * a bitrate, this value will be estimates from bit rate and file size.
346 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
348 /* av_read_frame() support */
349 enum AVStreamParseType need_parsing;
350 struct AVCodecParserContext *parser;
353 int last_IP_duration;
355 /* av_seek_frame() support */
356 AVIndexEntry *index_entries; /**< only used if the format does not
357 support seeking natively */
358 int nb_index_entries;
359 unsigned int index_entries_allocated_size;
361 int64_t nb_frames; ///< number of frames in this stream if known or 0
363 #define MAX_REORDER_DELAY 4
364 int64_t pts_buffer[MAX_REORDER_DELAY+1];
366 char *filename; /**< source filename of the stream */
368 int disposition; /**< AV_DISPOSITION_* bitfield */
371 #define AV_PROGRAM_RUNNING 1
374 * New fields can be added to the end with minor version bumps.
375 * Removal, reordering and changes to existing fields require a major
377 * sizeof(AVProgram) must not be used outside libav*.
379 typedef struct AVProgram {
381 char *provider_name; ///< Network name for DVB streams
382 char *name; ///< Service name for DVB streams
384 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
385 unsigned int *stream_index;
386 unsigned int nb_stream_indexes;
389 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
390 (streams are added dynamically) */
392 #define MAX_STREAMS 20
395 * format I/O context.
396 * New fields can be added to the end with minor version bumps.
397 * Removal, reordering and changes to existing fields require a major
399 * sizeof(AVFormatContext) must not be used outside libav*.
401 typedef struct AVFormatContext {
402 const AVClass *av_class; /**< set by av_alloc_format_context */
403 /* can only be iformat or oformat, not both at the same time */
404 struct AVInputFormat *iformat;
405 struct AVOutputFormat *oformat;
408 unsigned int nb_streams;
409 AVStream *streams[MAX_STREAMS];
410 char filename[1024]; /**< input or output filename */
418 int year; /**< ID3 year, 0 if none */
419 int track; /**< track number, 0 if none */
420 char genre[32]; /**< ID3 genre */
422 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
423 /* private data for pts handling (do not modify directly) */
424 /** This buffer is only needed when packets were already buffered but
425 not decoded, for example to get the codec parameters in mpeg
427 struct AVPacketList *packet_buffer;
429 /** decoding: position of the first frame of the component, in
430 AV_TIME_BASE fractional seconds. NEVER set this value directly:
431 it is deduced from the AVStream values. */
433 /** decoding: duration of the stream, in AV_TIME_BASE fractional
434 seconds. NEVER set this value directly: it is deduced from the
437 /** decoding: total file size. 0 if unknown */
439 /** decoding: total stream bitrate in bit/s, 0 if not
440 available. Never set it directly if the file_size and the
441 duration are known as ffmpeg can compute it automatically. */
444 /* av_read_frame() support */
446 const uint8_t *cur_ptr;
450 /* av_seek_frame() support */
451 int64_t data_offset; /** offset of the first packet */
459 #define AVFMT_NOOUTPUTLOOP -1
460 #define AVFMT_INFINITEOUTPUTLOOP 0
461 /** number of times to loop output in formats that support it */
465 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
466 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
467 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
470 /** decoding: size of data to probe; encoding unused */
471 unsigned int probesize;
474 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
476 int max_analyze_duration;
481 unsigned int nb_programs;
482 AVProgram **programs;
485 * Forced video codec_id.
486 * demuxing: set by user
488 enum CodecID video_codec_id;
490 * Forced audio codec_id.
491 * demuxing: set by user
493 enum CodecID audio_codec_id;
495 * Forced subtitle codec_id.
496 * demuxing: set by user
498 enum CodecID subtitle_codec_id;
501 * Maximum amount of memory in bytes to use per stream for the index.
502 * If the needed index exceeds this size entries will be discarded as
503 * needed to maintain a smaller size. This can lead to slower or less
504 * accurate seeking (depends on demuxer).
505 * Demuxers for which a full in memory index is mandatory will ignore
508 * demuxing: set by user
510 unsigned int max_index_size;
513 * Maximum amount of memory in bytes to use for buffering frames
514 * obtained from real-time capture devices.
516 unsigned int max_picture_buffer;
519 typedef struct AVPacketList {
521 struct AVPacketList *next;
524 #if LIBAVFORMAT_VERSION_INT < (53<<16)
525 extern AVInputFormat *first_iformat;
526 extern AVOutputFormat *first_oformat;
529 AVInputFormat *av_iformat_next(AVInputFormat *f);
530 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
532 enum CodecID av_guess_image2_codec(const char *filename);
534 /* XXX: use automatic init with either ELF sections or C file parser */
538 void av_register_input_format(AVInputFormat *format);
539 void av_register_output_format(AVOutputFormat *format);
540 AVOutputFormat *guess_stream_format(const char *short_name,
541 const char *filename, const char *mime_type);
542 AVOutputFormat *guess_format(const char *short_name,
543 const char *filename, const char *mime_type);
546 * Guesses the codec id based upon muxer and filename.
548 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
549 const char *filename, const char *mime_type, enum CodecType type);
552 * Send a nice hexadecimal dump of a buffer to the specified file stream.
554 * @param f The file stream pointer where the dump should be sent to.
556 * @param size buffer size
558 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
560 void av_hex_dump(FILE *f, uint8_t *buf, int size);
563 * Send a nice hexadecimal dump of a buffer to the log.
565 * @param avcl A pointer to an arbitrary struct of which the first field is a
566 * pointer to an AVClass struct.
567 * @param level The importance level of the message, lower values signifying
570 * @param size buffer size
572 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
574 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
577 * Send a nice dump of a packet to the specified file stream.
579 * @param f The file stream pointer where the dump should be sent to.
580 * @param pkt packet to dump
581 * @param dump_payload true if the payload must be displayed too
583 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
586 * Send a nice dump of a packet to the log.
588 * @param avcl A pointer to an arbitrary struct of which the first field is a
589 * pointer to an AVClass struct.
590 * @param level The importance level of the message, lower values signifying
592 * @param pkt packet to dump
593 * @param dump_payload true if the payload must be displayed too
595 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
597 void av_register_all(void);
599 /** codec tag <-> codec id */
600 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
601 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
603 /* media file input */
606 * finds AVInputFormat based on input format's short name.
608 AVInputFormat *av_find_input_format(const char *short_name);
613 * @param is_opened whether the file is already opened, determines whether
614 * demuxers with or without AVFMT_NOFILE are probed
616 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
619 * Allocates all the structures needed to read an input stream.
620 * This does not open the needed codecs for decoding the stream[s].
622 int av_open_input_stream(AVFormatContext **ic_ptr,
623 ByteIOContext *pb, const char *filename,
624 AVInputFormat *fmt, AVFormatParameters *ap);
627 * Open a media file as input. The codecs are not opened. Only the file
628 * header (if present) is read.
630 * @param ic_ptr the opened media file handle is put here
631 * @param filename filename to open.
632 * @param fmt if non NULL, force the file format to use
633 * @param buf_size optional buffer size (zero if default is OK)
634 * @param ap additional parameters needed when opening the file (NULL if default)
635 * @return 0 if OK. AVERROR_xxx otherwise.
637 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
640 AVFormatParameters *ap);
642 * Allocate an AVFormatContext.
643 * Can be freed with av_free() but do not forget to free everything you
644 * explicitly allocated as well!
646 AVFormatContext *av_alloc_format_context(void);
649 * Read packets of a media file to get stream information. This
650 * is useful for file formats with no headers such as MPEG. This
651 * function also computes the real frame rate in case of mpeg2 repeat
653 * The logical file position is not changed by this function;
654 * examined packets may be buffered for later processing.
656 * @param ic media file handle
657 * @return >=0 if OK. AVERROR_xxx if error.
658 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
660 int av_find_stream_info(AVFormatContext *ic);
663 * Read a transport packet from a media file.
665 * This function is obsolete and should never be used.
666 * Use av_read_frame() instead.
668 * @param s media file handle
669 * @param pkt is filled
670 * @return 0 if OK. AVERROR_xxx if error.
672 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
675 * Return the next frame of a stream.
677 * The returned packet is valid
678 * until the next av_read_frame() or until av_close_input_file() and
679 * must be freed with av_free_packet. For video, the packet contains
680 * exactly one frame. For audio, it contains an integer number of
681 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
682 * data). If the audio frames have a variable size (e.g. MPEG audio),
683 * then it contains one frame.
685 * pkt->pts, pkt->dts and pkt->duration are always set to correct
686 * values in AVStream.timebase units (and guessed if the format cannot
687 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
688 * has B frames, so it is better to rely on pkt->dts if you do not
689 * decompress the payload.
691 * @return 0 if OK, < 0 if error or end of file.
693 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
696 * Seek to the key frame at timestamp.
697 * 'timestamp' in 'stream_index'.
698 * @param stream_index If stream_index is (-1), a default
699 * stream is selected, and timestamp is automatically converted
700 * from AV_TIME_BASE units to the stream specific time_base.
701 * @param timestamp timestamp in AVStream.time_base units
702 * or if there is no stream specified then in AV_TIME_BASE units
703 * @param flags flags which select direction and seeking mode
704 * @return >= 0 on success
706 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
709 * start playing a network based stream (e.g. RTSP stream) at the
712 int av_read_play(AVFormatContext *s);
715 * Pause a network based stream (e.g. RTSP stream).
717 * Use av_read_play() to resume it.
719 int av_read_pause(AVFormatContext *s);
722 * Free a AVFormatContext allocated by av_open_input_stream.
723 * @param s context to free
725 void av_close_input_stream(AVFormatContext *s);
728 * Close a media file (but not its codecs).
730 * @param s media file handle
732 void av_close_input_file(AVFormatContext *s);
735 * Add a new stream to a media file.
737 * Can only be called in the read_header() function. If the flag
738 * AVFMTCTX_NOHEADER is in the format context, then new streams
739 * can be added in read_packet too.
741 * @param s media file handle
742 * @param id file format dependent stream id
744 AVStream *av_new_stream(AVFormatContext *s, int id);
745 AVProgram *av_new_program(AVFormatContext *s, int id);
748 * Set the pts for a given stream.
751 * @param pts_wrap_bits number of bits effectively used by the pts
752 * (used for wrap control, 33 is the value for MPEG)
753 * @param pts_num numerator to convert to seconds (MPEG: 1)
754 * @param pts_den denominator to convert to seconds (MPEG: 90000)
756 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
757 int pts_num, int pts_den);
759 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
760 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
761 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
763 int av_find_default_stream_index(AVFormatContext *s);
766 * Gets the index for a specific timestamp.
767 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
768 * the timestamp which is <= the requested one, if backward is 0
770 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
771 * @return < 0 if no such timestamp could be found
773 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
776 * Ensures the index uses less memory than the maximum specified in
777 * AVFormatContext.max_index_size, by discarding entries if it grows
779 * This function is not part of the public API and should only be called
782 void ff_reduce_index(AVFormatContext *s, int stream_index);
785 * Add a index entry into a sorted list updateing if it is already there.
787 * @param timestamp timestamp in the timebase of the given stream
789 int av_add_index_entry(AVStream *st,
790 int64_t pos, int64_t timestamp, int size, int distance, int flags);
793 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
794 * This is not supposed to be called directly by a user application, but by demuxers.
795 * @param target_ts target timestamp in the time base of the given stream
796 * @param stream_index stream number
798 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
801 * Updates cur_dts of all streams based on given timestamp and AVStream.
803 * Stream ref_st unchanged, others set cur_dts in their native timebase
804 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
805 * @param timestamp new dts expressed in time_base of param ref_st
806 * @param ref_st reference stream giving time_base of param timestamp
808 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
811 * Does a binary search using read_timestamp().
812 * This is not supposed to be called directly by a user application, but by demuxers.
813 * @param target_ts target timestamp in the time base of the given stream
814 * @param stream_index stream number
816 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 ));
818 /** media file output */
819 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
822 * Allocate the stream private data and write the stream header to an
825 * @param s media file handle
826 * @return 0 if OK. AVERROR_xxx if error.
828 int av_write_header(AVFormatContext *s);
831 * Write a packet to an output media file.
833 * The packet shall contain one audio or video frame.
834 * The packet must be correctly interleaved according to the container specification,
835 * if not then av_interleaved_write_frame must be used
837 * @param s media file handle
838 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
839 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
841 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
844 * Writes a packet to an output media file ensuring correct interleaving.
846 * The packet must contain one audio or video frame.
847 * If the packets are already correctly interleaved the application should
848 * call av_write_frame() instead as it is slightly faster. It is also important
849 * to keep in mind that completely non-interleaved input will need huge amounts
850 * of memory to interleave with this, so it is preferable to interleave at the
853 * @param s media file handle
854 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
855 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
857 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
860 * Interleave a packet per DTS in an output media file.
862 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
863 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
865 * @param s media file handle
866 * @param out the interleaved packet will be output here
867 * @param in the input packet
868 * @param flush 1 if no further packets are available as input and all
869 * remaining packets should be output
870 * @return 1 if a packet was output, 0 if no packet could be output,
871 * < 0 if an error occured
873 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
876 * @brief Write the stream trailer to an output media file and
877 * free the file private data.
879 * @param s media file handle
880 * @return 0 if OK. AVERROR_xxx if error.
882 int av_write_trailer(AVFormatContext *s);
884 void dump_format(AVFormatContext *ic,
890 * parses width and height out of string str.
891 * @deprecated Use av_parse_video_frame_size instead.
893 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
896 * Converts frame rate from string to a fraction.
897 * @deprecated Use av_parse_video_frame_rate instead.
899 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
902 * Parses \p datestr and returns a corresponding number of microseconds.
903 * @param datestr String representing a date or a duration.
904 * - If a date the syntax is:
906 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
908 * Time is localtime unless Z is appended, in which case it is
909 * interpreted as UTC.
910 * If the year-month-day part isn't specified it takes the current
912 * Returns the number of microseconds since 1st of January, 1970 up to
913 * the time of the parsed date or INT64_MIN if \p datestr cannot be
914 * successfully parsed.
915 * - If a duration the syntax is:
917 * [-]HH[:MM[:SS[.m...]]]
920 * Returns the number of microseconds contained in a time interval
921 * with the specified duration or INT64_MIN if \p datestr cannot be
922 * successfully parsed.
923 * @param duration Flag which tells how to interpret \p datestr, if
924 * not zero \p datestr is interpreted as a duration, otherwise as a
927 int64_t parse_date(const char *datestr, int duration);
929 int64_t av_gettime(void);
931 /* ffm specific for ffserver */
932 #define FFM_PACKET_SIZE 4096
933 offset_t ffm_read_write_index(int fd);
934 void ffm_write_write_index(int fd, offset_t pos);
935 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
938 * Attempts to find a specific tag in a URL.
940 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
943 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
946 * Returns in 'buf' the path with '%d' replaced by number.
948 * Also handles the '%0nd' format where 'n' is the total number
949 * of digits and '%%'.
951 * @param buf destination buffer
952 * @param buf_size destination buffer size
953 * @param path numbered sequence string
954 * @param number frame number
955 * @return 0 if OK, -1 if format error.
957 int av_get_frame_filename(char *buf, int buf_size,
958 const char *path, int number);
961 * Check whether filename actually is a numbered sequence generator.
963 * @param filename possible numbered sequence string
964 * @return 1 if a valid numbered sequence string, 0 otherwise.
966 int av_filename_number_test(const char *filename);
969 * Generate an SDP for an RTP session.
971 * @param ac array of AVFormatContexts describing the RTP streams. If the
972 * array is composed by only one context, such context can contain
973 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
974 * all the contexts in the array (an AVCodecContext per RTP stream)
975 * must contain only one AVStream
976 * @param n_files number of AVCodecContexts contained in ac
977 * @param buff buffer where the SDP will be stored (must be allocated by
979 * @param size the size of the buffer
980 * @return 0 if OK. AVERROR_xxx if error.
982 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
984 #ifdef HAVE_AV_CONFIG_H
986 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
989 #define dynarray_add(tab, nb_ptr, elem)\
991 typeof(tab) _tab = (tab);\
992 typeof(elem) _elem = (elem);\
993 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
994 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
997 #define dynarray_add(tab, nb_ptr, elem)\
999 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
1003 time_t mktimegm(struct tm *tm);
1004 struct tm *brktimegm(time_t secs, struct tm *tm);
1005 const char *small_strptime(const char *p, const char *fmt,
1009 int resolve_host(struct in_addr *sin_addr, const char *hostname);
1011 void url_split(char *proto, int proto_size,
1012 char *authorization, int authorization_size,
1013 char *hostname, int hostname_size,
1015 char *path, int path_size,
1018 int match_ext(const char *filename, const char *extensions);
1020 #endif /* HAVE_AV_CONFIG_H */
1022 #endif /* FFMPEG_AVFORMAT_H */