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_INT ((52<<16)+(7<<8)+0)
25 #define LIBAVFORMAT_VERSION 52.7.0
26 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
28 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
31 #include <stdio.h> /* FILE */
36 /* packet functions */
38 typedef struct AVPacket {
39 int64_t pts; ///< presentation time stamp in time_base units
40 int64_t dts; ///< decompression time stamp in time_base units
45 int duration; ///< presentation duration in time_base units (0 if not available)
46 void (*destruct)(struct AVPacket *);
48 int64_t pos; ///< byte position in stream, -1 if unknown
50 #define PKT_FLAG_KEY 0x0001
52 void av_destruct_packet_nofree(AVPacket *pkt);
55 * Default packet destructor.
57 void av_destruct_packet(AVPacket *pkt);
60 * Initialize optional fields of a packet to default values.
64 void av_init_packet(AVPacket *pkt);
67 * Allocate the payload of a packet and initialize its fields to default values.
70 * @param size wanted payload size
71 * @return 0 if OK. AVERROR_xxx otherwise.
73 int av_new_packet(AVPacket *pkt, int size);
76 * Allocate and read the payload of a packet and initialize its fields to default values.
79 * @param size wanted payload size
80 * @return >0 (read size) if OK. AVERROR_xxx otherwise.
82 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
85 * @warning This is a hack - the packet memory allocation stuff is broken. The
86 * packet is allocated if it was not really allocated
88 int av_dup_packet(AVPacket *pkt);
93 * @param pkt packet to free
95 static inline void av_free_packet(AVPacket *pkt)
97 if (pkt && pkt->destruct) {
102 /*************************************************/
103 /* fractional numbers for exact pts handling */
106 * the exact value of the fractional number is: 'val + num / den'.
107 * num is assumed to be such as 0 <= num < den
108 * @deprecated Use AVRational instead
110 typedef struct AVFrac {
111 int64_t val, num, den;
112 } AVFrac attribute_deprecated;
114 /*************************************************/
115 /* input/output formats */
119 struct AVFormatContext;
121 /** this structure contains the data a format has to probe a file */
122 typedef struct AVProbeData {
123 const char *filename;
128 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
129 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
131 typedef struct AVFormatParameters {
132 AVRational time_base;
137 enum PixelFormat pix_fmt;
138 int channel; /**< used to select dv channel */
139 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
140 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
141 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
142 stream packet (only meaningful if
143 mpeg2ts_raw is TRUE) */
144 int initial_pause:1; /**< do not begin to play the stream
145 immediately (RTSP only) */
146 int prealloced_context:1;
147 #if LIBAVFORMAT_VERSION_INT < (53<<16)
148 enum CodecID video_codec_id;
149 enum CodecID audio_codec_id;
151 } AVFormatParameters;
153 //! demuxer will use url_fopen, no opened file should be provided by the caller
154 #define AVFMT_NOFILE 0x0001
155 #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
156 #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
157 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
159 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
160 #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
161 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
163 typedef struct AVOutputFormat {
165 const char *long_name;
166 const char *mime_type;
167 const char *extensions; /**< comma separated filename extensions */
168 /** size of private data so that it can be allocated in the wrapper */
171 enum CodecID audio_codec; /**< default audio codec */
172 enum CodecID video_codec; /**< default video codec */
173 int (*write_header)(struct AVFormatContext *);
174 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
175 int (*write_trailer)(struct AVFormatContext *);
176 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
178 /** currently only used to set pixel format if not YUV420P */
179 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
180 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
183 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
184 * the arrays are all CODEC_ID_NONE terminated
186 const struct AVCodecTag **codec_tag;
188 enum CodecID subtitle_codec; /**< default subtitle codec */
191 struct AVOutputFormat *next;
194 typedef struct AVInputFormat {
196 const char *long_name;
197 /** size of private data so that it can be allocated in the wrapper */
200 * Tell if a given file has a chance of being parsed by this format.
201 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
202 * big so you do not have to check for that unless you need more.
204 int (*read_probe)(AVProbeData *);
205 /** read the format header and initialize the AVFormatContext
206 structure. Return 0 if OK. 'ap' if non NULL contains
207 additional paramters. Only used in raw format right
208 now. 'av_new_stream' should be called to create new streams. */
209 int (*read_header)(struct AVFormatContext *,
210 AVFormatParameters *ap);
211 /** read one packet and put it in 'pkt'. pts and flags are also
212 set. 'av_new_stream' can be called only if the flag
213 AVFMTCTX_NOHEADER is used. */
214 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
215 /** close the stream. The AVFormatContext and AVStreams are not
216 freed by this function */
217 int (*read_close)(struct AVFormatContext *);
219 * seek to a given timestamp relative to the frames in
220 * stream component stream_index
221 * @param stream_index must not be -1
222 * @param flags selects which direction should be preferred if no exact
224 * @return >= 0 on success (but not necessarily the new offset)
226 int (*read_seek)(struct AVFormatContext *,
227 int stream_index, int64_t timestamp, int flags);
229 * gets the next timestamp in stream[stream_index].time_base units.
230 * @return the timestamp or AV_NOPTS_VALUE if an error occured
232 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
233 int64_t *pos, int64_t pos_limit);
234 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
236 /** if extensions are defined, then no probe is done. You should
237 usually not use extension format guessing because it is not
239 const char *extensions;
240 /** general purpose read only value that the format can use */
243 /** start/resume playing - only meaningful if using a network based format
245 int (*read_play)(struct AVFormatContext *);
247 /** pause playing - only meaningful if using a network based format
249 int (*read_pause)(struct AVFormatContext *);
251 const struct AVCodecTag **codec_tag;
254 struct AVInputFormat *next;
257 enum AVStreamParseType {
259 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
260 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
261 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
264 typedef struct AVIndexEntry {
267 #define AVINDEX_KEYFRAME 0x0001
269 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).
270 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
275 * New fields can be added to the end with minor version bumps.
276 * Removal, reordering and changes to existing fields require a major
278 * sizeof(AVStream) must not be used outside libav*.
280 typedef struct AVStream {
281 int index; /**< stream index in AVFormatContext */
282 int id; /**< format specific stream id */
283 AVCodecContext *codec; /**< codec context */
285 * Real base frame rate of the stream.
286 * This is the lowest frame rate with which all timestamps can be
287 * represented accurately (it is the least common multiple of all
288 * frame rates in the stream), Note, this value is just a guess!
289 * For example if the timebase is 1/90000 and all frames have either
290 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
292 AVRational r_frame_rate;
295 /* internal data used in av_find_stream_info() */
297 /** encoding: PTS generation when outputing stream */
301 * This is the fundamental unit of time (in seconds) in terms
302 * of which frame timestamps are represented. For fixed-fps content,
303 * timebase should be 1/frame rate and timestamp increments should be
306 AVRational time_base;
307 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
308 /* ffmpeg.c private use */
309 int stream_copy; /**< if set, just copy stream */
310 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
311 //FIXME move stuff to a flags field?
312 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
313 * MN: dunno if that is the right place for it */
316 * Decoding: pts of the first frame of the stream, in stream time base.
317 * Only set this if you are absolutely 100% sure that the value you set
318 * it to really is the pts of the first frame.
319 * This may be undefined (AV_NOPTS_VALUE).
320 * @note The ASF header does NOT contain a correct start_time the ASF
321 * demuxer must NOT set this.
325 * Decoding: duration of the stream, in stream time base.
326 * If a source file does not specify a duration, but does specify
327 * a bitrate, this value will be estimates from bit rate and file size.
331 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
333 /* av_read_frame() support */
334 enum AVStreamParseType need_parsing;
335 struct AVCodecParserContext *parser;
338 int last_IP_duration;
340 /* av_seek_frame() support */
341 AVIndexEntry *index_entries; /**< only used if the format does not
342 support seeking natively */
343 int nb_index_entries;
344 unsigned int index_entries_allocated_size;
346 int64_t nb_frames; ///< number of frames in this stream if known or 0
348 #define MAX_REORDER_DELAY 4
349 int64_t pts_buffer[MAX_REORDER_DELAY+1];
351 char *filename; /**< source filename of the stream */
354 #define AV_PROGRAM_RUNNING 1
357 * New fields can be added to the end with minor version bumps.
358 * Removal, reordering and changes to existing fields require a major
360 * sizeof(AVProgram) must not be used outside libav*.
362 typedef struct AVProgram {
364 char *provider_name; ///< Network name for DVB streams
365 char *name; ///< Service name for DVB streams
367 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
368 unsigned int *stream_index;
369 unsigned int nb_stream_indexes;
372 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
373 (streams are added dynamically) */
375 #define MAX_STREAMS 20
378 * format I/O context.
379 * New fields can be added to the end with minor version bumps.
380 * Removal, reordering and changes to existing fields require a major
382 * sizeof(AVFormatContext) must not be used outside libav*.
384 typedef struct AVFormatContext {
385 const AVClass *av_class; /**< set by av_alloc_format_context */
386 /* can only be iformat or oformat, not both at the same time */
387 struct AVInputFormat *iformat;
388 struct AVOutputFormat *oformat;
391 unsigned int nb_streams;
392 AVStream *streams[MAX_STREAMS];
393 char filename[1024]; /**< input or output filename */
401 int year; /**< ID3 year, 0 if none */
402 int track; /**< track number, 0 if none */
403 char genre[32]; /**< ID3 genre */
405 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
406 /* private data for pts handling (do not modify directly) */
407 /** This buffer is only needed when packets were already buffered but
408 not decoded, for example to get the codec parameters in mpeg
410 struct AVPacketList *packet_buffer;
412 /** decoding: position of the first frame of the component, in
413 AV_TIME_BASE fractional seconds. NEVER set this value directly:
414 it is deduced from the AVStream values. */
416 /** decoding: duration of the stream, in AV_TIME_BASE fractional
417 seconds. NEVER set this value directly: it is deduced from the
420 /** decoding: total file size. 0 if unknown */
422 /** decoding: total stream bitrate in bit/s, 0 if not
423 available. Never set it directly if the file_size and the
424 duration are known as ffmpeg can compute it automatically. */
427 /* av_read_frame() support */
429 const uint8_t *cur_ptr;
433 /* av_seek_frame() support */
434 int64_t data_offset; /** offset of the first packet */
442 #define AVFMT_NOOUTPUTLOOP -1
443 #define AVFMT_INFINITEOUTPUTLOOP 0
444 /** number of times to loop output in formats that support it */
448 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
449 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
450 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
453 /** decoding: size of data to probe; encoding unused */
454 unsigned int probesize;
457 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
459 int max_analyze_duration;
464 unsigned int nb_programs;
465 AVProgram **programs;
468 * Forced video codec_id.
469 * demuxing: set by user
471 enum CodecID video_codec_id;
473 * Forced audio codec_id.
474 * demuxing: set by user
476 enum CodecID audio_codec_id;
478 * Forced subtitle codec_id.
479 * demuxing: set by user
481 enum CodecID subtitle_codec_id;
484 * Maximum amount of memory in bytes to use per stream for the index.
485 * If the needed index exceeds this size entries will be discarded as
486 * needed to maintain a smaller size. This can lead to slower or less
487 * accurate seeking (depends on demuxer).
488 * Demuxers for which a full in memory index is mandatory will ignore
491 * demuxing: set by user
493 unsigned int max_index_size;
496 typedef struct AVPacketList {
498 struct AVPacketList *next;
501 #if LIBAVFORMAT_VERSION_INT < (53<<16)
502 extern AVInputFormat *first_iformat;
503 extern AVOutputFormat *first_oformat;
506 AVInputFormat *av_iformat_next(AVInputFormat *f);
507 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
509 enum CodecID av_guess_image2_codec(const char *filename);
511 /* XXX: use automatic init with either ELF sections or C file parser */
515 void av_register_input_format(AVInputFormat *format);
516 void av_register_output_format(AVOutputFormat *format);
517 AVOutputFormat *guess_stream_format(const char *short_name,
518 const char *filename, const char *mime_type);
519 AVOutputFormat *guess_format(const char *short_name,
520 const char *filename, const char *mime_type);
523 * Guesses the codec id based upon muxer and filename.
525 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
526 const char *filename, const char *mime_type, enum CodecType type);
529 * Send a nice hexadecimal dump of a buffer to the specified file stream.
531 * @param f The file stream pointer where the dump should be sent to.
533 * @param size buffer size
535 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
537 void av_hex_dump(FILE *f, uint8_t *buf, int size);
540 * Send a nice hexadecimal dump of a buffer to the log.
542 * @param avcl A pointer to an arbitrary struct of which the first field is a
543 * pointer to an AVClass struct.
544 * @param level The importance level of the message, lower values signifying
547 * @param size buffer size
549 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
551 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
554 * Send a nice dump of a packet to the specified file stream.
556 * @param f The file stream pointer where the dump should be sent to.
557 * @param pkt packet to dump
558 * @param dump_payload true if the payload must be displayed too
560 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
563 * Send a nice dump of a packet 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
569 * @param pkt packet to dump
570 * @param dump_payload true if the payload must be displayed too
572 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
574 void av_register_all(void);
576 /** codec tag <-> codec id */
577 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
578 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
580 /* media file input */
583 * finds AVInputFormat based on input format's short name.
585 AVInputFormat *av_find_input_format(const char *short_name);
590 * @param is_opened whether the file is already opened, determines whether
591 * demuxers with or without AVFMT_NOFILE are probed
593 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
596 * Allocates all the structures needed to read an input stream.
597 * This does not open the needed codecs for decoding the stream[s].
599 int av_open_input_stream(AVFormatContext **ic_ptr,
600 ByteIOContext *pb, const char *filename,
601 AVInputFormat *fmt, AVFormatParameters *ap);
604 * Open a media file as input. The codecs are not opened. Only the file
605 * header (if present) is read.
607 * @param ic_ptr the opened media file handle is put here
608 * @param filename filename to open.
609 * @param fmt if non NULL, force the file format to use
610 * @param buf_size optional buffer size (zero if default is OK)
611 * @param ap additional parameters needed when opening the file (NULL if default)
612 * @return 0 if OK. AVERROR_xxx otherwise.
614 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
617 AVFormatParameters *ap);
619 * Allocate an AVFormatContext.
620 * Can be freed with av_free() but do not forget to free everything you
621 * explicitly allocated as well!
623 AVFormatContext *av_alloc_format_context(void);
626 * Read packets of a media file to get stream information. This
627 * is useful for file formats with no headers such as MPEG. This
628 * function also computes the real frame rate in case of mpeg2 repeat
630 * The logical file position is not changed by this function;
631 * examined packets may be buffered for later processing.
633 * @param ic media file handle
634 * @return >=0 if OK. AVERROR_xxx if error.
635 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
637 int av_find_stream_info(AVFormatContext *ic);
640 * Read a transport packet from a media file.
642 * This function is obsolete and should never be used.
643 * Use av_read_frame() instead.
645 * @param s media file handle
646 * @param pkt is filled
647 * @return 0 if OK. AVERROR_xxx if error.
649 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
652 * Return the next frame of a stream.
654 * The returned packet is valid
655 * until the next av_read_frame() or until av_close_input_file() and
656 * must be freed with av_free_packet. For video, the packet contains
657 * exactly one frame. For audio, it contains an integer number of
658 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
659 * data). If the audio frames have a variable size (e.g. MPEG audio),
660 * then it contains one frame.
662 * pkt->pts, pkt->dts and pkt->duration are always set to correct
663 * values in AVStream.timebase units (and guessed if the format cannot
664 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
665 * has B frames, so it is better to rely on pkt->dts if you do not
666 * decompress the payload.
668 * @return 0 if OK, < 0 if error or end of file.
670 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
673 * Seek to the key frame at timestamp.
674 * 'timestamp' in 'stream_index'.
675 * @param stream_index If stream_index is (-1), a default
676 * stream is selected, and timestamp is automatically converted
677 * from AV_TIME_BASE units to the stream specific time_base.
678 * @param timestamp timestamp in AVStream.time_base units
679 * or if there is no stream specified then in AV_TIME_BASE units
680 * @param flags flags which select direction and seeking mode
681 * @return >= 0 on success
683 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
686 * start playing a network based stream (e.g. RTSP stream) at the
689 int av_read_play(AVFormatContext *s);
692 * Pause a network based stream (e.g. RTSP stream).
694 * Use av_read_play() to resume it.
696 int av_read_pause(AVFormatContext *s);
699 * Free a AVFormatContext allocated by av_open_input_stream.
700 * @param s context to free
702 void av_close_input_stream(AVFormatContext *s);
705 * Close a media file (but not its codecs).
707 * @param s media file handle
709 void av_close_input_file(AVFormatContext *s);
712 * Add a new stream to a media file.
714 * Can only be called in the read_header() function. If the flag
715 * AVFMTCTX_NOHEADER is in the format context, then new streams
716 * can be added in read_packet too.
718 * @param s media file handle
719 * @param id file format dependent stream id
721 AVStream *av_new_stream(AVFormatContext *s, int id);
722 AVProgram *av_new_program(AVFormatContext *s, int id);
725 * Set the pts for a given stream.
728 * @param pts_wrap_bits number of bits effectively used by the pts
729 * (used for wrap control, 33 is the value for MPEG)
730 * @param pts_num numerator to convert to seconds (MPEG: 1)
731 * @param pts_den denominator to convert to seconds (MPEG: 90000)
733 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
734 int pts_num, int pts_den);
736 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
737 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
738 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
740 int av_find_default_stream_index(AVFormatContext *s);
743 * Gets the index for a specific timestamp.
744 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
745 * the timestamp which is <= the requested one, if backward is 0
747 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
748 * @return < 0 if no such timestamp could be found
750 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
753 * Ensures the index uses less memory than the maximum specified in
754 * AVFormatContext.max_index_size, by discarding entries if it grows
756 * This function is not part of the public API and should only be called
759 void ff_reduce_index(AVFormatContext *s, int stream_index);
762 * Add a index entry into a sorted list updateing if it is already there.
764 * @param timestamp timestamp in the timebase of the given stream
766 int av_add_index_entry(AVStream *st,
767 int64_t pos, int64_t timestamp, int size, int distance, int flags);
770 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
771 * This is not supposed to be called directly by a user application, but by demuxers.
772 * @param target_ts target timestamp in the time base of the given stream
773 * @param stream_index stream number
775 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
778 * Updates cur_dts of all streams based on given timestamp and AVStream.
780 * Stream ref_st unchanged, others set cur_dts in their native timebase
781 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
782 * @param timestamp new dts expressed in time_base of param ref_st
783 * @param ref_st reference stream giving time_base of param timestamp
785 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
788 * Does a binary search using read_timestamp().
789 * This is not supposed to be called directly by a user application, but by demuxers.
790 * @param target_ts target timestamp in the time base of the given stream
791 * @param stream_index stream number
793 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 ));
795 /** media file output */
796 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
799 * Allocate the stream private data and write the stream header to an
802 * @param s media file handle
803 * @return 0 if OK. AVERROR_xxx if error.
805 int av_write_header(AVFormatContext *s);
808 * Write a packet to an output media file.
810 * The packet shall contain one audio or video frame.
811 * The packet must be correctly interleaved according to the container specification,
812 * if not then av_interleaved_write_frame must be used
814 * @param s media file handle
815 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
816 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
818 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
821 * Writes a packet to an output media file ensuring correct interleaving.
823 * The packet must contain one audio or video frame.
824 * If the packets are already correctly interleaved the application should
825 * call av_write_frame() instead as it is slightly faster. It is also important
826 * to keep in mind that completely non-interleaved input will need huge amounts
827 * of memory to interleave with this, so it is preferable to interleave at the
830 * @param s media file handle
831 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
832 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
834 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
837 * Interleave a packet per DTS in an output media file.
839 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
840 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
842 * @param s media file handle
843 * @param out the interleaved packet will be output here
844 * @param in the input packet
845 * @param flush 1 if no further packets are available as input and all
846 * remaining packets should be output
847 * @return 1 if a packet was output, 0 if no packet could be output,
848 * < 0 if an error occured
850 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
853 * @brief Write the stream trailer to an output media file and
854 * free the file private data.
856 * @param s media file handle
857 * @return 0 if OK. AVERROR_xxx if error.
859 int av_write_trailer(AVFormatContext *s);
861 void dump_format(AVFormatContext *ic,
867 * parses width and height out of string str.
868 * @deprecated Use av_parse_video_frame_size instead.
870 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
873 * Converts frame rate from string to a fraction.
874 * @deprecated Use av_parse_video_frame_rate instead.
876 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
879 * Parses \p datestr and returns a corresponding number of microseconds.
880 * @param datestr String representing a date or a duration.
881 * - If a date the syntax is:
883 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
885 * Time is localtime unless Z is appended, in which case it is
886 * interpreted as UTC.
887 * If the year-month-day part isn't specified it takes the current
889 * Returns the number of microseconds since 1st of January, 1970 up to
890 * the time of the parsed date or INT64_MIN if \p datestr cannot be
891 * successfully parsed.
892 * - If a duration the syntax is:
894 * [-]HH[:MM[:SS[.m...]]]
897 * Returns the number of microseconds contained in a time interval
898 * with the specified duration or INT64_MIN if \p datestr cannot be
899 * successfully parsed.
900 * @param duration Flag which tells how to interpret \p datestr, if
901 * not zero \p datestr is interpreted as a duration, otherwise as a
904 int64_t parse_date(const char *datestr, int duration);
906 int64_t av_gettime(void);
908 /* ffm specific for ffserver */
909 #define FFM_PACKET_SIZE 4096
910 offset_t ffm_read_write_index(int fd);
911 void ffm_write_write_index(int fd, offset_t pos);
912 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
915 * Attempts to find a specific tag in a URL.
917 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
920 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
923 * Returns in 'buf' the path with '%d' replaced by number.
925 * Also handles the '%0nd' format where 'n' is the total number
926 * of digits and '%%'.
928 * @param buf destination buffer
929 * @param buf_size destination buffer size
930 * @param path numbered sequence string
931 * @param number frame number
932 * @return 0 if OK, -1 if format error.
934 int av_get_frame_filename(char *buf, int buf_size,
935 const char *path, int number);
938 * Check whether filename actually is a numbered sequence generator.
940 * @param filename possible numbered sequence string
941 * @return 1 if a valid numbered sequence string, 0 otherwise.
943 int av_filename_number_test(const char *filename);
946 * Generate an SDP for an RTP session.
948 * @param ac array of AVFormatContexts describing the RTP streams. If the
949 * array is composed by only one context, such context can contain
950 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
951 * all the contexts in the array (an AVCodecContext per RTP stream)
952 * must contain only one AVStream
953 * @param n_files number of AVCodecContexts contained in ac
954 * @param buff buffer where the SDP will be stored (must be allocated by
956 * @param size the size of the buffer
957 * @return 0 if OK. AVERROR_xxx if error.
959 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
961 #ifdef HAVE_AV_CONFIG_H
963 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
966 #define dynarray_add(tab, nb_ptr, elem)\
968 typeof(tab) _tab = (tab);\
969 typeof(elem) _elem = (elem);\
970 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
971 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
974 #define dynarray_add(tab, nb_ptr, elem)\
976 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
980 time_t mktimegm(struct tm *tm);
981 struct tm *brktimegm(time_t secs, struct tm *tm);
982 const char *small_strptime(const char *p, const char *fmt,
986 int resolve_host(struct in_addr *sin_addr, const char *hostname);
988 void url_split(char *proto, int proto_size,
989 char *authorization, int authorization_size,
990 char *hostname, int hostname_size,
992 char *path, int path_size,
995 int match_ext(const char *filename, const char *extensions);
997 #endif /* HAVE_AV_CONFIG_H */
999 #endif /* FFMPEG_AVFORMAT_H */