1 /* LzmaLib.h -- LZMA library interface
\r
2 2013-01-18 : Igor Pavlov : Public domain */
\r
11 #define MY_STDAPI int MY_STD_CALL
\r
13 #define LZMA_PROPS_SIZE 5
\r
16 RAM requirements for LZMA:
\r
17 for compression: (dictSize * 11.5 + 6 MB) + state_size
\r
18 for decompression: dictSize + state_size
\r
19 state_size = (4 + (1.5 << (lc + lp))) KB
\r
20 by default (lc=3, lp=0), state_size = 16 KB.
\r
22 LZMA properties (5 bytes) format
\r
23 Offset Size Description
\r
24 0 1 lc, lp and pb in encoded form.
\r
25 1 4 dictSize (little endian).
\r
33 In: the pointer to the size of outProps buffer; *outPropsSize = LZMA_PROPS_SIZE = 5.
\r
34 Out: the pointer to the size of written properties in outProps buffer; *outPropsSize = LZMA_PROPS_SIZE = 5.
\r
36 LZMA Encoder will use defult values for any parameter, if it is
\r
37 -1 for any from: level, loc, lp, pb, fb, numThreads
\r
40 level - compression level: 0 <= level <= 9;
\r
42 level dictSize algo fb
\r
52 The default value for "level" is 5.
\r
54 algo = 0 means fast method
\r
55 algo = 1 means normal method
\r
57 dictSize - The dictionary size in bytes. The maximum value is
\r
58 128 MB = (1 << 27) bytes for 32-bit version
\r
59 1 GB = (1 << 30) bytes for 64-bit version
\r
60 The default value is 16 MB = (1 << 24) bytes.
\r
61 It's recommended to use the dictionary that is larger than 4 KB and
\r
62 that can be calculated as (1 << N) or (3 << N) sizes.
\r
64 lc - The number of literal context bits (high bits of previous literal).
\r
65 It can be in the range from 0 to 8. The default value is 3.
\r
66 Sometimes lc=4 gives the gain for big files.
\r
68 lp - The number of literal pos bits (low bits of current position for literals).
\r
69 It can be in the range from 0 to 4. The default value is 0.
\r
70 The lp switch is intended for periodical data when the period is equal to 2^lp.
\r
71 For example, for 32-bit (4 bytes) periodical data you can use lp=2. Often it's
\r
72 better to set lc=0, if you change lp switch.
\r
74 pb - The number of pos bits (low bits of current position).
\r
75 It can be in the range from 0 to 4. The default value is 2.
\r
76 The pb switch is intended for periodical data when the period is equal 2^pb.
\r
78 fb - Word size (the number of fast bytes).
\r
79 It can be in the range from 5 to 273. The default value is 32.
\r
80 Usually, a big number gives a little bit better compression ratio and
\r
81 slower compression process.
\r
83 numThreads - The number of thereads. 1 or 2. The default value is 2.
\r
84 Fast mode (algo = 0) can use only 1 thread.
\r
87 destLen - processed output size
\r
90 SZ_ERROR_MEM - Memory allocation error
\r
91 SZ_ERROR_PARAM - Incorrect paramater
\r
92 SZ_ERROR_OUTPUT_EOF - output buffer overflow
\r
93 SZ_ERROR_THREAD - errors in multithreading functions (only for Mt version)
\r
96 MY_STDAPI LzmaCompress(unsigned char *dest, size_t *destLen, const unsigned char *src, size_t srcLen,
\r
97 unsigned char *outProps, size_t *outPropsSize, /* *outPropsSize must be = 5 */
\r
98 int level, /* 0 <= level <= 9, default = 5 */
\r
99 unsigned dictSize, /* default = (1 << 24) */
\r
100 int lc, /* 0 <= lc <= 8, default = 3 */
\r
101 int lp, /* 0 <= lp <= 4, default = 0 */
\r
102 int pb, /* 0 <= pb <= 4, default = 2 */
\r
103 int fb, /* 5 <= fb <= 273, default = 32 */
\r
104 int numThreads /* 1 or 2, default = 2 */
\r
112 destLen - output data size
\r
114 srcLen - input data size
\r
116 destLen - processed output size
\r
117 srcLen - processed input size
\r
120 SZ_ERROR_DATA - Data error
\r
121 SZ_ERROR_MEM - Memory allocation arror
\r
122 SZ_ERROR_UNSUPPORTED - Unsupported properties
\r
123 SZ_ERROR_INPUT_EOF - it needs more bytes in input buffer (src)
\r
126 MY_STDAPI LzmaUncompress(unsigned char *dest, size_t *destLen, const unsigned char *src, SizeT *srcLen,
\r
127 const unsigned char *props, size_t propsSize);
\r