src/gallium/drivers/llvmpipe/lp_tile_soa.py

   1 #!/usr/bin/env python
   2
   3 '''
   4 /**************************************************************************
   5  *
   6  * Copyright 2009 VMware, Inc.
   7  * All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the
  11  * "Software"), to deal in the Software without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sub license, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice (including the
  18  * next paragraph) shall be included in all copies or substantial portions
  19  * of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  24  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  25  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  26  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  27  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28  *
  29  **************************************************************************/
  30
  31 /**
  32  * @file
  33  * Pixel format accessor functions.
  34  *
  35  * @author Jose Fonseca <jfonseca@vmware.com>
  36  */
  37 '''
  38
  39
  40 import sys
  41 import os.path
  42
  43 sys.path.insert(0, os.path.join(os.path.dirname(sys.argv[0]), '../../auxiliary/util'))
  44
  45 from u_format_pack import *
  46
  47
  48 def is_format_supported(format):
  49     '''Determines whether we actually have the plumbing necessary to generate the
  50     to read/write to/from this format.'''
  51
  52     # FIXME: Ideally we would support any format combination here.
  53
  54     if format.layout != PLAIN:
  55         return False
  56
  57     for i in range(4):
  58         channel = format.channels[i]
  59         if channel.type not in (VOID, UNSIGNED, SIGNED, FLOAT):
  60             return False
  61         if channel.type == FLOAT and channel.size not in (32 ,64):
  62             return False
  63
  64     if format.colorspace not in ('rgb', 'srgb'):
  65         return False
  66
  67     return True
  68
  69
  70 def generate_format_read(format, dst_channel, dst_native_type, dst_suffix):
  71     '''Generate the function to read pixels from a particular format'''
  72
  73     name = format.short_name()
  74
  75     src_native_type = native_type(format)
  76
  77     print 'static void'
  78     print 'lp_tile_%s_read_%s(%s *dst, const uint8_t *src, unsigned src_stride, unsigned x0, unsigned y0, unsigned w, unsigned h)' % (name, dst_suffix, dst_native_type)
  79     print '{'
  80     print '   unsigned x, y;'
  81     print '   const uint8_t *src_row = src + y0*src_stride;'
  82     print '   for (y = 0; y < h; ++y) {'
  83     print '      const %s *src_pixel = (const %s *)(src_row + x0*%u);' % (src_native_type, src_native_type, format.stride())
  84     print '      for (x = 0; x < w; ++x) {'
  85
  86     names = ['']*4
  87     if format.colorspace in ('rgb', 'srgb'):
  88         for i in range(4):
  89             swizzle = format.swizzles[i]
  90             if swizzle < 4:
  91                 names[swizzle] += 'rgba'[i]
  92     elif format.colorspace == 'zs':
  93         swizzle = format.swizzles[0]
  94         if swizzle < 4:
  95             names[swizzle] = 'z'
  96         else:
  97             assert False
  98     else:
  99         assert False
 100
 101     if format.layout == PLAIN:
 102         if not format.is_array():
 103             print '         %s pixel = *src_pixel++;' % src_native_type
 104             shift = 0;
 105             for i in range(4):
 106                 src_channel = format.channels[i]
 107                 width = src_channel.size
 108                 if names[i]:
 109                     value = 'pixel'
 110                     mask = (1 << width) - 1
 111                     if shift:
 112                         value = '(%s >> %u)' % (value, shift)
 113                     if shift + width < format.block_size():
 114                         value = '(%s & 0x%x)' % (value, mask)
 115                     value = conversion_expr(src_channel, dst_channel, dst_native_type, value, clamp=False)
 116                     print '         %s %s = %s;' % (dst_native_type, names[i], value)
 117                 shift += width
 118         else:
 119             for i in range(4):
 120                 if names[i]:
 121                     print '         %s %s;' % (dst_native_type, names[i])
 122             for i in range(4):
 123                 src_channel = format.channels[i]
 124                 if names[i]:
 125                     value = '(*src_pixel++)'
 126                     value = conversion_expr(src_channel, dst_channel, dst_native_type, value, clamp=False)
 127                     print '         %s = %s;' % (names[i], value)
 128                 elif src_channel.size:
 129                     print '         ++src_pixel;'
 130     else:
 131         assert False
 132
 133     for i in range(4):
 134         if format.colorspace in ('rgb', 'srgb'):
 135             swizzle = format.swizzles[i]
 136             if swizzle < 4:
 137                 value = names[swizzle]
 138             elif swizzle == SWIZZLE_0:
 139                 value = '0'
 140             elif swizzle == SWIZZLE_1:
 141                 value = get_one(dst_channel)
 142             else:
 143                 assert False
 144         elif format.colorspace == 'zs':
 145             if i < 3:
 146                 value = 'z'
 147             else:
 148                 value = get_one(dst_channel)
 149         else:
 150             assert False
 151         print '         TILE_PIXEL(dst, x, y, %u) = %s; /* %s */' % (i, value, 'rgba'[i])
 152
 153     print '      }'
 154     print '      src_row += src_stride;'
 155     print '   }'
 156     print '}'
 157     print
 158
 159
 160 def pack_rgba(format, src_channel, r, g, b, a):
 161     """Return an expression for packing r, g, b, a into a pixel of the
 162     given format.  Ex: '(b << 24) | (g << 16) | (r << 8) | (a << 0)'
 163     """
 164     assert format.colorspace in ('rgb', 'srgb')
 165     inv_swizzle = format.inv_swizzles()
 166     shift = 0
 167     expr = None
 168     for i in range(4):
 169         # choose r, g, b, or a depending on the inverse swizzle term
 170         if inv_swizzle[i] == 0:
 171             value = r
 172         elif inv_swizzle[i] == 1:
 173             value = g
 174         elif inv_swizzle[i] == 2:
 175             value = b
 176         elif inv_swizzle[i] == 3:
 177             value = a
 178         else:
 179             value = None
 180
 181         if value:
 182             dst_channel = format.channels[i]
 183             dst_native_type = native_type(format)
 184             value = conversion_expr(src_channel, dst_channel, dst_native_type, value, clamp=False)
 185             term = "((%s) << %d)" % (value, shift)
 186             if expr:
 187                 expr = expr + " | " + term
 188             else:
 189                 expr = term
 190
 191         width = format.channels[i].size
 192         shift = shift + width
 193     return expr
 194
 195
 196 def emit_unrolled_write_code(format, src_channel):
 197     '''Emit code for writing a block based on unrolled loops.
 198     This is considerably faster than the TILE_PIXEL-based code below.
 199     '''
 200     dst_native_type = 'uint%u_t' % format.block_size()
 201     print '   const unsigned dstpix_stride = dst_stride / %d;' % format.stride()
 202     print '   %s *dstpix = (%s *) dst;' % (dst_native_type, dst_native_type)
 203     print '   unsigned int qx, qy, i;'
 204     print
 205     print '   for (qy = 0; qy < h; qy += TILE_VECTOR_HEIGHT) {'
 206     print '      const unsigned py = y0 + qy;'
 207     print '      for (qx = 0; qx < w; qx += TILE_VECTOR_WIDTH) {'
 208     print '         const unsigned px = x0 + qx;'
 209     print '         const uint8_t *r = src + 0 * TILE_C_STRIDE;'
 210     print '         const uint8_t *g = src + 1 * TILE_C_STRIDE;'
 211     print '         const uint8_t *b = src + 2 * TILE_C_STRIDE;'
 212     print '         const uint8_t *a = src + 3 * TILE_C_STRIDE;'
 213     print '         (void) r; (void) g; (void) b; (void) a; /* silence warnings */'
 214     print '         for (i = 0; i < TILE_C_STRIDE; i += 2) {'
 215     print '            const uint32_t pixel0 = %s;' % pack_rgba(format, src_channel, "r[i+0]", "g[i+0]", "b[i+0]", "a[i+0]")
 216     print '            const uint32_t pixel1 = %s;' % pack_rgba(format, src_channel, "r[i+1]", "g[i+1]", "b[i+1]", "a[i+1]")
 217     print '            const unsigned offset = (py + tile_y_offset[i]) * dstpix_stride + (px + tile_x_offset[i]);'
 218     print '            dstpix[offset + 0] = pixel0;'
 219     print '            dstpix[offset + 1] = pixel1;'
 220     print '         }'
 221     print '         src += TILE_X_STRIDE;'
 222     print '      }'
 223     print '   }'
 224
 225
 226 def emit_tile_pixel_write_code(format, src_channel):
 227     '''Emit code for writing a block based on the TILE_PIXEL macro.'''
 228     dst_native_type = native_type(format)
 229
 230     inv_swizzle = format.inv_swizzles()
 231
 232     print '   unsigned x, y;'
 233     print '   uint8_t *dst_row = dst + y0*dst_stride;'
 234     print '   for (y = 0; y < h; ++y) {'
 235     print '      %s *dst_pixel = (%s *)(dst_row + x0*%u);' % (dst_native_type, dst_native_type, format.stride())
 236     print '      for (x = 0; x < w; ++x) {'
 237
 238     if format.layout == PLAIN:
 239         if not format.is_array():
 240             print '         %s pixel = 0;' % dst_native_type
 241             shift = 0;
 242             for i in range(4):
 243                 dst_channel = format.channels[i]
 244                 width = dst_channel.size
 245                 if inv_swizzle[i] is not None:
 246                     value = 'TILE_PIXEL(src, x, y, %u)' % inv_swizzle[i]
 247                     value = conversion_expr(src_channel, dst_channel, dst_native_type, value, clamp=False)
 248                     if shift:
 249                         value = '(%s << %u)' % (value, shift)
 250                     print '         pixel |= %s;' % value
 251                 shift += width
 252             print '         *dst_pixel++ = pixel;'
 253         else:
 254             for i in range(4):
 255                 dst_channel = format.channels[i]
 256                 if inv_swizzle[i] is not None:
 257                     value = 'TILE_PIXEL(src, x, y, %u)' % inv_swizzle[i]
 258                     value = conversion_expr(src_channel, dst_channel, dst_native_type, value, clamp=False)
 259                     print '         *dst_pixel++ = %s;' % value
 260                 else:
 261                     print '         ++dst_pixel;'
 262     else:
 263         assert False
 264
 265     print '      }'
 266     print '      dst_row += dst_stride;'
 267     print '   }'
 268
 269
 270 def generate_format_write(format, src_channel, src_native_type, src_suffix):
 271     '''Generate the function to write pixels to a particular format'''
 272
 273     name = format.short_name()
 274
 275     print 'static void'
 276     print 'lp_tile_%s_write_%s(const %s *src, uint8_t *dst, unsigned dst_stride, unsigned x0, unsigned y0, unsigned w, unsigned h)' % (name, src_suffix, src_native_type)
 277     print '{'
 278     if format.layout == PLAIN \
 279         and format.colorspace == 'rgb' \
 280         and format.block_size() <= 32 \
 281         and format.is_pot() \
 282         and not format.is_mixed() \
 283         and (format.channels[0].type == UNSIGNED \
 284              or format.channels[1].type == UNSIGNED):
 285         emit_unrolled_write_code(format, src_channel)
 286     else:
 287         emit_tile_pixel_write_code(format, src_channel)
 288     print '}'
 289     print
 290
 291
 292 def generate_read(formats, dst_channel, dst_native_type, dst_suffix):
 293     '''Generate the dispatch function to read pixels from any format'''
 294
 295     for format in formats:
 296         if is_format_supported(format):
 297             generate_format_read(format, dst_channel, dst_native_type, dst_suffix)
 298
 299     print 'void'
 300     print 'lp_tile_read_%s(enum pipe_format format, %s *dst, const void *src, unsigned src_stride, unsigned x, unsigned y, unsigned w, unsigned h)' % (dst_suffix, dst_native_type)
 301     print '{'
 302     print '   void (*func)(%s *dst, const uint8_t *src, unsigned src_stride, unsigned x0, unsigned y0, unsigned w, unsigned h);' % dst_native_type
 303     print '   switch(format) {'
 304     for format in formats:
 305         if is_format_supported(format):
 306             print '   case %s:' % format.name
 307             print '      func = &lp_tile_%s_read_%s;' % (format.short_name(), dst_suffix)
 308             print '      break;'
 309     print '   default:'
 310     print '      debug_printf("%s: unsupported format %s\\n", __FUNCTION__, util_format_name(format));'
 311     print '      return;'
 312     print '   }'
 313     print '   func(dst, (const uint8_t *)src, src_stride, x, y, w, h);'
 314     print '}'
 315     print
 316
 317
 318 def generate_write(formats, src_channel, src_native_type, src_suffix):
 319     '''Generate the dispatch function to write pixels to any format'''
 320
 321     for format in formats:
 322         if is_format_supported(format):
 323             generate_format_write(format, src_channel, src_native_type, src_suffix)
 324
 325     print 'void'
 326     print 'lp_tile_write_%s(enum pipe_format format, const %s *src, void *dst, unsigned dst_stride, unsigned x, unsigned y, unsigned w, unsigned h)' % (src_suffix, src_native_type)
 327
 328     print '{'
 329     print '   void (*func)(const %s *src, uint8_t *dst, unsigned dst_stride, unsigned x0, unsigned y0, unsigned w, unsigned h);' % src_native_type
 330     print '   switch(format) {'
 331     for format in formats:
 332         if is_format_supported(format):
 333             print '   case %s:' % format.name
 334             print '      func = &lp_tile_%s_write_%s;' % (format.short_name(), src_suffix)
 335             print '      break;'
 336     print '   default:'
 337     print '      debug_printf("%s: unsupported format %s\\n", __FUNCTION__, util_format_name(format));'
 338     print '      return;'
 339     print '   }'
 340     print '   func(src, (uint8_t *)dst, dst_stride, x, y, w, h);'
 341     print '}'
 342     print
 343
 344
 345 def main():
 346     formats = []
 347     for arg in sys.argv[1:]:
 348         formats.extend(parse(arg))
 349
 350     print '/* This file is autogenerated by lp_tile_soa.py from u_format.csv. Do not edit directly. */'
 351     print
 352     # This will print the copyright message on the top of this file
 353     print __doc__.strip()
 354     print
 355     print '#include "pipe/p_compiler.h"'
 356     print '#include "util/u_format.h"'
 357     print '#include "util/u_math.h"'
 358     print '#include "util/u_half.h"'
 359     print '#include "lp_tile_soa.h"'
 360     print
 361     print 'const unsigned char'
 362     print 'tile_offset[TILE_VECTOR_HEIGHT][TILE_VECTOR_WIDTH] = {'
 363     print '   {  0,  1,  4,  5},'
 364     print '   {  2,  3,  6,  7},'
 365     print '   {  8,  9, 12, 13},'
 366     print '   { 10, 11, 14, 15}'
 367     print '};'
 368     print
 369     print '/* Note: these lookup tables could be replaced with some'
 370     print ' * bit-twiddling code, but this is a little faster.'
 371     print ' */'
 372     print 'static unsigned tile_x_offset[TILE_VECTOR_WIDTH * TILE_VECTOR_HEIGHT] = {'
 373     print '   0, 1, 0, 1, 2, 3, 2, 3,'
 374     print '   0, 1, 0, 1, 2, 3, 2, 3'
 375     print '};'
 376     print
 377     print 'static unsigned tile_y_offset[TILE_VECTOR_WIDTH * TILE_VECTOR_HEIGHT] = {'
 378     print '   0, 0, 1, 1, 0, 0, 1, 1,'
 379     print '   2, 2, 3, 3, 2, 2, 3, 3'
 380     print '};'
 381     print
 382
 383     channel = Channel(UNSIGNED, True, 8)
 384     native_type = 'uint8_t'
 385     suffix = '4ub'
 386
 387     generate_read(formats, channel, native_type, suffix)
 388     generate_write(formats, channel, native_type, suffix)
 389
 390
 391 if __name__ == '__main__':
 392     main()