2 * $Id: texcache.c,v 1.8 2006-09-12 13:33:18 nkeynes Exp $
4 * Texture cache. Responsible for maintaining a working set of OpenGL
8 * Copyright (c) 2005 Nathan Keynes.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
22 #include "pvr2/pvr2.h"
24 /** Specifies the maximum number of OpenGL
25 * textures we're willing to have open at a time. If more are
26 * needed, textures will be evicted in LRU order.
28 #define MAX_TEXTURES 64
34 * find entry by texture_addr
36 * move entry to tail of lru list
40 typedef signed short texcache_entry_index;
41 #define EMPTY_ENTRY 0xFF
43 static texcache_entry_index texcache_free_ptr = 0;
44 static GLuint texcache_free_list[MAX_TEXTURES];
46 typedef struct texcache_entry {
47 uint32_t texture_addr;
48 int width, height, mode;
50 texcache_entry_index next;
54 static uint8_t texcache_page_lookup[PVR2_RAM_PAGES];
55 static uint32_t texcache_ref_counter;
56 static struct texcache_entry texcache_active_list[MAX_TEXTURES];
59 * Initialize the texture cache.
64 for( i=0; i<PVR2_RAM_PAGES; i++ ) {
65 texcache_page_lookup[i] = EMPTY_ENTRY;
67 for( i=0; i<MAX_TEXTURES; i++ ) {
68 texcache_free_list[i] = i;
70 texcache_free_ptr = 0;
71 texcache_ref_counter = 0;
75 * Setup the initial texture ids (must be called after the GL context is
78 void texcache_gl_init( )
81 GLuint texids[MAX_TEXTURES];
83 glGenTextures( MAX_TEXTURES, texids );
84 for( i=0; i<MAX_TEXTURES; i++ ) {
85 texcache_active_list[i].texture_id = texids[i];
90 * Flush all textures from the cache, returning them to the free list.
92 void texcache_flush( )
95 /* clear structures */
96 for( i=0; i<PVR2_RAM_PAGES; i++ ) {
97 texcache_page_lookup[i] = EMPTY_ENTRY;
99 for( i=0; i<MAX_TEXTURES; i++ ) {
100 texcache_free_list[i] = i;
102 texcache_free_ptr = 0;
103 texcache_ref_counter = 0;
107 * Flush all textures and delete. The cache will be non-functional until
108 * the next call to texcache_init(). This would typically be done if
109 * switching GL targets.
111 void texcache_shutdown( )
113 GLuint texids[MAX_TEXTURES];
117 for( i=0; i<MAX_TEXTURES; i++ ) {
118 texids[i] = texcache_active_list[i].texture_id;
120 glDeleteTextures( MAX_TEXTURES, texids );
124 * Evict all textures contained in the page identified by a texture address.
126 void texcache_invalidate_page( uint32_t texture_addr ) {
127 uint32_t texture_page = texture_addr >> 12;
128 texcache_entry_index idx = texcache_page_lookup[texture_page];
129 if( idx == EMPTY_ENTRY )
131 assert( texcache_free_ptr >= 0 );
133 texcache_entry_t entry = &texcache_active_list[idx];
136 texcache_free_list[texcache_free_ptr] = idx;
138 entry->next = EMPTY_ENTRY;
139 } while( idx != EMPTY_ENTRY );
140 texcache_page_lookup[texture_page] = EMPTY_ENTRY;
144 * Evict a single texture from the cache.
145 * @return the slot of the evicted texture.
147 static texcache_entry_index texcache_evict( void )
149 /* Full table scan - take over the entry with the lowest lru value */
150 texcache_entry_index slot = 0;
151 int lru_value = texcache_active_list[0].lru_count;
153 for( i=1; i<MAX_TEXTURES; i++ ) {
154 /* FIXME: account for rollover */
155 if( texcache_active_list[i].lru_count < lru_value ) {
157 lru_value = texcache_active_list[i].lru_count;
161 /* Remove the selected slot from the lookup table */
162 uint32_t evict_page = texcache_active_list[slot].texture_addr;
163 texcache_entry_index replace_next = texcache_active_list[slot].next;
164 texcache_active_list[slot].next = EMPTY_ENTRY; /* Just for safety */
165 if( texcache_page_lookup[evict_page] == slot ) {
166 texcache_page_lookup[evict_page] = replace_next;
168 texcache_entry_index idx = texcache_page_lookup[evict_page];
169 texcache_entry_index next;
171 next = texcache_active_list[idx].next;
173 texcache_active_list[idx].next = replace_next;
177 } while( next != EMPTY_ENTRY );
182 static void detwiddle_pal8_to_32(int x1, int y1, int size, int totsize,
183 char **in, uint32_t *out, uint32_t *pal) {
185 out[y1 * totsize + x1] = pal[**in];
189 detwiddle_pal8_to_32(x1, y1, ns, totsize, in, out, pal);
190 detwiddle_pal8_to_32(x1, y1+ns, ns, totsize, in, out, pal);
191 detwiddle_pal8_to_32(x1+ns, y1, ns, totsize, in, out, pal);
192 detwiddle_pal8_to_32(x1+ns, y1+ns, ns, totsize, in, out, pal);
196 static void detwiddle_pal8_to_16(int x1, int y1, int size, int totsize,
197 char **in, uint16_t *out, uint16_t *pal) {
199 out[y1 * totsize + x1] = pal[**in];
203 detwiddle_pal8_to_16(x1, y1, ns, totsize, in, out, pal);
204 detwiddle_pal8_to_16(x1, y1+ns, ns, totsize, in, out, pal);
205 detwiddle_pal8_to_16(x1+ns, y1, ns, totsize, in, out, pal);
206 detwiddle_pal8_to_16(x1+ns, y1+ns, ns, totsize, in, out, pal);
210 static void detwiddle_16_to_16(int x1, int y1, int size, int totsize,
211 uint16_t **in, uint16_t *out ) {
213 out[y1 * totsize + x1] = **in;
217 detwiddle_16_to_16(x1, y1, ns, totsize, in, out);
218 detwiddle_16_to_16(x1, y1+ns, ns, totsize, in, out);
219 detwiddle_16_to_16(x1+ns, y1, ns, totsize, in, out);
220 detwiddle_16_to_16(x1+ns, y1+ns, ns, totsize, in, out);
224 #define VQ_CODEBOOK_SIZE 2048 /* 256 entries * 4 pixels per quad * 2 byte pixels */
227 uint16_t quad[256][4];
230 static void detwiddle_vq_to_16(int x1, int y1, int size, int totsize,
231 uint8_t **in, uint16_t *out, struct vq_codebook *codebook ) {
235 out[y1 * totsize + x1] = codebook->quad[code][0];
236 out[y1 * totsize + x1 + 1] = codebook->quad[code][1];
237 out[(y1+1) * totsize + x1] = codebook->quad[code][2];
238 out[(y1+1) * totsize + x1 + 1] = codebook->quad[code][3];
241 detwiddle_vq_to_16(x1, y1, ns, totsize, in, out, codebook);
242 detwiddle_vq_to_16(x1, y1+ns, ns, totsize, in, out, codebook);
243 detwiddle_vq_to_16(x1+ns, y1, ns, totsize, in, out, codebook);
244 detwiddle_vq_to_16(x1+ns, y1+ns, ns, totsize, in, out, codebook);
248 static void vq_decode( int width, int height, char *input, uint16_t *output,
250 struct vq_codebook codebook;
253 /* Detwiddle the codebook, for the sake of my own sanity if nothing else */
254 uint16_t *p = (uint16_t *)input;
255 for( i=0; i<256; i++ ) {
256 codebook.quad[i][0] = *p++;
257 codebook.quad[i][2] = *p++;
258 codebook.quad[i][1] = *p++;
259 codebook.quad[i][3] = *p++;
262 uint8_t *c = (uint8_t *)p;
264 detwiddle_vq_to_16( 0, 0, width, width, &c, output, &codebook );
266 for( j=0; j<height; j+=2 ) {
267 for( i=0; i<width; i+=2 ) {
269 output[i + j*width] = codebook.quad[code][0];
270 output[i + 1 + j*width] = codebook.quad[code][1];
271 output[i + (j+1)*width] = codebook.quad[code][2];
272 output[i + 1 + (j+1)*width] = codebook.quad[code][3];
279 * Load texture data from the given address and parameters into the currently
280 * bound OpenGL texture.
282 static texcache_load_texture( uint32_t texture_addr, int width, int height,
284 uint32_t bytes = width * height;
286 GLint intFormat, format, type;
287 int tex_format = mode & PVR2_TEX_FORMAT_MASK;
289 if( tex_format == PVR2_TEX_FORMAT_IDX8 ||
290 tex_format == PVR2_TEX_FORMAT_IDX4 ) {
291 switch( MMIO_READ( PVR2, RENDER_PALETTE ) & 0x03 ) {
292 case 0: /* ARGB1555 */
293 intFormat = GL_RGB5_A1;
295 type = GL_UNSIGNED_SHORT_1_5_5_5_REV;
300 type = GL_UNSIGNED_SHORT_5_6_5_REV;
303 intFormat = GL_RGBA4;
305 type = GL_UNSIGNED_SHORT_4_4_4_4_REV;
308 intFormat = GL_RGBA8;
310 type = GL_UNSIGNED_INT_8_8_8_8_REV;
315 if( tex_format == PVR2_TEX_FORMAT_IDX8 ) {
316 unsigned char data[bytes<<shift];
317 int bank = (mode >> 25) &0x03;
318 char *palette = mmio_region_PVR2PAL.mem + (bank * (256 << shift));
323 pvr2_vram64_read( tmp, texture_addr, bytes );
324 detwiddle_pal8_to_32( 0, 0, width, width, &p,
325 (uint32_t *)data, (uint32_t *)palette );
329 pvr2_vram64_read( tmp, texture_addr, bytes );
330 detwiddle_pal8_to_16( 0, 0, width, width, &p,
331 (uint16_t *)data, (uint16_t *)palette );
333 glTexImage2D( GL_TEXTURE_2D, 0, intFormat, width, height, 0, format, type,
338 switch( tex_format ) {
339 case PVR2_TEX_FORMAT_ARGB1555:
341 intFormat = GL_RGB5_A1;
343 type = GL_UNSIGNED_SHORT_1_5_5_5_REV;
345 case PVR2_TEX_FORMAT_RGB565:
349 type = GL_UNSIGNED_SHORT_5_6_5_REV;
351 case PVR2_TEX_FORMAT_ARGB4444:
353 intFormat = GL_RGBA4;
355 type = GL_UNSIGNED_SHORT_4_4_4_4_REV;
357 case PVR2_TEX_FORMAT_YUV422:
358 ERROR( "YUV textures not supported" );
360 case PVR2_TEX_FORMAT_BUMPMAP:
361 ERROR( "Bumpmap not supported" );
363 case PVR2_TEX_FORMAT_IDX4:
366 intFormat = GL_INTENSITY4;
367 format = GL_COLOR_INDEX;
368 type = GL_UNSIGNED_BYTE;
371 case PVR2_TEX_FORMAT_IDX8:
372 intFormat = GL_INTENSITY8;
373 format = GL_COLOR_INDEX;
374 type = GL_UNSIGNED_BYTE;
380 /* load data from image, detwiddling/uncompressing as required */
381 if( PVR2_TEX_IS_COMPRESSED(mode) ) {
382 int inputlength = VQ_CODEBOOK_SIZE +
383 ((width*height) >> 2); /* + mip maps */
385 pvr2_vram64_read( tmp, texture_addr, inputlength );
386 vq_decode( width, height, tmp, (uint16_t *)&data, PVR2_TEX_IS_TWIDDLED(mode) );
387 } else if( PVR2_TEX_IS_TWIDDLED(mode) ) {
389 uint16_t *p = (uint16_t *)tmp;
390 pvr2_vram64_read( tmp, texture_addr, bytes );
392 detwiddle_16_to_16( 0, 0, width, width, &p, (uint16_t *)&data );
394 pvr2_vram64_read( data, texture_addr, bytes );
398 glTexImage2D( GL_TEXTURE_2D, 0, intFormat, width, height, 0, format, type,
401 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
402 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
406 * Return a texture ID for the texture specified at the supplied address
407 * and given parameters (the same sequence of bytes could in theory have
408 * multiple interpretations). We use the texture address as the primary
409 * index, but allow for multiple instances at each address. The texture
410 * will be bound to the GL_TEXTURE_2D target before being returned.
412 * If the texture has already been bound, return the ID to which it was
413 * bound. Otherwise obtain an unused texture ID and set it up appropriately.
415 GLuint texcache_get_texture( uint32_t texture_addr, int width, int height,
418 uint32_t texture_page = texture_addr >> 12;
419 texcache_entry_index idx = texcache_page_lookup[texture_page];
420 while( idx != EMPTY_ENTRY ) {
421 texcache_entry_t entry = &texcache_active_list[idx];
422 if( entry->texture_addr == texture_addr &&
423 entry->mode == mode &&
424 entry->width == width &&
425 entry->height == height ) {
426 entry->lru_count = texcache_ref_counter++;
427 glBindTexture( GL_TEXTURE_2D, entry->texture_id );
428 return entry->texture_id;
433 /* Not found - check the free list */
436 if( texcache_free_ptr < MAX_TEXTURES ) {
437 slot = texcache_free_list[texcache_free_ptr++];
439 slot = texcache_evict();
442 /* Construct new entry */
443 texcache_active_list[slot].texture_addr = texture_addr;
444 texcache_active_list[slot].width = width;
445 texcache_active_list[slot].height = height;
446 texcache_active_list[slot].mode = mode;
447 texcache_active_list[slot].lru_count = texcache_ref_counter++;
449 /* Add entry to the lookup table */
450 texcache_active_list[slot].next = texcache_page_lookup[texture_page];
451 texcache_page_lookup[texture_page] = slot;
453 /* Construct the GL texture */
454 glBindTexture( GL_TEXTURE_2D, texcache_active_list[slot].texture_id );
455 texcache_load_texture( texture_addr, width, height, mode );
457 return texcache_active_list[slot].texture_id;
.