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 */
43 #define MAXINT64 int64_t_C(0x7fffffffffffffff)
47 #define MININT64 int64_t_C(0x8000000000000000)
50 typedef struct AVPacket {
51 int64_t pts; ///< presentation time stamp in time_base units
52 int64_t dts; ///< decompression time stamp in time_base units
57 int duration; ///< presentation duration in time_base units (0 if not available)
58 void (*destruct)(struct AVPacket *);
60 int64_t pos; ///< byte position in stream, -1 if unknown
62 #define PKT_FLAG_KEY 0x0001
64 void av_destruct_packet_nofree(AVPacket *pkt);
65 void av_destruct_packet(AVPacket *pkt);
67 /* initialize optional fields of a packet */
68 static inline void av_init_packet(AVPacket *pkt)
70 pkt->pts = AV_NOPTS_VALUE;
71 pkt->dts = AV_NOPTS_VALUE;
75 pkt->stream_index = 0;
76 pkt->destruct= av_destruct_packet_nofree;
79 int av_new_packet(AVPacket *pkt, int size);
80 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
81 int av_dup_packet(AVPacket *pkt);
86 * @param pkt packet to free
88 static inline void av_free_packet(AVPacket *pkt)
90 if (pkt && pkt->destruct) {
95 /*************************************************/
96 /* fractional numbers for exact pts handling */
98 /* the exact value of the fractional number is: 'val + num / den'. num
99 is assumed to be such as 0 <= num < den */
100 typedef struct AVFrac {
101 int64_t val, num, den;
102 } AVFrac attribute_deprecated;
104 /*************************************************/
105 /* input/output formats */
107 struct AVFormatContext;
109 /* this structure contains the data a format has to probe a file */
110 typedef struct AVProbeData {
111 const char *filename;
116 #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
118 typedef struct AVFormatParameters {
119 AVRational time_base;
124 enum PixelFormat pix_fmt;
125 int channel; /* used to select dv channel */
126 const char *device; /* video, audio or DV device */
127 const char *standard; /* tv standard, NTSC, PAL, SECAM */
128 int mpeg2ts_raw:1; /* force raw MPEG2 transport stream output, if possible */
129 int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
130 stream packet (only meaningful if
131 mpeg2ts_raw is TRUE */
132 int initial_pause:1; /* do not begin to play the stream
133 immediately (RTSP only) */
134 int prealloced_context:1;
135 enum CodecID video_codec_id;
136 enum CodecID audio_codec_id;
137 } AVFormatParameters;
139 #define AVFMT_NOFILE 0x0001 /* no file should be opened */
140 #define AVFMT_NEEDNUMBER 0x0002 /* needs '%d' in filename */
141 #define AVFMT_SHOW_IDS 0x0008 /* show format stream IDs numbers */
142 #define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
144 #define AVFMT_GLOBALHEADER 0x0040 /* format wants global header */
145 #define AVFMT_NOTIMESTAMPS 0x0080 /* format doesnt need / has any timestamps */
147 typedef struct AVOutputFormat {
149 const char *long_name;
150 const char *mime_type;
151 const char *extensions; /* comma separated extensions */
152 /* size of private data so that it can be allocated in the wrapper */
155 enum CodecID audio_codec; /* default audio codec */
156 enum CodecID video_codec; /* default video codec */
157 int (*write_header)(struct AVFormatContext *);
158 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
159 int (*write_trailer)(struct AVFormatContext *);
160 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
162 /* currently only used to set pixel format if not YUV420P */
163 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
164 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
166 struct AVOutputFormat *next;
169 typedef struct AVInputFormat {
171 const char *long_name;
172 /* size of private data so that it can be allocated in the wrapper */
174 /* tell if a given file has a chance of being parsing by this format */
175 int (*read_probe)(AVProbeData *);
176 /* read the format header and initialize the AVFormatContext
177 structure. Return 0 if OK. 'ap' if non NULL contains
178 additionnal paramters. Only used in raw format right
179 now. 'av_new_stream' should be called to create new streams. */
180 int (*read_header)(struct AVFormatContext *,
181 AVFormatParameters *ap);
182 /* read one packet and put it in 'pkt'. pts and flags are also
183 set. 'av_new_stream' can be called only if the flag
184 AVFMTCTX_NOHEADER is used. */
185 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
186 /* close the stream. The AVFormatContext and AVStreams are not
187 freed by this function */
188 int (*read_close)(struct AVFormatContext *);
190 * seek to a given timestamp relative to the frames in
191 * stream component stream_index
192 * @param stream_index must not be -1
193 * @param flags selects which direction should be preferred if no exact
196 int (*read_seek)(struct AVFormatContext *,
197 int stream_index, int64_t timestamp, int flags);
199 * gets the next timestamp in AV_TIME_BASE units.
201 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
202 int64_t *pos, int64_t pos_limit);
203 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
205 /* if extensions are defined, then no probe is done. You should
206 usually not use extension format guessing because it is not
208 const char *extensions;
209 /* general purpose read only value that the format can use */
212 /* start/resume playing - only meaningful if using a network based format
214 int (*read_play)(struct AVFormatContext *);
216 /* pause playing - only meaningful if using a network based format
218 int (*read_pause)(struct AVFormatContext *);
221 struct AVInputFormat *next;
224 typedef struct AVIndexEntry {
227 #define AVINDEX_KEYFRAME 0x0001
229 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)
230 int min_distance; /* min distance between this and the previous keyframe, used to avoid unneeded searching */
233 typedef struct AVStream {
234 int index; /* stream index in AVFormatContext */
235 int id; /* format specific stream id */
236 AVCodecContext *codec; /* codec context */
238 * real base frame rate of the stream.
239 * this is the lowest framerate with which all timestamps can be
240 * represented accurately (its the least common multiple of all
241 * framerates in the stream), Note, this value is just a guess!
242 * for example if the timebase is 1/90000 and all frames have either
243 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
245 AVRational r_frame_rate;
247 /* internal data used in av_find_stream_info() */
248 int64_t codec_info_duration;
249 int codec_info_nb_frames;
250 /* encoding: PTS generation when outputing stream */
254 * this is the fundamental unit of time (in seconds) in terms
255 * of which frame timestamps are represented. for fixed-fps content,
256 * timebase should be 1/framerate and timestamp increments should be
259 AVRational time_base;
260 int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
261 /* ffmpeg.c private use */
262 int stream_copy; /* if TRUE, just copy stream */
263 enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
264 //FIXME move stuff to a flags field?
265 /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
266 * MN:dunno if thats the right place, for it */
268 /* decoding: position of the first frame of the component, in
269 AV_TIME_BASE fractional seconds. */
271 /* decoding: duration of the stream, in AV_TIME_BASE fractional
275 char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
277 /* av_read_frame() support */
278 int need_parsing; ///< 1->full parsing needed, 2->only parse headers dont repack
279 struct AVCodecParserContext *parser;
282 int last_IP_duration;
284 /* av_seek_frame() support */
285 AVIndexEntry *index_entries; /* only used if the format does not
286 support seeking natively */
287 int nb_index_entries;
288 unsigned int index_entries_allocated_size;
290 int64_t nb_frames; ///< number of frames in this stream if known or 0
292 #define MAX_REORDER_DELAY 4
293 int64_t pts_buffer[MAX_REORDER_DELAY+1];
296 #define AVFMTCTX_NOHEADER 0x0001 /* signal that no header is present
297 (streams are added dynamically) */
299 #define MAX_STREAMS 20
301 /* format I/O context */
302 typedef struct AVFormatContext {
303 const AVClass *av_class; /* set by av_alloc_format_context */
304 /* can only be iformat or oformat, not both at the same time */
305 struct AVInputFormat *iformat;
306 struct AVOutputFormat *oformat;
310 AVStream *streams[MAX_STREAMS];
311 char filename[1024]; /* input or output filename */
319 int year; /* ID3 year, 0 if none */
320 int track; /* track number, 0 if none */
321 char genre[32]; /* ID3 genre */
323 int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
324 /* private data for pts handling (do not modify directly) */
325 /* This buffer is only needed when packets were already buffered but
326 not decoded, for example to get the codec parameters in mpeg
328 struct AVPacketList *packet_buffer;
330 /* decoding: position of the first frame of the component, in
331 AV_TIME_BASE fractional seconds. NEVER set this value directly:
332 it is deduced from the AVStream values. */
334 /* decoding: duration of the stream, in AV_TIME_BASE fractional
335 seconds. NEVER set this value directly: it is deduced from the
338 /* decoding: total file size. 0 if unknown */
340 /* decoding: total stream bitrate in bit/s, 0 if not
341 available. Never set it directly if the file_size and the
342 duration are known as ffmpeg can compute it automatically. */
345 /* av_read_frame() support */
347 const uint8_t *cur_ptr;
351 /* av_seek_frame() support */
352 int64_t data_offset; /* offset of the first packet */
360 #define AVFMT_NOOUTPUTLOOP -1
361 #define AVFMT_INFINITEOUTPUTLOOP 0
362 /* number of times to loop output in formats that support it */
366 #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
367 #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
370 /* decoding: size of data to probe; encoding unused */
371 unsigned int probesize;
374 typedef struct AVPacketList {
376 struct AVPacketList *next;
379 extern AVInputFormat *first_iformat;
380 extern AVOutputFormat *first_oformat;
382 enum CodecID av_guess_image2_codec(const char *filename);
384 /* XXX: use automatic init with either ELF sections or C file parser */
392 void av_register_input_format(AVInputFormat *format);
393 void av_register_output_format(AVOutputFormat *format);
394 AVOutputFormat *guess_stream_format(const char *short_name,
395 const char *filename, const char *mime_type);
396 AVOutputFormat *guess_format(const char *short_name,
397 const char *filename, const char *mime_type);
398 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
399 const char *filename, const char *mime_type, enum CodecType type);
401 void av_hex_dump(FILE *f, uint8_t *buf, int size);
402 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
404 void av_register_all(void);
406 /* media file input */
407 AVInputFormat *av_find_input_format(const char *short_name);
408 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
409 int av_open_input_stream(AVFormatContext **ic_ptr,
410 ByteIOContext *pb, const char *filename,
411 AVInputFormat *fmt, AVFormatParameters *ap);
412 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
415 AVFormatParameters *ap);
416 /* no av_open for output, so applications will need this: */
417 AVFormatContext *av_alloc_format_context(void);
419 #define AVERROR_UNKNOWN (-1) /* unknown error */
420 #define AVERROR_IO (-2) /* i/o error */
421 #define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
422 #define AVERROR_INVALIDDATA (-4) /* invalid data found */
423 #define AVERROR_NOMEM (-5) /* not enough memory */
424 #define AVERROR_NOFMT (-6) /* unknown format */
425 #define AVERROR_NOTSUPP (-7) /* operation not supported */
427 int av_find_stream_info(AVFormatContext *ic);
428 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
429 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
430 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
431 int av_read_play(AVFormatContext *s);
432 int av_read_pause(AVFormatContext *s);
433 void av_close_input_file(AVFormatContext *s);
434 AVStream *av_new_stream(AVFormatContext *s, int id);
435 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
436 int pts_num, int pts_den);
438 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
439 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
440 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
442 int av_find_default_stream_index(AVFormatContext *s);
443 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
444 int av_add_index_entry(AVStream *st,
445 int64_t pos, int64_t timestamp, int size, int distance, int flags);
446 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
447 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
449 /* media file output */
450 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
451 int av_write_header(AVFormatContext *s);
452 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
453 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
454 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
456 int av_write_trailer(AVFormatContext *s);
458 void dump_format(AVFormatContext *ic,
462 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
463 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
464 int64_t parse_date(const char *datestr, int duration);
466 int64_t av_gettime(void);
468 /* ffm specific for ffserver */
469 #define FFM_PACKET_SIZE 4096
470 offset_t ffm_read_write_index(int fd);
471 void ffm_write_write_index(int fd, offset_t pos);
472 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
474 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
476 int av_get_frame_filename(char *buf, int buf_size,
477 const char *path, int number);
478 int av_filename_number_test(const char *filename);
481 int video_grab_init(void);
482 int audio_init(void);
485 int dv1394_init(void);
486 int dc1394_init(void);
488 #ifdef HAVE_AV_CONFIG_H
490 #include "os_support.h"
492 int strstart(const char *str, const char *val, const char **ptr);
493 int stristart(const char *str, const char *val, const char **ptr);
494 void pstrcpy(char *buf, int buf_size, const char *str);
495 char *pstrcat(char *buf, int buf_size, const char *s);
497 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
500 #define dynarray_add(tab, nb_ptr, elem)\
502 typeof(tab) _tab = (tab);\
503 typeof(elem) _elem = (elem);\
504 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
505 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
508 #define dynarray_add(tab, nb_ptr, elem)\
510 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
514 time_t mktimegm(struct tm *tm);
515 struct tm *brktimegm(time_t secs, struct tm *tm);
516 const char *small_strptime(const char *p, const char *fmt,
520 int resolve_host(struct in_addr *sin_addr, const char *hostname);
522 void url_split(char *proto, int proto_size,
523 char *authorization, int authorization_size,
524 char *hostname, int hostname_size,
526 char *path, int path_size,
529 int match_ext(const char *filename, const char *extensions);
531 #endif /* HAVE_AV_CONFIG_H */
537 #endif /* AVFORMAT_H */