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)+(3<<8)+0)
25 #define LIBAVFORMAT_VERSION 52.3.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 AV_TIME_BASE units.
231 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
232 int64_t *pos, int64_t pos_limit);
233 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
235 /** if extensions are defined, then no probe is done. You should
236 usually not use extension format guessing because it is not
238 const char *extensions;
239 /** general purpose read only value that the format can use */
242 /** start/resume playing - only meaningful if using a network based format
244 int (*read_play)(struct AVFormatContext *);
246 /** pause playing - only meaningful if using a network based format
248 int (*read_pause)(struct AVFormatContext *);
250 const struct AVCodecTag **codec_tag;
253 struct AVInputFormat *next;
256 enum AVStreamParseType {
258 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
259 AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
260 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
263 typedef struct AVIndexEntry {
266 #define AVINDEX_KEYFRAME 0x0001
268 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).
269 int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
274 * New fields can be added to the end with minor version bumps.
275 * Removal, reordering and changes to existing fields require a Major
277 * sizeof(AVStream) must not be used outside libav*
279 typedef struct AVStream {
280 int index; /**< stream index in AVFormatContext */
281 int id; /**< format specific stream id */
282 AVCodecContext *codec; /**< codec context */
284 * real base frame rate of the stream.
285 * this is the lowest framerate with which all timestamps can be
286 * represented accurately (it is the least common multiple of all
287 * framerates in the stream), Note, this value is just a guess!
288 * for example if the timebase is 1/90000 and all frames have either
289 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
291 AVRational r_frame_rate;
294 /* internal data used in av_find_stream_info() */
296 /** encoding: PTS generation when outputing stream */
300 * this is the fundamental unit of time (in seconds) in terms
301 * of which frame timestamps are represented. for fixed-fps content,
302 * timebase should be 1/framerate and timestamp increments should be
305 AVRational time_base;
306 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
307 /* ffmpeg.c private use */
308 int stream_copy; /**< if set, just copy stream */
309 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
310 //FIXME move stuff to a flags field?
311 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
312 * MN: dunno if that is the right place for it */
315 * decoding: pts of the first frame of the stream, in stream time base.
316 * only set this if you are absolutely 100% sure that the value you set
317 * it to really is the pts of the first frame
318 * This may be undefined (AV_NOPTS_VALUE).
319 * @note the ASF header does NOT contain a correct start_time the ASF
320 * demuxer must NOT set this
324 * decoding: duration of the stream, in stream time base.
325 * If a source file does not specify a duration, but does specify
326 * a bitrate, this value will be estimates from bit rate and file size.
330 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
332 /* av_read_frame() support */
333 enum AVStreamParseType need_parsing;
334 struct AVCodecParserContext *parser;
337 int last_IP_duration;
339 /* av_seek_frame() support */
340 AVIndexEntry *index_entries; /**< only used if the format does not
341 support seeking natively */
342 int nb_index_entries;
343 unsigned int index_entries_allocated_size;
345 int64_t nb_frames; ///< number of frames in this stream if known or 0
347 #define MAX_REORDER_DELAY 4
348 int64_t pts_buffer[MAX_REORDER_DELAY+1];
351 #define AV_PROGRAM_RUNNING 1
355 * New fields can be added to the end with minor version bumps.
356 * Removal, reordering and changes to existing fields require a Major
358 * sizeof(AVProgram) must not be used outside libav*
360 typedef struct AVProgram {
362 char *provider_name; ///< Network name for DVB streams
363 char *name; ///< Service name for DVB streams
365 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
366 unsigned int *stream_index;
367 unsigned int nb_stream_indexes;
370 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
371 (streams are added dynamically) */
373 #define MAX_STREAMS 20
376 * format I/O context.
377 * New fields can be added to the end with minor version bumps.
378 * Removal, reordering and changes to existing fields require a Major
380 * sizeof(AVFormatContext) must not be used outside libav*
382 typedef struct AVFormatContext {
383 const AVClass *av_class; /**< set by av_alloc_format_context */
384 /* can only be iformat or oformat, not both at the same time */
385 struct AVInputFormat *iformat;
386 struct AVOutputFormat *oformat;
389 unsigned int nb_streams;
390 AVStream *streams[MAX_STREAMS];
391 char filename[1024]; /**< input or output filename */
399 int year; /**< ID3 year, 0 if none */
400 int track; /**< track number, 0 if none */
401 char genre[32]; /**< ID3 genre */
403 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
404 /* private data for pts handling (do not modify directly) */
405 /** This buffer is only needed when packets were already buffered but
406 not decoded, for example to get the codec parameters in mpeg
408 struct AVPacketList *packet_buffer;
410 /** decoding: position of the first frame of the component, in
411 AV_TIME_BASE fractional seconds. NEVER set this value directly:
412 it is deduced from the AVStream values. */
414 /** decoding: duration of the stream, in AV_TIME_BASE fractional
415 seconds. NEVER set this value directly: it is deduced from the
418 /** decoding: total file size. 0 if unknown */
420 /** decoding: total stream bitrate in bit/s, 0 if not
421 available. Never set it directly if the file_size and the
422 duration are known as ffmpeg can compute it automatically. */
425 /* av_read_frame() support */
427 const uint8_t *cur_ptr;
431 /* av_seek_frame() support */
432 int64_t data_offset; /** offset of the first packet */
440 #define AVFMT_NOOUTPUTLOOP -1
441 #define AVFMT_INFINITEOUTPUTLOOP 0
442 /** number of times to loop output in formats that support it */
446 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
447 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
448 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
451 /** decoding: size of data to probe; encoding unused */
452 unsigned int probesize;
455 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
457 int max_analyze_duration;
462 unsigned int nb_programs;
463 AVProgram **programs;
466 * Forced video codec_id.
467 * demuxing: set by user
469 enum CodecID video_codec_id;
471 * Forced audio codec_id.
472 * demuxing: set by user
474 enum CodecID audio_codec_id;
476 * Forced subtitle codec_id.
477 * demuxing: set by user
479 enum CodecID subtitle_codec_id;
482 typedef struct AVPacketList {
484 struct AVPacketList *next;
487 #if LIBAVFORMAT_VERSION_INT < (53<<16)
488 extern AVInputFormat *first_iformat;
489 extern AVOutputFormat *first_oformat;
492 AVInputFormat *av_iformat_next(AVInputFormat *f);
493 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
495 enum CodecID av_guess_image2_codec(const char *filename);
497 /* XXX: use automatic init with either ELF sections or C file parser */
501 void av_register_input_format(AVInputFormat *format);
502 void av_register_output_format(AVOutputFormat *format);
503 AVOutputFormat *guess_stream_format(const char *short_name,
504 const char *filename, const char *mime_type);
505 AVOutputFormat *guess_format(const char *short_name,
506 const char *filename, const char *mime_type);
509 * Guesses the codec id based upon muxer and filename.
511 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
512 const char *filename, const char *mime_type, enum CodecType type);
515 * Send a nice hexadecimal dump of a buffer to the specified file stream.
517 * @param f The file stream pointer where the dump should be sent to.
519 * @param size buffer size
521 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
523 void av_hex_dump(FILE *f, uint8_t *buf, int size);
526 * Send a nice hexadecimal dump of a buffer to the log.
528 * @param avcl A pointer to an arbitrary struct of which the first field is a
529 * pointer to an AVClass struct.
530 * @param level The importance level of the message, lower values signifying
533 * @param size buffer size
535 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
537 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
540 * Send a nice dump of a packet to the specified file stream.
542 * @param f The file stream pointer where the dump should be sent to.
543 * @param pkt packet to dump
544 * @param dump_payload true if the payload must be displayed too
546 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
549 * Send a nice dump of a packet to the log.
551 * @param avcl A pointer to an arbitrary struct of which the first field is a
552 * pointer to an AVClass struct.
553 * @param level The importance level of the message, lower values signifying
555 * @param pkt packet to dump
556 * @param dump_payload true if the payload must be displayed too
558 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
560 void av_register_all(void);
562 /** codec tag <-> codec id */
563 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
564 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
566 /* media file input */
569 * finds AVInputFormat based on input format's short name.
571 AVInputFormat *av_find_input_format(const char *short_name);
576 * @param is_opened whether the file is already opened, determines whether
577 * demuxers with or without AVFMT_NOFILE are probed
579 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
582 * Allocates all the structures needed to read an input stream.
583 * This does not open the needed codecs for decoding the stream[s].
585 int av_open_input_stream(AVFormatContext **ic_ptr,
586 ByteIOContext *pb, const char *filename,
587 AVInputFormat *fmt, AVFormatParameters *ap);
590 * Open a media file as input. The codecs are not opened. Only the file
591 * header (if present) is read.
593 * @param ic_ptr the opened media file handle is put here
594 * @param filename filename to open.
595 * @param fmt if non NULL, force the file format to use
596 * @param buf_size optional buffer size (zero if default is OK)
597 * @param ap additional parameters needed when opening the file (NULL if default)
598 * @return 0 if OK. AVERROR_xxx otherwise.
600 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
603 AVFormatParameters *ap);
605 * Allocate an AVFormatContext.
606 * Can be freed with av_free() but do not forget to free everything you
607 * explicitly allocated as well!
609 AVFormatContext *av_alloc_format_context(void);
612 * Read packets of a media file to get stream information. This
613 * is useful for file formats with no headers such as MPEG. This
614 * function also computes the real frame rate in case of mpeg2 repeat
616 * The logical file position is not changed by this function;
617 * examined packets may be buffered for later processing.
619 * @param ic media file handle
620 * @return >=0 if OK. AVERROR_xxx if error.
621 * @todo Let user decide somehow what information is needed so we do not waste time getting stuff the user does not need.
623 int av_find_stream_info(AVFormatContext *ic);
626 * Read a transport packet from a media file.
628 * This function is obsolete and should never be used.
629 * Use av_read_frame() instead.
631 * @param s media file handle
632 * @param pkt is filled
633 * @return 0 if OK. AVERROR_xxx if error.
635 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
638 * Return the next frame of a stream.
640 * The returned packet is valid
641 * until the next av_read_frame() or until av_close_input_file() and
642 * must be freed with av_free_packet. For video, the packet contains
643 * exactly one frame. For audio, it contains an integer number of
644 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
645 * data). If the audio frames have a variable size (e.g. MPEG audio),
646 * then it contains one frame.
648 * pkt->pts, pkt->dts and pkt->duration are always set to correct
649 * values in AVStream.timebase units (and guessed if the format cannot
650 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
651 * has B frames, so it is better to rely on pkt->dts if you do not
652 * decompress the payload.
654 * @return 0 if OK, < 0 if error or end of file.
656 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
659 * Seek to the key frame at timestamp.
660 * 'timestamp' in 'stream_index'.
661 * @param stream_index If stream_index is (-1), a default
662 * stream is selected, and timestamp is automatically converted
663 * from AV_TIME_BASE units to the stream specific time_base.
664 * @param timestamp timestamp in AVStream.time_base units
665 * or if there is no stream specified then in AV_TIME_BASE units
666 * @param flags flags which select direction and seeking mode
667 * @return >= 0 on success
669 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
672 * start playing a network based stream (e.g. RTSP stream) at the
675 int av_read_play(AVFormatContext *s);
678 * Pause a network based stream (e.g. RTSP stream).
680 * Use av_read_play() to resume it.
682 int av_read_pause(AVFormatContext *s);
685 * Free a AVFormatContext allocated by av_open_input_stream.
686 * @param s context to free
688 void av_close_input_stream(AVFormatContext *s);
691 * Close a media file (but not its codecs).
693 * @param s media file handle
695 void av_close_input_file(AVFormatContext *s);
698 * Add a new stream to a media file.
700 * Can only be called in the read_header() function. If the flag
701 * AVFMTCTX_NOHEADER is in the format context, then new streams
702 * can be added in read_packet too.
704 * @param s media file handle
705 * @param id file format dependent stream id
707 AVStream *av_new_stream(AVFormatContext *s, int id);
708 AVProgram *av_new_program(AVFormatContext *s, int id);
711 * Set the pts for a given stream.
714 * @param pts_wrap_bits number of bits effectively used by the pts
715 * (used for wrap control, 33 is the value for MPEG)
716 * @param pts_num numerator to convert to seconds (MPEG: 1)
717 * @param pts_den denominator to convert to seconds (MPEG: 90000)
719 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
720 int pts_num, int pts_den);
722 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
723 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
724 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
726 int av_find_default_stream_index(AVFormatContext *s);
729 * Gets the index for a specific timestamp.
730 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
731 * the timestamp which is <= the requested one, if backward is 0
733 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
734 * @return < 0 if no such timestamp could be found
736 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
739 * Add a index entry into a sorted list updateing if it is already there.
741 * @param timestamp timestamp in the timebase of the given stream
743 int av_add_index_entry(AVStream *st,
744 int64_t pos, int64_t timestamp, int size, int distance, int flags);
747 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
748 * This is not supposed to be called directly by a user application, but by demuxers.
749 * @param target_ts target timestamp in the time base of the given stream
750 * @param stream_index stream number
752 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
755 * Updates cur_dts of all streams based on given timestamp and AVStream.
757 * Stream ref_st unchanged, others set cur_dts in their native timebase
758 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
759 * @param timestamp new dts expressed in time_base of param ref_st
760 * @param ref_st reference stream giving time_base of param timestamp
762 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
765 * Does a binary search using read_timestamp().
766 * This is not supposed to be called directly by a user application, but by demuxers.
767 * @param target_ts target timestamp in the time base of the given stream
768 * @param stream_index stream number
770 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 ));
772 /** media file output */
773 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
776 * Allocate the stream private data and write the stream header to an
779 * @param s media file handle
780 * @return 0 if OK. AVERROR_xxx if error.
782 int av_write_header(AVFormatContext *s);
785 * Write a packet to an output media file.
787 * The packet shall contain one audio or video frame.
788 * The packet must be correctly interleaved according to the container specification,
789 * if not then av_interleaved_write_frame must be used
791 * @param s media file handle
792 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
793 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
795 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
798 * Writes a packet to an output media file ensuring correct interleaving.
800 * The packet must contain one audio or video frame.
801 * If the packets are already correctly interleaved the application should
802 * call av_write_frame() instead as it is slightly faster. It is also important
803 * to keep in mind that completely non-interleaved input will need huge amounts
804 * of memory to interleave with this, so it is preferable to interleave at the
807 * @param s media file handle
808 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
809 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
811 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
814 * Interleave a packet per DTS in an output media file.
816 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
817 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
819 * @param s media file handle
820 * @param out the interleaved packet will be output here
821 * @param in the input packet
822 * @param flush 1 if no further packets are available as input and all
823 * remaining packets should be output
824 * @return 1 if a packet was output, 0 if no packet could be output,
825 * < 0 if an error occured
827 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
830 * @brief Write the stream trailer to an output media file and
831 * free the file private data.
833 * @param s media file handle
834 * @return 0 if OK. AVERROR_xxx if error.
836 int av_write_trailer(AVFormatContext *s);
838 void dump_format(AVFormatContext *ic,
844 * parses width and height out of string str.
845 * @deprecated Use av_parse_video_frame_size instead.
847 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
850 * Converts frame rate from string to a fraction.
851 * @deprecated Use av_parse_video_frame_rate instead.
853 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
856 * Parses \p datestr and returns a corresponding number of microseconds.
857 * @param datestr String representing a date or a duration.
858 * - If a date the syntax is:
860 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
862 * Time is localtime unless Z is appended, in which case it is
863 * interpreted as UTC.
864 * If the year-month-day part isn't specified it takes the current
866 * Returns the number of microseconds since 1st of January, 1970 up to
867 * the time of the parsed date or INT64_MIN if \p datestr cannot be
868 * successfully parsed.
869 * - If a duration the syntax is:
871 * [-]HH[:MM[:SS[.m...]]]
874 * Returns the number of microseconds contained in a time interval
875 * with the specified duration or INT64_MIN if \p datestr cannot be
876 * successfully parsed.
877 * @param duration Flag which tells how to interpret \p datestr, if
878 * not zero \p datestr is interpreted as a duration, otherwise as a
881 int64_t parse_date(const char *datestr, int duration);
883 int64_t av_gettime(void);
885 /* ffm specific for ffserver */
886 #define FFM_PACKET_SIZE 4096
887 offset_t ffm_read_write_index(int fd);
888 void ffm_write_write_index(int fd, offset_t pos);
889 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
892 * Attempts to find a specific tag in a URL.
894 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
897 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
900 * Returns in 'buf' the path with '%d' replaced by number.
902 * Also handles the '%0nd' format where 'n' is the total number
903 * of digits and '%%'.
905 * @param buf destination buffer
906 * @param buf_size destination buffer size
907 * @param path numbered sequence string
908 * @param number frame number
909 * @return 0 if OK, -1 if format error.
911 int av_get_frame_filename(char *buf, int buf_size,
912 const char *path, int number);
915 * Check whether filename actually is a numbered sequence generator.
917 * @param filename possible numbered sequence string
918 * @return 1 if a valid numbered sequence string, 0 otherwise.
920 int av_filename_number_test(const char *filename);
923 * Generate an SDP for an RTP session.
925 * @param ac array of AVFormatContexts describing the RTP streams. If the
926 * array is composed by only one context, such context can contain
927 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
928 * all the contexts in the array (an AVCodecContext per RTP stream)
929 * must contain only one AVStream
930 * @param n_files number of AVCodecContexts contained in ac
931 * @param buff buffer where the SDP will be stored (must be allocated by
933 * @param size the size of the buffer
934 * @return 0 if OK. AVERROR_xxx if error.
936 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
938 #ifdef HAVE_AV_CONFIG_H
940 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
943 #define dynarray_add(tab, nb_ptr, elem)\
945 typeof(tab) _tab = (tab);\
946 typeof(elem) _elem = (elem);\
947 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
948 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
951 #define dynarray_add(tab, nb_ptr, elem)\
953 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
957 time_t mktimegm(struct tm *tm);
958 struct tm *brktimegm(time_t secs, struct tm *tm);
959 const char *small_strptime(const char *p, const char *fmt,
963 int resolve_host(struct in_addr *sin_addr, const char *hostname);
965 void url_split(char *proto, int proto_size,
966 char *authorization, int authorization_size,
967 char *hostname, int hostname_size,
969 char *path, int path_size,
972 int match_ext(const char *filename, const char *extensions);
974 #endif /* HAVE_AV_CONFIG_H */
976 #endif /* FFMPEG_AVFORMAT_H */