Name

 
ICCompressBegin --- Prepare a compressor for compressing data
 
 

Syntax

 #include <mme/mme_api.h>
 MMRESULT ICCompressBegin(HIC hic,
                        LPBITMAPINFOHEADER lpbiInput,
                        LPBITMAPINFOHEADER lpbiOutput);
 

Arguments

 
HIC hic
Specifies a handle to a compressor.

 
LPBITMAPINFOHEADER lpbiInput
Specifies a pointer to a BITMAPINFOHEADER data structure holding the input format. 

 
The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICCompressBegin function. 
 
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures. 
 
 

 
LPBITMAPINFOHEADER lpbiOutput
Specifies a pointer to a BITMAPINFOHEADER data structure holding the output format. 

 
The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICCompressBegin function. 
 
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures. 
 
 

Description

 
The ICCompressBegin function prepares a compressor for compressing data.  Call this function before calling the ICCompress function. 

For bitstreaming CODECs (Software H.261 CODEC), this function starts compression. There is no need to call the ICCompress function; instead, call the mmeProcessCallbacks function to continue compression. Before calling the ICCompressBegin function, there must be an initial call with the ICAddBuffer function. 
 
 

Extensions

 
None.
 

Return Values

 
Returns ICERR_OK if the specified compression is supported; otherwise, it returns one of the following error codes:
 
 

 
ICERR_BADHANDLE@T{ The hic argument is invalid, the compressor is not open, or the compressor is not open for compression.  T} ICERR_BADFORMAT@T{ The lpbiOutput and lpbiInput arguments are not acceptable formats.  T} ICERR_BADPARAM@T{ The lpbiOutput argument, lpbiInput argument, or both are NULL.  T}

See Also

 
ICAddBuffer(3mms), ICCompress(3mms), ICCompressEnd(3mms), ICDecompressBegin(3mms)