yep, FLI support
[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       4610
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     int flags;
199 } AVIndexEntry;
200
201 typedef struct AVStream {
202     int index;    /* stream index in AVFormatContext */
203     int id;       /* format specific stream id */
204     AVCodecContext codec; /* codec context */
205     int r_frame_rate;     /* real frame rate of the stream */
206     int r_frame_rate_base;/* real frame rate base of the stream */
207     void *priv_data;
208     /* internal data used in av_find_stream_info() */
209     int64_t codec_info_duration;     
210     int codec_info_nb_frames;
211     /* encoding: PTS generation when outputing stream */
212     AVFrac pts;
213     /* ffmpeg.c private use */
214     int stream_copy; /* if TRUE, just copy stream */
215     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
216      * MN:dunno if thats the right place, for it */
217     float quality; 
218     /* decoding: position of the first frame of the component, in
219        AV_TIME_BASE fractional seconds. */
220     int64_t start_time; 
221     /* decoding: duration of the stream, in AV_TIME_BASE fractional
222        seconds. */
223     int64_t duration;
224
225     /* av_read_frame() support */
226     int need_parsing;
227     struct AVCodecParserContext *parser;
228     int got_frame;
229     int64_t cur_frame_pts;
230     int64_t cur_frame_dts;
231     int64_t cur_dts;
232     int last_IP_duration;
233     /* av_seek_frame() support */
234     AVIndexEntry *index_entries; /* only used if the format does not
235                                     support seeking natively */
236     int nb_index_entries;
237     int index_entries_allocated_size;
238 } AVStream;
239
240 #define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
241                                          (streams are added dynamically) */
242
243 #define MAX_STREAMS 20
244
245 /* format I/O context */
246 typedef struct AVFormatContext {
247     /* can only be iformat or oformat, not both at the same time */
248     struct AVInputFormat *iformat;
249     struct AVOutputFormat *oformat;
250     void *priv_data;
251     ByteIOContext pb;
252     int nb_streams;
253     AVStream *streams[MAX_STREAMS];
254     char filename[1024]; /* input or output filename */
255     /* stream info */
256     char title[512];
257     char author[512];
258     char copyright[512];
259     char comment[512];
260     char album[512];
261     int year;  /* ID3 year, 0 if none */
262     int track; /* track number, 0 if none */
263     char genre[32]; /* ID3 genre */
264
265     int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
266     /* private data for pts handling (do not modify directly) */
267     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
268     int pts_num, pts_den; /* value to convert to seconds */
269     /* This buffer is only needed when packets were already buffered but
270        not decoded, for example to get the codec parameters in mpeg
271        streams */
272     struct AVPacketList *packet_buffer;
273
274     /* decoding: position of the first frame of the component, in
275        AV_TIME_BASE fractional seconds. NEVER set this value directly:
276        it is deduced from the AVStream values.  */
277     int64_t start_time; 
278     /* decoding: duration of the stream, in AV_TIME_BASE fractional
279        seconds. NEVER set this value directly: it is deduced from the
280        AVStream values.  */
281     int64_t duration;
282     /* decoding: total file size. 0 if unknown */
283     int64_t file_size;
284     /* decoding: total stream bitrate in bit/s, 0 if not
285        available. Never set it directly if the file_size and the
286        duration are known as ffmpeg can compute it automatically. */
287     int bit_rate;
288
289     /* av_read_frame() support */
290     AVStream *cur_st;
291     const uint8_t *cur_ptr;
292     int cur_len;
293     AVPacket cur_pkt;
294
295     /* the following are used for pts/dts unit conversion */
296     int64_t last_pkt_stream_pts;
297     int64_t last_pkt_stream_dts;
298     int64_t last_pkt_pts;
299     int64_t last_pkt_dts;
300     int last_pkt_pts_frac;
301     int last_pkt_dts_frac;
302
303     /* av_seek_frame() support */
304     int64_t data_offset; /* offset of the first packet */
305     int index_built;
306 } AVFormatContext;
307
308 typedef struct AVPacketList {
309     AVPacket pkt;
310     struct AVPacketList *next;
311 } AVPacketList;
312
313 extern AVInputFormat *first_iformat;
314 extern AVOutputFormat *first_oformat;
315
316 /* still image support */
317 struct AVInputImageContext;
318 typedef struct AVInputImageContext AVInputImageContext;
319
320 typedef struct AVImageInfo {
321     enum PixelFormat pix_fmt; /* requested pixel format */
322     int width; /* requested width */
323     int height; /* requested height */
324     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
325     AVPicture pict; /* returned allocated image */
326 } AVImageInfo;
327
328 /* AVImageFormat.flags field constants */
329 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
330
331 typedef struct AVImageFormat {
332     const char *name;
333     const char *extensions;
334     /* tell if a given file has a chance of being parsing by this format */
335     int (*img_probe)(AVProbeData *);
336     /* read a whole image. 'alloc_cb' is called when the image size is
337        known so that the caller can allocate the image. If 'allo_cb'
338        returns non zero, then the parsing is aborted. Return '0' if
339        OK. */
340     int (*img_read)(ByteIOContext *, 
341                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
342     /* write the image */
343     int supported_pixel_formats; /* mask of supported formats for output */
344     int (*img_write)(ByteIOContext *, AVImageInfo *);
345     int flags;
346     struct AVImageFormat *next;
347 } AVImageFormat;
348
349 void av_register_image_format(AVImageFormat *img_fmt);
350 AVImageFormat *av_probe_image_format(AVProbeData *pd);
351 AVImageFormat *guess_image_format(const char *filename);
352 int av_read_image(ByteIOContext *pb, const char *filename,
353                   AVImageFormat *fmt,
354                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
355 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
356
357 extern AVImageFormat *first_image_format;
358
359 extern AVImageFormat pnm_image_format;
360 extern AVImageFormat pbm_image_format;
361 extern AVImageFormat pgm_image_format;
362 extern AVImageFormat ppm_image_format;
363 extern AVImageFormat pam_image_format;
364 extern AVImageFormat pgmyuv_image_format;
365 extern AVImageFormat yuv_image_format;
366 #ifdef CONFIG_ZLIB
367 extern AVImageFormat png_image_format;
368 #endif
369 extern AVImageFormat jpeg_image_format;
370 extern AVImageFormat gif_image_format;
371
372 /* XXX: use automatic init with either ELF sections or C file parser */
373 /* modules */
374
375 /* mpeg.c */
376 extern AVInputFormat mpegps_demux;
377 int mpegps_init(void);
378
379 /* mpegts.c */
380 extern AVInputFormat mpegts_demux;
381 int mpegts_init(void);
382
383 /* rm.c */
384 int rm_init(void);
385
386 /* crc.c */
387 int crc_init(void);
388
389 /* img.c */
390 int img_init(void);
391
392 /* asf.c */
393 int asf_init(void);
394
395 /* avienc.c */
396 int avienc_init(void);
397
398 /* avidec.c */
399 int avidec_init(void);
400
401 /* swf.c */
402 int swf_init(void);
403
404 /* mov.c */
405 int mov_init(void);
406
407 /* movenc.c */
408 int movenc_init(void);
409
410 /* flvenc.c */
411 int flvenc_init(void);
412
413 /* flvdec.c */
414 int flvdec_init(void);
415
416 /* jpeg.c */
417 int jpeg_init(void);
418
419 /* gif.c */
420 int gif_init(void);
421
422 /* au.c */
423 int au_init(void);
424
425 /* amr.c */
426 int amr_init(void);
427
428 /* wav.c */
429 int wav_init(void);
430
431 /* raw.c */
432 int pcm_read_seek(AVFormatContext *s, 
433                   int stream_index, int64_t timestamp);
434 int raw_init(void);
435
436 /* mp3.c */
437 int mp3_init(void);
438
439 /* yuv4mpeg.c */
440 int yuv4mpeg_init(void);
441
442 /* ogg.c */
443 int ogg_init(void);
444
445 /* dv.c */
446 int dv_init(void);
447
448 /* ffm.c */
449 int ffm_init(void);
450
451 /* rtsp.c */
452 extern AVInputFormat redir_demux;
453 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
454
455 /* 4xm.c */
456 int fourxm_init(void);
457
458 /* psxstr.c */
459 int str_init(void);
460
461 /* idroq.c */
462 int roq_init(void);
463
464 /* ipmovie.c */
465 int ipmovie_init(void);
466
467 /* nut.c */
468 int nut_init(void);
469
470 /* wc3movie.c */
471 int wc3_init(void);
472
473 /* westwood.c */
474 int westwood_init(void);
475
476 /* segafilm.c */
477 int film_init(void);
478
479 /* idcin.c */
480 int idcin_init(void);
481
482 /* flic.c */
483 int flic_init(void);
484
485 #include "rtp.h"
486
487 #include "rtsp.h"
488
489 /* yuv4mpeg.c */
490 extern AVOutputFormat yuv4mpegpipe_oformat;
491
492 /* utils.c */
493 void av_register_input_format(AVInputFormat *format);
494 void av_register_output_format(AVOutputFormat *format);
495 AVOutputFormat *guess_stream_format(const char *short_name, 
496                                     const char *filename, const char *mime_type);
497 AVOutputFormat *guess_format(const char *short_name, 
498                              const char *filename, const char *mime_type);
499
500 void av_hex_dump(FILE *f, uint8_t *buf, int size);
501 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
502
503 void av_register_all(void);
504
505 typedef struct FifoBuffer {
506     uint8_t *buffer;
507     uint8_t *rptr, *wptr, *end;
508 } FifoBuffer;
509
510 int fifo_init(FifoBuffer *f, int size);
511 void fifo_free(FifoBuffer *f);
512 int fifo_size(FifoBuffer *f, uint8_t *rptr);
513 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
514 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
515
516 /* media file input */
517 AVInputFormat *av_find_input_format(const char *short_name);
518 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
519 int av_open_input_stream(AVFormatContext **ic_ptr, 
520                          ByteIOContext *pb, const char *filename, 
521                          AVInputFormat *fmt, AVFormatParameters *ap);
522 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
523                        AVInputFormat *fmt,
524                        int buf_size,
525                        AVFormatParameters *ap);
526
527 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
528 #define AVERROR_IO          (-2)  /* i/o error */
529 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
530 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
531 #define AVERROR_NOMEM       (-5)  /* not enough memory */
532 #define AVERROR_NOFMT       (-6)  /* unknown format */
533 #define AVERROR_NOTSUPP     (-7)  /* operation not supported */
534  
535 int av_find_stream_info(AVFormatContext *ic);
536 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
537 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
538 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp);
539 int av_read_play(AVFormatContext *s);
540 int av_read_pause(AVFormatContext *s);
541 void av_close_input_file(AVFormatContext *s);
542 AVStream *av_new_stream(AVFormatContext *s, int id);
543 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
544                      int pts_num, int pts_den);
545
546 /* media file output */
547 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
548 int av_write_header(AVFormatContext *s);
549 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
550                    int size);
551 int av_write_trailer(AVFormatContext *s);
552
553 void dump_format(AVFormatContext *ic,
554                  int index, 
555                  const char *url,
556                  int is_output);
557 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
558 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
559 int64_t parse_date(const char *datestr, int duration);
560
561 int64_t av_gettime(void);
562
563 /* ffm specific for ffserver */
564 #define FFM_PACKET_SIZE 4096
565 offset_t ffm_read_write_index(int fd);
566 void ffm_write_write_index(int fd, offset_t pos);
567 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
568
569 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
570
571 int get_frame_filename(char *buf, int buf_size,
572                        const char *path, int number);
573 int filename_number_test(const char *filename);
574
575 /* grab specific */
576 int video_grab_init(void);
577 int audio_init(void);
578
579 /* DV1394 */
580 int dv1394_init(void);
581
582 #ifdef HAVE_AV_CONFIG_H
583
584 #include "os_support.h"
585
586 int strstart(const char *str, const char *val, const char **ptr);
587 int stristart(const char *str, const char *val, const char **ptr);
588 void pstrcpy(char *buf, int buf_size, const char *str);
589 char *pstrcat(char *buf, int buf_size, const char *s);
590
591 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
592
593 #ifdef __GNUC__
594 #define dynarray_add(tab, nb_ptr, elem)\
595 do {\
596     typeof(tab) _tab = (tab);\
597     typeof(elem) _elem = (elem);\
598     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
599     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
600 } while(0)
601 #else
602 #define dynarray_add(tab, nb_ptr, elem)\
603 do {\
604     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
605 } while(0)
606 #endif
607
608 time_t mktimegm(struct tm *tm);
609 const char *small_strptime(const char *p, const char *fmt, 
610                            struct tm *dt);
611
612 struct in_addr;
613 int resolve_host(struct in_addr *sin_addr, const char *hostname);
614
615 void url_split(char *proto, int proto_size,
616                char *hostname, int hostname_size,
617                int *port_ptr,
618                char *path, int path_size,
619                const char *url);
620
621 int match_ext(const char *filename, const char *extensions);
622
623 #endif /* HAVE_AV_CONFIG_H */
624
625 #ifdef __cplusplus
626 }
627 #endif
628
629 #endif /* AVFORMAT_H */