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 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::cx</title> 49 </head> 50 <body> 51<h1><CODE><a href="../../nn/Overview.html">nn</a>::cx</CODE> Namespace</h1> 52<h2>Description</h2> 53 <div class="section"> 54<p>Namespace for the file compression and decompression library.</p><!-- write here --></div> 55 <a name="struct" id="struct"> 56<h2>Structures</h2> 57 <div class="section"> 58 <table class="members"> 59 <tr> 60 <th> 61<a href="../../nn/cx/UncompContextRL/Overview.html"><CODE>nn::cx::UncompContextRL</CODE></a> 62 </th> 63<td>The context for decompressing run-length compressed data.</td> 64 </tr> 65 <tr> 66 <th> 67<a href="../../nn/cx/UncompContextLZ/Overview.html"><CODE>nn::cx::UncompContextLZ</CODE></a> 68 </th> 69<td>The context for decompressing LZ77 compressed data.</td> 70 </tr> 71 <tr> 72 <th> 73<a href="../../nn/cx/UncompContextHuffman/Overview.html"><CODE>nn::cx::UncompContextHuffman</CODE></a> 74 </th> 75<td>The context for decompressing Huffman compressed data.</td> 76 </tr> 77 <tr> 78 <th> 79<a href="../../nn/cx/UncompContextLH/Overview.html"><CODE>nn::cx::UncompContextLH</CODE></a> 80 </th> 81<td>The context for decompressing LZ-Huffman compressed data.</td> 82 </tr> 83 <tr> 84 <th> 85<a href="../../nn/cx/UncompContextLRC/Overview.html"><CODE>nn::cx::UncompContextLRC</CODE></a> 86 </th> 87<td>The context for decompressing LZ-Range Coder compressed data.</td> 88 </tr> </table> 89 </div> 90 </a> <a name="enum" id="enum"> 91<h2>Enumerated Types</h2> 92 <div class="section"> 93 <table class="members"> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<a href="../../nn/cx/ErrorCode.html"><CODE>ErrorCode</CODE></a> 98 </th> 99<td>Enumerated type representing the error codes.</td> 100 </tr> 101 <tr> 102 <td width="100"> </td> 103 <th> 104<a href="../../nn/cx/CompressionType.html"><CODE>CompressionType</CODE></a> 105 </th> 106<td>Enumerated type representing compression types.</td> 107 </tr> </table> 108 </div> 109 </a> <a name="constant" id="constant"> 110<h2>Constants</h2> 111 <div class="section"> 112 <table class="members"> 113 <tr> 114<th class="category" colspan="4">Compression</th> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119<span class="argument"><a href="../../nn/cx/HUFFMAN_COMPRESS_WORK_SIZE.html"><CODE>HUFFMAN_COMPRESS_WORK_SIZE</CODE></a></span> 120 </th> 121<td width="100">const int</td> 122<td>This is the size of the temporary buffer for compression with <CODE><a href="../../nn/cx/CompressHuffman.html">nn::cx::CompressHuffman</a></CODE>.</td> 123 </tr> 124 <tr> 125<th class="category" colspan="4">Uncompression</th> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130<span class="argument"><a href="../../nn/cx/UNCOMPRESS_LH_WORK_SIZE.html"><CODE>UNCOMPRESS_LH_WORK_SIZE</CODE></a></span> 131 </th> 132<td width="100">const int</td> 133<td>This is the size of the temporary buffer for uncompression with <CODE><a href="../../nn/cx/UncompressLH.html">nn::cx::UncompressLH</a></CODE>.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138<span class="argument"><a href="../../nn/cx/UNCOMPRESS_LRC_WORK_SIZE.html"><CODE>UNCOMPRESS_LRC_WORK_SIZE</CODE></a></span> 139 </th> 140<td width="100">const int</td> 141<td>This is the size of the temporary buffer for uncompression with <CODE><a href="../../nn/cx/UncompressLRC.html">nn::cx::UncompressLRC</a></CODE>.</td> 142 </tr> 143 <tr> 144<th class="category" colspan="4">Other</th> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149<span class="argument"><a href="../../nn/cx/LZ_COMPRESS_WORK_SIZE.html"><CODE>LZ_COMPRESS_WORK_SIZE</CODE></a></span> 150 </th> 151<td width="100">const int</td> 152<td>This is the size of the temporary buffer for compression with <CODE><a href="../../nn/cx/CompressLZ.html">nn::cx::CompressLZ</a></CODE>.</td> 153 </tr> </table> 154 </div> 155 </a> <a name="function" id="function"> 156<h2>Functions</h2> 157 <div class="section"> 158 <table class="members"> 159 <tr> 160<th class="category" colspan="3">Compression</th> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165<a href="../../nn/cx/CompressLZ.html"><CODE>CompressLZ</CODE></a> 166 </th> 167<td>Carries out LZ77 compression.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172<a href="../../nn/cx/CompressRL.html"><CODE>CompressRL</CODE></a> 173 </th> 174<td>Carries out run-length compression.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179<a href="../../nn/cx/CompressHuffman.html"><CODE>CompressHuffman</CODE></a> 180 </th> 181<td>Carries out Huffman compression.</td> 182 </tr> 183 <tr> 184<th class="category" colspan="3">Decompression</th> 185 </tr> 186 <tr> 187 <td width="100"> </td> 188 <th> 189<a href="../../nn/cx/GetCompressionHeader.html"><CODE>GetCompressionHeader</CODE></a> 190 </th> 191<td>Gets header information from the first four bytes in the compressed data.</td> 192 </tr> 193 <tr> 194 <td width="100"> </td> 195 <th> 196<a href="../../nn/cx/GetCompressionType.html"><CODE>GetCompressionType</CODE></a> 197 </th> 198<td>Gets the compression type from the first byte in the compressed data.</td> 199 </tr> 200 <tr> 201 <td width="100"> </td> 202 <th> 203<a href="../../nn/cx/GetUncompressedSize.html"><CODE>GetUncompressedSize</CODE></a> 204 </th> 205<td>Gets the data size after decompression.</td> 206 </tr> 207 <tr> 208 <td width="100"> </td> 209 <th> 210<a href="../../nn/cx/UncompressAny.html"><CODE>UncompressAny</CODE></a> 211 </th> 212<td>Detects the compression format from the data header and executes the appropriate decompression process.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<a href="../../nn/cx/UncompressRL.html"><CODE>UncompressRL</CODE></a> 218 </th> 219<td>Decompresses run-length compressed data.</td> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224<a href="../../nn/cx/UncompressLZ.html"><CODE>UncompressLZ</CODE></a> 225 </th> 226<td>Decompresses LZ77 compressed data.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<a href="../../nn/cx/UncompressBLZ.html">UncompressBLZ</a> 232 </th> 233<td>Decompresses LZ backward compressed (BLZ) data.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238<a href="../../nn/cx/UncompressHuffman.html"><CODE>UncompressHuffman</CODE></a> 239 </th> 240<td>Decompresses Huffman compressed data.</td> 241 </tr> 242 <tr> 243 <td width="100"> </td> 244 <th> 245<a href="../../nn/cx/UncompressLH.html"><CODE>UncompressLH</CODE></a> 246 </th> 247<td>Decompresses LZ-Huffman compressed data.</td> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252<a href="../../nn/cx/UncompressLRC.html"><CODE>UncompressLRC</CODE></a> 253 </th> 254<td>Decompresses LZ-Range Coder compressed data.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259<a href="../../nn/cx/UnfilterDiff.html"><CODE>UnfilterDiff</CODE></a> 260 </th> 261<td>Restores data converted using a difference filter.</td> 262 </tr> 263 <tr> 264<th class="category" colspan="3">Decompress with error checking</th> 265 </tr> 266 <tr> 267 <td width="100"> </td> 268 <th> 269<a href="../../nn/cx/SecureUncompressAny.html"><CODE>SecureUncompressAny</CODE></a> 270 </th> 271<td>Detects the compression format from the data header and executes the appropriate decompression process while checking for errors.</td> 272 </tr> 273 <tr> 274 <td width="100"> </td> 275 <th> 276<a href="../../nn/cx/SecureUncompressRL.html"><CODE>SecureUncompressRL</CODE></a> 277 </th> 278<td>Decompresses run-length compressed data while checking for errors.</td> 279 </tr> 280 <tr> 281 <td width="100"> </td> 282 <th> 283<a href="../../nn/cx/SecureUncompressLZ.html"><CODE>SecureUncompressLZ</CODE></a> 284 </th> 285<td>Decompresses LZ77 compressed data while checking for errors.</td> 286 </tr> 287 <tr> 288 <td width="100"> </td> 289 <th> 290<a href="../../nn/cx/SecureUncompressHuffman.html"><CODE>SecureUncompressHuffman</CODE></a> 291 </th> 292<td>Decompresses Huffman compressed data while checking for errors.</td> 293 </tr> 294 <tr> 295 <td width="100"> </td> 296 <th> 297<a href="../../nn/cx/SecureUncompressLH.html"><CODE>SecureUncompressLH</CODE></a> 298 </th> 299<td>Decompresses LZ-Huffman compressed data.</td> 300 </tr> 301 <tr> 302 <td width="100"> </td> 303 <th> 304<a href="../../nn/cx/SecureUncompressLRC.html"><CODE>SecureUncompressLRC</CODE></a> 305 </th> 306<td>Decompresses LZ-Range Coder compressed data.</td> 307 </tr> 308 <tr> 309 <td width="100"> </td> 310 <th> 311<a href="../../nn/cx/SecureUnfilterDiff.html"><CODE>SecureUnfilterDiff</CODE></a> 312 </th> 313<td>Restores data converted using a difference filter.</td> 314 </tr> 315 <tr> 316<th class="category" colspan="3">Streaming decompression</th> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<a href="../../nn/cx/InitUncompContextRL.html"><CODE>InitUncompContextRL</CODE></a> 322 </th> 323<td>Initializes the streaming decompression context for run-length compressed data.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328<a href="../../nn/cx/InitUncompContextLZ.html"><CODE>InitUncompContextLZ</CODE></a> 329 </th> 330<td>Initializes the streaming decompression context for LZ77 compressed data.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335<a href="../../nn/cx/InitUncompContextHuffman.html"><CODE>InitUncompContextHuffman</CODE></a> 336 </th> 337<td>Initializes the streaming decompression context for Huffman compressed data.</td> 338 </tr> 339 <tr> 340 <td width="100"> </td> 341 <th> 342<a href="../../nn/cx/InitUncompContextLH.html"><CODE>InitUncompContextLH</CODE></a> 343 </th> 344<td>Initializes the streaming decompression context for LZ-Huffman compressed data.</td> 345 </tr> 346 <tr> 347 <td width="100"> </td> 348 <th> 349<a href="../../nn/cx/InitUncompContextLRC.html"><CODE>InitUncompContextLRC</CODE></a> 350 </th> 351<td>Initializes the streaming decompression context for LZ-Range Coder compressed data.</td> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356<a href="../../nn/cx/ReadUncompRL.html"><CODE>ReadUncompRL</CODE></a> 357 </th> 358<td>Streaming decompression of run-length compressed data.</td> 359 </tr> 360 <tr> 361 <td width="100"> </td> 362 <th> 363<a href="../../nn/cx/ReadUncompLZ.html"><CODE>ReadUncompLZ</CODE></a> 364 </th> 365<td>Streaming decompression of LZ77 compressed data.</td> 366 </tr> 367 <tr> 368 <td width="100"> </td> 369 <th> 370<a href="../../nn/cx/ReadUncompHuffman.html"><CODE>ReadUncompHuffman</CODE></a> 371 </th> 372<td>Streaming decompression of Huffman compressed data.</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377<a href="../../nn/cx/ReadUncompLH.html"><CODE>ReadUncompLH</CODE></a> 378 </th> 379<td>Streaming decompression of LZ-Huffman compressed data.</td> 380 </tr> 381 <tr> 382 <td width="100"> </td> 383 <th> 384<a href="../../nn/cx/ReadUncompLRC.html"><CODE>ReadUncompLRC</CODE></a> 385 </th> 386<td>Streaming decompression of LZ-Range Coder compressed data.</td> 387 </tr> 388 <tr> 389 <td width="100"> </td> 390 <th> 391<a href="../../nn/cx/IsFinishedUncomp.html"><CODE>IsFinishedUncomp</CODE></a> 392 </th> 393<td>Determines whether the streaming decompression of compressed data is finished.</td> 394 </tr> 395 <tr> 396 <td width="100"> </td> 397 <th> 398<a href="../../nn/cx/InitUncompContextRLFront.html"><CODE>InitUncompContextRLFront</CODE></a> 399 </th> 400<td>Initializes the streaming decompression context for run-length compressed data to the specified decompressed size.</td> 401 </tr> 402 <tr> 403 <td width="100"> </td> 404 <th> 405<a href="../../nn/cx/InitUncompContextLZFront.html"><CODE>InitUncompContextLZFront</CODE></a> 406 </th> 407<td>Initializes the streaming decompression context for LZ77 compressed data to the specified decompressed size.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412<a href="../../nn/cx/InitUncompContextHuffmanFront.html"><CODE>InitUncompContextHuffmanFront</CODE></a> 413 </th> 414<td>Initializes the streaming decompression context for Huffman compressed data to the specified size.</td> 415 </tr> 416 <tr> 417 <td width="100"> </td> 418 <th> 419<a href="../../nn/cx/InitUncompContextLHFront.html"><CODE>InitUncompContextLHFront</CODE></a> 420 </th> 421<td>Initializes the streaming decompression context for LZ-Huffman compressed data to the specified decompressed size.</td> 422 </tr> 423 <tr> 424 <td width="100"> </td> 425 <th> 426<a href="../../nn/cx/InitUncompContextLRCFront.html"><CODE>InitUncompContextLRCFront</CODE></a> 427 </th> 428<td>Initializes the streaming decompression context for LZ-Range Coder compressed data to the specified decompressed size.</td> 429 </tr> </table> 430 </div> 431 </a> 432<h2>Revision History</h2> 433 <div class="section"> 434 <dl class="history"> 435 <dt>2010/11/10</dt> 436<dd>Initial version.<br /> 437 </dd> 438 </dl> 439 </div> 440 <hr><p>CONFIDENTIAL</p></body> 441</html> 442