aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/lzmasdk/LzmaDec.h
blob: 4d922f23dc9d6a7de6aafbe27d3d9111ec259f3d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/* LzmaDec.h -- LZMA Decoder 
2018-04-21 : Igor Pavlov : Public domain */
 
#ifndef __LZMA_DEC_H 
#define __LZMA_DEC_H 
 
#include "7zTypes.h" 
 
EXTERN_C_BEGIN 
 
/* #define _LZMA_PROB32 */ 
/* _LZMA_PROB32 can increase the speed on some CPUs, 
   but memory usage for CLzmaDec::probs will be doubled in that case */ 
 
typedef
#ifdef _LZMA_PROB32 
  UInt32
#else 
  UInt16
#endif 
  CLzmaProb;
 
 
/* ---------- LZMA Properties ---------- */ 
 
#define LZMA_PROPS_SIZE 5 
 
typedef struct _CLzmaProps 
{ 
  Byte lc;
  Byte lp;
  Byte pb;
  Byte _pad_;
  UInt32 dicSize; 
} CLzmaProps; 
 
/* LzmaProps_Decode - decodes properties 
Returns: 
  SZ_OK 
  SZ_ERROR_UNSUPPORTED - Unsupported properties 
*/ 
 
SRes LzmaProps_Decode(CLzmaProps *p, const Byte *data, unsigned size); 
 
 
/* ---------- LZMA Decoder state ---------- */ 
 
/* LZMA_REQUIRED_INPUT_MAX = number of required input bytes for worst case. 
   Num bits = log2((2^11 / 31) ^ 22) + 26 < 134 + 26 = 160; */ 
 
#define LZMA_REQUIRED_INPUT_MAX 20 
 
typedef struct 
{ 
  /* Don't change this structure. ASM code can use it. */
  CLzmaProps prop; 
  CLzmaProb *probs; 
  CLzmaProb *probs_1664;
  Byte *dic; 
  SizeT dicBufSize;
  SizeT dicPos;
  const Byte *buf; 
  UInt32 range;
  UInt32 code;
  UInt32 processedPos; 
  UInt32 checkDicSize; 
  UInt32 reps[4]; 
  UInt32 state;
  UInt32 remainLen;

  UInt32 numProbs; 
  unsigned tempBufSize; 
  Byte tempBuf[LZMA_REQUIRED_INPUT_MAX]; 
} CLzmaDec; 
 
#define LzmaDec_Construct(p) { (p)->dic = NULL; (p)->probs = NULL; }
 
void LzmaDec_Init(CLzmaDec *p); 
 
/* There are two types of LZMA streams: 
     - Stream with end mark. That end mark adds about 6 bytes to compressed size.
     - Stream without end mark. You must know exact uncompressed size to decompress such stream. */
 
typedef enum 
{ 
  LZMA_FINISH_ANY,   /* finish at any point */ 
  LZMA_FINISH_END    /* block must be finished at the end */ 
} ELzmaFinishMode; 
 
/* ELzmaFinishMode has meaning only if the decoding reaches output limit !!! 
 
   You must use LZMA_FINISH_END, when you know that current output buffer 
   covers last bytes of block. In other cases you must use LZMA_FINISH_ANY. 
 
   If LZMA decoder sees end marker before reaching output limit, it returns SZ_OK, 
   and output value of destLen will be less than output buffer size limit. 
   You can check status result also. 
 
   You can use multiple checks to test data integrity after full decompression: 
     1) Check Result and "status" variable. 
     2) Check that output(destLen) = uncompressedSize, if you know real uncompressedSize. 
     3) Check that output(srcLen) = compressedSize, if you know real compressedSize. 
        You must use correct finish mode in that case. */ 
 
typedef enum 
{ 
  LZMA_STATUS_NOT_SPECIFIED,               /* use main error code instead */ 
  LZMA_STATUS_FINISHED_WITH_MARK,          /* stream was finished with end mark. */ 
  LZMA_STATUS_NOT_FINISHED,                /* stream was not finished */ 
  LZMA_STATUS_NEEDS_MORE_INPUT,            /* you must provide more input bytes */ 
  LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK  /* there is probability that stream was finished without end mark */ 
} ELzmaStatus; 
 
/* ELzmaStatus is used only as output value for function call */ 
 
 
/* ---------- Interfaces ---------- */ 
 
/* There are 3 levels of interfaces: 
     1) Dictionary Interface 
     2) Buffer Interface 
     3) One Call Interface 
   You can select any of these interfaces, but don't mix functions from different 
   groups for same object. */ 
 
 
