ID3 parsing and generation in MP3 format
[libav.git] / libavformat / avformat.h
CommitLineData
fb025625
FB
1#ifndef AVFORMAT_H
2#define AVFORMAT_H
de6d9b64 3
02d697aa
ZK
4#ifdef __cplusplus
5extern "C" {
6#endif
7
8026c3b5
AB
8#define LIBAVFORMAT_VERSION_INT 0x000408
9#define LIBAVFORMAT_VERSION "0.4.8"
6a58e151
FB
10#define LIBAVFORMAT_BUILD 4607
11#define LIBAVFORMAT_BUILD_STR "4607"
8026c3b5
AB
12
13#define LIBAVFORMAT_IDENT "FFmpeg" LIBAVFORMAT_VERSION "b" LIBAVFORMAT_BUILD_STR
4b1f4f23 14
f71869a4
FB
15#include <time.h>
16
de6d9b64
FB
17#include "avcodec.h"
18
de6d9b64
FB
19#include "avio.h"
20
21/* packet functions */
22
ee404803
FB
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
fb025625 33
de6d9b64 34typedef struct AVPacket {
0c1a9eda
ZK
35 int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
36 uint8_t *data;
6fa5a56c
FB
37 int size;
38 int stream_index;
39 int flags;
40 int duration;
41 void (*destruct)(struct AVPacket *);
42 void *priv;
de6d9b64 43} AVPacket;
6fa5a56c
FB
44#define PKT_FLAG_KEY 0x0001
45
46static inline void av_init_packet(AVPacket *pkt)
47{
48 pkt->pts = AV_NOPTS_VALUE;
49 pkt->flags = 0;
50 pkt->stream_index = 0;
51}
de6d9b64
FB
52
53int av_new_packet(AVPacket *pkt, int size);
6fa5a56c
FB
54
55/**
56 * Free a packet
57 *
58 * @param pkt packet to free
59 */
60static inline void av_free_packet(AVPacket *pkt)
61{
342474ab
MN
62 if (pkt && pkt->destruct) {
63 pkt->destruct(pkt);
64 }
6fa5a56c 65}
de6d9b64
FB
66
67/*************************************************/
916c80e9
FB
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 */
72typedef struct AVFrac {
0c1a9eda 73 int64_t val, num, den;
916c80e9
FB
74} AVFrac;
75
0c1a9eda
ZK
76void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
77void av_frac_add(AVFrac *f, int64_t incr);
78void av_frac_set(AVFrac *f, int64_t val);
916c80e9
FB
79
80/*************************************************/
b9a281db 81/* input/output formats */
de6d9b64
FB
82
83struct AVFormatContext;
b9a281db
FB
84
85/* this structure contains the data a format has to probe a file */
86typedef struct AVProbeData {
5c91a675 87 const char *filename;
b9a281db
FB
88 unsigned char *buf;
89 int buf_size;
90} AVProbeData;
91
92#define AVPROBE_SCORE_MAX 100
de6d9b64
FB
93
94typedef struct AVFormatParameters {
95 int frame_rate;
14bea432 96 int frame_rate_base;
de6d9b64
FB
97 int sample_rate;
98 int channels;
99 int width;
100 int height;
4606ac8d 101 enum PixelFormat pix_fmt;
290c5fa6 102 struct AVImageFormat *image_format;
7f172339
FB
103 int channel; /* used to select dv channel */
104 const char *device; /* video4linux, audio or DV device */
e3ee3283 105 const char *standard; /* tv standard, NTSC, PAL, SECAM */
de6d9b64
FB
106} AVFormatParameters;
107
b9a281db
FB
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 */
fb025625
FB
113#define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
114 raw picture data */
b9a281db
FB
115
116typedef struct AVOutputFormat {
de6d9b64
FB
117 const char *name;
118 const char *long_name;
119 const char *mime_type;
120 const char *extensions; /* comma separated extensions */
b9a281db
FB
121 /* size of private data so that it can be allocated in the wrapper */
122 int priv_data_size;
de6d9b64
FB
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 *);
1e51d801 127 /* XXX: change prototype for 64 bit pts */
de6d9b64
FB
128 int (*write_packet)(struct AVFormatContext *,
129 int stream_index,
10bb7023 130 unsigned char *buf, int size, int force_pts);
de6d9b64 131 int (*write_trailer)(struct AVFormatContext *);
b9a281db
FB
132 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
133 int flags;
290c5fa6
FB
134 /* currently only used to set pixel format if not YUV420P */
135 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
b9a281db
FB
136 /* private fields */
137 struct AVOutputFormat *next;
138} AVOutputFormat;
de6d9b64 139
b9a281db
FB
140typedef 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
de6d9b64 148 structure. Return 0 if OK. 'ap' if non NULL contains
b9a281db
FB
149 additionnal paramters. Only used in raw format right
150 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
151 int (*read_header)(struct AVFormatContext *,
152 AVFormatParameters *ap);
b9a281db
FB
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. */
de6d9b64
FB
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 */
0c1a9eda 162 int (*read_seek)(struct AVFormatContext *, int64_t pts);
b9a281db 163 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
de6d9b64 164 int flags;
b9a281db
FB
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;
de6d9b64
FB
174
175typedef struct AVStream {
b9a281db
FB
176 int index; /* stream index in AVFormatContext */
177 int id; /* format specific stream id */
de6d9b64 178 AVCodecContext codec; /* codec context */
76c0441b 179 int r_frame_rate; /* real frame rate of the stream */
14bea432 180 int r_frame_rate_base;/* real frame rate base of the stream */
de6d9b64 181 void *priv_data;
b9a281db
FB
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;
1e51d801
FB
186 /* PTS generation when outputing stream */
187 AVFrac pts;
a48b7a6b
FB
188 /* ffmpeg.c private use */
189 int stream_copy; /* if TRUE, just copy stream */
1e491e29
MN
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;
ee404803
FB
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;
de6d9b64
FB
199} AVStream;
200
201#define MAX_STREAMS 20
202
203/* format I/O context */
204typedef struct AVFormatContext {
b9a281db
FB
205 /* can only be iformat or oformat, not both at the same time */
206 struct AVInputFormat *iformat;
207 struct AVOutputFormat *oformat;
de6d9b64
FB
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];
6a58e151
FB
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
92b3e125 223 int flags; /* format specific flags */
916c80e9
FB
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 */
de6d9b64
FB
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 */
ee404803
FB
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;
de6d9b64
FB
246} AVFormatContext;
247
248typedef struct AVPacketList {
249 AVPacket pkt;
250 struct AVPacketList *next;
251} AVPacketList;
252
b9a281db
FB
253extern AVInputFormat *first_iformat;
254extern AVOutputFormat *first_oformat;
de6d9b64 255
290c5fa6
FB
256/* still image support */
257struct AVInputImageContext;
258typedef struct AVInputImageContext AVInputImageContext;
259
260typedef struct AVImageInfo {
261 enum PixelFormat pix_fmt; /* requested pixel format */
262 int width; /* requested width */
263 int height; /* requested height */
7e2e1abf 264 int interleaved; /* image is interleaved (e.g. interleaved GIF) */
290c5fa6
FB
265 AVPicture pict; /* returned allocated image */
266} AVImageInfo;
267
3b1a27e0 268/* AVImageFormat.flags field constants */
7e2e1abf 269#define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
3b1a27e0 270
290c5fa6
FB
271typedef 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 *);
3b1a27e0 285 int flags;
290c5fa6
FB
286 struct AVImageFormat *next;
287} AVImageFormat;
288
289void av_register_image_format(AVImageFormat *img_fmt);
290AVImageFormat *av_probe_image_format(AVProbeData *pd);
291AVImageFormat *guess_image_format(const char *filename);
292int av_read_image(ByteIOContext *pb, const char *filename,
293 AVImageFormat *fmt,
294 int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
295int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
296
297extern AVImageFormat *first_image_format;
298
299extern AVImageFormat pnm_image_format;
300extern AVImageFormat pbm_image_format;
301extern AVImageFormat pgm_image_format;
302extern AVImageFormat ppm_image_format;
8975ba81 303extern AVImageFormat pam_image_format;
290c5fa6
FB
304extern AVImageFormat pgmyuv_image_format;
305extern AVImageFormat yuv_image_format;
3a13f6bd 306#ifdef CONFIG_ZLIB
0e04e4e9 307extern AVImageFormat png_image_format;
3a13f6bd 308#endif
0250738f 309extern AVImageFormat jpeg_image_format;
cdc90af0 310extern AVImageFormat gif_image_format;
290c5fa6 311
b9a281db
FB
312/* XXX: use automatic init with either ELF sections or C file parser */
313/* modules */
de6d9b64 314
b9a281db 315/* mpeg.c */
ee404803 316extern AVInputFormat mpegps_demux;
b9a281db
FB
317int mpegps_init(void);
318
319/* mpegts.c */
320extern AVInputFormat mpegts_demux;
321int mpegts_init(void);
de6d9b64 322
b9a281db
FB
323/* rm.c */
324int rm_init(void);
325
326/* crc.c */
327int crc_init(void);
328
329/* img.c */
330int img_init(void);
331
332/* asf.c */
333int asf_init(void);
de6d9b64
FB
334
335/* avienc.c */
b9a281db 336int avienc_init(void);
de6d9b64 337
b9a281db
FB
338/* avidec.c */
339int avidec_init(void);
6cea494e 340
b9a281db
FB
341/* swf.c */
342int swf_init(void);
343
344/* mov.c */
345int mov_init(void);
de6d9b64 346
1cb5f7fd
MN
347/* movenc.c */
348int movenc_init(void);
349
d4f5d74a
GM
350/* flvenc.c */
351int flvenc_init(void);
352
353/* flvdec.c */
354int flvdec_init(void);
355
b9a281db
FB
356/* jpeg.c */
357int jpeg_init(void);
de6d9b64 358
6cea494e 359/* gif.c */
b9a281db
FB
360int gif_init(void);
361
6cea494e 362/* au.c */
b9a281db 363int au_init(void);
6cea494e 364
bc634f6f
ZK
365/* amr.c */
366int amr_init(void);
367
de6d9b64 368/* wav.c */
b9a281db 369int wav_init(void);
de6d9b64
FB
370
371/* raw.c */
b9a281db 372int raw_init(void);
de6d9b64 373
6a58e151
FB
374/* mp3.c */
375int mp3_init(void);
376
2864dfd5
RFI
377/* yuv4mpeg.c */
378int yuv4mpeg_init(void);
379
81e0d0b4
MH
380/* ogg.c */
381int ogg_init(void);
382
f20dca40
FB
383/* dv.c */
384int dv_init(void);
385
de6d9b64 386/* ffm.c */
b9a281db 387int ffm_init(void);
de6d9b64 388
fb025625
FB
389/* rtsp.c */
390extern AVInputFormat redir_demux;
391int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
392
3c96b4ef
MM
393/* 4xm.c */
394int fourxm_init(void);
395
3f16d933
MM
396/* psxstr.c */
397int str_init(void);
398
3ef8be2b
MM
399/* idroq.c */
400int roq_init(void);
401
402/* ipmovie.c */
403int ipmovie_init(void);
404
3aa180b8
AB
405/* nut.c */
406int nut_init(void);
407
493645eb
MM
408/* wc3movie.c */
409int wc3_init(void);
410
fb025625
FB
411#include "rtp.h"
412
413#include "rtsp.h"
414
290c5fa6
FB
415/* yuv4mpeg.c */
416extern AVOutputFormat yuv4mpegpipe_oformat;
417
b9a281db 418/* utils.c */
b9a281db
FB
419void av_register_input_format(AVInputFormat *format);
420void av_register_output_format(AVOutputFormat *format);
36ada60c
PG
421AVOutputFormat *guess_stream_format(const char *short_name,
422 const char *filename, const char *mime_type);
b9a281db
FB
423AVOutputFormat *guess_format(const char *short_name,
424 const char *filename, const char *mime_type);
de6d9b64 425
0c1a9eda 426void av_hex_dump(uint8_t *buf, int size);
de6d9b64 427
94988531 428void av_register_all(void);
de6d9b64
FB
429
430typedef struct FifoBuffer {
0c1a9eda
ZK
431 uint8_t *buffer;
432 uint8_t *rptr, *wptr, *end;
de6d9b64
FB
433} FifoBuffer;
434
435int fifo_init(FifoBuffer *f, int size);
436void fifo_free(FifoBuffer *f);
0c1a9eda
ZK
437int fifo_size(FifoBuffer *f, uint8_t *rptr);
438int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
439void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
de6d9b64 440
b9a281db
FB
441/* media file input */
442AVInputFormat *av_find_input_format(const char *short_name);
94988531 443AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
b9a281db
FB
444int 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
456int av_find_stream_info(AVFormatContext *ic);
de6d9b64
FB
457int av_read_packet(AVFormatContext *s, AVPacket *pkt);
458void av_close_input_file(AVFormatContext *s);
b9a281db 459AVStream *av_new_stream(AVFormatContext *s, int id);
916c80e9
FB
460void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
461 int pts_num, int pts_den);
de6d9b64 462
b9a281db 463/* media file output */
290c5fa6 464int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
b9a281db 465int av_write_header(AVFormatContext *s);
1e51d801
FB
466int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf,
467 int size);
b9a281db 468int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
469
470void dump_format(AVFormatContext *ic,
471 int index,
472 const char *url,
473 int is_output);
474int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
445f1b83 475int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
0c1a9eda 476int64_t parse_date(const char *datestr, int duration);
de6d9b64 477
0c1a9eda 478int64_t av_gettime(void);
94988531 479
de6d9b64
FB
480/* ffm specific for ffserver */
481#define FFM_PACKET_SIZE 4096
482offset_t ffm_read_write_index(int fd);
483void ffm_write_write_index(int fd, offset_t pos);
484void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
485
486int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
487
813cae4b
FB
488int get_frame_filename(char *buf, int buf_size,
489 const char *path, int number);
b9a281db 490int filename_number_test(const char *filename);
96baaa6a 491
b9a281db
FB
492/* grab specific */
493int video_grab_init(void);
494int audio_init(void);
96baaa6a 495
86fd51fb
FB
496/* DV1394 */
497int dv1394_init(void);
fb025625
FB
498
499#ifdef HAVE_AV_CONFIG_H
f71869a4
FB
500
501#include "os_support.h"
502
fb025625
FB
503int strstart(const char *str, const char *val, const char **ptr);
504int stristart(const char *str, const char *val, const char **ptr);
505void pstrcpy(char *buf, int buf_size, const char *str);
506char *pstrcat(char *buf, int buf_size, const char *s);
fb025625 507
39f472c3
FB
508void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
509
510#define dynarray_add(tab, nb_ptr, elem)\
511do {\
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
f71869a4
FB
518time_t mktimegm(struct tm *tm);
519const char *small_strptime(const char *p, const char *fmt,
520 struct tm *dt);
521
fb025625
FB
522struct in_addr;
523int resolve_host(struct in_addr *sin_addr, const char *hostname);
524
525void 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
a941f391
FB
531int match_ext(const char *filename, const char *extensions);
532
fb025625
FB
533#endif /* HAVE_AV_CONFIG_H */
534
02d697aa
ZK
535#ifdef __cplusplus
536}
537#endif
538
fb025625 539#endif /* AVFORMAT_H */