1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>CompressHuffman</title>
8  </head>
9  <body>
10<h1><CODE>nn::cx::CompressHuffman</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14u32 CompressHuffman(
15     const u8 * srcp,
16     u32             size,
17     u8 * dstp,
18     u8 huffBitSize,
19     void * work
20);
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>srcp</th>
36<td>Pointer to compression source data.</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th>size</th>
41<td>Compression source data size.</td>
42        </tr>
43        <tr>
44<td>out</td>
45<th>dstp</th>
46<td>Pointer to compression target data (requires a buffer larger than the compression source data).</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>huffBitSize</th>
51<td>Number of encoded bits.</td>
52        </tr>
53        <tr>
54<td>in</td>
55<th>work</th>
56<td>Temporary buffer to use for compression (requires a region of <CODE>nncx::HUFFMAN_COMPRESS_WORK_SIZE</CODE> bytes).</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<div class="section">Returns the size of the compressed data. If the compressed data is larger than the original data, compression is terminated and <CODE>0</CODE> is returned. </div>
61<h2>Description</h2>
62    <div class="section">
63<p>Carries out Huffman compression.</p><!-- write here --></div>
64<h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2010/11/10</dt>
68<dd>Initial version.<br />
69        </dd>
70      </dl>
71    </div>
72  <hr><p>CONFIDENTIAL</p></body>
73</html>