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