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