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

//! Effects in .wipac files.
//!
//! # File Paths
//!
//! | Game | Versions | File Patterns |
//! | --- | --- | --- |
//! | Xenoblade 1 DE | |  |
//! | Xenoblade 2 |  |  |
//! | Xenoblade 3 |  | `effect/**/*.wipac`  |
use crate::{Offset32, parse_ptr32, xc3_write_binwrite_impl};
use binrw::{BinRead, BinWrite, NullString, binread};
use xc3_write::{Xc3Write, Xc3WriteOffsets};

// TODO: Come up with a better name
// TODO: implement proper write support
#[binread]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
#[br(magic(b"ARC\x00"))]
#[xc3(magic(b"ARC\x00"))]
#[br(stream = r)]
#[xc3(base_offset)]
pub struct Wipac {
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u32,

    // FirehawkBinarys
    #[br(map(|x: NullString| x.to_string()))]
    #[br(pad_size_to = 32)]
    pub unk4: String,

    #[br(count = unk2, align_after = 16)]
    pub unk5: Vec<Offset32<Unk>>,

    #[br(count = unk2)]
    pub unk6: Vec<Efxa>,
}

#[binread]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
#[br(stream = r)]
#[xc3(base_offset)]
pub struct Unk {
    #[br(temp, try_calc = r.stream_position())]
    base_offset: u64,

    #[br(parse_with = parse_ptr32, offset = base_offset)]
    #[xc3(offset(u32))]
    pub cmp: Cmp,

    pub unk2: u32,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
#[br(magic(b"cmp\x00"))]
#[xc3(magic(b"cmp\x00"))]
pub struct Cmp {
    pub cmp_type: CmpType,
    pub compressed_size: u32,
    pub decompressed_size: u32,

    #[br(count = compressed_size)]
    pub compressed_stream: Vec<u8>,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, BinRead, Xc3Write, Xc3WriteOffsets, PartialEq, Clone)]
#[br(magic(b"efxa"))]
#[xc3(magic(b"efxa"))]
pub struct Efxa {
    pub unk1: u32,
    pub unk2: u32,
    pub unk3: u32,
    pub unk4: u32,

    #[br(map(|x: NullString| x.to_string()))]
    #[br(pad_size_to = 44)]
    pub unk5: String,
}

#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(BinRead, BinWrite, Debug, Clone, Copy, PartialEq, Eq)]
pub enum CmpType {
    #[brw(magic(b"zlib"))]
    Zlib,
}

xc3_write_binwrite_impl!(CmpType);