1592N/A/*
1592N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1592N/A *
1592N/A * This code is free software; you can redistribute it and/or modify it
1592N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
1592N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
1592N/A *
1592N/A * This code is distributed in the hope that it will be useful, but WITHOUT
1592N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1592N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1592N/A * version 2 for more details (a copy is included in the LICENSE file that
1592N/A * accompanied this code).
1592N/A *
1592N/A * You should have received a copy of the GNU General Public License version
1592N/A * 2 along with this work; if not, write to the Free Software Foundation,
1592N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1592N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
1592N/A */
1592N/A
1592N/A/* deflate.h -- internal compression state
1592N/A * Copyright (C) 1995-2004 Jean-loup Gailly
1592N/A * For conditions of distribution and use, see copyright notice in zlib.h
1592N/A */
1592N/A
1592N/A/* WARNING: this file should *not* be used by applications. It is
1592N/A part of the implementation of the compression library and is
1592N/A subject to change. Applications should only use zlib.h.
1592N/A */
1592N/A
1592N/A/* @(#) $Id$ */
1592N/A
1592N/A#ifndef DEFLATE_H
1592N/A#define DEFLATE_H
1592N/A
1592N/A#include "zutil.h"
1592N/A
1592N/A/* define NO_GZIP when compiling if you want to disable gzip header and
1592N/A trailer creation by deflate(). NO_GZIP would be used to avoid linking in
1592N/A the crc code when it is not needed. For shared libraries, gzip encoding
1592N/A should be left enabled. */
1592N/A#ifndef NO_GZIP
1592N/A# define GZIP
1592N/A#endif
1592N/A
1592N/A/* ===========================================================================
1592N/A * Internal compression state.
1592N/A */
1592N/A
1592N/A#define LENGTH_CODES 29
1592N/A/* number of length codes, not counting the special END_BLOCK code */
1592N/A
1592N/A#define LITERALS 256
1592N/A/* number of literal bytes 0..255 */
1592N/A
1592N/A#define L_CODES (LITERALS+1+LENGTH_CODES)
1592N/A/* number of Literal or Length codes, including the END_BLOCK code */
1592N/A
1592N/A#define D_CODES 30
1592N/A/* number of distance codes */
1592N/A
1592N/A#define BL_CODES 19
1592N/A/* number of codes used to transfer the bit lengths */
1592N/A
1592N/A#define HEAP_SIZE (2*L_CODES+1)
1592N/A/* maximum heap size */
1592N/A
1592N/A#define MAX_BITS 15
1592N/A/* All codes must not exceed MAX_BITS bits */
1592N/A
1592N/A#define INIT_STATE 42
1592N/A#define EXTRA_STATE 69
1592N/A#define NAME_STATE 73
1592N/A#define COMMENT_STATE 91
1592N/A#define HCRC_STATE 103
1592N/A#define BUSY_STATE 113
1592N/A#define FINISH_STATE 666
1592N/A/* Stream status */
1592N/A
1592N/A
1592N/A/* Data structure describing a single value and its code string. */
1592N/Atypedef struct ct_data_s {
1592N/A union {
1592N/A ush freq; /* frequency count */
1592N/A ush code; /* bit string */
1592N/A } fc;
1592N/A union {
1592N/A ush dad; /* father node in Huffman tree */
1592N/A ush len; /* length of bit string */
1592N/A } dl;
1592N/A} FAR ct_data;
1592N/A
1592N/A#define Freq fc.freq
1592N/A#define Code fc.code
1592N/A#define Dad dl.dad
1592N/A#define Len dl.len
1592N/A
1592N/Atypedef struct static_tree_desc_s static_tree_desc;
1592N/A
1592N/Atypedef struct tree_desc_s {
1592N/A ct_data *dyn_tree; /* the dynamic tree */
1592N/A int max_code; /* largest code with non zero frequency */
1592N/A static_tree_desc *stat_desc; /* the corresponding static tree */
1592N/A} FAR tree_desc;
1592N/A
1592N/Atypedef ush Pos;
1592N/Atypedef Pos FAR Posf;
1592N/Atypedef unsigned IPos;
1592N/A
1592N/A/* A Pos is an index in the character window. We use short instead of int to
1592N/A * save space in the various tables. IPos is used only for parameter passing.
1592N/A */
1592N/A
1592N/Atypedef struct internal_state {
1592N/A z_streamp strm; /* pointer back to this zlib stream */
1592N/A int status; /* as the name implies */
1592N/A Bytef *pending_buf; /* output still pending */
1592N/A ulg pending_buf_size; /* size of pending_buf */
1592N/A Bytef *pending_out; /* next pending byte to output to the stream */
1592N/A uInt pending; /* nb of bytes in the pending buffer */
1592N/A int wrap; /* bit 0 true for zlib, bit 1 true for gzip */
1592N/A gz_headerp gzhead; /* gzip header information to write */
1592N/A uInt gzindex; /* where in extra, name, or comment */
1592N/A Byte method; /* STORED (for zip only) or DEFLATED */
1592N/A int last_flush; /* value of flush param for previous deflate call */
1592N/A
1592N/A /* used by deflate.c: */
1592N/A
1592N/A uInt w_size; /* LZ77 window size (32K by default) */
1592N/A uInt w_bits; /* log2(w_size) (8..16) */
1592N/A uInt w_mask; /* w_size - 1 */
1592N/A
1592N/A Bytef *window;
1592N/A /* Sliding window. Input bytes are read into the second half of the window,
1592N/A * and move to the first half later to keep a dictionary of at least wSize
1592N/A * bytes. With this organization, matches are limited to a distance of
1592N/A * wSize-MAX_MATCH bytes, but this ensures that IO is always
1592N/A * performed with a length multiple of the block size. Also, it limits
1592N/A * the window size to 64K, which is quite useful on MSDOS.
1592N/A * To do: use the user input buffer as sliding window.
1592N/A */
1592N/A
1592N/A ulg window_size;
1592N/A /* Actual size of window: 2*wSize, except when the user input buffer
1592N/A * is directly used as sliding window.
1592N/A */
1592N/A
1592N/A Posf *prev;
1592N/A /* Link to older string with same hash index. To limit the size of this
1592N/A * array to 64K, this link is maintained only for the last 32K strings.
1592N/A * An index in this array is thus a window index modulo 32K.
1592N/A */
1592N/A
1592N/A Posf *head; /* Heads of the hash chains or NIL. */
1592N/A
1592N/A uInt ins_h; /* hash index of string to be inserted */
1592N/A uInt hash_size; /* number of elements in hash table */
1592N/A uInt hash_bits; /* log2(hash_size) */
1592N/A uInt hash_mask; /* hash_size-1 */
1592N/A
1592N/A uInt hash_shift;
1592N/A /* Number of bits by which ins_h must be shifted at each input
1592N/A * step. It must be such that after MIN_MATCH steps, the oldest
1592N/A * byte no longer takes part in the hash key, that is:
1592N/A * hash_shift * MIN_MATCH >= hash_bits
1592N/A */
1592N/A
1592N/A long block_start;
1592N/A /* Window position at the beginning of the current output block. Gets
1592N/A * negative when the window is moved backwards.
1592N/A */
1592N/A
1592N/A uInt match_length; /* length of best match */
1592N/A IPos prev_match; /* previous match */
1592N/A int match_available; /* set if previous match exists */
1592N/A uInt strstart; /* start of string to insert */
1592N/A uInt match_start; /* start of matching string */
1592N/A uInt lookahead; /* number of valid bytes ahead in window */
1592N/A
1592N/A uInt prev_length;
1592N/A /* Length of the best match at previous step. Matches not greater than this
1592N/A * are discarded. This is used in the lazy match evaluation.
1592N/A */
1592N/A
1592N/A uInt max_chain_length;
1592N/A /* To speed up deflation, hash chains are never searched beyond this
1592N/A * length. A higher limit improves compression ratio but degrades the
1592N/A * speed.
1592N/A */
1592N/A
1592N/A uInt max_lazy_match;
1592N/A /* Attempt to find a better match only when the current match is strictly
1592N/A * smaller than this value. This mechanism is used only for compression
1592N/A * levels >= 4.
1592N/A */
1592N/A# define max_insert_length max_lazy_match
1592N/A /* Insert new strings in the hash table only if the match length is not
1592N/A * greater than this length. This saves time but degrades compression.
1592N/A * max_insert_length is used only for compression levels <= 3.
1592N/A */
1592N/A
1592N/A int level; /* compression level (1..9) */
1592N/A int strategy; /* favor or force Huffman coding*/
1592N/A
1592N/A uInt good_match;
1592N/A /* Use a faster search when the previous match is longer than this */
1592N/A
1592N/A int nice_match; /* Stop searching when current match exceeds this */
1592N/A
1592N/A /* used by trees.c: */
1592N/A /* Didn't use ct_data typedef below to supress compiler warning */
1592N/A struct ct_data_s dyn_ltree[HEAP_SIZE]; /* literal and length tree */
1592N/A struct ct_data_s dyn_dtree[2*D_CODES+1]; /* distance tree */
1592N/A struct ct_data_s bl_tree[2*BL_CODES+1]; /* Huffman tree for bit lengths */
1592N/A
1592N/A struct tree_desc_s l_desc; /* desc. for literal tree */
1592N/A struct tree_desc_s d_desc; /* desc. for distance tree */
1592N/A struct tree_desc_s bl_desc; /* desc. for bit length tree */
1592N/A
1592N/A ush bl_count[MAX_BITS+1];
1592N/A /* number of codes at each bit length for an optimal tree */
1592N/A
1592N/A int heap[2*L_CODES+1]; /* heap used to build the Huffman trees */
1592N/A int heap_len; /* number of elements in the heap */
1592N/A int heap_max; /* element of largest frequency */
1592N/A /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1592N/A * The same heap array is used to build all trees.
1592N/A */
1592N/A
1592N/A uch depth[2*L_CODES+1];
1592N/A /* Depth of each subtree used as tie breaker for trees of equal frequency
1592N/A */
1592N/A
1592N/A uchf *l_buf; /* buffer for literals or lengths */
1592N/A
1592N/A uInt lit_bufsize;
1592N/A /* Size of match buffer for literals/lengths. There are 4 reasons for
1592N/A * limiting lit_bufsize to 64K:
1592N/A * - frequencies can be kept in 16 bit counters
1592N/A * - if compression is not successful for the first block, all input
1592N/A * data is still in the window so we can still emit a stored block even
1592N/A * when input comes from standard input. (This can also be done for
1592N/A * all blocks if lit_bufsize is not greater than 32K.)
1592N/A * - if compression is not successful for a file smaller than 64K, we can
1592N/A * even emit a stored file instead of a stored block (saving 5 bytes).
1592N/A * This is applicable only for zip (not gzip or zlib).
1592N/A * - creating new Huffman trees less frequently may not provide fast
1592N/A * adaptation to changes in the input data statistics. (Take for
1592N/A * example a binary file with poorly compressible code followed by
1592N/A * a highly compressible string table.) Smaller buffer sizes give
1592N/A * fast adaptation but have of course the overhead of transmitting
1592N/A * trees more frequently.
1592N/A * - I can't count above 4
1592N/A */
1592N/A
1592N/A uInt last_lit; /* running index in l_buf */
1592N/A
1592N/A ushf *d_buf;
1592N/A /* Buffer for distances. To simplify the code, d_buf and l_buf have
1592N/A * the same number of elements. To use different lengths, an extra flag
1592N/A * array would be necessary.
1592N/A */
1592N/A
1592N/A ulg opt_len; /* bit length of current block with optimal trees */
1592N/A ulg static_len; /* bit length of current block with static trees */
1592N/A uInt matches; /* number of string matches in current block */
1592N/A int last_eob_len; /* bit length of EOB code for last block */
1592N/A
1592N/A#ifdef DEBUG
1592N/A ulg compressed_len; /* total bit length of compressed file mod 2^32 */
1592N/A ulg bits_sent; /* bit length of compressed data sent mod 2^32 */
1592N/A#endif
1592N/A
1592N/A ush bi_buf;
1592N/A /* Output buffer. bits are inserted starting at the bottom (least
1592N/A * significant bits).
1592N/A */
1592N/A int bi_valid;
1592N/A /* Number of valid bits in bi_buf. All bits above the last valid bit
1592N/A * are always zero.
1592N/A */
1592N/A
1592N/A} FAR deflate_state;
1592N/A
1592N/A/* Output a byte on the stream.
1592N/A * IN assertion: there is enough room in pending_buf.
1592N/A */
1592N/A#define put_byte(s, c) {s->pending_buf[s->pending++] = (c);}
1592N/A
1592N/A
1592N/A#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
1592N/A/* Minimum amount of lookahead, except at the end of the input file.
1592N/A * See deflate.c for comments about the MIN_MATCH+1.
1592N/A */
1592N/A
1592N/A#define MAX_DIST(s) ((s)->w_size-MIN_LOOKAHEAD)
1592N/A/* In order to simplify the code, particularly on 16 bit machines, match
1592N/A * distances are limited to MAX_DIST instead of WSIZE.
1592N/A */
1592N/A
1592N/A /* in trees.c */
1592N/Avoid _tr_init OF((deflate_state *s));
1592N/Aint _tr_tally OF((deflate_state *s, unsigned dist, unsigned lc));
1592N/Avoid _tr_flush_block OF((deflate_state *s, charf *buf, ulg stored_len,
1592N/A int eof));
1592N/Avoid _tr_align OF((deflate_state *s));
1592N/Avoid _tr_stored_block OF((deflate_state *s, charf *buf, ulg stored_len,
1592N/A int eof));
1592N/A
1592N/A#define d_code(dist) \
1592N/A ((dist) < 256 ? _dist_code[dist] : _dist_code[256+((dist)>>7)])
1592N/A/* Mapping from a distance to a distance code. dist is the distance - 1 and
1592N/A * must not have side effects. _dist_code[256] and _dist_code[257] are never
1592N/A * used.
1592N/A */
1592N/A
1592N/A#ifndef DEBUG
1592N/A/* Inline versions of _tr_tally for speed: */
1592N/A
1592N/A#if defined(GEN_TREES_H) || !defined(STDC)
1592N/A extern uch _length_code[];
1592N/A extern uch _dist_code[];
1592N/A#else
1592N/A extern const uch _length_code[];
1592N/A extern const uch _dist_code[];
1592N/A#endif
1592N/A
1592N/A# define _tr_tally_lit(s, c, flush) \
1592N/A { uch cc = (c); \
1592N/A s->d_buf[s->last_lit] = 0; \
1592N/A s->l_buf[s->last_lit++] = cc; \
1592N/A s->dyn_ltree[cc].Freq++; \
1592N/A flush = (s->last_lit == s->lit_bufsize-1); \
1592N/A }
1592N/A# define _tr_tally_dist(s, distance, length, flush) \
1592N/A { uch len = (length); \
1592N/A ush dist = (distance); \
1592N/A s->d_buf[s->last_lit] = dist; \
1592N/A s->l_buf[s->last_lit++] = len; \
1592N/A dist--; \
1592N/A s->dyn_ltree[_length_code[len]+LITERALS+1].Freq++; \
1592N/A s->dyn_dtree[d_code(dist)].Freq++; \
1592N/A flush = (s->last_lit == s->lit_bufsize-1); \
1592N/A }
1592N/A#else
1592N/A# define _tr_tally_lit(s, c, flush) flush = _tr_tally(s, 0, c)
1592N/A# define _tr_tally_dist(s, distance, length, flush) \
1592N/A flush = _tr_tally(s, distance, length)
1592N/A#endif
1592N/A
1592N/A#endif /* DEFLATE_H */