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<STYLE type="text/css">
10<!--
11.sample_source{
12  background-color : #e8e8e8;
13}
14H3{
15  color : teal;
16}
17.command_list{
18  margin-bottom : 16pt;
19}
20.command_desc{
21  }
22.command_item{
23  margin-top : 16pt;
24  background-color : #e8e8e8;
25}
26.blockquoted_table {
27  border : 1px;
28  width : 80%;
29}
30TD,TH{
31  border-color  : #c0d8d8;
32  padding       : 1pt 4pt 1pt 4pt;
33  border-width  : 1px;
34  border-style  : solid;
35}
36-->
37</STYLE>
38</HEAD>
39<BODY>
40<H1 align="left">ntcompress</H1>
41<H2>Description</H2>
42<P>  <code>ntcompress</code> is a tool that creates compressed data in a format that can be handled by the CX library.</P>
43<H2>Using the Library</H2>
44<H3>Start Command</H3>
45<P><CODE>% ntcompress &lt;-d8|d16|r|l|h4|h8&gt; [-s] [-&lt;t|T&gt;[width]] [-H] [-A4] [-o outputFile] &lt;inputFile&gt;<BR></CODE></P>
46<P>  Compresses and converts the input file that is designated by <code>inputFile</code> into the designated format. Run-length compression, LZ77 compression, Huffman compression, and difference filter conversion are all possible.</P>
47<P>With the <code>-s</code> option, the message indicating successful compression will not be displayed.</P>
48<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>-A4</code> option, the size of the output file will be padded with zeros so that it is a multiple of four.<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 or -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> The output is little-endian with -t and big-endian with -T for u16 and u32.
49</P>
50<H3>The formats for the designation of the compression method</H3>
51<P>The following formats can be designated for the compression method:
52</P>
53<TABLE border="1">
54  <TBODY>
55    <TR>
56<TH height="20">Options</TH>
57<TH height="20" width="101">Conversion Method</TH>
58<TH height="20" width="244">Parameters</TH>
59    </TR>
60    <TR>
61<TD><code>-d</code></TD>
62<TD width="101">Difference filter</TD>
63<TD width="244">Designates the bit size of the comparison unit  <I>{ 8 | 16 </I>}</TD>
64    </TR>
65    <TR>
66<TD><code>-r</code></TD>
67<TD width="101">Run length compression</TD>
68<TD width="244">None.</TD>
69    </TR>
70    <TR>
71<TD><code>-h</code></TD>
72<TD width="101">Huffman compression</TD>
73<TD width="244">Designates the bit size to encode  <I>{ 4 | 8 }</I></TD>
74    </TR>
75    <TR>
76<TD><code>-l</code></TD>
77<TD width="101">LZ77 compression</TD>
78<TD width="244">None.</TD>
79    </TR>
80  </TBODY>
81</TABLE>
82<H2>Location</H2>
83<P><CODE>$(REVOLUTION_SDK_ROOT)/X86/bin/ntcompress.exe</CODE></P>
84<H2>See Also</H2>
85<P><CODE><A href="../cx/CXUncompressHuffman.html">CXUncompressHuffman</A>, <A href="../cx/CXUncompressRL.html">CXUncompressRL</A>, <A href="../cx/CXUncompressLZ.html">CXUncompressLZ</A>, <A href="../cx/CXReadUncompHuffman.html">CXReacUncompHuffman</A>, <A href="../cx/CXReadUncompRL.html">CXReadUncompRL</A>, <A href="../cx/CXReadUncompLZ.html">CXReadUncompLZ</A></CODE></P>
86<H2>Revision History</H2>
87<P>07/06/2006 Initial version.</P><BR>
88<hr>
89<P>CONFIDENTIAL</p>
90</BODY>
91</HTML>