1 /* bits.c -- output variable-length bit strings
2 * Copyright (C) 1992-1993 Jean-loup Gailly
3 * This is free software; you can redistribute it and/or modify it under the
4 * terms of the GNU General Public License, see the file COPYING.
11 * Output variable-length bit strings. Compression can be done
12 * to a file or to memory. (The latter is not supported in this version.)
16 * The PKZIP "deflate" file format interprets compressed file data
17 * as a sequence of bits. Multi-bit strings in the file may cross
18 * byte boundaries without restriction.
20 * The first bit of each byte is the low-order bit.
22 * The routines in this file allow a variable-length bit value to
23 * be output right-to-left (useful for literal values). For
24 * left-to-right output (useful for code strings from the tree routines),
25 * the bits must have been reversed first with bi_reverse().
27 * For in-memory compression, the compressed bit stream goes directly
28 * into the requested output buffer. The input data is read in blocks
29 * by the mem_read() function. The buffer is limited to 64K on 16 bit
34 * void bi_init (FILE *zipfile)
35 * Initialize the bit string routines.
37 * void send_bits (int value, int length)
38 * Write out a bit string, taking the source bits right to
41 * int bi_reverse (int value, int length)
42 * Reverse the bits of a bit string, taking the source bits left to
43 * right and emitting them right to left.
45 * void bi_windup (void)
46 * Write out any remaining bits in an incomplete byte.
48 * void copy_block(char *buf, unsigned len, int header)
49 * Copy a stored block to the zip file, storing first the length and
50 * its one's complement if requested.
63 static char rcsid[] = "$FreeBSD: src/gnu/usr.bin/gzip/bits.c,v 1.7 1999/08/27 23:35:49 peter Exp $";
66 /* ===========================================================================
67 * Local data used by the "bit string" routines.
70 local file_t zfile; /* output gzip file */
72 local unsigned short bi_buf;
73 /* Output buffer. bits are inserted starting at the bottom (least significant
77 #define Buf_size (8 * 2*sizeof(char))
78 /* Number of bits used within bi_buf. (bi_buf might be implemented on
79 * more than 16 bits on some systems.)
83 /* Number of valid bits in bi_buf. All bits above the last valid bit
87 int (*read_buf) OF((char *buf, unsigned size));
88 /* Current input function. Set to mem_read for in-memory compression */
91 ulg bits_sent; /* bit length of the compressed data */
94 /* ===========================================================================
95 * Initialize the bit string routines.
97 void bi_init (zipfile)
98 file_t zipfile; /* output zip file, NO_FILE for in-memory compression */
107 /* Set the defaults for file compression. They are set by memcompress
108 * for in-memory compression.
110 if (zfile != NO_FILE) {
111 read_buf = file_read;
115 /* ===========================================================================
116 * Send a value on a given number of bits.
117 * IN assertion: length <= 16 and value fits in length bits.
119 void send_bits(value, length)
120 int value; /* value to send */
121 int length; /* number of bits */
124 Tracev((stderr," l %2d v %4x ", length, value));
125 Assert(length > 0 && length <= 15, "invalid length");
126 bits_sent += (ulg)length;
128 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
129 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
130 * unused bits in value.
132 if (bi_valid > (int)Buf_size - length) {
133 bi_buf |= (value << bi_valid);
135 bi_buf = (ush)value >> (Buf_size - bi_valid);
136 bi_valid += length - Buf_size;
138 bi_buf |= value << bi_valid;
143 /* ===========================================================================
144 * Reverse the first len bits of a code, using straightforward code (a faster
145 * method would use a table)
146 * IN assertion: 1 <= len <= 15
148 unsigned bi_reverse(code, len)
149 unsigned code; /* the value to invert */
150 int len; /* its bit length */
152 register unsigned res = 0;
155 code >>= 1, res <<= 1;
160 /* ===========================================================================
161 * Write out any remaining bits in an incomplete byte.
167 } else if (bi_valid > 0) {
173 bits_sent = (bits_sent+7) & ~7;
177 /* ===========================================================================
178 * Copy a stored block to the zip file, storing first the length and its
179 * one's complement if requested.
181 void copy_block(buf, len, header)
182 char *buf; /* the input data */
183 unsigned len; /* its length */
184 int header; /* true if block header must be written */
186 bi_windup(); /* align on byte boundary */
190 put_short((ush)~len);
196 bits_sent += (ulg)len<<3;
201 if (key) zencode(*buf, t);