Files
VRMify-Enhanced/tests/test_fbx_helpers.py
T
Black-Cyan 60cce66993
Tests / test (push) Has been cancelled
初始化 VRMify 增强版(VRMify Enhanced)
导入上游源码,为所有面向用户的品牌显示处添加「增强版 / Enhanced」标识;包含 unitypackage→VRM 的纯色 Toon 材质、兽耳 SpringBone、Unity 描边、UV 接缝白边补偿修复,以及默认不强制 T-pose。146 个单元测试通过。
2026-11-15 23:21:59 +08:00

401 lines
19 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# -*- coding: utf-8 -*-
"""FBX / Unity 资源相关的小函数:英文骨名、英文表情名、Unity 材质找贴图、欧拉角顺序、替换网格。
不需要真实模型(Unity 酱、Query 酱实测中发现的问题都在这里留了用例)。
"""
import io
import math
import os
import shutil
import sys
import tarfile
import tempfile
import unittest
HERE = os.path.dirname(os.path.abspath(__file__))
ROOT = os.path.dirname(HERE)
for _p in (os.path.join(ROOT, "convert"), os.path.join(ROOT, "formats")):
if _p not in sys.path:
sys.path.insert(0, _p)
import fbx2pmx # noqa: E402
import unityasset # noqa: E402
import unitypackage_unpack # noqa: E402
from vrmconv.expressions import _preset_en # noqa: E402
from vrmconv.humanoid import _en_bone, _map_humanoid # noqa: E402
class BoneNameTest(unittest.TestCase):
def test_conventions(self):
cases = {
"Character1_Hips": ("slot", "hips"), "Character1_Spine1": ("slot", "chest"),
"Character1_LeftUpLeg": ("slot", "leftUpperLeg"), "Character1_LeftLeg": ("slot", "leftLowerLeg"),
"Chr_RightForeArm": ("slot", "rightLowerArm"), "mixamorig:LeftHand": ("slot", "leftHand"),
"J_Bip_C_UpperChest": ("slot", "upperChest"), "J_Bip_L_UpperArm": ("slot", "leftUpperArm"),
"thigh.L": ("slot", "leftUpperLeg"), "Bip001 R Calf": ("slot", "rightLowerLeg"),
"Bip001 Pelvis": ("slot", "hips"), "Eye_R": ("slot", "rightEye"),
"Character1_LeftHandThumb1": ("finger", ("left", "Thumb", 0)),
"Character1_RightHandIndex3": ("finger", ("right", "Index", 3)),
}
for name, want in cases.items():
self.assertEqual(_en_bone(name), want, name)
def test_not_humanoid(self):
for name in ("J_L_HairTail_00", "skirt_L_01", "Pai_L", "J_Mune_root_00", "Root", "H02_L",
"Character1_RightHandPinky4", "J_L_Sode_A00"):
self.assertIsNone(_en_bone(name), name)
def test_leg_without_upleg(self):
# 只有 Leg(没有 UpLeg / Thigh)时 Leg 是大腿
names = ["Hips", "Spine", "Leg_L", "Knee_L", "Foot_L"]
bones = [{"name": n, "name_en": n} for n in names]
human = _map_humanoid(bones, True, {})
self.assertEqual(human.get("leftUpperLeg"), 2)
self.assertEqual(human.get("leftLowerLeg"), 3)
def test_unity_finger_names(self):
"""Unity / VRChat 的「Index Proximal.L」:其余手指 1~3;拇指 Proximal / Intermediate / Distal = 0~2,
有 ThumbMetacarpal(VRM 1.0 风格)时 Metacarpal / Proximal / Distal = 0~2。"""
self.assertEqual(_en_bone("Index Proximal.L"), ("finger", ("left", "Index", 1)))
self.assertEqual(_en_bone("Little Distal.R"), ("finger", ("right", "Little", 3)))
self.assertEqual(_en_bone("Thumb Proximal.L"), ("finger", ("left", "Thumb", 0)))
self.assertEqual(_en_bone("Thumb Intermediate.L"), ("finger", ("left", "Thumb", 1)))
self.assertEqual(_en_bone("J_Bip_L_ThumbProximal", True), ("finger", ("left", "Thumb", 1)))
self.assertEqual(_en_bone("J_Bip_L_ThumbMetacarpal", True), ("finger", ("left", "Thumb", 0)))
names = ["Hips", "Spine", "Chest", "Neck", "Head", "Upper_arm.L", "Lower_arm.L", "Hand.L"] + ["%s %s.L" % (f, s) for f in ("Thumb", "Index", "Middle", "Ring", "Little")
for s in ("Proximal", "Intermediate", "Distal")]
human = _map_humanoid([{"name": n, "name_en": n} for n in names], True, {})
self.assertEqual(names[human["leftThumbMetacarpal"]], "Thumb Proximal.L")
self.assertEqual(names[human["leftThumbDistal"]], "Thumb Distal.L")
self.assertEqual(names[human["leftIndexProximal"]], "Index Proximal.L")
self.assertEqual(names[human["leftLittleDistal"]], "Little Distal.L")
def test_mmd_names_win(self):
bones = [{"name": "下半身", "name_en": ""}, {"name": "Hips", "name_en": ""}]
self.assertEqual(_map_humanoid(bones, True, {})["hips"], 0)
def test_mmd_names_win_over_earlier_name_en(self):
"""模型旁边另放的控制骨(左肩調整,英文名和本体一样是 L_Shoulder)排在前面,也不能抢走 左肩。"""
bones = [{"name": "左肩調整", "name_en": "L_Shoulder"}, {"name": "上半身3", "name_en": ""},
{"name": "左肩", "name_en": "L_Shoulder"}, {"name": "右肩調整", "name_en": "R_Shoulder"}]
human = _map_humanoid(bones, True, {})
self.assertEqual(human["leftShoulder"], 2)
self.assertEqual(human["rightShoulder"], 3) # 没有日文名的,英文名照常补位
class ExpressionNameTest(unittest.TestCase):
def test_presets(self):
cases = {"MTH_A": "aa", "Fcl_MTH_E": "ee", "vrc.v_oh": "oh", "EYE_DEF_C": "blink",
"Fcl_EYE_Close_L": "blinkLeft", "Blink_R": "blinkRight", "Fcl_ALL_Joy": "happy",
"Head_02_MouthOpen": "aa", "happy": "happy"}
for name, want in cases.items():
self.assertEqual(_preset_en(name, True), want, name)
self.assertEqual(_preset_en("Fcl_ALL_Joy", False), "joy")
self.assertEqual(_preset_en("vrc.blink_left", False), "blink_l")
def test_lookup(self):
from vrmconv.expressions import Lookup
lk = Lookup(["怒りA", "キリッ", "eyeBlink_L", "EyeBlink_R", "上L", "にこり2"])
self.assertEqual(lk.get("怒り"), "怒りA") # 变体后缀
self.assertEqual(lk.get("キリッ"), "キリッ") # 半角片假名
self.assertEqual(lk.get("にこり2"), "にこり2") # 全角数字
self.assertEqual(lk.all(("eyeBlinkLeft", "eyeBlinkRight")), ("eyeBlink_L", "EyeBlink_R"))
self.assertIsNone(lk.get("上")) # 单边的不算
self.assertIsNone(lk.all(("eyeBlinkLeft", "eyeWideRight")))
def test_en_parts_and_arkit(self):
from vrmconv.expressions import Lookup, _en_part, combo_recipes
lk = Lookup(["Fcl_BRW_Angry", "Fcl_EYE_Joy", "Mouth_Laugh1", "Mouth_Smile1", "Eye_Smile_L", "Fcl_ALL_Sorrow"])
self.assertEqual(_en_part(lk, "angry", 1), "Fcl_BRW_Angry")
self.assertEqual(_en_part(lk, "happy", 2), "Fcl_EYE_Joy") # 单边的 Eye_Smile_L 不算
self.assertEqual(_en_part(lk, "happy", 3), "Mouth_Smile1") # smile 先于 laugh
self.assertIsNone(_en_part(lk, "sad", 1)) # ALL 是整张脸,不当部位
# 只有 ARKit:各部位都从 ARKit 来;每个表情动不同的顶点,不会被当成重叠
names = ["browDownLeft", "browDownRight", "eyeSquintLeft", "eyeSquintRight", "mouthFrownLeft",
"mouthFrownRight", "browInnerUp"]
deltas = {n: {k: (0.0, 0.1, 0.0)} for k, n in enumerate(names)}
r = combo_recipes(deltas, {})
self.assertEqual(r["angry"], [("browDownLeft", 0.5, 1), ("browDownRight", 0.5, 1),
("eyeSquintLeft", 0.3, 2), ("eyeSquintRight", 0.3, 2),
("mouthFrownLeft", 0.4, 3), ("mouthFrownRight", 0.4, 3)])
self.assertEqual([n for n, _, _ in r["sad"]], ["browInnerUp", "mouthFrownLeft", "mouthFrownRight"])
def test_not_presets(self):
for name in ("MTH_SMILE1", "Fcl_BRW_Angry", "Key 1", "eye_a", "Basis", "EYE_SMILE1"):
self.assertIsNone(_preset_en(name, True), name)
MAT_U5 = """%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
--- !u!21 &2100000
Material:
m_Name: mat_Body
m_SavedProperties:
m_TexEnvs:
- _BumpMap:
m_Texture: {fileID: 2800000, guid: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, type: 3}
- _MainTex:
m_Texture: {fileID: 2800000, guid: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, type: 3}
m_Floats: []
"""
MAT_U4 = """%YAML 1.1
--- !u!21 &2100000
Material:
m_Name: mat_Hair
m_SavedProperties:
m_TexEnvs:
data:
first:
name: _MainTex
second:
m_Texture: {fileID: 0}
data:
first:
name: _Main_Texture
second:
m_Texture: {fileID: 2800000, guid: cccccccccccccccccccccccccccccccc, type: 3}
m_Floats:
data:
first:
name: _Cutoff
"""
def _write(path, data):
with open(path, "wb" if isinstance(data, bytes) else "w", **({} if isinstance(data, bytes) else {"encoding": "utf-8"})) as f:
f.write(data)
class UnityAssetTest(unittest.TestCase):
def setUp(self):
self.tmp = tempfile.mkdtemp(prefix="m2v_unity_")
a = os.path.join(self.tmp, "Assets")
for sub in ("Chara/Models", "Chara/Materials", "Chara/Textures", "Other/Materials"):
os.makedirs(os.path.join(a, sub))
def tex(name, guid):
p = os.path.join(a, "Chara/Textures", name)
open(p, "wb").write(b"x")
open(p + ".meta", "w").write("fileFormatVersion: 2\nguid: %s\n" % guid)
tex("tex_body.tga", "a" * 32)
tex("tex_body_n.tga", "b" * 32)
tex("tex_hair.png", "c" * 32)
tex("tex_other.png", "d" * 32)
_write(os.path.join(a, "Chara/Materials/mat_Body.mat"), MAT_U5)
_write(os.path.join(a, "Chara/Materials/mat_Hair.mat"), MAT_U4)
# 别处的同名材质:不在 FBX 的上级链上,不该被选中
_write(os.path.join(a, "Other/Materials/mat_Body.mat"), MAT_U5.replace("a" * 32, "d" * 32))
self.models = os.path.join(a, "Chara/Models")
def tearDown(self):
shutil.rmtree(self.tmp, ignore_errors=True)
def test_lookup(self):
m = unityasset.material_textures(self.models)
self.assertEqual(os.path.basename(m["mat_Body"]), "tex_body.tga") # _MainTex,不是法线
self.assertEqual(os.path.basename(m["mat_Hair"]), "tex_hair.png") # Unity 4 格式、空的 _MainTex 跳过
def test_root(self):
self.assertEqual(os.path.basename(unityasset.find_root(self.models)), "Assets")
def test_solid_color_mat(self):
"""Toon 材质常常没有贴图,颜色只在 m_Colors 里:以前 `not guid_path` 直接返回 {},
这类材质全被当成默认白色丢掉。Unity 5 / Unity 4 两种写法都要认。"""
tmp = tempfile.mkdtemp(prefix="m2v_solid_")
try:
mats = os.path.join(tmp, "Assets", "Materials")
os.makedirs(mats)
u5 = """%YAML 1.1
%TAG !u! tag:unity3d.com,2011:
--- !u!21 &2100000
Material:
m_Name: mat_Black
m_SavedProperties:
m_Colors:
- _ShadeColor: {r: 0.5, g: 0.5, b: 0.5, a: 1}
- _Color: {r: 0, g: 0, b: 0, a: 1}
m_TexEnvs:
- _MainTex:
m_Texture: {fileID: 0}
m_Floats: []
"""
u4 = """%YAML 1.1
--- !u!21 &2100000
Material:
m_Name: mat_White
m_SavedProperties:
m_Colors:
data:
first:
name: _Color
second:
val: {r: 1, g: 1, b: 1, a: 1}
m_TexEnvs: []
"""
_write(os.path.join(mats, "mat_Black.mat"), u5)
_write(os.path.join(mats, "mat_White.mat"), u4)
props = unityasset.material_properties(mats)
self.assertIsNone(props["mat_Black"]["tex"])
self.assertEqual(props["mat_Black"]["color"], [0.0, 0.0, 0.0, 1.0])
self.assertIsNone(props["mat_White"]["tex"])
self.assertEqual(props["mat_White"]["color"], [1.0, 1.0, 1.0, 1.0])
# 兼容旧接口:只返回有贴图的材质
self.assertEqual(unityasset.material_textures(mats), {})
finally:
shutil.rmtree(tmp, ignore_errors=True)
def test_outline_settings(self):
"""UCTS / Toon shader 的描边只在 .mat 里(FBX 完全没有):宽度、颜色要读出来;
`_Outline_Width: 0` 是没开描边,不能一律给所有材质加轮廓线。"""
tmp = tempfile.mkdtemp(prefix="m2v_outline_")
try:
mats = os.path.join(tmp, "Assets", "Materials")
os.makedirs(mats)
def mat(nm, width):
return """%%YAML 1.1
--- !u!21 &2100000
Material:
m_Name: %s
m_ShaderKeywords: _EMISSIVE_SIMPLE _OUTLINE_NML
m_SavedProperties:
m_TexEnvs: []
m_Floats:
- _Outline_Width: %s
- _Farthest_Distance: 100
m_Colors:
- _Color: {r: 1, g: 1, b: 1, a: 1}
- _Outline_Color: {r: 0.2, g: 0.1, b: 0.3, a: 1}
""" % (nm, width)
_write(os.path.join(mats, "mat_Base.mat"), mat("mat_Base", 20))
_write(os.path.join(mats, "mat_NoOutline.mat"), mat("mat_NoOutline", 0))
props = unityasset.material_properties(mats)
ol = props["mat_Base"]["outline"]
self.assertAlmostEqual(ol["width"], 20.0)
self.assertEqual(ol["color"], [0.2, 0.1, 0.3])
self.assertEqual(ol["mode"], "NML")
self.assertIsNone(props["mat_NoOutline"]["outline"])
finally:
shutil.rmtree(tmp, ignore_errors=True)
def test_solid_png(self):
import vrmio
data = fbx2pmx._solid_png((0.0, 0.0, 0.0))
w, h, rows = vrmio.decode_rgba(data)
self.assertEqual((w, h), (4, 4))
self.assertEqual(rows[0][0][:3], (0, 0, 0))
self.assertEqual(rows[3][3][3], 255)
class UnitypackageTest(unittest.TestCase):
"""unitypackage 解包(流式读一遍):一个资源的成员挨着放,pathname 在 asset 前后都行。"""
def test_unpack(self):
tmp = tempfile.mkdtemp(prefix="m2v_up_")
try:
pkg = os.path.join(tmp, "a.unitypackage")
with tarfile.open(pkg, "w:gz") as tf:
for name, data in (
("a1/asset", b"FBX"), ("a1/asset.meta", b"m1"), ("a1/pathname", b"Assets/Chara/model.fbx"),
("a1/preview.png", b"png"),
("b2/pathname", b"Assets/Chara/tex.png"), ("b2/asset", b"PNG"), # pathname 在前
("c3/asset.meta", b"m3"), ("c3/pathname", b"Assets/Empty/"), # 文件夹资源:没有 asset
("d4/asset", b"lost")): # 没有 pathname
info = tarfile.TarInfo(name)
info.size = len(data)
tf.addfile(info, io.BytesIO(data))
out = os.path.join(tmp, "out")
unitypackage_unpack.unpack(pkg, out, verbose=False)
got = {}
for d, ds, fs in os.walk(out):
for x in ds:
got[os.path.relpath(os.path.join(d, x), out).replace("\\", "/")] = None
for x in fs:
with open(os.path.join(d, x), "rb") as f:
got[os.path.relpath(os.path.join(d, x), out).replace("\\", "/")] = f.read()
self.assertEqual(got, {
"Chara": None, "Chara/model.fbx": b"FBX", "Chara/model.fbx.meta": b"m1",
"Chara/model.fbx.pathname": b"Assets/Chara/model.fbx", "Chara/model.fbx.preview.png": b"png",
"Chara/tex.png": b"PNG", "Chara/tex.png.pathname": b"Assets/Chara/tex.png",
"Empty": None, "Empty.meta": b"m3", "Empty.pathname": b"Assets/Empty/",
"d4": b"lost"})
finally:
shutil.rmtree(tmp, ignore_errors=True)
class FbxMathTest(unittest.TestCase):
def test_rotation_order(self):
# 默认(XYZ)和以前一样:Rz·Ry·Rx
r = (30.0, 40.0, 50.0)
m_x = fbx2pmx.m_trs([0, 0, 0], (r[0], 0, 0), [1, 1, 1])
m_y = fbx2pmx.m_trs([0, 0, 0], (0, r[1], 0), [1, 1, 1])
m_z = fbx2pmx.m_trs([0, 0, 0], (0, 0, r[2]), [1, 1, 1])
want_xyz = fbx2pmx.m_mul(m_z, fbx2pmx.m_mul(m_y, m_x))
want_zxy = fbx2pmx.m_mul(m_y, fbx2pmx.m_mul(m_x, m_z)) # 4 = ZXY:先 Z 再 X 再 Y
for got, want in ((fbx2pmx.m_rot(r), want_xyz), (fbx2pmx.m_rot(r, 4), want_zxy)):
for a, b in zip(got, want):
self.assertAlmostEqual(a, b, places=9)
def test_pivot_is_translation(self):
class N:
def get(self, k):
return None
sc = fbx2pmx.Scene.__new__(fbx2pmx.Scene)
sc._props70 = lambda node: {"Lcl Rotation": [0.0, 0.0, 90.0], "RotationPivot": [1.0, 0.0, 0.0]}
m = fbx2pmx.Scene._local_matrix(sc, N())
# 绕 (1,0,0) 转 90°:原点 → (1,-1,0)
p = fbx2pmx.m_point(m, (0.0, 0.0, 0.0))
self.assertAlmostEqual(p[0], 1.0, places=6)
self.assertAlmostEqual(p[1], -1.0, places=6)
self.assertTrue(math.isfinite(p[2]))
class AlternateMeshTest(unittest.TestCase):
def rec(self, name, nv=100, lo=(0, 0, 0), hi=(1, 1, 1)):
return {"name": name, "nv": nv, "nt": nv * 2, "lo": list(lo), "hi": list(hi), "segs": [len(name)]}
def test_groups(self):
recs = [self.rec("Body", 500), self.rec("Finger_Pa"), self.rec("Finger_Nomal"), self.rec("Finger_Gu"),
self.rec("Head_01_Normal", 300, (0, 2, 0), (1, 3, 1)),
self.rec("Head_02_MouthOpen", 300, (0, 2, 0), (1, 3, 1)),
self.rec("Glove_L", 100, (5, 0, 0), (6, 1, 1))] # 同样的顶点数,但位置不同
groups = fbx2pmx._alternate_groups(recs)
got = {p["name"]: sorted(a["name"] for a in alts) for p, alts in groups}
self.assertEqual(got, {"Finger_Nomal": ["Finger_Gu", "Finger_Pa"],
"Head_01_Normal": ["Head_02_MouthOpen"]})
class AutoPhysTest(unittest.TestCase):
"""自动物理的兽耳识别:BlackCyan 的 Ear_0_L…Ear_3_R 八根骨曾全被 _FACE 当五官排除。"""
def _sway(self, spec):
# spec: [(骨名, 父骨序号, 位置)],0 = 头、1 = 腰(humanoid)
from vrmconv import autophys
bones = [{"name": n, "name_en": n, "pos": p, "parent": q, "layer": 0,
"flag": 0x001F, "tail": -1} for n, q, p in spec]
model = {"bones": bones, "rigid_bodies": [], "vertices": []}
autophys.synthesize(model, [q for _, q, _ in spec], {}, {"head": 0, "hips": 1})
return {rb["name"] for rb in model["rigid_bodies"] if rb["mode"] == 1}
def test_animal_ear_chains_sway(self):
got = self._sway([
("Head", -1, (0, 10, 0)), ("Hips", -1, (0, 0, 0)),
("Ear_0_L", 0, (1, 10.2, 0)), ("Ear_1_L", 2, (1.2, 10.5, 0)),
("Ear_0_R", 0, (-1, 10.2, 0)), ("Ear_1_R", 4, (-1.2, 10.5, 0)),
("Earring_L", 0, (1.5, 9.5, 0)), # 耳环是挂件,不能跟着摆
("Hair_0", 0, (0, 11, 0)), # 有头发骨时结构推断关闭,兽耳仍要识别
])
for nm in ("Ear_0_L", "Ear_1_L", "Ear_0_R", "Ear_1_R", "Hair_0"):
self.assertIn("auto_" + nm, got)
self.assertNotIn("auto_Earring_L", got)
def test_single_ear_bone_does_not_sway(self):
"""人形模型单根的耳朵 / 表情骨仍由 _FACE 拦住(有头发骨和没头发骨两种结构都要挡)。"""
for extra in ([("Hair_0", 0, (0, 11, 0))], []):
got = self._sway([("Head", -1, (0, 10, 0)), ("Hips", -1, (0, 0, 0)),
("Ear_L", 0, (1, 10.2, 0))] + extra)
self.assertNotIn("auto_Ear_L", got)
if __name__ == "__main__":
unittest.main()