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
28 #define LIBAVFORMAT_VERSION_INT ((51<<16)+(6<<8)+0)
29 #define LIBAVFORMAT_VERSION 51.6.0
30 #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
32 #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
35 #include <stdio.h> /* FILE */
40 /* packet functions */
42 typedef struct AVPacket {
43 int64_t pts; ///< presentation time stamp in time_base units
44 int64_t dts; ///< decompression time stamp in time_base units
49 int duration; ///< presentation duration in time_base units (0 if not available)
50 void (*destruct)(struct AVPacket *);
52 int64_t pos; ///< byte position in stream, -1 if unknown
54 #define PKT_FLAG_KEY 0x0001
56 void av_destruct_packet_nofree(AVPacket *pkt);
57 void av_destruct_packet(AVPacket *pkt);
59 /* initialize optional fields of a packet */
60 static inline void av_init_packet(AVPacket *pkt)
62 pkt->pts = AV_NOPTS_VALUE;
63 pkt->dts = AV_NOPTS_VALUE;
67 pkt->stream_index = 0;
68 pkt->destruct= av_destruct_packet_nofree;
71 int av_new_packet(AVPacket *pkt, int size);
72 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
73 int av_dup_packet(AVPacket *pkt);
78 * @param pkt packet to free
80 static inline void av_free_packet(AVPacket *pkt)
82 if (pkt && pkt->destruct) {
87 /*************************************************/
88 /* fractional numbers for exact pts handling */
90 /* the exact value of the fractional number is: 'val + num / den'. num
91 is assumed to be such as 0 <= num < den */
92 typedef struct AVFrac {
93 int64_t val, num, den;
94 } AVFrac attribute_deprecated;
96 /*************************************************/
97 /* input/output formats */
99 struct AVFormatContext;
101 /* this structure contains the data a format has to probe a file */
102 typedef struct AVProbeData {
103 const char *filename;
108 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
110 typedef struct AVFormatParameters {
111 AVRational time_base;
116 enum PixelFormat pix_fmt;
117 int channel; /* used to select dv channel */
118 const char *device; /* video, audio or DV device */
119 const char *standard; /* tv standard, NTSC, PAL, SECAM */
120 int mpeg2ts_raw:1; /* force raw MPEG2 transport stream output, if possible */
121 int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
122 stream packet (only meaningful if
123 mpeg2ts_raw is TRUE */
124 int initial_pause:1; /* do not begin to play the stream
125 immediately (RTSP only) */
126 int prealloced_context:1;
127 enum CodecID video_codec_id;
128 enum CodecID audio_codec_id;
129 } AVFormatParameters;
131 #define AVFMT_NOFILE 0x0001 /* no file should be opened */
132 #define AVFMT_NEEDNUMBER 0x0002 /* needs '%d' in filename */
133 #define AVFMT_SHOW_IDS 0x0008 /* show format stream IDs numbers */
134 #define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
136 #define AVFMT_GLOBALHEADER 0x0040 /* format wants global header */
137 #define AVFMT_NOTIMESTAMPS 0x0080 /* format doesnt need / has any timestamps */
139 typedef struct AVOutputFormat {
141 const char *long_name;
142 const char *mime_type;
143 const char *extensions; /* comma separated extensions */
144 /* size of private data so that it can be allocated in the wrapper */
147 enum CodecID audio_codec; /* default audio codec */
148 enum CodecID video_codec; /* default video codec */
149 int (*write_header)(struct AVFormatContext *);
150 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
151 int (*write_trailer)(struct AVFormatContext *);
152 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
154 /* currently only used to set pixel format if not YUV420P */
155 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
156 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
158 struct AVOutputFormat *next;
161 typedef struct AVInputFormat {
163 const char *long_name;
164 /* size of private data so that it can be allocated in the wrapper */
166 /* tell if a given file has a chance of being parsing by this format */
167 int (*read_probe)(AVProbeData *);
168 /* read the format header and initialize the AVFormatContext
169 structure. Return 0 if OK. 'ap' if non NULL contains
170 additionnal paramters. Only used in raw format right
171 now. 'av_new_stream' should be called to create new streams. */
172 int (*read_header)(struct AVFormatContext *,
173 AVFormatParameters *ap);
174 /* read one packet and put it in 'pkt'. pts and flags are also
175 set. 'av_new_stream' can be called only if the flag
176 AVFMTCTX_NOHEADER is used. */
177 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
178 /* close the stream. The AVFormatContext and AVStreams are not
179 freed by this function */
180 int (*read_close)(struct AVFormatContext *);
182 * seek to a given timestamp relative to the frames in
183 * stream component stream_index
184 * @param stream_index must not be -1
185 * @param flags selects which direction should be preferred if no exact
188 int (*read_seek)(struct AVFormatContext *,
189 int stream_index, int64_t timestamp, int flags);
191 * gets the next timestamp in AV_TIME_BASE units.
193 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
194 int64_t *pos, int64_t pos_limit);
195 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
197 /* if extensions are defined, then no probe is done. You should
198 usually not use extension format guessing because it is not
200 const char *extensions;
201 /* general purpose read only value that the format can use */
204 /* start/resume playing - only meaningful if using a network based format
206 int (*read_play)(struct AVFormatContext *);
208 /* pause playing - only meaningful if using a network based format
210 int (*read_pause)(struct AVFormatContext *);
213 struct AVInputFormat *next;
216 typedef struct AVIndexEntry {
219 #define AVINDEX_KEYFRAME 0x0001
221 int size:30; //yeah trying to keep the size of this small to reduce memory requirements (its 24 vs 32 byte due to possible 8byte align)
222 int min_distance; /* min distance between this and the previous keyframe, used to avoid unneeded searching */
225 typedef struct AVStream {
226 int index; /* stream index in AVFormatContext */
227 int id; /* format specific stream id */
228 AVCodecContext *codec; /* codec context */
230 * real base frame rate of the stream.
231 * this is the lowest framerate with which all timestamps can be
232 * represented accurately (its the least common multiple of all
233 * framerates in the stream), Note, this value is just a guess!
234 * for example if the timebase is 1/90000 and all frames have either
235 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
237 AVRational r_frame_rate;
239 /* internal data used in av_find_stream_info() */
240 int64_t codec_info_duration;
241 int codec_info_nb_frames;
242 /* encoding: PTS generation when outputing stream */
246 * this is the fundamental unit of time (in seconds) in terms
247 * of which frame timestamps are represented. for fixed-fps content,
248 * timebase should be 1/framerate and timestamp increments should be
251 AVRational time_base;
252 int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
253 /* ffmpeg.c private use */
254 int stream_copy; /* if TRUE, just copy stream */
255 enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
256 //FIXME move stuff to a flags field?
257 /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
258 * MN:dunno if thats the right place, for it */
260 /* decoding: position of the first frame of the component, in
261 AV_TIME_BASE fractional seconds. */
263 /* decoding: duration of the stream, in AV_TIME_BASE fractional
267 char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
269 /* av_read_frame() support */
270 int need_parsing; ///< 1->full parsing needed, 2->only parse headers dont repack
271 struct AVCodecParserContext *parser;
274 int last_IP_duration;
276 /* av_seek_frame() support */
277 AVIndexEntry *index_entries; /* only used if the format does not
278 support seeking natively */
279 int nb_index_entries;
280 unsigned int index_entries_allocated_size;
282 int64_t nb_frames; ///< number of frames in this stream if known or 0
284 #define MAX_REORDER_DELAY 4
285 int64_t pts_buffer[MAX_REORDER_DELAY+1];
288 #define AVFMTCTX_NOHEADER 0x0001 /* signal that no header is present
289 (streams are added dynamically) */
291 #define MAX_STREAMS 20
293 /* format I/O context */
294 typedef struct AVFormatContext {
295 const AVClass *av_class; /* set by av_alloc_format_context */
296 /* can only be iformat or oformat, not both at the same time */
297 struct AVInputFormat *iformat;
298 struct AVOutputFormat *oformat;
302 AVStream *streams[MAX_STREAMS];
303 char filename[1024]; /* input or output filename */
311 int year; /* ID3 year, 0 if none */
312 int track; /* track number, 0 if none */
313 char genre[32]; /* ID3 genre */
315 int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
316 /* private data for pts handling (do not modify directly) */
317 /* This buffer is only needed when packets were already buffered but
318 not decoded, for example to get the codec parameters in mpeg
320 struct AVPacketList *packet_buffer;
322 /* decoding: position of the first frame of the component, in
323 AV_TIME_BASE fractional seconds. NEVER set this value directly:
324 it is deduced from the AVStream values. */
326 /* decoding: duration of the stream, in AV_TIME_BASE fractional
327 seconds. NEVER set this value directly: it is deduced from the
330 /* decoding: total file size. 0 if unknown */
332 /* decoding: total stream bitrate in bit/s, 0 if not
333 available. Never set it directly if the file_size and the
334 duration are known as ffmpeg can compute it automatically. */
337 /* av_read_frame() support */
339 const uint8_t *cur_ptr;
343 /* av_seek_frame() support */
344 int64_t data_offset; /* offset of the first packet */
352 #define AVFMT_NOOUTPUTLOOP -1
353 #define AVFMT_INFINITEOUTPUTLOOP 0
354 /* number of times to loop output in formats that support it */
358 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
359 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
362 /* decoding: size of data to probe; encoding unused */
363 unsigned int probesize;
366 typedef struct AVPacketList {
368 struct AVPacketList *next;
371 extern AVInputFormat *first_iformat;
372 extern AVOutputFormat *first_oformat;
374 enum CodecID av_guess_image2_codec(const char *filename);
376 /* XXX: use automatic init with either ELF sections or C file parser */
384 void av_register_input_format(AVInputFormat *format);
385 void av_register_output_format(AVOutputFormat *format);
386 AVOutputFormat *guess_stream_format(const char *short_name,
387 const char *filename, const char *mime_type);
388 AVOutputFormat *guess_format(const char *short_name,
389 const char *filename, const char *mime_type);
390 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
391 const char *filename, const char *mime_type, enum CodecType type);
393 void av_hex_dump(FILE *f, uint8_t *buf, int size);
394 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
396 void av_register_all(void);
398 /* media file input */
399 AVInputFormat *av_find_input_format(const char *short_name);
400 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
401 int av_open_input_stream(AVFormatContext **ic_ptr,
402 ByteIOContext *pb, const char *filename,
403 AVInputFormat *fmt, AVFormatParameters *ap);
404 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
407 AVFormatParameters *ap);
408 /* no av_open for output, so applications will need this: */
409 AVFormatContext *av_alloc_format_context(void);
411 #define AVERROR_UNKNOWN (-1) /* unknown error */
412 #define AVERROR_IO (-2) /* i/o error */
413 #define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
414 #define AVERROR_INVALIDDATA (-4) /* invalid data found */
415 #define AVERROR_NOMEM (-5) /* not enough memory */
416 #define AVERROR_NOFMT (-6) /* unknown format */
417 #define AVERROR_NOTSUPP (-7) /* operation not supported */
419 int av_find_stream_info(AVFormatContext *ic);
420 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
421 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
422 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
423 int av_read_play(AVFormatContext *s);
424 int av_read_pause(AVFormatContext *s);
425 void av_close_input_file(AVFormatContext *s);
426 AVStream *av_new_stream(AVFormatContext *s, int id);
427 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
428 int pts_num, int pts_den);
430 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
431 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
432 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
434 int av_find_default_stream_index(AVFormatContext *s);
435 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
436 int av_add_index_entry(AVStream *st,
437 int64_t pos, int64_t timestamp, int size, int distance, int flags);
438 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
439 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
440 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 ));
442 /* media file output */
443 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
444 int av_write_header(AVFormatContext *s);
445 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
446 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
447 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
449 int av_write_trailer(AVFormatContext *s);
451 void dump_format(AVFormatContext *ic,
455 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
456 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
457 int64_t parse_date(const char *datestr, int duration);
459 int64_t av_gettime(void);
461 /* ffm specific for ffserver */
462 #define FFM_PACKET_SIZE 4096
463 offset_t ffm_read_write_index(int fd);
464 void ffm_write_write_index(int fd, offset_t pos);
465 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
467 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
469 int av_get_frame_filename(char *buf, int buf_size,
470 const char *path, int number);
471 int av_filename_number_test(const char *filename);
474 int video_grab_init(void);
475 int audio_init(void);
478 int dv1394_init(void);
479 int dc1394_init(void);
481 #ifdef HAVE_AV_CONFIG_H
483 #include "os_support.h"
485 int strstart(const char *str, const char *val, const char **ptr);
486 int stristart(const char *str, const char *val, const char **ptr);
487 void pstrcpy(char *buf, int buf_size, const char *str);
488 char *pstrcat(char *buf, int buf_size, const char *s);
490 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
493 #define dynarray_add(tab, nb_ptr, elem)\
495 typeof(tab) _tab = (tab);\
496 typeof(elem) _elem = (elem);\
497 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
498 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
501 #define dynarray_add(tab, nb_ptr, elem)\
503 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
507 time_t mktimegm(struct tm *tm);
508 struct tm *brktimegm(time_t secs, struct tm *tm);
509 const char *small_strptime(const char *p, const char *fmt,
513 int resolve_host(struct in_addr *sin_addr, const char *hostname);
515 void url_split(char *proto, int proto_size,
516 char *authorization, int authorization_size,
517 char *hostname, int hostname_size,
519 char *path, int path_size,
522 int match_ext(const char *filename, const char *extensions);
524 #endif /* HAVE_AV_CONFIG_H */
530 #endif /* AVFORMAT_H */