romkit 0.1.0

Identify game ROMs and extract their data and assets as structured files.
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

//! File formats found inside ROMs, independent of any one game.

pub mod bcstm;
pub mod g2d;
pub mod garc;
pub mod lz;
pub mod narc;
pub mod nitro3d;
pub mod sdat;

use serde::Serialize;

/// A file type recognized from its signature, its first four bytes.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
pub struct Format {
    /// The conventional extension, e.g. `narc`.
    pub extension: &'static str,
    pub description: &'static str,
}

impl Format {
    pub fn sniff(head: &[u8]) -> Option<Self> {
        let signature = head.first_chunk::<4>()?;
        SIGNATURES
            .iter()
            .find(|(known, _, _)| *known == signature)
            .map(|&(_, extension, description)| Self {
                extension,
                description,
            })
    }
}

/// Nitro SDK (DS) formats, which store their signatures byte-reversed.
const SIGNATURES: &[(&[u8; 4], &str, &str)] = &[
    (b"NARC", "narc", "archive"),
    (b"RLCN", "nclr", "palette"),
    (b"RGCN", "ncgr", "tile graphics"),
    (b"RECN", "ncer", "sprite cells"),
    (b"RNAN", "nanr", "cell animation"),
    (b"RCSN", "nscr", "tilemap"),
    (b"BMD0", "nsbmd", "3D model"),
    (b"BTX0", "nsbtx", "3D textures"),
    (b"BCA0", "nsbca", "3D skeletal animation"),
    (b"BTP0", "nsbtp", "3D texture pattern animation"),
    (b"BTA0", "nsbta", "3D texture coordinate animation"),
    (b"BMA0", "nsbma", "3D material animation"),
    (b"BVA0", "nsbva", "3D visibility animation"),
    (b"SDAT", "sdat", "sound archive"),
    (b"SSEQ", "sseq", "music sequence"),
    (b"SSAR", "ssar", "sound effect sequences"),
    (b"SBNK", "sbnk", "instrument bank"),
    (b"SWAR", "swar", "wave archive"),
    (b"STRM", "strm", "audio stream"),
    // 3DS formats, mostly CTR SDK ones.
    (b"CRAG", "garc", "archive"),
    (b"BCH\0", "bch", "3D models and textures"),
    (b"CGFX", "bcres", "3D models and textures"),
    (b"CTPK", "ctpk", "textures"),
    (b"DARC", "arc", "archive"),
    (b"SARC", "sarc", "archive"),
    (b"CSAR", "bcsar", "sound archive"),
    (b"CSTM", "bcstm", "audio stream"),
    (b"CWAV", "bcwav", "sound"),
    (b"DVLB", "shbin", "shader"),
    (b"SMDH", "smdh", "icon and titles"),
];

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

    #[test]
    fn sniffs_signatures() {
        assert_eq!(Format::sniff(b"RGCN\xFF\xFE").unwrap().extension, "ncgr");
        assert_eq!(Format::sniff(b"NARC").unwrap().description, "archive");
        assert_eq!(Format::sniff(b"XYZW"), None);
        assert_eq!(Format::sniff(b"NAR"), None);
    }
}