前言
MikuMikuDance（简称MMD）是一款动画软件，早期视为Vocaload角色制作动画的软件，现在还经常能在B站等视频网站，或一些动画网站（某I站）看到MMD作品。
我在高中也简单学过操作这款软件以及PE、水杉等软件，学会了简单k帧、套动作、调渲染、加后期、压缩等技术，这与我学习计算机专业有很大的关系（虽然学校学的和这个八竿子打不着，或许我应该学美术去）,现在已经分不清很多东西了，封面静画就是杂七杂八过气MME一锅扔的成果，得益于G渲的强大，还能看出一点效果。
现在我想学一些3D的开发，包括用程序读取模型、动作等，很快我就想到之前用过的MMD。
一些3D姿势估计（3D pose estimate）或许能得到骨骼位置以及PAF（骨骼间关系），但我需要知道3D动画是如何储存动作数据的，才能想到怎样将姿势估计得到的数据转化为动作数据。
因此我找了一些资料解析MMD的动作数据VMD（Vocaload Mation Data）文件，并写下这篇记录。
我的参考文献：
MMD中的VMD文件格式详解国内博客，解释VMD格式并用Java读取
VMD file formatMMD Wiki
本文会用python解析vmd文件，并纠正上述文章的一点错误。
根据MMD的规矩，上借物表：
| 名称 | 来源 |
|---|---|
| MikuMikuDanceE_v803 | 圝龙龍龖龘圝 |
| 八重樱 | 神帝宇 |
封面静画：
| 名称 | 类别\来源 |
|---|---|
| LightBloom | 背光 |
| AutoLuminousBasic | 自发光特效 |
| HgSAO | 阴影 |
| SoftLightSB | 柔化 |
| SvSSAO | 阴影 |
| XDOF | 景深 |
| dGreenerShader | G渲 |
| Tokyo Stage | 场景 |
一、格式说明
首先，vmd文件本身是一个二进制文件，里面装着类型不同的数据：uint8、uint32_t、float，甚至还有不同编码的字符串，因此我们需要二进制流读入这个文件。
vmd格式很像计算机网络的协议格式，某某位是什么含义，区别是，vmd文件的长度理论上是无限的，让我们来看看。
vmd的大致格式如下：
- 头部
- 关键帧数量
- 关键帧
头部
最开始的就是头部（header），看到这就有十分强烈的既视感：
| 类型 | 长度 | 含义 |
|---|---|---|
| byte | 30 | 版本信息 |
| byte | 10 or 20 | 模型名称 |
其中，版本信息（VersionInformation）长度为30，是ascii编码的字符串，翻译过来有两种，一为“Vocaloid Motion Data file”，二为“Vocaloid Motion Data 0002”，长度不足30后用\0（或者说b'\x00'）填充。这是由于vmd版本有两种，大概是为了解决模型名称长度不足，因此后续只影响模型名称的占用长度。
模型名称（ModelName），是动作数据保存时用的模型的模型名，通过这个我们可以获取到那个名称，我们知道，一个动作数据想要运作起来，只要套用模型的骨骼名称是标准的模板就可以，因此我想象不出这个名称有何用处，或许某些模型带有特殊骨骼，例如翅膀之类的，这样能方便回溯？模型名称的长度根据版本而决定，version1为10，version长度为20。编码原文写的是shift-JIS，是日语编码，这样想没错，然而我试验后发现并非如此，例如经常改模型的大神神帝宇的模型，他的模型名称用shift-JIS为乱码，用gb2312竟然能正常读出来；还有机动牛肉大神的模型，他的模型名称用gb2312无法解码，用shift-JIS解码竟然是正常的简体中文？？？怎么做到的？
骨骼关键帧（BoneKeyFrame）
骨骼关键帧，分为两部分：骨骼关键帧数、骨骼关键帧记录：
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 骨骼关键帧数量 BoneKeyFrameNumber |
| 类型 | 长度 | 含义 |
|---|---|---|
| byte | 15 | 骨骼名称 BoneName |
| uint32_t | 4 | 关键帧时间 FrameTime |
| float*3 | 12 | x,y,z空间坐标 Translation.xyz |
| float*4 | 16 | 旋转四元数x,y,z,w Rotation.xyzw |
| uint8_t * 16 or uint32 * 4 | 16 | 补间曲线x的坐标 XCurve |
| uint8_t * 16 or uint32 * 4 | 16 | 补间曲线y的坐标 YCurve |
| uint8_t * 16 or uint32 * 4 | 16 | 补间曲线z的坐标 ZCurve |
| uint8_t * 16 or uint32 * 4 | 16 | 补间曲线旋转的坐标 RCurve |
| byte | 111 | 合计 |
我们可以查一下，每个骨骼关键帧的数量为111字节。
旋转坐标
一开始还没发现，旋转坐标竟然有四个，分别为x, y, z, w，急的我去MMD里查看一下，发现和我印象中没有什么差别
补间曲线
为何补间曲线的类型不确定呢？上面csdn博客的教程说“uint8_t那里有冗余，每四个只读第一个就行”。说的没有问题，首先我们要清楚这个补间曲线坐标的含义。
我们打开MMD，读入模型，随意改变一个骨骼点，记录帧，就会发现左下角会出现补间曲线。
如果曲线只有一个，那么为什么会有四个补间曲线呢？实际上不止一个，补间曲线框的右上角就有个下拉菜单可以选择，对于圆形骨骼，没有相对位置变化，x, y, z补间曲线没有用，只有旋转速率可以调节，而方框骨骼可以移动，因此x, y, z, 旋转补间曲线都有用处。
回过头来，再说一下补间曲线的坐标，在这里，是以左下角为原点，横纵方向[0, 127]的坐标轴
后面的格式与这个格式大同小异。
表情关键帧（MorphKeyFrame）
表情关键帧分为：表情关键帧数、表情关键帧记录：
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 表情关键帧数量 MorphKeyFrameNumber |
| 类型 | 长度 | 含义 |
|---|---|---|
| byte | 15 | 表情名称 MorphName |
| uint32_t | 4 | 关键帧时间 FrameTime |
| float | 4 | 程度 Weight |
| byte | 23 | 合计 |
镜头（CameraKeyFrame）
镜头关键帧分为：镜头关键帧数、镜头关键帧记录：
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 镜头关键帧数量 CameraKeyFrameNumber |
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 关键帧时间 FrameTime |
| float | 4 | 距离 Distance |
| float*3 | 12 | x,y,z空间坐标 Position.xyz |
| float*3 | 12 | 旋转角度（弧度制） Rotation.xyz |
| uint8_t*24 | 24 | 相机曲线 Curve |
| uint32_t | 4 | 镜头FOV角度 ViewAngle |
| uint8_t | 1 | Orthographic相机 |
| byte | 61 | 合计 |
距离是我们镜头与中心红点的距离，在MMD中，我们可以通过滑轮改变
这有什么用呢？可以看下面的图：
旋转角度不再是四元数，而是普通的弧度制角度，我猜大概是镜头的万向锁情况没那么严重，因此用弧度制就能表示。
Curve是曲线的意思，按照之前的的补间曲线，确实还有一个相机曲线，不过一个曲线=两个小红x=4个坐标点=四字节，因此24字节有20字节的冗余，它的前四个字节就已经表达了坐标，后面20个字节是将这4个字节重复了5次。
镜头FOV角度和透视值有关，上面的博客写的是float，但实际上我试验是uint32_t，取值刚好就是MMD中的透视值。
Orthographic似乎是一种特殊的相机，没有近大远小的透视关系（不确定），不过在我的实验中，它一直取值为0。和上面的已透视没有关系，当取消已透视时，透视值会强制为1。
下面的骨骼追踪似乎没有记录，可能是强制转换成骨骼所在的坐标了。
后面的格式与这个格式大同小异。
光线关键帧（LightKeyFrame）
表情关键帧分为：光线关键帧数、光线关键帧记录：
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 光线关键帧数量 LightKeyFrameNumber |
| 类型 | 长度 | 含义 |
|---|---|---|
| uint32_t | 4 | 关键帧时间 FrameTime |
| float*3 | 12 | RGB颜色空间 color.rgb |
| float*3 | 12 | xyz投射方向 Direction.xyz |
| byte | 28 | 合计 |
rgb颜色空间之[0, 1]之间的数，类似html的RGB(50%, 20%, 30%)这种表示方法，转换方式就是把RGB值分别除以256。
光线投射方向是[-1, 1]之间的小数。正所对的投射方向是坐标轴的负方向，例如将Y拉到1， 光线会从上向下投影。
二、代码读取
我依旧会使用面向对象的方式构建VMD类，不过构造方法无力，属性太多，我选择用静态方法添加属性的方式构建对象
class Vmd:
def __init__(self):
pass
@staticmethod
def from_file(filename, model_name_encode="shift-JIS"):
with open(filename, "rb") as f:
from functools import reduce
array = bytes(reduce(lambda x, y: x+y, list(f)))
vmd = Vmd()
VersionInformation = array[:30].decode("ascii")
if VersionInformation.startswith("Vocaloid Motion Data file"):
vision = 1
elif VersionInformation.startswith("Vocaloid Motion Data 0002"):
vision = 2
else:
raise Exception("unknow vision")
vmd.vision = vision
vmd.model_name = array[30: 30+10*vision].split(bytes([0]))[0].decode(model_name_encode)
vmd.bone_keyframe_number = int.from_bytes(array[30+10*vision: 30+10*vision+4], byteorder='little', signed=False)
vmd.bone_keyframe_record = []
vmd.morph_keyframe_record = []
vmd.camera_keyframe_record = []
vmd.light_keyframe_record = []
current_index = 34+10 * vision
import struct
for i in range(vmd.bone_keyframe_number):
vmd.bone_keyframe_record.append({
"BoneName": array[current_index: current_index+15].split(bytes([0]))[0].decode("shift-JIS"),
"FrameTime": struct.unpack("三、实验
随意掰弯一些关节并注册、使用：
if __name__ == '__main__':
vmd = Vmd.from_file("test.vmd", model_name_encode="gb2312")
from pprint import pprint
pprint(vmd.dict)
output:
{'BoneKeyFrameNumber': 4,
'BoneKeyFrameRecord': [{'BoneName': '右腕',
'Curve': {'r': (20, 20, 107, 107),
'x': (20, 20, 107, 107),
'y': (20, 20, 107, 107),
'z': (20, 20, 107, 107)},
'FrameTime': 0,
'Position': {'x': 0.0, 'y': 0.0, 'z': 0.0},
'Rotation': {'w': 0.9358965158462524,
'x': 0.0,
'y': -0.3522740602493286,
'z': 0.0}},
{'BoneName': '首',
'Curve': {'r': (127, 127, 127, 127),
'x': (0, 127, 0, 127),
'y': (0, 0, 0, 0),
'z': (127, 0, 127, 0)},
'FrameTime': 60,
'Position': {'x': 0.0, 'y': 0.0, 'z': 0.0},
'Rotation': {'w': 0.9191020727157593,
'x': 0.0,
'y': -0.3940184712409973,
'z': 0.0}},
{'BoneName': '右ひじ',
'Curve': {'r': (127, 127, 127, 127),
'x': (0, 127, 0, 127),
'y': (0, 0, 0, 0),
'z': (127, 0, 127, 0)},
'FrameTime': 60,
'Position': {'x': 0.0, 'y': 0.0, 'z': 0.0},
'Rotation': {'w': 0.9568025469779968,
'x': 0.0,
'y': -0.290740042924881,
'z': 0.0}},
{'BoneName': '右腕',
'Curve': {'r': (20, 20, 107, 107),
'x': (20, 20, 107, 107),
'y': (20, 20, 107, 107),
'z': (20, 20, 107, 107)},
'FrameTime': 60,
'Position': {'x': 0.0, 'y': 0.0, 'z': 0.0},
'Rotation': {'w': 0.593818187713623,
'x': 0.0,
'y': -0.8045986294746399,
'z': 0.0}}],
'CameraKeyFrameNumber': 0,
'CameraKeyFrameRecord': [],
'LightKeyFrameNumber': 0,
'LightKeyFrameRecord': [],
'ModelName': '八重樱',
'MorphKeyFrameNumber': 2,
'MorphKeyFrameRecord': [{'FrameTime': 60, 'MorphName': 'まばたき', 'Weight': 1.0},
{'FrameTime': 60,
'MorphName': 'あ',
'Weight': 0.36000001430511475}],
'Vision': 2}
因为前面提到的编码模式，我选择用gb2312解码，在很多（也许是大部分）动作数据都会报错，可以去掉编码方式：
vmd = Vmd.from_file("test.vmd")
我们没有移动方块骨骼，因此位置信息都是0。
不喜欢看欧拉角的话，可以写一个转换方法：
@staticmethod
def _quaternion_to_EulerAngles(x, y, z, w):
import numpy as np
X = np.arcsin(2*w*x-2*y*z) / np.pi * 180
Y = -np.arctan2(2*w*y+2*x*z, 1-2*x**2-2*y**2) / np.pi * 180
Z = -np.arctan2(2*w*z+2*x*y, 1-2*x**2-2*z**2) / np.pi * 180
return X, Y, Z
@property
def euler_dict(self):
from copy import deepcopy
res_dict = deepcopy(self.dict)
for index, d in enumerate(res_dict['BoneKeyFrameRecord']):
x = d["Rotation"]["x"]
y = d["Rotation"]["y"]
z = d["Rotation"]["z"]
w = d["Rotation"]["w"]
X, Y, Z = Vmd._quaternion_to_EulerAngles(x, y, z, w)
res_dict['BoneKeyFrameRecord'][index]["Rotation"] = {
"X": X,
"Y": Y,
"Z": Z
}
return res_dict
这样只要调用：
vmd = Vmd.from_file("test.vmd")
from pprint import pprint
pprint(vmd.euler_dict)
即可得到转换成欧拉角的结果，同样的方式还可以编写转换RGB、弧度、角度等
python内置的json包可以很方便得将字典转换成json格式文档储存。
我们也可以试着写一些将VMD转换成vmd文件的方法。
四、总结
通过学习VMD的文件结构，大致了解了储存动作数据的格式和一些方法，或许可以类比到一些主流的商业3D软件上。
读取程序并不难，我写程序的很多时间都是查二进制操作消耗的，通过这个程序，还巩固了二进制操作的知识。
我在google上找到了一个包saba，专门用于操控MMD的文件，包括模型、动作数据等
Github链接
Qiita链接
现在学一下图形学，等学有所得再做出更多东西。