mmd-anim-cli 0.1.7

CLI diagnostics and roundtrip tools for mmd-anim
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
use std::collections::BTreeSet;

use serde::Deserialize;
use thiserror::Error;

use crate::schema::SCHEMA_VERSION;

pub const DEFAULT_FOCUSED_IK_BONE_NAMES: &[&str] = &[
    "左足",
    "右足",
    "左ひざ",
    "右ひざ",
    "左足首",
    "右足首",
    "左つま先",
    "右つま先",
    "左足IK",
    "右足IK",
    "左つま先IK",
    "右つま先IK",
    "左足IK",
    "右足IK",
    "左つま先IK",
    "右つま先IK",
];

#[derive(Debug, Error)]
pub enum MmdDumperOracleParseError {
    #[error("invalid JSONL at line {line}: {source}")]
    Json {
        line: usize,
        #[source]
        source: serde_json::Error,
    },
    #[error("MMDDumper oracle JSONL is empty")]
    Empty,
    #[error("unsupported MMDDumper oracle schemaVersion {schema_version}")]
    UnsupportedSchema { schema_version: u32 },
    #[error(
        "MMDDumper oracle bone matrix must have 16 components: frame={frame} model={model} bone={bone}"
    )]
    InvalidBoneMatrix {
        frame: i32,
        model: usize,
        bone: usize,
    },
    #[error("invalid manifest JSON: {source}")]
    ManifestJson {
        #[source]
        source: serde_json::Error,
    },
}

#[derive(Clone, Debug, PartialEq)]
pub struct MmdDumperOracleDump {
    pub source: MmdDumperOracleSource,
    pub frames: Vec<MmdDumperOracleFrame>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Eq)]
pub struct GoldenIkBatchManifest {
    pub cases: Vec<GoldenIkBatchCase>,
}

impl GoldenIkBatchManifest {
    pub fn from_json_str(input: &str) -> Result<Self, MmdDumperOracleParseError> {
        serde_json::from_str(input)
            .map_err(|source| MmdDumperOracleParseError::ManifestJson { source })
    }
}

#[derive(Clone, Debug, Deserialize, PartialEq, Eq)]
pub struct GoldenIkBatchCase {
    pub name: String,
    pub pmx: String,
    pub vmd: String,
    pub frames: Vec<i32>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Eq)]
pub struct GoldenIkFixture {
    pub name: String,
    pub output: String,
    pub frames: Vec<i32>,
}

impl GoldenIkFixture {
    pub fn from_json_str(input: &str) -> Result<Self, MmdDumperOracleParseError> {
        serde_json::from_str(input)
            .map_err(|source| MmdDumperOracleParseError::ManifestJson { source })
    }
}

impl MmdDumperOracleDump {
    pub fn from_jsonl_str(
        input: &str,
        target_frames: Option<&[i32]>,
    ) -> Result<Self, MmdDumperOracleParseError> {
        let target_frames =
            target_frames.map(|frames| frames.iter().copied().collect::<BTreeSet<_>>());
        let mut source = None;
        let mut frames = Vec::new();

        for (line_index, line) in input.lines().enumerate() {
            let line = line.trim();
            if line.is_empty() {
                continue;
            }

            let record: RawOracleRecord =
                serde_json::from_str(line).map_err(|source| MmdDumperOracleParseError::Json {
                    line: line_index + 1,
                    source,
                })?;
            if record.schema_version != SCHEMA_VERSION {
                return Err(MmdDumperOracleParseError::UnsupportedSchema {
                    schema_version: record.schema_version,
                });
            }

            source.get_or_insert_with(|| record.source.clone());
            let frame = record.frame.round() as i32;
            if target_frames
                .as_ref()
                .is_none_or(|target_frames| target_frames.contains(&frame))
            {
                frames.push(MmdDumperOracleFrame::from_raw(frame, record.models)?);
            }
        }

        Ok(Self {
            source: source.ok_or(MmdDumperOracleParseError::Empty)?,
            frames,
        })
    }

    pub fn find_frame(&self, frame: i32) -> Option<&MmdDumperOracleFrame> {
        self.frames
            .iter()
            .find(|candidate| candidate.frame == frame)
    }
}

#[derive(Clone, Debug, Deserialize, PartialEq, Eq)]
pub struct MmdDumperOracleSource {
    #[serde(rename = "mmdVersion")]
    pub mmd_version: String,
    #[serde(rename = "dumperVersion")]
    pub dumper_version: String,
    #[serde(default)]
    pub project: Option<String>,
}

#[derive(Clone, Debug, PartialEq)]
pub struct MmdDumperOracleFrame {
    pub frame: i32,
    pub models: Vec<MmdDumperOracleModel>,
}

impl MmdDumperOracleFrame {
    fn from_raw(
        frame: i32,
        models: Vec<RawOracleModel>,
    ) -> Result<Self, MmdDumperOracleParseError> {
        let mut parsed_models = Vec::with_capacity(models.len());
        for (model_index, model) in models.into_iter().enumerate() {
            parsed_models.push(MmdDumperOracleModel::from_raw(frame, model_index, model)?);
        }
        Ok(Self {
            frame,
            models: parsed_models,
        })
    }
}

