tiny docs improvement which i apparebtly forgot to commit
[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
b4b87d48 8#define LIBAVFORMAT_BUILD 4628
8026c3b5 9
7b7d86f1
FB
10#define LIBAVFORMAT_VERSION_INT FFMPEG_VERSION_INT
11#define LIBAVFORMAT_VERSION FFMPEG_VERSION
12#define LIBAVFORMAT_IDENT "FFmpeg" FFMPEG_VERSION "b" AV_STRINGIFY(LIBAVFORMAT_BUILD)
4b1f4f23 13
f71869a4 14#include <time.h>
67070e4f 15#include <stdio.h> /* FILE */
de6d9b64
FB
16#include "avcodec.h"
17
de6d9b64
FB
18#include "avio.h"
19
20/* packet functions */
21
ee404803
FB
22#ifndef MAXINT64
23#define MAXINT64 int64_t_C(0x7fffffffffffffff)
24#endif
25
26#ifndef MININT64
27#define MININT64 int64_t_C(0x8000000000000000)
28#endif
29
de6d9b64 30typedef struct AVPacket {
2692067a
MN
31 int64_t pts; ///< presentation time stamp in time_base units
32 int64_t dts; ///< decompression time stamp in time_base units
0c1a9eda 33 uint8_t *data;
6fa5a56c
FB
34 int size;
35 int stream_index;
36 int flags;
2692067a 37 int duration; ///< presentation duration in time_base units (0 if not available)
6fa5a56c
FB
38 void (*destruct)(struct AVPacket *);
39 void *priv;
2692067a 40 int64_t pos; ///< byte position in stream, -1 if unknown
de6d9b64 41} AVPacket;
6fa5a56c
FB
42#define PKT_FLAG_KEY 0x0001
43
63dd1377
MN
44void av_destruct_packet_nofree(AVPacket *pkt);
45
da24c5e3 46/* initialize optional fields of a packet */
6fa5a56c
FB
47static inline void av_init_packet(AVPacket *pkt)
48{
49 pkt->pts = AV_NOPTS_VALUE;
fb2758c8 50 pkt->dts = AV_NOPTS_VALUE;
2692067a 51 pkt->pos = -1;
fb2758c8 52 pkt->duration = 0;
6fa5a56c
FB
53 pkt->flags = 0;
54 pkt->stream_index = 0;
63dd1377 55 pkt->destruct= av_destruct_packet_nofree;
6fa5a56c 56}
de6d9b64
FB
57
58int av_new_packet(AVPacket *pkt, int size);
2692067a 59int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
fb2758c8 60int av_dup_packet(AVPacket *pkt);
6fa5a56c
FB
61
62/**
63 * Free a packet
64 *
65 * @param pkt packet to free
66 */
67static inline void av_free_packet(AVPacket *pkt)
68{
342474ab
MN
69 if (pkt && pkt->destruct) {
70 pkt->destruct(pkt);
71 }
6fa5a56c 72}
de6d9b64
FB
73
74/*************************************************/
916c80e9
FB
75/* fractional numbers for exact pts handling */
76
77/* the exact value of the fractional number is: 'val + num / den'. num
78 is assumed to be such as 0 <= num < den */
79typedef struct AVFrac {
0c1a9eda 80 int64_t val, num, den;
916c80e9
FB
81} AVFrac;
82
0c1a9eda
ZK
83void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
84void av_frac_add(AVFrac *f, int64_t incr);
85void av_frac_set(AVFrac *f, int64_t val);
916c80e9
FB
86
87/*************************************************/
b9a281db 88/* input/output formats */
de6d9b64
FB
89
90struct AVFormatContext;
b9a281db
FB
91
92/* this structure contains the data a format has to probe a file */
93typedef struct AVProbeData {
5c91a675 94 const char *filename;
b9a281db
FB
95 unsigned char *buf;
96 int buf_size;
97} AVProbeData;
98
99#define AVPROBE_SCORE_MAX 100
de6d9b64
FB
100
101typedef struct AVFormatParameters {
c0df9d75 102 AVRational time_base;
de6d9b64
FB
103 int sample_rate;
104 int channels;
105 int width;
106 int height;
4606ac8d 107 enum PixelFormat pix_fmt;
290c5fa6 108 struct AVImageFormat *image_format;
7f172339 109 int channel; /* used to select dv channel */
6beefa40 110 const char *device; /* video, audio or DV device */
e3ee3283 111 const char *standard; /* tv standard, NTSC, PAL, SECAM */
da24c5e3
FB
112 int mpeg2ts_raw:1; /* force raw MPEG2 transport stream output, if possible */
113 int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
114 stream packet (only meaningful if
115 mpeg2ts_raw is TRUE */
fb2758c8
FB
116 int initial_pause:1; /* do not begin to play the stream
117 immediately (RTSP only) */
5b6d5596
MN
118 enum CodecID video_codec_id;
119 enum CodecID audio_codec_id;
de6d9b64
FB
120} AVFormatParameters;
121
b9a281db
FB
122#define AVFMT_NOFILE 0x0001 /* no file should be opened */
123#define AVFMT_NEEDNUMBER 0x0002 /* needs '%d' in filename */
b9a281db 124#define AVFMT_SHOW_IDS 0x0008 /* show format stream IDs numbers */
fb025625
FB
125#define AVFMT_RAWPICTURE 0x0020 /* format wants AVPicture structure for
126 raw picture data */
c64d476c 127#define AVFMT_GLOBALHEADER 0x0040 /* format wants global header */
b9a281db
FB
128
129typedef struct AVOutputFormat {
de6d9b64
FB
130 const char *name;
131 const char *long_name;
132 const char *mime_type;
133 const char *extensions; /* comma separated extensions */
b9a281db
FB
134 /* size of private data so that it can be allocated in the wrapper */
135 int priv_data_size;
de6d9b64
FB
136 /* output support */
137 enum CodecID audio_codec; /* default audio codec */
138 enum CodecID video_codec; /* default video codec */
139 int (*write_header)(struct AVFormatContext *);
e928649b 140 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
de6d9b64 141 int (*write_trailer)(struct AVFormatContext *);
c64d476c 142 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
b9a281db 143 int flags;
290c5fa6
FB
144 /* currently only used to set pixel format if not YUV420P */
145 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
fe2d6fe2 146 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
b9a281db
FB
147 /* private fields */
148 struct AVOutputFormat *next;
149} AVOutputFormat;
de6d9b64 150
b9a281db
FB
151typedef struct AVInputFormat {
152 const char *name;
153 const char *long_name;
154 /* size of private data so that it can be allocated in the wrapper */
155 int priv_data_size;
156 /* tell if a given file has a chance of being parsing by this format */
157 int (*read_probe)(AVProbeData *);
158 /* read the format header and initialize the AVFormatContext
de6d9b64 159 structure. Return 0 if OK. 'ap' if non NULL contains
b9a281db
FB
160 additionnal paramters. Only used in raw format right
161 now. 'av_new_stream' should be called to create new streams. */
de6d9b64
FB
162 int (*read_header)(struct AVFormatContext *,
163 AVFormatParameters *ap);
b9a281db
FB
164 /* read one packet and put it in 'pkt'. pts and flags are also
165 set. 'av_new_stream' can be called only if the flag
da24c5e3 166 AVFMTCTX_NOHEADER is used. */
de6d9b64
FB
167 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
168 /* close the stream. The AVFormatContext and AVStreams are not
169 freed by this function */
170 int (*read_close)(struct AVFormatContext *);
3ba1438d
MN
171 /**
172 * seek to a given timestamp relative to the frames in
173 * stream component stream_index
174 * @param stream_index must not be -1
175 * @param flags selects which direction should be preferred if no exact
176 * match is available
177 */
fb2758c8 178 int (*read_seek)(struct AVFormatContext *,
3ba1438d 179 int stream_index, int64_t timestamp, int flags);
8d14a25c
MN
180 /**
181 * gets the next timestamp in AV_TIME_BASE units.
182 */
183 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
184 int64_t *pos, int64_t pos_limit);
da24c5e3 185 /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
de6d9b64 186 int flags;
b9a281db
FB
187 /* if extensions are defined, then no probe is done. You should
188 usually not use extension format guessing because it is not
189 reliable enough */
190 const char *extensions;
191 /* general purpose read only value that the format can use */
192 int value;
fb2758c8
FB
193
194 /* start/resume playing - only meaningful if using a network based format
195 (RTSP) */
196 int (*read_play)(struct AVFormatContext *);
197
198 /* pause playing - only meaningful if using a network based format
199 (RTSP) */
200 int (*read_pause)(struct AVFormatContext *);
201
b9a281db
FB
202 /* private fields */
203 struct AVInputFormat *next;
204} AVInputFormat;
de6d9b64 205
fb2758c8
FB
206typedef struct AVIndexEntry {
207 int64_t pos;
208 int64_t timestamp;
209#define AVINDEX_KEYFRAME 0x0001
b754978a 210/* the following 2 flags indicate that the next/prev keyframe is known, and scaning for it isnt needed */
fb2758c8 211 int flags;
3e9245a9 212 int min_distance; /* min distance between this and the previous keyframe, used to avoid unneeded searching */
fb2758c8
FB
213} AVIndexEntry;
214
f3356e9c
MN
215enum AVDiscard{
216//we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
217 AVDISCARD_NONE =-16, ///< discard nothing
218 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
219 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
220 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
221 AVDISCARD_ALL = 48, ///< discard all
222};
223
de6d9b64 224typedef struct AVStream {
b9a281db
FB
225 int index; /* stream index in AVFormatContext */
226 int id; /* format specific stream id */
de6d9b64 227 AVCodecContext codec; /* codec context */
b4b87d48
MN
228 /**
229 * real base frame rate of the stream.
230 * for example if the timebase is 1/90000 and all frames have either
231 * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
232 */
233 AVRational r_frame_rate;
de6d9b64 234 void *priv_data;
b9a281db 235 /* internal data used in av_find_stream_info() */
fb2758c8
FB
236 int64_t codec_info_duration;
237 int codec_info_nb_frames;
da24c5e3 238 /* encoding: PTS generation when outputing stream */
1e51d801 239 AVFrac pts;
9ee91c2f
MN
240 AVRational time_base;
241 int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
a48b7a6b
FB
242 /* ffmpeg.c private use */
243 int stream_copy; /* if TRUE, just copy stream */
f3356e9c 244 enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
b4aea108 245 //FIXME move stuff to a flags field?
1e491e29
MN
246 /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
247 * MN:dunno if thats the right place, for it */
248 float quality;
ee404803
FB
249 /* decoding: position of the first frame of the component, in
250 AV_TIME_BASE fractional seconds. */
251 int64_t start_time;
252 /* decoding: duration of the stream, in AV_TIME_BASE fractional
253 seconds. */
254 int64_t duration;
fb2758c8 255
09730260
FB
256 char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
257
fb2758c8
FB
258 /* av_read_frame() support */
259 int need_parsing;
260 struct AVCodecParserContext *parser;
6ec87caa 261
fb2758c8
FB
262 int64_t cur_dts;
263 int last_IP_duration;
77405fc8 264 int64_t last_IP_pts;
fb2758c8
FB
265 /* av_seek_frame() support */
266 AVIndexEntry *index_entries; /* only used if the format does not
267 support seeking natively */
268 int nb_index_entries;
269 int index_entries_allocated_size;
b4b87d48
MN
270
271 int64_t nb_frames; ///< number of frames in this stream if known or 0
de6d9b64
FB
272} AVStream;
273
da24c5e3
FB
274#define AVFMTCTX_NOHEADER 0x0001 /* signal that no header is present
275 (streams are added dynamically) */
276
de6d9b64
FB
277#define MAX_STREAMS 20
278
279/* format I/O context */
280typedef struct AVFormatContext {
7fea94ce 281 const AVClass *av_class; /* set by av_alloc_format_context */
b9a281db
FB
282 /* can only be iformat or oformat, not both at the same time */
283 struct AVInputFormat *iformat;
284 struct AVOutputFormat *oformat;
de6d9b64
FB
285 void *priv_data;
286 ByteIOContext pb;
287 int nb_streams;
288 AVStream *streams[MAX_STREAMS];
289 char filename[1024]; /* input or output filename */
290 /* stream info */
4568325a 291 int64_t timestamp;
de6d9b64
FB
292 char title[512];
293 char author[512];
294 char copyright[512];
295 char comment[512];
6a58e151
FB
296 char album[512];
297 int year; /* ID3 year, 0 if none */
298 int track; /* track number, 0 if none */
299 char genre[32]; /* ID3 genre */
300
da24c5e3 301 int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
916c80e9 302 /* private data for pts handling (do not modify directly) */
de6d9b64
FB
303 /* This buffer is only needed when packets were already buffered but
304 not decoded, for example to get the codec parameters in mpeg
305 streams */
ee404803
FB
306 struct AVPacketList *packet_buffer;
307
308 /* decoding: position of the first frame of the component, in
309 AV_TIME_BASE fractional seconds. NEVER set this value directly:
310 it is deduced from the AVStream values. */
311 int64_t start_time;
312 /* decoding: duration of the stream, in AV_TIME_BASE fractional
313 seconds. NEVER set this value directly: it is deduced from the
314 AVStream values. */
315 int64_t duration;
316 /* decoding: total file size. 0 if unknown */
317 int64_t file_size;
318 /* decoding: total stream bitrate in bit/s, 0 if not
319 available. Never set it directly if the file_size and the
320 duration are known as ffmpeg can compute it automatically. */
321 int bit_rate;
fb2758c8
FB
322
323 /* av_read_frame() support */
324 AVStream *cur_st;
325 const uint8_t *cur_ptr;
326 int cur_len;
327 AVPacket cur_pkt;
328
fb2758c8
FB
329 /* av_seek_frame() support */
330 int64_t data_offset; /* offset of the first packet */
331 int index_built;
2db3c638
MN
332
333 int mux_rate;
334 int packet_size;
17c88cb0
MN
335 int preload;
336 int max_delay;
8108551a
TK
337
338#define AVFMT_NOOUTPUTLOOP -1
339#define AVFMT_INFINITEOUTPUTLOOP 0
340 /* number of times to loop output in formats that support it */
341 int loop_output;
342
de6d9b64
FB
343} AVFormatContext;
344
345typedef struct AVPacketList {
346 AVPacket pkt;
347 struct AVPacketList *next;
348} AVPacketList;
349
b9a281db
FB
350extern AVInputFormat *first_iformat;
351extern AVOutputFormat *first_oformat;
de6d9b64 352
290c5fa6
FB
353/* still image support */
354struct AVInputImageContext;
355typedef struct AVInputImageContext AVInputImageContext;
356
357typedef struct AVImageInfo {
358 enum PixelFormat pix_fmt; /* requested pixel format */
359 int width; /* requested width */
360 int height; /* requested height */
7e2e1abf 361 int interleaved; /* image is interleaved (e.g. interleaved GIF) */
290c5fa6
FB
362 AVPicture pict; /* returned allocated image */
363} AVImageInfo;
364
3b1a27e0 365/* AVImageFormat.flags field constants */
7e2e1abf 366#define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
3b1a27e0 367
290c5fa6
FB
368typedef struct AVImageFormat {
369 const char *name;
370 const char *extensions;
371 /* tell if a given file has a chance of being parsing by this format */
372 int (*img_probe)(AVProbeData *);
373 /* read a whole image. 'alloc_cb' is called when the image size is
374 known so that the caller can allocate the image. If 'allo_cb'
375 returns non zero, then the parsing is aborted. Return '0' if
376 OK. */
377 int (*img_read)(ByteIOContext *,
378 int (*alloc_cb)(void *, AVImageInfo *info), void *);
379 /* write the image */
380 int supported_pixel_formats; /* mask of supported formats for output */
381 int (*img_write)(ByteIOContext *, AVImageInfo *);
3b1a27e0 382 int flags;
290c5fa6
FB
383 struct AVImageFormat *next;
384} AVImageFormat;
385
386void av_register_image_format(AVImageFormat *img_fmt);
387AVImageFormat *av_probe_image_format(AVProbeData *pd);
388AVImageFormat *guess_image_format(const char *filename);
5b6d5596 389enum CodecID av_guess_image2_codec(const char *filename);
290c5fa6
FB
390int av_read_image(ByteIOContext *pb, const char *filename,
391 AVImageFormat *fmt,
392 int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
393int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
394
395extern AVImageFormat *first_image_format;
396
397extern AVImageFormat pnm_image_format;
398extern AVImageFormat pbm_image_format;
399extern AVImageFormat pgm_image_format;
400extern AVImageFormat ppm_image_format;
8975ba81 401extern AVImageFormat pam_image_format;
290c5fa6
FB
402extern AVImageFormat pgmyuv_image_format;
403extern AVImageFormat yuv_image_format;
3a13f6bd 404#ifdef CONFIG_ZLIB
0e04e4e9 405extern AVImageFormat png_image_format;
3a13f6bd 406#endif
0250738f 407extern AVImageFormat jpeg_image_format;
cdc90af0 408extern AVImageFormat gif_image_format;
6a91ec51 409extern AVImageFormat sgi_image_format;
290c5fa6 410
b9a281db
FB
411/* XXX: use automatic init with either ELF sections or C file parser */
412/* modules */
de6d9b64 413
b9a281db 414/* mpeg.c */
ee404803 415extern AVInputFormat mpegps_demux;
b9a281db
FB
416int mpegps_init(void);
417
418/* mpegts.c */
419extern AVInputFormat mpegts_demux;
420int mpegts_init(void);
de6d9b64 421
b9a281db
FB
422/* rm.c */
423int rm_init(void);
424
425/* crc.c */
426int crc_init(void);
427
428/* img.c */
429int img_init(void);
430
03cfe134
MN
431/* img2.c */
432int img2_init(void);
433
b9a281db
FB
434/* asf.c */
435int asf_init(void);
de6d9b64
FB
436
437/* avienc.c */
b9a281db 438int avienc_init(void);
de6d9b64 439
b9a281db
FB
440/* avidec.c */
441int avidec_init(void);
6cea494e 442
b9a281db
FB
443/* swf.c */
444int swf_init(void);
445
446/* mov.c */
447int mov_init(void);
de6d9b64 448
1cb5f7fd
MN
449/* movenc.c */
450int movenc_init(void);
451
d4f5d74a
GM
452/* flvenc.c */
453int flvenc_init(void);
454
455/* flvdec.c */
456int flvdec_init(void);
457
b9a281db
FB
458/* jpeg.c */
459int jpeg_init(void);
de6d9b64 460
6cea494e 461/* gif.c */
b9a281db
FB
462int gif_init(void);
463
6cea494e 464/* au.c */
b9a281db 465int au_init(void);
6cea494e 466
bc634f6f
ZK
467/* amr.c */
468int amr_init(void);
469
de6d9b64 470/* wav.c */
c3775e54 471int ff_wav_init(void);
de6d9b64
FB
472
473/* raw.c */
fb2758c8 474int pcm_read_seek(AVFormatContext *s,
7b3c1382 475 int stream_index, int64_t timestamp, int flags);
b9a281db 476int raw_init(void);
de6d9b64 477
6a58e151
FB
478/* mp3.c */
479int mp3_init(void);
480
2864dfd5
RFI
481/* yuv4mpeg.c */
482int yuv4mpeg_init(void);
483
9146ca37 484/* ogg2.c */
81e0d0b4
MH
485int ogg_init(void);
486
9146ca37
MR
487/* ogg.c */
488int libogg_init(void);
489
f20dca40 490/* dv.c */
c3775e54 491int ff_dv_init(void);
f20dca40 492
de6d9b64 493/* ffm.c */
b9a281db 494int ffm_init(void);
de6d9b64 495
fb025625
FB
496/* rtsp.c */
497extern AVInputFormat redir_demux;
498int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
499
3c96b4ef
MM
500/* 4xm.c */
501int fourxm_init(void);
502
3f16d933
MM
503/* psxstr.c */
504int str_init(void);
505
3ef8be2b
MM
506/* idroq.c */
507int roq_init(void);
508
509/* ipmovie.c */
510int ipmovie_init(void);
511
3aa180b8
AB
512/* nut.c */
513int nut_init(void);
514
493645eb
MM
515/* wc3movie.c */
516int wc3_init(void);
517
2fdf638b
MM
518/* westwood.c */
519int westwood_init(void);
520
521/* segafilm.c */
522int film_init(void);
523
4120a53a
MM
524/* idcin.c */
525int idcin_init(void);
526
42cad81a
MM
527/* flic.c */
528int flic_init(void);
529
a7eb3c8d
MM
530/* sierravmd.c */
531int vmd_init(void);
532
08abe0fd
MN
533/* matroska.c */
534int matroska_init(void);
535
d08d7142
MM
536/* sol.c */
537int sol_init(void);
538
ad81a9fe
MM
539/* electronicarts.c */
540int ea_init(void);
541
27d5f18f
FR
542/* nsvdec.c */
543int nsvdec_init(void);
544
fb025625
FB
545#include "rtp.h"
546
547#include "rtsp.h"
548
290c5fa6
FB
549/* yuv4mpeg.c */
550extern AVOutputFormat yuv4mpegpipe_oformat;
551
b9a281db 552/* utils.c */
b9a281db
FB
553void av_register_input_format(AVInputFormat *format);
554void av_register_output_format(AVOutputFormat *format);
36ada60c
PG
555AVOutputFormat *guess_stream_format(const char *short_name,
556 const char *filename, const char *mime_type);
b9a281db
FB
557AVOutputFormat *guess_format(const char *short_name,
558 const char *filename, const char *mime_type);
5b6d5596
MN
559enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
560 const char *filename, const char *mime_type, enum CodecType type);
de6d9b64 561
fb2758c8
FB
562void av_hex_dump(FILE *f, uint8_t *buf, int size);
563void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
de6d9b64 564
94988531 565void av_register_all(void);
de6d9b64
FB
566
567typedef struct FifoBuffer {
0c1a9eda
ZK
568 uint8_t *buffer;
569 uint8_t *rptr, *wptr, *end;
de6d9b64
FB
570} FifoBuffer;
571
572int fifo_init(FifoBuffer *f, int size);
573void fifo_free(FifoBuffer *f);
0c1a9eda
ZK
574int fifo_size(FifoBuffer *f, uint8_t *rptr);
575int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
576void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
7000a175 577int put_fifo(ByteIOContext *pb, FifoBuffer *f, int buf_size, uint8_t **rptr_ptr);
568e18b1 578void fifo_realloc(FifoBuffer *f, unsigned int size);
de6d9b64 579
b9a281db
FB
580/* media file input */
581AVInputFormat *av_find_input_format(const char *short_name);
94988531 582AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
da24c5e3
FB
583int av_open_input_stream(AVFormatContext **ic_ptr,
584 ByteIOContext *pb, const char *filename,
585 AVInputFormat *fmt, AVFormatParameters *ap);
b9a281db
FB
586int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
587 AVInputFormat *fmt,
588 int buf_size,
589 AVFormatParameters *ap);
bc874dae
MB
590/* no av_open for output, so applications will need this: */
591AVFormatContext *av_alloc_format_context(void);
b9a281db
FB
592
593#define AVERROR_UNKNOWN (-1) /* unknown error */
594#define AVERROR_IO (-2) /* i/o error */
595#define AVERROR_NUMEXPECTED (-3) /* number syntax expected in filename */
596#define AVERROR_INVALIDDATA (-4) /* invalid data found */
597#define AVERROR_NOMEM (-5) /* not enough memory */
598#define AVERROR_NOFMT (-6) /* unknown format */
fb2758c8
FB
599#define AVERROR_NOTSUPP (-7) /* operation not supported */
600
b9a281db 601int av_find_stream_info(AVFormatContext *ic);
de6d9b64 602int av_read_packet(AVFormatContext *s, AVPacket *pkt);
fb2758c8 603int av_read_frame(AVFormatContext *s, AVPacket *pkt);
3ba1438d 604int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
fb2758c8
FB
605int av_read_play(AVFormatContext *s);
606int av_read_pause(AVFormatContext *s);
de6d9b64 607void av_close_input_file(AVFormatContext *s);
b9a281db 608AVStream *av_new_stream(AVFormatContext *s, int id);
9ee91c2f 609void av_set_pts_info(AVStream *s, int pts_wrap_bits,
916c80e9 610 int pts_num, int pts_den);
de6d9b64 611
3ba1438d
MN
612#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
613#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
27a5fe5f 614#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
3ba1438d 615
b754978a 616int av_find_default_stream_index(AVFormatContext *s);
dc56fc38 617int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
3e9245a9
MN
618int av_add_index_entry(AVStream *st,
619 int64_t pos, int64_t timestamp, int distance, int flags);
3ba1438d 620int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
b754978a 621
b9a281db 622/* media file output */
290c5fa6 623int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
b9a281db 624int av_write_header(AVFormatContext *s);
e928649b 625int av_write_frame(AVFormatContext *s, AVPacket *pkt);
3c895fc0 626int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
e928649b 627
b9a281db 628int av_write_trailer(AVFormatContext *s);
de6d9b64
FB
629
630void dump_format(AVFormatContext *ic,
631 int index,
632 const char *url,
633 int is_output);
634int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
445f1b83 635int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
0c1a9eda 636int64_t parse_date(const char *datestr, int duration);
de6d9b64 637
0c1a9eda 638int64_t av_gettime(void);
94988531 639
de6d9b64
FB
640/* ffm specific for ffserver */
641#define FFM_PACKET_SIZE 4096
642offset_t ffm_read_write_index(int fd);
643void ffm_write_write_index(int fd, offset_t pos);
644void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
645
646int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
647
813cae4b
FB
648int get_frame_filename(char *buf, int buf_size,
649 const char *path, int number);
b9a281db 650int filename_number_test(const char *filename);
96baaa6a 651
b9a281db
FB
652/* grab specific */
653int video_grab_init(void);
654int audio_init(void);
96baaa6a 655
86fd51fb
FB
656/* DV1394 */
657int dv1394_init(void);
f02be79d 658int dc1394_init(void);
fb025625
FB
659
660#ifdef HAVE_AV_CONFIG_H
f71869a4
FB
661
662#include "os_support.h"
663
fb025625
FB
664int strstart(const char *str, const char *val, const char **ptr);
665int stristart(const char *str, const char *val, const char **ptr);
666void pstrcpy(char *buf, int buf_size, const char *str);
667char *pstrcat(char *buf, int buf_size, const char *s);
fb025625 668
39f472c3
FB
669void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
670
e4e70d2e 671#ifdef __GNUC__
39f472c3
FB
672#define dynarray_add(tab, nb_ptr, elem)\
673do {\
674 typeof(tab) _tab = (tab);\
675 typeof(elem) _elem = (elem);\
676 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
677 __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
678} while(0)
e4e70d2e
FH
679#else
680#define dynarray_add(tab, nb_ptr, elem)\
681do {\
682 __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
683} while(0)
684#endif
39f472c3 685
f71869a4 686time_t mktimegm(struct tm *tm);
0c9fc6e1 687struct tm *brktimegm(time_t secs, struct tm *tm);
f71869a4
FB
688const char *small_strptime(const char *p, const char *fmt,
689 struct tm *dt);
690
fb025625
FB
691struct in_addr;
692int resolve_host(struct in_addr *sin_addr, const char *hostname);
693
694void url_split(char *proto, int proto_size,
6ba5cbc6 695 char *authorization, int authorization_size,
fb025625
FB
696 char *hostname, int hostname_size,
697 int *port_ptr,
698 char *path, int path_size,
699 const char *url);
700
a941f391
FB
701int match_ext(const char *filename, const char *extensions);
702
fb025625
FB
703#endif /* HAVE_AV_CONFIG_H */
704
02d697aa
ZK
705#ifdef __cplusplus
706}
707#endif
708
fb025625 709#endif /* AVFORMAT_H */
f3356e9c 710