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