added stream start time and duration API - AV_NOPTS_VALUE is no longer zero
[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_VERSION_INT 0x000406  
9 #define LIBAVFORMAT_VERSION     "0.4.6"
10 #define LIBAVFORMAT_BUILD       4606
11
12 #include "avcodec.h"
13
14 #include "avio.h"
15
16 /* packet functions */
17
18 #ifndef MAXINT64
19 #define MAXINT64 int64_t_C(0x7fffffffffffffff)
20 #endif
21
22 #ifndef MININT64
23 #define MININT64 int64_t_C(0x8000000000000000)
24 #endif
25
26 #define AV_NOPTS_VALUE MININT64
27 #define AV_TIME_BASE 1000000
28
29 typedef struct AVPacket {
30     int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
31     uint8_t *data;
32     int   size;
33     int   stream_index;
34     int   flags;
35     int   duration;
36     void  (*destruct)(struct AVPacket *);
37     void  *priv;
38 } AVPacket; 
39 #define PKT_FLAG_KEY   0x0001
40
41 static inline void av_init_packet(AVPacket *pkt)
42 {
43     pkt->pts   = AV_NOPTS_VALUE;
44     pkt->flags = 0;
45     pkt->stream_index = 0;
46 }
47
48 int av_new_packet(AVPacket *pkt, int size);
49
50 /**
51  * Free a packet
52  *
53  * @param pkt packet to free
54  */
55 static inline void av_free_packet(AVPacket *pkt)
56 {
57     if (pkt && pkt->destruct) {
58         pkt->destruct(pkt);
59     }
60 }
61
62 /*************************************************/
63 /* fractional numbers for exact pts handling */
64
65 /* the exact value of the fractional number is: 'val + num / den'. num
66    is assumed to be such as 0 <= num < den */
67 typedef struct AVFrac {
68     int64_t val, num, den; 
69 } AVFrac;
70
71 void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
72 void av_frac_add(AVFrac *f, int64_t incr);
73 void av_frac_set(AVFrac *f, int64_t val);
74
75 /*************************************************/
76 /* input/output formats */
77
78 struct AVFormatContext;
79
80 /* this structure contains the data a format has to probe a file */
81 typedef struct AVProbeData {
82     const char *filename;
83     unsigned char *buf;
84     int buf_size;
85 } AVProbeData;
86
87 #define AVPROBE_SCORE_MAX 100
88
89 typedef struct AVFormatParameters {
90     int frame_rate;
91     int frame_rate_base;
92     int sample_rate;
93     int channels;
94     int width;
95     int height;
96     enum PixelFormat pix_fmt;
97     struct AVImageFormat *image_format;
98     int channel; /* used to select dv channel */
99     const char *device; /* video4linux, audio or DV device */
100     const char *standard; /* tv standard, NTSC, PAL, SECAM */
101 } AVFormatParameters;
102
103 #define AVFMT_NOFILE        0x0001 /* no file should be opened */
104 #define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */ 
105 #define AVFMT_NOHEADER      0x0004 /* signal that no header is present
106                                       (streams are added dynamically) */
107 #define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
108 #define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
109                                       raw picture data */
110
111 typedef struct AVOutputFormat {
112     const char *name;
113     const char *long_name;
114     const char *mime_type;
115     const char *extensions; /* comma separated extensions */
116     /* size of private data so that it can be allocated in the wrapper */
117     int priv_data_size;
118     /* output support */
119     enum CodecID audio_codec; /* default audio codec */
120     enum CodecID video_codec; /* default video codec */
121     int (*write_header)(struct AVFormatContext *);
122     /* XXX: change prototype for 64 bit pts */
123     int (*write_packet)(struct AVFormatContext *, 
124                         int stream_index,
125                         unsigned char *buf, int size, int force_pts);
126     int (*write_trailer)(struct AVFormatContext *);
127     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
128     int flags;
129     /* currently only used to set pixel format if not YUV420P */
130     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
131     /* private fields */
132     struct AVOutputFormat *next;
133 } AVOutputFormat;
134
135 typedef struct AVInputFormat {
136     const char *name;
137     const char *long_name;
138     /* size of private data so that it can be allocated in the wrapper */
139     int priv_data_size;
140     /* tell if a given file has a chance of being parsing by this format */
141     int (*read_probe)(AVProbeData *);
142     /* read the format header and initialize the AVFormatContext
143        structure. Return 0 if OK. 'ap' if non NULL contains
144        additionnal paramters. Only used in raw format right
145        now. 'av_new_stream' should be called to create new streams.  */
146     int (*read_header)(struct AVFormatContext *,
147                        AVFormatParameters *ap);
148     /* read one packet and put it in 'pkt'. pts and flags are also
149        set. 'av_new_stream' can be called only if the flag
150        AVFMT_NOHEADER is used. */
151     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
152     /* close the stream. The AVFormatContext and AVStreams are not
153        freed by this function */
154     int (*read_close)(struct AVFormatContext *);
155     /* seek at or before a given pts (given in microsecond). The pts
156        origin is defined by the stream */
157     int (*read_seek)(struct AVFormatContext *, int64_t pts);
158     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
159     int flags;
160     /* if extensions are defined, then no probe is done. You should
161        usually not use extension format guessing because it is not
162        reliable enough */
163     const char *extensions;
164     /* general purpose read only value that the format can use */
165     int value;
166     /* private fields */
167     struct AVInputFormat *next;
168 } AVInputFormat;
169
170 typedef struct AVStream {
171     int index;    /* stream index in AVFormatContext */
172     int id;       /* format specific stream id */
173     AVCodecContext codec; /* codec context */
174     int r_frame_rate;     /* real frame rate of the stream */
175     int r_frame_rate_base;/* real frame rate base of the stream */
176     void *priv_data;
177     /* internal data used in av_find_stream_info() */
178     int codec_info_state;     
179     int codec_info_nb_repeat_frames;
180     int codec_info_nb_real_frames;
181     /* PTS generation when outputing stream */
182     AVFrac pts;
183     /* ffmpeg.c private use */
184     int stream_copy; /* if TRUE, just copy stream */
185     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
186      * MN:dunno if thats the right place, for it */
187     float quality; 
188     /* decoding: position of the first frame of the component, in
189        AV_TIME_BASE fractional seconds. */
190     int64_t start_time; 
191     /* decoding: duration of the stream, in AV_TIME_BASE fractional
192        seconds. */
193     int64_t duration;
194 } AVStream;
195
196 #define MAX_STREAMS 20
197
198 /* format I/O context */
199 typedef struct AVFormatContext {
200     /* can only be iformat or oformat, not both at the same time */
201     struct AVInputFormat *iformat;
202     struct AVOutputFormat *oformat;
203     void *priv_data;
204     ByteIOContext pb;
205     int nb_streams;
206     AVStream *streams[MAX_STREAMS];
207     char filename[1024]; /* input or output filename */
208     /* stream info */
209     char title[512];
210     char author[512];
211     char copyright[512];
212     char comment[512];
213     int flags; /* format specific flags */
214     /* private data for pts handling (do not modify directly) */
215     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
216     int pts_num, pts_den; /* value to convert to seconds */
217     /* This buffer is only needed when packets were already buffered but
218        not decoded, for example to get the codec parameters in mpeg
219        streams */
220     struct AVPacketList *packet_buffer;
221
222     /* decoding: position of the first frame of the component, in
223        AV_TIME_BASE fractional seconds. NEVER set this value directly:
224        it is deduced from the AVStream values.  */
225     int64_t start_time; 
226     /* decoding: duration of the stream, in AV_TIME_BASE fractional
227        seconds. NEVER set this value directly: it is deduced from the
228        AVStream values.  */
229     int64_t duration;
230     /* decoding: total file size. 0 if unknown */
231     int64_t file_size;
232     /* decoding: total stream bitrate in bit/s, 0 if not
233        available. Never set it directly if the file_size and the
234        duration are known as ffmpeg can compute it automatically. */
235     int bit_rate;
236 } AVFormatContext;
237
238 typedef struct AVPacketList {
239     AVPacket pkt;
240     struct AVPacketList *next;
241 } AVPacketList;
242
243 extern AVInputFormat *first_iformat;
244 extern AVOutputFormat *first_oformat;
245
246 /* still image support */
247 struct AVInputImageContext;
248 typedef struct AVInputImageContext AVInputImageContext;
249
250 typedef struct AVImageInfo {
251     enum PixelFormat pix_fmt; /* requested pixel format */
252     int width; /* requested width */
253     int height; /* requested height */
254     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
255     AVPicture pict; /* returned allocated image */
256 } AVImageInfo;
257
258 /* AVImageFormat.flags field constants */
259 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
260
261 typedef struct AVImageFormat {
262     const char *name;
263     const char *extensions;
264     /* tell if a given file has a chance of being parsing by this format */
265     int (*img_probe)(AVProbeData *);
266     /* read a whole image. 'alloc_cb' is called when the image size is
267        known so that the caller can allocate the image. If 'allo_cb'
268        returns non zero, then the parsing is aborted. Return '0' if
269        OK. */
270     int (*img_read)(ByteIOContext *, 
271                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
272     /* write the image */
273     int supported_pixel_formats; /* mask of supported formats for output */
274     int (*img_write)(ByteIOContext *, AVImageInfo *);
275     int flags;
276     struct AVImageFormat *next;
277 } AVImageFormat;
278
279 void av_register_image_format(AVImageFormat *img_fmt);
280 AVImageFormat *av_probe_image_format(AVProbeData *pd);
281 AVImageFormat *guess_image_format(const char *filename);
282 int av_read_image(ByteIOContext *pb, const char *filename,
283                   AVImageFormat *fmt,
284                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
285 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
286
287 extern AVImageFormat *first_image_format;
288
289 extern AVImageFormat pnm_image_format;
290 extern AVImageFormat pbm_image_format;
291 extern AVImageFormat pgm_image_format;
292 extern AVImageFormat ppm_image_format;
293 extern AVImageFormat pam_image_format;
294 extern AVImageFormat pgmyuv_image_format;
295 extern AVImageFormat yuv_image_format;
296 #ifdef CONFIG_ZLIB
297 extern AVImageFormat png_image_format;
298 #endif
299 extern AVImageFormat jpeg_image_format;
300 extern AVImageFormat gif_image_format;
301
302 /* XXX: use automatic init with either ELF sections or C file parser */
303 /* modules */
304
305 /* mpeg.c */
306 extern AVInputFormat mpegps_demux;
307 int mpegps_init(void);
308
309 /* mpegts.c */
310 extern AVInputFormat mpegts_demux;
311 int mpegts_init(void);
312
313 /* rm.c */
314 int rm_init(void);
315
316 /* crc.c */
317 int crc_init(void);
318
319 /* img.c */
320 int img_init(void);
321
322 /* asf.c */
323 int asf_init(void);
324
325 /* avienc.c */
326 int avienc_init(void);
327
328 /* avidec.c */
329 int avidec_init(void);
330
331 /* swf.c */
332 int swf_init(void);
333
334 /* mov.c */
335 int mov_init(void);
336
337 /* flvenc.c */
338 int flvenc_init(void);
339
340 /* flvdec.c */
341 int flvdec_init(void);
342
343 /* jpeg.c */
344 int jpeg_init(void);
345
346 /* gif.c */
347 int gif_init(void);
348
349 /* au.c */
350 int au_init(void);
351
352 /* amr.c */
353 int amr_init(void);
354
355 /* wav.c */
356 int wav_init(void);
357
358 /* raw.c */
359 int raw_init(void);
360
361 /* yuv4mpeg.c */
362 int yuv4mpeg_init(void);
363
364 /* ogg.c */
365 int ogg_init(void);
366
367 /* dv.c */
368 int dv_init(void);
369
370 /* ffm.c */
371 int ffm_init(void);
372
373 /* rtsp.c */
374 extern AVInputFormat redir_demux;
375 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
376
377 /* 4xm.c */
378 int fourxm_init(void);
379
380 #include "rtp.h"
381
382 #include "rtsp.h"
383
384 /* yuv4mpeg.c */
385 extern AVOutputFormat yuv4mpegpipe_oformat;
386
387 /* utils.c */
388 void av_register_input_format(AVInputFormat *format);
389 void av_register_output_format(AVOutputFormat *format);
390 AVOutputFormat *guess_stream_format(const char *short_name, 
391                                     const char *filename, const char *mime_type);
392 AVOutputFormat *guess_format(const char *short_name, 
393                              const char *filename, const char *mime_type);
394
395 void av_hex_dump(uint8_t *buf, int size);
396
397 void av_register_all(void);
398
399 typedef struct FifoBuffer {
400     uint8_t *buffer;
401     uint8_t *rptr, *wptr, *end;
402 } FifoBuffer;
403
404 int fifo_init(FifoBuffer *f, int size);
405 void fifo_free(FifoBuffer *f);
406 int fifo_size(FifoBuffer *f, uint8_t *rptr);
407 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
408 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
409
410 /* media file input */
411 AVInputFormat *av_find_input_format(const char *short_name);
412 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
413 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
414                        AVInputFormat *fmt,
415                        int buf_size,
416                        AVFormatParameters *ap);
417
418 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
419 #define AVERROR_IO          (-2)  /* i/o error */
420 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
421 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
422 #define AVERROR_NOMEM       (-5)  /* not enough memory */
423 #define AVERROR_NOFMT       (-6)  /* unknown format */
424
425 int av_find_stream_info(AVFormatContext *ic);
426 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
427 void av_close_input_file(AVFormatContext *s);
428 AVStream *av_new_stream(AVFormatContext *s, int id);
429 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
430                      int pts_num, int pts_den);
431
432 /* media file output */
433 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
434 int av_write_header(AVFormatContext *s);
435 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
436                    int size);
437 int av_write_trailer(AVFormatContext *s);
438
439 void dump_format(AVFormatContext *ic,
440                  int index, 
441                  const char *url,
442                  int is_output);
443 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
444 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
445 int64_t parse_date(const char *datestr, int duration);
446
447 int64_t av_gettime(void);
448
449 /* ffm specific for ffserver */
450 #define FFM_PACKET_SIZE 4096
451 offset_t ffm_read_write_index(int fd);
452 void ffm_write_write_index(int fd, offset_t pos);
453 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
454
455 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
456
457 int get_frame_filename(char *buf, int buf_size,
458                        const char *path, int number);
459 int filename_number_test(const char *filename);
460
461 /* grab specific */
462 int video_grab_init(void);
463 int audio_init(void);
464
465 /* DV1394 */
466 int dv1394_init(void);
467
468 #ifdef HAVE_AV_CONFIG_H
469 int strstart(const char *str, const char *val, const char **ptr);
470 int stristart(const char *str, const char *val, const char **ptr);
471 void pstrcpy(char *buf, int buf_size, const char *str);
472 char *pstrcat(char *buf, int buf_size, const char *s);
473
474 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
475
476 #define dynarray_add(tab, nb_ptr, elem)\
477 do {\
478     typeof(tab) _tab = (tab);\
479     typeof(elem) _elem = (elem);\
480     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
481     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
482 } while(0)
483
484 struct in_addr;
485 int resolve_host(struct in_addr *sin_addr, const char *hostname);
486
487 void url_split(char *proto, int proto_size,
488                char *hostname, int hostname_size,
489                int *port_ptr,
490                char *path, int path_size,
491                const char *url);
492
493 int match_ext(const char *filename, const char *extensions);
494
495 #endif /* HAVE_AV_CONFIG_H */
496
497 #ifdef __cplusplus
498 }
499 #endif
500
501 #endif /* AVFORMAT_H */