1 /* $Id: rle.c,v 1.13 2003-01-02 21:32:18 btb Exp $ */
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
17 * Routines to do run length encoding/decoding
20 * Changed shorts to ints in parameters.
24 * Revision 1.10 1995/08/14 14:26:34 allender
25 * changed transparency color to 0
27 * Revision 1.9 1995/07/05 16:07:49 allender
28 * transparency/kitchen chagnes
30 * Revision 1.8 1995/05/12 11:54:03 allender
31 * changed memory stuff again
33 * Revision 1.7 1995/05/11 12:49:19 allender
34 * change transparency color
36 * Revision 1.6 1995/05/04 20:00:30 allender
37 * use NewPtr instead of malloc. Fix gr_rle_scanline (which caused me
38 * *many* hours of frustration!!!!)
40 * Revision 1.5 1995/05/01 08:40:32 allender
41 * trying to find memory bug....this stuff works -- it's johns code
43 * Revision 1.4 1995/04/27 07:38:24 allender
44 * new rle code ala John
46 * Revision 1.3 1995/04/19 14:36:06 allender
47 * *** empty log message ***
49 * Revision 1.2 1995/04/18 12:08:30 allender
50 * *** empty log message ***
52 * Revision 1.1 1995/03/09 09:23:04 allender
56 * --- PC RCS information ---
57 * Revision 1.19 1995/01/14 19:18:31 john
58 * Added assert to check for paged out bitmap.
60 * Revision 1.18 1995/01/14 11:32:07 john
61 * Added rle_cache_flush function.
63 * Revision 1.17 1994/12/13 10:58:27 john
64 * Fixed bug with 2 consecutive calls to get_expanded_Texture
65 * with 2 different bitmaps, returning the same rle texture,
66 * causing doors to disapper.
68 * Revision 1.16 1994/11/30 00:55:03 mike
71 * Revision 1.15 1994/11/24 13:24:44 john
72 * Made sure that some rep movs had the cld set first.
73 * Took some unused functions out.
75 * Revision 1.14 1994/11/23 16:03:46 john
76 * Fixed generic rle'ing to use new bit method.
78 * Revision 1.13 1994/11/23 15:45:51 john
79 * Changed to a 3 bit rle scheme.
81 * Revision 1.12 1994/11/18 22:50:24 john
82 * Changed shorts to ints in parameters.
84 * Revision 1.11 1994/11/14 17:06:13 john
87 * Revision 1.10 1994/11/14 15:54:09 john
88 * Put code in for maybe checking bogus rle data.
90 * Revision 1.9 1994/11/14 15:51:58 john
91 * Added rle_disable_caching variable to prove the stability of my rle
92 * caching code to any non-believers.
94 * Revision 1.8 1994/11/10 10:31:20 john
95 * Reduce cache buffers to 16.
97 * Revision 1.7 1994/11/09 19:53:43 john
98 * Added texture rle caching.
100 * Revision 1.6 1994/11/09 17:41:44 john
101 * Made a slow version of rle bitblt to svga, modex.
103 * Revision 1.5 1994/11/09 17:07:50 john
104 * Fixed bug with bitmap that gets bigger with rle.
106 * Revision 1.4 1994/11/09 16:35:17 john
107 * First version with working RLE bitmaps.
109 * Revision 1.3 1994/10/26 12:54:47 john
110 * Fixed bug with decode that used rep movsd instead of
113 * Revision 1.2 1994/10/06 17:05:25 john
114 * First version of rle stuff.
116 * Revision 1.1 1994/10/06 16:53:34 john
128 static char rcsid[] = "$Id: rle.c,v 1.13 2003-01-02 21:32:18 btb Exp $";
146 #define RLE_CODE 0xE0
147 #define NOT_RLE_CODE 31
149 #if !defined(NO_ASM) && defined(__WATCOMC__)
150 #define RLE_DECODE_ASM
152 ubyte *gr_rle_decode_asm( ubyte * src, ubyte * dest );
153 #pragma aux gr_rle_decode_asm parm [esi] [edi] value [edi] modify exact [eax ebx ecx edx esi edi] = \
189 #elif !defined(NO_ASM) && defined(__GNUC__)
190 #define RLE_DECODE_ASM
192 static inline int gr_rle_decode_asm( ubyte * src, ubyte * dest ) {
195 __asm__ __volatile__ (
197 " xorl %%ecx, %%ecx;"
200 " movb %%al,(%%edi);"
203 " movb (%%esi), %%al;"
212 " movb (%%esi), %%al;"
218 " movb %%al, (%%edi);"
222 : "=D" (__ret), "=S" (dummy) : "1" (src), "D" (dest) : "%eax", "%ecx");
226 #elif !defined(NO_ASM) && defined(_MSC_VER)
227 #define RLE_DECODE_ASM
229 __inline int gr_rle_decode_asm( ubyte * src, ubyte * dest )
270 #ifdef RLE_DECODE_ASM
273 void gr_rle_decode( ubyte * src, ubyte * dest, int dest_len )
277 dest_end = (ubyte *)gr_rle_decode_asm( src, dest );
279 Assert(dest_end-src < dest_len);
282 void gr_rle_decode( ubyte * src, ubyte * dest )
284 gr_rle_decode_asm( src, dest );
288 #else // NO_ASM or unknown compiler
290 void gr_rle_decode( ubyte * src, ubyte * dest )
293 ubyte data, count = 0;
297 if ( (data & RLE_CODE) != RLE_CODE ) {
300 count = data & NOT_RLE_CODE;
304 for (i = 0; i < count; i++)
312 void rle_stosb(char *dest, int len, int color);
314 #if !defined(NO_ASM) && defined(__WATCOMC__)
316 #pragma aux rle_stosb = "cld rep stosb" parm [edi] [ecx] [eax] modify exact [edi ecx];
318 #elif !defined(NO_ASM) && defined(__GNUC__)
320 inline void rle_stosb(char *dest, int len, int color) {
322 __asm__ __volatile__ (
324 : "=D" (dummy[0]), "=c" (dummy[1])
325 : "0" (dest), "1" (len), "a" (color) );
328 #elif !defined(NO_ASM) && defined(_MSC_VER)
330 __inline void rle_stosb(char *dest, int len, int color)
341 #else // NO_ASM or unknown compiler
343 void rle_stosb(char *dest, int len, int color)
346 for (i=0; i<len; i++ )
352 // Given pointer to start of one scanline of rle data, uncompress it to
353 // dest, from source pixels x1 to x2.
354 void gr_rle_expand_scanline_masked( ubyte *dest, ubyte *src, int x1, int x2 )
360 if ( x2 < x1 ) return;
365 if ( color == RLE_CODE ) return;
366 if ( (color & RLE_CODE)==RLE_CODE ) {
367 count = color & (~RLE_CODE);
377 // we know have '*count' pixels of 'color'.
379 if ( x1+count > x2 ) {
381 if ( color != TRANSPARENCY_COLOR ) rle_stosb( dest, count, color );
385 if ( color != TRANSPARENCY_COLOR ) rle_stosb( dest, count, color );
391 if ( color == RLE_CODE ) return;
392 if ( (color & RLE_CODE) == (RLE_CODE) ) {
393 count = color & (~RLE_CODE);
399 // we know have '*count' pixels of 'color'.
400 if ( i+count <= x2 ) {
401 if ( color != TRANSPARENCY_COLOR )rle_stosb( dest, count, color );
406 if ( color != TRANSPARENCY_COLOR )rle_stosb( dest, count, color );
414 void gr_rle_expand_scanline( ubyte *dest, ubyte *src, int x1, int x2 )
420 if ( x2 < x1 ) return;
425 if ( color == RLE_CODE ) return;
426 if ( (color & RLE_CODE)==RLE_CODE ) {
427 count = color & (~RLE_CODE);
437 // we know have '*count' pixels of 'color'.
439 if ( x1+count > x2 ) {
441 rle_stosb( dest, count, color );
445 rle_stosb( dest, count, color );
451 if ( color == RLE_CODE ) return;
452 if ( (color & RLE_CODE)==RLE_CODE ) {
453 count = color & (~RLE_CODE);
459 // we know have '*count' pixels of 'color'.
460 if ( i+count <= x2 ) {
461 rle_stosb( dest, count, color );
466 rle_stosb( dest, count, color );
474 int gr_rle_encode( int org_size, ubyte *src, ubyte *dest )
485 for (i=1; i<org_size; i++ ) {
489 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
491 Assert( oc != RLE_CODE );
502 if ( count == NOT_RLE_CODE ) {
510 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
512 Assert( oc != RLE_CODE );
521 return dest-dest_start;
525 int gr_rle_getsize( int org_size, ubyte *src )
535 for (i=1; i<org_size; i++ ) {
539 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
550 if ( count == NOT_RLE_CODE ) {
557 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
569 int gr_bitmap_rle_compress( grs_bitmap * bmp )
576 // first must check to see if this is large bitmap.
578 for (y=0; y<bmp->bm_h; y++ ) {
579 d1= gr_rle_getsize( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y] );
586 rle_data=d_malloc( (bmp->bm_w+1) * bmp->bm_h );
587 if (rle_data==NULL) return 0;
589 doffset = 4 + bmp->bm_h;
591 doffset = 4 + (2 * bmp->bm_h); // each row of rle'd bitmap has short instead of byte offset now
593 for (y=0; y<bmp->bm_h; y++ ) {
594 d1= gr_rle_getsize( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y] );
595 if ( ((doffset+d1) > bmp->bm_w*bmp->bm_h) || (d1 > (large_rle?32767:255) ) ) {
599 d = gr_rle_encode( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y], &rle_data[doffset] );
603 *((short *)&(rle_data[(y*2)+4])) = (short)d;
607 //mprintf( 0, "Bitmap of size %dx%d, (%d bytes) went down to %d bytes\n", bmp->bm_w, bmp->bm_h, bmp->bm_h*bmp->bm_w, doffset );
608 memcpy( rle_data, &doffset, 4 );
609 memcpy( bmp->bm_data, rle_data, doffset );
611 bmp->bm_flags |= BM_FLAG_RLE;
613 bmp->bm_flags |= BM_FLAG_RLE_BIG;
617 #define MAX_CACHE_BITMAPS 32
619 typedef struct rle_cache_element {
620 grs_bitmap * rle_bitmap;
622 grs_bitmap * expanded_bitmap;
626 int rle_cache_initialized = 0;
629 rle_cache_element rle_cache[MAX_CACHE_BITMAPS];
634 void rle_cache_close(void)
636 if (rle_cache_initialized) {
638 rle_cache_initialized = 0;
639 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
640 gr_free_bitmap(rle_cache[i].expanded_bitmap);
645 void rle_cache_init()
648 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
649 rle_cache[i].rle_bitmap = NULL;
650 rle_cache[i].expanded_bitmap = gr_create_bitmap( 64, 64 );
651 rle_cache[i].last_used = 0;
652 Assert( rle_cache[i].expanded_bitmap != NULL );
654 rle_cache_initialized = 1;
655 atexit( rle_cache_close );
658 void rle_cache_flush()
661 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
662 rle_cache[i].rle_bitmap = NULL;
663 rle_cache[i].last_used = 0;
667 void rle_expand_texture_sub( grs_bitmap * bmp, grs_bitmap * rle_temp_bitmap_1 )
669 unsigned char * dbits;
670 unsigned char * sbits;
672 #ifdef RLE_DECODE_ASM
673 unsigned char * dbits1;
677 Assert (bmp->iMagic == BM_MAGIC_NUMBER);
680 sbits = &bmp->bm_data[4 + bmp->bm_h];
681 dbits = rle_temp_bitmap_1->bm_data;
683 rle_temp_bitmap_1->bm_flags = bmp->bm_flags & (~BM_FLAG_RLE);
685 for (i=0; i < bmp->bm_h; i++ ) {
686 #ifdef RLE_DECODE_ASM
687 dbits1=(unsigned char *)gr_rle_decode_asm( sbits, dbits );
689 gr_rle_decode( sbits, dbits );
691 sbits += (int)bmp->bm_data[4+i];
693 #ifdef RLE_DECODE_ASM
694 Assert( dbits == dbits1 ); // Get John, bogus rle data!
698 gr_set_bitmap_data (rle_temp_bitmap_1, rle_temp_bitmap_1->bm_data);
702 #if defined(POLY_ACC)
703 grs_bitmap *rle_get_id_sub(grs_bitmap *bmp)
707 for (i=0;i<MAX_CACHE_BITMAPS;i++) {
708 if (rle_cache[i].expanded_bitmap == bmp) {
709 return rle_cache[i].rle_bitmap;
717 grs_bitmap * rle_expand_texture( grs_bitmap * bmp )
720 int lowest_count, lc;
721 int least_recently_used;
723 if (!rle_cache_initialized) rle_cache_init();
725 Assert( !(bmp->bm_flags & BM_FLAG_PAGED_OUT) );
729 if ( rle_counter < lc ) {
730 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
731 rle_cache[i].rle_bitmap = NULL;
732 rle_cache[i].last_used = 0;
736 // if (((rle_counter % 100)==1) && (rle_hits+rle_misses > 0))
737 // mprintf(( 0, "RLE-CACHE %d%%, H:%d, M:%d\n", (rle_misses*100)/(rle_hits+rle_misses), rle_hits, rle_misses ));
739 lowest_count = rle_cache[rle_next].last_used;
740 least_recently_used = rle_next;
742 if ( rle_next >= MAX_CACHE_BITMAPS )
745 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
746 if (rle_cache[i].rle_bitmap == bmp) {
748 rle_cache[i].last_used = rle_counter;
749 return rle_cache[i].expanded_bitmap;
751 if ( rle_cache[i].last_used < lowest_count ) {
752 lowest_count = rle_cache[i].last_used;
753 least_recently_used = i;
757 Assert(bmp->bm_w<=64 && bmp->bm_h<=64); //dest buffer is 64x64
759 rle_expand_texture_sub( bmp, rle_cache[least_recently_used].expanded_bitmap );
760 rle_cache[least_recently_used].rle_bitmap = bmp;
761 rle_cache[least_recently_used].last_used = rle_counter;
762 return rle_cache[least_recently_used].expanded_bitmap;
766 void gr_rle_expand_scanline_generic( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
772 if ( x2 < x1 ) return;
777 if ( color == RLE_CODE ) return;
778 if ( (color & RLE_CODE) == RLE_CODE ) {
779 count = color & NOT_RLE_CODE;
789 // we know have '*count' pixels of 'color'.
791 if ( x1+count > x2 ) {
793 for ( j=0; j<count; j++ )
794 gr_bm_pixel( dest, dx++, dy, color );
798 for ( j=0; j<count; j++ )
799 gr_bm_pixel( dest, dx++, dy, color );
804 if ( color == RLE_CODE ) return;
805 if ( (color & RLE_CODE) == RLE_CODE ) {
806 count = color & NOT_RLE_CODE;
812 // we know have '*count' pixels of 'color'.
813 if ( i+count <= x2 ) {
814 for ( j=0; j<count; j++ )
815 gr_bm_pixel( dest, dx++, dy, color );
819 for ( j=0; j<count; j++ )
820 gr_bm_pixel( dest, dx++, dy, color );
826 void gr_rle_expand_scanline_generic_masked( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
832 if ( x2 < x1 ) return;
837 if ( color == RLE_CODE ) return;
838 if ( (color & RLE_CODE) == RLE_CODE ) {
839 count = color & NOT_RLE_CODE;
849 // we know have '*count' pixels of 'color'.
851 if ( x1+count > x2 ) {
853 if (color != TRANSPARENCY_COLOR) {
854 for ( j=0; j<count; j++ )
855 gr_bm_pixel( dest, dx++, dy, color );
860 if ( color != TRANSPARENCY_COLOR ) {
861 for ( j=0; j<count; j++ )
862 gr_bm_pixel( dest, dx++, dy, color );
869 if ( color == RLE_CODE ) return;
870 if ( (color & RLE_CODE) == RLE_CODE ) {
871 count = color & NOT_RLE_CODE;
877 // we know have '*count' pixels of 'color'.
878 if ( i+count <= x2 ) {
879 if ( color != TRANSPARENCY_COLOR ) {
880 for ( j=0; j<count; j++ )
881 gr_bm_pixel( dest, dx++, dy, color );
887 if ( color != TRANSPARENCY_COLOR ) {
888 for ( j=0; j<count; j++ )
889 gr_bm_pixel( dest, dx++, dy, color );
899 void gr_rle_expand_scanline_svga_masked( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
904 ubyte * vram = (ubyte *)0xA0000;
905 int VideoLocation,page,offset;
907 if ( x2 < x1 ) return;
909 VideoLocation = (unsigned int)dest->bm_data + (dest->bm_rowsize * dy) + dx;
910 page = VideoLocation >> 16;
911 offset = VideoLocation & 0xFFFF;
913 gr_vesa_setpage( page );
915 if ( (offset + (x2-x1+1)) < 65536 ) {
916 // We don't cross a svga page, so blit it fast!
917 gr_rle_expand_scanline_masked( &vram[offset], src, x1, x2 );
924 if ( color == RLE_CODE ) return;
925 if ( (color & RLE_CODE) == RLE_CODE ) {
926 count = color & NOT_RLE_CODE;
936 // we know have '*count' pixels of 'color'.
938 if ( x1+count > x2 ) {
940 if (color != TRANSPARENCY_COLOR) {
941 for ( j=0; j<count; j++ ) {
942 vram[offset++] = color;
943 if ( offset >= 65536 ) {
946 gr_vesa_setpage(page);
953 if ( color != TRANSPARENCY_COLOR ) {
954 for ( j=0; j<count; j++ ) {
955 vram[offset++] = color;
956 if ( offset >= 65536 ) {
959 gr_vesa_setpage(page);
964 if ( offset >= 65536 ) {
967 gr_vesa_setpage(page);
974 if ( color == RLE_CODE ) return;
975 if ( (color & RLE_CODE) == RLE_CODE ) {
976 count = color & NOT_RLE_CODE;
982 // we know have '*count' pixels of 'color'.
983 if ( i+count <= x2 ) {
984 if ( color != TRANSPARENCY_COLOR ) {
985 for ( j=0; j<count; j++ ) {
986 vram[offset++] = color;
987 if ( offset >= 65536 ) {
990 gr_vesa_setpage(page);
995 if ( offset >= 65536 ) {
998 gr_vesa_setpage(page);
1004 if ( color != TRANSPARENCY_COLOR ) {
1005 for ( j=0; j<count; j++ ) {
1006 vram[offset++] = color;
1007 if ( offset >= 65536 ) {
1010 gr_vesa_setpage(page);
1015 if ( offset >= 65536 ) {
1018 gr_vesa_setpage(page);
1029 * swaps entries 0 and 255 in an RLE bitmap without uncompressing it
1031 void rle_swap_0_255(grs_bitmap *bmp)
1033 int i, j, len, rle_big;
1034 unsigned char *ptr, *ptr2, *temp, *start;
1035 unsigned short line_size;
1037 rle_big = bmp->bm_flags & BM_FLAG_RLE_BIG;
1039 temp = d_malloc(4 + bmp->bm_h + (bmp->bm_w + 1) * bmp->bm_h);
1041 if (rle_big) { // set ptrs to first lines
1042 ptr = bmp->bm_data + 4 + 2 * bmp->bm_h;
1043 ptr2 = temp + 4 + 2 * bmp->bm_h;
1045 ptr = bmp->bm_data + 4 + bmp->bm_h;
1046 ptr2 = temp + 4 + bmp->bm_h;
1048 for (i = 0; i < bmp->bm_h; i++) {
1051 line_size = *((unsigned short *)&bmp->bm_data[4 + 2 * i]);
1053 line_size = bmp->bm_data[4 + i];
1054 for (j = 0; j < line_size; j++) {
1055 if ((ptr[j] & RLE_CODE) != RLE_CODE) {
1057 *ptr2++ = RLE_CODE | 1;
1063 if ((ptr[j] & NOT_RLE_CODE) == 0)
1068 else if (ptr[j] == 255)
1074 if (rle_big) // set line size
1075 *((unsigned short *)&temp[4 + 2 * i]) = ptr2 - start;
1077 temp[4 + i] = ptr2 - start;
1078 ptr += line_size; // go to next line
1081 *((int *)temp) = len; // set total size
1082 memcpy(bmp->bm_data, temp, len);