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