avformat.h 13.4 KB
Newer Older
Fabrice Bellard's avatar
Fabrice Bellard committed
1 2
#ifndef AVFORMAT_H
#define AVFORMAT_H
Fabrice Bellard's avatar
Fabrice Bellard committed
3

4 5 6 7
#ifdef __cplusplus
extern "C" {
#endif

Fabrice Bellard's avatar
Fabrice Bellard committed
8 9
#define LIBAVFORMAT_VERSION_INT 0x000406  
#define LIBAVFORMAT_VERSION     "0.4.6"
10
#define LIBAVFORMAT_BUILD       4603
11

Fabrice Bellard's avatar
Fabrice Bellard committed
12 13 14 15 16 17
#include "avcodec.h"

#include "avio.h"

/* packet functions */

Fabrice Bellard's avatar
Fabrice Bellard committed
18 19
#define AV_NOPTS_VALUE 0

Fabrice Bellard's avatar
Fabrice Bellard committed
20
typedef struct AVPacket {
21 22
    int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
    uint8_t *data;
23 24 25 26 27 28
    int   size;
    int   stream_index;
    int   flags;
    int   duration;
    void  (*destruct)(struct AVPacket *);
    void  *priv;
Fabrice Bellard's avatar
Fabrice Bellard committed
29
} AVPacket; 
30 31 32 33 34 35 36 37
#define PKT_FLAG_KEY   0x0001

static inline void av_init_packet(AVPacket *pkt)
{
    pkt->pts   = AV_NOPTS_VALUE;
    pkt->flags = 0;
    pkt->stream_index = 0;
}
Fabrice Bellard's avatar
Fabrice Bellard committed
38 39

int av_new_packet(AVPacket *pkt, int size);
40 41 42 43 44 45 46 47 48 49

/**
 * Free a packet
 *
 * @param pkt packet to free
 */
static inline void av_free_packet(AVPacket *pkt)
{
    pkt->destruct(pkt);
}
Fabrice Bellard's avatar
Fabrice Bellard committed
50

Fabrice Bellard's avatar
Fabrice Bellard committed
51 52 53 54 55 56
/*************************************************/
/* fractional numbers for exact pts handling */

/* the exact value of the fractional number is: 'val + num / den'. num
   is assumed to be such as 0 <= num < den */
typedef struct AVFrac {
57
    int64_t val, num, den; 
Fabrice Bellard's avatar
Fabrice Bellard committed
58 59
} AVFrac;

60 61 62
void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
void av_frac_add(AVFrac *f, int64_t incr);
void av_frac_set(AVFrac *f, int64_t val);
Fabrice Bellard's avatar
Fabrice Bellard committed
63

Fabrice Bellard's avatar
Fabrice Bellard committed
64
/*************************************************/
65
/* input/output formats */
Fabrice Bellard's avatar
Fabrice Bellard committed
66 67

struct AVFormatContext;
68 69 70

/* this structure contains the data a format has to probe a file */
typedef struct AVProbeData {
71
    const char *filename;
72 73 74 75 76
    unsigned char *buf;
    int buf_size;
} AVProbeData;

#define AVPROBE_SCORE_MAX 100
Fabrice Bellard's avatar
Fabrice Bellard committed
77 78 79 80 81 82 83

typedef struct AVFormatParameters {
    int frame_rate;
    int sample_rate;
    int channels;
    int width;
    int height;
84
    enum PixelFormat pix_fmt;
85
    struct AVImageFormat *image_format;
86 87
    int channel; /* used to select dv channel */
    const char *device; /* video4linux, audio or DV device */
Fabrice Bellard's avatar
Fabrice Bellard committed
88 89
} AVFormatParameters;

90 91 92 93 94
#define AVFMT_NOFILE        0x0001 /* no file should be opened */
#define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */ 
#define AVFMT_NOHEADER      0x0004 /* signal that no header is present
                                      (streams are added dynamically) */
#define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
Fabrice Bellard's avatar
Fabrice Bellard committed
95 96
#define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
                                      raw picture data */
97 98

typedef struct AVOutputFormat {
Fabrice Bellard's avatar
Fabrice Bellard committed
99 100 101 102
    const char *name;
    const char *long_name;
    const char *mime_type;
    const char *extensions; /* comma separated extensions */
103 104
    /* size of private data so that it can be allocated in the wrapper */
    int priv_data_size;
Fabrice Bellard's avatar
Fabrice Bellard committed
105 106 107 108
    /* output support */
    enum CodecID audio_codec; /* default audio codec */
    enum CodecID video_codec; /* default video codec */
    int (*write_header)(struct AVFormatContext *);
109
    /* XXX: change prototype for 64 bit pts */
Fabrice Bellard's avatar
Fabrice Bellard committed
110 111
    int (*write_packet)(struct AVFormatContext *, 
                        int stream_index,
112
                        unsigned char *buf, int size, int force_pts);
Fabrice Bellard's avatar
Fabrice Bellard committed
113
    int (*write_trailer)(struct AVFormatContext *);
114 115
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
    int flags;
116 117
    /* currently only used to set pixel format if not YUV420P */
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
118 119 120
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
Fabrice Bellard's avatar
Fabrice Bellard committed
121

122 123 124 125 126 127 128 129
typedef struct AVInputFormat {
    const char *name;
    const char *long_name;
    /* size of private data so that it can be allocated in the wrapper */
    int priv_data_size;
    /* tell if a given file has a chance of being parsing by this format */
    int (*read_probe)(AVProbeData *);
    /* read the format header and initialize the AVFormatContext
Fabrice Bellard's avatar
Fabrice Bellard committed
130
       structure. Return 0 if OK. 'ap' if non NULL contains
131 132
       additionnal paramters. Only used in raw format right
       now. 'av_new_stream' should be called to create new streams.  */
Fabrice Bellard's avatar
Fabrice Bellard committed
133 134
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
135 136 137
    /* read one packet and put it in 'pkt'. pts and flags are also
       set. 'av_new_stream' can be called only if the flag
       AVFMT_NOHEADER is used. */
Fabrice Bellard's avatar
Fabrice Bellard committed
138 139 140 141 142 143
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
    /* close the stream. The AVFormatContext and AVStreams are not
       freed by this function */
    int (*read_close)(struct AVFormatContext *);
    /* seek at or before a given pts (given in microsecond). The pts
       origin is defined by the stream */
144
    int (*read_seek)(struct AVFormatContext *, int64_t pts);
145
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
Fabrice Bellard's avatar
Fabrice Bellard committed
146
    int flags;
147 148 149 150 151 152 153 154 155
    /* if extensions are defined, then no probe is done. You should
       usually not use extension format guessing because it is not
       reliable enough */
    const char *extensions;
    /* general purpose read only value that the format can use */
    int value;
    /* private fields */
    struct AVInputFormat *next;
} AVInputFormat;
Fabrice Bellard's avatar
Fabrice Bellard committed
156 157

typedef struct AVStream {
158 159
    int index;    /* stream index in AVFormatContext */
    int id;       /* format specific stream id */
Fabrice Bellard's avatar
Fabrice Bellard committed
160
    AVCodecContext codec; /* codec context */
161
    int r_frame_rate;     /* real frame rate of the stream */
162
    uint64_t time_length; /* real length of the stream in miliseconds */
Fabrice Bellard's avatar
Fabrice Bellard committed
163
    void *priv_data;
164 165 166 167
    /* internal data used in av_find_stream_info() */
    int codec_info_state;     
    int codec_info_nb_repeat_frames;
    int codec_info_nb_real_frames;
168 169
    /* PTS generation when outputing stream */
    AVFrac pts;
Fabrice Bellard's avatar
Fabrice Bellard committed
170 171
    /* ffmpeg.c private use */
    int stream_copy; /* if TRUE, just copy stream */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
172 173 174
    /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
     * MN:dunno if thats the right place, for it */
    float quality; 
Fabrice Bellard's avatar
Fabrice Bellard committed
175 176 177 178 179 180
} AVStream;

#define MAX_STREAMS 20

/* format I/O context */
typedef struct AVFormatContext {
181 182 183
    /* can only be iformat or oformat, not both at the same time */
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
Fabrice Bellard's avatar
Fabrice Bellard committed
184 185 186 187 188 189 190 191 192 193
    void *priv_data;
    ByteIOContext pb;
    int nb_streams;
    AVStream *streams[MAX_STREAMS];
    char filename[1024]; /* input or output filename */
    /* stream info */
    char title[512];
    char author[512];
    char copyright[512];
    char comment[512];
194
    int flags; /* format specific flags */
Fabrice Bellard's avatar
Fabrice Bellard committed
195 196 197
    /* private data for pts handling (do not modify directly) */
    int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
    int pts_num, pts_den; /* value to convert to seconds */
Fabrice Bellard's avatar
Fabrice Bellard committed
198 199 200 201 202 203 204 205 206 207 208
    /* This buffer is only needed when packets were already buffered but
       not decoded, for example to get the codec parameters in mpeg
       streams */
   struct AVPacketList *packet_buffer;
} AVFormatContext;

typedef struct AVPacketList {
    AVPacket pkt;
    struct AVPacketList *next;
} AVPacketList;

209 210
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
Fabrice Bellard's avatar
Fabrice Bellard committed
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/* still image support */
struct AVInputImageContext;
typedef struct AVInputImageContext AVInputImageContext;

typedef struct AVImageInfo {
    enum PixelFormat pix_fmt; /* requested pixel format */
    int width; /* requested width */
    int height; /* requested height */
    AVPicture pict; /* returned allocated image */
} AVImageInfo;

typedef struct AVImageFormat {
    const char *name;
    const char *extensions;
    /* tell if a given file has a chance of being parsing by this format */
    int (*img_probe)(AVProbeData *);
    /* read a whole image. 'alloc_cb' is called when the image size is
       known so that the caller can allocate the image. If 'allo_cb'
       returns non zero, then the parsing is aborted. Return '0' if
       OK. */
    int (*img_read)(ByteIOContext *, 
                    int (*alloc_cb)(void *, AVImageInfo *info), void *);
    /* write the image */
    int supported_pixel_formats; /* mask of supported formats for output */
    int (*img_write)(ByteIOContext *, AVImageInfo *);
    struct AVImageFormat *next;
} AVImageFormat;

void av_register_image_format(AVImageFormat *img_fmt);
AVImageFormat *av_probe_image_format(AVProbeData *pd);
AVImageFormat *guess_image_format(const char *filename);
int av_read_image(ByteIOContext *pb, const char *filename,
                  AVImageFormat *fmt,
                  int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);

extern AVImageFormat *first_image_format;

extern AVImageFormat pnm_image_format;
extern AVImageFormat pbm_image_format;
extern AVImageFormat pgm_image_format;
extern AVImageFormat ppm_image_format;
extern AVImageFormat pgmyuv_image_format;
extern AVImageFormat yuv_image_format;
256
#ifdef CONFIG_ZLIB
Fabrice Bellard's avatar
Fabrice Bellard committed
257
extern AVImageFormat png_image_format;
258
#endif
259
extern AVImageFormat jpeg_image_format;
260
extern AVImageFormat gif_image_format;
261

262 263
/* XXX: use automatic init with either ELF sections or C file parser */
/* modules */
Fabrice Bellard's avatar
Fabrice Bellard committed
264

265 266 267 268 269 270
/* mpeg.c */
int mpegps_init(void);

/* mpegts.c */
extern AVInputFormat mpegts_demux;
int mpegts_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
271

272 273 274 275 276 277 278 279 280 281 282
/* rm.c */
int rm_init(void);

/* crc.c */
int crc_init(void);

/* img.c */
int img_init(void);

/* asf.c */
int asf_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
283 284

/* avienc.c */
285
int avienc_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
286

287 288
/* avidec.c */
int avidec_init(void);
289

290 291 292 293 294
/* swf.c */
int swf_init(void);

/* mov.c */
int mov_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
295

296 297
/* jpeg.c */
int jpeg_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
298

299
/* gif.c */
300 301
int gif_init(void);

302
/* au.c */
303
int au_init(void);
304

Fabrice Bellard's avatar
Fabrice Bellard committed
305
/* wav.c */
306
int wav_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
307 308

/* raw.c */
309
int raw_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
310

311 312 313
/* ogg.c */
int ogg_init(void);

314 315 316
/* dv.c */
int dv_init(void);

Fabrice Bellard's avatar
Fabrice Bellard committed
317
/* ffm.c */
318
int ffm_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
319

Fabrice Bellard's avatar
Fabrice Bellard committed
320 321 322 323 324 325 326 327
/* rtsp.c */
extern AVInputFormat redir_demux;
int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);

#include "rtp.h"

#include "rtsp.h"

328 329 330
/* yuv4mpeg.c */
extern AVOutputFormat yuv4mpegpipe_oformat;

331
/* utils.c */
Fabrice Bellard's avatar
Fabrice Bellard committed
332 333 334
#define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
#define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))

335 336
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
337 338
AVOutputFormat *guess_stream_format(const char *short_name, 
                                    const char *filename, const char *mime_type);
339 340
AVOutputFormat *guess_format(const char *short_name, 
                             const char *filename, const char *mime_type);
Fabrice Bellard's avatar
Fabrice Bellard committed
341

342
void av_hex_dump(uint8_t *buf, int size);
Fabrice Bellard's avatar
Fabrice Bellard committed
343

Fabrice Bellard's avatar
Fabrice Bellard committed
344
void av_register_all(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
345 346

typedef struct FifoBuffer {
347 348
    uint8_t *buffer;
    uint8_t *rptr, *wptr, *end;
Fabrice Bellard's avatar
Fabrice Bellard committed
349 350 351 352
} FifoBuffer;

int fifo_init(FifoBuffer *f, int size);
void fifo_free(FifoBuffer *f);
353 354 355
int fifo_size(FifoBuffer *f, uint8_t *rptr);
int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
Fabrice Bellard's avatar
Fabrice Bellard committed
356

357 358
/* media file input */
AVInputFormat *av_find_input_format(const char *short_name);
Fabrice Bellard's avatar
Fabrice Bellard committed
359
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
360 361 362 363 364 365 366 367 368 369 370 371 372
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 
                       AVInputFormat *fmt,
                       int buf_size,
                       AVFormatParameters *ap);

#define AVERROR_UNKNOWN     (-1)  /* unknown error */
#define AVERROR_IO          (-2)  /* i/o error */
#define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
#define AVERROR_INVALIDDATA (-4)  /* invalid data found */
#define AVERROR_NOMEM       (-5)  /* not enough memory */
#define AVERROR_NOFMT       (-6)  /* unknown format */

int av_find_stream_info(AVFormatContext *ic);
Fabrice Bellard's avatar
Fabrice Bellard committed
373 374
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
void av_close_input_file(AVFormatContext *s);
375
AVStream *av_new_stream(AVFormatContext *s, int id);
Fabrice Bellard's avatar
Fabrice Bellard committed
376 377
void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
                     int pts_num, int pts_den);
