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

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVFORMAT_H
  22 #define AVFORMAT_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #define LIBAVFORMAT_VERSION_INT ((51<<16)+(7<<8)+0)
  29 #define LIBAVFORMAT_VERSION     51.7.0
  30 #define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
  31
  32 #define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
  33
  34 #include <time.h>
  35 #include <stdio.h>  /* FILE */
  36 #include "avcodec.h"
  37
  38 #include "avio.h"
  39
  40 /* packet functions */
  41
  42 typedef struct AVPacket {
  43     int64_t pts;                            ///< presentation time stamp in time_base units
  44     int64_t dts;                            ///< decompression time stamp in time_base units
  45     uint8_t *data;
  46     int   size;
  47     int   stream_index;
  48     int   flags;
  49     int   duration;                         ///< presentation duration in time_base units (0 if not available)
  50     void  (*destruct)(struct AVPacket *);
  51     void  *priv;
  52     int64_t pos;                            ///< byte position in stream, -1 if unknown
  53 } AVPacket;
  54 #define PKT_FLAG_KEY   0x0001
  55
  56 void av_destruct_packet_nofree(AVPacket *pkt);
  57 void av_destruct_packet(AVPacket *pkt);
  58
  59 /* initialize optional fields of a packet */
  60 static inline void av_init_packet(AVPacket *pkt)
  61 {
  62     pkt->pts   = AV_NOPTS_VALUE;
  63     pkt->dts   = AV_NOPTS_VALUE;
  64     pkt->pos   = -1;
  65     pkt->duration = 0;
  66     pkt->flags = 0;
  67     pkt->stream_index = 0;
  68     pkt->destruct= av_destruct_packet_nofree;
  69 }
  70
  71 int av_new_packet(AVPacket *pkt, int size);
  72 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
  73 int av_dup_packet(AVPacket *pkt);
  74
  75 /**
  76  * Free a packet
  77  *
  78  * @param pkt packet to free
  79  */
  80 static inline void av_free_packet(AVPacket *pkt)
  81 {
  82     if (pkt && pkt->destruct) {
  83         pkt->destruct(pkt);
  84     }
  85 }
  86
  87 /*************************************************/
  88 /* fractional numbers for exact pts handling */
  89
  90 /* the exact value of the fractional number is: 'val + num / den'. num
  91    is assumed to be such as 0 <= num < den */
  92 typedef struct AVFrac {
  93     int64_t val, num, den;
  94 } AVFrac attribute_deprecated;
  95
  96 /*************************************************/
  97 /* input/output formats */
  98
  99 struct AVFormatContext;
 100
 101 /* this structure contains the data a format has to probe a file */
 102 typedef struct AVProbeData {
 103     const char *filename;
 104     unsigned char *buf;
 105     int buf_size;
 106 } AVProbeData;
 107
 108 #define AVPROBE_SCORE_MAX 100               ///< max score, half of that is used for file extension based detection
 109
 110 typedef struct AVFormatParameters {
 111     AVRational time_base;
 112     int sample_rate;
 113     int channels;
 114     int width;
 115     int height;
 116     enum PixelFormat pix_fmt;
 117     int channel; /* used to select dv channel */
 118     const char *device; /* video, audio or DV device */
 119     const char *standard; /* tv standard, NTSC, PAL, SECAM */
 120     int mpeg2ts_raw:1;  /* force raw MPEG2 transport stream output, if possible */
 121     int mpeg2ts_compute_pcr:1; /* compute exact PCR for each transport
 122                                   stream packet (only meaningful if
 123                                   mpeg2ts_raw is TRUE */
 124     int initial_pause:1;       /* do not begin to play the stream
 125                                   immediately (RTSP only) */
 126     int prealloced_context:1;
 127     enum CodecID video_codec_id;
 128     enum CodecID audio_codec_id;
 129 } AVFormatParameters;
 130
 131 //! demuxer will use url_fopen, no opened file should be provided by the caller
 132 #define AVFMT_NOFILE        0x0001
 133 #define AVFMT_NEEDNUMBER    0x0002 /* needs '%d' in filename */
 134 #define AVFMT_SHOW_IDS      0x0008 /* show format stream IDs numbers */
 135 #define AVFMT_RAWPICTURE    0x0020 /* format wants AVPicture structure for
 136                                       raw picture data */
 137 #define AVFMT_GLOBALHEADER  0x0040 /* format wants global header */
 138 #define AVFMT_NOTIMESTAMPS  0x0080 /* format doesnt need / has any timestamps */
 139
 140 typedef struct AVOutputFormat {
 141     const char *name;
 142     const char *long_name;
 143     const char *mime_type;
 144     const char *extensions; /* comma separated extensions */
 145     /* size of private data so that it can be allocated in the wrapper */
 146     int priv_data_size;
 147     /* output support */
 148     enum CodecID audio_codec; /* default audio codec */
 149     enum CodecID video_codec; /* default video codec */
 150     int (*write_header)(struct AVFormatContext *);
 151     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
 152     int (*write_trailer)(struct AVFormatContext *);
 153     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
 154     int flags;
 155     /* currently only used to set pixel format if not YUV420P */
 156     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
 157     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
 158     /* private fields */
 159     struct AVOutputFormat *next;
 160 } AVOutputFormat;
 161
 162 typedef struct AVInputFormat {
 163     const char *name;
 164     const char *long_name;
 165     /* size of private data so that it can be allocated in the wrapper */
 166     int priv_data_size;
 167     /* tell if a given file has a chance of being parsing by this format */
 168     int (*read_probe)(AVProbeData *);
 169     /* read the format header and initialize the AVFormatContext
 170        structure. Return 0 if OK. 'ap' if non NULL contains
 171        additionnal paramters. Only used in raw format right
 172        now. 'av_new_stream' should be called to create new streams.  */
 173     int (*read_header)(struct AVFormatContext *,
 174                        AVFormatParameters *ap);
 175     /* read one packet and put it in 'pkt'. pts and flags are also
 176        set. 'av_new_stream' can be called only if the flag
 177        AVFMTCTX_NOHEADER is used. */
 178     int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
 179     /* close the stream. The AVFormatContext and AVStreams are not
 180        freed by this function */
 181     int (*read_close)(struct AVFormatContext *);
 182     /**
 183      * seek to a given timestamp relative to the frames in
 184      * stream component stream_index
 185      * @param stream_index must not be -1
 186      * @param flags selects which direction should be preferred if no exact
 187      *              match is available
 188      */
 189     int (*read_seek)(struct AVFormatContext *,
 190                      int stream_index, int64_t timestamp, int flags);
 191     /**
 192      * gets the next timestamp in AV_TIME_BASE units.
 193      */
 194     int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
 195                               int64_t *pos, int64_t pos_limit);
 196     /* can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
 197     int flags;
 198     /* if extensions are defined, then no probe is done. You should
 199        usually not use extension format guessing because it is not
 200        reliable enough */
 201     const char *extensions;
 202     /* general purpose read only value that the format can use */
 203     int value;
 204
 205     /* start/resume playing - only meaningful if using a network based format
 206        (RTSP) */
 207     int (*read_play)(struct AVFormatContext *);
 208
 209     /* pause playing - only meaningful if using a network based format
 210        (RTSP) */
 211     int (*read_pause)(struct AVFormatContext *);
 212
 213     /* private fields */
 214     struct AVInputFormat *next;
 215 } AVInputFormat;
 216
 217 typedef struct AVIndexEntry {
 218     int64_t pos;
 219     int64_t timestamp;
 220 #define AVINDEX_KEYFRAME 0x0001
 221     int flags:2;
 222     int size:30; //yeah trying to keep the size of this small to reduce memory requirements (its 24 vs 32 byte due to possible 8byte align)
 223     int min_distance;         /* min distance between this and the previous keyframe, used to avoid unneeded searching */
 224 } AVIndexEntry;
 225
 226 typedef struct AVStream {
 227     int index;    /* stream index in AVFormatContext */
 228     int id;       /* format specific stream id */
 229     AVCodecContext *codec; /* codec context */
 230     /**
 231      * real base frame rate of the stream.
 232      * this is the lowest framerate with which all timestamps can be
 233      * represented accurately (its the least common multiple of all
 234      * framerates in the stream), Note, this value is just a guess!
 235      * for example if the timebase is 1/90000 and all frames have either
 236      * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
 237      */
 238     AVRational r_frame_rate;
 239     void *priv_data;
 240     /* internal data used in av_find_stream_info() */
 241     int64_t codec_info_duration;
 242     int codec_info_nb_frames;
 243     /* encoding: PTS generation when outputing stream */
 244     AVFrac pts;
 245
 246     /**
 247      * this is the fundamental unit of time (in seconds) in terms
 248      * of which frame timestamps are represented. for fixed-fps content,
 249      * timebase should be 1/framerate and timestamp increments should be
 250      * identically 1.
 251      */
 252     AVRational time_base;
 253     int pts_wrap_bits; /* number of bits in pts (used for wrapping control) */
 254     /* ffmpeg.c private use */
 255     int stream_copy; /* if TRUE, just copy stream */
 256     enum AVDiscard discard; ///< selects which packets can be discarded at will and dont need to be demuxed
 257     //FIXME move stuff to a flags field?
 258     /* quality, as it has been removed from AVCodecContext and put in AVVideoFrame
 259      * MN:dunno if thats the right place, for it */
 260     float quality;
 261     /* decoding: position of the first frame of the component, in
 262        AV_TIME_BASE fractional seconds. */
 263     int64_t start_time;
 264     /* decoding: duration of the stream, in AV_TIME_BASE fractional
 265        seconds. */
 266     int64_t duration;
 267
 268     char language[4]; /* ISO 639 3-letter language code (empty string if undefined) */
 269
 270     /* av_read_frame() support */
 271     int need_parsing;                  ///< 1->full parsing needed, 2->only parse headers dont repack
 272     struct AVCodecParserContext *parser;
 273
 274     int64_t cur_dts;
 275     int last_IP_duration;
 276     int64_t last_IP_pts;
 277     /* av_seek_frame() support */
 278     AVIndexEntry *index_entries; /* only used if the format does not
 279                                     support seeking natively */
 280     int nb_index_entries;
 281     unsigned int index_entries_allocated_size;
 282
 283     int64_t nb_frames;                 ///< number of frames in this stream if known or 0
 284
 285 #define MAX_REORDER_DELAY 4
 286     int64_t pts_buffer[MAX_REORDER_DELAY+1];
 287 } AVStream;
 288
 289 #define AVFMTCTX_NOHEADER      0x0001 /* signal that no header is present
 290                                          (streams are added dynamically) */
 291
 292 #define MAX_STREAMS 20
 293
 294 /* format I/O context */
 295 typedef struct AVFormatContext {
 296     const AVClass *av_class; /* set by av_alloc_format_context */
 297     /* can only be iformat or oformat, not both at the same time */
 298     struct AVInputFormat *iformat;
 299     struct AVOutputFormat *oformat;
 300     void *priv_data;
 301     ByteIOContext pb;
 302     unsigned int nb_streams;
 303     AVStream *streams[MAX_STREAMS];
 304     char filename[1024]; /* input or output filename */
 305     /* stream info */
 306     int64_t timestamp;
 307     char title[512];
 308     char author[512];
 309     char copyright[512];
 310     char comment[512];
 311     char album[512];
 312     int year;  /* ID3 year, 0 if none */
 313     int track; /* track number, 0 if none */
 314     char genre[32]; /* ID3 genre */
 315
 316     int ctx_flags; /* format specific flags, see AVFMTCTX_xx */
 317     /* private data for pts handling (do not modify directly) */
 318     /* This buffer is only needed when packets were already buffered but
 319        not decoded, for example to get the codec parameters in mpeg
 320        streams */
 321     struct AVPacketList *packet_buffer;
 322
 323     /* decoding: position of the first frame of the component, in
 324        AV_TIME_BASE fractional seconds. NEVER set this value directly:
 325        it is deduced from the AVStream values.  */
 326     int64_t start_time;
 327     /* decoding: duration of the stream, in AV_TIME_BASE fractional
 328        seconds. NEVER set this value directly: it is deduced from the
 329        AVStream values.  */
 330     int64_t duration;
 331     /* decoding: total file size. 0 if unknown */
 332     int64_t file_size;
 333     /* decoding: total stream bitrate in bit/s, 0 if not
 334        available. Never set it directly if the file_size and the
 335        duration are known as ffmpeg can compute it automatically. */
 336     int bit_rate;
 337
 338     /* av_read_frame() support */
 339     AVStream *cur_st;
 340     const uint8_t *cur_ptr;
 341     int cur_len;
 342     AVPacket cur_pkt;
 343
 344     /* av_seek_frame() support */
 345     int64_t data_offset; /* offset of the first packet */
 346     int index_built;
 347
 348     int mux_rate;
 349     int packet_size;
 350     int preload;
 351     int max_delay;
 352
 353 #define AVFMT_NOOUTPUTLOOP -1
 354 #define AVFMT_INFINITEOUTPUTLOOP 0
 355     /* number of times to loop output in formats that support it */
 356     int loop_output;
 357
 358     int flags;
 359 #define AVFMT_FLAG_GENPTS       0x0001 ///< generate pts if missing even if it requires parsing future frames
 360 #define AVFMT_FLAG_IGNIDX       0x0002 ///< ignore index
 361
 362     int loop_input;
 363     /* decoding: size of data to probe; encoding unused */
 364     unsigned int probesize;
 365 } AVFormatContext;
 366
 367 typedef struct AVPacketList {
 368     AVPacket pkt;
 369     struct AVPacketList *next;
 370 } AVPacketList;
 371
 372 extern AVInputFormat *first_iformat;
 373 extern AVOutputFormat *first_oformat;
 374
 375 enum CodecID av_guess_image2_codec(const char *filename);
 376
 377 /* XXX: use automatic init with either ELF sections or C file parser */
 378 /* modules */
 379
 380 #include "rtp.h"
 381
 382 #include "rtsp.h"
 383
 384 /* utils.c */
 385 void av_register_input_format(AVInputFormat *format);
 386 void av_register_output_format(AVOutputFormat *format);
 387 AVOutputFormat *guess_stream_format(const char *short_name,
 388                                     const char *filename, const char *mime_type);
 389 AVOutputFormat *guess_format(const char *short_name,
 390                              const char *filename, const char *mime_type);
 391 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
 392                             const char *filename, const char *mime_type, enum CodecType type);
 393
 394 void av_hex_dump(FILE *f, uint8_t *buf, int size);
 395 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
 396
 397 void av_register_all(void);
 398
 399 /* media file input */
 400 AVInputFormat *av_find_input_format(const char *short_name);
 401 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
 402 int av_open_input_stream(AVFormatContext **ic_ptr,
 403                          ByteIOContext *pb, const char *filename,
 404                          AVInputFormat *fmt, AVFormatParameters *ap);
 405 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
 406                        AVInputFormat *fmt,
 407                        int buf_size,
 408                        AVFormatParameters *ap);
 409 /* no av_open for output, so applications will need this: */
 410 AVFormatContext *av_alloc_format_context(void);
 411
 412 #define AVERROR_UNKNOWN     (-1)  /* unknown error */
 413 #define AVERROR_IO          (-2)  /* i/o error */
 414 #define AVERROR_NUMEXPECTED (-3)  /* number syntax expected in filename */
 415 #define AVERROR_INVALIDDATA (-4)  /* invalid data found */
 416 #define AVERROR_NOMEM       (-5)  /* not enough memory */
 417 #define AVERROR_NOFMT       (-6)  /* unknown format */
 418 #define AVERROR_NOTSUPP     (-7)  /* operation not supported */
 419
 420 int av_find_stream_info(AVFormatContext *ic);
 421 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
 422 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
 423 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
 424 int av_read_play(AVFormatContext *s);
 425 int av_read_pause(AVFormatContext *s);
 426 void av_close_input_file(AVFormatContext *s);
 427 AVStream *av_new_stream(AVFormatContext *s, int id);
 428 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
 429                      int pts_num, int pts_den);
 430
 431 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
 432 #define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
 433 #define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non keyframes
 434
 435 int av_find_default_stream_index(AVFormatContext *s);
 436 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
 437 int av_add_index_entry(AVStream *st,
 438                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
 439 int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
 440 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
 441 int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
 442
 443 /* media file output */
 444 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
 445 int av_write_header(AVFormatContext *s);
 446 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
 447 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
 448 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
 449
 450 int av_write_trailer(AVFormatContext *s);
 451
 452 void dump_format(AVFormatContext *ic,
 453                  int index,
 454                  const char *url,
 455                  int is_output);
 456 int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
 457 int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
 458 int64_t parse_date(const char *datestr, int duration);
 459
 460 int64_t av_gettime(void);
 461
 462 /* ffm specific for ffserver */
 463 #define FFM_PACKET_SIZE 4096
 464 offset_t ffm_read_write_index(int fd);
 465 void ffm_write_write_index(int fd, offset_t pos);
 466 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
 467
 468 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
 469
 470 int av_get_frame_filename(char *buf, int buf_size,
 471                           const char *path, int number);
 472 int av_filename_number_test(const char *filename);
 473
 474 /* grab specific */
 475 int video_grab_init(void);
 476 int audio_init(void);
 477
 478 /* DV1394 */
 479 int dv1394_init(void);
 480 int dc1394_init(void);
 481
 482 #ifdef HAVE_AV_CONFIG_H
 483
 484 #include "os_support.h"
 485
 486 int strstart(const char *str, const char *val, const char **ptr);
 487 int stristart(const char *str, const char *val, const char **ptr);
 488 void pstrcpy(char *buf, int buf_size, const char *str);
 489 char *pstrcat(char *buf, int buf_size, const char *s);
 490
 491 void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
 492
 493 #ifdef __GNUC__
 494 #define dynarray_add(tab, nb_ptr, elem)\
 495 do {\
 496     typeof(tab) _tab = (tab);\
 497     typeof(elem) _elem = (elem);\
 498     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
 499     __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
 500 } while(0)
 501 #else
 502 #define dynarray_add(tab, nb_ptr, elem)\
 503 do {\
 504     __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
 505 } while(0)
 506 #endif
 507
 508 time_t mktimegm(struct tm *tm);
 509 struct tm *brktimegm(time_t secs, struct tm *tm);
 510 const char *small_strptime(const char *p, const char *fmt,
 511                            struct tm *dt);
 512
 513 struct in_addr;
 514 int resolve_host(struct in_addr *sin_addr, const char *hostname);
 515
 516 void url_split(char *proto, int proto_size,
 517                char *authorization, int authorization_size,
 518                char *hostname, int hostname_size,
 519                int *port_ptr,
 520                char *path, int path_size,
 521                const char *url);
 522
 523 int match_ext(const char *filename, const char *extensions);
 524
 525 #endif /* HAVE_AV_CONFIG_H */
 526
 527 #ifdef __cplusplus
 528 }
 529 #endif
 530
 531 #endif /* AVFORMAT_H */
 532