Blame view

lib/bzlib_private.h 14 KB
c29fdfc1d   wdenk   Patch by Yuli Bar...
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
  /*
   * This file is a modified version of bzlib_private.h from the bzip2-1.0.2
   * distribution which can be found at http://sources.redhat.com/bzip2/
   */
  
  /*-------------------------------------------------------------*/
  /*--- Private header file for the library.                  ---*/
  /*---                                       bzlib_private.h ---*/
  /*-------------------------------------------------------------*/
  
  /*--
    This file is a part of bzip2 and/or libbzip2, a program and
    library for lossless, block-sorting data compression.
  
    Copyright (C) 1996-2002 Julian R Seward.  All rights reserved.
  
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
  
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
  
    2. The origin of this software must not be misrepresented; you must
       not claim that you wrote the original software.  If you use this
       software in a product, an acknowledgment in the product
       documentation would be appreciated but is not required.
  
    3. Altered source versions must be plainly marked as such, and must
       not be misrepresented as being the original software.
  
    4. The name of the author may not be used to endorse or promote
       products derived from this software without specific prior written
       permission.
  
    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
    GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
    Julian Seward, Cambridge, UK.
    jseward@acm.org
    bzip2/libbzip2 version 1.0 of 21 March 2000
  
    This program is based on (at least) the work of:
       Mike Burrows
       David Wheeler
       Peter Fenwick
       Alistair Moffat
       Radford Neal
       Ian H. Witten
       Robert Sedgewick
       Jon L. Bentley
  
    For more information on these sources, see the manual.
  --*/
  
  
  #ifndef _BZLIB_PRIVATE_H
  #define _BZLIB_PRIVATE_H
  
  #include <malloc.h>
  
  #include "bzlib.h"
  
  #ifndef BZ_NO_STDIO
  #include <stdio.h>
  #include <ctype.h>
  #include <string.h>
  #endif
