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 ((51<<16)+(17<<8)+0)
25 #define LIBAVFORMAT_VERSION 51.17.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 #if LIBAVFORMAT_VERSION_INT < (52<<16)
140 const char *device; /**< video, audio or DV device */
142 const char *standard; /**< tv standard, NTSC, PAL, SECAM */
143 int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
144 int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
145 stream packet (only meaningful if
146 mpeg2ts_raw is TRUE) */
147 int initial_pause:1; /**< do not begin to play the stream
148 immediately (RTSP only) */
149 int prealloced_context:1;
150 enum CodecID video_codec_id;
151 enum CodecID audio_codec_id;
152 } AVFormatParameters;
154 //! demuxer will use url_fopen, no opened file should be provided by the caller
155 #define AVFMT_NOFILE 0x0001
156 #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
157 #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
158 #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
160 #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
161 #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
162 #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
164 typedef struct AVOutputFormat {
166 const char *long_name;
167 const char *mime_type;
168 const char *extensions; /**< comma separated filename extensions */
169 /** size of private data so that it can be allocated in the wrapper */
172 enum CodecID audio_codec; /**< default audio codec */
173 enum CodecID video_codec; /**< default video codec */
174 int (*write_header)(struct AVFormatContext *);
175 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
176 int (*write_trailer)(struct AVFormatContext *);
177 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
179 /** currently only used to set pixel format if not YUV420P */
180 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
181 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
184 * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
185 * the arrays are all CODEC_ID_NONE terminated
187 const struct AVCodecTag **codec_tag;
189 enum CodecID subtitle_codec; /**< default subtitle codec */
192 struct AVOutputFormat *next;
195 typedef struct AVInputFormat {
197 const char *long_name;
198 /** size of private data so that it can be allocated in the wrapper */
201 * tell if a given file has a chance of being parsed by this format.
202 * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
203 * so you dont have to check for that unless you need more.
205 int (*read_probe)(AVProbeData *);
206 /** read the format header and initialize the AVFormatContext
207 structure. Return 0 if OK. 'ap' if non NULL contains
208 additional paramters. Only used in raw format right
209 now. 'av_new_stream' should be called to create new streams. */
210 int (*read_header)(struct AVFormatContext *,
211 AVFormatParameters *ap);
212 /** read one packet and put it in 'pkt'. pts and flags are also
213 set. 'av_new_stream' can be called only if the flag
214 AVFMTCTX_NOHEADER is used. */
215 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
216 /** close the stream. The AVFormatContext and AVStreams are not
217 freed by this function */
218 int (*read_close)(struct AVFormatContext *);
220 * seek to a given timestamp relative to the frames in
221 * stream component stream_index
222 * @param stream_index must not be -1
223 * @param flags selects which direction should be preferred if no exact
225 * @return >= 0 on success (but not necessarily the new offset)
227 int (*read_seek)(struct AVFormatContext *,
228 int stream_index, int64_t timestamp, int flags);
230 * gets the next timestamp in AV_TIME_BASE units.
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 */
273 typedef struct AVStream {
274 int index; /**< stream index in AVFormatContext */
275 int id; /**< format specific stream id */
276 AVCodecContext *codec; /**< codec context */
278 * real base frame rate of the stream.
279 * this is the lowest framerate with which all timestamps can be
280 * represented accurately (it is the least common multiple of all
281 * framerates in the stream), Note, this value is just a guess!
282 * for example if the timebase is 1/90000 and all frames have either
283 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
285 AVRational r_frame_rate;
288 /* internal data used in av_find_stream_info() */
290 #if LIBAVFORMAT_VERSION_INT < (52<<16)
291 int codec_info_nb_frames;
293 /** encoding: PTS generation when outputing stream */
297 * this is the fundamental unit of time (in seconds) in terms
298 * of which frame timestamps are represented. for fixed-fps content,
299 * timebase should be 1/framerate and timestamp increments should be
302 AVRational time_base;
303 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
304 /* ffmpeg.c private use */
305 int stream_copy; /**< if set, just copy stream */
306 enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
307 //FIXME move stuff to a flags field?
308 /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
309 * MN: dunno if that is the right place for it */
312 * decoding: pts of the first frame of the stream, in stream time base.
313 * only set this if you are absolutely 100% sure that the value you set
314 * it to really is the pts of the first frame
315 * This may be undefined (AV_NOPTS_VALUE).
316 * @note the ASF header does NOT contain a correct start_time the ASF
317 * demuxer must NOT set this
321 * decoding: duration of the stream, in stream time base.
322 * If a source file does not specify a duration, but does specify
323 * a bitrate, this value will be estimates from bit rate and file size.
327 char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
329 /* av_read_frame() support */
330 enum AVStreamParseType need_parsing;
331 struct AVCodecParserContext *parser;
334 int last_IP_duration;
336 /* av_seek_frame() support */
337 AVIndexEntry *index_entries; /**< only used if the format does not
338 support seeking natively */
339 int nb_index_entries;
340 unsigned int index_entries_allocated_size;
342 int64_t nb_frames; ///< number of frames in this stream if known or 0
344 #define MAX_REORDER_DELAY 4
345 int64_t pts_buffer[MAX_REORDER_DELAY+1];
348 #define AV_PROGRAM_RUNNING 1
350 typedef struct AVProgram {
352 char *provider_name; ///< Network name for DVB streams
353 char *name; ///< Service name for DVB streams
355 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
356 unsigned int *stream_index;
357 unsigned int nb_stream_indexes;
360 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
361 (streams are added dynamically) */
363 #define MAX_STREAMS 20
365 /* format I/O context */
366 typedef struct AVFormatContext {
367 const AVClass *av_class; /**< set by av_alloc_format_context */
368 /* can only be iformat or oformat, not both at the same time */
369 struct AVInputFormat *iformat;
370 struct AVOutputFormat *oformat;
373 unsigned int nb_streams;
374 AVStream *streams[MAX_STREAMS];
375 char filename[1024]; /**< input or output filename */
383 int year; /**< ID3 year, 0 if none */
384 int track; /**< track number, 0 if none */
385 char genre[32]; /**< ID3 genre */
387 int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
388 /* private data for pts handling (do not modify directly) */
389 /** This buffer is only needed when packets were already buffered but
390 not decoded, for example to get the codec parameters in mpeg
392 struct AVPacketList *packet_buffer;
394 /** decoding: position of the first frame of the component, in
395 AV_TIME_BASE fractional seconds. NEVER set this value directly:
396 it is deduced from the AVStream values. */
398 /** decoding: duration of the stream, in AV_TIME_BASE fractional
399 seconds. NEVER set this value directly: it is deduced from the
402 /** decoding: total file size. 0 if unknown */
404 /** decoding: total stream bitrate in bit/s, 0 if not
405 available. Never set it directly if the file_size and the
406 duration are known as ffmpeg can compute it automatically. */
409 /* av_read_frame() support */
411 const uint8_t *cur_ptr;
415 /* av_seek_frame() support */
416 int64_t data_offset; /** offset of the first packet */
424 #define AVFMT_NOOUTPUTLOOP -1
425 #define AVFMT_INFINITEOUTPUTLOOP 0
426 /** number of times to loop output in formats that support it */
430 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
431 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
432 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
435 /** decoding: size of data to probe; encoding unused */
436 unsigned int probesize;
439 * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
441 int max_analyze_duration;
446 unsigned int nb_programs;
447 AVProgram **programs;
450 typedef struct AVPacketList {
452 struct AVPacketList *next;
455 extern AVInputFormat *first_iformat;
456 extern AVOutputFormat *first_oformat;
458 enum CodecID av_guess_image2_codec(const char *filename);
460 /* XXX: use automatic init with either ELF sections or C file parser */
468 void av_register_input_format(AVInputFormat *format);
469 void av_register_output_format(AVOutputFormat *format);
470 AVOutputFormat *guess_stream_format(const char *short_name,
471 const char *filename, const char *mime_type);
472 AVOutputFormat *guess_format(const char *short_name,
473 const char *filename, const char *mime_type);
476 * Guesses the codec id based upon muxer and filename.
478 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
479 const char *filename, const char *mime_type, enum CodecType type);
482 * Send a nice hexadecimal dump of a buffer to the specified file stream.
484 * @param f The file stream pointer where the dump should be sent to.
486 * @param size buffer size
488 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
490 void av_hex_dump(FILE *f, uint8_t *buf, int size);
493 * Send a nice hexadecimal dump of a buffer to the log.
495 * @param avcl A pointer to an arbitrary struct of which the first field is a
496 * pointer to an AVClass struct.
497 * @param level The importance level of the message, lower values signifying
500 * @param size buffer size
502 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
504 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
507 * Send a nice dump of a packet to the specified file stream.
509 * @param f The file stream pointer where the dump should be sent to.
510 * @param pkt packet to dump
511 * @param dump_payload true if the payload must be displayed too
513 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
516 * Send a nice dump of a packet to the log.
518 * @param avcl A pointer to an arbitrary struct of which the first field is a
519 * pointer to an AVClass struct.
520 * @param level The importance level of the message, lower values signifying
522 * @param pkt packet to dump
523 * @param dump_payload true if the payload must be displayed too
525 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
527 void av_register_all(void);
529 /** codec tag <-> codec id */
530 enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
531 unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
533 /* media file input */
536 * finds AVInputFormat based on input format's short name.
538 AVInputFormat *av_find_input_format(const char *short_name);
543 * @param is_opened whether the file is already opened, determines whether
544 * demuxers with or without AVFMT_NOFILE are probed
546 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
549 * Allocates all the structures needed to read an input stream.
550 * This does not open the needed codecs for decoding the stream[s].
552 int av_open_input_stream(AVFormatContext **ic_ptr,
553 ByteIOContext *pb, const char *filename,
554 AVInputFormat *fmt, AVFormatParameters *ap);
557 * Open a media file as input. The codecs are not opened. Only the file
558 * header (if present) is read.
560 * @param ic_ptr the opened media file handle is put here
561 * @param filename filename to open.
562 * @param fmt if non NULL, force the file format to use
563 * @param buf_size optional buffer size (zero if default is OK)
564 * @param ap additional parameters needed when opening the file (NULL if default)
565 * @return 0 if OK. AVERROR_xxx otherwise.
567 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
570 AVFormatParameters *ap);
571 /** no av_open for output, so applications will need this: */
572 AVFormatContext *av_alloc_format_context(void);
575 * Read packets of a media file to get stream information. This
576 * is useful for file formats with no headers such as MPEG. This
577 * function also computes the real frame rate in case of mpeg2 repeat
579 * The logical file position is not changed by this function;
580 * examined packets may be buffered for later processing.
582 * @param ic media file handle
583 * @return >=0 if OK. AVERROR_xxx if error.
584 * @todo Let user decide somehow what information is needed so we do not waste time geting stuff the user does not need.
586 int av_find_stream_info(AVFormatContext *ic);
589 * Read a transport packet from a media file.
591 * This function is obsolete and should never be used.
592 * Use av_read_frame() instead.
594 * @param s media file handle
595 * @param pkt is filled
596 * @return 0 if OK. AVERROR_xxx if error.
598 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
601 * Return the next frame of a stream.
603 * The returned packet is valid
604 * until the next av_read_frame() or until av_close_input_file() and
605 * must be freed with av_free_packet. For video, the packet contains
606 * exactly one frame. For audio, it contains an integer number of
607 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
608 * data). If the audio frames have a variable size (e.g. MPEG audio),
609 * then it contains one frame.
611 * pkt->pts, pkt->dts and pkt->duration are always set to correct
612 * values in AVStream.timebase units (and guessed if the format cannot
613 * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
614 * has B frames, so it is better to rely on pkt->dts if you do not
615 * decompress the payload.
617 * @return 0 if OK, < 0 if error or end of file.
619 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
622 * Seek to the key frame at timestamp.
623 * 'timestamp' in 'stream_index'.
624 * @param stream_index If stream_index is (-1), a default
625 * stream is selected, and timestamp is automatically converted
626 * from AV_TIME_BASE units to the stream specific time_base.
627 * @param timestamp timestamp in AVStream.time_base units
628 * or if there is no stream specified then in AV_TIME_BASE units
629 * @param flags flags which select direction and seeking mode
630 * @return >= 0 on success
632 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
635 * start playing a network based stream (e.g. RTSP stream) at the
638 int av_read_play(AVFormatContext *s);
641 * Pause a network based stream (e.g. RTSP stream).
643 * Use av_read_play() to resume it.
645 int av_read_pause(AVFormatContext *s);
648 * Close a media file (but not its codecs).
650 * @param s media file handle
652 void av_close_input_file(AVFormatContext *s);
655 * Add a new stream to a media file.
657 * Can only be called in the read_header() function. If the flag
658 * AVFMTCTX_NOHEADER is in the format context, then new streams
659 * can be added in read_packet too.
661 * @param s media file handle
662 * @param id file format dependent stream id
664 AVStream *av_new_stream(AVFormatContext *s, int id);
665 AVProgram *av_new_program(AVFormatContext *s, int id);
668 * Set the pts for a given stream.
671 * @param pts_wrap_bits number of bits effectively used by the pts
672 * (used for wrap control, 33 is the value for MPEG)
673 * @param pts_num numerator to convert to seconds (MPEG: 1)
674 * @param pts_den denominator to convert to seconds (MPEG: 90000)
676 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
677 int pts_num, int pts_den);
679 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
680 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
681 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
683 int av_find_default_stream_index(AVFormatContext *s);
686 * Gets the index for a specific timestamp.
687 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
688 * the timestamp which is <= the requested one, if backward is 0
690 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
691 * @return < 0 if no such timestamp could be found
693 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
696 * Add a index entry into a sorted list updateing if it is already there.
698 * @param timestamp timestamp in the timebase of the given stream
700 int av_add_index_entry(AVStream *st,
701 int64_t pos, int64_t timestamp, int size, int distance, int flags);
704 * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
705 * This is not supposed to be called directly by a user application, but by demuxers.
706 * @param target_ts target timestamp in the time base of the given stream
707 * @param stream_index stream number
709 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
712 * Updates cur_dts of all streams based on given timestamp and AVStream.
714 * Stream ref_st unchanged, others set cur_dts in their native timebase
715 * only needed for timestamp wrapping or if (dts not set and pts!=dts).
716 * @param timestamp new dts expressed in time_base of param ref_st
717 * @param ref_st reference stream giving time_base of param timestamp
719 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
722 * Does a binary search using read_timestamp().
723 * This is not supposed to be called directly by a user application, but by demuxers.
724 * @param target_ts target timestamp in the time base of the given stream
725 * @param stream_index stream number
727 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 ));
729 /** media file output */
730 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
733 * Allocate the stream private data and write the stream header to an
736 * @param s media file handle
737 * @return 0 if OK. AVERROR_xxx if error.
739 int av_write_header(AVFormatContext *s);
742 * Write a packet to an output media file.
744 * The packet shall contain one audio or video frame.
745 * The packet must be correctly interleaved according to the container specification,
746 * if not then av_interleaved_write_frame must be used
748 * @param s media file handle
749 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
750 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
752 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
755 * Writes a packet to an output media file ensuring correct interleaving.
757 * The packet must contain one audio or video frame.
758 * If the packets are already correctly interleaved the application should
759 * call av_write_frame() instead as it is slightly faster. It is also important
760 * to keep in mind that completely non-interleaved input will need huge amounts
761 * of memory to interleave with this, so it is preferable to interleave at the
764 * @param s media file handle
765 * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
766 * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
768 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
771 * Interleave a packet per DTS in an output media file.
773 * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
774 * so they cannot be used after it, note calling av_free_packet() on them is still safe.
776 * @param s media file handle
777 * @param out the interleaved packet will be output here
778 * @param in the input packet
779 * @param flush 1 if no further packets are available as input and all
780 * remaining packets should be output
781 * @return 1 if a packet was output, 0 if no packet could be output,
782 * < 0 if an error occured
784 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
787 * @brief Write the stream trailer to an output media file and
788 * free the file private data.
790 * @param s media file handle
791 * @return 0 if OK. AVERROR_xxx if error.
793 int av_write_trailer(AVFormatContext *s);
795 void dump_format(AVFormatContext *ic,
801 * parses width and height out of string str.
802 * @deprecated Use av_parse_video_frame_size instead.
804 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
807 * Converts frame rate from string to a fraction.
808 * @deprecated Use av_parse_video_frame_rate instead.
810 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
813 * Parses \p datestr and returns a corresponding number of microseconds.
814 * @param datestr String representing a date or a duration.
815 * - If a date the syntax is:
817 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
819 * Time is localtime unless Z is appended, in which case it is
820 * interpreted as UTC.
821 * If the year-month-day part isn't specified it takes the current
823 * Returns the number of microseconds since 1st of January, 1970 up to
824 * the time of the parsed date or INT64_MIN if \p datestr cannot be
825 * successfully parsed.
826 * - If a duration the syntax is:
828 * [-]HH[:MM[:SS[.m...]]]
831 * Returns the number of microseconds contained in a time interval
832 * with the specified duration or INT64_MIN if \p datestr cannot be
833 * succesfully parsed.
834 * @param duration Flag which tells how to interpret \p datestr, if
835 * not zero \p datestr is interpreted as a duration, otherwise as a
838 int64_t parse_date(const char *datestr, int duration);
840 int64_t av_gettime(void);
842 /* ffm specific for ffserver */
843 #define FFM_PACKET_SIZE 4096
844 offset_t ffm_read_write_index(int fd);
845 void ffm_write_write_index(int fd, offset_t pos);
846 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
849 * Attempts to find a specific tag in a URL.
851 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
854 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
857 * Returns in 'buf' the path with '%d' replaced by number.
859 * Also handles the '%0nd' format where 'n' is the total number
860 * of digits and '%%'.
862 * @param buf destination buffer
863 * @param buf_size destination buffer size
864 * @param path numbered sequence string
865 * @number frame number
866 * @return 0 if OK, -1 if format error.
868 int av_get_frame_filename(char *buf, int buf_size,
869 const char *path, int number);
872 * Check whether filename actually is a numbered sequence generator.
874 * @param filename possible numbered sequence string
875 * @return 1 if a valid numbered sequence string, 0 otherwise.
877 int av_filename_number_test(const char *filename);
880 * Generate an SDP for an RTP session.
882 * @param ac array of AVFormatContexts describing the RTP streams. If the
883 * array is composed by only one context, such context can contain
884 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
885 * all the contexts in the array (an AVCodecContext per RTP stream)
886 * must contain only one AVStream
887 * @param n_files number of AVCodecContexts contained in ac
888 * @param buff buffer where the SDP will be stored (must be allocated by
890 * @param size the size of the buffer
891 * @return 0 if OK. AVERROR_xxx if error.
893 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
895 #ifdef HAVE_AV_CONFIG_H
897 #include "os_support.h"
899 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
902 #define dynarray_add(tab, nb_ptr, elem)\
904 typeof(tab) _tab = (tab);\
905 typeof(elem) _elem = (elem);\
906 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
907 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
910 #define dynarray_add(tab, nb_ptr, elem)\
912 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
916 time_t mktimegm(struct tm *tm);
917 struct tm *brktimegm(time_t secs, struct tm *tm);
918 const char *small_strptime(const char *p, const char *fmt,
922 int resolve_host(struct in_addr *sin_addr, const char *hostname);
924 void url_split(char *proto, int proto_size,
925 char *authorization, int authorization_size,
926 char *hostname, int hostname_size,
928 char *path, int path_size,
931 int match_ext(const char *filename, const char *extensions);
933 #endif /* HAVE_AV_CONFIG_H */
935 #endif /* FFMPEG_AVFORMAT_H */