Root cause of three identical field crashes (audio thread, opcode fetch
through a pointer with its low 32 bits overwritten, seconds after scene
transitions): AudioHeap_AllocPermanent writes permanentCache[index] with
index = permanentPool.count and no bound against the 32-entry array. In
SoH every soundfont sync-load is forced permanent, and custom sequences
whose SEQ.xml says CachePolicy="Temporary" ALSO allocate permanently
(the factory stores the LUS enum where CACHE_TEMPORARY == 0, while
AudioLoad_SyncLoad's switch reads 0 with the ROM convention
'permanent'). A pack with ~60 streamed customs plus vanilla fonts pushes
count past 32 within a session, after which each allocation sprays a
{ptr, size, tableType/id} triplet at 24-byte stride through
gAudioContext - entry[135]'s ptr field lands exactly on
seqPlayers[0].scriptState.pc and entry[156] on seqPlayers[1]'s (both
verified against the crash-dump registers).
- permanentCache raised 32 -> 512 (12 KB) and AllocPermanent refuses
allocations past the array instead of corrupting memory.
- Same unbounded-index disease fixed in the three sibling writers:
AllocCached's persistent path (16-entry array; CACHE_EITHER degrades
to temporary, hard persistent requests fail cleanly),
AllocPersistentSampleCacheEntry, AllocTemporarySampleCacheEntry.
- seqLoadStatus malloc sized for the full id space (sequenceMapSize +
0xF) matching sequenceMap; custom ids above sequenceMapSize previously
overflowed the allocation by up to 15 bytes.
Upstream SoH bugs, not branch-introduced - this branch's many-track
packs merely made the overflow reachable in normal play. Standalone
upstreamable fix.
* Bring over changes from 2ship
# Conflicts:
# .github/workflows/apt-deps.txt
# soh/CMakeLists.txt
# soh/soh/resource/importer/AudioSampleFactory.h
# soh/soh/resource/importer/AudioSequenceFactory.cpp
# soh/soh/resource/importer/AudioSequenceFactory.h
# soh/soh/resource/importer/AudioSoundFontFactory.h
* Update xml format
* Format and fix mixer for Windows
* Fixes for new LUS
* Good ole clang-format
* Allows OTRExporter to parse pairs of .seq and .meta files
* Gets added sequences available to SfxEditor and playing in game.
* Some cleanup of the names appearing in the SfxEditor.
* Moves sequence swap lower in the audio command stack.
* Increases temp cache memory available on title/file-select screen.
Certain sequences wouldn't play on the file select and title screen
because they were too large to be cached.
* Introduces workaround for 255 sequence limit.
* Bug fixes and cleanup.
* Fixes bug where fanfares would sometimes disable the sequence player.
* Fixes bug causing certain areas to discard caches when loading enemy music.
* Fixes potential config-related crash by replacing invalid characters.
* Allows custom bgm to play in all BGM categories.
* Properly randomizes the custom tracks.
* Moves custom sequences to a patch OTR.
* If custom music was not loaded, fall back to default values.
* Prevents OOB crash on Synthwave array and adds octave drop feature.
Added octave drop to experimental features, which drops the octave of
a note that is too high for the audio engine to actually play. Without
this, some custom sequences have notes which cap at a specific value
and sound terrible. At least with this they will still harmonize with
the other notes. Experimental tab added to the SfxEditor to house
the checkbox for the octave drop feature.
* Adds more pool memory for a few tracks that couldn't fit.
* Some cleanup on the generated music archive process.
* Fixes missed memory boost from earlier.
* Adds ability to remove enemy proximity music.
* Applies correct cache policy to fanfares to prevent unloading sequences.
* Removes case-sensitiveness of the sequence type.
* Fixes not reverting to sequence after miniboss.
* Fixes transition to/from miniboss (again) and ocarina bug.
To be clear, fixes the more rampant portable ocarina bug present in my earlier builds, not the authentic one.
* Finally properly fixes transitions between sequences
For miniboss fights and SfxEditor previews.
* Removes unneeded boolean expression.
* Adds randomize button to individual SFX Editor entries.
* Fixes lost woods music overwriting goron city music.
* Plays swapped Hyrule Field music when transitioning to daytime.
* Fixes swapping Gerudo Valley music when transitioning from daytime.
* Updates custom sequence OTRPath to match SequenceOTRizer.
* Reverts changes to OTRExporter in favor of external tool
* Fixes formatting issues.
* Attempts to fix formatting issue in git diff.
* Should actually fix formatting issues.
* Should fix mac/linux exclusive build error.
* Fixes segfault on macos.
* sort custom seqs
* Fixes audioseq crash when under 255 seqs
* Removes magic numbers.
* Removes commented out code.
* fixes formatting in SfxEditor.h
Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>
* Cleans up the one hardcoded QueueSeqCmd call.
* Fixes unneeded erroneous memory boost applied earlier.
* Applies additional formatting/cleanliness suggestions from review
* Fixes small logic bug
Co-authored-by: RaelCappra <rael.cappra@gmail.com>
Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>
Pedro Nascimento