86ddee4b5294133caa4444bb92127fa00a532ff9
[libav.git] / libavformat / avformat.h
1 #ifndef AVFORMAT_H
2 #define AVFORMAT_H
3
4 #define LIBAVFORMAT_VERSION_INT 0x000406
5 #define LIBAVFORMAT_VERSION "0.4.6"
6 #define LIBAVFORMAT_BUILD 4602
7
8 #include "avcodec.h"
9
10 #include "avio.h"
11
12 /* packet functions */
13
14 #define AV_NOPTS_VALUE 0
15
16 typedef struct AVPacket {
17 INT64 pts; /* presentation time stamp in stream units (set av_set_pts_info) */
18 UINT8 *data;
19 int size;
20 int stream_index;
21 int flags;
22 int duration;
23 #define PKT_FLAG_KEY 0x0001
24 } AVPacket;
25
26 int av_new_packet(AVPacket *pkt, int size);
27 void av_free_packet(AVPacket *pkt);
28
29 /*************************************************/
30 /* fractional numbers for exact pts handling */
31
32 /* the exact value of the fractional number is: 'val + num / den'. num
33 is assumed to be such as 0 <= num < den */
34 typedef struct AVFrac {
35 INT64 val, num, den;
36 } AVFrac;
37
38 void av_frac_init(AVFrac *f, INT64 val, INT64 num, INT64 den);
39 void av_frac_add(AVFrac *f, INT64 incr);
40 void av_frac_set(AVFrac *f, INT64 val);
41
42 /*************************************************/
43 /* input/output formats */
44
45 struct AVFormatContext;
46
47 /* this structure contains the data a format has to probe a file */
48 typedef struct AVProbeData {
49 char *filename;
50 unsigned char *buf;
51 int buf_size;
52 } AVProbeData;
53
54 #define AVPROBE_SCORE_MAX 100
55
56 typedef struct AVFormatParameters {
57 int frame_rate;
58 int sample_rate;
59 int channels;
60 int width;
61 int height;
62 enum PixelFormat pix_fmt;
63 } AVFormatParameters;
64
65 #define AVFMT_NOFILE 0x0001 /* no file should be opened */
66 #define AVFMT_NEEDNUMBER 0x0002 /* needs '%d' in filename */
67 #define AVFMT_NOHEADER 0x0004 /* signal that no header is present
68 (streams are added dynamically) */
69 #define AVFMT_SHOW_IDS 0x0008 /* show format stream IDs numbers */
70 #define AVFMT_RGB24 0x0010 /* force RGB24 output for ppm (hack
71 - need better api) */
72 #define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
73 raw picture data */
74
75 typedef struct AVOutputFormat {
76 const char *name;
77 const char *long_name;
78 const char *mime_type;
79 const char *extensions; /* comma separated extensions */
80 /* size of private data so that it can be allocated in the wrapper */
81 int priv_data_size;
82 /* output support */
83 enum CodecID audio_codec; /* default audio codec */
84 enum CodecID video_codec; /* default video codec */
85 int (*write_header)(struct AVFormatContext *);
86 /* XXX: change prototype for 64 bit pts */
87 int (*write_packet)(struct AVFormatContext *,
88 int stream_index,
89 unsigned char *buf, int size, int force_pts);
90 int (*write_trailer)(struct AVFormatContext *);
91 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
92 int flags;
93 /* private fields */
94 struct AVOutputFormat *next;
95 } AVOutputFormat;
96
97 typedef struct AVInputFormat {
98 const char *name;
99 const char *long_name;
100 /* size of private data so that it can be allocated in the wrapper */
101 int priv_data_size;
102 /* tell if a given file has a chance of being parsing by this format */
103 int (*read_probe)(AVProbeData *);
104 /* read the format header and initialize the AVFormatContext
105 structure. Return 0 if OK. 'ap' if non NULL contains
106 additionnal paramters. Only used in raw format right
107 now. 'av_new_stream' should be called to create new streams. */
108 int (*read_header)(struct AVFormatContext *,
109 AVFormatParameters *ap);
110 /* read one packet and put it in 'pkt'. pts and flags are also
111 set. 'av_new_stream' can be called only if the flag
112 AVFMT_NOHEADER is used. */
113 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
114 /* close the stream. The AVFormatContext and AVStreams are not
115 freed by this function */
116 int (*read_close)(struct AVFormatContext *);
117 /* seek at or before a given pts (given in microsecond). The pts
118 origin is defined by the stream */
119 int (*read_seek)(struct AVFormatContext *, INT64 pts);
120 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
121 int flags;
122 /* if extensions are defined, then no probe is done. You should
123 usually not use extension format guessing because it is not
124 reliable enough */
125 const char *extensions;
126 /* general purpose read only value that the format can use */
127 int value;
128 /* private fields */
129 struct AVInputFormat *next;
130 } AVInputFormat;
131
132 typedef struct AVStream {
133 int index; /* stream index in AVFormatContext */
134 int id; /* format specific stream id */
135 AVCodecContext codec; /* codec context */
136 int r_frame_rate; /* real frame rate of the stream */
137 uint64_t time_length; /* real length of the stream in miliseconds */
138 void *priv_data;
139 /* internal data used in av_find_stream_info() */
140 int codec_info_state;
141 int codec_info_nb_repeat_frames;
142 int codec_info_nb_real_frames;
143 /* PTS generation when outputing stream */
144 AVFrac pts;
145 /* ffmpeg.c private use */
146 int stream_copy; /* if TRUE, just copy stream */
147 /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
148 * MN:dunno if thats the right place, for it */
149 float quality;
150 } AVStream;
151
152 #define MAX_STREAMS 20
153
154 /* format I/O context */
155 typedef struct AVFormatContext {
156 /* can only be iformat or oformat, not both at the same time */
157 struct AVInputFormat *iformat;
158 struct AVOutputFormat *oformat;
159 void *priv_data;
160 ByteIOContext pb;
161 int nb_streams;
162 AVStream *streams[MAX_STREAMS];
163 char filename[1024]; /* input or output filename */
164 /* stream info */
165 char title[512];
166 char author[512];
167 char copyright[512];
168 char comment[512];
169 int flags; /* format specific flags */
170 /* private data for pts handling (do not modify directly) */
171 int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
172 int pts_num, pts_den; /* value to convert to seconds */
173 /* This buffer is only needed when packets were already buffered but
174 not decoded, for example to get the codec parameters in mpeg
175 streams */
176 struct AVPacketList *packet_buffer;
177 } AVFormatContext;
178
179 typedef struct AVPacketList {
180 AVPacket pkt;
181 struct AVPacketList *next;
182 } AVPacketList;
183
184 extern AVInputFormat *first_iformat;
185 extern AVOutputFormat *first_oformat;
186
187 /* XXX: use automatic init with either ELF sections or C file parser */
188 /* modules */
189
190 /* mpeg.c */
191 int mpegps_init(void);
192
193 /* mpegts.c */
194 extern AVInputFormat mpegts_demux;
195 int mpegts_init(void);
196
197 /* rm.c */
198 int rm_init(void);
199
200 /* crc.c */
201 int crc_init(void);
202
203 /* img.c */
204 int img_init(void);
205
206 /* asf.c */
207 int asf_init(void);
208
209 /* avienc.c */
210 int avienc_init(void);
211
212 /* avidec.c */
213 int avidec_init(void);
214
215 /* swf.c */
216 int swf_init(void);
217
218 /* mov.c */
219 int mov_init(void);
220
221 /* jpeg.c */
222 int jpeg_init(void);
223
224 /* gif.c */
225 int gif_init(void);
226
227 /* au.c */
228 int au_init(void);
229
230 /* wav.c */
231 int wav_init(void);
232
233 /* raw.c */
234 int raw_init(void);
235
236 /* ogg.c */
237 int ogg_init(void);
238
239 /* dv.c */
240 int dv_init(void);
241
242 /* ffm.c */
243 int ffm_init(void);
244
245 /* rtsp.c */
246 extern AVInputFormat redir_demux;
247 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
248
249 #include "rtp.h"
250
251 #include "rtsp.h"
252
253 /* utils.c */
254 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
255 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
256
257 void av_register_input_format(AVInputFormat *format);
258 void av_register_output_format(AVOutputFormat *format);
259 AVOutputFormat *guess_stream_format(const char *short_name,
260 const char *filename, const char *mime_type);
261 AVOutputFormat *guess_format(const char *short_name,
262 const char *filename, const char *mime_type);
263
264 void av_hex_dump(UINT8 *buf, int size);
265
266 void av_register_all(void);
267
268 typedef struct FifoBuffer {
269 UINT8 *buffer;
270 UINT8 *rptr, *wptr, *end;
271 } FifoBuffer;
272
273 int fifo_init(FifoBuffer *f, int size);
274 void fifo_free(FifoBuffer *f);
275 int fifo_size(FifoBuffer *f, UINT8 *rptr);
276 int fifo_read(FifoBuffer *f, UINT8 *buf, int buf_size, UINT8 **rptr_ptr);
277 void fifo_write(FifoBuffer *f, UINT8 *buf, int size, UINT8 **wptr_ptr);
278
279 /* media file input */
280 AVInputFormat *av_find_input_format(const char *short_name);
281 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
282 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
283 AVInputFormat *fmt,
284 int buf_size,
285 AVFormatParameters *ap);
286
287 #define AVERROR_UNKNOWN (-1) /* unknown error */
288 #define AVERROR_IO (-2) /* i/o error */
289 #define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
290 #define AVERROR_INVALIDDATA (-4) /* invalid data found */
291 #define AVERROR_NOMEM (-5) /* not enough memory */
292 #define AVERROR_NOFMT (-6) /* unknown format */
293
294 int av_find_stream_info(AVFormatContext *ic);
295 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
296 void av_close_input_file(AVFormatContext *s);
297 AVStream *av_new_stream(AVFormatContext *s, int id);
298 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
299 int pts_num, int pts_den);
300
301 /* media file output */
302 int av_write_header(AVFormatContext *s);
303 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf,
304 int size);
305 int av_write_trailer(AVFormatContext *s);
306
307 void dump_format(AVFormatContext *ic,
308 int index,
309 const char *url,
310 int is_output);
311 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
312 INT64 parse_date(const char *datestr, int duration);
313
314 INT64 av_gettime(void);
315
316 /* ffm specific for ffserver */
317 #define FFM_PACKET_SIZE 4096
318 offset_t ffm_read_write_index(int fd);
319 void ffm_write_write_index(int fd, offset_t pos);
320 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
321
322 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
323
324 int get_frame_filename(char *buf, int buf_size,
325 const char *path, int number);
326 int filename_number_test(const char *filename);
327
328 /* grab specific */
329 int video_grab_init(void);
330 int audio_init(void);
331
332 extern const char *v4l_device;
333 extern const char *audio_device;
334
335 #ifdef HAVE_AV_CONFIG_H
336 int strstart(const char *str, const char *val, const char **ptr);
337 int stristart(const char *str, const char *val, const char **ptr);
338 void pstrcpy(char *buf, int buf_size, const char *str);
339 char *pstrcat(char *buf, int buf_size, const char *s);
340
341 struct in_addr;
342 int resolve_host(struct in_addr *sin_addr, const char *hostname);
343
344 void url_split(char *proto, int proto_size,
345 char *hostname, int hostname_size,
346 int *port_ptr,
347 char *path, int path_size,
348 const char *url);
349
350 int match_ext(const char *filename, const char *extensions);
351
352 #endif /* HAVE_AV_CONFIG_H */
353
354 #endif /* AVFORMAT_H */