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>nn::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="3">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>This is the size of the temporary buffer for compression with <CODE><a href="../../nn/cx/CompressHuffman.html">nn::cx::CompressHuffman</a></CODE>.</td> 122 </tr> 123 <tr> 124<th class="category" colspan="3">Uncompression</th> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<span class="argument"><a href="../../nn/cx/UNCOMPRESS_LH_WORK_SIZE.html"><CODE>UNCOMPRESS_LH_WORK_SIZE</CODE></a></span> 130 </th> 131<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> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136<span class="argument"><a href="../../nn/cx/UNCOMPRESS_LRC_WORK_SIZE.html"><CODE>UNCOMPRESS_LRC_WORK_SIZE</CODE></a></span> 137 </th> 138<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> 139 </tr> 140 <tr> 141<th class="category" colspan="3">Other</th> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146<span class="argument"><a href="../../nn/cx/LZ_COMPRESS_WORK_SIZE.html"><CODE>LZ_COMPRESS_WORK_SIZE</CODE></a></span> 147 </th> 148<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> 149 </tr> </table> 150 </div> 151 </a> <a name="function" id="function"> 152<h2>Functions</h2> 153 <div class="section"> 154 <table class="members"> 155 <tr> 156<th class="category" colspan="3">Compression</th> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161<a href="../../nn/cx/CompressLZ.html"><CODE>CompressLZ</CODE></a> 162 </th> 163<td>Carries out LZ77 compression.</td> 164 </tr> 165 <tr> 166 <td width="100"> </td> 167 <th> 168<a href="../../nn/cx/CompressRL.html"><CODE>CompressRL</CODE></a> 169 </th> 170<td>Carries out run-length compression.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<a href="../../nn/cx/CompressHuffman.html"><CODE>CompressHuffman</CODE></a> 176 </th> 177<td>Carries out Huffman compression.</td> 178 </tr> 179 <tr> 180<th class="category" colspan="3">Decompression</th> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185<a href="../../nn/cx/GetCompressionHeader.html"><CODE>GetCompressionHeader</CODE></a> 186 </th> 187<td>Gets header information from the first four bytes in the compressed data.</td> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192<a href="../../nn/cx/GetCompressionType.html"><CODE>GetCompressionType</CODE></a> 193 </th> 194<td>Gets the compression type from the first byte in the compressed data.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199<a href="../../nn/cx/GetUncompressedSize.html"><CODE>GetUncompressedSize</CODE></a> 200 </th> 201<td>Gets the data size after decompression.</td> 202 </tr> 203 <tr> 204 <td width="100"> </td> 205 <th> 206<a href="../../nn/cx/UncompressAny.html"><CODE>UncompressAny</CODE></a> 207 </th> 208<td>Detects the compression format from the data header and executes the appropriate decompression process.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213<a href="../../nn/cx/UncompressRL.html"><CODE>UncompressRL</CODE></a> 214 </th> 215<td>Decompresses run-length compressed data.</td> 216 </tr> 217 <tr> 218 <td width="100"> </td> 219 <th> 220<a href="../../nn/cx/UncompressLZ.html"><CODE>UncompressLZ</CODE></a> 221 </th> 222<td>Decompresses LZ77 compressed data.</td> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227<a href="../../nn/cx/UncompressHuffman.html"><CODE>UncompressHuffman</CODE></a> 228 </th> 229<td>Decompresses Huffman compressed data.</td> 230 </tr> 231 <tr> 232 <td width="100"> </td> 233 <th> 234<a href="../../nn/cx/UncompressLH.html"><CODE>UncompressLH</CODE></a> 235 </th> 236<td>Decompresses LZ-Huffman compressed data.</td> 237 </tr> 238 <tr> 239 <td width="100"> </td> 240 <th> 241<a href="../../nn/cx/UncompressLRC.html"><CODE>UncompressLRC</CODE></a> 242 </th> 243<td>Decompresses LZ-Range Coder compressed data.</td> 244 </tr> 245 <tr> 246 <td width="100"> </td> 247 <th> 248<a href="../../nn/cx/UnfilterDiff.html"><CODE>UnfilterDiff</CODE></a> 249 </th> 250<td>Restores data converted using a difference filter.</td> 251 </tr> 252 <tr> 253<th class="category" colspan="3">Decompress with error checking</th> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258<a href="../../nn/cx/SecureUncompressAny.html"><CODE>SecureUncompressAny</CODE></a> 259 </th> 260<td>Detects the compression format from the data header and executes the appropriate decompression process while checking for errors.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<a href="../../nn/cx/SecureUncompressRL.html"><CODE>SecureUncompressRL</CODE></a> 266 </th> 267<td>Decompresses run-length compressed data while checking for errors.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272<a href="../../nn/cx/SecureUncompressLZ.html"><CODE>SecureUncompressLZ</CODE></a> 273 </th> 274<td>Decompresses LZ77 compressed data while checking for errors.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<a href="../../nn/cx/SecureUncompressHuffman.html"><CODE>SecureUncompressHuffman</CODE></a> 280 </th> 281<td>Decompresses Huffman compressed data while checking for errors.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286<a href="../../nn/cx/SecureUncompressLH.html"><CODE>SecureUncompressLH</CODE></a> 287 </th> 288<td>Decompresses LZ-Huffman compressed data.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<a href="../../nn/cx/SecureUncompressLRC.html"><CODE>SecureUncompressLRC</CODE></a> 294 </th> 295<td>Decompresses LZ-Range Coder compressed data.</td> 296 </tr> 297 <tr> 298 <td width="100"> </td> 299 <th> 300<a href="../../nn/cx/SecureUnfilterDiff.html"><CODE>SecureUnfilterDiff</CODE></a> 301 </th> 302<td>Restores data converted using a difference filter.</td> 303 </tr> 304 <tr> 305<th class="category" colspan="3">Streaming decompression</th> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310<a href="../../nn/cx/InitUncompContextRL.html"><CODE>InitUncompContextRL</CODE></a> 311 </th> 312<td>Initializes the streaming decompression context for run-length compressed data.</td> 313 </tr> 314 <tr> 315 <td width="100"> </td> 316 <th> 317<a href="../../nn/cx/InitUncompContextLZ.html"><CODE>InitUncompContextLZ</CODE></a> 318 </th> 319<td>Initializes the streaming decompression context for LZ77 compressed data.</td> 320 </tr> 321 <tr> 322 <td width="100"> </td> 323 <th> 324<a href="../../nn/cx/InitUncompContextHuffman.html"><CODE>InitUncompContextHuffman</CODE></a> 325 </th> 326<td>Initializes the streaming decompression context for Huffman compressed data.</td> 327 </tr> 328 <tr> 329 <td width="100"> </td> 330 <th> 331<a href="../../nn/cx/InitUncompContextLH.html"><CODE>InitUncompContextLH</CODE></a> 332 </th> 333<td>Initializes the streaming decompression context for LZ-Huffman compressed data.</td> 334 </tr> 335 <tr> 336 <td width="100"> </td> 337 <th> 338<a href="../../nn/cx/InitUncompContextLRC.html"><CODE>InitUncompContextLRC</CODE></a> 339 </th> 340<td>Initializes the streaming decompression context for LZ-Range Coder compressed data.</td> 341 </tr> 342 <tr> 343 <td width="100"> </td> 344 <th> 345<a href="../../nn/cx/ReadUncompRL.html"><CODE>ReadUncompRL</CODE></a> 346 </th> 347<td>Streaming decompression of run-length compressed data.</td> 348 </tr> 349 <tr> 350 <td width="100"> </td> 351 <th> 352<a href="../../nn/cx/ReadUncompLZ.html"><CODE>ReadUncompLZ</CODE></a> 353 </th> 354<td>Streaming decompression of LZ77 compressed data.</td> 355 </tr> 356 <tr> 357 <td width="100"> </td> 358 <th> 359<a href="../../nn/cx/ReadUncompHuffman.html"><CODE>ReadUncompHuffman</CODE></a> 360 </th> 361<td>Streaming decompression of Huffman compressed data.</td> 362 </tr> 363 <tr> 364 <td width="100"> </td> 365 <th> 366<a href="../../nn/cx/ReadUncompLH.html"><CODE>ReadUncompLH</CODE></a> 367 </th> 368<td>Streaming decompression of LZ-Huffman compressed data.</td> 369 </tr> 370 <tr> 371 <td width="100"> </td> 372 <th> 373<a href="../../nn/cx/ReadUncompLRC.html"><CODE>ReadUncompLRC</CODE></a> 374 </th> 375<td>Streaming decompression of LZ-Range Coder compressed data.</td> 376 </tr> 377 <tr> 378 <td width="100"> </td> 379 <th> 380<a href="../../nn/cx/IsFinishedUncomp.html"><CODE>IsFinishedUncomp</CODE></a> 381 </th> 382<td>Determines whether the streaming decompression of compressed data is finished.</td> 383 </tr> 384 <tr> 385 <td width="100"> </td> 386 <th> 387<a href="../../nn/cx/InitUncompContextRLFront.html"><CODE>InitUncompContextRLFront</CODE></a> 388 </th> 389<td>Initializes the streaming decompression context for run-length compressed data to the specified decompressed size.</td> 390 </tr> 391 <tr> 392 <td width="100"> </td> 393 <th> 394<a href="../../nn/cx/InitUncompContextLZFront.html"><CODE>InitUncompContextLZFront</CODE></a> 395 </th> 396<td>Initializes the streaming decompression context for LZ77 compressed data to the specified decompressed size.</td> 397 </tr> 398 <tr> 399 <td width="100"> </td> 400 <th> 401<a href="../../nn/cx/InitUncompContextHuffmanFront.html"><CODE>InitUncompContextHuffmanFront</CODE></a> 402 </th> 403<td>Initializes the streaming decompression context for Huffman compressed data to the specified size.</td> 404 </tr> 405 <tr> 406 <td width="100"> </td> 407 <th> 408<a href="../../nn/cx/InitUncompContextLHFront.html"><CODE>InitUncompContextLHFront</CODE></a> 409 </th> 410<td>Initializes the streaming decompression context for LZ-Huffman compressed data to the specified decompressed size.</td> 411 </tr> 412 <tr> 413 <td width="100"> </td> 414 <th> 415<a href="../../nn/cx/InitUncompContextLRCFront.html"><CODE>InitUncompContextLRCFront</CODE></a> 416 </th> 417<td>Initializes the streaming decompression context for LZ-Range Coder compressed data to the specified decompressed size.</td> 418 </tr> </table> 419 </div> 420 </a> 421<h2>Revision History</h2> 422 <div class="section"> 423 <dl class="history"> 424 <dt>2010/11/10</dt> 425<dd>Initial version.<br /> 426 </dd> 427 </dl> 428 </div> 429 <hr><p>CONFIDENTIAL</p></body> 430</html> 431