# ntrcomp

## Description

`ntrcomp` is a tool that creates compressed data in a format that can be handled by the `NITRO-SDK MI_Uncompress*()` command.

## How to Use

### Start Command

`% ntrcomp <-d|r|l|h [option]> [-s] [-t[width]] [-H] [-A4] [-o outputFile] <inputFile>
`

Compresses and converts the input file that is designated by `inputFile` into a designated format. Run-length compression, LZ77 compression, Huffman compression, and difference filter conversion are all possible.

With the `-s` option, the message indicating successful compression will not be displayed.

With the `-H` 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.
With the `-A4` option, the size of the output file will be aligned with final zeros so that it is a multiple of four.
With the `-o` option, the file name of the output file can be designated. If nothing is designated, the output file is created with the name (input file name console part)`_`(compression method)`.bin.`
With the `-t` option, the output file can be output as a C format text file. By adding options (1|2|4), you can choose between types u8, u16, and u32. (The default is u8.)

### The formats for the designation of the compression method

The following formats can be designated for the compression method:

Option | Conversion Method | Parameter
--- | --- | ---
`-d` | Difference filter | Designates the bit size of the comparison unit { 8 | 16 }
`-r` | Run length compression | None.
`-h` | Huffman compression | Designates the bit size to encode { 4 | 8 }
`-l` | LZ77 compression | Designates the search position of the corresponding character strings {2 or greater}

## Location

`$NitroSDK/tools/bin/ntrcomp.exe`

## See Also

`MI_UncompressHuffman, MI_UncompressRL*, MI_UncompressLZ*`

## Revision History

03/03/2005 Added descriptions for new options.
08/20/2004 Initial version