/* There are two variants to allocate state for Dictionary Interface: 
     1) LzmaDec_Allocate / LzmaDec_Free 
     2) LzmaDec_AllocateProbs / LzmaDec_FreeProbs 
   You can use variant 2, if you set dictionary buffer manually. 
   For Buffer Interface you must always use variant 1. 
 
LzmaDec_Allocate* can return: 
  SZ_OK 
  SZ_ERROR_MEM         - Memory allocation error 
  SZ_ERROR_UNSUPPORTED - Unsupported properties 
*/ 
    
SRes LzmaDec_AllocateProbs(CLzmaDec *p, const Byte *props, unsigned propsSize, ISzAllocPtr alloc); 
void LzmaDec_FreeProbs(CLzmaDec *p, ISzAllocPtr alloc); 
 
SRes LzmaDec_Allocate(CLzmaDec *p, const Byte *props, unsigned propsSize, ISzAllocPtr alloc);
void LzmaDec_Free(CLzmaDec *p, ISzAllocPtr alloc);
 
/* ---------- Dictionary Interface ---------- */ 
 
/* You can use it, if you want to eliminate the overhead for data copying from 
   dictionary to some other external buffer. 
   You must work with CLzmaDec variables directly in this interface. 
 
   STEPS: 
     LzmaDec_Construct()
     LzmaDec_Allocate() 
     for (each new stream) 
     { 
       LzmaDec_Init() 
       while (it needs more decompression) 
       { 
         LzmaDec_DecodeToDic() 
         use data from CLzmaDec::dic and update CLzmaDec::dicPos 
       } 
     } 
     LzmaDec_Free() 
*/ 
 
/* LzmaDec_DecodeToDic 
    
   The decoding to internal dictionary buffer (CLzmaDec::dic). 
   You must manually update CLzmaDec::dicPos, if it reaches CLzmaDec::dicBufSize !!! 
 
finishMode: 
  It has meaning only if the decoding reaches output limit (dicLimit). 
  LZMA_FINISH_ANY - Decode just dicLimit bytes. 
  LZMA_FINISH_END - Stream must be finished after dicLimit. 
 
Returns: 
  SZ_OK 
    status: 
      LZMA_STATUS_FINISHED_WITH_MARK 
      LZMA_STATUS_NOT_FINISHED 
      LZMA_STATUS_NEEDS_MORE_INPUT 
      LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK 
  SZ_ERROR_DATA - Data error 
*/ 
 
SRes LzmaDec_DecodeToDic(CLzmaDec *p, SizeT dicLimit, 
    const Byte *src, SizeT *srcLen, ELzmaFinishMode finishMode, ELzmaStatus *status); 
 
 
/* ---------- Buffer Interface ---------- */ 
 
/* It's zlib-like interface. 
   See LzmaDec_DecodeToDic description for information about STEPS and return results, 
   but you must use LzmaDec_DecodeToBuf instead of LzmaDec_DecodeToDic and you don't need 
   to work with CLzmaDec variables manually. 
 
finishMode: 
  It has meaning only if the decoding reaches output limit (*destLen). 
  LZMA_FINISH_ANY - Decode just destLen bytes. 
  LZMA_FINISH_END - Stream must be finished after (*destLen). 
*/ 
 
SRes LzmaDec_DecodeToBuf(CLzmaDec *p, Byte *dest, SizeT *destLen, 
    const Byte *src, SizeT *srcLen, ELzmaFinishMode finishMode, ELzmaStatus *status); 
 
 
/* ---------- One Call Interface ---------- */ 
 
/* LzmaDecode 
 
finishMode: 
  It has meaning only if the decoding reaches output limit (*destLen). 
  LZMA_FINISH_ANY - Decode just destLen bytes. 
  LZMA_FINISH_END - Stream must be finished after (*destLen). 
 
Returns: 
  SZ_OK 
    status: 
      LZMA_STATUS_FINISHED_WITH_MARK 
      LZMA_STATUS_NOT_FINISHED 
      LZMA_STATUS_MAYBE_FINISHED_WITHOUT_MARK 
  SZ_ERROR_DATA - Data error 
  SZ_ERROR_MEM  - Memory allocation error 
  SZ_ERROR_UNSUPPORTED - Unsupported properties 
  SZ_ERROR_INPUT_EOF - It needs more bytes in input buffer (src). 
*/ 
 
SRes LzmaDecode(Byte *dest, SizeT *destLen, const Byte *src, SizeT *srcLen, 
    const Byte *propData, unsigned propSize, ELzmaFinishMode finishMode, 
    ELzmaStatus *status, ISzAllocPtr alloc); 
 
EXTERN_C_END 
 
#endif