2 /*-------------------------------------------------------------*/
3 /*--- Compression machinery (not incl block sorting) ---*/
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-2002 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.6 of 6 September 2010
47 Copyright (C) 1996-2010 Julian Seward <jseward@bzip.org>
49 This program is based on (at least) the work of:
59 For more information on these sources, see the manual.
63 0.9.0 -- original version.
64 0.9.0a/b -- no changes in this file.
65 0.9.0c -- changed setting of nGroups in sendMTFValues()
66 so as to do a bit better on small files
69 #include "bzlib_private.h"
72 /*---------------------------------------------------*/
73 /*--- Bit stream I/O ---*/
74 /*---------------------------------------------------*/
76 /*---------------------------------------------------*/
77 void BZ2_bsInitWrite ( EState* s )
84 /*---------------------------------------------------*/
86 void bsFinishWrite ( EState* s )
88 while (s->bsLive > 0) {
89 s->zbits[s->numZ] = (UChar)(s->bsBuff >> 24);
97 /*---------------------------------------------------*/
100 while (s->bsLive >= 8) { \
102 = (UChar)(s->bsBuff >> 24); \
110 /*---------------------------------------------------*/
113 void bsW ( EState* s, Int32 n, UInt32 v )
116 s->bsBuff |= (v << (32 - s->bsLive - n));
121 /*---------------------------------------------------*/
123 void bsPutUInt32 ( EState* s, UInt32 u )
125 bsW ( s, 8, (u >> 24) & 0xffL );
126 bsW ( s, 8, (u >> 16) & 0xffL );
127 bsW ( s, 8, (u >> 8) & 0xffL );
128 bsW ( s, 8, u & 0xffL );
132 /*---------------------------------------------------*/
134 void bsPutUChar ( EState* s, UChar c )
136 bsW( s, 8, (UInt32)c );
140 /*---------------------------------------------------*/
141 /*--- The back end proper ---*/
142 /*---------------------------------------------------*/
144 /*---------------------------------------------------*/
146 void makeMaps_e ( EState* s )
150 for (i = 0; i < 256; i++)
152 s->unseqToSeq[i] = s->nInUse;
158 /*---------------------------------------------------*/
160 void generateMTFValues ( EState* s )
169 After sorting (eg, here),
170 s->arr1 [ 0 .. s->nblock-1 ] holds sorted order,
172 ((UChar*)s->arr2) [ 0 .. s->nblock-1 ]
173 holds the original block data.
175 The first thing to do is generate the MTF values,
177 ((UInt16*)s->arr1) [ 0 .. s->nblock-1 ].
178 Because there are strictly fewer or equal MTF values
179 than block values, ptr values in this area are overwritten
180 with MTF values only when they are no longer needed.
182 The final compressed bitstream is generated into the
184 (UChar*) (&((UChar*)s->arr2)[s->nblock])
186 These storage aliases are set up in bzCompressInit(),
187 except for the last one, which is arranged in
190 UInt32* ptr = s->ptr;
191 UChar* block = s->block;
192 UInt16* mtfv = s->mtfv;
197 for (i = 0; i <= EOB; i++) s->mtfFreq[i] = 0;
201 for (i = 0; i < s->nInUse; i++) yy[i] = (UChar) i;
203 for (i = 0; i < s->nblock; i++) {
205 AssertD ( wr <= i, "generateMTFValues(1)" );
206 j = ptr[i]-1; if (j < 0) j += s->nblock;
207 ll_i = s->unseqToSeq[block[j]];
208 AssertD ( ll_i < s->nInUse, "generateMTFValues(2a)" );
218 mtfv[wr] = BZ_RUNB; wr++;
219 s->mtfFreq[BZ_RUNB]++;
221 mtfv[wr] = BZ_RUNA; wr++;
222 s->mtfFreq[BZ_RUNA]++;
224 if (zPend < 2) break;
225 zPend = (zPend - 2) / 2;
231 register UChar* ryy_j;
232 register UChar rll_i;
237 while ( rll_i != rtmp ) {
238 register UChar rtmp2;
245 j = ryy_j - &(yy[0]);
246 mtfv[wr] = j+1; wr++; s->mtfFreq[j+1]++;
256 mtfv[wr] = BZ_RUNB; wr++;
257 s->mtfFreq[BZ_RUNB]++;
259 mtfv[wr] = BZ_RUNA; wr++;
260 s->mtfFreq[BZ_RUNA]++;
262 if (zPend < 2) break;
263 zPend = (zPend - 2) / 2;
268 mtfv[wr] = EOB; wr++; s->mtfFreq[EOB]++;
274 /*---------------------------------------------------*/
275 #define BZ_LESSER_ICOST 0
276 #define BZ_GREATER_ICOST 15
279 void sendMTFValues ( EState* s )
281 Int32 v, t, i, j, gs, ge, totc, bt, bc, iter;
282 Int32 nSelectors, alphaSize, minLen, maxLen, selCtr;
284 Int32 nBytes __maybe_unused;
287 UChar len [BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
288 is a global since the decoder also needs it.
290 Int32 code[BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
291 Int32 rfreq[BZ_N_GROUPS][BZ_MAX_ALPHA_SIZE];
292 are also globals only used in this proc.
293 Made global to keep stack frame size small.
297 UInt16 cost[BZ_N_GROUPS];
298 Int32 fave[BZ_N_GROUPS];
300 UInt16* mtfv = s->mtfv;
302 if (s->verbosity >= 3)
303 VPrintf3( " %d in block, %d after MTF & 1-2 coding, "
304 "%d+2 syms in use\n",
305 s->nblock, s->nMTF, s->nInUse );
307 alphaSize = s->nInUse+2;
308 for (t = 0; t < BZ_N_GROUPS; t++)
309 for (v = 0; v < alphaSize; v++)
310 s->len[t][v] = BZ_GREATER_ICOST;
312 /*--- Decide how many coding tables to use ---*/
313 AssertH ( s->nMTF > 0, 3001 );
314 if (s->nMTF < 200) nGroups = 2; else
315 if (s->nMTF < 600) nGroups = 3; else
316 if (s->nMTF < 1200) nGroups = 4; else
317 if (s->nMTF < 2400) nGroups = 5; else
320 /*--- Generate an initial set of coding tables ---*/
322 Int32 nPart, remF, tFreq, aFreq;
328 tFreq = remF / nPart;
331 while (aFreq < tFreq && ge < alphaSize-1) {
333 aFreq += s->mtfFreq[ge];
337 && nPart != nGroups && nPart != 1
338 && ((nGroups-nPart) % 2 == 1)) {
339 aFreq -= s->mtfFreq[ge];
343 if (s->verbosity >= 3)
344 VPrintf5( " initial group %d, [%d .. %d], "
345 "has %d syms (%4.1f%%)\n",
346 nPart, gs, ge, aFreq,
347 (100.0 * (float)aFreq) / (float)(s->nMTF) );
349 for (v = 0; v < alphaSize; v++)
350 if (v >= gs && v <= ge)
351 s->len[nPart-1][v] = BZ_LESSER_ICOST; else
352 s->len[nPart-1][v] = BZ_GREATER_ICOST;
361 Iterate up to BZ_N_ITERS times to improve the tables.
363 for (iter = 0; iter < BZ_N_ITERS; iter++) {
365 for (t = 0; t < nGroups; t++) fave[t] = 0;
367 for (t = 0; t < nGroups; t++)
368 for (v = 0; v < alphaSize; v++)
372 Set up an auxiliary length table which is used to fast-track
373 the common case (nGroups == 6).
376 for (v = 0; v < alphaSize; v++) {
377 s->len_pack[v][0] = (s->len[1][v] << 16) | s->len[0][v];
378 s->len_pack[v][1] = (s->len[3][v] << 16) | s->len[2][v];
379 s->len_pack[v][2] = (s->len[5][v] << 16) | s->len[4][v];
388 /*--- Set group start & end marks. --*/
389 if (gs >= s->nMTF) break;
390 ge = gs + BZ_G_SIZE - 1;
391 if (ge >= s->nMTF) ge = s->nMTF-1;
394 Calculate the cost of this group as coded
395 by each of the coding tables.
397 for (t = 0; t < nGroups; t++) cost[t] = 0;
399 if (nGroups == 6 && 50 == ge-gs+1) {
400 /*--- fast track the common case ---*/
401 register UInt32 cost01, cost23, cost45;
403 cost01 = cost23 = cost45 = 0;
405 # define BZ_ITER(nn) \
406 icv = mtfv[gs+(nn)]; \
407 cost01 += s->len_pack[icv][0]; \
408 cost23 += s->len_pack[icv][1]; \
409 cost45 += s->len_pack[icv][2]; \
411 BZ_ITER(0); BZ_ITER(1); BZ_ITER(2); BZ_ITER(3); BZ_ITER(4);
412 BZ_ITER(5); BZ_ITER(6); BZ_ITER(7); BZ_ITER(8); BZ_ITER(9);
413 BZ_ITER(10); BZ_ITER(11); BZ_ITER(12); BZ_ITER(13); BZ_ITER(14);
414 BZ_ITER(15); BZ_ITER(16); BZ_ITER(17); BZ_ITER(18); BZ_ITER(19);
415 BZ_ITER(20); BZ_ITER(21); BZ_ITER(22); BZ_ITER(23); BZ_ITER(24);
416 BZ_ITER(25); BZ_ITER(26); BZ_ITER(27); BZ_ITER(28); BZ_ITER(29);
417 BZ_ITER(30); BZ_ITER(31); BZ_ITER(32); BZ_ITER(33); BZ_ITER(34);
418 BZ_ITER(35); BZ_ITER(36); BZ_ITER(37); BZ_ITER(38); BZ_ITER(39);
419 BZ_ITER(40); BZ_ITER(41); BZ_ITER(42); BZ_ITER(43); BZ_ITER(44);
420 BZ_ITER(45); BZ_ITER(46); BZ_ITER(47); BZ_ITER(48); BZ_ITER(49);
424 cost[0] = cost01 & 0xffff; cost[1] = cost01 >> 16;
425 cost[2] = cost23 & 0xffff; cost[3] = cost23 >> 16;
426 cost[4] = cost45 & 0xffff; cost[5] = cost45 >> 16;
429 /*--- slow version which correctly handles all situations ---*/
430 for (i = gs; i <= ge; i++) {
431 UInt16 icv = mtfv[i];
432 for (t = 0; t < nGroups; t++) cost[t] += s->len[t][icv];
437 Find the coding table which is best for this group,
438 and record its identity in the selector table.
440 bc = 999999999; bt = -1;
441 for (t = 0; t < nGroups; t++)
442 if (cost[t] < bc) { bc = cost[t]; bt = t; };
445 s->selector[nSelectors] = bt;
449 Increment the symbol frequencies for the selected table.
451 if (nGroups == 6 && 50 == ge-gs+1) {
452 /*--- fast track the common case ---*/
454 # define BZ_ITUR(nn) s->rfreq[bt][ mtfv[gs+(nn)] ]++
456 BZ_ITUR(0); BZ_ITUR(1); BZ_ITUR(2); BZ_ITUR(3); BZ_ITUR(4);
457 BZ_ITUR(5); BZ_ITUR(6); BZ_ITUR(7); BZ_ITUR(8); BZ_ITUR(9);
458 BZ_ITUR(10); BZ_ITUR(11); BZ_ITUR(12); BZ_ITUR(13); BZ_ITUR(14);
459 BZ_ITUR(15); BZ_ITUR(16); BZ_ITUR(17); BZ_ITUR(18); BZ_ITUR(19);
460 BZ_ITUR(20); BZ_ITUR(21); BZ_ITUR(22); BZ_ITUR(23); BZ_ITUR(24);
461 BZ_ITUR(25); BZ_ITUR(26); BZ_ITUR(27); BZ_ITUR(28); BZ_ITUR(29);
462 BZ_ITUR(30); BZ_ITUR(31); BZ_ITUR(32); BZ_ITUR(33); BZ_ITUR(34);
463 BZ_ITUR(35); BZ_ITUR(36); BZ_ITUR(37); BZ_ITUR(38); BZ_ITUR(39);
464 BZ_ITUR(40); BZ_ITUR(41); BZ_ITUR(42); BZ_ITUR(43); BZ_ITUR(44);
465 BZ_ITUR(45); BZ_ITUR(46); BZ_ITUR(47); BZ_ITUR(48); BZ_ITUR(49);
470 /*--- slow version which correctly handles all situations ---*/
471 for (i = gs; i <= ge; i++)
472 s->rfreq[bt][ mtfv[i] ]++;
477 if (s->verbosity >= 3) {
478 VPrintf2 ( " pass %d: size is %d, grp uses are ",
480 for (t = 0; t < nGroups; t++)
481 VPrintf1 ( "%d ", fave[t] );
486 Recompute the tables based on the accumulated frequencies.
488 /* maxLen was changed from 20 to 17 in bzip2-1.0.3. See
489 comment in huffman.c for details. */
490 for (t = 0; t < nGroups; t++)
491 BZ2_hbMakeCodeLengths ( &(s->len[t][0]), &(s->rfreq[t][0]),
492 alphaSize, 17 /*20*/ );
496 AssertH( nGroups < 8, 3002 );
497 AssertH( nSelectors < 32768 &&
498 nSelectors <= (2 + (900000 / BZ_G_SIZE)),
502 /*--- Compute MTF values for the selectors. ---*/
504 UChar pos[BZ_N_GROUPS], ll_i, tmp2, tmp;
505 for (i = 0; i < nGroups; i++) pos[i] = i;
506 for (i = 0; i < nSelectors; i++) {
507 ll_i = s->selector[i];
510 while ( ll_i != tmp ) {
517 s->selectorMtf[i] = j;
521 /*--- Assign actual codes for the tables. --*/
522 for (t = 0; t < nGroups; t++) {
525 for (i = 0; i < alphaSize; i++) {
526 if (s->len[t][i] > maxLen) maxLen = s->len[t][i];
527 if (s->len[t][i] < minLen) minLen = s->len[t][i];
529 AssertH ( !(maxLen > 17 /*20*/ ), 3004 );
530 AssertH ( !(minLen < 1), 3005 );
531 BZ2_hbAssignCodes ( &(s->code[t][0]), &(s->len[t][0]),
532 minLen, maxLen, alphaSize );
535 /*--- Transmit the mapping table. ---*/
538 for (i = 0; i < 16; i++) {
540 for (j = 0; j < 16; j++)
541 if (s->inUse[i * 16 + j]) inUse16[i] = True;
545 for (i = 0; i < 16; i++)
546 if (inUse16[i]) bsW(s,1,1); else bsW(s,1,0);
548 for (i = 0; i < 16; i++)
550 for (j = 0; j < 16; j++) {
551 if (s->inUse[i * 16 + j]) bsW(s,1,1); else bsW(s,1,0);
554 if (s->verbosity >= 3)
555 VPrintf1( " bytes: mapping %d, ", s->numZ-nBytes );
558 /*--- Now the selectors. ---*/
560 bsW ( s, 3, nGroups );
561 bsW ( s, 15, nSelectors );
562 for (i = 0; i < nSelectors; i++) {
563 for (j = 0; j < s->selectorMtf[i]; j++) bsW(s,1,1);
566 if (s->verbosity >= 3)
567 VPrintf1( "selectors %d, ", s->numZ-nBytes );
569 /*--- Now the coding tables. ---*/
572 for (t = 0; t < nGroups; t++) {
573 Int32 curr = s->len[t][0];
575 for (i = 0; i < alphaSize; i++) {
576 while (curr < s->len[t][i]) { bsW(s,2,2); curr++; /* 10 */ };
577 while (curr > s->len[t][i]) { bsW(s,2,3); curr--; /* 11 */ };
582 if (s->verbosity >= 3)
583 VPrintf1 ( "code lengths %d, ", s->numZ-nBytes );
585 /*--- And finally, the block data proper ---*/
590 if (gs >= s->nMTF) break;
591 ge = gs + BZ_G_SIZE - 1;
592 if (ge >= s->nMTF) ge = s->nMTF-1;
593 AssertH ( s->selector[selCtr] < nGroups, 3006 );
595 if (nGroups == 6 && 50 == ge-gs+1) {
596 /*--- fast track the common case ---*/
598 UChar* s_len_sel_selCtr
599 = &(s->len[s->selector[selCtr]][0]);
600 Int32* s_code_sel_selCtr
601 = &(s->code[s->selector[selCtr]][0]);
603 # define BZ_ITAH(nn) \
604 mtfv_i = mtfv[gs+(nn)]; \
606 s_len_sel_selCtr[mtfv_i], \
607 s_code_sel_selCtr[mtfv_i] )
609 BZ_ITAH(0); BZ_ITAH(1); BZ_ITAH(2); BZ_ITAH(3); BZ_ITAH(4);
610 BZ_ITAH(5); BZ_ITAH(6); BZ_ITAH(7); BZ_ITAH(8); BZ_ITAH(9);
611 BZ_ITAH(10); BZ_ITAH(11); BZ_ITAH(12); BZ_ITAH(13); BZ_ITAH(14);
612 BZ_ITAH(15); BZ_ITAH(16); BZ_ITAH(17); BZ_ITAH(18); BZ_ITAH(19);
613 BZ_ITAH(20); BZ_ITAH(21); BZ_ITAH(22); BZ_ITAH(23); BZ_ITAH(24);
614 BZ_ITAH(25); BZ_ITAH(26); BZ_ITAH(27); BZ_ITAH(28); BZ_ITAH(29);
615 BZ_ITAH(30); BZ_ITAH(31); BZ_ITAH(32); BZ_ITAH(33); BZ_ITAH(34);
616 BZ_ITAH(35); BZ_ITAH(36); BZ_ITAH(37); BZ_ITAH(38); BZ_ITAH(39);
617 BZ_ITAH(40); BZ_ITAH(41); BZ_ITAH(42); BZ_ITAH(43); BZ_ITAH(44);
618 BZ_ITAH(45); BZ_ITAH(46); BZ_ITAH(47); BZ_ITAH(48); BZ_ITAH(49);
623 /*--- slow version which correctly handles all situations ---*/
624 for (i = gs; i <= ge; i++) {
626 s->len [s->selector[selCtr]] [mtfv[i]],
627 s->code [s->selector[selCtr]] [mtfv[i]] );
635 AssertH( selCtr == nSelectors, 3007 );
637 if (s->verbosity >= 3)
638 VPrintf1( "codes %d\n", s->numZ-nBytes );
642 /*---------------------------------------------------*/
643 void BZ2_compressBlock ( EState* s, Bool is_last_block )
647 BZ_FINALISE_CRC ( s->blockCRC );
648 s->combinedCRC = (s->combinedCRC << 1) | (s->combinedCRC >> 31);
649 s->combinedCRC ^= s->blockCRC;
650 if (s->blockNo > 1) s->numZ = 0;
652 if (s->verbosity >= 2)
653 VPrintf4( " block %d: crc = 0x%08x, "
654 "combined CRC = 0x%08x, size = %d\n",
655 s->blockNo, s->blockCRC, s->combinedCRC, s->nblock );
660 s->zbits = (UChar*) (&((UChar*)s->arr2)[s->nblock]);
662 /*-- If this is the first block, create the stream header. --*/
663 if (s->blockNo == 1) {
664 BZ2_bsInitWrite ( s );
665 bsPutUChar ( s, BZ_HDR_B );
666 bsPutUChar ( s, BZ_HDR_Z );
667 bsPutUChar ( s, BZ_HDR_h );
668 bsPutUChar ( s, (UChar)(BZ_HDR_0 + s->blockSize100k) );
673 bsPutUChar ( s, 0x31 ); bsPutUChar ( s, 0x41 );
674 bsPutUChar ( s, 0x59 ); bsPutUChar ( s, 0x26 );
675 bsPutUChar ( s, 0x53 ); bsPutUChar ( s, 0x59 );
677 /*-- Now the block's CRC, so it is in a known place. --*/
678 bsPutUInt32 ( s, s->blockCRC );
681 Now a single bit indicating (non-)randomisation.
682 As of version 0.9.5, we use a better sorting algorithm
683 which makes randomisation unnecessary. So always set
684 the randomised bit to 'no'. Of course, the decoder
685 still needs to be able to handle randomised blocks
686 so as to maintain backwards compatibility with
687 older versions of bzip2.
691 bsW ( s, 24, s->origPtr );
692 generateMTFValues ( s );
697 /*-- If this is the last block, add the stream trailer. --*/
700 bsPutUChar ( s, 0x17 ); bsPutUChar ( s, 0x72 );
701 bsPutUChar ( s, 0x45 ); bsPutUChar ( s, 0x38 );
702 bsPutUChar ( s, 0x50 ); bsPutUChar ( s, 0x90 );
703 bsPutUInt32 ( s, s->combinedCRC );
704 if (s->verbosity >= 2)
705 VPrintf1( " final combined CRC = 0x%08x\n ", s->combinedCRC );
711 /*-------------------------------------------------------------*/
712 /*--- end compress.c ---*/
713 /*-------------------------------------------------------------*/