util: Share a single function pointer for the 4-byte rgba unpack function.
[mesa.git] / src / util / format / u_format_table.py
1 from __future__ import print_function
2
3 CopyRight = '''
4 /**************************************************************************
5 *
6 * Copyright 2010 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
33 import sys
34
35 from u_format_parse import *
36 import u_format_pack
37
38
39 def layout_map(layout):
40 return 'UTIL_FORMAT_LAYOUT_' + str(layout).upper()
41
42
43 def colorspace_map(colorspace):
44 return 'UTIL_FORMAT_COLORSPACE_' + str(colorspace).upper()
45
46
47 colorspace_channels_map = {
48 'rgb': ['r', 'g', 'b', 'a'],
49 'srgb': ['sr', 'sg', 'sb', 'a'],
50 'zs': ['z', 's'],
51 'yuv': ['y', 'u', 'v'],
52 }
53
54
55 type_map = {
56 VOID: "UTIL_FORMAT_TYPE_VOID",
57 UNSIGNED: "UTIL_FORMAT_TYPE_UNSIGNED",
58 SIGNED: "UTIL_FORMAT_TYPE_SIGNED",
59 FIXED: "UTIL_FORMAT_TYPE_FIXED",
60 FLOAT: "UTIL_FORMAT_TYPE_FLOAT",
61 }
62
63
64 def bool_map(value):
65 if value:
66 return "TRUE"
67 else:
68 return "FALSE"
69
70
71 swizzle_map = {
72 SWIZZLE_X: "PIPE_SWIZZLE_X",
73 SWIZZLE_Y: "PIPE_SWIZZLE_Y",
74 SWIZZLE_Z: "PIPE_SWIZZLE_Z",
75 SWIZZLE_W: "PIPE_SWIZZLE_W",
76 SWIZZLE_0: "PIPE_SWIZZLE_0",
77 SWIZZLE_1: "PIPE_SWIZZLE_1",
78 SWIZZLE_NONE: "PIPE_SWIZZLE_NONE",
79 }
80
81
82 def write_format_table(formats):
83 print('/* This file is autogenerated by u_format_table.py from u_format.csv. Do not edit directly. */')
84 print()
85 # This will print the copyright message on the top of this file
86 print(CopyRight.strip())
87 print()
88 print('#include "u_format.h"')
89 print('#include "u_format_bptc.h"')
90 print('#include "u_format_s3tc.h"')
91 print('#include "u_format_rgtc.h"')
92 print('#include "u_format_latc.h"')
93 print('#include "u_format_etc.h"')
94 print()
95
96 u_format_pack.generate(formats)
97
98 def do_channel_array(channels, swizzles):
99 print(" {")
100 for i in range(4):
101 channel = channels[i]
102 if i < 3:
103 sep = ","
104 else:
105 sep = ""
106 if channel.size:
107 print(" {%s, %s, %s, %u, %u}%s\t/* %s = %s */" % (type_map[channel.type], bool_map(channel.norm), bool_map(channel.pure), channel.size, channel.shift, sep, "xyzw"[i], channel.name))
108 else:
109 print(" {0, 0, 0, 0, 0}%s" % (sep,))
110 print(" },")
111
112 def do_swizzle_array(channels, swizzles):
113 print(" {")
114 for i in range(4):
115 swizzle = swizzles[i]
116 if i < 3:
117 sep = ","
118 else:
119 sep = ""
120 try:
121 comment = colorspace_channels_map[format.colorspace][i]
122 except (KeyError, IndexError):
123 comment = 'ignored'
124 print(" %s%s\t/* %s */" % (swizzle_map[swizzle], sep, comment))
125 print(" },")
126
127 for format in formats:
128 sn = format.short_name()
129
130 print('const struct util_format_description')
131 print('util_format_%s_description = {' % (sn,))
132 print(" %s," % (format.name,))
133 print(" \"%s\"," % (format.name,))
134 print(" \"%s\"," % (sn,))
135 print(" {%u, %u, %u, %u},\t/* block */" % (format.block_width, format.block_height, format.block_depth, format.block_size()))
136 print(" %s," % (layout_map(format.layout),))
137 print(" %u,\t/* nr_channels */" % (format.nr_channels(),))
138 print(" %s,\t/* is_array */" % (bool_map(format.is_array()),))
139 print(" %s,\t/* is_bitmask */" % (bool_map(format.is_bitmask()),))
140 print(" %s,\t/* is_mixed */" % (bool_map(format.is_mixed()),))
141 print(" %s,\t/* is_unorm */" % (bool_map(format.is_unorm()),))
142 print(" %s,\t/* is_snorm */" % (bool_map(format.is_snorm()),))
143 u_format_pack.print_channels(format, do_channel_array)
144 u_format_pack.print_channels(format, do_swizzle_array)
145 print(" %s," % (colorspace_map(format.colorspace),))
146
147 # We don't generate code for YUV formats, and many of the new ones lack pack/unpack
148 # functions for softpipe/llvmpipe.
149 noaccess_formats = [
150 'yv12',
151 'yv16',
152 'iyuv',
153 'nv12',
154 'nv16',
155 'nv21',
156 'p010',
157 'p012',
158 'p016',
159 'xyuv',
160 'ayuv',
161 'r8g8_r8b8_unorm',
162 'g8r8_b8r8_unorm',
163 'g8r8_g8b8_unorm',
164 'y8_u8_v8_422_unorm',
165 'y8_u8v8_422_unorm',
166 'y8_u8_v8_444_unorm',
167 'y16_u16_v16_420_unorm',
168 'y16_u16_v16_422_unorm',
169 'y16_u16v16_422_unorm',
170 'y16_u16_v16_444_unorm',
171 ]
172 access = sn not in noaccess_formats
173 if format.layout in ('astc', 'atc', 'fxt1'):
174 access = False
175 if format.layout == 'etc' and sn != 'etc1_rgb8':
176 access = False
177 if format.colorspace != ZS and not format.is_pure_color() and access:
178 print(" .unpack_rgba_8unorm = &util_format_%s_unpack_rgba_8unorm," % sn)
179 print(" .pack_rgba_8unorm = &util_format_%s_pack_rgba_8unorm," % sn)
180 if format.layout == 's3tc' or format.layout == 'rgtc':
181 print(" .fetch_rgba_8unorm = &util_format_%s_fetch_rgba_8unorm," % sn)
182 print(" .unpack_rgba = &util_format_%s_unpack_rgba_float," % sn)
183 print(" .pack_rgba_float = &util_format_%s_pack_rgba_float," % sn)
184 print(" .fetch_rgba_float = &util_format_%s_fetch_rgba_float," % sn)
185
186 if format.has_depth():
187 print(" .unpack_z_32unorm = &util_format_%s_unpack_z_32unorm," % sn)
188 print(" .pack_z_32unorm = &util_format_%s_pack_z_32unorm," % sn)
189 print(" .unpack_z_float = &util_format_%s_unpack_z_float," % sn)
190 print(" .pack_z_float = &util_format_%s_pack_z_float," % sn)
191
192 if format.has_stencil():
193 print(" .unpack_s_8uint = &util_format_%s_unpack_s_8uint," % sn)
194 print(" .pack_s_8uint = &util_format_%s_pack_s_8uint," % sn)
195
196 if format.is_pure_unsigned():
197 print(" .unpack_rgba = &util_format_%s_unpack_unsigned," % sn)
198 print(" .pack_rgba_uint = &util_format_%s_pack_unsigned," % sn)
199 print(" .pack_rgba_sint = &util_format_%s_pack_signed," % sn)
200 print(" .fetch_rgba_uint = &util_format_%s_fetch_unsigned," % sn)
201 elif format.is_pure_signed():
202 print(" .pack_rgba_uint = &util_format_%s_pack_unsigned," % sn)
203 print(" .unpack_rgba = &util_format_%s_unpack_signed," % sn)
204 print(" .pack_rgba_sint = &util_format_%s_pack_signed," % sn)
205 print(" .fetch_rgba_sint = &util_format_%s_fetch_signed," % sn)
206 print("};")
207 print()
208
209 print("const struct util_format_description *")
210 print("util_format_description(enum pipe_format format)")
211 print("{")
212 print(" if (format >= PIPE_FORMAT_COUNT) {")
213 print(" return NULL;")
214 print(" }")
215 print()
216 print(" switch (format) {")
217 for format in formats:
218 print(" case %s:" % format.name)
219 print(" return &util_format_%s_description;" % (format.short_name(),))
220 print(" default:")
221 print(" return NULL;")
222 print(" }")
223 print("}")
224 print()
225
226
227 def main():
228
229 formats = []
230 for arg in sys.argv[1:]:
231 formats.extend(parse(arg))
232 write_format_table(formats)
233
234
235 if __name__ == '__main__':
236 main()