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
433
434
435
436
437
438
439
440
441
442
443
444
use crate::{FileDataIdx, FileInfoIdx, FileInfoIndiceIdx, FilePathIdx, Hash40, InfoToDataIdx};
use modular_bitfield::prelude::*;
use binrw::{binread, io::*, BinRead, BinResult, ReadOptions};
#[derive(BinRead, Debug, Clone, Copy)]
#[br(magic = 0x10_u32)]
pub struct CompTableHeader {
pub decomp_size: u32,
pub comp_size: u32,
pub section_size: u32,
}
pub(crate) struct CompressedFileSystem(pub FileSystem);
impl BinRead for CompressedFileSystem {
type Args = ();
fn read_options<R>(reader: &mut R, options: &ReadOptions, args: Self::Args) -> BinResult<Self>
where
R: Read + Seek,
{
let header = CompTableHeader::read_options(reader, options, args)?;
let mut compressed = vec![0; header.comp_size as usize];
reader.read_exact(&mut compressed)?;
let compressed = Cursor::new(compressed);
let mut decompressed = Cursor::new(crate::zstd_backend::decode_all(compressed)?);
FileSystem::read_options(&mut decompressed, options, ()).map(CompressedFileSystem)
}
}
#[binread]
#[derive(Debug)]
pub struct FileSystem {
pub fs_header: FileSystemHeader,
#[br(align_before = 0x100)]
pub stream_header: StreamHeader,
#[br(count = stream_header.quick_dir_count)]
pub quick_dirs: Vec<QuickDir>,
#[br(count = stream_header.stream_hash_count)]
pub stream_hash_to_entries: Vec<HashToIndex>,
#[br(count = stream_header.stream_hash_count)]
pub stream_entries: Vec<StreamEntry>,
#[br(count = stream_header.stream_file_index_count)]
pub stream_file_indices: Vec<u32>,
#[br(count = stream_header.stream_offset_entry_count)]
pub stream_datas: Vec<StreamData>,
#[br(temp)]
pub hash_index_group_count: u32,
#[br(temp)]
pub bucket_count: u32,
#[br(count = bucket_count)]
pub file_info_buckets: Vec<FileInfoBucket>,
#[br(count = hash_index_group_count)]
pub file_hash_to_path_index: Vec<HashToIndex>,
#[br(count = fs_header.file_info_path_count)]
pub file_paths: Vec<FilePath>,
#[br(count = fs_header.file_info_index_count)]
pub file_info_indices: Vec<FileInfoIndex>,
#[br(count = fs_header.folder_count)]
pub dir_hash_to_info_index: Vec<HashToIndex>,
#[br(count = fs_header.folder_count)]
pub dir_infos: Vec<DirInfo>,
#[br(count = fs_header.folder_offset_count_1 + fs_header.folder_offset_count_2 + fs_header.extra_folder)]
pub folder_offsets: Vec<DirectoryOffset>,
#[br(count = fs_header.hash_folder_count)]
pub folder_child_hashes: Vec<HashToIndex>,
#[br(count = fs_header.file_info_count + fs_header.file_data_count_2 + fs_header.extra_count)]
pub file_infos: Vec<FileInfo>,
#[br(count = fs_header.file_info_sub_index_count + fs_header.file_data_count_2 + fs_header.extra_count_2)]
pub file_info_to_datas: Vec<FileInfoToFileData>,
#[br(count = fs_header.file_data_count + fs_header.file_data_count_2 + fs_header.extra_sub_count)]
pub file_datas: Vec<FileData>,
}
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileSystemHeader {
pub table_filesize: u32,
pub file_info_path_count: u32,
pub file_info_index_count: u32,
pub folder_count: u32,
pub folder_offset_count_1: u32,
pub hash_folder_count: u32,
pub file_info_count: u32,
pub file_info_sub_index_count: u32,
pub file_data_count: u32,
pub folder_offset_count_2: u32,
pub file_data_count_2: u32,
pub padding: u32,
pub unk1_10: u32,
pub unk2_10: u32,
pub regional_count_1: u8,
pub regional_count_2: u8,
pub padding2: u16,
pub version: u32,
pub extra_folder: u32,
pub extra_count: u32,
pub unk: [u32; 2],
pub extra_count_2: u32,
pub extra_sub_count: u32,
}
#[derive(BinRead, Debug)]
pub struct StreamHeader {
pub quick_dir_count: u32,
pub stream_hash_count: u32,
pub stream_file_index_count: u32,
pub stream_offset_entry_count: u32,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy)]
#[br(map = Self::from_bytes)]
pub struct QuickDir {
pub hash: u32,
pub name_length: u8,
pub count: B24,
pub index: u32,
}
#[derive(BinRead, Debug, Clone, Copy)]
pub struct StreamEntry {
pub path: HashToIndex,
pub flags: StreamEntryFlags,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[br(map = Self::from_bytes)]
pub struct StreamEntryFlags {
pub is_regional: bool,
pub is_localized: bool,
pub unused: B30,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
#[br(map = Self::from_bytes)]
pub struct HashToIndex {
pub hash: u32,
pub length: u8,
pub index: B24,
}
impl PartialEq<Hash40> for HashToIndex {
fn eq(&self, other: &Hash40) -> bool {
self.hash40() == *other
}
}
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileInfoBucket {
pub start: u32,
pub count: u32,
}
#[repr(C)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FilePath {
pub path: HashToIndex,
pub ext: HashToIndex,
pub parent: HashToIndex,
pub file_name: HashToIndex,
}
#[repr(C)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileInfoIndex {
pub dir_offset_index: u32,
pub file_info_index: FileInfoIdx,
}
#[repr(C)]
#[cfg_attr(feature = "smash-runtime", repr(packed))]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct DirInfo {
pub path: HashToIndex,
pub name: Hash40,
pub parent: Hash40,
pub extra_dis_re: u32,
pub extra_dis_re_length: u32,
pub file_info_start_index: u32,
pub file_count: u32,
pub child_dir_start_index: u32,
pub child_dir_count: u32,
pub flags: DirInfoFlags,
}
#[repr(C)]
#[derive(Debug, Clone)]
pub enum RedirectionType {
Symlink(DirInfo),
Shared(DirectoryOffset),
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[br(map = Self::from_bytes)]
pub struct DirInfoFlags {
pub unk1: B26,
pub redirected: bool,
pub unk2: bool,
pub is_symlink: bool,
pub unk3: B3,
}
#[derive(BinRead, Debug, Clone, Copy)]
pub struct StreamData {
pub size: u64,
pub offset: u64,
}
#[repr(packed)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct DirectoryOffset {
pub offset: u64,
pub decomp_size: u32,
pub size: u32,
pub file_start_index: u32,
pub file_count: u32,
pub directory_index: u32,
}
#[repr(C)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileInfo {
pub file_path_index: FilePathIdx,
pub file_info_indice_index: FileInfoIndiceIdx,
pub info_to_data_index: InfoToDataIdx,
pub flags: FileInfoFlags,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[br(map = Self::from_bytes)]
pub struct FileInfoFlags {
pub unused: B4,
pub is_redirect: bool,
pub unused2: B7,
pub unknown1: bool,
pub padding3: B2,
pub is_regional: bool,
pub is_localized: bool,
pub unused3: B3,
pub unknown2: bool,
pub unknown3: bool,
pub unused4: B10,
}
#[repr(C)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileInfoToFileData {
pub folder_offset_index: u32,
pub file_data_index: FileDataIdx,
pub file_info_index_and_load_type: FileInfoToFileDataBitfield,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[br(map = Self::from_bytes)]
pub struct FileInfoToFileDataBitfield {
pub file_info_idx: B24,
pub load_type: u8,
}
#[repr(C)]
#[derive(BinRead, Debug, Clone, Copy)]
pub struct FileData {
pub offset_in_folder: u32,
pub comp_size: u32,
pub decomp_size: u32,
pub flags: FileDataFlags,
}
#[bitfield]
#[derive(BinRead, Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[br(map = Self::from_bytes)]
pub struct FileDataFlags {
pub compressed: bool,
pub use_zstd: bool,
pub unk: B30,
}
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct SearchListEntry {
pub path: HashToIndex,
pub parent: HashToIndex,
pub file_name: HashToIndex,
pub ext: HashToIndex,
}
#[repr(transparent)]
#[derive(Debug, Copy, Clone)]
pub struct PathListEntry(pub SearchListEntry);
#[repr(transparent)]
#[derive(Debug, Copy, Clone)]
pub struct FolderPathListEntry(pub SearchListEntry);
macro_rules! impl_fs_index {
($to_index:ty, $index_with:ty) => {
impl std::ops::Index<$index_with> for [$to_index] {
type Output = $to_index;
fn index(&self, index: $index_with) -> &Self::Output {
self.get(usize::from(index)).unwrap()
}
}
impl std::ops::IndexMut<$index_with> for [$to_index] {
fn index_mut(&mut self, index: $index_with) -> &mut Self::Output {
self.get_mut(usize::from(index)).unwrap()
}
}
};
}
impl_fs_index!(FilePath, FilePathIdx);
impl_fs_index!(FileInfoIndex, FileInfoIndiceIdx);
impl_fs_index!(FileInfo, FileInfoIdx);
impl_fs_index!(FileInfoToFileData, InfoToDataIdx);
impl_fs_index!(FileData, FileDataIdx);
use std::ops::{Deref, DerefMut};
impl Deref for PathListEntry {
type Target = SearchListEntry;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for PathListEntry {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl Deref for FolderPathListEntry {
type Target = SearchListEntry;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for FolderPathListEntry {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl PathListEntry {
pub fn is_directory(&self) -> bool {
self.parent.index() & 0x40_0000 != 0
}
pub fn as_folder_entry(&self) -> FolderPathListEntry {
let mut file_path = self.path;
file_path.set_index(0xFF_FFFF);
let mut parent = self.parent;
parent.set_index(0x40_0000);
let mut ext = self.ext;
ext.set_hash(0xFFFF_FFFF);
ext.set_length(0x00);
ext.set_index(0x00);
FolderPathListEntry(SearchListEntry {
path: file_path,
parent,
ext,
file_name: self.file_name,
})
}
}
impl FolderPathListEntry {
pub fn get_child_count(&self) -> usize {
self.parent.index() as usize
}
pub fn get_first_child_index(&self) -> usize {
(self.ext.hash40().as_u64() & 0xFF_FFFF) as usize
}
pub fn as_path_entry(&self) -> PathListEntry {
let mut file_path = self.path;
file_path.set_index(0xFF_FFFF);
let mut parent = self.parent;
parent.set_index(0x40_0000);
let mut ext = self.ext;
ext.set_hash(0x0);
ext.set_length(0x0);
ext.set_index(0x0);
PathListEntry(SearchListEntry {
path: file_path,
parent,
ext,
file_name: self.file_name,
})
}
pub fn set_first_child_index(&mut self, idx: u32) {
self.ext.set_hash(idx & 0xFF_FFFF)
}
}