summaryrefslogtreecommitdiff
path: root/include/audio
diff options
context:
space:
mode:
authorengineer124 <47598039+engineer124@users.noreply.github.com>2024-02-09 04:36:11 +1100
committerGitHub <noreply@github.com>2024-02-08 14:36:11 -0300
commiteb577e29e4ca049fc225314ef2b7e438879eb06a (patch)
tree9ff390819665f05ab0653335f66cc4074218100d /include/audio
parent7e716e120f882afdb3eec9c68b9f8cb16489fde1 (diff)
Introduce More Audio Headers (#1515)
* 4 audio headers * local first * PR Review, more cleanup * more cleanup * fix bss * PR Review * PR Suggestions
Diffstat (limited to 'include/audio')
-rw-r--r--include/audio/heap.h22
-rw-r--r--include/audio/list.h43
-rw-r--r--include/audio/load.h32
-rw-r--r--include/audio/playback.h139
-rw-r--r--include/audio/reverb.h8
-rw-r--r--include/audio/seqplayer.h245
-rw-r--r--include/audio/synthesis.h54
7 files changed, 511 insertions, 32 deletions
diff --git a/include/audio/heap.h b/include/audio/heap.h
index 33f3dfcd9..2c4147dbc 100644
--- a/include/audio/heap.h
+++ b/include/audio/heap.h
@@ -5,7 +5,7 @@
#include "libc/stddef.h"
#include "unk.h"
-typedef struct {
+typedef struct AudioHeapInitSizes {
/* 0x0 */ size_t heapSize; // total number of bytes allocated to the audio heap. Must be <= the size of `gAudioHeap` (ideally about the same size)
/* 0x4 */ size_t initPoolSize; // The entire audio heap is split into two pools.
/* 0x8 */ size_t permanentPoolSize;
@@ -14,7 +14,7 @@ typedef struct {
/**
* Meta-data associated with a pool (contain withing the Audio Heap)
*/
-typedef struct {
+typedef struct AudioAllocPool {
/* 0x0 */ u8* startAddr; // start addr of the pool
/* 0x4 */ u8* curAddr; // address of the next available memory for allocation
/* 0x8 */ size_t size; // size of the pool
@@ -24,7 +24,7 @@ typedef struct {
/**
* Audio cache entry data to store a single entry containing either a sequence, soundfont, or entire sample banks
*/
-typedef struct {
+typedef struct AudioCacheEntry {
/* 0x0 */ u8* addr;
/* 0x4 */ size_t size;
/* 0x8 */ s16 tableType;
@@ -34,7 +34,7 @@ typedef struct {
/**
* Audio cache entry data to store a single entry containing an individual sample
*/
-typedef struct {
+typedef struct SampleCacheEntry {
/* 0x00 */ s8 inUse;
/* 0x01 */ s8 origMedium;
/* 0x02 */ u8 sampleBankId;
@@ -47,42 +47,42 @@ typedef struct {
/**
* Audio cache entry data to store individual samples
*/
-typedef struct {
+typedef struct AudioSampleCache {
/* 0x000 */ AudioAllocPool pool;
/* 0x010 */ SampleCacheEntry entries[128];
/* 0xA10 */ s32 numEntries;
} AudioSampleCache; // size = 0xA14
-typedef struct {
+typedef struct AudioPersistentCache {
/* 0x00 */ u32 numEntries;
/* 0x04 */ AudioAllocPool pool;
/* 0x14 */ AudioCacheEntry entries[16];
} AudioPersistentCache; // size = 0xD4
-typedef struct {
+typedef struct AudioTemporaryCache {
/* 0x00 */ u32 nextSide;
/* 0x04 */ AudioAllocPool pool;
/* 0x14 */ AudioCacheEntry entries[2];
} AudioTemporaryCache; // size = 0x3C
-typedef struct {
+typedef struct AudioCache {
/* 0x000 */ AudioPersistentCache persistent;
/* 0x0D4 */ AudioTemporaryCache temporary;
/* 0x100 */ UNK_TYPE1 pad100[0x10];
} AudioCache; // size = 0x110
-typedef struct {
+typedef struct AudioCachePoolSplit {
/* 0x0 */ size_t persistentCommonPoolSize;
/* 0x4 */ size_t temporaryCommonPoolSize;
} AudioCachePoolSplit; // size = 0x8
-typedef struct {
+typedef struct AudioCommonPoolSplit {
/* 0x0 */ size_t seqCacheSize;
/* 0x4 */ size_t fontCacheSize;
/* 0x8 */ size_t sampleBankCacheSize;
} AudioCommonPoolSplit; // size = 0xC
-typedef struct {
+typedef struct AudioSessionPoolSplit {
/* 0x0 */ size_t miscPoolSize;
/* 0x4 */ size_t unusedSizes[2];
/* 0xC */ size_t cachePoolSize;
diff --git a/include/audio/list.h b/include/audio/list.h
new file mode 100644
index 000000000..0f05d8634
--- /dev/null
+++ b/include/audio/list.h
@@ -0,0 +1,43 @@
+#ifndef AUDIO_LIST_H
+#define AUDIO_LIST_H
+
+#include "PR/ultratypes.h"
+
+// A node in a circularly linked list. Each node is either a head or an item:
+// - Items can be either detached (prev = NULL), or attached to a list.
+// 'value' points to something of interest.
+// - List heads are always attached; if a list is empty, its head points
+// to itself. 'count' contains the size of the list.
+// If the list holds notes, 'pool' points back to the pool where it lives.
+// Otherwise, that member is NULL.
+typedef struct AudioListItem {
+ /* 0x0 */ struct AudioListItem* prev;
+ /* 0x4 */ struct AudioListItem* next;
+ union {
+ /* 0x8 */ void* value; // either Note* or SequenceLayer*
+ /* 0x8 */ s32 count;
+ } u;
+ /* 0xC */ struct NotePool* pool;
+} AudioListItem; // size = 0x10
+
+typedef struct NotePool {
+ /* 0x00 */ AudioListItem disabled;
+ /* 0x10 */ AudioListItem decaying;
+ /* 0x20 */ AudioListItem releasing;
+ /* 0x30 */ AudioListItem active;
+} NotePool; // size = 0x40
+
+// playback.c functions
+
+void AudioList_InitNoteLists(NotePool* pool);
+void AudioList_InitNoteFreeList(void);
+void AudioList_ClearNotePool(NotePool* pool);
+void AudioList_FillNotePool(NotePool* pool, s32 count);
+void AudioList_Remove(AudioListItem* item);
+
+// seqplayer.c functions
+
+void AudioList_PushBack(AudioListItem* list, AudioListItem* item);
+void* AudioList_PopBack(AudioListItem* list);
+
+#endif
diff --git a/include/audio/load.h b/include/audio/load.h
index eccdc2db2..2952dee01 100644
--- a/include/audio/load.h
+++ b/include/audio/load.h
@@ -1,25 +1,23 @@
#ifndef AUDIO_LOAD_H
#define AUDIO_LOAD_H
-#include "audio/soundfont.h"
+#include "soundfont.h"
+#include "PR/os.h"
+#include "PR/os_message.h"
#include "PR/ultratypes.h"
#include "libc/stddef.h"
#include "libc/stdint.h"
-#include "PR/os_message.h"
#include "unk.h"
-#include "PR/os.h"
-
-struct Sample;
typedef s32 (*DmaHandler)(OSPiHandle* handle, OSIoMesg* mb, s32 direction);
-typedef enum {
+typedef enum SampleBankTableType {
/* 0 */ SEQUENCE_TABLE,
/* 1 */ FONT_TABLE,
/* 2 */ SAMPLE_TABLE
} SampleBankTableType;
-typedef struct {
+typedef struct AudioTableEntry {
/* 0x0 */ uintptr_t romAddr;
/* 0x4 */ size_t size;
/* 0x8 */ s8 medium;
@@ -29,7 +27,7 @@ typedef struct {
/* 0xE */ s16 shortData3;
} AudioTableEntry; // size = 0x10
-typedef struct {
+typedef struct AudioTable {
/* 0x00 */ s16 numEntries;
/* 0x02 */ s16 unkMediumParam;
/* 0x04 */ uintptr_t romAddr;
@@ -37,7 +35,7 @@ typedef struct {
/* 0x10 */ AudioTableEntry entries[1]; // (dynamic size)
} AudioTable; // size >= 0x20
-typedef enum {
+typedef enum AudioLoadStatus {
/* 0 */ LOAD_STATUS_NOT_LOADED,
/* 1 */ LOAD_STATUS_IN_PROGRESS,
/* 2 */ LOAD_STATUS_COMPLETE,
@@ -46,14 +44,14 @@ typedef enum {
/* 5 */ LOAD_STATUS_PERMANENT
} AudioLoadStatus;
-typedef enum {
+typedef enum AudioCacheType {
/* 0 */ CACHE_TEMPORARY,
/* 1 */ CACHE_PERSISTENT,
/* 2 */ CACHE_EITHER,
/* 3 */ CACHE_PERMANENT
} AudioCacheType;
-typedef enum {
+typedef enum AudioCacheLoadType {
/* 0 */ CACHE_LOAD_PERMANENT,
/* 1 */ CACHE_LOAD_PERSISTENT,
/* 2 */ CACHE_LOAD_TEMPORARY,
@@ -61,7 +59,7 @@ typedef enum {
/* 4 */ CACHE_LOAD_EITHER_NOSYNC
} AudioCacheLoadType;
-typedef struct {
+typedef struct AudioAsyncLoad {
/* 0x00 */ s8 status;
/* 0x01 */ s8 delay;
/* 0x02 */ s8 medium;
@@ -78,7 +76,7 @@ typedef struct {
/* 0x40 */ OSIoMesg ioMesg;
} AudioAsyncLoad; // size = 0x58
-typedef struct {
+typedef struct AudioSlowLoad {
/* 0x00 */ u8 medium;
/* 0x01 */ u8 seqOrFontId;
/* 0x02 */ u16 instId;
@@ -89,13 +87,13 @@ typedef struct {
/* 0x14 */ s32 status;
/* 0x18 */ size_t bytesRemaining;
/* 0x1C */ s8* isDone; // TODO: rename in OoT and sync up here. This is an external status while (s32 status) is an internal status
- /* 0x20 */ struct Sample sample;
+ /* 0x20 */ Sample sample;
/* 0x30 */ OSMesgQueue msgqueue;
/* 0x48 */ OSMesg msg;
/* 0x4C */ OSIoMesg ioMesg;
} AudioSlowLoad; // size = 0x64
-typedef struct {
+typedef struct SampleDma {
/* 0x0 */ u8* ramAddr;
/* 0x4 */ uintptr_t devAddr;
/* 0x8 */ u16 sizeUnused;
@@ -105,9 +103,9 @@ typedef struct {
/* 0xE */ u8 ttl; // Time To Live: duration after which the DMA can be discarded
} SampleDma; // size = 0x10
-typedef struct {
+typedef struct AudioPreloadReq {
/* 0x00 */ u32 endAndMediumKey;
- /* 0x04 */ struct Sample* sample;
+ /* 0x04 */ Sample* sample;
/* 0x08 */ u8* ramAddr;
/* 0x0C */ u32 encodedInfo;
/* 0x10 */ s32 isFree;
diff --git a/include/audio/playback.h b/include/audio/playback.h
new file mode 100644
index 000000000..cd01bc61d
--- /dev/null
+++ b/include/audio/playback.h
@@ -0,0 +1,139 @@
+#ifndef AUDIO_PLAYBACK_H
+#define AUDIO_PLAYBACK_H
+
+#include "synthesis.h"
+#include "effects.h"
+#include "list.h"
+#include "PR/ultratypes.h"
+#include "unk.h"
+
+struct SequenceLayer;
+struct Instrument;
+struct TunedSample;
+struct Drum;
+struct SoundEffect;
+
+#define AUDIO_ERROR(fontId, id, err) (((fontId << 8) + id) + (err << 24))
+
+typedef enum AudioError {
+ /* 0x01 */ AUDIO_ERROR_NO_INST = 1,
+ /* 0x03 */ AUDIO_ERROR_INVALID_INST_ID = 3,
+ /* 0x04 */ AUDIO_ERROR_INVALID_DRUM_SFX_ID,
+ /* 0x05 */ AUDIO_ERROR_NO_DRUM_SFX,
+ /* 0x10 */ AUDIO_ERROR_FONT_NOT_LOADED = 0x10
+} AudioError;
+
+typedef union {
+ struct {
+ /* 0x0 */ u8 unused : 2;
+ /* 0x0 */ u8 type : 2;
+ /* 0x0 */ u8 strongRight : 1;
+ /* 0x0 */ u8 strongLeft : 1;
+ /* 0x0 */ u8 strongReverbRight : 1;
+ /* 0x0 */ u8 strongReverbLeft : 1;
+ };
+ /* 0x0 */ u8 asByte;
+} StereoData; // size = 0x1
+
+typedef struct NoteAttributes {
+ /* 0x00 */ u8 targetReverbVol;
+ /* 0x01 */ u8 gain; // Increases volume by a multiplicative scaling factor. Represented as a UQ4.4 number
+ /* 0x02 */ u8 pan;
+ /* 0x03 */ u8 surroundEffectIndex;
+ /* 0x04 */ StereoData stereoData;
+ /* 0x05 */ u8 combFilterSize;
+ /* 0x06 */ u16 combFilterGain;
+ /* 0x08 */ f32 freqScale;
+ /* 0x0C */ f32 velocity;
+ /* 0x10 */ s16* filter;
+ /* 0x14 */ s16* filterBuf;
+} NoteAttributes; // size = 0x18
+
+typedef enum NotePlaybackStatus {
+ /* 0 */ PLAYBACK_STATUS_0,
+ /* 1 */ PLAYBACK_STATUS_1,
+ /* 2 */ PLAYBACK_STATUS_2
+} NotePlaybackStatus;
+
+typedef struct NotePlaybackState {
+ /* 0x00 */ u8 priority;
+ /* 0x01 */ u8 waveId;
+ /* 0x02 */ u8 harmonicIndex; // the harmonic index for the synthetic wave contained in gWaveSamples (also matches the base 2 logarithm of the harmonic order)
+ /* 0x03 */ u8 fontId;
+ /* 0x04 */ u8 status;
+ /* 0x05 */ u8 stereoHeadsetEffects;
+ /* 0x06 */ s16 adsrVolScaleUnused;
+ /* 0x08 */ f32 portamentoFreqScale;
+ /* 0x0C */ f32 vibratoFreqScale;
+ /* 0x18 */ struct SequenceLayer* wantedParentLayer;
+ /* 0x14 */ struct SequenceLayer* parentLayer;
+ /* 0x10 */ struct SequenceLayer* prevParentLayer;
+ /* 0x1C */ NoteAttributes attributes;
+ /* 0x34 */ AdsrState adsr;
+ /* 0x54 */ Portamento portamento;
+ /* 0x60 */ VibratoState vibratoState;
+ /* 0x7C */ UNK_TYPE1 pad7C[0x4];
+ /* 0x80 */ u8 unk_80;
+ /* 0x84 */ u32 startSamplePos;
+ /* 0x88 */ UNK_TYPE1 unk_BC[0x1C];
+} NotePlaybackState; // size = 0xA4
+
+typedef struct NoteSampleState {
+ struct {
+ /* 0x00 */ vu8 enabled : 1;
+ /* 0x00 */ u8 needsInit : 1;
+ /* 0x00 */ u8 finished : 1;
+ /* 0x00 */ u8 unused : 1;
+ /* 0x00 */ u8 strongRight : 1;
+ /* 0x00 */ u8 strongLeft : 1;
+ /* 0x00 */ u8 strongReverbRight : 1;
+ /* 0x00 */ u8 strongReverbLeft : 1;
+ } bitField0;
+ struct {
+ /* 0x01 */ u8 reverbIndex : 3;
+ /* 0x01 */ u8 bookOffset : 2;
+ /* 0x01 */ u8 isSyntheticWave : 1;
+ /* 0x01 */ u8 hasTwoParts : 1;
+ /* 0x01 */ u8 useHaasEffect : 1;
+ } bitField1;
+ /* 0x02 */ u8 gain; // Increases volume by a multiplicative scaling factor. Represented as a UQ4.4 number
+ /* 0x03 */ u8 haasEffectLeftDelaySize;
+ /* 0x04 */ u8 haasEffectRightDelaySize;
+ /* 0x05 */ u8 targetReverbVol;
+ /* 0x06 */ u8 harmonicIndexCurAndPrev; // bits 3..2 store curHarmonicIndex, bits 1..0 store prevHarmonicIndex
+ /* 0x07 */ u8 combFilterSize;
+ /* 0x08 */ u16 targetVolLeft;
+ /* 0x0A */ u16 targetVolRight;
+ /* 0x0C */ u16 frequencyFixedPoint;
+ /* 0x0E */ u16 combFilterGain;
+ union {
+ /* 0x10 */ TunedSample* tunedSample;
+ /* 0x10 */ s16* waveSampleAddr; // used for synthetic waves
+ };
+ /* 0x14 */ s16* filter;
+ /* 0x18 */ UNK_TYPE1 unk_18;
+ /* 0x19 */ u8 surroundEffectIndex;
+ /* 0x1A */ UNK_TYPE1 unk_1A[0x6];
+} NoteSampleState; // size = 0x20
+
+typedef struct Note {
+ /* 0x00 */ AudioListItem listItem;
+ /* 0x10 */ NoteSynthesisState synthesisState;
+ /* 0x34 */ NotePlaybackState playbackState;
+ /* 0xD8 */ NoteSampleState sampleState;
+} Note; // size = 0xF8
+
+void AudioPlayback_NoteDisable(Note* note);
+void AudioPlayback_ProcessNotes(void);
+struct TunedSample* AudioPlayback_GetInstrumentTunedSample(struct Instrument* instrument, s32 semitone);
+struct Instrument* AudioPlayback_GetInstrumentInner(s32 fontId, s32 instId);
+struct Drum* AudioPlayback_GetDrum(s32 fontId, s32 drumId);
+struct SoundEffect* AudioPlayback_GetSoundEffect(s32 fontId, s32 sfxId);
+s32 AudioPlayback_SetFontInstrument(s32 instrumentType, s32 fontId, s32 index, void* value);
+void AudioPlayback_SeqLayerNoteDecay(struct SequenceLayer* layer);
+void AudioPlayback_SeqLayerNoteRelease(struct SequenceLayer* layer);
+void AudioPlayback_InitSyntheticWave(Note* note, struct SequenceLayer* layer);
+Note* AudioPlayback_AllocNote(struct SequenceLayer* layer);
+void AudioPlayback_NoteInitAll(void);
+
+#endif
diff --git a/include/audio/reverb.h b/include/audio/reverb.h
index 83df3eed9..6d10fc59a 100644
--- a/include/audio/reverb.h
+++ b/include/audio/reverb.h
@@ -1,8 +1,8 @@
#ifndef AUDIO_REVERB_H
#define AUDIO_REVERB_H
+#include "soundfont.h"
#include "PR/ultratypes.h"
-#include "audio/soundfont.h"
#define REVERB_INDEX_NONE -1
@@ -19,7 +19,7 @@ typedef enum ReverbDataType {
/* 9 */ REVERB_DATA_TYPE_9 // Reverb Unk
} ReverbDataType;
-typedef struct {
+typedef struct ReverbSettings {
/* 0x00 */ u8 downsampleRate;
/* 0x02 */ u16 delayNumSamples;
/* 0x04 */ u16 decayRatio; // determines how fast reverb dissipates
@@ -39,7 +39,7 @@ typedef struct {
* By storing the sample in a ring buffer, the time it takes to loop
* around back to the same sample acts as a delay, leading to an echo effect.
*/
-typedef struct {
+typedef struct ReverbBufferEntry {
/* 0x00 */ s16 numSamplesAfterDownsampling; // never read
/* 0x02 */ s16 numSamples; // never read
/* 0x04 */ s16* toDownsampleLeft;
@@ -52,7 +52,7 @@ typedef struct {
/* 0x18 */ u16 saveResampleNumSamples;
} ReverbBufferEntry; // size = 0x1C
-typedef struct {
+typedef struct SynthesisReverb {
/* 0x000 */ u8 resampleFlags;
/* 0x001 */ u8 useReverb;
/* 0x002 */ u8 framesToIgnore;
diff --git a/include/audio/seqplayer.h b/include/audio/seqplayer.h
new file mode 100644
index 000000000..6e656f5cf
--- /dev/null
+++ b/include/audio/seqplayer.h
@@ -0,0 +1,245 @@
+#ifndef AUDIO_SEQPLAYER_H
+#define AUDIO_SEQPLAYER_H
+
+#include "effects.h"
+#include "list.h"
+#include "playback.h"
+#include "PR/ultratypes.h"
+#include "PR/abi.h"
+#include "unk.h"
+
+struct Sample;
+struct Instrument;
+struct TunedSample;
+
+#define SEQ_NUM_CHANNELS 16
+
+#define NO_LAYER ((SequenceLayer*)(-1))
+
+#define TATUMS_PER_BEAT 48
+
+#define IS_SEQUENCE_CHANNEL_VALID(ptr) ((uintptr_t)(ptr) != (uintptr_t)&gAudioCtx.sequenceChannelNone)
+#define SEQ_IO_VAL_NONE -1
+
+#define MUTE_FLAGS_STOP_SAMPLES (1 << 3) // prevent further noteSubEus from playing
+#define MUTE_FLAGS_STOP_LAYER (1 << 4) // stop something in seqLayer scripts
+#define MUTE_FLAGS_SOFTEN (1 << 5) // lower volume, by default to half
+#define MUTE_FLAGS_STOP_NOTES (1 << 6) // prevent further notes from playing
+#define MUTE_FLAGS_STOP_SCRIPT (1 << 7) // stop processing sequence/channel scripts
+
+typedef struct SeqScriptState {
+ /* 0x00 */ u8* pc; // program counter
+ /* 0x04 */ u8* stack[4];
+ /* 0x14 */ u8 remLoopIters[4]; // remaining loop iterations
+ /* 0x18 */ u8 depth;
+ /* 0x19 */ s8 value;
+} SeqScriptState; // size = 0x1C
+
+typedef enum SeqPlayerState {
+ /* 0 */ SEQPLAYER_STATE_0,
+ /* 1 */ SEQPLAYER_STATE_FADE_IN,
+ /* 2 */ SEQPLAYER_STATE_FADE_OUT
+} SeqPlayerState;
+
+// Also known as a Group, according to debug strings.
+typedef struct SequencePlayer {
+ /* 0x000 */ u8 enabled : 1;
+ /* 0x000 */ u8 finished : 1;
+ /* 0x000 */ u8 muted : 1;
+ /* 0x000 */ u8 seqDmaInProgress : 1;
+ /* 0x000 */ u8 fontDmaInProgress : 1;
+ /* 0x000 */ u8 recalculateVolume : 1;
+ /* 0x000 */ u8 stopScript : 1;
+ /* 0x000 */ u8 applyBend : 1;
+ /* 0x001 */ u8 state;
+ /* 0x002 */ u8 noteAllocPolicy;
+ /* 0x003 */ u8 muteFlags;
+ /* 0x004 */ u8 seqId;
+ /* 0x005 */ u8 defaultFont;
+ /* 0x006 */ u8 unk_06[1];
+ /* 0x007 */ s8 playerIndex;
+ /* 0x008 */ u16 tempo; // tatums per minute
+ /* 0x00A */ u16 tempoAcc;
+ /* 0x00C */ s16 tempoChange;
+ /* 0x00E */ s16 transposition;
+ /* 0x010 */ u16 delay;
+ /* 0x012 */ u16 fadeTimer;
+ /* 0x014 */ u16 storedFadeTimer;
+ /* 0x016 */ u16 unk_16;
+ /* 0x018 */ u8* seqData;
+ /* 0x01C */ f32 fadeVolume;
+ /* 0x020 */ f32 fadeVelocity;
+ /* 0x024 */ f32 volume;
+ /* 0x028 */ f32 muteVolumeScale;
+ /* 0x02C */ f32 fadeVolumeScale;
+ /* 0x030 */ f32 appliedFadeVolume;
+ /* 0x034 */ f32 bend;
+ /* 0x038 */ struct SequenceChannel* channels[16];
+ /* 0x078 */ SeqScriptState scriptState;
+ /* 0x094 */ u8* shortNoteVelocityTable;
+ /* 0x098 */ u8* shortNoteGateTimeTable;
+ /* 0x09C */ NotePool notePool;
+ /* 0x0DC */ s32 skipTicks;
+ /* 0x0E0 */ u32 scriptCounter;
+ /* 0x0E4 */ UNK_TYPE1 unk_E4[0x74]; // unused struct members for sequence/sound font dma management, according to sm64 decomp
+ /* 0x158 */ s8 seqScriptIO[8];
+} SequencePlayer; // size = 0x160
+
+// Also known as a SubTrack, according to sm64 debug strings.
+typedef struct SequenceChannel {
+ /* 0x00 */ u8 enabled : 1;
+ /* 0x00 */ u8 finished : 1;
+ /* 0x00 */ u8 stopScript : 1;
+ /* 0x00 */ u8 muted : 1; // sets SequenceLayer.muted
+ /* 0x00 */ u8 hasInstrument : 1;
+ /* 0x00 */ u8 stereoHeadsetEffects : 1;
+ /* 0x00 */ u8 largeNotes : 1; // notes specify duration and velocity
+ /* 0x00 */ u8 unused : 1;
+ union {
+ struct {
+ /* 0x01 */ u8 freqScale : 1;
+ /* 0x01 */ u8 volume : 1;
+ /* 0x01 */ u8 pan : 1;
+ } s;
+ /* 0x01 */ u8 asByte;
+ } changes;
+ /* 0x02 */ u8 noteAllocPolicy;
+ /* 0x03 */ u8 muteFlags;
+ /* 0x04 */ u8 targetReverbVol; // or dry/wet mix
+ /* 0x05 */ u8 notePriority; // 0-3
+ /* 0x06 */ u8 someOtherPriority;
+ /* 0x07 */ u8 fontId;
+ /* 0x08 */ u8 reverbIndex;
+ /* 0x09 */ u8 bookOffset;
+ /* 0x0A */ u8 newPan;
+ /* 0x0B */ u8 panChannelWeight; // proportion of pan that comes from the channel (0..128)
+ /* 0x0C */ u8 gain; // Increases volume by a multiplicative scaling factor. Represented as a UQ4.4 number
+ /* 0x0D */ u8 velocityRandomVariance;
+ /* 0x0E */ u8 gateTimeRandomVariance;
+ /* 0x0F */ u8 combFilterSize;
+ /* 0x10 */ u8 surroundEffectIndex;
+ /* 0x11 */ u8 channelIndex;
+ /* 0x12 */ VibratoSubStruct vibrato;
+ /* 0x20 */ u16 delay;
+ /* 0x22 */ u16 combFilterGain;
+ /* 0x24 */ u16 unk_22; // Used for indexing data
+ /* 0x26 */ s16 instOrWave; // either 0 (none), instrument index + 1, or
+ // 0x80..0x83 for sawtooth/triangle/sine/square waves.
+ /* 0x28 */ s16 transposition;
+ /* 0x2C */ f32 volumeScale;
+ /* 0x30 */ f32 volume;
+ /* 0x34 */ s32 pan;
+ /* 0x38 */ f32 appliedVolume;
+ /* 0x3C */ f32 freqScale;
+ /* 0x40 */ u8 (*dynTable)[][2];
+ /* 0x44 */ Note* noteUnused;
+ /* 0x48 */ struct SequenceLayer* layerUnused;
+ /* 0x4C */ struct Instrument* instrument;
+ /* 0x50 */ SequencePlayer* seqPlayer;
+ /* 0x54 */ struct SequenceLayer* layers[4];
+ /* 0x64 */ SeqScriptState scriptState;
+ /* 0x80 */ AdsrSettings adsr;
+ /* 0x88 */ NotePool notePool;
+ /* 0xC8 */ s8 seqScriptIO[8]; // bridge between sound script and audio lib, "io ports"
+ /* 0xD0 */ u8* sfxState; // SfxChannelState
+ /* 0xD4 */ s16* filter;
+ /* 0xD8 */ StereoData stereoData;
+ /* 0xDC */ s32 startSamplePos;
+ /* 0xE0 */ s32 unk_E0;
+} SequenceChannel; // size = 0xE4
+
+// Might also be known as a Track, according to sm64 debug strings (?).
+typedef struct SequenceLayer {
+ /* 0x00 */ u8 enabled : 1;
+ /* 0x00 */ u8 finished : 1;
+ /* 0x00 */ u8 muted : 1;
+ /* 0x00 */ u8 continuousNotes : 1; // keep the same note for consecutive notes with the same sound
+ /* 0x00 */ u8 bit3 : 1; // "loaded"?
+ /* 0x00 */ u8 ignoreDrumPan : 1;
+ /* 0x00 */ u8 bit1 : 1; // "has initialized continuous notes"?
+ /* 0x00 */ u8 notePropertiesNeedInit : 1;
+ /* 0x01 */ StereoData stereoData;
+ /* 0x02 */ u8 instOrWave;
+ /* 0x03 */ u8 gateTime;
+ /* 0x04 */ u8 semitone;
+ /* 0x05 */ u8 portamentoTargetNote;
+ /* 0x06 */ u8 pan; // 0..128
+ /* 0x07 */ u8 notePan;
+ /* 0x08 */ u8 surroundEffectIndex;
+ /* 0x09 */ u8 targetReverbVol;
+ union {
+ struct {
+ /* 0x0A */ u16 bit_0 : 1;
+ /* 0x0A */ u16 bit_1 : 1;
+ /* 0x0A */ u16 bit_2 : 1;
+ /* 0x0A */ u16 useVibrato : 1;
+ /* 0x0A */ u16 bit_4 : 1;
+ /* 0x0A */ u16 bit_5 : 1;
+ /* 0x0A */ u16 bit_6 : 1;
+ /* 0x0A */ u16 bit_7 : 1;
+ /* 0x0A */ u16 bit_8 : 1;
+ /* 0x0A */ u16 bit_9 : 1;
+ /* 0x0A */ u16 bit_A : 1;
+ /* 0x0A */ u16 bit_B : 1;
+ /* 0x0A */ u16 bit_C : 1;
+ /* 0x0A */ u16 bit_D : 1;
+ /* 0x0A */ u16 bit_E : 1;
+ /* 0x0A */ u16 bit_F : 1;
+ } s;
+ /* 0x0A */ u16 asByte;
+ } unk_0A;
+ /* 0x0C */ VibratoSubStruct vibrato;
+ /* 0x1A */ s16 delay;
+ /* 0x1C */ s16 gateDelay;
+ /* 0x1E */ s16 delay2;
+ /* 0x20 */ u16 portamentoTime;
+ /* 0x22 */ s16 transposition; // #semitones added to play commands
+ // (seq instruction encoding only allows referring to the limited range
+ // 0..0x3F; this makes 0x40..0x7F accessible as well)
+ /* 0x24 */ s16 shortNoteDefaultDelay;
+ /* 0x26 */ s16 lastDelay;
+ /* 0x28 */ AdsrSettings adsr;
+ /* 0x30 */ Portamento portamento;
+ /* 0x3C */ Note* note;
+ /* 0x40 */ f32 freqScale;
+ /* 0x44 */ f32 bend;
+ /* 0x48 */ f32 velocitySquare2;
+ /* 0x4C */ f32 velocitySquare; // not sure which one of those corresponds to the sm64 original
+ /* 0x50 */ f32 noteVelocity;
+ /* 0x54 */ f32 noteFreqScale;
+ /* 0x58 */ struct Instrument* instrument;
+ /* 0x5C */ struct TunedSample* tunedSample;
+ /* 0x60 */ SequenceChannel* channel;
+ /* 0x64 */ SeqScriptState scriptState;
+ /* 0x80 */ AudioListItem listItem;
+} SequenceLayer; // size = 0x90
+
+void AudioScript_SequenceChannelDisable(SequenceChannel* channel);
+void AudioScript_SequencePlayerDisableAsFinished(SequencePlayer* seqPlayer);
+void AudioScript_SequencePlayerDisable(SequencePlayer* seqPlayer);
+void AudioScript_ProcessSequences(s32 arg0);
+void AudioScript_SkipForwardSequence(SequencePlayer* seqPlayer);
+void AudioScript_ResetSequencePlayer(SequencePlayer* seqPlayer);
+void AudioScript_InitSequencePlayerChannels(s32 seqPlayerIndex);
+void AudioScript_InitSequencePlayers(void);
+
+typedef enum AudioCustomFunctions {
+ /* 0x00 */ AUDIO_CUSTOM_FUNCTION_SEQ_0,
+ /* 0x01 */ AUDIO_CUSTOM_FUNCTION_SEQ_1,
+ /* 0x02 */ AUDIO_CUSTOM_FUNCTION_SEQ_2,
+ /* 0x03 */ AUDIO_CUSTOM_FUNCTION_SEQ_3,
+ /* 0xFE */ AUDIO_CUSTOM_FUNCTION_SYNTH = 0xFE,
+ /* 0xFF */ AUDIO_CUSTOM_FUNCTION_REVERB
+} AudioCustomFunctions;
+
+typedef void (*AudioCustomUpdateFunction)(void);
+typedef u32 (*AudioCustomSeqFunction)(s8 value, SequenceChannel* channel);
+typedef void* (*AudioCustomReverbFunction)(struct Sample*, s32, s8, s32);
+typedef Acmd* (*AudioCustomSynthFunction)(Acmd*, s32, s32);
+
+extern AudioCustomUpdateFunction gAudioCustomUpdateFunction;
+extern AudioCustomSeqFunction gAudioCustomSeqFunction;
+extern AudioCustomReverbFunction gAudioCustomReverbFunction;
+extern AudioCustomSynthFunction gAudioCustomSynthFunction;
+
+#endif
diff --git a/include/audio/synthesis.h b/include/audio/synthesis.h
new file mode 100644
index 000000000..194bb7a5c
--- /dev/null
+++ b/include/audio/synthesis.h
@@ -0,0 +1,54 @@
+#ifndef AUDIO_SYNTHESIS_H
+#define AUDIO_SYNTHESIS_H
+
+#include "PR/ultratypes.h"
+#include "PR/abi.h"
+#include "unk.h"
+
+// size of a single sample point
+#define SAMPLE_SIZE sizeof(s16)
+
+// Samples are processed in groups of 16 called a "frame"
+#define SAMPLES_PER_FRAME ADPCMFSIZE
+
+// The length of one left/right channel is 13 frames
+#define DMEM_1CH_SIZE (13 * SAMPLES_PER_FRAME * SAMPLE_SIZE)
+// Both left and right channels
+#define DMEM_2CH_SIZE (2 * DMEM_1CH_SIZE)
+
+// Must be the same amount of samples as copied by aDuplicate() (audio microcode)
+#define WAVE_SAMPLE_COUNT 64
+
+typedef struct NoteSynthesisBuffers {
+ /* 0x000 */ s16 adpcmState[16];
+ /* 0x020 */ s16 finalResampleState[16];
+ /* 0x040 */ s16 filterState[32];
+ /* 0x080 */ s16 unusedState[16];
+ /* 0x0A0 */ s16 haasEffectDelayState[32];
+ /* 0x0E0 */ s16 combFilterState[128];
+ /* 0x1E0 */ s16 surroundEffectState[128];
+} NoteSynthesisBuffers; // size = 0x2E0
+
+typedef struct NoteSynthesisState {
+ /* 0x00 */ u8 atLoopPoint : 1;
+ /* 0x00 */ u8 stopLoop : 1;
+ /* 0x01 */ u8 sampleDmaIndex;
+ /* 0x02 */ u8 prevHaasEffectLeftDelaySize;
+ /* 0x03 */ u8 prevHaasEffectRightDelaySize;
+ /* 0x04 */ u8 curReverbVol;
+ /* 0x05 */ u8 numParts;
+ /* 0x06 */ u16 samplePosFrac; // Fractional part of the sample position
+ /* 0x08 */ u16 surroundEffectGain;
+ /* 0x0C */ s32 samplePosInt; // Integer part of the sample position
+ /* 0x10 */ NoteSynthesisBuffers* synthesisBuffers;
+ /* 0x14 */ s16 curVolLeft;
+ /* 0x16 */ s16 curVolRight;
+ /* 0x18 */ UNK_TYPE1 unk_18[0x6];
+ /* 0x1E */ u8 combFilterNeedsInit;
+ /* 0x1F */ u8 unk_1F;
+ /* 0x20 */ UNK_TYPE1 unk_20[0x4];
+} NoteSynthesisState; // size = 0x24
+
+Acmd* AudioSynth_Update(Acmd* abiCmdStart, s32* numAbiCmds, s16* aiBufStart, s32 numSamplesPerFrame);
+
+#endif