avformat.h 16.8 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

8
#define LIBAVFORMAT_BUILD       4609
A
Alex Beregszaszi 已提交
9

F
Fabrice Bellard 已提交
10 11 12
#define LIBAVFORMAT_VERSION_INT FFMPEG_VERSION_INT
#define LIBAVFORMAT_VERSION     FFMPEG_VERSION
#define LIBAVFORMAT_IDENT	"FFmpeg" FFMPEG_VERSION "b" AV_STRINGIFY(LIBAVFORMAT_BUILD)
13

14 15
#include <time.h>

F
Fabrice Bellard 已提交
16 17 18 19 20 21
#include "avcodec.h"

#include "avio.h"

/* packet functions */

22 23 24 25 26 27 28 29 30 31
#ifndef MAXINT64
#define MAXINT64 int64_t_C(0x7fffffffffffffff)
#endif

#ifndef MININT64
#define MININT64 int64_t_C(0x8000000000000000)
#endif

#define AV_NOPTS_VALUE MININT64
#define AV_TIME_BASE 1000000
F
Fabrice Bellard 已提交
32

F
Fabrice Bellard 已提交
33
typedef struct AVPacket {
34 35
    int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
    uint8_t *data;
36 37 38 39 40 41
    int   size;
    int   stream_index;
    int   flags;
    int   duration;
    void  (*destruct)(struct AVPacket *);
    void  *priv;
F
Fabrice Bellard 已提交
42
} AVPacket; 
43 44
#define PKT_FLAG_KEY   0x0001

45
/* initialize optional fields of a packet */
46 47 48 49 50 51
static inline void av_init_packet(AVPacket *pkt)
{
    pkt->pts   = AV_NOPTS_VALUE;
    pkt->flags = 0;
    pkt->stream_index = 0;
}
F
Fabrice Bellard 已提交
52 53

int av_new_packet(AVPacket *pkt, int size);
54 55 56 57 58 59 60 61

/**
 * Free a packet
 *
 * @param pkt packet to free
 */
static inline void av_free_packet(AVPacket *pkt)
{
62 63 64
    if (pkt && pkt->destruct) {
	pkt->destruct(pkt);
    }
65
}
F
Fabrice Bellard 已提交
66

F
Fabrice Bellard 已提交
67 68 69 70 71 72
/*************************************************/
/* 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 {
73
    int64_t val, num, den; 
F
Fabrice Bellard 已提交
74 75
} AVFrac;

76 77 78
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 已提交
79

F
Fabrice Bellard 已提交
80
/*************************************************/
81
/* input/output formats */
F
Fabrice Bellard 已提交
82 83

struct AVFormatContext;
84 85 86

/* this structure contains the data a format has to probe a file */
typedef struct AVProbeData {
87
    const char *filename;
88 89 90 91 92
    unsigned char *buf;
    int buf_size;
} AVProbeData;

#define AVPROBE_SCORE_MAX 100
F
Fabrice Bellard 已提交
93 94 95

