• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/python
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
11from datetime import date
12import json
13import math
14import pprint
15import os
16import sys
17
18sys.path.append('../..')
19import angle_format
20
21template_texture_format_table_autogen_cpp = """// GENERATED FILE - DO NOT EDIT.
22// Generated by {script_name} using data from {data_source_name}
23//
24// Copyright {copyright_year} The ANGLE Project Authors. All rights reserved.
25// Use of this source code is governed by a BSD-style license that can be
26// found in the LICENSE file.
27//
28// texture_format_table:
29//   Queries for full textureFormat information based in internalFormat
30//
31
32#include "libANGLE/renderer/d3d/d3d11/texture_format_table.h"
33
34#include "image_util/copyimage.h"
35#include "image_util/generatemip.h"
36#include "image_util/loadimage.h"
37
38#include "libANGLE/renderer/d3d/d3d11/formatutils11.h"
39#include "libANGLE/renderer/d3d/d3d11/renderer11_utils.h"
40#include "libANGLE/renderer/d3d/d3d11/texture_format_table_utils.h"
41
42using namespace angle;
43
44namespace rx
45{{
46
47namespace d3d11
48{{
49
50// static
51const Format &Format::Get(GLenum internalFormat, const Renderer11DeviceCaps &deviceCaps)
52{{
53    // clang-format off
54    switch (internalFormat)
55    {{
56{angle_format_info_cases}
57        default:
58            break;
59    }}
60    // clang-format on
61
62    UNREACHABLE();
63    static constexpr Format defaultInfo;
64    return defaultInfo;
65}}
66
67}}  // namespace d3d11
68
69}}  // namespace rx
70"""
71
72
73def get_swizzle_format_id(internal_format, angle_format):
74    angle_format_id = angle_format["formatName"]
75    if (internal_format == 'GL_NONE') or (angle_format_id == 'NONE'):
76        return 'GL_NONE'
77
78    elif 'swizzleFormat' in angle_format:
79        # For some special formats like compressed formats that don't have a clearly defined number
80        # of bits per channel, swizzle format needs to be specified manually.
81        return angle_format['swizzleFormat']
82
83    if 'bits' not in angle_format:
84        raise ValueError('no bits information for determining swizzleformat for format: ' +
85                         internal_format)
86
87    bits = angle_format['bits']
88    max_component_bits = max(bits.itervalues())
89    channels_different = not all(
90        [component_bits == bits.itervalues().next() for component_bits in bits.itervalues()])
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}                                 {swizzleFormat},
162{space}                                 {initializer});
163{space}    return info;
164{space}}}
165"""
166
167split_format_entry_template = """{space}    {condition}
168{space}    {{
169{space}        static constexpr Format info({internalFormat},
170{space}                                     angle::FormatID::{formatName},
171{space}                                     {texFormat},
172{space}                                     {srvFormat},
173{space}                                     {uavFormat},
174{space}                                     {rtvFormat},
175{space}                                     {dsvFormat},
176{space}                                     {blitSRVFormat},
177{space}                                     {swizzleFormat},
178{space}                                     {initializer});
179{space}        return info;
180{space}    }}
181"""
182
183
184def json_to_table_data(internal_format, format_name, prefix, json):
185
186    table_data = ""
187
188    parsed = {
189        "space": "        ",
190        "internalFormat": internal_format,
191        "formatName": format_name,
192        "texFormat": "DXGI_FORMAT_UNKNOWN",
193        "srvFormat": "DXGI_FORMAT_UNKNOWN",
194        "uavFormat": "DXGI_FORMAT_UNKNOWN",
195        "rtvFormat": "DXGI_FORMAT_UNKNOWN",
196        "dsvFormat": "DXGI_FORMAT_UNKNOWN",
197        "condition": prefix,
198    }
199
200    for k, v in json.iteritems():
201        parsed[k] = v
202
203    # Derived values.
204    parsed["blitSRVFormat"] = get_blit_srv_format(parsed)
205    parsed["swizzleFormat"] = get_swizzle_format_id(internal_format, parsed)
206    parsed["initializer"] = angle_format.get_internal_format_initializer(
207        internal_format, parsed["formatName"])
208
209    if len(prefix) > 0:
210        return split_format_entry_template.format(**parsed)
211    else:
212        return format_entry_template.format(**parsed)
213
214
215def parse_json_angle_format_case(format_name, angle_format, json_data):
216    supported_case = {}
217    unsupported_case = {}
218    support_test = None
219    fallback = None
220
221    for k, v in angle_format.iteritems():
222        if k == "FL10Plus":
223            assert support_test is None
224            support_test = "OnlyFL10Plus(deviceCaps)"
225            for k2, v2 in v.iteritems():
226                supported_case[k2] = v2
227        elif k == "FL9_3":
228            split = True
229            for k2, v2 in v.iteritems():
230                unsupported_case[k2] = v2
231        elif k == "supportTest":
232            assert support_test is None
233            support_test = v
234        elif k == "fallbackFormat":
235            fallback = v
236        else:
237            supported_case[k] = v
238            unsupported_case[k] = v
239
240    if fallback != None:
241        unsupported_case, _, _ = parse_json_angle_format_case(fallback, json_data[fallback],
242                                                              json_data)
243        unsupported_case["formatName"] = fallback
244
245    if support_test != None:
246        return supported_case, unsupported_case, support_test
247    else:
248        return supported_case, None, None
249
250
251def parse_json_into_switch_angle_format_string(json_map, json_data):
252    table_data = ''
253
254    for internal_format, format_name in sorted(json_map.iteritems()):
255
256        if format_name not in json_data:
257            continue
258
259        # Typeless internal formats are dummy formats just used to fit support
260        # for typeless D3D textures into the format system. Their properties
261        # should not be queried.
262        if 'TYPELESS' in internal_format:
263            continue
264
265        angle_format = json_data[format_name]
266
267        supported_case, unsupported_case, support_test = parse_json_angle_format_case(
268            format_name, angle_format, json_data)
269
270        table_data += '        case ' + internal_format + ':\n'
271
272        if support_test != None:
273            table_data += "        {\n"
274            table_data += json_to_table_data(internal_format, format_name,
275                                             "if (" + support_test + ")", supported_case)
276            table_data += json_to_table_data(internal_format, format_name, "else",
277                                             unsupported_case)
278            table_data += "        }\n"
279        else:
280            table_data += json_to_table_data(internal_format, format_name, "", supported_case)
281
282    return table_data
283
284
285def main():
286
287    # auto_script parameters.
288    if len(sys.argv) > 1:
289        inputs = ['../../angle_format.py', 'texture_format_data.json', 'texture_format_map.json']
290        outputs = ['texture_format_table_autogen.cpp']
291
292        if sys.argv[1] == 'inputs':
293            print ','.join(inputs)
294        elif sys.argv[1] == 'outputs':
295            print ','.join(outputs)
296        else:
297            print('Invalid script parameters')
298            return 1
299        return 0
300
301    json_map = angle_format.load_with_override(os.path.abspath('texture_format_map.json'))
302    data_source_name = 'texture_format_data.json'
303    json_data = angle_format.load_json(data_source_name)
304
305    angle_format_cases = parse_json_into_switch_angle_format_string(json_map, json_data)
306    output_cpp = template_texture_format_table_autogen_cpp.format(
307        script_name=sys.argv[0],
308        copyright_year=date.today().year,
309        angle_format_info_cases=angle_format_cases,
310        data_source_name=data_source_name)
311    with open('texture_format_table_autogen.cpp', 'wt') as out_file:
312        out_file.write(output_cpp)
313        out_file.close()
314    return 0
315
316
317if __name__ == '__main__':
318    sys.exit(main())
319