util: Add the shortened format name to the description.
[mesa.git] / src / gallium / auxiliary / util / u_format_table.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
33 import sys
34
35 from u_format_parse import *
36
37
38 def layout_map(layout):
39 return 'UTIL_FORMAT_LAYOUT_' + str(layout).upper()
40
41
42 def colorspace_map(colorspace):
43 return 'UTIL_FORMAT_COLORSPACE_' + str(colorspace).upper()
44
45
46 colorspace_channels_map = {
47 'rgb': ['r', 'g', 'b', 'a'],
48 'srgb': ['sr', 'sg', 'sb', 'a'],
49 'zs': ['z', 's'],
50 'yuv': ['y', 'u', 'v'],
51 }
52
53
54 type_map = {
55 VOID: "UTIL_FORMAT_TYPE_VOID",
56 UNSIGNED: "UTIL_FORMAT_TYPE_UNSIGNED",
57 SIGNED: "UTIL_FORMAT_TYPE_SIGNED",
58 FIXED: "UTIL_FORMAT_TYPE_FIXED",
59 FLOAT: "UTIL_FORMAT_TYPE_FLOAT",
60 }
61
62
63 def bool_map(value):
64 if value:
65 return "TRUE"
66 else:
67 return "FALSE"
68
69
70 swizzle_map = {
71 SWIZZLE_X: "UTIL_FORMAT_SWIZZLE_X",
72 SWIZZLE_Y: "UTIL_FORMAT_SWIZZLE_Y",
73 SWIZZLE_Z: "UTIL_FORMAT_SWIZZLE_Z",
74 SWIZZLE_W: "UTIL_FORMAT_SWIZZLE_W",
75 SWIZZLE_0: "UTIL_FORMAT_SWIZZLE_0",
76 SWIZZLE_1: "UTIL_FORMAT_SWIZZLE_1",
77 SWIZZLE_NONE: "UTIL_FORMAT_SWIZZLE_NONE",
78 }
79
80
81 def write_format_table(formats):
82 print '/* This file is autogenerated by u_format_table.py from u_format.csv. Do not edit directly. */'
83 print
84 # This will print the copyright message on the top of this file
85 print __doc__.strip()
86 print
87 print '#include "u_format.h"'
88 print
89 print 'const struct util_format_description'
90 print 'util_format_none_description = {'
91 print " PIPE_FORMAT_NONE,"
92 print " \"PIPE_FORMAT_NONE\","
93 print " \"none\","
94 print " {0, 0, 0},"
95 print " 0,"
96 print " 0,"
97 print " 0,"
98 print " 0,"
99 print " {{0, 0, 0}, {0, 0, 0}, {0, 0, 0}, {0, 0, 0}},"
100 print " {0, 0, 0, 0},"
101 print " 0"
102 print "};"
103 print
104 for format in formats:
105 print 'const struct util_format_description'
106 print 'util_format_%s_description = {' % (format.short_name(),)
107 print " %s," % (format.name,)
108 print " \"%s\"," % (format.name,)
109 print " \"%s\"," % (format.short_name(),)
110 print " {%u, %u, %u},\t/* block */" % (format.block_width, format.block_height, format.block_size())
111 print " %s," % (layout_map(format.layout),)
112 print " %u,\t/* nr_channels */" % (format.nr_channels(),)
113 print " %s,\t/* is_array */" % (bool_map(format.is_array()),)
114 print " %s,\t/* is_mixed */" % (bool_map(format.is_mixed()),)
115 print " {"
116 for i in range(4):
117 channel = format.channels[i]
118 if i < 3:
119 sep = ","
120 else:
121 sep = ""
122 if channel.size:
123 print " {%s, %s, %u}%s\t/* %s = %s */" % (type_map[channel.type], bool_map(channel.norm), channel.size, sep, "xyzw"[i], channel.name)
124 else:
125 print " {0, 0, 0}%s" % (sep,)
126 print " },"
127 print " {"
128 for i in range(4):
129 swizzle = format.swizzles[i]
130 if i < 3:
131 sep = ","
132 else:
133 sep = ""
134 try:
135 comment = colorspace_channels_map[format.colorspace][i]
136 except (KeyError, IndexError):
137 comment = 'ignored'
138 print " %s%s\t/* %s */" % (swizzle_map[swizzle], sep, comment)
139 print " },"
140 print " %s," % (colorspace_map(format.colorspace),)
141 print "};"
142 print
143 print "const struct util_format_description *"
144 print "util_format_description(enum pipe_format format)"
145 print "{"
146 print " if (format >= PIPE_FORMAT_COUNT) {"
147 print " return NULL;"
148 print " }"
149 print
150 print " switch (format) {"
151 print " case PIPE_FORMAT_NONE:"
152 print " return &util_format_none_description;"
153 for format in formats:
154 print " case %s:" % format.name
155 print " return &util_format_%s_description;" % (format.short_name(),)
156 print " default:"
157 print " assert(0);"
158 print " return NULL;"
159 print " }"
160 print "}"
161 print
162
163
164 def main():
165
166 formats = []
167 for arg in sys.argv[1:]:
168 formats.extend(parse(arg))
169 write_format_table(formats)
170
171
172 if __name__ == '__main__':
173 main()