cannam@89: 
cannam@89: /*-------------------------------------------------------------*/
cannam@89: /*--- Private header file for the library.                  ---*/
cannam@89: /*---                                       bzlib_private.h ---*/
cannam@89: /*-------------------------------------------------------------*/
cannam@89: 
cannam@89: /* ------------------------------------------------------------------
cannam@89:    This file is part of bzip2/libbzip2, a program and library for
cannam@89:    lossless, block-sorting data compression.
cannam@89: 
cannam@89:    bzip2/libbzip2 version 1.0.6 of 6 September 2010
cannam@89:    Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
cannam@89: 
cannam@89:    Please read the WARNING, DISCLAIMER and PATENTS sections in the 
cannam@89:    README file.
cannam@89: 
cannam@89:    This program is released under the terms of the license contained
cannam@89:    in the file LICENSE.
cannam@89:    ------------------------------------------------------------------ */
cannam@89: 
cannam@89: 
cannam@89: #ifndef _BZLIB_PRIVATE_H
cannam@89: #define _BZLIB_PRIVATE_H
cannam@89: 
cannam@89: #include <stdlib.h>
cannam@89: 
cannam@89: #ifndef BZ_NO_STDIO
cannam@89: #include <stdio.h>
cannam@89: #include <ctype.h>
cannam@89: #include <string.h>
cannam@89: #endif
cannam@89: 
cannam@89: #include "bzlib.h"
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- General stuff. --*/
cannam@89: 
cannam@89: #define BZ_VERSION  "1.0.6, 6-Sept-2010"
cannam@89: 
cannam@89: typedef char            Char;
cannam@89: typedef unsigned char   Bool;
cannam@89: typedef unsigned char   UChar;
cannam@89: typedef int             Int32;
cannam@89: typedef unsigned int    UInt32;
cannam@89: typedef short           Int16;
cannam@89: typedef unsigned short  UInt16;
cannam@89: 
cannam@89: #define True  ((Bool)1)
cannam@89: #define False ((Bool)0)
cannam@89: 
cannam@89: #ifndef __GNUC__
cannam@89: #define __inline__  /* */
cannam@89: #endif 
cannam@89: 
cannam@89: #ifndef BZ_NO_STDIO
cannam@89: 
cannam@89: extern void BZ2_bz__AssertH__fail ( int errcode );
cannam@89: #define AssertH(cond,errcode) \
cannam@89:    { if (!(cond)) BZ2_bz__AssertH__fail ( errcode ); }
cannam@89: 
cannam@89: #if BZ_DEBUG
cannam@89: #define AssertD(cond,msg) \
cannam@89:    { if (!(cond)) {       \
cannam@89:       fprintf ( stderr,   \
cannam@89:         "\n\nlibbzip2(debug build): internal error\n\t%s\n", msg );\
cannam@89:       exit(1); \
cannam@89:    }}
cannam@89: #else
cannam@89: #define AssertD(cond,msg) /* */
cannam@89: #endif
cannam@89: 
cannam@89: #define VPrintf0(zf) \
cannam@89:    fprintf(stderr,zf)
cannam@89: #define VPrintf1(zf,za1) \
cannam@89:    fprintf(stderr,zf,za1)
cannam@89: #define VPrintf2(zf,za1,za2) \
cannam@89:    fprintf(stderr,zf,za1,za2)
cannam@89: #define VPrintf3(zf,za1,za2,za3) \
cannam@89:    fprintf(stderr,zf,za1,za2,za3)
cannam@89: #define VPrintf4(zf,za1,za2,za3,za4) \
cannam@89:    fprintf(stderr,zf,za1,za2,za3,za4)
cannam@89: #define VPrintf5(zf,za1,za2,za3,za4,za5) \
cannam@89:    fprintf(stderr,zf,za1,za2,za3,za4,za5)
cannam@89: 
cannam@89: #else
cannam@89: 
cannam@89: extern void bz_internal_error ( int errcode );
cannam@89: #define AssertH(cond,errcode) \
cannam@89:    { if (!(cond)) bz_internal_error ( errcode ); }
cannam@89: #define AssertD(cond,msg)                do { } while (0)
cannam@89: #define VPrintf0(zf)                     do { } while (0)
cannam@89: #define VPrintf1(zf,za1)                 do { } while (0)
cannam@89: #define VPrintf2(zf,za1,za2)             do { } while (0)
cannam@89: #define VPrintf3(zf,za1,za2,za3)         do { } while (0)
cannam@89: #define VPrintf4(zf,za1,za2,za3,za4)     do { } while (0)
cannam@89: #define VPrintf5(zf,za1,za2,za3,za4,za5) do { } while (0)
cannam@89: 
cannam@89: #endif
cannam@89: 
cannam@89: 
cannam@89: #define BZALLOC(nnn) (strm->bzalloc)(strm->opaque,(nnn),1)
cannam@89: #define BZFREE(ppp)  (strm->bzfree)(strm->opaque,(ppp))
cannam@89: 
cannam@89: 
cannam@89: /*-- Header bytes. --*/
cannam@89: 
cannam@89: #define BZ_HDR_B 0x42   /* 'B' */
cannam@89: #define BZ_HDR_Z 0x5a   /* 'Z' */
cannam@89: #define BZ_HDR_h 0x68   /* 'h' */
cannam@89: #define BZ_HDR_0 0x30   /* '0' */
cannam@89:   
cannam@89: /*-- Constants for the back end. --*/
cannam@89: 
cannam@89: #define BZ_MAX_ALPHA_SIZE 258
cannam@89: #define BZ_MAX_CODE_LEN    23
cannam@89: 
cannam@89: #define BZ_RUNA 0
cannam@89: #define BZ_RUNB 1
cannam@89: 
cannam@89: #define BZ_N_GROUPS 6
cannam@89: #define BZ_G_SIZE   50
cannam@89: #define BZ_N_ITERS  4
cannam@89: 
cannam@89: #define BZ_MAX_SELECTORS (2 + (900000 / BZ_G_SIZE))
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Stuff for randomising repetitive blocks. --*/
cannam@89: 
cannam@89: extern Int32 BZ2_rNums[512];
cannam@89: 
cannam@89: #define BZ_RAND_DECLS                          \
cannam@89:    Int32 rNToGo;                               \
cannam@89:    Int32 rTPos                                 \
cannam@89: 
cannam@89: #define BZ_RAND_INIT_MASK                      \
cannam@89:    s->rNToGo = 0;                              \
cannam@89:    s->rTPos  = 0                               \
cannam@89: 
cannam@89: #define BZ_RAND_MASK ((s->rNToGo == 1) ? 1 : 0)
cannam@89: 
cannam@89: #define BZ_RAND_UPD_MASK                       \
cannam@89:    if (s->rNToGo == 0) {                       \
cannam@89:       s->rNToGo = BZ2_rNums[s->rTPos];         \
cannam@89:       s->rTPos++;                              \
cannam@89:       if (s->rTPos == 512) s->rTPos = 0;       \
cannam@89:    }                                           \
cannam@89:    s->rNToGo--;
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Stuff for doing CRCs. --*/
cannam@89: 
cannam@89: extern UInt32 BZ2_crc32Table[256];
cannam@89: 
cannam@89: #define BZ_INITIALISE_CRC(crcVar)              \
cannam@89: {                                              \
cannam@89:    crcVar = 0xffffffffL;                       \
cannam@89: }
cannam@89: 
cannam@89: #define BZ_FINALISE_CRC(crcVar)                \
cannam@89: {                                              \
cannam@89:    crcVar = ~(crcVar);                         \
cannam@89: }
cannam@89: 
cannam@89: #define BZ_UPDATE_CRC(crcVar,cha)              \
cannam@89: {                                              \
cannam@89:    crcVar = (crcVar << 8) ^                    \
cannam@89:             BZ2_crc32Table[(crcVar >> 24) ^    \
cannam@89:                            ((UChar)cha)];      \
cannam@89: }
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- States and modes for compression. --*/
cannam@89: 
cannam@89: #define BZ_M_IDLE      1
cannam@89: #define BZ_M_RUNNING   2
cannam@89: #define BZ_M_FLUSHING  3
cannam@89: #define BZ_M_FINISHING 4
cannam@89: 
cannam@89: #define BZ_S_OUTPUT    1
cannam@89: #define BZ_S_INPUT     2
cannam@89: 
cannam@89: #define BZ_N_RADIX 2
cannam@89: #define BZ_N_QSORT 12
cannam@89: #define BZ_N_SHELL 18
cannam@89: #define BZ_N_OVERSHOOT (BZ_N_RADIX + BZ_N_QSORT + BZ_N_SHELL + 2)
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Structure holding all the compression-side stuff. --*/
cannam@89: 
cannam@89: typedef
cannam@89:    struct {
cannam@89:       /* pointer back to the struct bz_stream */
cannam@89:       bz_stream* strm;
cannam@89: 
cannam@89:       /* mode this stream is in, and whether inputting */
cannam@89:       /* or outputting data */
cannam@89:       Int32    mode;
cannam@89:       Int32    state;
cannam@89: 
cannam@89:       /* remembers avail_in when flush/finish requested */
cannam@89:       UInt32   avail_in_expect;
cannam@89: 
cannam@89:       /* for doing the block sorting */
cannam@89:       UInt32*  arr1;
cannam@89:       UInt32*  arr2;
cannam@89:       UInt32*  ftab;
cannam@89:       Int32    origPtr;
cannam@89: 
cannam@89:       /* aliases for arr1 and arr2 */
cannam@89:       UInt32*  ptr;
cannam@89:       UChar*   block;
cannam@89:       UInt16*  mtfv;
cannam@89:       UChar*   zbits;
cannam@89: 
cannam@89:       /* for deciding when to use the fallback sorting algorithm */
cannam@89:       Int32    workFactor;
cannam@89: 
cannam@89:       /* run-length-encoding of the input */
cannam@89:       UInt32   state_in_ch;
cannam@89:       Int32    state_in_len;
cannam@89:       BZ_RAND_DECLS;
cannam@89: 
cannam@89:       /* input and output limits and current posns */
cannam@89:       Int32    nblock;
cannam@89:       Int32    nblockMAX;
cannam@89:       Int32    numZ;
cannam@89:       Int32    state_out_pos;
cannam@89: 
cannam@89:       /* map of bytes used in block */
cannam@89:       Int32    nInUse;
cannam@89:       Bool     inUse[256];
cannam@89:       UChar    unseqToSeq[256];
cannam@89: 
cannam@89:       /* the buffer for bit stream creation */
cannam@89:       UInt32   bsBuff;
cannam@89:       Int32    bsLive;
cannam@89: 
cannam@89:       /* block and combined CRCs */
cannam@89:       UInt32   blockCRC;
cannam@89:       UInt32   combinedCRC;
cannam@89: 
cannam@89:       /* misc administratium */
cannam@89:       Int32    verbosity;
cannam@89:       Int32    blockNo;
cannam@89:       Int32    blockSize100k;
cannam@89: 
cannam@89:       /* stuff for coding the MTF values */
cannam@89:       Int32    nMTF;
cannam@89:       Int32    mtfFreq    [BZ_MAX_ALPHA_SIZE];
cannam@89:       UChar    selector   [BZ_MAX_SELECTORS];
cannam@89:       UChar    selectorMtf[BZ_MAX_SELECTORS];
cannam@89: 
cannam@89:       UChar    len     [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       Int32    code    [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       Int32    rfreq   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       /* second dimension: only 3 needed; 4 makes index calculations faster */
cannam@89:       UInt32   len_pack[BZ_MAX_ALPHA_SIZE][4];
cannam@89: 
cannam@89:    }
cannam@89:    EState;
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- externs for compression. --*/
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_blockSort ( EState* );
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_compressBlock ( EState*, Bool );
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_bsInitWrite ( EState* );
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_hbAssignCodes ( Int32*, UChar*, Int32, Int32, Int32 );
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_hbMakeCodeLengths ( UChar*, Int32*, Int32, Int32 );
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- states for decompression. --*/
cannam@89: 
cannam@89: #define BZ_X_IDLE        1
cannam@89: #define BZ_X_OUTPUT      2
cannam@89: 
cannam@89: #define BZ_X_MAGIC_1     10
cannam@89: #define BZ_X_MAGIC_2     11
cannam@89: #define BZ_X_MAGIC_3     12
cannam@89: #define BZ_X_MAGIC_4     13
cannam@89: #define BZ_X_BLKHDR_1    14
cannam@89: #define BZ_X_BLKHDR_2    15
cannam@89: #define BZ_X_BLKHDR_3    16
cannam@89: #define BZ_X_BLKHDR_4    17
cannam@89: #define BZ_X_BLKHDR_5    18
cannam@89: #define BZ_X_BLKHDR_6    19
cannam@89: #define BZ_X_BCRC_1      20
cannam@89: #define BZ_X_BCRC_2      21
cannam@89: #define BZ_X_BCRC_3      22
cannam@89: #define BZ_X_BCRC_4      23
cannam@89: #define BZ_X_RANDBIT     24
cannam@89: #define BZ_X_ORIGPTR_1   25
cannam@89: #define BZ_X_ORIGPTR_2   26
cannam@89: #define BZ_X_ORIGPTR_3   27
cannam@89: #define BZ_X_MAPPING_1   28
cannam@89: #define BZ_X_MAPPING_2   29
cannam@89: #define BZ_X_SELECTOR_1  30
cannam@89: #define BZ_X_SELECTOR_2  31
cannam@89: #define BZ_X_SELECTOR_3  32
cannam@89: #define BZ_X_CODING_1    33
cannam@89: #define BZ_X_CODING_2    34
cannam@89: #define BZ_X_CODING_3    35
cannam@89: #define BZ_X_MTF_1       36
cannam@89: #define BZ_X_MTF_2       37
cannam@89: #define BZ_X_MTF_3       38
cannam@89: #define BZ_X_MTF_4       39
cannam@89: #define BZ_X_MTF_5       40
cannam@89: #define BZ_X_MTF_6       41
cannam@89: #define BZ_X_ENDHDR_2    42
cannam@89: #define BZ_X_ENDHDR_3    43
cannam@89: #define BZ_X_ENDHDR_4    44
cannam@89: #define BZ_X_ENDHDR_5    45
cannam@89: #define BZ_X_ENDHDR_6    46
cannam@89: #define BZ_X_CCRC_1      47
cannam@89: #define BZ_X_CCRC_2      48
cannam@89: #define BZ_X_CCRC_3      49
cannam@89: #define BZ_X_CCRC_4      50
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Constants for the fast MTF decoder. --*/
cannam@89: 
cannam@89: #define MTFA_SIZE 4096
cannam@89: #define MTFL_SIZE 16
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Structure holding all the decompression-side stuff. --*/
cannam@89: 
cannam@89: typedef
cannam@89:    struct {
cannam@89:       /* pointer back to the struct bz_stream */
cannam@89:       bz_stream* strm;
cannam@89: 
cannam@89:       /* state indicator for this stream */
cannam@89:       Int32    state;
cannam@89: 
cannam@89:       /* for doing the final run-length decoding */
cannam@89:       UChar    state_out_ch;
cannam@89:       Int32    state_out_len;
cannam@89:       Bool     blockRandomised;
cannam@89:       BZ_RAND_DECLS;
cannam@89: 
cannam@89:       /* the buffer for bit stream reading */
cannam@89:       UInt32   bsBuff;
cannam@89:       Int32    bsLive;
cannam@89: 
cannam@89:       /* misc administratium */
cannam@89:       Int32    blockSize100k;
cannam@89:       Bool     smallDecompress;
cannam@89:       Int32    currBlockNo;
cannam@89:       Int32    verbosity;
cannam@89: 
cannam@89:       /* for undoing the Burrows-Wheeler transform */
cannam@89:       Int32    origPtr;
cannam@89:       UInt32   tPos;
cannam@89:       Int32    k0;
cannam@89:       Int32    unzftab[256];
cannam@89:       Int32    nblock_used;
cannam@89:       Int32    cftab[257];
cannam@89:       Int32    cftabCopy[257];
cannam@89: 
cannam@89:       /* for undoing the Burrows-Wheeler transform (FAST) */
cannam@89:       UInt32   *tt;
cannam@89: 
cannam@89:       /* for undoing the Burrows-Wheeler transform (SMALL) */
cannam@89:       UInt16   *ll16;
cannam@89:       UChar    *ll4;
cannam@89: 
cannam@89:       /* stored and calculated CRCs */
cannam@89:       UInt32   storedBlockCRC;
cannam@89:       UInt32   storedCombinedCRC;
cannam@89:       UInt32   calculatedBlockCRC;
cannam@89:       UInt32   calculatedCombinedCRC;
cannam@89: 
cannam@89:       /* map of bytes used in block */
cannam@89:       Int32    nInUse;
cannam@89:       Bool     inUse[256];
cannam@89:       Bool     inUse16[16];
cannam@89:       UChar    seqToUnseq[256];
cannam@89: 
cannam@89:       /* for decoding the MTF values */
cannam@89:       UChar    mtfa   [MTFA_SIZE];
cannam@89:       Int32    mtfbase[256 / MTFL_SIZE];
cannam@89:       UChar    selector   [BZ_MAX_SELECTORS];
cannam@89:       UChar    selectorMtf[BZ_MAX_SELECTORS];
cannam@89:       UChar    len  [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89: 
cannam@89:       Int32    limit  [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       Int32    base   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       Int32    perm   [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
cannam@89:       Int32    minLens[BZ_N_GROUPS];
cannam@89: 
cannam@89:       /* save area for scalars in the main decompress code */
cannam@89:       Int32    save_i;
cannam@89:       Int32    save_j;
cannam@89:       Int32    save_t;
cannam@89:       Int32    save_alphaSize;
cannam@89:       Int32    save_nGroups;
cannam@89:       Int32    save_nSelectors;
cannam@89:       Int32    save_EOB;
cannam@89:       Int32    save_groupNo;
cannam@89:       Int32    save_groupPos;
cannam@89:       Int32    save_nextSym;
cannam@89:       Int32    save_nblockMAX;
cannam@89:       Int32    save_nblock;
cannam@89:       Int32    save_es;
cannam@89:       Int32    save_N;
cannam@89:       Int32    save_curr;
cannam@89:       Int32    save_zt;
cannam@89:       Int32    save_zn; 
cannam@89:       Int32    save_zvec;
cannam@89:       Int32    save_zj;
cannam@89:       Int32    save_gSel;
cannam@89:       Int32    save_gMinlen;
cannam@89:       Int32*   save_gLimit;
cannam@89:       Int32*   save_gBase;
cannam@89:       Int32*   save_gPerm;
cannam@89: 
cannam@89:    }
cannam@89:    DState;
cannam@89: 
cannam@89: 
cannam@89: 
cannam@89: /*-- Macros for decompression. --*/
cannam@89: 
cannam@89: #define BZ_GET_FAST(cccc)                     \
cannam@89:     /* c_tPos is unsigned, hence test < 0 is pointless. */ \
cannam@89:     if (s->tPos >= (UInt32)100000 * (UInt32)s->blockSize100k) return True; \
cannam@89:     s->tPos = s->tt[s->tPos];                 \
cannam@89:     cccc = (UChar)(s->tPos & 0xff);           \
cannam@89:     s->tPos >>= 8;
cannam@89: 
cannam@89: #define BZ_GET_FAST_C(cccc)                   \
cannam@89:     /* c_tPos is unsigned, hence test < 0 is pointless. */ \
cannam@89:     if (c_tPos >= (UInt32)100000 * (UInt32)ro_blockSize100k) return True; \
cannam@89:     c_tPos = c_tt[c_tPos];                    \
cannam@89:     cccc = (UChar)(c_tPos & 0xff);            \
cannam@89:     c_tPos >>= 8;
cannam@89: 
cannam@89: #define SET_LL4(i,n)                                          \
cannam@89:    { if (((i) & 0x1) == 0)                                    \
cannam@89:         s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0xf0) | (n); else    \
cannam@89:         s->ll4[(i) >> 1] = (s->ll4[(i) >> 1] & 0x0f) | ((n) << 4);  \
cannam@89:    }
cannam@89: 
cannam@89: #define GET_LL4(i)                             \
cannam@89:    ((((UInt32)(s->ll4[(i) >> 1])) >> (((i) << 2) & 0x4)) & 0xF)
cannam@89: 
cannam@89: #define SET_LL(i,n)                          \
cannam@89:    { s->ll16[i] = (UInt16)(n & 0x0000ffff);  \
cannam@89:      SET_LL4(i, n >> 16);                    \
cannam@89:    }
cannam@89: 
cannam@89: #define GET_LL(i) \
cannam@89:    (((UInt32)s->ll16[i]) | (GET_LL4(i) << 16))
cannam@89: 
cannam@89: #define BZ_GET_SMALL(cccc)                            \
cannam@89:     /* c_tPos is unsigned, hence test < 0 is pointless. */ \
cannam@89:     if (s->tPos >= (UInt32)100000 * (UInt32)s->blockSize100k) return True; \
cannam@89:     cccc = BZ2_indexIntoF ( s->tPos, s->cftab );    \
cannam@89:     s->tPos = GET_LL(s->tPos);
cannam@89: 
cannam@89: 
cannam@89: /*-- externs for decompression. --*/
cannam@89: 
cannam@89: extern Int32 
cannam@89: BZ2_indexIntoF ( Int32, Int32* );
cannam@89: 
cannam@89: extern Int32 
cannam@89: BZ2_decompress ( DState* );
cannam@89: 
cannam@89: extern void 
cannam@89: BZ2_hbCreateDecodeTables ( Int32*, Int32*, Int32*, UChar*,
cannam@89:                            Int32,  Int32, Int32 );
cannam@89: 
cannam@89: 
cannam@89: #endif
cannam@89: 
cannam@89: 
cannam@89: /*-- BZ_NO_STDIO seems to make NULL disappear on some platforms. --*/
cannam@89: 
cannam@89: #ifdef BZ_NO_STDIO
cannam@89: #ifndef NULL
cannam@89: #define NULL 0
cannam@89: #endif
cannam@89: #endif
cannam@89: 
cannam@89: 
cannam@89: /*-------------------------------------------------------------*/
cannam@89: /*--- end                                   bzlib_private.h ---*/
cannam@89: /*-------------------------------------------------------------*/