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