aboutsummaryrefslogtreecommitdiff
path: root/src/unityfs/header.rs
blob: d4fc89fba463b272b057781f67c5c44c2d31f645 (plain)
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
use crate::helper::{AlignExt, ReadExt};
use anyhow::{Result, anyhow, bail};
use humansize::DECIMAL;
use log::{debug, info};
use std::io::{Cursor, Read, Seek, SeekFrom};

#[derive(Debug, Clone)]
pub struct NodeInfo {
    pub name: String,
    pub size: u64,
    pub(super) offset: u64,
    _status: u32,
}

pub struct BlockInfo {
    pub comp_size: u32,
    pub decomp_size: u32,
    pub comp_scheme: CompressionScheme,
}

pub struct UnityFSHeader {
    pub(crate) nodes: Vec<NodeInfo>,
    pub file_version: u32,
    pub player_version: String,
    pub unity_version: String,
}

impl UnityFSHeader {
    pub fn read(mut file: impl Read + Seek) -> Result<(Self, Vec<BlockInfo>)> {
        let signature = file.read_cstr()?;
        if signature.as_str() != "UnityFS" {
            bail!("unknown signature {signature:?}")
        }

        let file_version = file.read_u32_be()?;
        let player_version = file.read_cstr()?;
        let unity_version = file.read_cstr()?;
        let size = file.read_u64_be()?;
        let blockindex_comp_size = file.read_u32_be()?;
        let blockindex_decomp_size = file.read_u32_be()?;
        let flags = file.read_u32_be()?;

        let meta_comp_scheme = CompressionScheme::from_flag_num(flags as u8).ok_or(anyhow!(
            "unknown block compression 0x{:02x}",
            (flags & 0x3f) as u8
        ))?;
        let blockindex_eof = flags & 0x80 != 0;
        let blockindex_has_directory = flags & 0x40 != 0;
        let blockindex_need_padding = flags & 0x200 != 0;

        info!("File Version: {file_version:?}");
        info!("Player Version: {player_version:?}");
        info!("Unity Version: {unity_version:?}");
        debug!("size={size:?}");
        debug!("meta_comp_size={blockindex_comp_size:?}");
        debug!("meta_decomp_size={blockindex_decomp_size:?}");
        debug!("flags={flags:?}");
        debug!("meta_comp_scheme={meta_comp_scheme:?}");
        debug!("blockindex_eof={blockindex_eof:?}");
        debug!("blockindex_has_directory={blockindex_has_directory:?}");
        debug!("blockindex_need_padding={blockindex_need_padding:?}");

        let mut blockindex = {
            let restore_position = if blockindex_eof {
                let pos = file.stream_position()?;
                file.seek(SeekFrom::End(-(blockindex_comp_size as i64)))?;
                Some(pos)
            } else {
                None
            };

            let mut blockindex = vec![0u8; blockindex_comp_size as usize];
            file.read_exact(&mut blockindex)?;

            if let Some(pos) = restore_position {
                file.seek(SeekFrom::Start(pos))?;
            }
            let blockindex =
                meta_comp_scheme.decompress(blockindex, blockindex_decomp_size as usize)?;
            Cursor::new(blockindex)
        };

        file.align(16)?;

        blockindex.read_u128_be()?;

        let num_blocks = blockindex.read_u32_be()?;
        info!("File has {num_blocks} blocks");
        let mut blocks = Vec::new();
        for _ in 0..num_blocks {
            let decomp_size = blockindex.read_u32_be()?;
            let comp_size = blockindex.read_u32_be()?;
            let flags = blockindex.read_u16_be()?;
            let comp_scheme = CompressionScheme::from_flag_num(flags as u8)
                .ok_or(anyhow!("unknown block compression 0x{:02x}", flags & 0x3f))?;
            blocks.push(BlockInfo {
                comp_size,
                decomp_size,
                comp_scheme,
            })
        }

        let num_nodes = blockindex.read_u32_be()?;
        debug!("num_nodes={num_nodes:?}");
        let mut nodes = Vec::new();
        for _ in 0..num_nodes {
            let offset = blockindex.read_u64_be()?;
            let size = blockindex.read_u64_be()?;
            let status = blockindex.read_u32_be()?;
            let name = blockindex.read_cstr()?;
            info!(
                "found node {name:?} (size={}, status={status})",
                humansize::format_size(size, DECIMAL)
            );
            nodes.push(NodeInfo {
                offset,
                size,
                _status: status,
                name,
            })
        }

        Ok((
            Self {
                file_version,
                player_version,
                unity_version,
                nodes,
            },
            blocks,
        ))
    }
    pub fn nodes(&self) -> &[NodeInfo] {
        &self.nodes
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum CompressionScheme {
    None,
    Lzma,
    Lz4,
    Lz4hc,
    Lzham,
}
impl CompressionScheme {
    pub fn from_flag_num(n: u8) -> Option<CompressionScheme> {
        Some(match n & 0x3f {
            0 => CompressionScheme::None,
            1 => CompressionScheme::Lzma,
            2 => CompressionScheme::Lz4,
            3 => CompressionScheme::Lz4hc,
            4 => CompressionScheme::Lzham,
            _ => return None,
        })
    }
    pub fn decompress(&self, block: Vec<u8>, decomp_size: usize) -> Result<Vec<u8>> {
        match self {
            CompressionScheme::None => Ok(block),
            CompressionScheme::Lzma => {
                let mut r = lzma::Reader::from(Cursor::new(block))?;
                let mut buf = Vec::new();
                r.read_to_end(&mut buf)?;
                Ok(buf)
            }
            CompressionScheme::Lz4hc | CompressionScheme::Lz4 => {
                Ok(lz4_flex::block::decompress(&block, decomp_size)?)
            }
            // CompressionScheme::LZ4HC | CompressionScheme::LZ4 => {
            //     Ok(lz4::block::decompress(&block, Some(decomp_size as i32))?)
            // }
            CompressionScheme::Lzham => todo!(),
        }
    }
}