LHA

From Just Solve the File Format Problem
(Difference between revisions)
Jump to: navigation, search
(→‎Format details)
Line 31: Line 31:
  
 
=== Compression schemes ===
 
=== Compression schemes ===
−
Each member file has a 5-byte ''compression method'' field, composed of ASCII characters. The first and last characters are virtually always dashes ("<code>-</code>"), and might be left off when discussing LHA compression methods. Known compression schemes:
+
Each member file has a 5-byte ''compression method'' field, composed of ASCII characters. The first and last characters are virtually always dashes ("<code>-</code>"), and might be left off when discussing LHA compression schemes. Known schemes:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 92: Line 92:
 
|<code>-lZ5-</code>
 
|<code>-lZ5-</code>
 
|-
 
|-
−
|<code>-pc1-</code> ||rowspan="5"| PMarc extensions ||rowspan="5"| Refer to [[PMA]].
+
|<code>-pc1-</code> ||rowspan="4"| PMarc extensions ||rowspan="4"| Refer to [[PMA]]. Another PMarc signature is <code>-pms-</code>, but it does not seem to be used as a compression ID.
 
|-
 
|-
 
|<code>-pm0-</code>
 
|<code>-pm0-</code>
Line 99: Line 99:
 
|-
 
|-
 
|<code>-pm2-</code>
 
|<code>-pm2-</code>
−
|-
 
−
|<code>-pms-</code>
 
 
|-
 
|-
 
|<code>-ah0-</code> ||rowspan="3"| MAR extensions ||rowspan="3"| Refer to [[Micrognosis Compression Archiver]].
 
|<code>-ah0-</code> ||rowspan="3"| MAR extensions ||rowspan="3"| Refer to [[Micrognosis Compression Archiver]].
Line 122: Line 120:
  
 
== Identification ==
 
== Identification ==
−
Bytes {{magic|'-' 'l' ?? ?? '-'}} appear at offset 2. This is not a global file signature, but represents the compression scheme of the first member file of the archive.
+
LHA can be identified with high accuracy, but doing so can be laborious, due to the lack of a signature, and other complicating factors.
  
−
If you consider [[PMA]] to be a form of LHA, then the second of these bytes can also be <code>'p'</code>.
+
Identification logic could be based on the header of the first member file. Check that the compression method (offset 2–6) and header level (offset 20) fields have valid values. When suitable and possible, validate the header checksum field -- this depends on the header level.
  
−
The byte at offset 20 (the header level) has value 0x00 through 0x03. If it is 0x00 or 0x01, the header checksum (the byte at offset 1) can also help identify the format.
+
See also the "[[#See also]]" section, for some formats that could masquerade as LHA.
  
 
== See also ==
 
== See also ==
Line 178: Line 176:
 
