BMSSTOC (Sound TOC) #206
BMSSTOC (Sound TOC) #206
Conversation
steven11sjf
commented
Aug 5, 2024
steven11sjf
commented
- contains helper data for the BFSAR about wave archives, sound streams, and groups
- added some hashes from BFSAR
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #206 +/- ##
==========================================
+ Coverage 76.33% 76.47% +0.14%
==========================================
Files 78 79 +1
Lines 3782 3809 +27
==========================================
+ Hits 2887 2913 +26
- Misses 895 896 +1 ☔ View full report in Codecov by Sentry. |
| "file_id" / FileId, | ||
| "warc_index" / Int32ul, # index of the WARC listed in BFSAR | ||
| "idx" / Int32ul, # 0 to max wave archives | ||
| Check(construct.this._index == construct.this.idx), |
There was a problem hiding this comment.
these Check calls suggest the index fields ought to be in a Rebuild
There was a problem hiding this comment.
Should i keep the check and just add a rebuild? or solely rely on the rebuild?
|
|
||
| FileId = Struct( | ||
| "file_idx" / Int24ul, | ||
| "file_type" / construct.Enum(Byte, sound=1, soundgroup=2, bank=3, player=4, wavearchive=5, group=6), |
There was a problem hiding this comment.
as a rule of thumb, always make an Enum class for use with construct.Enum
| "wav_name" / PropertyEnum, | ||
| "file_id" / FileId, | ||
| "warc_index" / Int32ul, # index of the WARC listed in BFSAR | ||
| "idx" / Int32ul, # 0 to max wave archives |
There was a problem hiding this comment.
I don't understand this comment
There was a problem hiding this comment.
not quite sure the best way to write it but in the BFSAR all sounds have a "global" index which is warc_index (like, sounds are numbered 0 - (N-1) and wave archives are N - N+len(WArc). and the idx field is the same but starts from 0.
| "file_size" / Int32ul, # == length of romfs:/packs/sounds/<group>.bfgrp | ||
| Const(0, Int64ul), | ||
| "group" / PaddedString(0x80, "ascii"), | ||
| "_size" / Rebuild(Int32ul, lambda ctx: len(ctx.wavs)), |
There was a problem hiding this comment.
if this is a length/count, don't call it a size
| "group" / PaddedString(0x80, "ascii"), | ||
| "_size" / Rebuild(Int32ul, lambda ctx: len(ctx.wavs)), | ||
| Const(0, Int32ul), | ||
| Const(b"\x0D\xF0\xAD\xBA" * 4), # 16B of BAADF00D magic from heap alloc |
There was a problem hiding this comment.
does Const(0xBAADF00D)[4] work?
There was a problem hiding this comment.
No, closest i can get is twoConst(0xBAADF00DBAADF00D, Int64ul) calls. You need to specify the FormatField when you do it that way and it throws an error when making a Const an array
| BMSSTOC = Struct( | ||
| "wave_archives" / PrefixedArray(Int32ul, WaveArchiveData), | ||
| "sound_streams" / PrefixedArray(Int32ul, SoundStreams), | ||
| "groups" / construct.Debugger(PrefixedArray(Int32ul, GroupData)), |
There was a problem hiding this comment.
to scare the bugs off obviously
| "wave_archives" / PrefixedArray(Int32ul, WaveArchiveData), | ||
| "sound_streams" / PrefixedArray(Int32ul, SoundStreams), | ||
| "groups" / PrefixedArray(Int32ul, GroupData), | ||
| construct.Terminated, |
There was a problem hiding this comment.
these arrays can all use make_vector()
- contains helper data for the BFSAR about wave archives, sound streams, and groups
