xc3_lib 0.21.0

Xenoblade Chronicles file format library
Documentation 
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

use crate::{parse_ptr64, parse_string_opt_ptr64, parse_string_ptr64};
use binrw::BinRead;
use xc3_write::{
    Xc3Write, Xc3WriteOffsets,
    strings::{StringSectionUniqueSorted, WriteOptions},
};

use super::{BcList, BcOffset, StringOffset};

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
#[br(magic(b"ASMB"))]
#[xc3(magic(b"ASMB"))]
pub struct Asmb {
    #[br(parse_with = parse_ptr64)]
    #[xc3(offset(u64))]
    pub inner: AsmbInner,
}

// TODO: How to select the version?
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub enum AsmbInner {
    /// Xenoblade 2
    V1(AsmbInnerV1),
    /// Xenoblade 1 DE and Xenoblade 3
    V2(AsmbInnerV2),
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, PartialEq, Clone)]
pub struct AsmbInnerV1 {
    pub unk1: u32,
    pub unk2: i32,
    pub folders: BcList<StringOffset>,
    pub unk4: BcList<BcOffset<StateV1>>,
    pub unk5: BcList<VarParamV1>,
    pub unk6: BcList<AnimationV1>,

    // TODO: This doesn't always match the chr name?
    #[br(parse_with = parse_string_opt_ptr64)]
    #[xc3(offset(u64))]
    pub skeleton_file_name: Option<String>,

    pub unk8: BcList<KeyValueV1>,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct StateV1 {
    pub unk1: u32,
    pub unk2: i32,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name: String,

    pub unk3: [i32; 4],

    // TODO: types?
    pub children: BcList<BcOffset<StateTransitionV1>>,
    pub unk9: u64,
    pub unk10: BcList<StateKeyValueV1>,
    pub unk11: BcList<StateKeyValueV1>,
    pub unk12: BcList<u64>,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct AnimationV1 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub file_name: String,

    pub unk1: BcList<AnimationUnk1V1>,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct VarParamV1 {
    pub unk1: u32,
    pub unk2: i32,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name: String,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct AnimationUnk1V1 {
    pub unk1: u16,
    pub unk2: u16,
    pub unk3: i32,
}

// TODO: more fields?
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct StateTransitionV1 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name: String,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct KeyValueV1 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub key: String,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub value: String,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct StateKeyValueV1 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub key: String,

    pub unk1: u32,
    pub unk2: i32,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub value: String,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct AsmbInnerV2 {
    pub folders: BcList<StringOffset>,
    pub unk2: BcList<FsmGroupV2>,
    pub unk3: u64,        // 0?
    pub unk4: BcList<u8>, // TODO: type?
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct FsmGroupV2 {
    pub unk1: BcList<BcOffset<StateV2>>,
    pub unk2: BcList<BcOffset<StateTransitionV2>>,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub unk3: String,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub unk4: String,

    #[br(parse_with = parse_string_opt_ptr64)]
    #[xc3(offset(u64))]
    pub unk5: Option<String>,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct StateV2 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name: String,

    /// Hash of [name](#structfield.name) using [murmur3](crate::hash::murmur3).
    pub name_hash: u32,
    pub unk3: u32,
    pub unk4: u32,
    pub unk5: u32,
    pub unk6: u32,
    pub unk7: u32,

    // TODO: types?
    pub children: BcList<BcOffset<StateTransitionV2>>,
    pub unk9: BcList<u8>,
    pub unk10: BcList<u8>,
    pub unk11: BcList<u8>,
    pub unk12: BcList<u8>,
    pub unk13: BcList<u8>,

    // TODO: only in xc3?
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub unk14: String,

    pub unk15: [f32; 8],
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
pub struct StateTransitionV2 {
    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name1: String,

    #[br(parse_with = parse_string_ptr64)]
    #[xc3(offset(u64))]
    pub name2: String,

    /// Hash of [name2](#structfield.name) using [murmur3](crate::hash::murmur3).
    pub name2_hash: u32,
    pub unk4: [f32; 4],
    pub unk5: i32,
    pub unk6: [f32; 2],
    pub unk7: u32,
    pub unk8: u32,
    pub unk9: [i16; 8],
    pub unk10: f32,
    pub unk11: u32,
    pub unk12: u32,
    pub unk13: i32,
}

// TODO: Is there a cleaner way to defer and sort strings?
impl Xc3WriteOffsets for AsmbInnerV1Offsets<'_> {
    type Args = ();

    fn write_offsets<W: std::io::prelude::Write + std::io::prelude::Seek>(
        &self,
        writer: &mut W,
        base_offset: u64,
        data_ptr: &mut u64,
        endian: xc3_write::Endian,
        _args: Self::Args,
    ) -> xc3_write::Xc3Result<()> {
        let mut string_section = StringSectionUniqueSorted::default();

        // Different order than field order.
        let folders = self
            .folders
            .0
            .write(writer, base_offset, data_ptr, endian)?;
        for f in folders.0 {
            string_section.insert_offset64(&f.name);
        }

        let unk5 = self.unk5.0.write(writer, base_offset, data_ptr, endian)?;
        for u in unk5.0 {
            string_section.insert_offset64(&u.name);
        }

        let unk6 = self.unk6.0.write(writer, base_offset, data_ptr, endian)?;
        for u in unk6.0 {
            string_section.insert_offset64(&u.file_name);
        }

        // TODO: find a better way to handle nested data.
        let unk4 = self.unk4.0.write(writer, base_offset, data_ptr, endian)?;
        for u in unk4.0 {
            let u = u.value.write(writer, base_offset, data_ptr, endian)?;
            string_section.insert_offset64(&u.name);

            let children = u.children.0.write(writer, base_offset, data_ptr, endian)?;
            for c in children.0 {
                let c = c.value.write(writer, base_offset, data_ptr, endian)?;
                string_section.insert_offset64(&c.name);
            }
        }

        let unk8 = self.unk8.0.write(writer, base_offset, data_ptr, endian)?;
        for u in unk8.0 {
            string_section.insert_offset64(&u.key);
            string_section.insert_offset64(&u.value);
        }

        // TODO: How to handle an optional string?
        // if let Some(name) = &self.skeleton_file_name.write_offset(writer, base_offset, data_ptr)? {
        //     string_section.insert_offset(name);
        // }

        // The names are the last item before the addresses.
        string_section.write(
            writer,
            data_ptr,
            &WriteOptions {
                start_alignment: 8,
                start_padding_byte: 0xff,
                string_alignment: 1,
                string_padding_byte: 0,
            },
            endian,
        )?;

        Ok(())
    }
}