libavformat/avformat.h

   1 #ifndef AVFORMAT_H
   2 #define AVFORMAT_H
   3
   4 #ifdef __cplusplus
   5 extern "C" {
   6 #endif
   7
   8 #define LIBAVFORMAT_BUILD       4608
   9
  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)
  13
  14 #include <time.h>
  15
  16 #include "avcodec.h"
  17
  18 #include "avio.h"
  19
  20 /* packet functions */
  21
  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
  30 #define AV_NOPTS_VALUE MININT64
  31 #define AV_TIME_BASE 1000000
  32
  33 typedef struct AVPacket {
  34     int64_t pts; /* presentation time stamp in stream units (set av_set_pts_info) */
  35     uint8_t *data;
  36     int   size;
  37     int   stream_index;
  38     int   flags;
  39     int   duration;
  40     void  (*destruct)(struct AVPacket *);
  41     void  *priv;
  42 } AVPacket;
  43 #define PKT_FLAG_KEY   0x0001
  44
  45 static inline void av_init_packet(AVPacket *pkt)
  46 {
  47     pkt->pts   = AV_NOPTS_VALUE;
  48     pkt->flags = 0;
  49     pkt->stream_index = 0;
  50 }
  51
  52 int av_new_packet(AVPacket *pkt, int size);
  53
  54 /**
  55  * Free a packet
  56  *
  57  * @param pkt packet to free
  58  */
  59 static inline void av_free_packet(AVPacket *pkt)
  60 {
  61     if (pkt && pkt->destruct) {
  62         pkt->destruct(pkt);
  63     }
  64 }
  65
  66 /*************************************************/
  67 /* fractional numbers for exact pts handling */
  68
  69 /* the exact value of the fractional number is: 'val + num / den'. num
  70    is assumed to be such as 0 <= num < den */
  71 typedef struct AVFrac {
  72     int64_t val, num, den;
  73 } AVFrac;
  74
  75 void av_frac_init(AVFrac *f, int64_t val, int64_t num, int64_t den);
  76 void av_frac_add(AVFrac *f, int64_t incr);
  77 void av_frac_set(AVFrac *f, int64_t val);
  78
  79 /*************************************************/
  80 /* input/output formats */
  81
  82 struct AVFormatContext;
  83
  84 /* this structure contains the data a format has to probe a file */
  85 typedef struct AVProbeData {
  86     const char *filename;
  87     unsigned char *buf;
  88     int buf_size;
  89 } AVProbeData;
  90
  91 #define AVPROBE_SCORE_MAX 100
  92
  93 typedef struct AVFormatParameters {
  94     int frame_rate;
  95     int frame_rate_base;
  96     int sample_rate;
  97     int channels;
  98     int width;
  99     int height;
 100     enum PixelFormat pix_fmt;
 101     struct AVImageFormat *image_format;
 102     int channel; /* used to select dv channel */
 103     const char *device; /* video4linux, audio or DV device */
 104     const char *standard; /* tv standard, NTSC, PAL, SECAM */
 105 } AVFormatParameters;
 106
 107 #define AVFMT_NOFILE        0x0001 /* no file should be opened */
 108 #define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */
 109 #define AVFMT_NOHEADER      0x0004 /* signal that no header is present
 110                                       (streams are added dynamically) */
 111 #define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
 112 #define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
 113                                       raw picture data */
 114
 115 typedef struct AVOutputFormat {
 116     const char *name;
 117     const char *long_name;
 118     const char *mime_type;
 119     const char *extensions; /* comma separated extensions */
 120     /* size of private data so that it can be allocated in the wrapper */
 121     int priv_data_size;
 122     /* output support */
 123     enum CodecID audio_codec; /* default audio codec */
 124     enum CodecID video_codec; /* default video codec */
 125     int (*write_header)(struct AVFormatContext *);
 126     int (*write_packet)(struct AVFormatContext *,
 127                         int stream_index,
 128                         const uint8_t *buf, int size, int64_t pts);
 129     int (*write_trailer)(struct AVFormatContext *);
 130     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
 131     int flags;
 132     /* currently only used to set pixel format if not YUV420P */
 133     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
 134     /* private fields */
 135     struct AVOutputFormat *next;
 136 } AVOutputFormat;
 137
 138 typedef struct AVInputFormat {
 139     const char *name;
 140     const char *long_name;
 141     /* size of private data so that it can be allocated in the wrapper */
 142     int priv_data_size;
 143     /* tell if a given file has a chance of being parsing by this format */
 144     int (*read_probe)(AVProbeData *);
 145     /* read the format header and initialize the AVFormatContext
 146        structure. Return 0 if OK. 'ap' if non NULL contains
 147        additionnal paramters. Only used in raw format right
 148        now. 'av_new_stream' should be called to create new streams.  */
 149     int (*read_header)(struct AVFormatContext *,
 150                        AVFormatParameters *ap);
 151     /* read one packet and put it in 'pkt'. pts and flags are also
 152        set. 'av_new_stream' can be called only if the flag
 153        AVFMT_NOHEADER is used. */
 154     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
 155     /* close the stream. The AVFormatContext and AVStreams are not
 156        freed by this function */
 157     int (*read_close)(struct AVFormatContext *);
 158     /* seek at or before a given pts (given in microsecond). The pts
 159        origin is defined by the stream */
 160     int (*read_seek)(struct AVFormatContext *, int64_t pts);
 161     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_NOHEADER */
 162     int flags;
 163     /* if extensions are defined, then no probe is done. You should
 164        usually not use extension format guessing because it is not
 165        reliable enough */
 166     const char *extensions;
 167     /* general purpose read only value that the format can use */
 168     int value;
 169     /* private fields */
 170     struct AVInputFormat *next;
 171 } AVInputFormat;
 172
 173 typedef struct AVStream {
 174     int index;    /* stream index in AVFormatContext */
 175     int id;       /* format specific stream id */
 176     AVCodecContext codec; /* codec context */
 177     int r_frame_rate;     /* real frame rate of the stream */
 178     int r_frame_rate_base;/* real frame rate base of the stream */
 179     void *priv_data;
 180     /* internal data used in av_find_stream_info() */
 181     int codec_info_state;
 182     int codec_info_nb_repeat_frames;
 183     int codec_info_nb_real_frames;
 184     /* PTS generation when outputing stream */
 185     AVFrac pts;
 186     /* ffmpeg.c private use */
 187     int stream_copy; /* if TRUE, just copy stream */
 188     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
 189      * MN:dunno if thats the right place, for it */
 190     float quality;
 191     /* decoding: position of the first frame of the component, in
 192        AV_TIME_BASE fractional seconds. */
 193     int64_t start_time;
 194     /* decoding: duration of the stream, in AV_TIME_BASE fractional
 195        seconds. */
 196     int64_t duration;
 197 } AVStream;
 198
 199 #define MAX_STREAMS 20
 200
 201 /* format I/O context */
 202 typedef struct AVFormatContext {
 203     /* can only be iformat or oformat, not both at the same time */
 204     struct AVInputFormat *iformat;
 205     struct AVOutputFormat *oformat;
 206     void *priv_data;
 207     ByteIOContext pb;
 208     int nb_streams;
 209     AVStream *streams[MAX_STREAMS];
 210     char filename[1024]; /* input or output filename */
 211     /* stream info */
 212     char title[512];
 213     char author[512];
 214     char copyright[512];
 215     char comment[512];
 216     char album[512];
 217     int year;  /* ID3 year, 0 if none */
 218     int track; /* track number, 0 if none */
 219     char genre[32]; /* ID3 genre */
 220
 221     int flags; /* format specific flags */
 222     /* private data for pts handling (do not modify directly) */
 223     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
 224     int pts_num, pts_den; /* value to convert to seconds */
 225     /* This buffer is only needed when packets were already buffered but
 226        not decoded, for example to get the codec parameters in mpeg
 227        streams */
 228     struct AVPacketList *packet_buffer;
 229
 230     /* decoding: position of the first frame of the component, in
 231        AV_TIME_BASE fractional seconds. NEVER set this value directly:
 232        it is deduced from the AVStream values.  */
 233     int64_t start_time;
 234     /* decoding: duration of the stream, in AV_TIME_BASE fractional
 235        seconds. NEVER set this value directly: it is deduced from the
 236        AVStream values.  */
 237     int64_t duration;
 238     /* decoding: total file size. 0 if unknown */
 239     int64_t file_size;
 240     /* decoding: total stream bitrate in bit/s, 0 if not
 241        available. Never set it directly if the file_size and the
 242        duration are known as ffmpeg can compute it automatically. */
 243     int bit_rate;
 244 } AVFormatContext;
 245
 246 typedef struct AVPacketList {
 247     AVPacket pkt;
 248     struct AVPacketList *next;
 249 } AVPacketList;
 250
 251 extern AVInputFormat *first_iformat;
 252 extern AVOutputFormat *first_oformat;
 253
 254 /* still image support */
 255 struct AVInputImageContext;
 256 typedef struct AVInputImageContext AVInputImageContext;
 257
 258 typedef struct AVImageInfo {
 259     enum PixelFormat pix_fmt; /* requested pixel format */
 260     int width; /* requested width */
 261     int height; /* requested height */
 262     int interleaved; /* image is interleaved (e.g. interleaved GIF) */
 263     AVPicture pict; /* returned allocated image */
 264 } AVImageInfo;
 265
 266 /* AVImageFormat.flags field constants */
 267 #define AVIMAGE_INTERLEAVED 0x0001 /* image format support interleaved output */
 268
 269 typedef struct AVImageFormat {
 270     const char *name;
 271     const char *extensions;
 272     /* tell if a given file has a chance of being parsing by this format */
 273     int (*img_probe)(AVProbeData *);
 274     /* read a whole image. 'alloc_cb' is called when the image size is
 275        known so that the caller can allocate the image. If 'allo_cb'
 276        returns non zero, then the parsing is aborted. Return '0' if
 277        OK. */
 278     int (*img_read)(ByteIOContext *,
 279                     int (*alloc_cb)(void *, AVImageInfo *info), void *);
 280     /* write the image */
 281     int supported_pixel_formats; /* mask of supported formats for output */
 282     int (*img_write)(ByteIOContext *, AVImageInfo *);
 283     int flags;
 284     struct AVImageFormat *next;
 285 } AVImageFormat;
 286
 287 void av_register_image_format(AVImageFormat *img_fmt);
 288 AVImageFormat *av_probe_image_format(AVProbeData *pd);
 289 AVImageFormat *guess_image_format(const char *filename);
 290 int av_read_image(ByteIOContext *pb, const char *filename,
 291                   AVImageFormat *fmt,
 292                   int (*alloc_cb)(void *, AVImageInfo *info), void *opaque);
 293 int av_write_image(ByteIOContext *pb, AVImageFormat *fmt, AVImageInfo *img);
 294
 295 extern AVImageFormat *first_image_format;
 296
 297 extern AVImageFormat pnm_image_format;
 298 extern AVImageFormat pbm_image_format;
 299 extern AVImageFormat pgm_image_format;
 300 extern AVImageFormat ppm_image_format;
 301 extern AVImageFormat pam_image_format;
 302 extern AVImageFormat pgmyuv_image_format;
 303 extern AVImageFormat yuv_image_format;
 304 #ifdef CONFIG_ZLIB
 305 extern AVImageFormat png_image_format;
 306 #endif
 307 extern AVImageFormat jpeg_image_format;
 308 extern AVImageFormat gif_image_format;
 309
 310 /* XXX: use automatic init with either ELF sections or C file parser */
 311 /* modules */
 312
 313 /* mpeg.c */
 314 extern AVInputFormat mpegps_demux;
 315 int mpegps_init(void);
 316
 317 /* mpegts.c */
 318 extern AVInputFormat mpegts_demux;
 319 int mpegts_init(void);
 320
 321 /* rm.c */
 322 int rm_init(void);
 323
 324 /* crc.c */
 325 int crc_init(void);
 326
 327 /* img.c */
 328 int img_init(void);
 329
 330 /* asf.c */
 331 int asf_init(void);
 332
 333 /* avienc.c */
 334 int avienc_init(void);
 335
 336 /* avidec.c */
 337 int avidec_init(void);
 338
 339 /* swf.c */
 340 int swf_init(void);
 341
 342 /* mov.c */
 343 int mov_init(void);
 344
 345 /* movenc.c */
 346 int movenc_init(void);
 347
 348 /* flvenc.c */
 349 int flvenc_init(void);
 350
 351 /* flvdec.c */
 352 int flvdec_init(void);
 353
 354 /* jpeg.c */
 355 int jpeg_init(void);
 356
 357 /* gif.c */
 358 int gif_init(void);
 359
 360 /* au.c */
 361 int au_init(void);
 362
 363 /* amr.c */
 364 int amr_init(void);
 365
 366 /* wav.c */
 367 int wav_init(void);
 368
 369 /* raw.c */
 370 int raw_init(void);
 371
 372 /* mp3.c */
 373 int mp3_init(void);
 374
 375 /* yuv4mpeg.c */
 376 int yuv4mpeg_init(void);
 377
 378 /* ogg.c */
 379 int ogg_init(void);
 380
 381 /* dv.c */
 382 int dv_init(void);
 383
 384 /* ffm.c */
 385 int ffm_init(void);
 386
 387 /* rtsp.c */
 388 extern AVInputFormat redir_demux;
 389 int redir_open(AVFormatContext **ic_ptr, ByteIOContext *f);
 390
 391 /* 4xm.c */
 392 int fourxm_init(void);
 393
 394 /* psxstr.c */
 395 int str_init(void);
 396
 397 /* idroq.c */
 398 int roq_init(void);
 399
 400 /* ipmovie.c */
 401 int ipmovie_init(void);
 402
 403 /* nut.c */
 404 int nut_init(void);
 405
 406 /* wc3movie.c */
 407 int wc3_init(void);
 408
 409 /* westwood.c */
 410 int westwood_init(void);
 411
 412 /* segafilm.c */
 413 int film_init(void);
 414
 415 #include "rtp.h"
 416
 417 #include "rtsp.h"
 418
 419 /* yuv4mpeg.c */
 420 extern AVOutputFormat yuv4mpegpipe_oformat;
 421
 422 /* utils.c */
 423 void av_register_input_format(AVInputFormat *format);
 424 void av_register_output_format(AVOutputFormat *format);
 425 AVOutputFormat *guess_stream_format(const char *short_name,
 426                                     const char *filename, const char *mime_type);
 427 AVOutputFormat *guess_format(const char *short_name,
 428                              const char *filename, const char *mime_type);
 429
 430 void av_hex_dump(uint8_t *buf, int size);
 431
 432 void av_register_all(void);
 433
 434 typedef struct FifoBuffer {
 435     uint8_t *buffer;
 436     uint8_t *rptr, *wptr, *end;
 437 } FifoBuffer;
 438
 439 int fifo_init(FifoBuffer *f, int size);
 440 void fifo_free(FifoBuffer *f);
 441 int fifo_size(FifoBuffer *f, uint8_t *rptr);
 442 int fifo_read(FifoBuffer *f, uint8_t *buf, int buf_size, uint8_t **rptr_ptr);
 443 void fifo_write(FifoBuffer *f, uint8_t *buf, int size, uint8_t **wptr_ptr);
 444
 445 /* media file input */
 446 AVInputFormat *av_find_input_format(const char *short_name);
 447 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
 448 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
 449                        AVInputFormat *fmt,
 450                        int buf_size,
 451                        AVFormatParameters *ap);
 452
 453 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
 454 #define AVERROR_IO          (-2)  /* i/o error */
 455 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
 456 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
 457 #define AVERROR_NOMEM       (-5)  /* not enough memory */
 458 #define AVERROR_NOFMT       (-6)  /* unknown format */
 459
 460 int av_find_stream_info(AVFormatContext *ic);
 461 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
 462 void av_close_input_file(AVFormatContext *s);
 463 AVStream *av_new_stream(AVFormatContext *s, int id);
 464 void av_set_pts_info(AVFormatContext *s, int pts_wrap_bits,
 465                      int pts_num, int pts_den);
 466
 467 /* media file output */
 468 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
 469 int av_write_header(AVFormatContext *s);
 470 int av_write_frame(AVFormatContext *s, int stream_index, const uint8_t *buf,
 471                    int size);
 472 int av_write_trailer(AVFormatContext *s);
 473
 474 void dump_format(AVFormatContext *ic,
 475                  int index,
 476                  const char *url,
 477                  int is_output);
 478 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
 479 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
 480 int64_t parse_date(const char *datestr, int duration);
 481
 482 int64_t av_gettime(void);
 483
 484 /* ffm specific for ffserver */
 485 #define FFM_PACKET_SIZE 4096
 486 offset_t ffm_read_write_index(int fd);
 487 void ffm_write_write_index(int fd, offset_t pos);
 488 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
 489
 490 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
 491
 492 int get_frame_filename(char *buf, int buf_size,
 493                        const char *path, int number);
 494 int filename_number_test(const char *filename);
 495
 496 /* grab specific */
 497 int video_grab_init(void);
 498 int audio_init(void);
 499
 500 /* DV1394 */
 501 int dv1394_init(void);
 502
 503 #ifdef HAVE_AV_CONFIG_H
 504
 505 #include "os_support.h"
 506
 507 int strstart(const char *str, const char *val, const char **ptr);
 508 int stristart(const char *str, const char *val, const char **ptr);
 509 void pstrcpy(char *buf, int buf_size, const char *str);
 510 char *pstrcat(char *buf, int buf_size, const char *s);
 511
 512 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
 513
 514 #ifdef __GNUC__
 515 #define dynarray_add(tab, nb_ptr, elem)\
 516 do {\
 517     typeof(tab) _tab = (tab);\
 518     typeof(elem) _elem = (elem);\
 519     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
 520     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
 521 } while(0)
 522 #else
 523 #define dynarray_add(tab, nb_ptr, elem)\
 524 do {\
 525     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
 526 } while(0)
 527 #endif
 528
 529 time_t mktimegm(struct tm *tm);
 530 const char *small_strptime(const char *p, const char *fmt,
 531                            struct tm *dt);
 532
 533 struct in_addr;
 534 int resolve_host(struct in_addr *sin_addr, const char *hostname);
 535
 536 void url_split(char *proto, int proto_size,
 537                char *hostname, int hostname_size,
 538                int *port_ptr,
 539                char *path, int path_size,
 540                const char *url);
 541
 542 int match_ext(const char *filename, const char *extensions);
 543
 544 #endif /* HAVE_AV_CONFIG_H */
 545
 546 #ifdef __cplusplus
 547 }
 548 #endif
 549
 550 #endif /* AVFORMAT_H */