avformat.h 13.4 KB
Newer Older
F
Fabrice Bellard 已提交
1 2
#ifndef AVFORMAT_H
#define AVFORMAT_H
F
Fabrice Bellard 已提交
3

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

F
Fabrice Bellard 已提交
8 9
#define LIBAVFORMAT_VERSION_INT 0x000406  
#define LIBAVFORMAT_VERSION     "0.4.6"
10
#define LIBAVFORMAT_BUILD       4603
11

F
Fabrice Bellard 已提交
12 13 14 15 16 17
#include "avcodec.h"

#include "avio.h"

/* packet functions */

F
Fabrice Bellard 已提交
18 19
#define AV_NOPTS_VALUE 0

F
Fabrice Bellard 已提交
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;
F
Fabrice Bellard 已提交
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;
}
F
Fabrice Bellard 已提交
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);
}
F
Fabrice Bellard 已提交
50

F
Fabrice Bellard 已提交
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; 
F
Fabrice Bellard 已提交
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);
F
Fabrice Bellard 已提交
63

F
Fabrice Bellard 已提交
64
/*************************************************/
65
/* input/output formats */
F
Fabrice Bellard 已提交
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
F
Fabrice Bellard 已提交
77 78 79

typedef struct AVFormatParameters {
    int frame_rate;
80
    int frame_rate_base;
F
Fabrice Bellard 已提交
81 82 83 84
    int sample_rate;
    int channels;
    int width;
    int height;
85
    enum PixelFormat pix_fmt;
86
    struct AVImageFormat *image_format;
87 88
    int channel; /* used to select dv channel */
    const char *device; /* video4linux, audio or DV device */
F
Fabrice Bellard 已提交
89 90
} AVFormatParameters;

91 92 93 94 95
#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 */
F
Fabrice Bellard 已提交
96 97
#define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
                                      raw picture data */
98 99

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

123 124 125 126 127 128 129 130
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
F
Fabrice Bellard 已提交
131
       structure. Return 0 if OK. 'ap' if non NULL contains
132 133
       additionnal paramters. Only used in raw format right
       now. 'av_new_stream' should be called to create new streams.  */
F
Fabrice Bellard 已提交
134 135
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
136 137 138
    /* 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. */
F
Fabrice Bellard 已提交
139 140 141 142 143 144
    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 */
145
    int (*read_seek)(struct AVFormatContext *, int64_t pts);
146
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
F
Fabrice Bellard 已提交
147
    int flags;
148 149 150 151 152 153 154 155 156
    /* 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;
F
Fabrice Bellard 已提交
157 158

typedef struct AVStream {
159 160
    int index;    /* stream index in AVFormatContext */
    int id;       /* format specific stream id */
F
Fabrice Bellard 已提交
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 */
F
Fabrice Bellard 已提交
165
    void *priv_data;
166 167 168 169
    /* internal data used in av_find_stream_info() */
    int codec_info_state;     
    int codec_info_nb_repeat_frames;
    int codec_info_nb_real_frames;
170 171
    /* PTS generation when outputing stream */
    AVFrac pts;
F
Fabrice Bellard 已提交
172 173
    /* ffmpeg.c private use */
    int stream_copy; /* if TRUE, just copy stream */
M
cleanup  
Michael Niedermayer 已提交
174 175 176
    /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
     * MN:dunno if thats the right place, for it */
    float quality; 
F
Fabrice Bellard 已提交
177 178 179 180 181 182
} AVStream;

#define MAX_STREAMS 20

/* format I/O context */
typedef struct AVFormatContext {
183 184 185
    /* can only be iformat or oformat, not both at the same time */
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
F
Fabrice Bellard 已提交
186 187 188 189 190 191 192 193 194 195
    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];
196
    int flags; /* format specific flags */
F
Fabrice Bellard 已提交
197 198 199
    /* 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 */
F
Fabrice Bellard 已提交
200 201 202 203 204 205 206 207 208 209 210
    /* 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;

211 212
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
F
Fabrice Bellard 已提交
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 256 257
/* 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;
258
#ifdef CONFIG_ZLIB
F
Fabrice Bellard 已提交
259
extern AVImageFormat png_image_format;
260
#endif
261
extern AVImageFormat jpeg_image_format;
262
extern AVImageFormat gif_image_format;
263

264 265
/* XXX: use automatic init with either ELF sections or C file parser */
/* modules */
F
Fabrice Bellard 已提交
266

