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