MI_ReadUncompHuffman*

Syntax

#include <nitro/mi/uncomp_stream.h>

  

s32 MI_ReadUncompHuffman(  MIUncompContextHuffman *context,  
                               const u8* data, 
                               u32 len );

Arguments

`context`	Pointer to the context structure for uncompression of Huffman compressed data.
data	Pointer to a portion of the data to be uncompressed.
len	Size of the data provided in the 2nd argument.

Return Values

Returns the number of remaining bytes of data being uncompressed. If all of the data is finished being uncompressed, the function returns 0.

Description

Performs streaming uncompression of run-length compressed data, doing just the data size given, and copying it to the buffer specified by the MI_InitUncompContextHuffman function. This function is slow compared to the MI_UncompressHuffman* function, which uncompresses all the data at once.

MI_ReadUncompHuffman() writes in units of 8 bits. Data can be directly uncompressed to VRAM.

Internal Operation

Processing only takes place on the CPU, without the use of a system call or DMA.

Revision History

2004/11/30 Initial version.

CONFIDENTIAL