/**************************************************************************
 * 
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 **************************************************************************/

/**
 * Framebuffer/surface tile caching.
 *
 * Author:
 *    Brian Paul
 */

#include "pipe/p_util.h"
#include "pipe/p_inlines.h"
#include "sp_context.h"
#include "sp_surface.h"
#include "sp_tile_cache.h"

#define NUM_ENTRIES 30


/** XXX move these */
#define MAX_WIDTH 2048
#define MAX_HEIGHT 2048


struct softpipe_tile_cache
{
   struct pipe_surface *surface;  /**< the surface we're caching */
   struct pipe_texture *texture;  /**< if caching a texture */
   struct softpipe_cached_tile entries[NUM_ENTRIES];
   uint clear_flags[(MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32];
   float clear_value[4];
};


/**
 * Return the position in the cache for the tile that contains win pos (x,y).
 * We currently use a direct mapped cache so this is like a hack key.
 * At some point we should investige something more sophisticated, like
 * a LRU replacement policy.
 */
#define CACHE_POS(x, y) \
   (((x) / TILE_SIZE + ((y) / TILE_SIZE) * 5) % NUM_ENTRIES)



static INLINE uint
is_clear_flag_set(const uint *bitvec, int x, int y)
{
   int pos, bit;
   x /= TILE_SIZE;
   y /= TILE_SIZE;
   pos = y * (MAX_WIDTH / TILE_SIZE) + x;
   assert(pos / 32 < (MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32);
   bit = bitvec[pos / 32] & (1 << (pos & 31));
   return bit;
}
   

static INLINE void
clear_clear_flag(uint *bitvec, int x, int y)
{
   int pos;
   x /= TILE_SIZE;
   y /= TILE_SIZE;
   pos = y * (MAX_WIDTH / TILE_SIZE) + x;
   assert(pos / 32 < (MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32);
   bitvec[pos / 32] &= ~(1 << (pos & 31));
}
   

struct softpipe_tile_cache *
sp_create_tile_cache(void)
{
   struct softpipe_tile_cache *tc;
   uint pos;

   tc = CALLOC_STRUCT( softpipe_tile_cache );
   if (tc) {
      for (pos = 0; pos < NUM_ENTRIES; pos++) {
         tc->entries[pos].x =
         tc->entries[pos].y = -1;
      }
   }
   return tc;
}


void
sp_destroy_tile_cache(struct softpipe_tile_cache *tc)
{
   uint pos;
   for (pos = 0; pos < NUM_ENTRIES; pos++) {
      assert(tc->entries[pos].x < 0);
   }
   FREE( tc );
}


void
sp_tile_cache_set_surface(struct softpipe_tile_cache *tc,
                          struct pipe_surface *ps)
{
   if (tc->surface && tc->surface->map) {
      assert(tc->surface != ps);
      pipe_surface_unmap(tc->surface);
   }

   pipe_surface_reference(&tc->surface, ps);

   if (!ps->map)
      pipe_surface_map(ps);
}


struct pipe_surface *
sp_tile_cache_get_surface(struct softpipe_tile_cache *tc)
{
   return tc->surface;
}


void
sp_tile_cache_set_texture(struct softpipe_tile_cache *tc,
                          struct pipe_texture *texture)
{
   uint i;

   tc->texture = texture;

   /* mark as entries as invalid/empty */
   /* XXX we should try to avoid this when the teximage hasn't changed */
   for (i = 0; i < NUM_ENTRIES; i++) {
      tc->entries[i].x = -1;
   }
}


static INLINE boolean
is_depth_stencil_surface(struct pipe_surface *ps)
{
   return (ps &&
           (ps->format == PIPE_FORMAT_S8_Z24 ||
            ps->format == PIPE_FORMAT_U_Z16 ||
            ps->format == PIPE_FORMAT_U_Z32 ||
            ps->format == PIPE_FORMAT_U_S8));
}


/**
 * Set pixels in a tile to the given clear color/value.
 */
static void
clear_tile(struct softpipe_cached_tile *tile, uint format,
           const float clear_value[4])
{
   uint i, j;

   switch (format) {
   case PIPE_FORMAT_U_Z16:
      {
         ushort clear_val = (ushort) (clear_value[0] * 0xffff);
         for (i = 0; i < TILE_SIZE; i++) {
            for (j = 0; j < TILE_SIZE; j++) {
               tile->data.depth16[i][j] = clear_val;
            }
         }
      }
      break;
   case PIPE_FORMAT_U_Z32:
      {
         uint clear_val = (uint) (clear_value[0] * 0xffffffff);
         for (i = 0; i < TILE_SIZE; i++) {
            for (j = 0; j < TILE_SIZE; j++) {
               tile->data.depth32[i][j] = clear_val;
            }
         }
      }
      break;
   case PIPE_FORMAT_S8_Z24:
      {
         uint clear_val = (uint) (clear_value[0] * 0xffffff);
         clear_val |= ((uint) clear_value[1]) << 24;
         for (i = 0; i < TILE_SIZE; i++) {
            for (j = 0; j < TILE_SIZE; j++) {
               tile->data.depth32[i][j] = clear_val;
            }
         }
      }
      break;
   case PIPE_FORMAT_U_S8:
      {
         ubyte clear_val = (uint) clear_value[0];
         for (i = 0; i < TILE_SIZE; i++) {
            for (j = 0; j < TILE_SIZE; j++) {
               tile->data.stencil8[i][j] = clear_val;
            }
         }
      }
      break;
   default:
      /* color */
      if (clear_value[0] == 0.0 &&
          clear_value[1] == 0.0 &&
          clear_value[2] == 0.0 &&
          clear_value[3] == 0.0) {
         memset(tile->data.color, 0, sizeof(tile->data.color));
      }
      else {
         for (i = 0; i < TILE_SIZE; i++) {
            for (j = 0; j < TILE_SIZE; j++) {
               tile->data.color[i][j][0] = clear_value[0];
               tile->data.color[i][j][1] = clear_value[1];
               tile->data.color[i][j][2] = clear_value[2];
               tile->data.color[i][j][3] = clear_value[3];
            }
         }
      }
   }
}


static INLINE void
put_tile(struct pipe_context *pipe,
         struct pipe_surface *ps, 
         struct softpipe_cached_tile *tile)
{
   assert(tile->x >= 0);
   assert(tile->x % TILE_SIZE == 0);
   assert(tile->y >= 0);
   assert(tile->y % TILE_SIZE == 0);

   if (is_depth_stencil_surface(ps)) {
      pipe->put_tile(pipe, ps,
                     tile->x, tile->y, TILE_SIZE, TILE_SIZE,
                     tile->data.depth32, 0/*STRIDE*/);
   }
   else {
      pipe->put_tile_rgba(pipe, ps,
                          tile->x, tile->y, TILE_SIZE, TILE_SIZE,
                          (float *) tile->data.color);
   }
}


static INLINE void
get_tile(struct pipe_context *pipe,
         struct pipe_surface *ps, 
         struct softpipe_cached_tile *tile)
{
   assert(tile->x >= 0);
   assert(tile->x % TILE_SIZE == 0);
   assert(tile->y >= 0);
   assert(tile->y % TILE_SIZE == 0);

   if (is_depth_stencil_surface(ps)) {
      pipe->get_tile(pipe, ps,
                     tile->x, tile->y, TILE_SIZE, TILE_SIZE,
                     tile->data.depth32, 0/*STRIDE*/);
   }
   else {
      pipe->get_tile_rgba(pipe, ps,
                          tile->x, tile->y, TILE_SIZE, TILE_SIZE,
                          (float *) tile->data.color);
   }
}


/**
 * Actually clear the tiles which were flagged as being in a clear state.
 */
static void
sp_tile_cache_flush_clear(struct pipe_context *pipe,
                          struct softpipe_tile_cache *tc)
{
   struct pipe_surface *ps = tc->surface;
   const uint w = tc->surface->width;
   const uint h = tc->surface->height;
   uint x, y;
   struct softpipe_cached_tile tile;
   uint numCleared = 0;

   /* clear one tile to the clear value */
   clear_tile(&tile, ps->format, tc->clear_value);

   /* push the tile to all positions marked as clear */
   for (y = 0; y < h; y += TILE_SIZE) {
      for (x = 0; x < w; x += TILE_SIZE) {
         if (is_clear_flag_set(tc->clear_flags, x, y)) {
            tile.x = x;
            tile.y = y;
            put_tile(pipe, ps, &tile);

            /* do this? */
            clear_clear_flag(tc->clear_flags, x, y);

            numCleared++;
         }
      }
   }
#if 0
   printf("num cleared: %u\n", numCleared);
#endif
}


/**
 * Flush the tile cache: write all dirty tiles back to the surface.
 * any tiles "flagged" as cleared will be "really" cleared.
 */
void
sp_flush_tile_cache(struct softpipe_context *softpipe,
                    struct softpipe_tile_cache *tc)
{
   struct pipe_context *pipe = &softpipe->pipe;
   struct pipe_surface *ps = tc->surface;
   int inuse = 0, pos;

   if (!ps || !ps->buffer)
      return;

   if (!ps->map)
      pipe_surface_map(ps);

   for (pos = 0; pos < NUM_ENTRIES; pos++) {
      struct softpipe_cached_tile *tile = tc->entries + pos;
      if (tile->x >= 0) {
         put_tile(pipe, ps, tile);
         tile->x = tile->y = -1;  /* mark as empty */
         inuse++;
      }
   }

#if TILE_CLEAR_OPTIMIZATION
   sp_tile_cache_flush_clear(&softpipe->pipe, tc);
#endif

#if 0
   printf("flushed tiles in use: %d\n", inuse);
#endif
}


/**
 * Get a tile from the cache.
 * \param x, y  position of tile, in pixels
 */
struct softpipe_cached_tile *
sp_get_cached_tile(struct softpipe_context *softpipe,
                   struct softpipe_tile_cache *tc, int x, int y)
{
   struct pipe_context *pipe = &softpipe->pipe;
   struct pipe_surface *ps = tc->surface;

   /* tile pos in framebuffer: */
   const int tile_x = x & ~(TILE_SIZE - 1);
   const int tile_y = y & ~(TILE_SIZE - 1);

   /* cache pos/entry: */
   const int pos = CACHE_POS(x, y);
   struct softpipe_cached_tile *tile = tc->entries + pos;

   if (tile_x != tile->x ||
       tile_y != tile->y) {

      if (tile->x != -1) {
         /* put dirty tile back in framebuffer */
         put_tile(pipe, ps, tile);
      }

      tile->x = tile_x;
      tile->y = tile_y;

      if (is_clear_flag_set(tc->clear_flags, x, y)) {
         /* don't get tile from framebuffer, just clear it */
         clear_tile(tile, ps->format, tc->clear_value);
         clear_clear_flag(tc->clear_flags, x, y);
      }
      else {
         /* get new tile data from surface */
         get_tile(pipe, ps, tile);
      }
   }

   return tile;
}


/**
 * Given the texture face, level, zslice, x and y values, compute
 * the cache entry position/index where we'd hope to find the
 * cached texture tile.
 * This is basically a direct-map cache.
 * XXX There's probably lots of ways in which we can improve this.
 */
static INLINE uint
tex_cache_pos(int x, int y, int z, int face, int level)
{
   uint entry = x + y * 5 + z * 4 + face + level;
   return entry % NUM_ENTRIES;
}


/**
 * Similar to sp_get_cached_tile() but for textures.
 * Tiles are read-only and indexed with more params.
 */
const struct softpipe_cached_tile *
sp_get_cached_tile_tex(struct pipe_context *pipe,
                       struct softpipe_tile_cache *tc, int x, int y, int z,
                       int face, int level)
{
   /* tile pos in framebuffer: */
   const int tile_x = x & ~(TILE_SIZE - 1);
   const int tile_y = y & ~(TILE_SIZE - 1);
   /* cache pos/entry: */
   const uint pos = tex_cache_pos(x / TILE_SIZE, y / TILE_SIZE, z,
                                  face, level);
   struct softpipe_cached_tile *tile = tc->entries + pos;

   if (tile_x != tile->x ||
       tile_y != tile->y ||
       z != tile->z ||
       face != tile->face ||
       level != tile->level) {
      /* XXX this call is a bit heavier than we'd like: */
      struct pipe_surface *ps
         = pipe->get_tex_surface(pipe, tc->texture, face, level, z);

      pipe_surface_map(ps);

      pipe->get_tile_rgba(pipe, ps,
                          tile_x, tile_y, TILE_SIZE, TILE_SIZE,
                          (float *) tile->data.color);

      pipe_surface_unmap(ps);
      pipe_surface_reference(&ps, NULL);

      tile->x = tile_x;
      tile->y = tile_y;
      tile->z = z;
      tile->face = face;
      tile->level = level;
   }

   return tile;
}


/**
 * When a whole surface is being cleared to a value we can avoid
 * fetching tiles above.
 * Save the color and set a 'clearflag' for each tile of the screen.
 */
void
sp_tile_cache_clear(struct softpipe_tile_cache *tc, const float value[4])
{
   tc->clear_value[0] = value[0];
   tc->clear_value[1] = value[1];
   tc->clear_value[2] = value[2];
   tc->clear_value[3] = value[3];

#if TILE_CLEAR_OPTIMIZATION
   /* set flags to indicate all the tiles are cleared */
   memset(tc->clear_flags, 255, sizeof(tc->clear_flags));
#else
   /* disable the optimization */
   memset(tc->clear_flags, 0, sizeof(tc->clear_flags));
#endif
}