2 # Copyright © 2016 Intel Corporation
4 # Permission is hereby granted, free of charge, to any person obtaining a copy
5 # of this software and associated documentation files (the "Software"), to deal
6 # in the Software without restriction, including without limitation the rights
7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 # copies of the Software, and to permit persons to whom the Software is
9 # furnished to do so, subject to the following conditions:
11 # The above copyright notice and this permission notice shall be included in
12 # all copies or substantial portions of the Software.
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 """Generates isl_format_layout.c."""
24 from __future__
import absolute_import
, division
, print_function
30 from mako
import template
32 # Load the template, ensure that __future__.division is imported, and set the
33 # bytes encoding to be utf-8. This last bit is important to getting simple
34 # consistent behavior for python 3 when we get there.
35 TEMPLATE
= template
.Template(future_imports
=['division'],
36 output_encoding
='utf-8',
38 /* This file is autogenerated by gen_format_layout.py. DO NOT EDIT! */
41 * Copyright 2015 Intel Corporation
43 * Permission is hereby granted, free of charge, to any person obtaining a
44 * copy of this software and associated documentation files (the "Software"),
45 * to deal in the Software without restriction, including without limitation
46 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
47 * and/or sell copies of the Software, and to permit persons to whom the
48 * Software is furnished to do so, subject to the following conditions:
50 * The above copyright notice and this permission notice (including the next
51 * paragraph) shall be included in all copies or substantial portions of the
54 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
55 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
56 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
57 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
58 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
59 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
65 const struct isl_format_layout
66 isl_format_layouts[] = {
67 % for format in formats:
68 [ISL_FORMAT_${format.name}] = {
69 .format = ISL_FORMAT_${format.name},
70 .name = "ISL_FORMAT_${format.name}",
76 % for mask in ['r', 'g', 'b', 'a', 'l', 'i', 'p']:
77 <% channel = getattr(format, mask, None) %>\\
78 % if channel.type is not None:
79 .${mask} = { ISL_${channel.type}, ${channel.size} },
85 .colorspace = ISL_COLORSPACE_${format.colorspace},
86 .txc = ISL_TXC_${format.txc},
93 isl_format_is_valid(enum isl_format format)
95 if (format >= sizeof(isl_format_layouts) / sizeof(isl_format_layouts[0]))
97 return isl_format_layouts[format].name;
101 isl_format_srgb_to_linear(enum isl_format format)
104 % for srgb, rgb in srgb_to_linear_map:
105 case ISL_FORMAT_${srgb}:
106 return ISL_FORMAT_${rgb};
115 class Channel(object):
116 """Class representing a Channel.
118 Converts the csv encoded data into the format that the template (and thus
119 the consuming C code) expects.
122 # If the csv file grew very large this class could be put behind a factory
123 # to increase efficiency. Right now though it's fast enough that It didn't
124 # seem worthwhile to add all of the boilerplate
139 _splitter
= re
.compile(r
'\s*(?P<type>[a-z]+)(?P<size>[0-9]+)')
141 def __init__(self
, line
):
142 # If the line is just whitespace then just set everything to None to
143 # save on the regex cost and let the template skip on None.
148 grouped
= self
._splitter
.match(line
)
149 self
.type = self
._types
[grouped
.group('type')].upper()
150 self
.size
= grouped
.group('size')
153 class Format(object):
154 """Class taht contains all values needed by the template."""
155 def __init__(self
, line
):
156 # pylint: disable=invalid-name
157 self
.name
= line
[0].strip()
159 # Future division makes this work in python 2.
160 self
.bpb
= int(line
[1])
161 self
.bw
= line
[2].strip()
162 self
.bh
= line
[3].strip()
163 self
.bd
= line
[4].strip()
164 self
.r
= Channel(line
[5])
165 self
.g
= Channel(line
[6])
166 self
.b
= Channel(line
[7])
167 self
.a
= Channel(line
[8])
168 self
.l
= Channel(line
[9])
169 self
.i
= Channel(line
[10])
170 self
.p
= Channel(line
[11])
171 self
.order
= line
[12].strip()
173 # alpha doesn't have a colorspace of it's own.
174 self
.colorspace
= line
[13].strip().upper()
175 if self
.colorspace
in ['', 'ALPHA']:
176 self
.colorspace
= 'NONE'
178 # This sets it to the line value, or if it's an empty string 'NONE'
179 self
.txc
= line
[14].strip().upper() or 'NONE'
183 """Wrapper around csv.reader that skips comments and blanks."""
184 # csv.reader actually reads the file one line at a time (it was designed to
185 # open excel generated sheets), so hold the file until all of the lines are
187 with
open(csvfile
, 'r') as f
:
188 for line
in csv
.reader(f
):
189 if line
and not line
[0].startswith('#'):
192 def get_srgb_to_linear_map(formats
):
193 """Compute a map from sRGB to linear formats.
195 This function uses some probably somewhat fragile string munging to do
196 the conversion. However, we do assert that, if it's SRGB, the munging
197 succeeded so that gives some safety.
199 names
= {f
.name
for f
in formats
}
201 if fmt
.colorspace
!= 'SRGB':
211 for rep
in replacements
:
212 rgb_name
= fmt
.name
.replace(rep
[0], rep
[1])
213 if rgb_name
in names
:
215 yield fmt
.name
, rgb_name
218 # We should have found a format name
223 parser
= argparse
.ArgumentParser()
224 parser
.add_argument('--csv', action
='store', help='The CSV file to parse.')
228 help='The location to put the generated C file.')
229 args
= parser
.parse_args()
231 # This generator opens and writes the file itself, and it does so in bytes
232 # mode. This solves both python 2 vs 3 problems and solves the locale
233 # problem: Unicode can be rendered even if the shell calling this script
235 with
open(args
.out
, 'wb') as f
:
236 formats
= [Format(l
) for l
in reader(args
.csv
)]
238 # This basically does lazy evaluation and initialization, which
239 # saves on memory and startup overhead.
240 f
.write(TEMPLATE
.render(
242 srgb_to_linear_map
= list(get_srgb_to_linear_map(formats
)),
245 # In the even there's an error this imports some helpers from mako
246 # to print a useful stack trace and prints it, then exits with
247 # status 1, if python is run with debug; otherwise it just raises
251 from mako
import exceptions
252 print(exceptions
.text_error_template().render(),
258 if __name__
== '__main__':