1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>MI_ReadUncompHuffman</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">MI_ReadUncompHuffman* <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19  <PRE><CODE>#include &lt;nitro/mi/uncomp_stream.h&gt;</CODE><BR>
20  <BR>
21<CODE>s32 MI_ReadUncompHuffman(  <A href="MIUncompContextHuffman.html">MIUncompContextHuffman</A> *context,
22                               const u8* data,
23                               u32 len );</CODE><br>
24</PRE>
25  </dd>
26</dl>
27<h2>Arguments</h2>
28<TABLE border="1" width="100%">
29  <TBODY>
30    <TR>
31      <TD width="13%"><EM><STRONG><em><strong><code>context</code></strong></em>&nbsp;&nbsp;</STRONG></EM></TD>
32      <TD width="87%">Pointer to the context structure for uncompression of Huffman compressed data.</TD>
33    </TR>
34    <TR>
35      <TD width="13%"><EM><STRONG>data</STRONG></EM></TD>
36      <TD width="87%">Pointer to a portion of the data to be uncompressed.</TD>
37    </TR>
38    <TR>
39      <TD><EM><STRONG>len</STRONG></EM></TD>
40      <TD>Size of the data provided in the 2nd argument.</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44
45<h2>Return Values</h2>
46<p>Returns the number of remaining bytes of data being uncompressed. If all of the data is finished being uncompressed, the function returns <code>0</code>.</p>
47
48<H2>Description</H2>
49<P>Performs streaming uncompression of run-length compressed data, doing just the data size given, and copying it to the buffer specified by the <A href="MI_InitUncompContextHuffman.html"><CODE>MI_InitUncompContextHuffman</CODE></A> function. This function is slow compared to the <A href="MI_UncompressHuffman.html"><CODE>MI_UncompressHuffman*</CODE></A> function, which uncompresses all the data at once.</P>
50<P><CODE>MI_ReadUncompHuffman()</CODE> writes in units of 8 bits. Data can be directly uncompressed to VRAM.</P>
51<h2>Internal Operation</h2>
52<P>Processing only takes place on the CPU, without the use of a system call or DMA.</P>
53<h2>See Also</h2>
54<p><CODE><A href="MI_UncompressHuffman.html">MI_UncompressHuffman</A>, <A href="MI_InitUncompContextHuffman.html">MI_InitUncompContextHuffman</A>, <A href="MIUncompContextHuffman.html">MIUncompContextHuffman</A>,<A href="MI_ReadUncompLZ.html">MI_ReadUncompLZ*</A>, <A href="MI_ReadUncompRL.html">MI_ReadUncompRL*</A>, <A href="MI_CompressHuffman.html">MI_CompressHuffman</A><br></CODE></p>
55
56<H2>Revision History</H2>
57<P>2004/11/30 Initial version.</P>
58<hr><p>CONFIDENTIAL</p></body>
59</html>
60