typedef struct AVFormatParameters {
    int frame_rate;
96
    int frame_rate_base;
F
Fabrice Bellard 已提交
97 98 99 100
    int sample_rate;
    int channels;
    int width;
    int height;
101
    enum PixelFormat pix_fmt;
102
    struct AVImageFormat *image_format;
103 104
    int channel; /* used to select dv channel */
    const char *device; /* video4linux, audio or DV device */
105
    const char *standard; /* tv standard, NTSC, PAL, SECAM */
106 107 108 109
    int mpeg2ts_raw:1;  /* force raw MPEG2 transport stream output, if possible */
    int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
                                  stream packet (only meaningful if
                                  mpeg2ts_raw is TRUE */
F
Fabrice Bellard 已提交
110 111
} AVFormatParameters;

112 113 114
#define AVFMT_NOFILE        0x0001 /* no file should be opened */
#define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */ 
#define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
F
Fabrice Bellard 已提交
115 116
#define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
                                      raw picture data */
117 118

typedef struct AVOutputFormat {
F
Fabrice Bellard 已提交
119 120 121 122
    const char *name;
    const char *long_name;
    const char *mime_type;
    const char *extensions; /* comma separated extensions */
123 124
    /* size of private data so that it can be allocated in the wrapper */
    int priv_data_size;
F
Fabrice Bellard 已提交
125 126 127 128 129 130
    /* output support */
    enum CodecID audio_codec; /* default audio codec */
    enum CodecID video_codec; /* default video codec */
    int (*write_header)(struct AVFormatContext *);
    int (*write_packet)(struct AVFormatContext *, 
                        int stream_index,
131
                        const uint8_t *buf, int size, int64_t pts);
F
Fabrice Bellard 已提交
132
    int (*write_trailer)(struct AVFormatContext *);
133 134
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
    int flags;
135 136
    /* currently only used to set pixel format if not YUV420P */
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
137 138 139
    /* private fields */
    struct AVOutputFormat *next;
} AVOutputFormat;
F
Fabrice Bellard 已提交
140

141 142 143 144 145 146 147 148
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 已提交
149
       structure. Return 0 if OK. 'ap' if non NULL contains
150 151
       additionnal paramters. Only used in raw format right
       now. 'av_new_stream' should be called to create new streams.  */
F
Fabrice Bellard 已提交
152 153
    int (*read_header)(struct AVFormatContext *,
                       AVFormatParameters *ap);
154 155
    /* read one packet and put it in 'pkt'. pts and flags are also
       set. 'av_new_stream' can be called only if the flag
156
       AVFMTCTX_NOHEADER is used. */
F
Fabrice Bellard 已提交
157 158 159 160 161 162
    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 */
163
    int (*read_seek)(struct AVFormatContext *, int64_t pts);
164
    /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
F
Fabrice Bellard 已提交
165
    int flags;
166 167 168 169 170 171 172 173 174
    /* 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 已提交
175 176

typedef struct AVStream {
177 178
    int index;    /* stream index in AVFormatContext */
    int id;       /* format specific stream id */
F
Fabrice Bellard 已提交
179
    AVCodecContext codec; /* codec context */
180
    int r_frame_rate;     /* real frame rate of the stream */
181
    int r_frame_rate_base;/* real frame rate base of the stream */
F
Fabrice Bellard 已提交
182
    void *priv_data;
183 184 185 186
    /* internal data used in av_find_stream_info() */
    int codec_info_state;     
    int codec_info_nb_repeat_frames;
    int codec_info_nb_real_frames;
187
    /* encoding: PTS generation when outputing stream */
188
    AVFrac pts;
F
Fabrice Bellard 已提交
189 190
    /* ffmpeg.c private use */
    int stream_copy; /* if TRUE, just copy stream */
M
cleanup  
Michael Niedermayer 已提交
191 192 193
    /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
     * MN:dunno if thats the right place, for it */
    float quality; 
194 195 196 197 198 199
    /* decoding: position of the first frame of the component, in
       AV_TIME_BASE fractional seconds. */
    int64_t start_time; 
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
       seconds. */
    int64_t duration;
F
Fabrice Bellard 已提交
200 201
} AVStream;

202 203 204
#define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
                                         (streams are added dynamically) */

F
Fabrice Bellard 已提交
205 206 207 208
#define MAX_STREAMS 20

/* format I/O context */
typedef struct AVFormatContext {
209 210 211
    /* can only be iformat or oformat, not both at the same time */
    struct AVInputFormat *iformat;
    struct AVOutputFormat *oformat;
F
Fabrice Bellard 已提交
212 213 214 215 216 217 218 219 220 221
    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];
222 223 224 225 226
    char album[512];
    int year;  /* ID3 year, 0 if none */
    int track; /* track number, 0 if none */
    char genre[32]; /* ID3 genre */

227
    int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
