caching of timestamps for mpeg-ps so seeking is faster
[libav.git] / libavformat / avformat.h
1 #ifndef AVFORMAT_H
2 #define AVFORMAT_H
3
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
7
8 #define LIBAVFORMAT_BUILD 4611
9
10 #define LIBAVFORMAT_VERSION_INT FFMPEG_VERSION_INT
11 #define LIBAVFORMAT_VERSION FFMPEG_VERSION
12 #define LIBAVFORMAT_IDENT "FFmpeg" FFMPEG_VERSION "b" AV_STRINGIFY(LIBAVFORMAT_BUILD)
13
14 #include <time.h>
15 #include <stdio.h> /* FILE */
16 #include "avcodec.h"
17
18 #include "avio.h"
19
20 /* packet functions */
21
22 #ifndef MAXINT64
23 #define MAXINT64 int64_t_C(0x7fffffffffffffff)
24 #endif
25
26 #ifndef MININT64
27 #define MININT64 int64_t_C(0x8000000000000000)
28 #endif
29
30 #define AV_NOPTS_VALUE MININT64
31 #define AV_TIME_BASE 1000000
32
33 typedef struct AVPacket {
34 int64_t pts; /* presentation time stamp in AV_TIME_BASE units (or
35 pts_den units in muxers or demuxers) */
36 int64_t dts; /* decompression time stamp in AV_TIME_BASE units (or
37 pts_den units in muxers or demuxers) */
38 uint8_t *data;
39 int size;
40 int stream_index;
41 int flags;
42 int duration; /* presentation duration (0 if not available) */
43 void (*destruct)(struct AVPacket *);
44 void *priv;
45 } AVPacket;
46 #define PKT_FLAG_KEY 0x0001
47
48 /* initialize optional fields of a packet */
49 static inline void av_init_packet(AVPacket *pkt)
50 {
51 pkt->pts = AV_NOPTS_VALUE;
52 pkt->dts = AV_NOPTS_VALUE;
53 pkt->duration = 0;
54 pkt->flags = 0;
55 pkt->stream_index = 0;
56 }
57
58 int av_new_packet(AVPacket *pkt, int size);
59 int av_dup_packet(AVPacket *pkt);
60
61 /**
62 * Free a packet
63 *
64 * @param pkt packet to free
65 */
66 static inline void av_free_packet(AVPacket *pkt)
67 {
68 if (pkt && pkt->destruct) {
69 pkt->destruct(pkt);
70 }
71 }
72
73 /*************************************************/
74 /* fractional numbers for exact pts handling */
75
76 /* the exact value of the fractional number is: 'val + num / den'. num
77 is assumed to be such as 0 <= num < den */
78 typedef struct AVFrac {
79 int64_t val, num, den;
80 } AVFrac;
81
82 void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
83 void av_frac_add(AVFrac *f, int64_t incr);
84 void av_frac_set(AVFrac *f, int64_t val);
85
86 /*************************************************/
87 /* input/output formats */
88
89 struct AVFormatContext;
90
91 /* this structure contains the data a format has to probe a file */
92 typedef struct AVProbeData {
93 const char *filename;
94 unsigned char *buf;
95 int buf_size;
96 } AVProbeData;
97
98 #define AVPROBE_SCORE_MAX 100
99
100 typedef struct AVFormatParameters {
101 int frame_rate;
102 int frame_rate_base;
103 int sample_rate;
104 int channels;
105 int width;
106 int height;
107 enum PixelFormat pix_fmt;
108 struct AVImageFormat *image_format;
109 int channel; /* used to select dv channel */
110 const char *device; /* video4linux, audio or DV device */
111 const char *standard; /* tv standard, NTSC, PAL, SECAM */
112 int mpeg2ts_raw:1; /* force raw MPEG2 transport stream output, if possible */
113 int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
114 stream packet (only meaningful if
115 mpeg2ts_raw is TRUE */
116 int initial_pause:1; /* do not begin to play the stream
117 immediately (RTSP only) */
118 } AVFormatParameters;
119
120 #define AVFMT_NOFILE 0x0001 /* no file should be opened */
121 #define AVFMT_NEEDNUMBER 0x0002 /* needs '%d' in filename */
122 #define AVFMT_SHOW_IDS 0x0008 /* show format stream IDs numbers */
123 #define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
124 raw picture data */
125
126 typedef struct AVOutputFormat {
127 const char *name;
128 const char *long_name;
129 const char *mime_type;
130 const char *extensions; /* comma separated extensions */
131 /* size of private data so that it can be allocated in the wrapper */
132 int priv_data_size;
133 /* output support */
134 enum CodecID audio_codec; /* default audio codec */
135 enum CodecID video_codec; /* default video codec */
136 int (*write_header)(struct AVFormatContext *);
137 int (*write_packet)(struct AVFormatContext *,
138 int stream_index,
139 const uint8_t *buf, int size, int64_t pts);
140 int (*write_trailer)(struct AVFormatContext *);
141 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
142 int flags;
143 /* currently only used to set pixel format if not YUV420P */
144 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
145 /* private fields */
146 struct AVOutputFormat *next;
147 } AVOutputFormat;
148
149 typedef struct AVInputFormat {
150 const char *name;
151 const char *long_name;
152 /* size of private data so that it can be allocated in the wrapper */
153 int priv_data_size;
154 /* tell if a given file has a chance of being parsing by this format */
155 int (*read_probe)(AVProbeData *);
156 /* read the format header and initialize the AVFormatContext
157 structure. Return 0 if OK. 'ap' if non NULL contains
158 additionnal paramters. Only used in raw format right
159 now. 'av_new_stream' should be called to create new streams. */
160 int (*read_header)(struct AVFormatContext *,
161 AVFormatParameters *ap);
162 /* read one packet and put it in 'pkt'. pts and flags are also
163 set. 'av_new_stream' can be called only if the flag
164 AVFMTCTX_NOHEADER is used. */
165 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
166 /* close the stream. The AVFormatContext and AVStreams are not
167 freed by this function */
168 int (*read_close)(struct AVFormatContext *);
169 /* seek at or before a given timestamp (given in AV_TIME_BASE
170 units) relative to the frames in stream component stream_index */
171 int (*read_seek)(struct AVFormatContext *,
172 int stream_index, int64_t timestamp);
173 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
174 int flags;
175 /* if extensions are defined, then no probe is done. You should
176 usually not use extension format guessing because it is not
177 reliable enough */
178 const char *extensions;
179 /* general purpose read only value that the format can use */
180 int value;
181
182 /* start/resume playing - only meaningful if using a network based format
183 (RTSP) */
184 int (*read_play)(struct AVFormatContext *);
185
186 /* pause playing - only meaningful if using a network based format
187 (RTSP) */
188 int (*read_pause)(struct AVFormatContext *);
189
190 /* private fields */
191 struct AVInputFormat *next;
192 } AVInputFormat;
193
194 typedef struct AVIndexEntry {
195 int64_t pos;
196 int64_t timestamp;
197 #define AVINDEX_KEYFRAME 0x0001
198 /* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
199 #define AVINDEX_NEXT_KNOWN 0x0002
200 #define AVINDEX_PREV_KNOWN 0x0004
201 int flags;
202 } AVIndexEntry;
203
204 typedef struct AVStream {
205 int index; /* stream index in AVFormatContext */
206 int id; /* format specific stream id */
207 AVCodecContext codec; /* codec context */
208 int r_frame_rate; /* real frame rate of the stream */
209 int r_frame_rate_base;/* real frame rate base of the stream */
210 void *priv_data;
211 /* internal data used in av_find_stream_info() */
212 int64_t codec_info_duration;
213 int codec_info_nb_frames;
214 /* encoding: PTS generation when outputing stream */
215 AVFrac pts;
216 /* ffmpeg.c private use */
217 int stream_copy; /* if TRUE, just copy stream */
218 /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
219 * MN:dunno if thats the right place, for it */
220 float quality;
221 /* decoding: position of the first frame of the component, in
222 AV_TIME_BASE fractional seconds. */
223 int64_t start_time;
224 /* decoding: duration of the stream, in AV_TIME_BASE fractional
225 seconds. */
226 int64_t duration;
227
228 /* av_read_frame() support */
229 int need_parsing;
230 struct AVCodecParserContext *parser;
231
232 int64_t cur_dts;
233 int last_IP_duration;
234 /* av_seek_frame() support */
235 AVIndexEntry *index_entries; /* only used if the format does not
236 support seeking natively */
237 int nb_index_entries;
238 int index_entries_allocated_size;
239 } AVStream;
240
241 #define AVFMTCTX_NOHEADER 0x0001 /* signal that no header is present
242 (streams are added dynamically) */
243
244 #define MAX_STREAMS 20
245
246 /* format I/O context */
247 typedef struct AVFormatContext {
248 /* can only be iformat or oformat, not both at the same time */
249 struct AVInputFormat *iformat;
250 struct AVOutputFormat *oformat;
251 void *priv_data;
252 ByteIOContext pb;
253 int nb_streams;
254 AVStream *streams[MAX_STREAMS];
255 char filename[1024]; /* input or output filename */
256 /* stream info */
257 char title[512];
258 char author[512];
259 char copyright[512];
260 char comment[512];
261 char album[512];
262 int year; /* ID3 year, 0 if none */
263 int track; /* track number, 0 if none */
264 char genre[32]; /* ID3 genre */
265
266 int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
267 /* private data for pts handling (do not modify directly) */
268 int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
269 int pts_num, pts_den; /* value to convert to seconds */
270 /* This buffer is only needed when packets were already buffered but
271 not decoded, for example to get the codec parameters in mpeg
272 streams */
273 struct AVPacketList *packet_buffer;
274
275 /* decoding: position of the first frame of the component, in
276 AV_TIME_BASE fractional seconds. NEVER set this value directly:
277 it is deduced from the AVStream values. */
278 int64_t start_time;
279 /* decoding: duration of the stream, in AV_TIME_BASE fractional
280 seconds. NEVER set this value directly: it is deduced from the
281 AVStream values. */
282 int64_t duration;
283 /* decoding: total file size. 0 if unknown */
284 int64_t file_size;
285 /* decoding: total stream bitrate in bit/s, 0 if not
286 available. Never set it directly if the file_size and the
287 duration are known as ffmpeg can compute it automatically. */
288 int bit_rate;
289
290 /* av_read_frame() support */
291 AVStream *cur_st;
292 const uint8_t *cur_ptr;
293 int cur_len;
294 AVPacket cur_pkt;
295
296 /* the following are used for pts/dts unit conversion */
297 int64_t last_pkt_stream_pts;
298 int64_t last_pkt_stream_dts;
299 int64_t last_pkt_pts;
300 int64_t last_pkt_dts;
301 int last_pkt_pts_frac;
302 int last_pkt_dts_frac;
303
304 /* av_seek_frame() support */
305 int64_t data_offset; /* offset of the first packet */
306 int index_built;
307 } AVFormatContext;
308
309 typedef struct AVPacketList {
310 AVPacket pkt;
311 struct AVPacketList *next;
312 } AVPacketList;
313
314 extern AVInputFormat *first_iformat;
315 extern AVOutputFormat *first_oformat;
316
317 /* still image support */
318 struct AVInputImageContext;
319 typedef struct AVInputImageContext AVInputImageContext;
320
321 typedef struct AVImageInfo {
322 enum PixelFormat pix_fmt; /* requested pixel format */
323 int width; /* requested width */
324 int height; /* requested height */
325 int interleaved; /* image is interleaved (e.g. interleaved GIF) */
326 AVPicture pict; /* returned allocated image */
327 } AVImageInfo;
328
329 /* AVImageFormat.flags field constants */
330 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
331
332 typedef struct AVImageFormat {
333 const char *name;
334 const char *extensions;
335 /* tell if a given file has a chance of being parsing by this format */
336 int (*img_probe)(AVProbeData *);
337 /* read a whole image. 'alloc_cb' is called when the image size is
338 known so that the caller can allocate the image. If 'allo_cb'
339 returns non zero, then the parsing is aborted. Return '0' if
340 OK. */
341 int (*img_read)(ByteIOContext *,
342 int (*alloc_cb)(void *, AVImageInfo *info), void *);
343 /* write the image */
344 int supported_pixel_formats; /* mask of supported formats for output */
345 int (*img_write)(ByteIOContext *, AVImageInfo *);
346 int flags;
347 struct AVImageFormat *next;
348 } AVImageFormat;
349
350 void av_register_image_format(AVImageFormat *img_fmt);
351 AVImageFormat *av_probe_image_format(AVProbeData *pd);
352 AVImageFormat *guess_image_format(const char *filename);
353 int av_read_image(ByteIOContext *pb, const char *filename,
354 AVImageFormat *fmt,
355 int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
356 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
357
358 extern AVImageFormat *first_image_format;
359
360 extern AVImageFormat pnm_image_format;
361 extern AVImageFormat pbm_image_format;
362 extern AVImageFormat pgm_image_format;
363 extern AVImageFormat ppm_image_format;
364 extern AVImageFormat pam_image_format;
365 extern AVImageFormat pgmyuv_image_format;
366 extern AVImageFormat yuv_image_format;
367 #ifdef CONFIG_ZLIB
368 extern AVImageFormat png_image_format;
369 #endif
370 extern AVImageFormat jpeg_image_format;
371 extern AVImageFormat gif_image_format;
372
373 /* XXX: use automatic init with either ELF sections or C file parser */
374 /* modules */
375
376 /* mpeg.c */
377 extern AVInputFormat mpegps_demux;
378 int mpegps_init(void);
379
380 /* mpegts.c */
381 extern AVInputFormat mpegts_demux;
382 int mpegts_init(void);
383
384 /* rm.c */
385 int rm_init(void);
386
387 /* crc.c */
388 int crc_init(void);
389
390 /* img.c */
391 int img_init(void);
392
393 /* asf.c */
394 int asf_init(void);
395
396 /* avienc.c */
397 int avienc_init(void);
398
399 /* avidec.c */
400 int avidec_init(void);
401
402 /* swf.c */
403 int swf_init(void);
404
405 /* mov.c */
406 int mov_init(void);
407
408 /* movenc.c */
409 int movenc_init(void);
410
411 /* flvenc.c */
412 int flvenc_init(void);
413
414 /* flvdec.c */
415 int flvdec_init(void);
416
417 /* jpeg.c */
418 int jpeg_init(void);
419
420 /* gif.c */
421 int gif_init(void);
422
423 /* au.c */
424 int au_init(void);
425
426 /* amr.c */
427 int amr_init(void);
428
429 /* wav.c */
430 int wav_init(void);
431
432 /* raw.c */
433 int pcm_read_seek(AVFormatContext *s,
434 int stream_index, int64_t timestamp);
435 int raw_init(void);
436
437 /* mp3.c */
438 int mp3_init(void);
439
440 /* yuv4mpeg.c */
441 int yuv4mpeg_init(void);
442
443 /* ogg.c */
444 int ogg_init(void);
445
446 /* dv.c */
447 int dv_init(void);
448
449 /* ffm.c */
450 int ffm_init(void);
451
452 /* rtsp.c */
453 extern AVInputFormat redir_demux;
454 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
455
456 /* 4xm.c */
457 int fourxm_init(void);
458
459 /* psxstr.c */
460 int str_init(void);
461
462 /* idroq.c */
463 int roq_init(void);
464
465 /* ipmovie.c */
466 int ipmovie_init(void);
467
468 /* nut.c */
469 int nut_init(void);
470
471 /* wc3movie.c */
472 int wc3_init(void);
473
474 /* westwood.c */
475 int westwood_init(void);
476
477 /* segafilm.c */
478 int film_init(void);
479
480 /* idcin.c */
481 int idcin_init(void);
482
483 /* flic.c */
484 int flic_init(void);
485
486 /* sierravmd.c */
487 int vmd_init(void);
488
489 #include "rtp.h"
490
491 #include "rtsp.h"
492
493 /* yuv4mpeg.c */
494 extern AVOutputFormat yuv4mpegpipe_oformat;
495
496 /* utils.c */
497 void av_register_input_format(AVInputFormat *format);
498 void av_register_output_format(AVOutputFormat *format);
499 AVOutputFormat *guess_stream_format(const char *short_name,
500 const char *filename, const char *mime_type);
501 AVOutputFormat *guess_format(const char *short_name,
502 const char *filename, const char *mime_type);
503
504 void av_hex_dump(FILE *f, uint8_t *buf, int size);
505 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
506
507 void av_register_all(void);
508
509 typedef struct FifoBuffer {
510 uint8_t *buffer;
511 uint8_t *rptr, *wptr, *end;
512 } FifoBuffer;
513
514 int fifo_init(FifoBuffer *f, int size);
515 void fifo_free(FifoBuffer *f);
516 int fifo_size(FifoBuffer *f, uint8_t *rptr);
517 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
518 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
519
520 /* media file input */
521 AVInputFormat *av_find_input_format(const char *short_name);
522 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
523 int av_open_input_stream(AVFormatContext **ic_ptr,
524 ByteIOContext *pb, const char *filename,
525 AVInputFormat *fmt, AVFormatParameters *ap);
526 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
527 AVInputFormat *fmt,
528 int buf_size,
529 AVFormatParameters *ap);
530
531 #define AVERROR_UNKNOWN (-1) /* unknown error */
532 #define AVERROR_IO (-2) /* i/o error */
533 #define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
534 #define AVERROR_INVALIDDATA (-4) /* invalid data found */
535 #define AVERROR_NOMEM (-5) /* not enough memory */
536 #define AVERROR_NOFMT (-6) /* unknown format */
537 #define AVERROR_NOTSUPP (-7) /* operation not supported */
538
539 int av_find_stream_info(AVFormatContext *ic);
540 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
541 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
542 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp);
543 int av_read_play(AVFormatContext *s);
544 int av_read_pause(AVFormatContext *s);
545 void av_close_input_file(AVFormatContext *s);
546 AVStream *av_new_stream(AVFormatContext *s, int id);
547 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
548 int pts_num, int pts_den);
549
550 int av_find_default_stream_index(AVFormatContext *s);
551 int av_index_search_timestamp(AVStream *st, int timestamp);
552 void av_add_index_entry(AVStream *st,
553 int64_t pos, int64_t timestamp, int flags);
554
555 /* media file output */
556 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
557 int av_write_header(AVFormatContext *s);
558 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf,
559 int size);
560 int av_write_trailer(AVFormatContext *s);
561
562 void dump_format(AVFormatContext *ic,
563 int index,
564 const char *url,
565 int is_output);
566 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
567 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
568 int64_t parse_date(const char *datestr, int duration);
569
570 int64_t av_gettime(void);
571
572 /* ffm specific for ffserver */
573 #define FFM_PACKET_SIZE 4096
574 offset_t ffm_read_write_index(int fd);
575 void ffm_write_write_index(int fd, offset_t pos);
576 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
577
578 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
579
580 int get_frame_filename(char *buf, int buf_size,
581 const char *path, int number);
582 int filename_number_test(const char *filename);
583
584 /* grab specific */
585 int video_grab_init(void);
586 int audio_init(void);
587
588 /* DV1394 */
589 int dv1394_init(void);
590
591 #ifdef HAVE_AV_CONFIG_H
592
593 #include "os_support.h"
594
595 int strstart(const char *str, const char *val, const char **ptr);
596 int stristart(const char *str, const char *val, const char **ptr);
597 void pstrcpy(char *buf, int buf_size, const char *str);
598 char *pstrcat(char *buf, int buf_size, const char *s);
599
600 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
601
602 #ifdef __GNUC__
603 #define dynarray_add(tab, nb_ptr, elem)\
604 do {\
605 typeof(tab) _tab = (tab);\
606 typeof(elem) _elem = (elem);\
607 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
608 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
609 } while(0)
610 #else
611 #define dynarray_add(tab, nb_ptr, elem)\
612 do {\
613 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
614 } while(0)
615 #endif
616
617 time_t mktimegm(struct tm *tm);
618 const char *small_strptime(const char *p, const char *fmt,
619 struct tm *dt);
620
621 struct in_addr;
622 int resolve_host(struct in_addr *sin_addr, const char *hostname);
623
624 void url_split(char *proto, int proto_size,
625 char *hostname, int hostname_size,
626 int *port_ptr,
627 char *path, int path_size,
628 const char *url);
629
630 int match_ext(const char *filename, const char *extensions);
631
632 #endif /* HAVE_AV_CONFIG_H */
633
634 #ifdef __cplusplus
635 }
636 #endif
637
638 #endif /* AVFORMAT_H */