1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<TITLE>ntcompress</TITLE> 8<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css"> 9</HEAD> 10<BODY> 11<H1 align="left">ntcompress</H1> 12<H2>Description</H2> 13<P> <code>ntcompress</code> is a tool that creates compressed data in a format that can be handled by the CX library.</P> 14<H2>Using the Library</H2> 15<H3>Start Command</H3> 16<P><CODE>% ntcompress <-d8|d16|r|l|h4|h8|lzex> [-s] [-<t|T>[width]] [-H] [-A(4|8|16|32)] [-o outputFile] <inputFile></CODE><BR> <CODE>% ntcompress -x [-o outputFile] [-s] <inputFile><BR></CODE></P> 17<P> Compresses and converts the input file that is designated by <code>inputFile</code> into the designated format. Run-length compression, LZ77 extended compression, Huffman compression, and difference filter conversion are all possible.</P> 18<P>With the <code>-s</code> option, the message indicating successful compression will not be displayed.</P> 19<P>With the <code>-H</code> option, the data size is also appended to the data after expansion occurs. This is because header information is added to the data and compressed.<BR><BR><BR> With the <code>-A</code> option, the end of the output file is padded with zeros so that the file size is in alignment with the byte size of the <B>n</B> argument.<BR> With the <code>-o</code> option, the file name of the output file can be designated. If nothing is designated, the output file is created with the name (<em>input file name console part</em>)<code>_</code>(<em>compression method</em>)<code>.bin</code>.<BR>With the <CODE>-t</CODE> or <CODE>-T</CODE> option, the output file can be created as a C format text file. By adding options (1|2|4), you can choose between the u8, u16, and u32 types. (The default is u8.)<BR> If u16 or u32 is specified, the file is output as little-endian with the <CODE>-t</CODE> option or as big-endian with the <CODE>-T</CODE> option.<BR><BR>With the <code>-x</code> option, <CODE>ntcompress</CODE> is used and the compressed file is decompressed on the PC. 20</P> 21<H3>Formats for designation of the compression method</H3> 22<P>The following formats can be designated for the compression method: 23</P> 24<TABLE border="1"> 25 <TBODY> 26 <TR> 27<TH height="20">Options</TH> 28<TH height="20" width="101">Conversion Method</TH> 29<TH height="20" width="244">Parameters</TH> 30 </TR> 31 <TR> 32<TD><code>-d</code></TD> 33<TD width="101">Difference filter</TD> 34<TD width="244">Designates the bit size of the comparison unit <I>{ 8 | 16 </I>}.</TD> 35 </TR> 36 <TR> 37<TD><code>-r</code></TD> 38<TD width="101">Run length compression</TD> 39<TD width="244">None.</TD> 40 </TR> 41 <TR> 42<TD><code>-h</code></TD> 43<TD width="101">Huffman compression</TD> 44<TD width="244">Designates the bit size to encode <I>{ 4 | 8 }</I>.</TD> 45 </TR> 46 <TR> 47<TD><code>-lex</code></TD> 48<TD width="101">LZ77 extended compression</TD> 49<TD width="244">None.</TD> 50 </TR> 51 <TR> 52<TD><code>-l</code></TD> 53<TD width="101">LZ77 compression (for backward compatibility)</TD> 54<TD width="244">None.</TD> 55 </TR> 56 </TBODY> 57</TABLE> 58<P>Although you can expect a higher compression ratio with the LZ77 extended compression as compared to the LZ77 compression, the <code>-l</code> option is preserved for backward compatibility.<BR>Although either format can be decompressed using the same <A href="../cx/CXUncompressLZ.html"><CODE>CXUncompressLZ</CODE></A> function, note that the files compressed in the LZ77 format by the programs that use a version of the SDK prior to RVL-SDK 3.0 cannot be decompressed. <BR> 59</P> 60<H2>Location</H2> 61<P><CODE>$(REVOLUTION_SDK_ROOT)/X86/bin/ntcompress.exe</CODE></P> 62<H2>See Also</H2> 63<P><A href="../cx/CXUncompressHuffman.html"><CODE>CXUncompressHuffman</CODE></A>, <A href="../cx/CXUncompressRL.html"><CODE>CXUncompressRL</CODE></A>, <A href="../cx/CXUncompressLZ.html"><CODE>CXUncompressLZ</CODE></A>, 64 65<A href="../cx/CXReadUncompHuffman.html"><CODE>CXReacUncompHuffman</CODE></A>, <A href="../cx/CXReadUncompRL.html"><CODE>CXReadUncompRL</CODE></A>, <A href="../cx/CXReadUncompLZ.html"><CODE>CXReadUncompLZ</CODE></A></P> 66<H2>Revision History</H2> 67<P> 682007/04/28 Added LZ extended compression.<BR> 2006/11/30 Added options for alignment specifications and decompression.<BR>2006/07/06 Initial version. <BR> 69</P> 70<hr> 71<P>CONFIDENTIAL</p> 72</BODY> 73</HTML>