Fabrice Bellard's avatar
Fabrice Bellard committed
378

379
/* media file output */
380
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
381
int av_write_header(AVFormatContext *s);
382 383
int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
                   int size);
384
int av_write_trailer(AVFormatContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
385 386 387 388 389 390

void dump_format(AVFormatContext *ic,
                 int index, 
                 const char *url,
                 int is_output);
int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
391
int64_t parse_date(const char *datestr, int duration);
Fabrice Bellard's avatar
Fabrice Bellard committed
392

393
int64_t av_gettime(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
394

Fabrice Bellard's avatar
Fabrice Bellard committed
395 396 397 398 399 400 401 402
/* ffm specific for ffserver */
#define FFM_PACKET_SIZE 4096
offset_t ffm_read_write_index(int fd);
void ffm_write_write_index(int fd, offset_t pos);
void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);

int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);

Fabrice Bellard's avatar
Fabrice Bellard committed
403 404
int get_frame_filename(char *buf, int buf_size,
                       const char *path, int number);
405
int filename_number_test(const char *filename);
406

407 408 409
/* grab specific */
int video_grab_init(void);
int audio_init(void);
410

Fabrice Bellard's avatar
Fabrice Bellard committed
411 412
/* DV1394 */
int dv1394_init(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

#ifdef HAVE_AV_CONFIG_H
int strstart(const char *str, const char *val, const char **ptr);
int stristart(const char *str, const char *val, const char **ptr);
void pstrcpy(char *buf, int buf_size, const char *str);
char *pstrcat(char *buf, int buf_size, const char *s);

struct in_addr;
int resolve_host(struct in_addr *sin_addr, const char *hostname);

void url_split(char *proto, int proto_size,
               char *hostname, int hostname_size,
               int *port_ptr,
               char *path, int path_size,
               const char *url);

Fabrice Bellard's avatar
Fabrice Bellard committed
429 430
int match_ext(const char *filename, const char *extensions);

Fabrice Bellard's avatar
Fabrice Bellard committed
431 432
#endif /* HAVE_AV_CONFIG_H */

433 434 435 436
#ifdef __cplusplus
}
#endif

Fabrice Bellard's avatar
Fabrice Bellard committed
437
#endif /* AVFORMAT_H */