F
Fabrice Bellard 已提交
228 229 230
    /* 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 已提交
231 232 233
    /* This buffer is only needed when packets were already buffered but
       not decoded, for example to get the codec parameters in mpeg
       streams */
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
    struct AVPacketList *packet_buffer;

    /* decoding: position of the first frame of the component, in
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
       it is deduced from the AVStream values.  */
    int64_t start_time; 
    /* decoding: duration of the stream, in AV_TIME_BASE fractional
       seconds. NEVER set this value directly: it is deduced from the
       AVStream values.  */
    int64_t duration;
    /* decoding: total file size. 0 if unknown */
    int64_t file_size;
    /* decoding: total stream bitrate in bit/s, 0 if not
       available. Never set it directly if the file_size and the
       duration are known as ffmpeg can compute it automatically. */
    int bit_rate;
F
Fabrice Bellard 已提交
250 251 252 253 254 255 256
} AVFormatContext;

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

257 258
extern AVInputFormat *first_iformat;
extern AVOutputFormat *first_oformat;
F
Fabrice Bellard 已提交
259

260 261 262 263 264 265 266 267
/* 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 */
268
    int interleaved; /* image is interleaved (e.g. interleaved GIF) */
269 270 271
    AVPicture pict; /* returned allocated image */
} AVImageInfo;

272
/* AVImageFormat.flags field constants */
273
#define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288
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 *);
289
    int flags;
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    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;
307
extern AVImageFormat pam_image_format;
308 309
extern AVImageFormat pgmyuv_image_format;
extern AVImageFormat yuv_image_format;
310
#ifdef CONFIG_ZLIB
F
Fabrice Bellard 已提交
311
extern AVImageFormat png_image_format;
312
#endif
313
extern AVImageFormat jpeg_image_format;
314
extern AVImageFormat gif_image_format;
315

316 317
/* XXX: use automatic init with either ELF sections or C file parser */
/* modules */
F
Fabrice Bellard 已提交
318

319
/* mpeg.c */
320
extern AVInputFormat mpegps_demux;
321 322 323 324 325
int mpegps_init(void);

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

327 328 329 330 331 332 333 334 335 336 337
/* 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 已提交
338 339

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

342 343
/* avidec.c */
int avidec_init(void);
344

345 346 347 348 349
/* swf.c */
int swf_init(void);

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

351 352 353
/* movenc.c */
int movenc_init(void);

354 355 356 357 358 359
/* flvenc.c */
int flvenc_init(void);

/* flvdec.c */
int flvdec_init(void);

360 361
/* jpeg.c */
int jpeg_init(void);
F
Fabrice Bellard 已提交
362

363
/* gif.c */
364 365
int gif_init(void);

366
/* au.c */
367
int au_init(void);
368

Z
Zdenek Kabelac 已提交
369 370 371
/* amr.c */
int amr_init(void);

F
Fabrice Bellard 已提交
372
/* wav.c */
373
int wav_init(void);
F
Fabrice Bellard 已提交
374 375

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

378 379 380
/* mp3.c */
int mp3_init(void);

381 382 383
/* yuv4mpeg.c */
int yuv4mpeg_init(void);

384 385 386
/* ogg.c */
int ogg_init(void);

387 388 389
/* dv.c */
int dv_init(void);

F
Fabrice Bellard 已提交
390
/* ffm.c */
391
int ffm_init(void);
F
Fabrice Bellard 已提交
392

F
Fabrice Bellard 已提交
393 394 395 396
/* rtsp.c */
extern AVInputFormat redir_demux;
int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);

M
Mike Melanson 已提交
397 398 399
/* 4xm.c */
int fourxm_init(void);

400 401 402
/* psxstr.c */
int str_init(void);

403 404 405 406 407 408
/* idroq.c */
int roq_init(void);

/* ipmovie.c */
int ipmovie_init(void);

409 410 411
/* nut.c */
int nut_init(void);

412 413 414
/* wc3movie.c */
int wc3_init(void);

415 416 417 418 419 420
/* westwood.c */
int westwood_init(void);

/* segafilm.c */
int film_init(void);