#[derive(Clone, Debug, PartialEq)]
pub struct MmdDumperOracleModel {
    pub index: i32,
    pub name: String,
    pub filename: String,
    pub visible: bool,
    pub bones: Vec<MmdDumperOracleBone>,
    pub morphs: Vec<MmdDumperOracleMorph>,
}

impl MmdDumperOracleModel {
    fn from_raw(
        frame: i32,
        model_index: usize,
        model: RawOracleModel,
    ) -> Result<Self, MmdDumperOracleParseError> {
        let mut bones = Vec::with_capacity(model.bones.len());
        for (bone_index, bone) in model.bones.into_iter().enumerate() {
            bones.push(MmdDumperOracleBone::from_raw(
                frame,
                model_index,
                bone_index,
                bone,
            )?);
        }
        Ok(Self {
            index: model.index,
            name: model.name,
            filename: model.filename,
            visible: model.visible,
            bones,
            morphs: model.morphs,
        })
    }

    pub fn find_bone(&self, name: &str) -> Option<&MmdDumperOracleBone> {
        self.bones.iter().find(|bone| bone.name == name)
    }

    pub fn focused_ik_bones<'a>(
        &'a self,
        focused_bone_names: &'a [&'a str],
    ) -> impl Iterator<Item = &'a MmdDumperOracleBone> + 'a {
        self.bones
            .iter()
            .filter(move |bone| focused_bone_names.contains(&bone.name.as_str()))
    }
}

#[derive(Clone, Debug, PartialEq)]
pub struct MmdDumperOracleBone {
    pub index: i32,
    pub name: String,
    pub world_matrix: [f32; 16],
}

impl MmdDumperOracleBone {
    fn from_raw(
        frame: i32,
        model: usize,
        bone: usize,
        raw: RawOracleBone,
    ) -> Result<Self, MmdDumperOracleParseError> {
        let Ok(world_matrix) = raw.world_matrix.try_into() else {
            return Err(MmdDumperOracleParseError::InvalidBoneMatrix { frame, model, bone });
        };
        Ok(Self {
            index: raw.index,
            name: raw.name,
            world_matrix,
        })
    }
}

#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct MmdDumperOracleMorph {
    pub index: i32,
    pub name: String,
    pub weight: f32,
}

#[derive(Debug, Deserialize)]
struct RawOracleRecord {
    #[serde(rename = "schemaVersion")]
    schema_version: u32,
    source: MmdDumperOracleSource,
    frame: f32,
    models: Vec<RawOracleModel>,
}

#[derive(Debug, Deserialize)]
struct RawOracleModel {
    index: i32,
    name: String,
    filename: String,
    visible: bool,
    bones: Vec<RawOracleBone>,
    #[serde(default)]
    morphs: Vec<MmdDumperOracleMorph>,
}

#[derive(Debug, Deserialize)]
struct RawOracleBone {
    index: i32,
    name: String,
    #[serde(rename = "worldMatrix")]
    world_matrix: Vec<f32>,
}

#[cfg(test)]
mod tests {
    use super::*;

    // ── inline schema parse tests (always-on, no external asset required) ─────

    #[test]
    fn parses_minimal_inline_jsonl() {
        let jsonl = r#"{"schemaVersion":1,"source":{"mmdVersion":"9.32-x64","dumperVersion":"1.0.0"},"frame":0.0,"models":[{"index":0,"name":"test_model","filename":"test.pmx","visible":true,"bones":[{"index":0,"name":"センター","worldMatrix":[1.0,0.0,0.0,0.0, 0.0,1.0,0.0,0.0, 0.0,0.0,1.0,0.0, 0.0,0.0,0.0,1.0]}],"morphs":[{"index":0,"name":"まばたき","weight":0.5}]}]}"#;

        let dump = MmdDumperOracleDump::from_jsonl_str(jsonl, None).unwrap();

        assert_eq!(dump.source.mmd_version, "9.32-x64");
        assert_eq!(dump.source.dumper_version, "1.0.0");
        assert_eq!(dump.frames.len(), 1);
        assert_eq!(dump.frames[0].frame, 0);
        assert_eq!(dump.frames[0].models.len(), 1);

        let model = &dump.frames[0].models[0];
        assert_eq!(model.index, 0);
        assert_eq!(model.name, "test_model");
        assert_eq!(model.filename, "test.pmx");
        assert!(model.visible);
        assert_eq!(model.bones.len(), 1);
        assert_eq!(model.bones[0].world_matrix[15], 1.0);
        assert_eq!(model.morphs.len(), 1);
        assert_eq!(model.morphs[0].weight, 0.5);
    }

