1 /* $Id: rle.c,v 1.14 2003-03-14 09:19:48 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.14 2003-03-14 09:19:48 btb Exp $";
145 #include "byteswap.h"
147 #define RLE_CODE 0xE0
148 #define NOT_RLE_CODE 31
150 #if !defined(NO_ASM) && defined(__WATCOMC__)
151 #define RLE_DECODE_ASM
153 ubyte *gr_rle_decode_asm( ubyte * src, ubyte * dest );
154 #pragma aux gr_rle_decode_asm parm [esi] [edi] value [edi] modify exact [eax ebx ecx edx esi edi] = \
190 #elif !defined(NO_ASM) && defined(__GNUC__)
191 #define RLE_DECODE_ASM
193 static inline int gr_rle_decode_asm( ubyte * src, ubyte * dest ) {
196 __asm__ __volatile__ (
198 " xorl %%ecx, %%ecx;"
201 " movb %%al,(%%edi);"
204 " movb (%%esi), %%al;"
213 " movb (%%esi), %%al;"
219 " movb %%al, (%%edi);"
223 : "=D" (__ret), "=S" (dummy) : "1" (src), "D" (dest) : "%eax", "%ecx");
227 #elif !defined(NO_ASM) && defined(_MSC_VER)
228 #define RLE_DECODE_ASM
230 __inline int gr_rle_decode_asm( ubyte * src, ubyte * dest )
271 #ifdef RLE_DECODE_ASM
274 void gr_rle_decode( ubyte * src, ubyte * dest, int dest_len )
278 dest_end = (ubyte *)gr_rle_decode_asm( src, dest );
280 Assert(dest_end-src < dest_len);
283 void gr_rle_decode( ubyte * src, ubyte * dest )
285 gr_rle_decode_asm( src, dest );
289 #else // NO_ASM or unknown compiler
291 void gr_rle_decode( ubyte * src, ubyte * dest )
294 ubyte data, count = 0;
298 if ( (data & RLE_CODE) != RLE_CODE ) {
301 count = data & NOT_RLE_CODE;
305 for (i = 0; i < count; i++)
313 void rle_stosb(char *dest, int len, int color);
315 #if !defined(NO_ASM) && defined(__WATCOMC__)
317 #pragma aux rle_stosb = "cld rep stosb" parm [edi] [ecx] [eax] modify exact [edi ecx];
319 #elif !defined(NO_ASM) && defined(__GNUC__)
321 inline void rle_stosb(char *dest, int len, int color) {
323 __asm__ __volatile__ (
325 : "=D" (dummy[0]), "=c" (dummy[1])
326 : "0" (dest), "1" (len), "a" (color) );
329 #elif !defined(NO_ASM) && defined(_MSC_VER)
331 __inline void rle_stosb(char *dest, int len, int color)
342 #else // NO_ASM or unknown compiler
344 void rle_stosb(char *dest, int len, int color)
347 for (i=0; i<len; i++ )
353 // Given pointer to start of one scanline of rle data, uncompress it to
354 // dest, from source pixels x1 to x2.
355 void gr_rle_expand_scanline_masked( ubyte *dest, ubyte *src, int x1, int x2 )
361 if ( x2 < x1 ) return;
366 if ( color == RLE_CODE ) return;
367 if ( (color & RLE_CODE)==RLE_CODE ) {
368 count = color & (~RLE_CODE);
378 // we know have '*count' pixels of 'color'.
380 if ( x1+count > x2 ) {
382 if ( color != TRANSPARENCY_COLOR ) rle_stosb( dest, count, color );
386 if ( color != TRANSPARENCY_COLOR ) rle_stosb( dest, count, color );
392 if ( color == RLE_CODE ) return;
393 if ( (color & RLE_CODE) == (RLE_CODE) ) {
394 count = color & (~RLE_CODE);
400 // we know have '*count' pixels of 'color'.
401 if ( i+count <= x2 ) {
402 if ( color != TRANSPARENCY_COLOR )rle_stosb( dest, count, color );
407 if ( color != TRANSPARENCY_COLOR )rle_stosb( dest, count, color );
415 void gr_rle_expand_scanline( ubyte *dest, ubyte *src, int x1, int x2 )
421 if ( x2 < x1 ) return;
426 if ( color == RLE_CODE ) return;
427 if ( (color & RLE_CODE)==RLE_CODE ) {
428 count = color & (~RLE_CODE);
438 // we know have '*count' pixels of 'color'.
440 if ( x1+count > x2 ) {
442 rle_stosb( dest, count, color );
446 rle_stosb( dest, count, color );
452 if ( color == RLE_CODE ) return;
453 if ( (color & RLE_CODE)==RLE_CODE ) {
454 count = color & (~RLE_CODE);
460 // we know have '*count' pixels of 'color'.
461 if ( i+count <= x2 ) {
462 rle_stosb( dest, count, color );
467 rle_stosb( dest, count, color );
475 int gr_rle_encode( int org_size, ubyte *src, ubyte *dest )
486 for (i=1; i<org_size; i++ ) {
490 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
492 Assert( oc != RLE_CODE );
503 if ( count == NOT_RLE_CODE ) {
511 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
513 Assert( oc != RLE_CODE );
522 return dest-dest_start;
526 int gr_rle_getsize( int org_size, ubyte *src )
536 for (i=1; i<org_size; i++ ) {
540 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
551 if ( count == NOT_RLE_CODE ) {
558 if ( (count==1) && ((oc & RLE_CODE)!=RLE_CODE) ) {
570 int gr_bitmap_rle_compress( grs_bitmap * bmp )
577 // first must check to see if this is large bitmap.
579 for (y=0; y<bmp->bm_h; y++ ) {
580 d1= gr_rle_getsize( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y] );
587 rle_data=d_malloc( (bmp->bm_w+1) * bmp->bm_h );
588 if (rle_data==NULL) return 0;
590 doffset = 4 + bmp->bm_h;
592 doffset = 4 + (2 * bmp->bm_h); // each row of rle'd bitmap has short instead of byte offset now
594 for (y=0; y<bmp->bm_h; y++ ) {
595 d1= gr_rle_getsize( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y] );
596 if ( ((doffset+d1) > bmp->bm_w*bmp->bm_h) || (d1 > (large_rle?32767:255) ) ) {
600 d = gr_rle_encode( bmp->bm_w, &bmp->bm_data[bmp->bm_w*y], &rle_data[doffset] );
604 *((short *)&(rle_data[(y*2)+4])) = (short)d;
608 //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 );
609 memcpy( rle_data, &doffset, 4 );
610 memcpy( bmp->bm_data, rle_data, doffset );
612 bmp->bm_flags |= BM_FLAG_RLE;
614 bmp->bm_flags |= BM_FLAG_RLE_BIG;
618 #define MAX_CACHE_BITMAPS 32
620 typedef struct rle_cache_element {
621 grs_bitmap * rle_bitmap;
623 grs_bitmap * expanded_bitmap;
627 int rle_cache_initialized = 0;
630 rle_cache_element rle_cache[MAX_CACHE_BITMAPS];
635 void rle_cache_close(void)
637 if (rle_cache_initialized) {
639 rle_cache_initialized = 0;
640 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
641 gr_free_bitmap(rle_cache[i].expanded_bitmap);
646 void rle_cache_init()
649 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
650 rle_cache[i].rle_bitmap = NULL;
651 rle_cache[i].expanded_bitmap = gr_create_bitmap( 64, 64 );
652 rle_cache[i].last_used = 0;
653 Assert( rle_cache[i].expanded_bitmap != NULL );
655 rle_cache_initialized = 1;
656 atexit( rle_cache_close );
659 void rle_cache_flush()
662 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
663 rle_cache[i].rle_bitmap = NULL;
664 rle_cache[i].last_used = 0;
668 void rle_expand_texture_sub( grs_bitmap * bmp, grs_bitmap * rle_temp_bitmap_1 )
670 unsigned char * dbits;
671 unsigned char * sbits;
673 #ifdef RLE_DECODE_ASM
674 unsigned char * dbits1;
678 Assert (bmp->iMagic == BM_MAGIC_NUMBER);
681 sbits = &bmp->bm_data[4 + bmp->bm_h];
682 dbits = rle_temp_bitmap_1->bm_data;
684 rle_temp_bitmap_1->bm_flags = bmp->bm_flags & (~BM_FLAG_RLE);
686 for (i=0; i < bmp->bm_h; i++ ) {
687 #ifdef RLE_DECODE_ASM
688 dbits1=(unsigned char *)gr_rle_decode_asm( sbits, dbits );
690 gr_rle_decode( sbits, dbits );
692 sbits += (int)bmp->bm_data[4+i];
694 #ifdef RLE_DECODE_ASM
695 Assert( dbits == dbits1 ); // Get John, bogus rle data!
699 gr_set_bitmap_data (rle_temp_bitmap_1, rle_temp_bitmap_1->bm_data);
703 #if defined(POLY_ACC)
704 grs_bitmap *rle_get_id_sub(grs_bitmap *bmp)
708 for (i=0;i<MAX_CACHE_BITMAPS;i++) {
709 if (rle_cache[i].expanded_bitmap == bmp) {
710 return rle_cache[i].rle_bitmap;
718 grs_bitmap * rle_expand_texture( grs_bitmap * bmp )
721 int lowest_count, lc;
722 int least_recently_used;
724 if (!rle_cache_initialized) rle_cache_init();
726 Assert( !(bmp->bm_flags & BM_FLAG_PAGED_OUT) );
730 if ( rle_counter < lc ) {
731 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
732 rle_cache[i].rle_bitmap = NULL;
733 rle_cache[i].last_used = 0;
737 // if (((rle_counter % 100)==1) && (rle_hits+rle_misses > 0))
738 // mprintf(( 0, "RLE-CACHE %d%%, H:%d, M:%d\n", (rle_misses*100)/(rle_hits+rle_misses), rle_hits, rle_misses ));
740 lowest_count = rle_cache[rle_next].last_used;
741 least_recently_used = rle_next;
743 if ( rle_next >= MAX_CACHE_BITMAPS )
746 for (i=0; i<MAX_CACHE_BITMAPS; i++ ) {
747 if (rle_cache[i].rle_bitmap == bmp) {
749 rle_cache[i].last_used = rle_counter;
750 return rle_cache[i].expanded_bitmap;
752 if ( rle_cache[i].last_used < lowest_count ) {
753 lowest_count = rle_cache[i].last_used;
754 least_recently_used = i;
758 Assert(bmp->bm_w<=64 && bmp->bm_h<=64); //dest buffer is 64x64
760 rle_expand_texture_sub( bmp, rle_cache[least_recently_used].expanded_bitmap );
761 rle_cache[least_recently_used].rle_bitmap = bmp;
762 rle_cache[least_recently_used].last_used = rle_counter;
763 return rle_cache[least_recently_used].expanded_bitmap;
767 void gr_rle_expand_scanline_generic( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
773 if ( x2 < x1 ) return;
778 if ( color == RLE_CODE ) return;
779 if ( (color & RLE_CODE) == RLE_CODE ) {
780 count = color & NOT_RLE_CODE;
790 // we know have '*count' pixels of 'color'.
792 if ( x1+count > x2 ) {
794 for ( j=0; j<count; j++ )
795 gr_bm_pixel( dest, dx++, dy, color );
799 for ( j=0; j<count; j++ )
800 gr_bm_pixel( dest, dx++, dy, color );
805 if ( color == RLE_CODE ) return;
806 if ( (color & RLE_CODE) == RLE_CODE ) {
807 count = color & NOT_RLE_CODE;
813 // we know have '*count' pixels of 'color'.
814 if ( i+count <= x2 ) {
815 for ( j=0; j<count; j++ )
816 gr_bm_pixel( dest, dx++, dy, color );
820 for ( j=0; j<count; j++ )
821 gr_bm_pixel( dest, dx++, dy, color );
827 void gr_rle_expand_scanline_generic_masked( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
833 if ( x2 < x1 ) return;
838 if ( color == RLE_CODE ) return;
839 if ( (color & RLE_CODE) == RLE_CODE ) {
840 count = color & NOT_RLE_CODE;
850 // we know have '*count' pixels of 'color'.
852 if ( x1+count > x2 ) {
854 if (color != TRANSPARENCY_COLOR) {
855 for ( j=0; j<count; j++ )
856 gr_bm_pixel( dest, dx++, dy, color );
861 if ( color != TRANSPARENCY_COLOR ) {
862 for ( j=0; j<count; j++ )
863 gr_bm_pixel( dest, dx++, dy, color );
870 if ( color == RLE_CODE ) return;
871 if ( (color & RLE_CODE) == RLE_CODE ) {
872 count = color & NOT_RLE_CODE;
878 // we know have '*count' pixels of 'color'.
879 if ( i+count <= x2 ) {
880 if ( color != TRANSPARENCY_COLOR ) {
881 for ( j=0; j<count; j++ )
882 gr_bm_pixel( dest, dx++, dy, color );
888 if ( color != TRANSPARENCY_COLOR ) {
889 for ( j=0; j<count; j++ )
890 gr_bm_pixel( dest, dx++, dy, color );
900 void gr_rle_expand_scanline_svga_masked( grs_bitmap * dest, int dx, int dy, ubyte *src, int x1, int x2 )
905 ubyte * vram = (ubyte *)0xA0000;
906 int VideoLocation,page,offset;
908 if ( x2 < x1 ) return;
910 VideoLocation = (unsigned int)dest->bm_data + (dest->bm_rowsize * dy) + dx;
911 page = VideoLocation >> 16;
912 offset = VideoLocation & 0xFFFF;
914 gr_vesa_setpage( page );
916 if ( (offset + (x2-x1+1)) < 65536 ) {
917 // We don't cross a svga page, so blit it fast!
918 gr_rle_expand_scanline_masked( &vram[offset], src, x1, x2 );
925 if ( color == RLE_CODE ) return;
926 if ( (color & RLE_CODE) == RLE_CODE ) {
927 count = color & NOT_RLE_CODE;
937 // we know have '*count' pixels of 'color'.
939 if ( x1+count > x2 ) {
941 if (color != TRANSPARENCY_COLOR) {
942 for ( j=0; j<count; j++ ) {
943 vram[offset++] = color;
944 if ( offset >= 65536 ) {
947 gr_vesa_setpage(page);
954 if ( color != TRANSPARENCY_COLOR ) {
955 for ( j=0; j<count; j++ ) {
956 vram[offset++] = color;
957 if ( offset >= 65536 ) {
960 gr_vesa_setpage(page);
965 if ( offset >= 65536 ) {
968 gr_vesa_setpage(page);
975 if ( color == RLE_CODE ) return;
976 if ( (color & RLE_CODE) == RLE_CODE ) {
977 count = color & NOT_RLE_CODE;
983 // we know have '*count' pixels of 'color'.
984 if ( i+count <= x2 ) {
985 if ( color != TRANSPARENCY_COLOR ) {
986 for ( j=0; j<count; j++ ) {
987 vram[offset++] = color;
988 if ( offset >= 65536 ) {
991 gr_vesa_setpage(page);
996 if ( offset >= 65536 ) {
999 gr_vesa_setpage(page);
1005 if ( color != TRANSPARENCY_COLOR ) {
1006 for ( j=0; j<count; j++ ) {
1007 vram[offset++] = color;
1008 if ( offset >= 65536 ) {
1011 gr_vesa_setpage(page);
1016 if ( offset >= 65536 ) {
1019 gr_vesa_setpage(page);
1030 * swaps entries 0 and 255 in an RLE bitmap without uncompressing it
1032 void rle_swap_0_255(grs_bitmap *bmp)
1034 int i, j, len, rle_big;
1035 unsigned char *ptr, *ptr2, *temp, *start;
1036 unsigned short line_size;
1038 rle_big = bmp->bm_flags & BM_FLAG_RLE_BIG;
1040 temp = d_malloc(4 + bmp->bm_h + (bmp->bm_w + 1) * bmp->bm_h);
1042 if (rle_big) { // set ptrs to first lines
1043 ptr = bmp->bm_data + 4 + 2 * bmp->bm_h;
1044 ptr2 = temp + 4 + 2 * bmp->bm_h;
1046 ptr = bmp->bm_data + 4 + bmp->bm_h;
1047 ptr2 = temp + 4 + bmp->bm_h;
1049 for (i = 0; i < bmp->bm_h; i++) {
1052 line_size = INTEL_SHORT(*((unsigned short *)&bmp->bm_data[4 + 2 * i]));
1054 line_size = bmp->bm_data[4 + i];
1055 for (j = 0; j < line_size; j++) {
1056 if ((ptr[j] & RLE_CODE) != RLE_CODE) {
1058 *ptr2++ = RLE_CODE | 1;
1064 if ((ptr[j] & NOT_RLE_CODE) == 0)
1069 else if (ptr[j] == 255)
1075 if (rle_big) // set line size
1076 *((unsigned short *)&temp[4 + 2 * i]) = INTEL_SHORT(ptr2 - start);
1078 temp[4 + i] = ptr2 - start;
1079 ptr += line_size; // go to next line
1082 *((int *)temp) = len; // set total size
1083 memcpy(bmp->bm_data, temp, len);