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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
use binread::BinReaderExt;
use bit_field::BitField;
use std::{
io::{Read, Seek, SeekFrom},
marker::PhantomData,
mem::size_of,
num::NonZeroU32,
};
use crate::{
archive::{SerializedFlags, SerializedObjectVersion},
serialization::{
ArrayStreamInfo, Deferrable, Parseable, ReadInfo, SingleItemStreamInfo, Skippable,
StreamInfo,
},
AssetHeader, Error, NameReference, ObjectImport, ObjectVersion, ObjectVersionUE5, Result,
ThumbnailInfo,
};
fn skip_string<R>(reader: &mut R) -> Result<()>
where
R: Seek + Read,
{
let length: i32 = reader.read_le()?;
let (length, character_width) = if length < 0 {
(-length, 2)
} else {
(length, 1)
};
reader.seek(SeekFrom::Current(length as i64 * character_width))?;
Ok(())
}
fn parse_string<R>(reader: &mut R) -> Result<String>
where
R: Seek + Read,
{
let length: i32 = reader.read_le()?;
if length != 0 {
let utf8_bytes = {
if length < 0 {
let length = -length as usize - 1;
let mut utf8_bytes = Vec::with_capacity(3 * length);
for _ in 0..length {
let ch: u16 = reader.read_le()?;
if (0x000..0x0080).contains(&ch) {
utf8_bytes.push(ch as u8);
} else if (0x0080..0x0800).contains(&ch) {
let first = 0b1100_0000 + ch.get_bits(6..11) as u8;
let last = 0b1000_0000 + ch.get_bits(0..6) as u8;
utf8_bytes.push(first);
utf8_bytes.push(last);
} else {
let first = 0b1110_0000 + ch.get_bits(12..16) as u8;
let mid = 0b1000_0000 + ch.get_bits(6..12) as u8;
let last = 0b1000_0000 + ch.get_bits(0..6) as u8;
utf8_bytes.push(first);
utf8_bytes.push(mid);
utf8_bytes.push(last);
}
}
reader.seek(SeekFrom::Current(2))?;
utf8_bytes.shrink_to_fit();
utf8_bytes
} else {
let length = length - 1;
let mut utf8_bytes = Vec::new();
utf8_bytes.resize(length as usize, 0u8);
reader.read_exact(&mut utf8_bytes)?;
reader.seek(SeekFrom::Current(1))?;
utf8_bytes
}
};
String::from_utf8(utf8_bytes).map_err(Error::InvalidString)
} else {
Ok(String::new())
}
}
#[derive(Debug)]
pub struct UnrealString {}
impl Deferrable for UnrealString {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealString {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset))?;
skip_string(reader)
}
}
impl Parseable for UnrealString {
type ParsedType = String;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek + Read,
{
parse_string(reader)
}
}
#[derive(Debug)]
pub struct UnrealNameEntryWithHash {}
impl Deferrable for UnrealNameEntryWithHash {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealNameEntryWithHash {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset))?;
skip_string(reader)?;
reader.seek(SeekFrom::Current(size_of::<[u16; 2]>() as i64))?;
Ok(())
}
}
impl Parseable for UnrealNameEntryWithHash {
type ParsedType = String;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek + Read,
{
let string = parse_string(reader)?;
let _hash: u32 = reader.read_le()?;
Ok(string)
}
}
#[derive(Debug)]
pub struct UnrealArray<ElementType>
where
ElementType: Sized,
{
elements: Vec<ElementType>,
}
impl<ElementType> Deferrable for UnrealArray<ElementType> {
type StreamInfoType = ArrayStreamInfo;
}
impl<ElementType, ElementTypeStreamInfo> Skippable for UnrealArray<ElementType>
where
ElementType: Skippable<StreamInfoType = ElementTypeStreamInfo>,
ElementTypeStreamInfo: StreamInfo,
{
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset))?;
for _ in 0..stream_info.count {
let element_stream_info = ElementTypeStreamInfo::from_current_position(reader)?;
ElementType::seek_past_with_info(reader, &element_stream_info)?;
}
Ok(())
}
}
impl<ElementType, ElementStreamInfoType> Parseable for UnrealArray<ElementType>
where
ElementType: Parseable<StreamInfoType = ElementStreamInfoType>,
ElementStreamInfoType: StreamInfo,
{
type ParsedType = Vec<ElementType::ParsedType>;
fn parse_with_info_seekless<R>(
reader: &mut R,
read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek
+ Read
+ SerializedObjectVersion<ObjectVersion>
+ SerializedObjectVersion<ObjectVersionUE5>
+ SerializedFlags,
{
let mut elements = Vec::with_capacity(read_info.count as usize);
for _ in 0..read_info.count {
let read_info = ElementStreamInfoType::ReadInfoType::from_current_position(reader)?;
elements.push(ElementType::parse_with_info_seekless(reader, &read_info)?);
}
Ok(elements)
}
}
#[derive(Debug)]
pub struct UnrealArrayIterator<'a, ElementType, R>
where
ElementType: Parseable,
{
package: &'a mut AssetHeader<R>,
stream_info: ArrayStreamInfo,
next_index: u64,
phantom: PhantomData<ElementType>,
}
impl<'a, ElementType, ElementStreamInfoType, R> UnrealArrayIterator<'a, ElementType, R>
where
ElementType: Parseable<StreamInfoType = ElementStreamInfoType>,
ElementStreamInfoType: StreamInfo,
R: Seek + Read,
{
pub fn new(package: &'a mut AssetHeader<R>, stream_info: ArrayStreamInfo) -> Result<Self> {
package.archive.seek(SeekFrom::Start(stream_info.offset))?;
Ok(Self {
package,
stream_info,
next_index: 0,
phantom: PhantomData,
})
}
}
impl<'a, ElementType, ElementStreamInfoType, R> Iterator for UnrealArrayIterator<'a, ElementType, R>
where
ElementType: Parseable<StreamInfoType = ElementStreamInfoType>,
ElementStreamInfoType: StreamInfo,
R: Seek + Read,
{
type Item = Result<ElementType::ParsedType>;
fn next(&mut self) -> Option<Self::Item> {
if self.next_index < self.stream_info.count {
self.next_index += 1;
Some(
ElementStreamInfoType::ReadInfoType::from_current_position(
&mut self.package.archive,
)
.and_then(|read_info| {
ElementType::parse_with_info_seekless(&mut self.package.archive, &read_info)
}),
)
} else {
None
}
}
}
const GUID_SIZE: u64 = 16;
pub struct UnrealGuid {}
impl Deferrable for UnrealGuid {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealGuid {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset + GUID_SIZE))?;
Ok(())
}
}
const CUSTOM_VERSION_SIZE: u64 = 20;
pub struct UnrealCustomVersion {}
impl Deferrable for UnrealCustomVersion {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealCustomVersion {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset + CUSTOM_VERSION_SIZE))?;
Ok(())
}
}
const GUID_CUSTOM_VERSION_PREFIX_SIZE: u64 = 20;
pub struct UnrealGuidCustomVersion {}
impl Deferrable for UnrealGuidCustomVersion {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealGuidCustomVersion {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(
stream_info.offset + GUID_CUSTOM_VERSION_PREFIX_SIZE,
))?;
UnrealString::seek_past(reader)?;
Ok(())
}
}
const GENERATION_INFO_SIZE: u64 = 8;
pub struct UnrealGenerationInfo {}
impl Deferrable for UnrealGenerationInfo {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealGenerationInfo {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset + GENERATION_INFO_SIZE))?;
Ok(())
}
}
const COMPRESSED_CHUNK_SIZE: u64 = 16;
pub struct UnrealCompressedChunk {}
impl Deferrable for UnrealCompressedChunk {
type StreamInfoType = SingleItemStreamInfo;
}
impl Skippable for UnrealCompressedChunk {
fn seek_past_with_info<R>(reader: &mut R, stream_info: &Self::StreamInfoType) -> Result<()>
where
R: Seek + Read,
{
reader.seek(SeekFrom::Start(stream_info.offset + COMPRESSED_CHUNK_SIZE))?;
Ok(())
}
}
#[derive(Clone, Debug)]
pub struct UnrealEngineVersion {
pub major: u16,
pub minor: u16,
pub patch: u16,
pub changelist: u32,
pub is_licensee_version: bool,
pub branch_name: String,
}
impl UnrealEngineVersion {
pub const LICENSEE_BIT_MASK: u32 = 0x80000000;
pub const CHANGELIST_MASK: u32 = 0x7fffffff;
pub fn empty() -> Self {
Self {
major: 0,
minor: 0,
patch: 0,
changelist: 0,
is_licensee_version: false,
branch_name: String::new(),
}
}
pub fn from_changelist(changelist: u32) -> Self {
Self {
major: 4,
changelist: changelist & Self::CHANGELIST_MASK,
is_licensee_version: (changelist & Self::LICENSEE_BIT_MASK) != 0,
..Self::empty()
}
}
pub fn is_empty(&self) -> bool {
self.changelist == 0 && !self.is_licensee_version
}
}
impl Deferrable for UnrealEngineVersion {
type StreamInfoType = SingleItemStreamInfo;
}
impl Parseable for UnrealEngineVersion {
type ParsedType = UnrealEngineVersion;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek
+ Read
+ SerializedObjectVersion<ObjectVersion>
+ SerializedObjectVersion<ObjectVersionUE5>
+ SerializedFlags,
{
let major = reader.read_le()?;
let minor = reader.read_le()?;
let patch = reader.read_le()?;
let changelist = reader.read_le()?;
let branch_name = UnrealString::parse_inline(reader)?;
Ok(Self::ParsedType {
major,
minor,
patch,
branch_name,
..Self::from_changelist(changelist)
})
}
}
#[derive(Debug)]
pub struct UnrealNameReference {}
impl Deferrable for UnrealNameReference {
type StreamInfoType = SingleItemStreamInfo;
}
impl Parseable for UnrealNameReference {
type ParsedType = NameReference;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek + Read,
{
let index = reader.read_le()?;
let number = NonZeroU32::new(reader.read_le()?);
Ok(Self::ParsedType { index, number })
}
}
#[derive(Debug)]
pub struct UnrealClassImport {}
impl Deferrable for UnrealClassImport {
type StreamInfoType = SingleItemStreamInfo;
}
impl Parseable for UnrealClassImport {
type ParsedType = ObjectImport;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek
+ Read
+ SerializedObjectVersion<ObjectVersion>
+ SerializedObjectVersion<ObjectVersionUE5>
+ SerializedFlags,
{
let class_package = UnrealNameReference::parse_inline(reader)?;
let class_name = UnrealNameReference::parse_inline(reader)?;
let outer_index = reader.read_le()?;
let object_name = UnrealNameReference::parse_inline(reader)?;
let package_name = if reader
.serialized_with(ObjectVersion::VER_UE4_NON_OUTER_PACKAGE_IMPORT)
&& reader.serialized_with_editoronly_data()
{
Some(UnrealNameReference::parse_inline(reader)?)
} else {
None
};
let import_optional = if reader.serialized_with(ObjectVersionUE5::OPTIONAL_RESOURCES) {
reader.read_le::<u32>()? != 0
} else {
false
};
Ok(Self::ParsedType {
class_package,
class_name,
outer_index,
object_name,
package_name,
import_optional,
})
}
}
#[derive(Debug)]
pub struct UnrealThumbnailInfo {}
impl Deferrable for UnrealThumbnailInfo {
type StreamInfoType = SingleItemStreamInfo;
}
impl Parseable for UnrealThumbnailInfo {
type ParsedType = ThumbnailInfo;
fn parse_with_info_seekless<R>(
reader: &mut R,
_read_info: &<Self::StreamInfoType as StreamInfo>::ReadInfoType,
) -> Result<Self::ParsedType>
where
R: Seek
+ Read
+ SerializedObjectVersion<ObjectVersion>
+ SerializedObjectVersion<ObjectVersionUE5>
+ SerializedFlags,
{
let object_class_name = UnrealString::parse_inline(reader)?;
let object_path_without_package_name = UnrealString::parse_inline(reader)?;
let file_offset = reader.read_le()?;
Ok(Self::ParsedType {
object_class_name,
object_path_without_package_name,
file_offset,
})
}
}