dynamic array functions
[libav.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 0x000406
9 #define LIBAVFORMAT_VERSION "0.4.6"
10 #define LIBAVFORMAT_BUILD 4605
11
12 #include "avcodec.h"
13
14 #include "avio.h"
15
16 /* packet functions */
17
18 #define AV_NOPTS_VALUE 0
19
20 typedef struct AVPacket {
21 int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
22 uint8_t *data;
23 int size;
24 int stream_index;
25 int flags;
26 int duration;
27 void (*destruct)(struct AVPacket *);
28 void *priv;
29 } AVPacket;
30 #define PKT_FLAG_KEY 0x0001
31
32 static inline void av_init_packet(AVPacket *pkt)
33 {
34 pkt->pts = AV_NOPTS_VALUE;
35 pkt->flags = 0;
36 pkt->stream_index = 0;
37 }
38
39 int av_new_packet(AVPacket *pkt, int size);
40
41 /**
42 * Free a packet
43 *
44 * @param pkt packet to free
45 */
46 static inline void av_free_packet(AVPacket *pkt)
47 {
48 pkt->destruct(pkt);
49 }
50
51 /*************************************************/
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 */
56 typedef struct AVFrac {
57 int64_t val, num, den;
58 } AVFrac;
59
60 void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
61 void av_frac_add(AVFrac *f, int64_t incr);
62 void av_frac_set(AVFrac *f, int64_t val);
63
64 /*************************************************/
65 /* input/output formats */
66
67 struct AVFormatContext;
68
69 /* this structure contains the data a format has to probe a file */
70 typedef struct AVProbeData {
71 const char *filename;
72 unsigned char *buf;
73 int buf_size;
74 } AVProbeData;
75
76 #define AVPROBE_SCORE_MAX 100
77
78 typedef struct AVFormatParameters {
79 int frame_rate;
80 int frame_rate_base;
81 int sample_rate;
82 int channels;
83 int width;
84 int height;
85 enum PixelFormat pix_fmt;
86 struct AVImageFormat *image_format;
87 int channel; /* used to select dv channel */
88 const char *device; /* video4linux, audio or DV device */
89 } AVFormatParameters;
90
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 */
96 #define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
97 raw picture data */
98
99 typedef struct AVOutputFormat {
100 const char *name;
101 const char *long_name;
102 const char *mime_type;
103 const char *extensions; /* comma separated extensions */
104 /* size of private data so that it can be allocated in the wrapper */
105 int priv_data_size;
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 *);
110 /* XXX: change prototype for 64 bit pts */
111 int (*write_packet)(struct AVFormatContext *,
112 int stream_index,
113 unsigned char *buf, int size, int force_pts);
114 int (*write_trailer)(struct AVFormatContext *);
115 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
116 int flags;
117 /* currently only used to set pixel format if not YUV420P */
118 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
119 /* private fields */
120 struct AVOutputFormat *next;
121 } AVOutputFormat;
122
123 typedef 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
131 structure. Return 0 if OK. 'ap' if non NULL contains
132 additionnal paramters. Only used in raw format right
133 now. 'av_new_stream' should be called to create new streams. */
134 int (*read_header)(struct AVFormatContext *,
135 AVFormatParameters *ap);
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. */
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 */
145 int (*read_seek)(struct AVFormatContext *, int64_t pts);
146 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
147 int flags;
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;
157
158 typedef struct AVStream {
159 int index; /* stream index in AVFormatContext */
160 int id; /* format specific stream id */
161 AVCodecContext codec; /* codec context */
162 int r_frame_rate; /* real frame rate of the stream */
163 int r_frame_rate_base;/* real frame rate base of the stream */
164 uint64_t time_length; /* real length of the stream in miliseconds */
165 void *priv_data;
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;
170 /* PTS generation when outputing stream */
171 AVFrac pts;
172 /* ffmpeg.c private use */
173 int stream_copy; /* if TRUE, just copy stream */
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;
177 } AVStream;
178
179 #define MAX_STREAMS 20
180
181 /* format I/O context */
182 typedef struct AVFormatContext {
183 /* can only be iformat or oformat, not both at the same time */
184 struct AVInputFormat *iformat;
185 struct AVOutputFormat *oformat;
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];
196 int flags; /* format specific flags */
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 */
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
206 typedef struct AVPacketList {
207 AVPacket pkt;
208 struct AVPacketList *next;
209 } AVPacketList;
210
211 extern AVInputFormat *first_iformat;
212 extern AVOutputFormat *first_oformat;
213
214 /* still image support */
215 struct AVInputImageContext;
216 typedef struct AVInputImageContext AVInputImageContext;
217
218 typedef struct AVImageInfo {
219 enum PixelFormat pix_fmt; /* requested pixel format */
220 int width; /* requested width */
221 int height; /* requested height */
222 int interleaved; /* image is interleaved (e.g. interleaved GIF) */
223 AVPicture pict; /* returned allocated image */
224 } AVImageInfo;
225
226 /* AVImageFormat.flags field constants */
227 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
228
229 typedef 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 *);
243 int flags;
244 struct AVImageFormat *next;
245 } AVImageFormat;
246
247 void av_register_image_format(AVImageFormat *img_fmt);
248 AVImageFormat *av_probe_image_format(AVProbeData *pd);
249 AVImageFormat *guess_image_format(const char *filename);
250 int av_read_image(ByteIOContext *pb, const char *filename,
251 AVImageFormat *fmt,
252 int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
253 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
254
255 extern AVImageFormat *first_image_format;
256
257 extern AVImageFormat pnm_image_format;
258 extern AVImageFormat pbm_image_format;
259 extern AVImageFormat pgm_image_format;
260 extern AVImageFormat ppm_image_format;
261 extern AVImageFormat pam_image_format;
262 extern AVImageFormat pgmyuv_image_format;
263 extern AVImageFormat yuv_image_format;
264 #ifdef CONFIG_ZLIB
265 extern AVImageFormat png_image_format;
266 #endif
267 extern AVImageFormat jpeg_image_format;
268 extern AVImageFormat gif_image_format;
269
270 /* XXX: use automatic init with either ELF sections or C file parser */
271 /* modules */
272
273 /* mpeg.c */
274 int mpegps_init(void);
275
276 /* mpegts.c */
277 extern AVInputFormat mpegts_demux;
278 int mpegts_init(void);
279
280 /* rm.c */
281 int rm_init(void);
282
283 /* crc.c */
284 int crc_init(void);
285
286 /* img.c */
287 int img_init(void);
288
289 /* asf.c */
290 int asf_init(void);
291
292 /* avienc.c */
293 int avienc_init(void);
294
295 /* avidec.c */
296 int avidec_init(void);
297
298 /* swf.c */
299 int swf_init(void);
300
301 /* mov.c */
302 int mov_init(void);
303
304 /* jpeg.c */
305 int jpeg_init(void);
306
307 /* gif.c */
308 int gif_init(void);
309
310 /* au.c */
311 int au_init(void);
312
313 /* amr.c */
314 int amr_init(void);
315
316 /* wav.c */
317 int wav_init(void);
318
319 /* raw.c */
320 int raw_init(void);
321
322 /* ogg.c */
323 int ogg_init(void);
324
325 /* dv.c */
326 int dv_init(void);
327
328 /* ffm.c */
329 int ffm_init(void);
330
331 /* rtsp.c */
332 extern AVInputFormat redir_demux;
333 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
334
335 /* 4xm.c */
336 int fourxm_init(void);
337
338 #include "rtp.h"
339
340 #include "rtsp.h"
341
342 /* yuv4mpeg.c */
343 extern AVOutputFormat yuv4mpegpipe_oformat;
344
345 /* utils.c */
346 void av_register_input_format(AVInputFormat *format);
347 void av_register_output_format(AVOutputFormat *format);
348 AVOutputFormat *guess_stream_format(const char *short_name,
349 const char *filename, const char *mime_type);
350 AVOutputFormat *guess_format(const char *short_name,
351 const char *filename, const char *mime_type);
352
353 void av_hex_dump(uint8_t *buf, int size);
354
355 void av_register_all(void);
356
357 typedef struct FifoBuffer {
358 uint8_t *buffer;
359 uint8_t *rptr, *wptr, *end;
360 } FifoBuffer;
361
362 int fifo_init(FifoBuffer *f, int size);
363 void fifo_free(FifoBuffer *f);
364 int fifo_size(FifoBuffer *f, uint8_t *rptr);
365 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
366 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
367
368 /* media file input */
369 AVInputFormat *av_find_input_format(const char *short_name);
370 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
371 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
372 AVInputFormat *fmt,
373 int buf_size,
374 AVFormatParameters *ap);
375
376 #define AVERROR_UNKNOWN (-1) /* unknown error */
377 #define AVERROR_IO (-2) /* i/o error */
378 #define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
379 #define AVERROR_INVALIDDATA (-4) /* invalid data found */
380 #define AVERROR_NOMEM (-5) /* not enough memory */
381 #define AVERROR_NOFMT (-6) /* unknown format */
382
383 int av_find_stream_info(AVFormatContext *ic);
384 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
385 void av_close_input_file(AVFormatContext *s);
386 AVStream *av_new_stream(AVFormatContext *s, int id);
387 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
388 int pts_num, int pts_den);
389
390 /* media file output */
391 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
392 int av_write_header(AVFormatContext *s);
393 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf,
394 int size);
395 int av_write_trailer(AVFormatContext *s);
396
397 void dump_format(AVFormatContext *ic,
398 int index,
399 const char *url,
400 int is_output);
401 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
402 int64_t parse_date(const char *datestr, int duration);
403
404 int64_t av_gettime(void);
405
406 /* ffm specific for ffserver */
407 #define FFM_PACKET_SIZE 4096
408 offset_t ffm_read_write_index(int fd);
409 void ffm_write_write_index(int fd, offset_t pos);
410 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
411
412 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
413
414 int get_frame_filename(char *buf, int buf_size,
415 const char *path, int number);
416 int filename_number_test(const char *filename);
417
418 /* grab specific */
419 int video_grab_init(void);
420 int audio_init(void);
421
422 /* DV1394 */
423 int dv1394_init(void);
424
425 #ifdef HAVE_AV_CONFIG_H
426 int strstart(const char *str, const char *val, const char **ptr);
427 int stristart(const char *str, const char *val, const char **ptr);
428 void pstrcpy(char *buf, int buf_size, const char *str);
429 char *pstrcat(char *buf, int buf_size, const char *s);
430
431 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
432
433 #define dynarray_add(tab, nb_ptr, elem)\
434 do {\
435 typeof(tab) _tab = (tab);\
436 typeof(elem) _elem = (elem);\
437 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
438 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
439 } while(0)
440
441 struct in_addr;
442 int resolve_host(struct in_addr *sin_addr, const char *hostname);
443
444 void url_split(char *proto, int proto_size,
445 char *hostname, int hostname_size,
446 int *port_ptr,
447 char *path, int path_size,
448 const char *url);
449
450 int match_ext(const char *filename, const char *extensions);
451
452 #endif /* HAVE_AV_CONFIG_H */
453
454 #ifdef __cplusplus
455 }
456 #endif
457
458 #endif /* AVFORMAT_H */