c29fdfc1d   wdenk   Patch by Yuli Bar...
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
  /*-- General stuff. --*/
  
  #define BZ_VERSION  "1.0.2, 30-Dec-2001"
  
  typedef char            Char;
  typedef unsigned char   Bool;
  typedef unsigned char   UChar;
  typedef int             Int32;
  typedef unsigned int    UInt32;
  typedef short           Int16;
  typedef unsigned short  UInt16;
  
  #define True  ((Bool)1)
  #define False ((Bool)0)
  
  #ifndef __GNUC__
  #define __inline__  /* */
  #endif
  
  #ifndef BZ_NO_STDIO
  extern void BZ2_bz__AssertH__fail ( int errcode );
  #define AssertH(cond,errcode) \
     { if (!(cond)) BZ2_bz__AssertH__fail ( errcode ); }
  #if BZ_DEBUG
  #define AssertD(cond,msg) \
     { if (!(cond)) {       \
        fprintf ( stderr,   \
42d1f0394   wdenk   * Patches by Xian...
105
106
107
108
109
  	"
  
  libbzip2(debug build): internal error
  \t%s
  ", msg );\
c29fdfc1d   wdenk   Patch by Yuli Bar...
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
        exit(1); \
     }}
  #else
  #define AssertD(cond,msg) /* */
  #endif
  #define VPrintf0(zf) \
     fprintf(stderr,zf)
  #define VPrintf1(zf,za1) \
     fprintf(stderr,zf,za1)
  #define VPrintf2(zf,za1,za2) \
     fprintf(stderr,zf,za1,za2)
  #define VPrintf3(zf,za1,za2,za3) \
     fprintf(stderr,zf,za1,za2,za3)
  #define VPrintf4(zf,za1,za2,za3,za4) \
     fprintf(stderr,zf,za1,za2,za3,za4)
  #define VPrintf5(zf,za1,za2,za3,za4,za5) \
     fprintf(stderr,zf,za1,za2,za3,za4,za5)
  #else
  extern void bz_internal_error ( int errcode );
  #define AssertH(cond,errcode) \
     { if (!(cond)) bz_internal_error ( errcode ); }
  #define AssertD(cond,msg) /* */
  #define VPrintf0(zf) /* */
  #define VPrintf1(zf,za1) /* */
  #define VPrintf2(zf,za1,za2) /* */
  #define VPrintf3(zf,za1,za2,za3) /* */
  #define VPrintf4(zf,za1,za2,za3,za4) /* */
  #define VPrintf5(zf,za1,za2,za3,za4,za5) /* */
  #endif
  
  
  #define BZALLOC(nnn) (strm->bzalloc)(strm->opaque,(nnn),1)
  #define BZFREE(ppp)  (strm->bzfree)(strm->opaque,(ppp))
  
  
  /*-- Header bytes. --*/
  
  #define BZ_HDR_B 0x42   /* 'B' */
  #define BZ_HDR_Z 0x5a   /* 'Z' */
  #define BZ_HDR_h 0x68   /* 'h' */
  #define BZ_HDR_0 0x30   /* '0' */
  
  /*-- Constants for the back end. --*/
  
  #define BZ_MAX_ALPHA_SIZE 258
  #define BZ_MAX_CODE_LEN    23
  
  #define BZ_RUNA 0
  #define BZ_RUNB 1
  
  #define BZ_N_GROUPS 6
  #define BZ_G_SIZE   50
  #define BZ_N_ITERS  4
  
  #define BZ_MAX_SELECTORS (2 + (900000 / BZ_G_SIZE))
c29fdfc1d   wdenk   Patch by Yuli Bar...
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
  /*-- Stuff for randomising repetitive blocks. --*/
  
  extern Int32 BZ2_rNums[512];
  
  #define BZ_RAND_DECLS                          \
     Int32 rNToGo;                               \
     Int32 rTPos                                 \
  
  #define BZ_RAND_INIT_MASK                      \
     s->rNToGo = 0;                              \
     s->rTPos  = 0                               \
  
  #define BZ_RAND_MASK ((s->rNToGo == 1) ? 1 : 0)
  
  #define BZ_RAND_UPD_MASK                       \
     if (s->rNToGo == 0) {                       \
        s->rNToGo = BZ2_rNums[s->rTPos];         \
        s->rTPos++;                              \
        if (s->rTPos == 512) s->rTPos = 0;       \
     }                                           \
     s->rNToGo--;
c29fdfc1d   wdenk   Patch by Yuli Bar...
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
  /*-- Stuff for doing CRCs. --*/
  
  extern UInt32 BZ2_crc32Table[256];
  
  #define BZ_INITIALISE_CRC(crcVar)              \
  {                                              \
     crcVar = 0xffffffffL;                       \
  }
  
  #define BZ_FINALISE_CRC(crcVar)                \
  {                                              \
     crcVar = ~(crcVar);                         \
  }
  
  #define BZ_UPDATE_CRC(crcVar,cha)              \
  {                                              \
     crcVar = (crcVar << 8) ^                    \
42d1f0394   wdenk   * Patches by Xian...
203
204
  	    BZ2_crc32Table[(crcVar >> 24) ^    \
  			   ((UChar)cha)];      \
c29fdfc1d   wdenk   Patch by Yuli Bar...
205
  }
c29fdfc1d   wdenk   Patch by Yuli Bar...
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  /*-- States and modes for compression. --*/
  
  #define BZ_M_IDLE      1
  #define BZ_M_RUNNING   2
  #define BZ_M_FLUSHING  3
  #define BZ_M_FINISHING 4
  
  #define BZ_S_OUTPUT    1
  #define BZ_S_INPUT     2
  
  #define BZ_N_RADIX 2
  #define BZ_N_QSORT 12
  #define BZ_N_SHELL 18
  #define BZ_N_OVERSHOOT (BZ_N_RADIX + BZ_N_QSORT + BZ_N_SHELL + 2)
c29fdfc1d   wdenk   Patch by Yuli Bar...
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
  /*-- Structure holding all the compression-side stuff. --*/
  
  typedef
     struct {
        /* pointer back to the struct bz_stream */
        bz_stream* strm;
  
        /* mode this stream is in, and whether inputting */
        /* or outputting data */
        Int32    mode;
        Int32    state;
  
        /* remembers avail_in when flush/finish requested */
        UInt32   avail_in_expect;
  
        /* for doing the block sorting */
        UInt32*  arr1;
        UInt32*  arr2;
        UInt32*  ftab;
        Int32    origPtr;
  
        /* aliases for arr1 and arr2 */
        UInt32*  ptr;
        UChar*   block;
        UInt16*  mtfv;
        UChar*   zbits;
  
        /* for deciding when to use the fallback sorting algorithm */
        Int32    workFactor;
  
        /* run-length-encoding of the input */
        UInt32   state_in_ch;
        Int32    state_in_len;
        BZ_RAND_DECLS;
  
        /* input and output limits and current posns */
        Int32    nblock;
        Int32    nblockMAX;
        Int32    numZ;
        Int32    state_out_pos;
  
        /* map of bytes used in block */
        Int32    nInUse;
        Bool     inUse[256];
        UChar    unseqToSeq[256];
  
        /* the buffer for bit stream creation */
        UInt32   bsBuff;
        Int32    bsLive;
  
        /* block and combined CRCs */
        UInt32   blockCRC;
        UInt32   combinedCRC;
  
        /* misc administratium */
        Int32    verbosity;
        Int32    blockNo;
        Int32    blockSize100k;
  
        /* stuff for coding the MTF values */
        Int32    nMTF;
        Int32    mtfFreq    [BZ_MAX_ALPHA_SIZE];
        UChar    selector   [BZ_MAX_SELECTORS];
        UChar    selectorMtf[BZ_MAX_SELECTORS];
  
        UChar    len     [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        Int32    code    [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        Int32    rfreq   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        /* second dimension: only 3 needed; 4 makes index calculations faster */
        UInt32   len_pack[BZ_MAX_ALPHA_SIZE][4];
  
     }
     EState;
c29fdfc1d   wdenk   Patch by Yuli Bar...
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
  /*-- externs for compression. --*/
  
  extern void
  BZ2_blockSort ( EState* );
  
  extern void
  BZ2_compressBlock ( EState*, Bool );
  
  extern void
  BZ2_bsInitWrite ( EState* );
  
  extern void
  BZ2_hbAssignCodes ( Int32*, UChar*, Int32, Int32, Int32 );
  
  extern void
  BZ2_hbMakeCodeLengths ( UChar*, Int32*, Int32, Int32 );
c29fdfc1d   wdenk   Patch by Yuli Bar...
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
  /*-- states for decompression. --*/
  
  #define BZ_X_IDLE        1
  #define BZ_X_OUTPUT      2
  
  #define BZ_X_MAGIC_1     10
  #define BZ_X_MAGIC_2     11
  #define BZ_X_MAGIC_3     12
  #define BZ_X_MAGIC_4     13
  #define BZ_X_BLKHDR_1    14
  #define BZ_X_BLKHDR_2    15
  #define BZ_X_BLKHDR_3    16
  #define BZ_X_BLKHDR_4    17
  #define BZ_X_BLKHDR_5    18
  #define BZ_X_BLKHDR_6    19
  #define BZ_X_BCRC_1      20
  #define BZ_X_BCRC_2      21
  #define BZ_X_BCRC_3      22
  #define BZ_X_BCRC_4      23
  #define BZ_X_RANDBIT     24
  #define BZ_X_ORIGPTR_1   25
  #define BZ_X_ORIGPTR_2   26
  #define BZ_X_ORIGPTR_3   27
  #define BZ_X_MAPPING_1   28
  #define BZ_X_MAPPING_2   29
  #define BZ_X_SELECTOR_1  30
  #define BZ_X_SELECTOR_2  31
  #define BZ_X_SELECTOR_3  32
  #define BZ_X_CODING_1    33
  #define BZ_X_CODING_2    34
  #define BZ_X_CODING_3    35
  #define BZ_X_MTF_1       36
  #define BZ_X_MTF_2       37
  #define BZ_X_MTF_3       38
  #define BZ_X_MTF_4       39
  #define BZ_X_MTF_5       40
  #define BZ_X_MTF_6       41
  #define BZ_X_ENDHDR_2    42
  #define BZ_X_ENDHDR_3    43
  #define BZ_X_ENDHDR_4    44
  #define BZ_X_ENDHDR_5    45
  #define BZ_X_ENDHDR_6    46
  #define BZ_X_CCRC_1      47
  #define BZ_X_CCRC_2      48
  #define BZ_X_CCRC_3      49
  #define BZ_X_CCRC_4      50
c29fdfc1d   wdenk   Patch by Yuli Bar...
355
356
357
358
  /*-- Constants for the fast MTF decoder. --*/
  
  #define MTFA_SIZE 4096
  #define MTFL_SIZE 16
c29fdfc1d   wdenk   Patch by Yuli Bar...
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
  /*-- Structure holding all the decompression-side stuff. --*/
  
  typedef
     struct {
        /* pointer back to the struct bz_stream */
        bz_stream* strm;
  
        /* state indicator for this stream */
        Int32    state;
  
        /* for doing the final run-length decoding */
        UChar    state_out_ch;
        Int32    state_out_len;
        Bool     blockRandomised;
        BZ_RAND_DECLS;
  
        /* the buffer for bit stream reading */
        UInt32   bsBuff;
        Int32    bsLive;
  
        /* misc administratium */
        Int32    blockSize100k;
        Bool     smallDecompress;
        Int32    currBlockNo;
        Int32    verbosity;
  
        /* for undoing the Burrows-Wheeler transform */
        Int32    origPtr;
        UInt32   tPos;
        Int32    k0;
        Int32    unzftab[256];
        Int32    nblock_used;
        Int32    cftab[257];
        Int32    cftabCopy[257];
  
        /* for undoing the Burrows-Wheeler transform (FAST) */
        UInt32   *tt;
  
        /* for undoing the Burrows-Wheeler transform (SMALL) */
        UInt16   *ll16;
        UChar    *ll4;
  
        /* stored and calculated CRCs */
        UInt32   storedBlockCRC;
        UInt32   storedCombinedCRC;
        UInt32   calculatedBlockCRC;
        UInt32   calculatedCombinedCRC;
  
        /* map of bytes used in block */
        Int32    nInUse;
        Bool     inUse[256];
        Bool     inUse16[16];
        UChar    seqToUnseq[256];
  
        /* for decoding the MTF values */
        UChar    mtfa   [MTFA_SIZE];
        Int32    mtfbase[256 / MTFL_SIZE];
        UChar    selector   [BZ_MAX_SELECTORS];
        UChar    selectorMtf[BZ_MAX_SELECTORS];
        UChar    len  [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
  
        Int32    limit  [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        Int32    base   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        Int32    perm   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
        Int32    minLens[BZ_N_GROUPS];
  
        /* save area for scalars in the main decompress code */
        Int32    save_i;
        Int32    save_j;
        Int32    save_t;
        Int32    save_alphaSize;
        Int32    save_nGroups;
        Int32    save_nSelectors;
        Int32    save_EOB;
        Int32    save_groupNo;
        Int32    save_groupPos;
        Int32    save_nextSym;
        Int32    save_nblockMAX;
        Int32    save_nblock;
        Int32    save_es;
        Int32    save_N;
        Int32    save_curr;
        Int32    save_zt;
        Int32    save_zn;
        Int32    save_zvec;
        Int32    save_zj;
        Int32    save_gSel;
        Int32    save_gMinlen;
        Int32*   save_gLimit;
        Int32*   save_gBase;
        Int32*   save_gPerm;
  
     }
     DState;
c29fdfc1d   wdenk   Patch by Yuli Bar...
453
454
455
456
457
458
459
460
461
462
463
464
465
466
  /*-- Macros for decompression. --*/
  
  #define BZ_GET_FAST(cccc)                     \
      s->tPos = s->tt[s->tPos];                 \
      cccc = (UChar)(s->tPos & 0xff);           \
      s->tPos >>= 8;
  
  #define BZ_GET_FAST_C(cccc)                   \
      c_tPos = c_tt[c_tPos];                    \
      cccc = (UChar)(c_tPos & 0xff);            \
      c_tPos >>= 8;
  
  #define SET_LL4(i,n)                                          \
     { if (((i) & 0x1) == 0)                                    \
42d1f0394   wdenk   * Patches by Xian...
467
468
  	s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0xf0) | (n); else    \
  	s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0x0f) | ((n) << 4);  \
c29fdfc1d   wdenk   Patch by Yuli Bar...
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
     }
  
  #define GET_LL4(i)                             \
     ((((UInt32)(s->ll4[(i) >> 1])) >> (((i) << 2) & 0x4)) & 0xF)
  
  #define SET_LL(i,n)                          \
     { s->ll16[i] = (UInt16)(n & 0x0000ffff);  \
       SET_LL4(i, n >> 16);                    \
     }
  
  #define GET_LL(i) \
     (((UInt32)s->ll16[i]) | (GET_LL4(i) << 16))
  
  #define BZ_GET_SMALL(cccc)                            \
        cccc = BZ2_indexIntoF ( s->tPos, s->cftab );    \
        s->tPos = GET_LL(s->tPos);
  
  
  /*-- externs for decompression. --*/
  
  extern Int32
  BZ2_indexIntoF ( Int32, Int32* );
  
  extern Int32
  BZ2_decompress ( DState* );
  
  extern void
  BZ2_hbCreateDecodeTables ( Int32*, Int32*, Int32*, UChar*,
42d1f0394   wdenk   * Patches by Xian...
497
  			   Int32,  Int32, Int32 );
c29fdfc1d   wdenk   Patch by Yuli Bar...
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
  
  
  #endif
  
  
  /*-- BZ_NO_STDIO seems to make NULL disappear on some platforms. --*/
  
  #ifdef BZ_NO_STDIO
  #ifndef NULL
  #define NULL 0
  #endif
  #endif
  
  
  /*-------------------------------------------------------------*/
  /*--- end                                   bzlib_private.h ---*/
  /*-------------------------------------------------------------*/