    #[test]
    fn filters_target_frames_from_jsonl() {
        let jsonl = concat!(
            r#"{"schemaVersion":1,"source":{"mmdVersion":"9.32-x64","dumperVersion":"1.0.0"},"frame":0.0,"models":[{"index":0,"name":"m","filename":"m.pmx","visible":true,"bones":[],"morphs":[]}]}"#,
            "\n",
            r#"{"schemaVersion":1,"source":{"mmdVersion":"9.32-x64","dumperVersion":"1.0.0"},"frame":30.0,"models":[{"index":0,"name":"m","filename":"m.pmx","visible":true,"bones":[],"morphs":[]}]}"#,
        );

        let dump = MmdDumperOracleDump::from_jsonl_str(jsonl, Some(&[30])).unwrap();

        assert_eq!(dump.frames.len(), 1);
        assert_eq!(dump.frames[0].frame, 30);
        assert!(dump.find_frame(30).is_some());
        assert!(dump.find_frame(0).is_none());
    }

    #[test]
    fn parses_manifest_with_inline_json() {
        let manifest_json = r#"{
            "schemaVersion": 1,
            "kind": "motion-numeric",
            "description": "test manifest for schema parse",
            "producer": {
                "tool": "MMDDumper",
                "runtime": "MikuMikuDance 9.32 x64",
                "command": "oracle-batch"
            },
            "defaults": {
                "outDir": "runs/test-motion-numeric",
                "timeoutMs": 180000,
                "dump": { "bones": true, "morphs": true, "rigidBodies": false },
                "focus": { "bones": ["センター", "右ひざ"], "morphs": ["まばたき"] },
                "comparison": {
                    "primary": "worldMatrix",
                    "secondary": ["localTransform", "morphWeight", "ikEnabled"],
                    "initialMode": "report-only"
                }
            },
            "cases": [
                {
                    "name": "test-case-a",
                    "kind": "motion-numeric",
                    "pmx": "model.pmx",
                    "vmd": "motion.vmd",
                    "frames": [0, 30],
                    "tags": ["inline"],
                    "notes": "extra manifest fields are intentionally ignored by this schema crate"
                },
                {
                    "name": "test-case-b",
                    "kind": "motion-numeric",
                    "pmx": "model_b.pmx",
                    "vmd": "motion_b.vmd",
                    "frames": [60]
                }
            ]
        }"#;

        let manifest = GoldenIkBatchManifest::from_json_str(manifest_json).unwrap();

        assert_eq!(manifest.cases.len(), 2);
        assert_eq!(manifest.cases[0].name, "test-case-a");
        assert_eq!(manifest.cases[0].pmx, "model.pmx");
        assert_eq!(manifest.cases[0].vmd, "motion.vmd");
        assert_eq!(manifest.cases[0].frames, vec![0, 30]);
        assert_eq!(manifest.cases[1].name, "test-case-b");
    }

    #[test]
    fn parses_fixture_with_inline_json() {
        let fixture_json = r#"{
            "name": "test-case",
            "output": "oracle.expected.jsonl",
            "frames": [0, 30, 60]
        }"#;

        let fixture = GoldenIkFixture::from_json_str(fixture_json).unwrap();

        assert_eq!(fixture.name, "test-case");
        assert_eq!(fixture.output, "oracle.expected.jsonl");
        assert_eq!(fixture.frames, vec![0, 30, 60]);
    }

    #[test]
    fn rejects_invalid_bone_matrix_length() {
        let jsonl = r#"{"schemaVersion":1,"source":{"mmdVersion":"9.32-x64","dumperVersion":"1.0.0"},"frame":0.0,"models":[{"index":0,"name":"m","filename":"m.pmx","visible":true,"bones":[{"index":0,"name":"bad","worldMatrix":[1.0,2.0,3.0]}],"morphs":[]}]}"#;

        let err = MmdDumperOracleDump::from_jsonl_str(jsonl, None).unwrap_err();

        assert!(
            matches!(err, MmdDumperOracleParseError::InvalidBoneMatrix { .. }),
            "expected InvalidBoneMatrix, got {:?}",
            err
        );
    }

    #[test]
    fn rejects_unsupported_schema_version() {
        let jsonl = r#"{"schemaVersion":99,"source":{"mmdVersion":"9.32-x64","dumperVersion":"1.0.0"},"frame":0.0,"models":[]}"#;

        let err = MmdDumperOracleDump::from_jsonl_str(jsonl, None).unwrap_err();

        assert!(
            matches!(
                err,
                MmdDumperOracleParseError::UnsupportedSchema { schema_version: 99 }
            ),
            "expected UnsupportedSchema(99), got {:?}",
            err
        );
    }

    #[test]
    fn exposes_three_mmd_loader_focused_ik_bone_contract() {
        assert!(DEFAULT_FOCUSED_IK_BONE_NAMES.contains(&"左ひざ"));
        assert!(DEFAULT_FOCUSED_IK_BONE_NAMES.contains(&"右足IK"));
        assert!(DEFAULT_FOCUSED_IK_BONE_NAMES.contains(&"左足IK"));
    }
}