Skip to content

Generate Vulkan Video fields for strict V3 #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antono3 merged 2 commits into from
Sep 22, 2026
Merged

Generate Vulkan Video fields for strict V3 #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15ce5b6
Generate Vulkan Video fields for strict V3
antono2 Sep 22, 2026
7a5bd68
Use current V version command in CI
antono2 Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 67 additions & 1 deletion .github/workflows/historical-registry-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,70 @@ jobs:
throw 'Vulkan Video bindings were not generated'
}

strict-v3-frontend:
name: Strict V3 frontend
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v7
- uses: actions/checkout@v7
with:
repository: KhronosGroup/Vulkan-Docs
ref: v1.4.362
path: vulkandocs
- uses: actions/checkout@v7
with:
repository: antono2/vulkan
path: published
- uses: actions/checkout@v7
with:
repository: vlang/v
ref: 239f06c1de4b6380b2c9d03eed023996951b2c74
path: .ci-v-source
fetch-depth: 1
- uses: actions/checkout@v7
with:
repository: vlang/vc
ref: 21490f7811a2dd366c3daa39bef8e53c1e3e5727
path: .ci-v-source/vc
fetch-depth: 1
- uses: actions/checkout@v7
with:
repository: vlang/tccbin
ref: d6e7ac1b1bcc98aed734a6ecbfa8509f24606c74
path: .ci-v-source/thirdparty/tcc
fetch-depth: 1
- uses: actions/setup-python@v7
with:
python-version: "3.x"
cache: pip
cache-dependency-path: .github/generator-requirements.txt
- name: Build pinned V3 compiler
run: |
make -C .ci-v-source local=1
echo "$GITHUB_WORKSPACE/.ci-v-source" >> "$GITHUB_PATH"
.ci-v-source/v version
- name: Generate and type-check current bindings
run: |
set -euo pipefail
python -m pip install --requirement .github/generator-requirements.txt
python src/main.py -registry vulkandocs/xml/vk.xml vulkan.v
python src/main.py -registry vulkandocs/xml/video.xml vulkan_video.v

grep -F 'pub type StdVideoH264ScalingListsScalingList4x4Array' \
src/vulkan_video.v
if grep -E '^[[:space:]]+[A-Z][A-Za-z0-9_]*[[:space:]]+\[' \
src/vulkan_video.v; then
echo 'PascalCase fixed-array fields must use named array aliases' >&2
exit 1
fi

install -m 0644 src/vulkan.v published/vulkan.v
install -m 0644 src/vulkan_video.v published/vulkan_video.v
install -d "$RUNNER_TEMP/vmodules/antono2"
ln -s "$GITHUB_WORKSPACE/published" \
"$RUNNER_TEMP/vmodules/antono2/vulkan"
VMODULES="$RUNNER_TEMP/vmodules" v -new-compiler -check test/main.c.v

generate-and-compile:
name: Vulkan-Docs ${{ matrix.version }}
strategy:
Expand Down Expand Up @@ -82,13 +146,15 @@ jobs:

required-checks:
if: always()
needs: [windows-generator, generate-and-compile]
needs: [windows-generator, strict-v3-frontend, generate-and-compile]
runs-on: ubuntu-24.04
steps:
- name: Verify historical registry matrix
env:
WINDOWS_RESULT: ${{ needs.windows-generator.result }}
V3_RESULT: ${{ needs.strict-v3-frontend.result }}
MATRIX_RESULT: ${{ needs.generate-and-compile.result }}
run: |
test "$WINDOWS_RESULT" = success
test "$V3_RESULT" = success
test "$MATRIX_RESULT" = success
72 changes: 27 additions & 45 deletions src/vgenerator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,39 +322,13 @@ class VOutputGenerator(OutputGenerator):

C_STRUCT_ARR_WITH_VK_PREFIX = []

# Used to find static C code, like #define VK_API_VERSION_MAJOR in appendSection
# The exact C code is then replaced in genType
REPLACEMENT_CONTAINS_ARR = [
'STD_VIDEO_DECODE_H264_FIELD_ORDER_COUNT_LIST_SIZE',
'VK_MAKE_VIDEO_STD_VERSION(major, minor, patch)',
'VK_STD_VULKAN_VIDEO_CODEC_H264_DECODE_API_VERSION_1_0_0',
'#define VK_STD_VULKAN_VIDEO_CODEC_H264_ENCODE_API_VERSION_1_0_0 VK_MAKE_VIDEO_STD_VERSION(1, 0, 0)',
'#define VK_STD_VULKAN_VIDEO_CODEC_H265_DECODE_API_VERSION_1_0_0 VK_MAKE_VIDEO_STD_VERSION(1, 0, 0)',
'VK_STD_VULKAN_VIDEO_CODEC_AV1_DECODE_API_VERSION_1_0_0',
'VK_STD_VULKAN_VIDEO_CODEC_AV1_ENCODE_API_VERSION_1_0_0',
'#define VK_DEFINE_HANDLE',
'\n#ifndef VK_DEFINE_NON_DISPATCHABLE_HANDLE\n #if (VK_USE_64_BIT_PTR_DEFINES==1)\n #if (defined(__cplusplus) && (__cplusplus >= 201103L)) || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201103L))\n #define VK_NULL_HANDLE nullptr\n #else\n #define VK_NULL_HANDLE ((void*)0)\n #endif\n #else\n #define VK_NULL_HANDLE 0ULL\n #endif\n#endif\n#ifndef VK_NULL_HANDLE\n #define VK_NULL_HANDLE 0\n#endif',
'\n#ifndef VK_USE_64_BIT_PTR_DEFINES\n #if defined(__LP64__) || defined(_WIN64) || (defined(__x86_64__) && !defined(__ILP32__) ) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__) || (defined(__riscv) && __riscv_xlen == 64)\n #define VK_USE_64_BIT_PTR_DEFINES 1\n #else\n #define VK_USE_64_BIT_PTR_DEFINES 0\n #endif\n#endif',
'\n#ifndef VK_DEFINE_NON_DISPATCHABLE_HANDLE\n #if (VK_USE_64_BIT_PTR_DEFINES==1)\n #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef struct object##_T *object;\n #else\n #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object;\n #endif\n#endif',
'#define VK_MAKE_API_VERSION(variant, major, minor, patch)',
'#define VK_API_VERSION_1_0',
'#define VK_HEADER_VERSION_COMPLETE',
'#define VK_MAKE_VERSION',
'#define VK_VERSION_MAJOR',
'#define VK_VERSION_MINOR',
'#define VK_VERSION_PATCH',
'#define VK_API_VERSION_VARIANT',
'#define VK_API_VERSION_MAJOR',
'#define VK_API_VERSION_MINOR',
'#define VK_API_VERSION_PATCH',
]

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# Internal state - accumulators for different inner block text
self.sections = {section: [] for section in self.ALL_SECTIONS}
self.feature_not_empty = False
self.may_alias = None
self.fixed_array_aliases = []

