1 /* LzmaDec.h -- LZMA Decoder
\r
2 2020-03-19 : Igor Pavlov : Public domain */
\r
11 /* #define _LZMA_PROB32 */
\r
12 /* _LZMA_PROB32 can increase the speed on some CPUs,
\r
13 but memory usage for CLzmaDec::probs will be doubled in that case */
\r
24 /* ---------- LZMA Properties ---------- */
\r
26 #define LZMA_PROPS_SIZE 5
\r
28 typedef struct _CLzmaProps
\r
37 /* LzmaProps_Decode - decodes properties
\r
40 SZ_ERROR_UNSUPPORTED - Unsupported properties
\r
43 SRes LzmaProps_Decode(CLzmaProps *p, const Byte *data, unsigned size);
\r
46 /* ---------- LZMA Decoder state ---------- */
\r
48 /* LZMA_REQUIRED_INPUT_MAX = number of required input bytes for worst case.
\r
49 Num bits = log2((2^11 / 31) ^ 22) + 26 < 134 + 26 = 160; */
\r
51 #define LZMA_REQUIRED_INPUT_MAX 20
\r
55 /* Don't change this structure. ASM code can use it. */
\r
58 CLzmaProb *probs_1664;
\r
65 UInt32 processedPos;
\r
66 UInt32 checkDicSize;
\r
72 unsigned tempBufSize;
\r
73 Byte tempBuf[LZMA_REQUIRED_INPUT_MAX];
\r
76 #define LzmaDec_Construct(p) { (p)->dic = NULL; (p)->probs = NULL; }
\r
78 void LzmaDec_Init(CLzmaDec *p);
\r
80 /* There are two types of LZMA streams:
\r
81 - Stream with end mark. That end mark adds about 6 bytes to compressed size.
\r
82 - Stream without end mark. You must know exact uncompressed size to decompress such stream. */
\r
86 LZMA_FINISH_ANY, /* finish at any point */
\r
87 LZMA_FINISH_END /* block must be finished at the end */
\r
90 /* ELzmaFinishMode has meaning only if the decoding reaches output limit !!!
\r
92 You must use LZMA_FINISH_END, when you know that current output buffer
\r
93 covers last bytes of block. In other cases you must use LZMA_FINISH_ANY.
\r
95 If LZMA decoder sees end marker before reaching output limit, it returns SZ_OK,
\r
96 and output value of destLen will be less than output buffer size limit.
\r
97 You can check status result also.
\r
99 You can use multiple checks to test data integrity after full decompression:
\r
100 1) Check Result and "status" variable.
\r
101 2) Check that output(destLen) = uncompressedSize, if you know real uncompressedSize.
\r
102 3) Check that output(srcLen) = compressedSize, if you know real compressedSize.
\r
103 You must use correct finish mode in that case. */
\r
107 LZMA_STATUS_NOT_SPECIFIED, /* use main error code instead */
\r
108 LZMA_STATUS_FINISHED_WITH_MARK, /* stream was finished with end mark. */
\r
109 LZMA_STATUS_NOT_FINISHED, /* stream was not finished */
\r
110 LZMA_STATUS_NEEDS_MORE_INPUT, /* you must provide more input bytes */
\r
111 LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK /* there is probability that stream was finished without end mark */
\r
114 /* ELzmaStatus is used only as output value for function call */
\r
117 /* ---------- Interfaces ---------- */
\r
119 /* There are 3 levels of interfaces:
\r
120 1) Dictionary Interface
\r
121 2) Buffer Interface
\r
122 3) One Call Interface
\r
123 You can select any of these interfaces, but don't mix functions from different
\r
124 groups for same object. */
\r
127 /* There are two variants to allocate state for Dictionary Interface:
\r
128 1) LzmaDec_Allocate / LzmaDec_Free
\r
129 2) LzmaDec_AllocateProbs / LzmaDec_FreeProbs
\r
130 You can use variant 2, if you set dictionary buffer manually.
\r
131 For Buffer Interface you must always use variant 1.
\r
133 LzmaDec_Allocate* can return:
\r
135 SZ_ERROR_MEM - Memory allocation error
\r
136 SZ_ERROR_UNSUPPORTED - Unsupported properties
\r
139 SRes LzmaDec_AllocateProbs(CLzmaDec *p, const Byte *props, unsigned propsSize, ISzAllocPtr alloc);
\r
140 void LzmaDec_FreeProbs(CLzmaDec *p, ISzAllocPtr alloc);
\r
142 SRes LzmaDec_Allocate(CLzmaDec *p, const Byte *props, unsigned propsSize, ISzAllocPtr alloc);
\r
143 void LzmaDec_Free(CLzmaDec *p, ISzAllocPtr alloc);
\r
145 /* ---------- Dictionary Interface ---------- */
\r
147 /* You can use it, if you want to eliminate the overhead for data copying from
\r
148 dictionary to some other external buffer.
\r
149 You must work with CLzmaDec variables directly in this interface.
\r
152 LzmaDec_Construct()
\r
154 for (each new stream)
\r
157 while (it needs more decompression)
\r
159 LzmaDec_DecodeToDic()
\r
160 use data from CLzmaDec::dic and update CLzmaDec::dicPos
\r
166 /* LzmaDec_DecodeToDic
\r
168 The decoding to internal dictionary buffer (CLzmaDec::dic).
\r
169 You must manually update CLzmaDec::dicPos, if it reaches CLzmaDec::dicBufSize !!!
\r
172 It has meaning only if the decoding reaches output limit (dicLimit).
\r
173 LZMA_FINISH_ANY - Decode just dicLimit bytes.
\r
174 LZMA_FINISH_END - Stream must be finished after dicLimit.
\r
179 LZMA_STATUS_FINISHED_WITH_MARK
\r
180 LZMA_STATUS_NOT_FINISHED
\r
181 LZMA_STATUS_NEEDS_MORE_INPUT
\r
182 LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK
\r
183 SZ_ERROR_DATA - Data error
\r
184 SZ_ERROR_FAIL - Some unexpected error: internal error of code, memory corruption or hardware failure
\r
187 SRes LzmaDec_DecodeToDic(CLzmaDec *p, SizeT dicLimit,
\r
188 const Byte *src, SizeT *srcLen, ELzmaFinishMode finishMode, ELzmaStatus *status);
\r
191 /* ---------- Buffer Interface ---------- */
\r
193 /* It's zlib-like interface.
\r
194 See LzmaDec_DecodeToDic description for information about STEPS and return results,
\r
195 but you must use LzmaDec_DecodeToBuf instead of LzmaDec_DecodeToDic and you don't need
\r
196 to work with CLzmaDec variables manually.
\r
199 It has meaning only if the decoding reaches output limit (*destLen).
\r
200 LZMA_FINISH_ANY - Decode just destLen bytes.
\r
201 LZMA_FINISH_END - Stream must be finished after (*destLen).
\r
204 SRes LzmaDec_DecodeToBuf(CLzmaDec *p, Byte *dest, SizeT *destLen,
\r
205 const Byte *src, SizeT *srcLen, ELzmaFinishMode finishMode, ELzmaStatus *status);
\r
208 /* ---------- One Call Interface ---------- */
\r
213 It has meaning only if the decoding reaches output limit (*destLen).
\r
214 LZMA_FINISH_ANY - Decode just destLen bytes.
\r
215 LZMA_FINISH_END - Stream must be finished after (*destLen).
\r
220 LZMA_STATUS_FINISHED_WITH_MARK
\r
221 LZMA_STATUS_NOT_FINISHED
\r
222 LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK
\r
223 SZ_ERROR_DATA - Data error
\r
224 SZ_ERROR_MEM - Memory allocation error
\r
225 SZ_ERROR_UNSUPPORTED - Unsupported properties
\r
226 SZ_ERROR_INPUT_EOF - It needs more bytes in input buffer (src).
\r
227 SZ_ERROR_FAIL - Some unexpected error: internal error of code, memory corruption or hardware failure
\r
230 SRes LzmaDecode(Byte *dest, SizeT *destLen, const Byte *src, SizeT *srcLen,
\r
231 const Byte *propData, unsigned propSize, ELzmaFinishMode finishMode,
\r
232 ELzmaStatus *status, ISzAllocPtr alloc);
\r