267 268 269 270 271 272
/* mpeg.c */
int mpegps_init(void);

/* mpegts.c */
extern AVInputFormat mpegts_demux;
int mpegts_init(void);
F
Fabrice Bellard 已提交
273

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

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

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

/* asf.c */
int asf_init(void);
F
Fabrice Bellard 已提交
285 286

/* avienc.c */
287
int avienc_init(void);
F
Fabrice Bellard 已提交
288

289 290
/* avidec.c */
int avidec_init(void);
291

292 293 294 295 296
/* swf.c */
int swf_init(void);

/* mov.c */
int mov_init(void);
F
Fabrice Bellard 已提交
297

298 299
/* jpeg.c */
int jpeg_init(void);
F
Fabrice Bellard 已提交
300

301
/* gif.c */
302 303
int gif_init(void);

304
/* au.c */
305
int au_init(void);
306

F
Fabrice Bellard 已提交
307
/* wav.c */
308
int wav_init(void);
F
Fabrice Bellard 已提交
309 310

/* raw.c */
311
int raw_init(void);
F
Fabrice Bellard 已提交
312

313 314 315
/* ogg.c */
int ogg_init(void);

316 317 318
/* dv.c */
int dv_init(void);

F
Fabrice Bellard 已提交
319
/* ffm.c */
320
int ffm_init(void);
F
Fabrice Bellard 已提交
321

F
Fabrice Bellard 已提交
322 323 324 325 326 327 328 329
/* rtsp.c */
extern AVInputFormat redir_demux;
int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);

#include "rtp.h"

#include "rtsp.h"

330 331 332
/* yuv4mpeg.c */
extern AVOutputFormat yuv4mpegpipe_oformat;

333 334 335
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
336 337
AVOutputFormat *guess_stream_format(const char *short_name, 
                                    const char *filename, const char *mime_type);
338 339
AVOutputFormat *guess_format(const char *short_name, 
                             const char *filename, const char *mime_type);
F
Fabrice Bellard 已提交
340

341
void av_hex_dump(uint8_t *buf, int size);
F
Fabrice Bellard 已提交
342

F
Fabrice Bellard 已提交
343
void av_register_all(void);
F
Fabrice Bellard 已提交
344 345

typedef struct FifoBuffer {
346 347
    uint8_t *buffer;
    uint8_t *rptr, *wptr, *end;
F
Fabrice Bellard 已提交
348 349 350 351
} FifoBuffer;

int fifo_init(FifoBuffer *f, int size);
void fifo_free(FifoBuffer *f);
352 353 354
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);
F
Fabrice Bellard 已提交
355

356 357
/* media file input */
AVInputFormat *av_find_input_format(const char *short_name);
F
Fabrice Bellard 已提交
358
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
359 360 361 362 363 364 365 366 367 368 369 370 371
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);
F
Fabrice Bellard 已提交
372 373
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
void av_close_input_file(AVFormatContext *s);
374
AVStream *av_new_stream(AVFormatContext *s, int id);
F
Fabrice Bellard 已提交
375 376
void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
                     int pts_num, int pts_den);
F
Fabrice Bellard 已提交
377

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

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);
390
int64_t parse_date(const char *datestr, int duration);
F
Fabrice Bellard 已提交
391

392
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
393

F
Fabrice Bellard 已提交
394 395 396 397 398 399 400 401
/* 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);

F
Fabrice Bellard 已提交
402 403
int get_frame_filename(char *buf, int buf_size,
                       const char *path, int number);
404
int filename_number_test(const char *filename);
405

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

F
Fabrice Bellard 已提交
410 411
/* DV1394 */
int dv1394_init(void);
F
Fabrice Bellard 已提交
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

#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);

F
Fabrice Bellard 已提交
428 429
int match_ext(const char *filename, const char *extensions);

F
Fabrice Bellard 已提交
430 431
#endif /* HAVE_AV_CONFIG_H */

432 433 434 435
#ifdef __cplusplus
}
#endif

F
Fabrice Bellard 已提交
436
#endif /* AVFORMAT_H */