def beginFile(self, genOpts):
OutputGenerator.beginFile(self, genOpts)
Expand Down Expand Up @@ -514,12 +488,6 @@ def appendSection(self, section, text):
self.logMsg('error', 'Missing section in appendSection (probably a <type> element missing its \'category\' attribute. Text:', text)
exit(1)

# Add text to REPLACEMENT_EXACT_TEXT_ARR if it is in REPLACEMENT_CONTAINS_ARR
# See REPLACEMENT_CONTAINS_ARR for explanation
esc_text = self.escStr(text)
for starts_with in self.REPLACEMENT_CONTAINS_ARR:
if text.__contains__(starts_with):
self.REPLACEMENT_EXACT_TEXT_ARR.append(esc_text)
self.sections[section].append(text)
self.feature_not_empty = True

Expand Down Expand Up @@ -878,6 +846,20 @@ def genStruct(self, typeinfo, typeName, alias, keep_vk_member_name = False):
structextends = typeElem.get('structextends')
body += '// ' + typeName + ' extends ' + structextends + '\n' if structextends else ''

if typeName not in self.ALIAS_TO_BASE_TYPE_MAP:
self.ALIAS_TO_BASE_TYPE_MAP[typeName] = 'C.'+ typeNameOrig

targetLen = self.getMaxCParamTypeLength(typeinfo)
self.fixed_array_aliases = []
members = ''
for member in typeElem.findall('.//member'):
members += self.deprecationComment(member, indent = 4)
members += self.makeVParamDecl(typeName, member, targetLen + 4, do_struct_members = True, keep_vk_member_name = keep_vk_member_name)
members += '\n'

for alias_name, alias_type in self.fixed_array_aliases:
body += 'pub type ' + alias_name + ' = ' + alias_type + '\n'

body += 'pub type ' + typeName + ' = ' + 'C.'+ typeNameOrig + '\n'
if typeElem.get('category') == 'struct':
body += '@[typedef]\npub struct '
Expand All @@ -891,15 +873,8 @@ def genStruct(self, typeinfo, typeName, alias, keep_vk_member_name = False):
body += self.genOpts.aliasMacro

body += 'C.'+ typeNameOrig + ' {\n'
if typeName not in self.ALIAS_TO_BASE_TYPE_MAP:
self.ALIAS_TO_BASE_TYPE_MAP[typeName] = 'C.'+ typeNameOrig

targetLen = self.getMaxCParamTypeLength(typeinfo)
body += 'pub mut:\n'
for member in typeElem.findall('.//member'):
body += self.deprecationComment(member, indent = 4)
body += self.makeVParamDecl(typeName, member, targetLen + 4, do_struct_members = True, keep_vk_member_name = keep_vk_member_name)
body += '\n'
body += members
body += '}\n'
if protect_end:
body += protect_end
Expand Down Expand Up @@ -1475,6 +1450,17 @@ def makeVParamDecl(self, typeName, param, aligncol, do_c_func_params=False, do_c
if do_array_voidptr:
v_type = 'voidptr'

# Vulkan Video exposes several PascalCase C fields whose types are
# inline fixed arrays. V3 parses `FieldName [N]T` as an embedded
# type followed by an attribute. A named array alias removes that
# ambiguity while preserving the public field and its C spelling
# for stable V.
if (do_struct_members and elem is param[-1]
and v_name[:1].isupper() and v_type.startswith('[')):
alias_name = typeName + v_name + 'Array'
self.fixed_array_aliases.append((alias_name, v_type))
v_type = alias_name

v_name = self.make_v_param_name(
param,
v_name,
Expand Down Expand Up @@ -2190,10 +2176,6 @@ def build_video_std_api_version_const(self, c_body):
major, minor, patch = match.group(2), match.group(3), match.group(4)
return f'pub const std_vulkan_video_codec_{codec_name}_api_version_{major}_{minor}_{patch} = make_video_std_version({major}, {minor}, {patch})'

# If text contains `\` before new line, the mapping isn't found. This fixes it
def escStr(self, text) -> str:
return text.replace(r'\\', '\\\\').replace(r'\n', '\\n')

# NOTE Anton: the oiginal method comes from vulkandocs/scripts/generator.py
def deprecationComment(self, elem, indent = 0):
"""If an API element is marked deprecated, return a brief comment
Expand Down
Loading
Loading