ICDecompressEx

	Overview

	Group

	Quick Info

The ICDecompressEx function decompresses a single video frame.

DWORD ICDecompressEx(

HIC hic,
DWORD dwFlags,
LPBITMAPINFOHEADER lpbiSrc,
LPVOID lpSrc,
int xSrc,
int ySrc,
int dxSrc,
int dySrc,
LPBITMAPINFOHEADER lpbiDst,
LPVOID lpDst,
int xDst,
int yDst,
int dxDst,
int dyDst
);

Parameters
hic

Handle of the decompressor.

dwFlags

Decompression flags. The following values are defined:

ICDECOMPRESS_HURRYUP

Tries to decompress at a faster rate. When an application uses this flag, the driver should buffer the decompressed data but not draw the image.

ICDECOMPRESS_NOTKEYFRAME

Current frame is not a key frame.

ICDECOMPRESS_NULLFRAME

Current frame does not contain data and the decompressed image should be left the same.

ICDECOMPRESS_PREROLL

Current frame precedes the point in the movie where playback starts and, therefore, will not be drawn.

ICDECOMPRESS_UPDATE

Screen is being updated or refreshed.

lpbiSrc

Address of a BITMAPINFOHEADER structure containing the format of the compressed data.

lpSrc

Address of the input data.

xSrc, ySrc

The x- and y- coordinates of the source rectangle for the DIB specified by lpbiSrc.

dxSrc, dySrc

Width and height of the source rectangle.

lpbiDst

Address of a BITMAPINFOHEADER structure containing the output format.

lpDst

Address of a buffer that is large enough to contain the decompressed data.

xDst, yDst

The x- and y-coordinates of the destination rectangle for the DIB specified by lpbiDst.

dxDst, dyDst

Width and height of the destination rectangle.

Return Values
Returns ICERR_OK if successful or an error otherwise.

Remarks
Typically, applications use the ICDECOMPRESS_PREROLL flag to seek to a key frame in a compressed stream. The flag is sent with the key frame and with subsequent frames required to decompress the desired frame.