git.sesse.net Git - ffmpeg/blob - libavformat/avformat.h

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