2
/*-------------------------------------------------------------*/
3
/*--- Private header file for the library. ---*/
4
/*--- bzlib_private.h ---*/
5
/*-------------------------------------------------------------*/
8
This file is a part of bzip2 and/or libbzip2, a program and
9
library for lossless, block-sorting data compression.
11
Copyright (C) 1996-2000 Julian R Seward. All rights reserved.
13
Redistribution and use in source and binary forms, with or without
14
modification, are permitted provided that the following conditions
17
1. Redistributions of source code must retain the above copyright
18
notice, this list of conditions and the following disclaimer.
20
2. The origin of this software must not be misrepresented; you must
21
not claim that you wrote the original software. If you use this
22
software in a product, an acknowledgment in the product
23
documentation would be appreciated but is not required.
25
3. Altered source versions must be plainly marked as such, and must
26
not be misrepresented as being the original software.
28
4. The name of the author may not be used to endorse or promote
29
products derived from this software without specific prior written
32
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
33
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
36
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
38
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
39
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
40
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44
Julian Seward, Cambridge, UK.
46
bzip2/libbzip2 version 1.0 of 21 March 2000
48
This program is based on (at least) the work of:
58
For more information on these sources, see the manual.
62
#ifndef _BZLIB_PRIVATE_H
63
#define _BZLIB_PRIVATE_H
77
/*-- General stuff. --*/
79
#define BZ_VERSION "1.0.1, 23-June-2000"
82
typedef unsigned char Bool;
83
typedef unsigned char UChar;
85
typedef unsigned int UInt32;
87
typedef unsigned short UInt16;
89
#define True ((Bool)1)
90
#define False ((Bool)0)
93
#define __inline__ /* */
97
extern void BZ2_bz__AssertH__fail ( int errcode );
98
#define AssertH(cond,errcode) \
99
{ if (!(cond)) BZ2_bz__AssertH__fail ( errcode ); }
101
#define AssertD(cond,msg) \
104
"\n\nlibbzip2(debug build): internal error\n\t%s\n", msg );\
108
#define AssertD(cond,msg) /* */
110
#define VPrintf0(zf) \
112
#define VPrintf1(zf,za1) \
113
fprintf(stderr,zf,za1)
114
#define VPrintf2(zf,za1,za2) \
115
fprintf(stderr,zf,za1,za2)
116
#define VPrintf3(zf,za1,za2,za3) \
117
fprintf(stderr,zf,za1,za2,za3)
118
#define VPrintf4(zf,za1,za2,za3,za4) \
119
fprintf(stderr,zf,za1,za2,za3,za4)
120
#define VPrintf5(zf,za1,za2,za3,za4,za5) \
121
fprintf(stderr,zf,za1,za2,za3,za4,za5)
123
extern void bz_internal_error ( int errcode );
124
#define AssertH(cond,errcode) \
125
{ if (!(cond)) bz_internal_error ( errcode ); }
126
#define AssertD(cond,msg) /* */
127
#define VPrintf0(zf) /* */
128
#define VPrintf1(zf,za1) /* */
129
#define VPrintf2(zf,za1,za2) /* */
130
#define VPrintf3(zf,za1,za2,za3) /* */
131
#define VPrintf4(zf,za1,za2,za3,za4) /* */
132
#define VPrintf5(zf,za1,za2,za3,za4,za5) /* */
136
#define BZALLOC(nnn) (strm->bzalloc)(strm->opaque,(nnn),1)
137
#define BZFREE(ppp) (strm->bzfree)(strm->opaque,(ppp))
140
/*-- Constants for the back end. --*/
142
#define BZ_MAX_ALPHA_SIZE 258
143
#define BZ_MAX_CODE_LEN 23
148
#define BZ_N_GROUPS 6
152
#define BZ_MAX_SELECTORS (2 + (900000 / BZ_G_SIZE))
156
/*-- Stuff for randomising repetitive blocks. --*/
158
extern Int32 BZ2_rNums[512];
160
#define BZ_RAND_DECLS \
164
#define BZ_RAND_INIT_MASK \
168
#define BZ_RAND_MASK ((s->rNToGo == 1) ? 1 : 0)
170
#define BZ_RAND_UPD_MASK \
171
if (s->rNToGo == 0) { \
172
s->rNToGo = BZ2_rNums[s->rTPos]; \
174
if (s->rTPos == 512) s->rTPos = 0; \
180
/*-- Stuff for doing CRCs. --*/
182
extern UInt32 BZ2_crc32Table[256];
184
#define BZ_INITIALISE_CRC(crcVar) \
186
crcVar = 0xffffffffL; \
189
#define BZ_FINALISE_CRC(crcVar) \
191
crcVar = ~(crcVar); \
194
#define BZ_UPDATE_CRC(crcVar,cha) \
196
crcVar = (crcVar << 8) ^ \
197
BZ2_crc32Table[(crcVar >> 24) ^ \
203
/*-- States and modes for compression. --*/
206
#define BZ_M_RUNNING 2
207
#define BZ_M_FLUSHING 3
208
#define BZ_M_FINISHING 4
210
#define BZ_S_OUTPUT 1
214
#define BZ_N_QSORT 12
215
#define BZ_N_SHELL 18
216
#define BZ_N_OVERSHOOT (BZ_N_RADIX + BZ_N_QSORT + BZ_N_SHELL + 2)
221
/*-- Structure holding all the compression-side stuff. --*/
225
/* pointer back to the struct bz_stream */
228
/* mode this stream is in, and whether inputting */
229
/* or outputting data */
233
/* remembers avail_in when flush/finish requested */
234
UInt32 avail_in_expect;
236
/* for doing the block sorting */
242
/* aliases for arr1 and arr2 */
248
/* for deciding when to use the fallback sorting algorithm */
251
/* run-length-encoding of the input */
256
/* input and output limits and current posns */
262
/* map of bytes used in block */
265
UChar unseqToSeq[256];
267
/* the buffer for bit stream creation */
271
/* block and combined CRCs */
275
/* misc administratium */
280
/* stuff for coding the MTF values */
282
Int32 mtfFreq [BZ_MAX_ALPHA_SIZE];
283
UChar selector [BZ_MAX_SELECTORS];
284
UChar selectorMtf[BZ_MAX_SELECTORS];
286
UChar len [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
287
Int32 code [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
288
Int32 rfreq [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
289
/* second dimension: only 3 needed; 4 makes index calculations faster */
290
UInt32 len_pack[BZ_MAX_ALPHA_SIZE][4];
297
/*-- externs for compression. --*/
300
BZ2_blockSort ( EState* );
303
BZ2_compressBlock ( EState*, Bool );
306
BZ2_bsInitWrite ( EState* );
309
BZ2_hbAssignCodes ( Int32*, UChar*, Int32, Int32, Int32 );
312
BZ2_hbMakeCodeLengths ( UChar*, Int32*, Int32, Int32 );
316
/*-- states for decompression. --*/
319
#define BZ_X_OUTPUT 2
321
#define BZ_X_MAGIC_1 10
322
#define BZ_X_MAGIC_2 11
323
#define BZ_X_MAGIC_3 12
324
#define BZ_X_MAGIC_4 13
325
#define BZ_X_BLKHDR_1 14
326
#define BZ_X_BLKHDR_2 15
327
#define BZ_X_BLKHDR_3 16
328
#define BZ_X_BLKHDR_4 17
329
#define BZ_X_BLKHDR_5 18
330
#define BZ_X_BLKHDR_6 19
331
#define BZ_X_BCRC_1 20
332
#define BZ_X_BCRC_2 21
333
#define BZ_X_BCRC_3 22
334
#define BZ_X_BCRC_4 23
335
#define BZ_X_RANDBIT 24
336
#define BZ_X_ORIGPTR_1 25
337
#define BZ_X_ORIGPTR_2 26
338
#define BZ_X_ORIGPTR_3 27
339
#define BZ_X_MAPPING_1 28
340
#define BZ_X_MAPPING_2 29
341
#define BZ_X_SELECTOR_1 30
342
#define BZ_X_SELECTOR_2 31
343
#define BZ_X_SELECTOR_3 32
344
#define BZ_X_CODING_1 33
345
#define BZ_X_CODING_2 34
346
#define BZ_X_CODING_3 35
347
#define BZ_X_MTF_1 36
348
#define BZ_X_MTF_2 37
349
#define BZ_X_MTF_3 38
350
#define BZ_X_MTF_4 39
351
#define BZ_X_MTF_5 40
352
#define BZ_X_MTF_6 41
353
#define BZ_X_ENDHDR_2 42
354
#define BZ_X_ENDHDR_3 43
355
#define BZ_X_ENDHDR_4 44
356
#define BZ_X_ENDHDR_5 45
357
#define BZ_X_ENDHDR_6 46
358
#define BZ_X_CCRC_1 47
359
#define BZ_X_CCRC_2 48
360
#define BZ_X_CCRC_3 49
361
#define BZ_X_CCRC_4 50
365
/*-- Constants for the fast MTF decoder. --*/
367
#define MTFA_SIZE 4096
372
/*-- Structure holding all the decompression-side stuff. --*/
376
/* pointer back to the struct bz_stream */
379
/* state indicator for this stream */
382
/* for doing the final run-length decoding */
385
Bool blockRandomised;
388
/* the buffer for bit stream reading */
392
/* misc administratium */
394
Bool smallDecompress;
398
/* for undoing the Burrows-Wheeler transform */
405
Int32 cftabCopy[257];
407
/* for undoing the Burrows-Wheeler transform (FAST) */
410
/* for undoing the Burrows-Wheeler transform (SMALL) */
414
/* stored and calculated CRCs */
415
UInt32 storedBlockCRC;
416
UInt32 storedCombinedCRC;
417
UInt32 calculatedBlockCRC;
418
UInt32 calculatedCombinedCRC;
420
/* map of bytes used in block */
424
UChar seqToUnseq[256];
426
/* for decoding the MTF values */
427
UChar mtfa [MTFA_SIZE];
428
Int32 mtfbase[256 / MTFL_SIZE];
429
UChar selector [BZ_MAX_SELECTORS];
430
UChar selectorMtf[BZ_MAX_SELECTORS];
431
UChar len [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
433
Int32 limit [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
434
Int32 base [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
435
Int32 perm [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
436
Int32 minLens[BZ_N_GROUPS];
438
/* save area for scalars in the main decompress code */
442
Int32 save_alphaSize;
444
Int32 save_nSelectors;
449
Int32 save_nblockMAX;
469
/*-- Macros for decompression. --*/
471
#define BZ_GET_FAST(cccc) \
472
s->tPos = s->tt[s->tPos]; \
473
cccc = (UChar)(s->tPos & 0xff); \
476
#define BZ_GET_FAST_C(cccc) \
477
c_tPos = c_tt[c_tPos]; \
478
cccc = (UChar)(c_tPos & 0xff); \
481
#define SET_LL4(i,n) \
482
{ if (((i) & 0x1) == 0) \
483
s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0xf0) | (n); else \
484
s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0x0f) | ((n) << 4); \
488
((((UInt32)(s->ll4[(i) >> 1])) >> (((i) << 2) & 0x4)) & 0xF)
490
#define SET_LL(i,n) \
491
{ s->ll16[i] = (UInt16)(n & 0x0000ffff); \
492
SET_LL4(i, n >> 16); \
496
(((UInt32)s->ll16[i]) | (GET_LL4(i) << 16))
498
#define BZ_GET_SMALL(cccc) \
499
cccc = BZ2_indexIntoF ( s->tPos, s->cftab ); \
500
s->tPos = GET_LL(s->tPos);
503
/*-- externs for decompression. --*/
506
BZ2_indexIntoF ( Int32, Int32* );
509
BZ2_decompress ( DState* );
512
BZ2_hbCreateDecodeTables ( Int32*, Int32*, Int32*, UChar*,
513
Int32, Int32, Int32 );
519
/*-- BZ_NO_STDIO seems to make NULL disappear on some platforms. --*/
528
/*-------------------------------------------------------------*/
529
/*--- end bzlib_private.h ---*/
530
/*-------------------------------------------------------------*/