AVI Main Header (Compact 2013)

3/26/2014

This and following sections describe the chunks contained in the LIST 'hdrl' and LIST 'movi' chunks. The 'idx1' chunk is not described in this document.

For more information on the 'idx1' chunk and indexes in AVI files, see version 1.02 of the OpenDML AVI File Format Extensions, published by the OpenDML AVI M-JPEG File Format Subcommittee, February 28, 1996.

The file begins with the main header. In the AVI file, this header is identified by the 'avih' FOURCC (four-character code). The header contains global information for the entire AVI file, such as the number of streams within the file and the width and height of the AVI sequence.

The AVI main header structure is defined as follows.

typedef struct {
    DWORD dwMicroSecPerFrame;
    DWORD dwMaxBytesPerSec;
    DWORD dwReserved1;
    DWORD dwFlags;
    DWORD dwTotalFrames;
    DWORD dwInitialFrames;
    DWORD dwStreams;
    DWORD dwSuggestedBufferSize;
    DWORD dwWidth;
    DWORD dwHeight;
    DWORD dwReserved[4];
} MainAVIHeader;

Remarks

• dwMicroSecPerFrame
  Specifies the number of microseconds between frames. This value indicates the overall timing for the file.

• dwMaxBytesPerSec
  Specifies the approximate maximum data rate of the file. This value indicates the number of bytes per second the system must handle to present an AVI sequence as specified by the other parameters contained in the main header and stream header chunks.

• dwReserved1
  Reserved. Set this to zero.

• dwFlags
  Contains any flags for the file. The following flags are defined.

  Flag	Description
  AVIF_HASINDEX	Indicates the AVI file has an 'idx1' chunk containing an index at the end of the file. For good performance, all AVI files should contain an index.
  AVIF_MUSTUSEINDEX	Indicates that the index, rather than the physical ordering of the chunks in the file, should be used to determine the order of presentation of the data. For example, you could use this to create a list of frames for editing.
  AVIF_ISINTERLEAVED	Indicates the AVI file is interleaved.
  AVIF_WASCAPTUREFILE	Indicates the AVI file is a specially allocated file used for capturing real-time video. Applications should warn the user before writing over a file with this flag set because the user probably defragmented this file.
  AVIF_COPYRIGHTED	Indicates the AVI file contains copyrighted data and software. When this flag is used, software should not permit the data to be duplicated.

• dwTotalFrames
  Specifies the total number of frames of data in the file.

• dwInitialFrames
  Specifies the initial frame for interleaved files. Noninterleaved files should specify zero. If you are creating interleaved files, specify the number of frames in the file prior to the initial frame of the AVI sequence in this member.

  For more information about the contents of this member, see "Special Information for Interleaved Files" in Video for Windows Programmer's Guide.

• dwStreams
  Specifies the number of streams in the file. For example, a file with audio and video has two streams.

• dwSuggestedBufferSize
  Specifies the suggested buffer size for reading the file. Generally, this size should be large enough to contain the largest chunk in the file.

  If set to zero, or if it is too small, the playback software will have to reallocate memory during playback, which will reduce performance.

  For an interleaved file, the buffer size should be large enough to read an entire record, and not just a chunk.

• dwWidth
  Specifies the width of the AVI file in pixels.

• dwHeight
  Specifies the height of the AVI file in pixels.

• dwReserved[4]
  Reserved. Set this array to zero.

See Also

Reference

AVI RIFF File Reference