CXInitUncompContextHuffmanFront

Syntax

#include <revolution/cx/CXStreamingUncompression.h>

void CXInitUncompContextHuffmanFront( CXUncompContextHuffman *context, 
                                      void*                   dest,
                                      s32                     destSize );

Arguments

context Pointer to the context structure to be used for streaming the uncompression of Huffman-compressed data.
dest Destination buffer for uncompressed data.
destSize Maximum amount of data that will be uncompressed. Specify a multiple of 4 bytes.

Return Values

None.

Description

Initializes the context structure for streaming uncompression of Huffman-compressed data. Use this interface for uncompressing only the number of bytes of data specified by destSize.
To uncompress all data, use the CXInitUncompContextHuffman function.

When the CXReadUncompHuffman function is run in this context, the next set of data gets expanded in the region passed by the dest argument.

If this context is going to be reused, it needs to be reinitialized after the expansion of each file is completed.

See Also

CXGetUncompressedSize
CXUncompressHuffman
CXSecureUncompressHuffman
CXInitUncompContextHuffman
CXReadUncompHuffman
CXIsFinishedUncompHuffman
CXCompressHuffman
ntcompress

Revision History

2008/09/25 Added the restriction that destSize be a multiple of 4 bytes.
2007/09/03 Corrected an error in See Also.
2007/06/05 Initial version.


CONFIDENTIAL