421 422 423
/* idcin.c */
int idcin_init(void);

F
Fabrice Bellard 已提交
424 425 426 427
#include "rtp.h"

#include "rtsp.h"

428 429 430
/* yuv4mpeg.c */
extern AVOutputFormat yuv4mpegpipe_oformat;

431 432 433
/* utils.c */
void av_register_input_format(AVInputFormat *format);
void av_register_output_format(AVOutputFormat *format);
434 435
AVOutputFormat *guess_stream_format(const char *short_name, 
                                    const char *filename, const char *mime_type);
436 437
AVOutputFormat *guess_format(const char *short_name, 
                             const char *filename, const char *mime_type);
F
Fabrice Bellard 已提交
438

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

F
Fabrice Bellard 已提交
441
void av_register_all(void);
F
Fabrice Bellard 已提交
442 443

typedef struct FifoBuffer {
444 445
    uint8_t *buffer;
    uint8_t *rptr, *wptr, *end;
F
Fabrice Bellard 已提交
446 447 448 449
} FifoBuffer;

int fifo_init(FifoBuffer *f, int size);
void fifo_free(FifoBuffer *f);
450 451 452
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 已提交
453

454 455
/* media file input */
AVInputFormat *av_find_input_format(const char *short_name);
F
Fabrice Bellard 已提交
456
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
457 458 459
int av_open_input_stream(AVFormatContext **ic_ptr, 
                         ByteIOContext *pb, const char *filename, 
                         AVInputFormat *fmt, AVFormatParameters *ap);
460 461 462 463 464 465 466 467 468 469 470 471 472
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 已提交
473 474
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
void av_close_input_file(AVFormatContext *s);
475
AVStream *av_new_stream(AVFormatContext *s, int id);
F
Fabrice Bellard 已提交
476 477
void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
                     int pts_num, int pts_den);
F
Fabrice Bellard 已提交
478

479
/* media file output */
480
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
481
int av_write_header(AVFormatContext *s);
482 483
int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf, 
                   int size);
484
int av_write_trailer(AVFormatContext *s);
F
Fabrice Bellard 已提交
485 486 487 488 489 490

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);
491
int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
492
int64_t parse_date(const char *datestr, int duration);
F
Fabrice Bellard 已提交
493

494
int64_t av_gettime(void);
F
Fabrice Bellard 已提交
495

F
Fabrice Bellard 已提交
496 497 498 499 500 501 502 503
/* 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 已提交
504 505
int get_frame_filename(char *buf, int buf_size,
                       const char *path, int number);
506
int filename_number_test(const char *filename);
507

508 509 510
/* grab specific */
int video_grab_init(void);
int audio_init(void);
511

F
Fabrice Bellard 已提交
512 513
/* DV1394 */
int dv1394_init(void);
F
Fabrice Bellard 已提交
514 515

#ifdef HAVE_AV_CONFIG_H
516 517 518

#include "os_support.h"

F
Fabrice Bellard 已提交
519 520 521 522 523
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);

F
Fabrice Bellard 已提交
524 525
void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);

F
Falk Hüffner 已提交
526
#ifdef __GNUC__
F
Fabrice Bellard 已提交
527 528 529 530 531 532 533
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    typeof(tab) _tab = (tab);\
    typeof(elem) _elem = (elem);\
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
    __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
} while(0)
F
Falk Hüffner 已提交
534 535 536 537 538 539
#else
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
} while(0)
#endif
F
Fabrice Bellard 已提交
540

541 542 543 544
time_t mktimegm(struct tm *tm);
const char *small_strptime(const char *p, const char *fmt, 
                           struct tm *dt);

F
Fabrice Bellard 已提交
545 546 547 548 549 550 551 552 553
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 已提交
554 555
int match_ext(const char *filename, const char *extensions);

F
Fabrice Bellard 已提交
556 557
#endif /* HAVE_AV_CONFIG_H */

558 559 560 561
#ifdef __cplusplus
}
#endif

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