user setable preload and max_mux_delay
[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       4620
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 void av_destruct_packet_nofree(AVPacket *pkt);
46
47 /* initialize optional fields of a packet */
48 static inline void av_init_packet(AVPacket *pkt)
49 {
50     pkt->pts   = AV_NOPTS_VALUE;
51     pkt->dts   = AV_NOPTS_VALUE;
52     pkt->duration = 0;
53     pkt->flags = 0;
54     pkt->stream_index = 0;
55     pkt->destruct= av_destruct_packet_nofree;
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 *, AVPacket *pkt);
138     int (*write_trailer)(struct AVFormatContext *);
139     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
140     int flags;
141     /* currently only used to set pixel format if not YUV420P */
142     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
143     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
144     /* private fields */
145     struct AVOutputFormat *next;
146 } AVOutputFormat;
147
148 typedef struct AVInputFormat {
149     const char *name;
150     const char *long_name;
151     /* size of private data so that it can be allocated in the wrapper */
152     int priv_data_size;
153     /* tell if a given file has a chance of being parsing by this format */
154     int (*read_probe)(AVProbeData *);
155     /* read the format header and initialize the AVFormatContext
156        structure. Return 0 if OK. 'ap' if non NULL contains
157        additionnal paramters. Only used in raw format right
158        now. 'av_new_stream' should be called to create new streams.  */
159     int (*read_header)(struct AVFormatContext *,
160                        AVFormatParameters *ap);
161     /* read one packet and put it in 'pkt'. pts and flags are also
162        set. 'av_new_stream' can be called only if the flag
163        AVFMTCTX_NOHEADER is used. */
164     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
165     /* close the stream. The AVFormatContext and AVStreams are not
166        freed by this function */
167     int (*read_close)(struct AVFormatContext *);
168     /** 
169      * seek to a given timestamp relative to the frames in 
170      * stream component stream_index
171      * @param stream_index must not be -1
172      * @param flags selects which direction should be preferred if no exact 
173      *              match is available
174      */
175     int (*read_seek)(struct AVFormatContext *, 
176                      int stream_index, int64_t timestamp, int flags);
177     /**
178      * gets the next timestamp in AV_TIME_BASE units.
179      */
180     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
181                               int64_t *pos, int64_t pos_limit);
182     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
183     int flags;
184     /* if extensions are defined, then no probe is done. You should
185        usually not use extension format guessing because it is not
186        reliable enough */
187     const char *extensions;
188     /* general purpose read only value that the format can use */
189     int value;
190
191     /* start/resume playing - only meaningful if using a network based format
192        (RTSP) */
193     int (*read_play)(struct AVFormatContext *);
194
195     /* pause playing - only meaningful if using a network based format
196        (RTSP) */
197     int (*read_pause)(struct AVFormatContext *);
198
199     /* private fields */
200     struct AVInputFormat *next;
201 } AVInputFormat;
202
203 typedef struct AVIndexEntry {
204     int64_t pos;
205     int64_t timestamp;
206 #define AVINDEX_KEYFRAME 0x0001
207 /* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
208     int flags;
209     int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
210 } AVIndexEntry;
211
212 typedef struct AVStream {
213     int index;    /* stream index in AVFormatContext */
214     int id;       /* format specific stream id */
215     AVCodecContext codec; /* codec context */
216     int r_frame_rate;     /* real frame rate of the stream */
217     int r_frame_rate_base;/* real frame rate base of the stream */
218     void *priv_data;
219     /* internal data used in av_find_stream_info() */
220     int64_t codec_info_duration;     
221     int codec_info_nb_frames;
222     /* encoding: PTS generation when outputing stream */
223     AVFrac pts;
224     AVRational time_base;
225     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
226     /* ffmpeg.c private use */
227     int stream_copy; /* if TRUE, just copy stream */
228     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
229      * MN:dunno if thats the right place, for it */
230     float quality; 
231     /* decoding: position of the first frame of the component, in
232        AV_TIME_BASE fractional seconds. */
233     int64_t start_time; 
234     /* decoding: duration of the stream, in AV_TIME_BASE fractional
235        seconds. */
236     int64_t duration;
237
238     /* av_read_frame() support */
239     int need_parsing;
240     struct AVCodecParserContext *parser;
241
242     int64_t cur_dts;
243     int last_IP_duration;
244     int64_t last_IP_pts;
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     const 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     
311     int mux_rate;
312     int packet_size;
313     int preload;
314     int max_delay;
315 } AVFormatContext;
316
317 typedef struct AVPacketList {
318     AVPacket pkt;
319     struct AVPacketList *next;
320 } AVPacketList;
321
322 extern AVInputFormat *first_iformat;
323 extern AVOutputFormat *first_oformat;
324
325 /* still image support */
326 struct AVInputImageContext;
327 typedef struct AVInputImageContext AVInputImageContext;
328
329 typedef struct AVImageInfo {
330     enum PixelFormat pix_fmt; /* requested pixel format */
331     int width; /* requested width */
332     int height; /* requested height */
333     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
334     AVPicture pict; /* returned allocated image */
335 } AVImageInfo;
336
337 /* AVImageFormat.flags field constants */
338 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
339
340 typedef struct AVImageFormat {
341     const char *name;
342     const char *extensions;
343     /* tell if a given file has a chance of being parsing by this format */
344     int (*img_probe)(AVProbeData *);
345     /* read a whole image. 'alloc_cb' is called when the image size is
346        known so that the caller can allocate the image. If 'allo_cb'
347        returns non zero, then the parsing is aborted. Return '0' if
348        OK. */
349     int (*img_read)(ByteIOContext *, 
350                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
351     /* write the image */
352     int supported_pixel_formats; /* mask of supported formats for output */
353     int (*img_write)(ByteIOContext *, AVImageInfo *);
354     int flags;
355     struct AVImageFormat *next;
356 } AVImageFormat;
357
358 void av_register_image_format(AVImageFormat *img_fmt);
359 AVImageFormat *av_probe_image_format(AVProbeData *pd);
360 AVImageFormat *guess_image_format(const char *filename);
361 int av_read_image(ByteIOContext *pb, const char *filename,
362                   AVImageFormat *fmt,
363                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
364 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
365
366 extern AVImageFormat *first_image_format;
367
368 extern AVImageFormat pnm_image_format;
369 extern AVImageFormat pbm_image_format;
370 extern AVImageFormat pgm_image_format;
371 extern AVImageFormat ppm_image_format;
372 extern AVImageFormat pam_image_format;
373 extern AVImageFormat pgmyuv_image_format;
374 extern AVImageFormat yuv_image_format;
375 #ifdef CONFIG_ZLIB
376 extern AVImageFormat png_image_format;
377 #endif
378 extern AVImageFormat jpeg_image_format;
379 extern AVImageFormat gif_image_format;
380 extern AVImageFormat sgi_image_format;
381
382 /* XXX: use automatic init with either ELF sections or C file parser */
383 /* modules */
384
385 /* mpeg.c */
386 extern AVInputFormat mpegps_demux;
387 int mpegps_init(void);
388
389 /* mpegts.c */
390 extern AVInputFormat mpegts_demux;
391 int mpegts_init(void);
392
393 /* rm.c */
394 int rm_init(void);
395
396 /* crc.c */
397 int crc_init(void);
398
399 /* img.c */
400 int img_init(void);
401
402 /* img2.c */
403 int img2_init(void);
404
405 /* asf.c */
406 int asf_init(void);
407
408 /* avienc.c */
409 int avienc_init(void);
410
411 /* avidec.c */
412 int avidec_init(void);
413
414 /* swf.c */
415 int swf_init(void);
416
417 /* mov.c */
418 int mov_init(void);
419
420 /* movenc.c */
421 int movenc_init(void);
422
423 /* flvenc.c */
424 int flvenc_init(void);
425
426 /* flvdec.c */
427 int flvdec_init(void);
428
429 /* jpeg.c */
430 int jpeg_init(void);
431
432 /* gif.c */
433 int gif_init(void);
434
435 /* au.c */
436 int au_init(void);
437
438 /* amr.c */
439 int amr_init(void);
440
441 /* wav.c */
442 int ff_wav_init(void);
443
444 /* raw.c */
445 int pcm_read_seek(AVFormatContext *s, 
446                   int stream_index, int64_t timestamp, int flags);
447 int raw_init(void);
448
449 /* mp3.c */
450 int mp3_init(void);
451
452 /* yuv4mpeg.c */
453 int yuv4mpeg_init(void);
454
455 /* ogg.c */
456 int ogg_init(void);
457
458 /* dv.c */
459 int ff_dv_init(void);
460
461 /* ffm.c */
462 int ffm_init(void);
463
464 /* rtsp.c */
465 extern AVInputFormat redir_demux;
466 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
467
468 /* 4xm.c */
469 int fourxm_init(void);
470
471 /* psxstr.c */
472 int str_init(void);
473
474 /* idroq.c */
475 int roq_init(void);
476
477 /* ipmovie.c */
478 int ipmovie_init(void);
479
480 /* nut.c */
481 int nut_init(void);
482
483 /* wc3movie.c */
484 int wc3_init(void);
485
486 /* westwood.c */
487 int westwood_init(void);
488
489 /* segafilm.c */
490 int film_init(void);
491
492 /* idcin.c */
493 int idcin_init(void);
494
495 /* flic.c */
496 int flic_init(void);
497
498 /* sierravmd.c */
499 int vmd_init(void);
500
501 /* matroska.c */
502 int matroska_init(void);
503
504 /* sol.c */
505 int sol_init(void);
506
507 /* electronicarts.c */
508 int ea_init(void);
509
510 #include "rtp.h"
511
512 #include "rtsp.h"
513
514 /* yuv4mpeg.c */
515 extern AVOutputFormat yuv4mpegpipe_oformat;
516
517 /* utils.c */
518 void av_register_input_format(AVInputFormat *format);
519 void av_register_output_format(AVOutputFormat *format);
520 AVOutputFormat *guess_stream_format(const char *short_name, 
521                                     const char *filename, const char *mime_type);
522 AVOutputFormat *guess_format(const char *short_name, 
523                              const char *filename, const char *mime_type);
524
525 void av_hex_dump(FILE *f, uint8_t *buf, int size);
526 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
527
528 void av_register_all(void);
529
530 typedef struct FifoBuffer {
531     uint8_t *buffer;
532     uint8_t *rptr, *wptr, *end;
533 } FifoBuffer;
534
535 int fifo_init(FifoBuffer *f, int size);
536 void fifo_free(FifoBuffer *f);
537 int fifo_size(FifoBuffer *f, uint8_t *rptr);
538 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
539 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
540 int put_fifo(ByteIOContext *pb, FifoBuffer *f, int buf_size, uint8_t **rptr_ptr);
541
542 /* media file input */
543 AVInputFormat *av_find_input_format(const char *short_name);
544 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
545 int av_open_input_stream(AVFormatContext **ic_ptr, 
546                          ByteIOContext *pb, const char *filename, 
547                          AVInputFormat *fmt, AVFormatParameters *ap);
548 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
549                        AVInputFormat *fmt,
550                        int buf_size,
551                        AVFormatParameters *ap);
552 /* no av_open for output, so applications will need this: */
553 AVFormatContext *av_alloc_format_context(void);
554
555 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
556 #define AVERROR_IO          (-2)  /* i/o error */
557 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
558 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
559 #define AVERROR_NOMEM       (-5)  /* not enough memory */
560 #define AVERROR_NOFMT       (-6)  /* unknown format */
561 #define AVERROR_NOTSUPP     (-7)  /* operation not supported */
562  
563 int av_find_stream_info(AVFormatContext *ic);
564 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
565 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
566 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
567 int av_read_play(AVFormatContext *s);
568 int av_read_pause(AVFormatContext *s);
569 void av_close_input_file(AVFormatContext *s);
570 AVStream *av_new_stream(AVFormatContext *s, int id);
571 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
572                      int pts_num, int pts_den);
573
574 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
575 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
576
577 int av_find_default_stream_index(AVFormatContext *s);
578 int av_index_search_timestamp(AVStream *st, int timestamp, int flags);
579 int av_add_index_entry(AVStream *st,
580                        int64_t pos, int64_t timestamp, int distance, int flags);
581 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
582
583 /* media file output */
584 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
585 int av_write_header(AVFormatContext *s);
586 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
587 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
588
589 int av_write_trailer(AVFormatContext *s);
590
591 void dump_format(AVFormatContext *ic,
592                  int index, 
593                  const char *url,
594                  int is_output);
595 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
596 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
597 int64_t parse_date(const char *datestr, int duration);
598
599 int64_t av_gettime(void);
600
601 /* ffm specific for ffserver */
602 #define FFM_PACKET_SIZE 4096
603 offset_t ffm_read_write_index(int fd);
604 void ffm_write_write_index(int fd, offset_t pos);
605 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
606
607 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
608
609 int get_frame_filename(char *buf, int buf_size,
610                        const char *path, int number);
611 int filename_number_test(const char *filename);
612
613 /* grab specific */
614 int video_grab_init(void);
615 int audio_init(void);
616
617 /* DV1394 */
618 int dv1394_init(void);
619
620 #ifdef HAVE_AV_CONFIG_H
621
622 #include "os_support.h"
623
624 int strstart(const char *str, const char *val, const char **ptr);
625 int stristart(const char *str, const char *val, const char **ptr);
626 void pstrcpy(char *buf, int buf_size, const char *str);
627 char *pstrcat(char *buf, int buf_size, const char *s);
628
629 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
630
631 #ifdef __GNUC__
632 #define dynarray_add(tab, nb_ptr, elem)\
633 do {\
634     typeof(tab) _tab = (tab);\
635     typeof(elem) _elem = (elem);\
636     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
637     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
638 } while(0)
639 #else
640 #define dynarray_add(tab, nb_ptr, elem)\
641 do {\
642     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
643 } while(0)
644 #endif
645
646 time_t mktimegm(struct tm *tm);
647 struct tm *brktimegm(time_t secs, struct tm *tm);
648 const char *small_strptime(const char *p, const char *fmt, 
649                            struct tm *dt);
650
651 struct in_addr;
652 int resolve_host(struct in_addr *sin_addr, const char *hostname);
653
654 void url_split(char *proto, int proto_size,
655                char *authorization, int authorization_size,
656                char *hostname, int hostname_size,
657                int *port_ptr,
658                char *path, int path_size,
659                const char *url);
660
661 int match_ext(const char *filename, const char *extensions);
662
663 #endif /* HAVE_AV_CONFIG_H */
664
665 #ifdef __cplusplus
666 }
667 #endif
668
669 #endif /* AVFORMAT_H */