xref: /aosp_15_r20/external/angle/src/libANGLE/renderer/d3d/d3d11/gen_texture_format_table.py (revision 8975f5c5ed3d1c378011245431ada316dfb6f244)
1#!/usr/bin/python3
2# Copyright 2015 The ANGLE Project Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5#
6# gen_texture_format_table.py:
7#  Code generation for texture format map
8#  NOTE: don't run this script directly. Run scripts/run_code_generation.py.
9#
10
11import json
12import math
13import pprint
14import os
15import sys
16
17sys.path.append('../..')
18import angle_format
19
20template_texture_format_table_autogen_cpp = """// GENERATED FILE - DO NOT EDIT.
21// Generated by {script_name} using data from {data_source_name}
22//
23// Copyright 2015 The ANGLE Project Authors. All rights reserved.
24// Use of this source code is governed by a BSD-style license that can be
25// found in the LICENSE file.
26//
27// texture_format_table:
28//   Queries for full textureFormat information based in internalFormat
29//
30
31#include "libANGLE/renderer/d3d/d3d11/texture_format_table.h"
32
33#include "image_util/copyimage.h"
34#include "image_util/generatemip.h"
35#include "image_util/loadimage.h"
36
37#include "libANGLE/renderer/d3d/d3d11/formatutils11.h"
38#include "libANGLE/renderer/d3d/d3d11/renderer11_utils.h"
39#include "libANGLE/renderer/d3d/d3d11/texture_format_table_utils.h"
40
41using namespace angle;
42
43namespace rx
44{{
45
46namespace d3d11
47{{
48
49// static
50const Format &Format::Get(GLenum internalFormat, const Renderer11DeviceCaps &deviceCaps)
51{{
52    // clang-format off
53    switch (internalFormat)
54    {{
55{angle_format_info_cases}
56        default:
57            break;
58    }}
59    // clang-format on
60
61    UNREACHABLE();
62    static constexpr Format defaultInfo;
63    return defaultInfo;
64}}
65
66}}  // namespace d3d11
67
68}}  // namespace rx
69"""
70
71
72def get_swizzle_format_id(internal_format, angle_format):
73    angle_format_id = angle_format["formatName"]
74    if (internal_format == 'GL_NONE') or (angle_format_id == 'NONE'):
75        return 'GL_NONE'
76
77    elif 'swizzleFormat' in angle_format:
78        # For some special formats like compressed formats that don't have a clearly defined number
79        # of bits per channel, swizzle format needs to be specified manually.
80        return angle_format['swizzleFormat']
81
82    if 'bits' not in angle_format:
83        raise ValueError('no bits information for determining swizzleformat for format: ' +
84                         internal_format)
85
86    bits = angle_format['bits']
87    max_component_bits = max(bits.values())
88    bits_iter = iter(list(sorted(bits.values())))
89    channels_different = not all(
90        [component_bits == next(bits_iter) for component_bits in bits.values()])
91
92    # The format itself can be used for swizzles if it can be accessed as a render target and
93    # sampled and the bit count for all 4 channels is the same.
94    if "rtvFormat" in angle_format and "srvFormat" in angle_format and "uavFormat" in angle_format and not channels_different and len(
95            angle_format['channels']) == 4:
96        return angle_format[
97            "glInternalFormat"] if "glInternalFormat" in angle_format else internal_format
98
99    b = int(math.ceil(float(max_component_bits) / 8) * 8)
100
101    # Depth formats need special handling, since combined depth/stencil formats don't have a clearly
102    # defined component type.
103    if angle_format['channels'].find('d') >= 0:
104        if b == 24 or b == 32:
105            return 'GL_RGBA32F'
106        if b == 16:
107            return 'GL_RGBA16_EXT'
108
109    if b == 24:
110        raise ValueError('unexpected 24-bit format when determining swizzleformat for format: ' +
111                         internal_format)
112
113    if 'componentType' not in angle_format:
114        raise ValueError('no component type information for determining swizzleformat for format: '
115                         + internal_format)
116
117    component_type = angle_format['componentType']
118
119    swizzle = "GL_RGBA" + str(b)
120
121    if component_type == 'uint':
122        swizzle += "I"
123    elif component_type == 'int':
124        swizzle += "I"
125    elif component_type == 'unorm':
126        if (b == 16):
127            swizzle += "_EXT"
128    elif component_type == 'snorm':
129        swizzle += "_SNORM"
130        if (b == 16):
131            swizzle += "_EXT"
132    elif component_type == 'float':
133        swizzle += "F"
134        if (b == 16):
135            swizzle += "_EXT"
136    else:
137        raise ValueError('could not determine swizzleformat based on componentType for format: ' +
138                         internal_format)
139
140    return swizzle
141
142
143def get_blit_srv_format(angle_format):
144    if 'channels' not in angle_format:
145        return 'DXGI_FORMAT_UNKNOWN'
146    if 'r' in angle_format['channels'] and angle_format['componentType'] in ['int', 'uint']:
147        return angle_format['rtvFormat']
148
149    return angle_format["srvFormat"] if "srvFormat" in angle_format else "DXGI_FORMAT_UNKNOWN"
150
151
152format_entry_template = """{space}{{
153{space}    static constexpr Format info({internalFormat},
154{space}                                 angle::FormatID::{formatName},
155{space}                                 {texFormat},
156{space}                                 {srvFormat},
157{space}                                 {uavFormat},
158{space}                                 {rtvFormat},
159{space}                                 {dsvFormat},
160{space}                                 {blitSRVFormat},
161{space}                                 {stencilSRVFormat},
162{space}                                 {linearSRVFormat},
163{space}                                 {typelessFormat},
164{space}                                 {swizzleFormat},
165{space}                                 {initializer});
166{space}    return info;
167{space}}}
168"""
169
170split_format_entry_template = """{space}    {condition}
171{space}    {{
172{space}        static constexpr Format info({internalFormat},
173{space}                                     angle::FormatID::{formatName},
174{space}                                     {texFormat},
175{space}                                     {srvFormat},
176{space}                                     {uavFormat},
177{space}                                     {rtvFormat},
178{space}                                     {dsvFormat},
179{space}                                     {blitSRVFormat},
180{space}                                     {stencilSRVFormat},
181{space}                                     {linearSRVFormat},
182{space}                                     {typelessFormat},
183{space}                                     {swizzleFormat},
184{space}                                     {initializer});
185{space}        return info;
186{space}    }}
187"""
188
189
190def json_to_table_data(internal_format, format_name, prefix, json):
191
192    table_data = ""
193
194    parsed = {
195        "space": "        ",
196        "internalFormat": internal_format,
197        "formatName": format_name,
198        "texFormat": "DXGI_FORMAT_UNKNOWN",
199        "srvFormat": "DXGI_FORMAT_UNKNOWN",
200        "stencilSRVFormat": "DXGI_FORMAT_UNKNOWN",
201        "linearSRVFormat": "DXGI_FORMAT_UNKNOWN",
202        "uavFormat": "DXGI_FORMAT_UNKNOWN",
203        "rtvFormat": "DXGI_FORMAT_UNKNOWN",
204        "dsvFormat": "DXGI_FORMAT_UNKNOWN",
205        "typelessFormat": "DXGI_FORMAT_UNKNOWN",
206        "condition": prefix,
207    }
208
209    for k, v in sorted(json.items()):
210        parsed[k] = v
211
212    # Derived values.
213    parsed["blitSRVFormat"] = get_blit_srv_format(parsed)
214    parsed["swizzleFormat"] = get_swizzle_format_id(internal_format, parsed)
215    parsed["initializer"] = angle_format.get_internal_format_initializer(
216        internal_format, parsed["formatName"])
217
218    if len(prefix) > 0:
219        return split_format_entry_template.format(**parsed)
220    else:
221        return format_entry_template.format(**parsed)
222
223
224def parse_json_angle_format_case(format_name, angle_format, json_data):
225    supported_case = {}
226    unsupported_case = {}
227    support_test = None
228    fallback = None
229
230    for k, v in sorted(angle_format.items()):
231        if k == "FL10Plus":
232            assert support_test is None
233            support_test = "OnlyFL10Plus(deviceCaps)"
234            for k2, v2 in sorted(v.items()):
235                supported_case[k2] = v2
236        elif k == "FL9_3":
237            split = True
238            for k2, v2 in sorted(v.items()):
239                unsupported_case[k2] = v2
240        elif k == "supportTest":
241            assert support_test is None
242            support_test = v
243        elif k == "fallbackFormat":
244            fallback = v
245        else:
246            supported_case[k] = v
247            unsupported_case[k] = v
248
249    if fallback != None:
250        unsupported_case, _, _ = parse_json_angle_format_case(fallback, json_data[fallback],
251                                                              json_data)
252        unsupported_case["formatName"] = fallback
253
254    if support_test != None:
255        return supported_case, unsupported_case, support_test
256    else:
257        return supported_case, None, None
258
259
260def parse_json_into_switch_angle_format_string(json_map, json_data):
261    table_data = ''
262
263    for internal_format, format_name in sorted(json_map.items()):
264
265        if format_name not in json_data:
266            continue
267
268        # Typeless internal formats are fake formats just used to fit support
269        # for typeless D3D textures into the format system. Their properties
270        # should not be queried.
271        if 'TYPELESS' in internal_format:
272            continue
273
274        angle_format = json_data[format_name]
275
276        supported_case, unsupported_case, support_test = parse_json_angle_format_case(
277            format_name, angle_format, json_data)
278
279        table_data += '        case ' + internal_format + ':\n'
280
281        if support_test != None:
282            table_data += "        {\n"
283            table_data += json_to_table_data(internal_format, format_name,
284                                             "if (" + support_test + ")", supported_case)
285            table_data += json_to_table_data(internal_format, format_name, "else",
286                                             unsupported_case)
287            table_data += "        }\n"
288        else:
289            table_data += json_to_table_data(internal_format, format_name, "", supported_case)
290
291    return table_data
292
293
294def main():
295
296    map_file_name = 'texture_format_map.json'
297    data_source_name = 'texture_format_data.json'
298
299    # auto_script parameters.
300    if len(sys.argv) > 1:
301        inputs = ['../../angle_format.py', data_source_name, map_file_name]
302        outputs = ['texture_format_table_autogen.cpp']
303
304        if sys.argv[1] == 'inputs':
305            print(','.join(inputs))
306        elif sys.argv[1] == 'outputs':
307            print(','.join(outputs))
308        else:
309            print('Invalid script parameters')
310            return 1
311        return 0
312
313    json_map = angle_format.load_with_override(os.path.abspath(map_file_name))
314    json_data = angle_format.load_json(data_source_name)
315
316    angle_format_cases = parse_json_into_switch_angle_format_string(json_map, json_data)
317    output_cpp = template_texture_format_table_autogen_cpp.format(
318        script_name=os.path.basename(sys.argv[0]),
319        angle_format_info_cases=angle_format_cases,
320        data_source_name=data_source_name)
321    with open('texture_format_table_autogen.cpp', 'wt') as out_file:
322        out_file.write(output_cpp)
323        out_file.close()
324    return 0
325
326
327if __name__ == '__main__':
328    sys.exit(main())
329