Merge nougat-mr1-cts-dev into master.
[platform/upstream/VK-GL-CTS.git] / scripts / opengl / src_util.py
1 # -*- coding: utf-8 -*-
2
3 #-------------------------------------------------------------------------
4 # drawElements Quality Program utilities
5 # --------------------------------------
6 #
7 # Copyright 2015 The Android Open Source Project
8 #
9 # Licensed under the Apache License, Version 2.0 (the "License");
10 # you may not use this file except in compliance with the License.
11 # You may obtain a copy of the License at
12 #
13 #      http://www.apache.org/licenses/LICENSE-2.0
14 #
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
20 #
21 #-------------------------------------------------------------------------
22
23 import os
24 import re
25 import sys
26
27 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
28
29 import khr_util.format
30 import khr_util.registry
31 import khr_util.registry_cache
32
33 SCRIPTS_DIR                     = os.path.dirname(__file__)
34 OPENGL_DIR                      = os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "opengl"))
35 EGL_DIR                         = os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "egl"))
36 OPENGL_INC_DIR          = os.path.join(OPENGL_DIR, "wrapper")
37
38 GL_SOURCE                       = khr_util.registry_cache.RegistrySource(
39                                                 "gl.xml",
40                                                 32093,
41                                                 "3292120320cacbc27009e7507656d7be17bb25f06876814c67eeffa369281eed")
42
43 EXTENSIONS                      = [
44         'GL_KHR_texture_compression_astc_ldr',
45         'GL_KHR_blend_equation_advanced',
46         'GL_KHR_blend_equation_advanced_coherent',
47         'GL_KHR_debug',
48         'GL_EXT_geometry_point_size',
49         'GL_EXT_tessellation_shader',
50         'GL_EXT_geometry_shader',
51         'GL_EXT_texture_buffer',
52         'GL_EXT_texture_snorm',
53         'GL_EXT_primitive_bounding_box',
54         'GL_OES_EGL_image',
55         'GL_OES_compressed_ETC1_RGB8_texture',
56         'GL_OES_texture_half_float',
57         'GL_OES_texture_storage_multisample_2d_array',
58         'GL_OES_sample_shading',
59         'GL_EXT_texture_compression_s3tc',
60         'GL_IMG_texture_compression_pvrtc',
61         'GL_EXT_copy_image',
62         'GL_EXT_draw_buffers_indexed',
63         'GL_EXT_texture_sRGB_decode',
64         'GL_EXT_texture_border_clamp',
65         'GL_EXT_texture_sRGB_R8',
66         'GL_EXT_texture_sRGB_RG8',
67         'GL_EXT_debug_marker',
68         'GL_EXT_robustness',
69         'GL_KHR_robustness',
70 ]
71
72 def getGLRegistry ():
73         return khr_util.registry_cache.getRegistry(GL_SOURCE)
74
75 # return the name of a core command corresponding to an extension command.
76 # Ideally this should be done using the alias attribute of commands, but dEQP
77 # just strips the extension suffix.
78 def getCoreName (name):
79         return re.sub('[A-Z]+$', '', name)
80
81 def getHybridInterface ():
82         # This is a bit awkward, since we have to create a strange hybrid
83         # interface that includes both GL and ES features and extensions.
84         registry = getGLRegistry()
85         glFeatures = registry.getFeatures('gl')
86         esFeatures = registry.getFeatures('gles2')
87         spec = khr_util.registry.InterfaceSpec()
88
89         for feature in registry.getFeatures('gl'):
90                 spec.addFeature(feature, 'gl', 'core')
91
92         for feature in registry.getFeatures('gles2'):
93                 spec.addFeature(feature, 'gles2')
94
95         for extName in EXTENSIONS:
96                 extension = registry.extensions[extName]
97                 # Add all extensions using the ES2 api, but force even non-ES2
98                 # extensions to be included.
99                 spec.addExtension(extension, 'gles2', 'core', force=True)
100
101         # Remove redundant extension commands that are already provided by core.
102         for commandName in list(spec.commands):
103                 coreName = getCoreName(commandName)
104                 if coreName != commandName and coreName in spec.commands:
105                         spec.commands.remove(commandName)
106
107         return khr_util.registry.createInterface(registry, spec, 'gles2')
108
109 def getInterface (registry, api, version=None, profile=None, **kwargs):
110         spec = khr_util.registry.spec(registry, api, version, profile, **kwargs)
111         if api == 'gl' and profile == 'core' and version < "3.2":
112                 gl32 = registry.features['GL_VERSION_3_2']
113                 for eRemove in gl32.xpath('remove'):
114                         spec.addComponent(eRemove)
115         return khr_util.registry.createInterface(registry, spec, api)
116
117 def getVersionToken (api, version):
118         prefixes = { 'gles2': "ES", 'gl': "GL" }
119         return prefixes[api] + version.replace(".", "")
120
121 def genCommandList(iface, renderCommand, directory, filename, align=False):
122         lines = map(renderCommand, iface.commands)
123         lines = filter(lambda l: l != None, lines)
124         if align:
125                 lines = indentLines(lines)
126         writeInlFile(os.path.join(directory, filename), lines)
127
128 def genCommandLists(registry, renderCommand, check, directory, filePattern, align=False):
129         for eFeature in registry.features:
130                 api                     = eFeature.get('api')
131                 version         = eFeature.get('number')
132                 profile         = check(api, version)
133                 if profile is True:
134                         profile = None
135                 elif profile is False:
136                         continue
137                 iface           = getInterface(registry, api, version=version, profile=profile)
138                 filename        = filePattern % getVersionToken(api, version)
139                 genCommandList(iface, renderCommand, directory, filename, align)
140
141 def getFunctionTypeName (funcName):
142         return "%sFunc" % funcName
143
144 def getFunctionMemberName (funcName):
145         assert funcName[:2] == "gl"
146         if funcName[:5] == "glEGL":
147                 # Otherwise we end up with gl.eGLImage...
148                 return "egl%s" % funcName[5:]
149         else:
150                 return "%c%s" % (funcName[2].lower(), funcName[3:])
151
152 INL_HEADER = khr_util.format.genInlHeader("Khronos GL API description (gl.xml)", GL_SOURCE.getRevision())
153
154 def writeInlFile (filename, source):
155         khr_util.format.writeInlFile(filename, INL_HEADER, source)
156
157 # Aliases from khr_util.common
158 indentLines                     = khr_util.format.indentLines
159 normalizeConstant       = khr_util.format.normalizeConstant
160 commandParams           = khr_util.format.commandParams
161 commandArgs                     = khr_util.format.commandArgs