** See [http://www.svgalib.org/rus/lbrate.html lbrate] → lzhuf-post.txt for a discussion of the terms of use.
 
** See [http://www.svgalib.org/rus/lbrate.html lbrate] → lzhuf-post.txt for a discussion of the terms of use.
 
* {{CdTextfiles|sourcecode/msdos/arc_lbr/ar002.zip|ar version "002" by Haruhiko Okumura}} (1990) (DOS binary + source code) - Implementation of "lh5" compression
 
* {{CdTextfiles|sourcecode/msdos/arc_lbr/ar002.zip|ar version "002" by Haruhiko Okumura}} (1990) (DOS binary + source code) - Implementation of "lh5" compression
−
* {{Deark}} (might be useful for analysis; doesn't decompress the format)
+
* [https://github.com/temisu/ancient Ancient] - Has modern C++ code for decompressing most LHA schemes, but as of this writing there's no easy way to use it.
 +
* {{Deark}} (might be useful for analysis; doesn't necessarily decompress the format)
  
 
== Sample files ==
 
== Sample files ==

Revision as of 18:24, 18 September 2020

File Format
Name LHA
Ontology
Extension(s) .lha, .lzh, .lzs
MIME Type(s) application/x-lzh-compressed
PRONOM fmt/626
Wikidata ID Q368782
Kaitai Struct Spec lzh.ksy
Released 1988

LHA is an archiving program and file format created by Haruyasu Yoshizaki (a.k.a. Yoshi) in 1988. It was originally called LHarc, then was briefly LH before settling on LHA. In the 1990s, it was the most popular archiving format on the Amiga platform. It also got some use on the PC platform including in the installers for id Software games such as Doom and Quake, because ZIP compression was inferior until the release of PKZIP 2.0, which brought the formats to parity.

It was particularly popular in Japan. Most of the best information about it is in Japanese.

It supports a number of different compression schemes, most of which use LZ77 combined with Huffman coding.

The file format is also known as LZH. See the LZH disambiguation page for other "LZH" formats.

This article covers the format used by LHarc/LHA, as well as "generalized" LHA format: the same file format, but with other compression schemes. The generalized format was possibly designed by Kazuhiko Miki in 1988 for the LArc software, but confirmation of this is needed. If so, it was soon borrowed by LHarc, with new compression schemes.

Contents

 [hide] 

Format details

File structure

An LHA file consists mainly of a sequence of elements, each representing a member file or directory. The sequence is usually terminated by an end-of-archive marker consisting of a single 0x00 byte (but take care, as level 2 headers could start with 0x00). There is no global archive-level header.

Member format

There are at least four different formats that an element can have. (Note that this is independent of compression schemes.) In LHA jargon, the formats are known as "header levels", and are usually called "header level 0", "... 1", "... 2", and "... 3". The header level is determined by the byte at offset 20 from the beginning of that element.

The header levels are similar, but irritatingly different. They don't even follow the same principles with respect to how they must be parsed.

LZH compression overview

From a decompression perspective, the LZ77+Huffman schemes work roughly as follows. (This is oversimplified.) There is a codes Huffman tree, and a separate offsets tree. A symbol is read using the codes tree which, depending on its value, represents either a literal byte value, or a length. If it is a length, then an additional symbol is read using the offsets tree. Based on the offset and length, a run of recently-decompressed bytes is repeated.

Compression schemes

Each member file has a 5-byte compression method field, composed of ASCII characters. The first and last characters are virtually always dashes ("-"), and might be left off when discussing LHA compression schemes. Known schemes:

ID Category Description and remarks
-lh0- Uncompressed
-lh1- LZ77+Huffman, 4k window, adaptive Huffman for codes, offsets use a pre-defined Huffman tree.
-lh2- LZ77+Huffman, 8k window, adaptive Huffman. Considered obsolete.
-lh3- LZ77+Huffman, 8k window, segmented, static Huffman for codes, offsets can use static Huffman or a pre-defined Huffman tree. Considered obsolete.
-lh4- Like lh5, but 4k window
-lh5- LZ77+Huffman, 8k window, segmented, static Huffman
-lh6- Like lh5, but 32k window
-lh7- Like lh5, but 64k window
-lh7- LHARK extension Refer to LHARK.
-lh8- Joe Jared extensions Like lh5, but 64k window. (Same as lh7.)
-lh9- Like lh5, but 128k window. Probably never used.
-lha- Like lh5, but 256k window. Probably never used.
-lhb- Like lh5, but 512k window. Probably never used.
-lhc- Like lh5, but 1M window. Probably never used.
-lhd- Special Not a compression scheme. Indicates that the element represents a subdirectory.
-lhe- Joe Jared extensions Like lh5, but 2M window. Probably never used.
-lhx- UNLHA32 extensions
-lx1-
-lz2- LArc methods
-lz3-
-lz4- Uncompressed
-lz5- LZ77/LZSS, 4k window. Almost identical to "SZDD" used in MS-DOS installation compression.
-lz7-
-lz8-
-lzs- LZ77/LZSS, 2k window
-lZ0- PUT/GET variants Refer to PUT.
-lZ1-
-lZ5-
-pc1- PMarc extensions Refer to PMA. Another PMarc signature is -pms-, but it does not seem to be used as a compression ID.
-pm0-
-pm1-
-pm2-
-ah0- MAR extensions Refer to Micrognosis Compression Archiver.
-ari-
-hf0-

The Wikipedia article has more information about some of the schemes.

Extended headers

For header levels 1 and higher, each member file has an associated list of "extended headers", similar to ZIP's extensible data fields. Each extended header is tagged with a single byte indicating its type. Extended headers are used to store platform-specific metadata, and to extend the format in other ways.

Header level 0 supports extended data in a more limited way. It allows for just one set of extended header fields (called the "extended area"), the content of which is determined by the initial one-byte "OS type" field.

Identification

LHA can be identified with high accuracy, but doing so can be laborious, due to the lack of a signature, and other complicating factors.

Identification logic could be based on the header of the first member file. Check that the compression method (offset 2–6) and header level (offset 20) fields have valid values. When suitable and possible, validate the header checksum field -- this depends on the header level.

See also the "#See also" section, for some formats that could masquerade as LHA.

See also

Other LHA-like formats to be aware of:

Format documentation

Software

Sample files

Other links

Retrieved from "http://fileformats.archiveteam.org/index.php?title=LHA&oldid=37989"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox