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