izzy/2ship2harkinian-Android
0
0
Fork 0
mirror of https://github.com/izzy2lost/2ship2harkinian-Android.git synced 2026-06-19 01:20:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Audio sequence.c OK and documented (#1201)

Browse Source 
* import sequence docs

* cleanup

* do not need raw hex
This commit is contained in:
engineer124
2023-03-30 19:53:47 +11:00
committed by GitHub
parent 045c3537a9
commit 6685a4775e
52 changed files with 1888 additions and 404 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/functions.h
+25 -34
View File
@@ -2812,7 +2812,6 @@ void AudioOcarina_TerminaWallGenerateNotes(void);
void AudioOcarina_PlayLongScarecrowAfterCredits(void);
void Audio_Update(void);
// void func_8019E110(void);
void AudioSfx_SetProperties(u8 bankId, u8 entryIndex, u8 channelIndex);
void play_sound(u16 sfxId);
void func_8019F128(u16 sfxId);
@@ -2846,10 +2845,10 @@ void Audio_PlaySfxForRiver(Vec3f* pos, f32 freqScale);
// void Audio_PlaySfxForWaterfall(void);
// void Audio_StepFreqLerp(void);
void func_801A0124(Vec3f* pos, u8 arg1);
void func_801A0184(void);
void func_801A01C4(void);
void Audio_SetBgmVolumeOff(void);
void Audio_SetBgmVolumeOn(void);
void func_801A0204(s8 seqId);
void func_801A0238(s32 arg0, s32 arg1);
void Audio_SetMainBgmVolume(u8 targetVolume, u8 volumeFadeTimer);
// void Audio_SetGanonsTowerBgmVolumeLevel(void);
// void Audio_SetGanonsTowerBgmVolume(void);
// void Audio_UpdateRiverSoundVolumes(void);
@@ -2879,12 +2878,9 @@ void func_801A1FB4(u8 playerIndex, Vec3f* pos, u16 seqId, f32 maxDist);
void func_801A246C(u8 param_1, u8 param_2);
void Audio_PlayMorningSceneSequence(u16 seqId, u8 dayMinusOne);
void Audio_PlaySceneSequence(u16 seqId, u8 dayMinusOne);
// void func_801A27E8(void);
// void func_801A281C(void);
void func_801A29D4(UNK_TYPE arg0, f32 arg1, UNK_TYPE arg2);
void func_801A2BB8(s32 seqId);
void func_801A2C20(void);
// void func_801A2C44(void);
void Audio_SetSeqTempoAndFreq(u8 seqPlayerIndex, f32 freqTempoScale, u8 duration);
void Audio_PlaySubBgm(u16 seqId);
void Audio_StopSubBgm(void);
void Audio_PlaySequenceInCutscene(u16 seqId);
void Audio_StopSequenceInCutscene(u16 seqId);
s32 Audio_IsSequencePlaying(u8 seqId);
@@ -2895,7 +2891,7 @@ void Audio_RestorePrevBgm(void);
void Audio_PlayFanfare(u16 seqId);
// void func_801A312C(void);
void func_801A31EC(u16 seqId, s8 arg1, u8 arg2);
void Audio_PlaySequenceWithSeqPlayerIO(s8 playerIndex, u16 seqId, u8 fadeInDuration, s8 ioPort, u8 ioData);
void Audio_PlaySequenceWithSeqPlayerIO(s8 seqPlayerIndex, u16 seqId, u8 fadeInDuration, s8 ioPort, u8 ioData);
void Audio_SetSequenceMode(u8 seqMode);
void Audio_UpdateEnemyBgmVolume(f32 dist);
u8 func_801A3950(s32 playerIndex, s32 isChannelIOSet);
@@ -2925,23 +2921,20 @@ void func_801A41F8(UNK_TYPE arg0);
void Audio_SetSfxVolumeExceptSystemAndOcarinaBanks(u8 arg0);
void func_801A4428(u8 reverbIndex);
void Audio_PreNMI(void);
// void Audio_ResetRequestedSceneSeqId(void);
// void func_801A44D4(void);
s32 func_801A46F8(void);
void func_801A4748(Vec3f* pos, u16 sfxId);
void func_801A479C(Vec3f* arg0, u16 sfxId, s32 arg2);
void Audio_SetAmbienceChannelIO(u8 channelIndexRange, u8 ioPort, u8 ioData);
void Audio_PlayAmbience(u8 ambienceId);
void Audio_Init(void);
void func_801A4D00(void);
// void func_801A4D50(void);
// void func_801A4DA4(void);
// void func_801A4DF4(void);
// void func_801A4E64(void);
void Audio_InitSound(void);
void Audio_ResetForAudioHeapStep3(void);
void Audio_ResetForAudioHeapStep2(void);
void Audio_ResetForAudioHeapStep1(s32 specId);
// void func_801A4EB0(void);
// void func_801A4EB8(void);
// void func_801A4FD8(void);
void func_801A4FD8(void);
void func_801A5080(u16 arg0);
u16 func_801A5100(void);
void func_801A5118(void);
@@ -2955,7 +2948,7 @@ UNK_TYPE func_801A51F0(UNK_TYPE arg0);
// void func_801A54D0(void);
// void func_801A5680(void);
// void func_801A5808(void);
// void func_801A5A10(void);
void AudioVoice_ResetData(void);
// void func_801A5A1C(void);
void AudioSfx_MuteBanks(u16 muteMask);
@@ -2974,20 +2967,18 @@ void AudioSfx_ProcessActiveSfx(void);
u8 AudioSfx_IsPlaying(u32 sfxId);
void AudioSfx_Reset(void);
void Audio_StartSequence(u8 playerIndex, u8 seqId, u8 seqArgs, u16 fadeTimer);
void Audio_StopSequence(u8 playerIndex, u16 fadeTimer);
// void func_801A7D84(void);
void Audio_QueueSeqCmd(u32 cmd);
void func_801A89D0(void);
u16 Audio_GetActiveSequence(u8 playerIndex);
s32 func_801A8ABC(u32 cmdVal, u32 cmdMask);
void Audio_SetVolumeScale(u8 playerIndex, u8 scaleIndex, u8 targetVol, u8 volFadeTimer);
void func_801A8D5C(void);
// void func_801A8E90(void);
u8 func_801A9768(void);
u8 func_801A982C(void);
// void func_801A99B8(void);
// void func_801A9A74(void);
void AudioSeq_StartSequence(u8 seqPlayerIndex, u8 seqId, u8 seqArgs, u16 fadeInDuration);
void AudioSeq_StopSequence(u8 seqPlayerIndex, u16 fadeOutDuration);
void AudioSeq_QueueSeqCmd(u32 cmd);
void AudioSeq_ProcessSeqCmds(void);
u16 AudioSeq_GetActiveSeqId(u8 seqPlayerIndex);
s32 AudioSeq_IsSeqCmdNotQueued(u32 cmdVal, u32 cmdMask);
void AudioSeq_SetVolumeScale(u8 seqPlayerIndex, u8 scaleIndex, u8 targetVol, u8 volFadeTimer);
void AudioSeq_UpdateActiveSequences(void);
u8 AudioSeq_UpdateAudioHeapReset(void);
u8 AudioSeq_ResetReverb(void);
void AudioSeq_ResetActiveSequences(void);
void AudioSeq_ResetActiveSequencesAndVolume(void);
void Regs_InitData(PlayState* play);
include/seqcmd.h
+521
View File
File diff suppressed because it is too large Load Diff
include/sequence.h
+13 -4
View File
@@ -1,8 +1,6 @@
#ifndef SEQUENCE_H
#define SEQUENCE_H
#define NA_BGM_STOP 0x100000FF
#define NA_BGM_GENERAL_SFX 0x00 // General Sound Effects
#define NA_BGM_AMBIENCE 0x01 // Ambient background noises
#define NA_BGM_TERMINA_FIELD 0x02 // Termina Field
@@ -133,12 +131,15 @@
#define NA_BGM_END_CREDITS_2 0x82 // The End/Credits II "STAFFROLL2"
#define NA_BGM_DISABLED 0xFFFF
#define SEQ_FLAG_ASYNC 0x8000
typedef enum {
/* 0 */ SEQ_PLAYER_BGM_MAIN,
/* 1 */ SEQ_PLAYER_FANFARE,
/* 2 */ SEQ_PLAYER_SFX,
/* 3 */ SEQ_PLAYER_BGM_SUB,
/* 4 */ SEQ_PLAYER_AMBIENCE,
/* 5 */ SEQ_PLAYER_MAX,
/* 0xFF */ SEQ_PLAYER_INVALID = 0xFF
} SequencePlayerId;
@@ -160,6 +161,14 @@ typedef enum {
/* 0x7 */ CHANNEL_IO_PORT_7
} ChannelIOPort;
typedef enum {
/* 0 */ VOL_SCALE_INDEX_BGM_MAIN,
/* 1 */ VOL_SCALE_INDEX_FANFARE,
/* 2 */ VOL_SCALE_INDEX_SFX,
/* 3 */ VOL_SCALE_INDEX_BGM_SUB,
/* 4 */ VOL_SCALE_INDEX_MAX
} VolumeScaleIndex; // May be worth using SequencePlayerId instead
typedef enum {
/* 0x0 */ AMBIENCE_CHANNEL_STREAM_0,
/* 0x1 */ AMBIENCE_CHANNEL_CRITTER_0,
@@ -174,7 +183,7 @@ typedef enum {
/* 0xD */ AMBIENCE_CHANNEL_SOUND_MODE,
/* 0xE */ AMBIENCE_CHANNEL_RAIN,
/* 0xF */ AMBIENCE_CHANNEL_LIGHTNING
} AmbienceChannelIndex; // playerIndex = SEQ_PLAYER_AMBIENCE
} AmbienceChannelIndex; // seqPlayerIndex = SEQ_PLAYER_AMBIENCE
typedef enum {
/* 0x00 */ AMBIENCE_ID_00,
@@ -198,7 +207,7 @@ typedef enum {
/* 0x12 */ AMBIENCE_ID_12,
/* 0x13 */ AMBIENCE_ID_13,
/* 0xFF */ AMBIENCE_ID_DISABLED = 0xFF
} AmbienceId; // playerIndex = SEQ_PLAYER_AMBIENCE
} AmbienceId; // seqPlayerIndex = SEQ_PLAYER_AMBIENCE
typedef enum {
/* 0x00 */ AMBIENCE_STREAM_0,
include/variables.h
+8 -37
View File
@@ -995,14 +995,9 @@ extern u8 gSfxChannelLayout;
extern Vec3f gSfxDefaultPos;
extern f32 gSfxDefaultFreqAndVolScale;
extern s8 gSfxDefaultReverb;
// extern UNK_TYPE1 D_801DB4C0;
// extern UNK_TYPE1 D_801DB4C4;
// extern UNK_TYPE1 D_801DB4C8;
// extern UNK_TYPE1 D_801DB4CC;
extern u8 gAudioSpecId;
// extern UNK_TYPE1 D_801DB4D8;
// extern UNK_TYPE4 D_801DB4DC;
extern ReverbSettings* gReverbSettingsTable[];
extern u8 gAudioHeapResetState;
extern ReverbSettings* gReverbSettingsTable[10];
extern AudioSpec gAudioSpecs[21];
// rodata
@@ -2669,38 +2664,14 @@ extern s32 D_801FD120;
// extern UNK_TYPE1 D_801FD5E8;
// extern UNK_TYPE1 D_801FD608;
// extern UNK_TYPE1 D_801FD610;
// extern UNK_TYPE1 sSfxPlayerBank;
// extern UNK_TYPE1 sSfxItemBank;
// extern UNK_TYPE1 sSfxEnvironmentBank;
// extern UNK_TYPE1 sSfxEnemyBank;
// extern UNK_TYPE1 sSfxSystemBank;
// extern UNK_TYPE1 sSfxOcarinaBank;
// extern UNK_TYPE1 sSfxVoiceBank;
// extern SfxRequest sSfxRequests[0x100];
// extern UNK_TYPE1 sSfxBankListEnd;
// extern UNK_TYPE1 sSfxBankFreeListStart;
// extern UNK_TYPE1 sSfxBankUnused;
extern ActiveSfx gActiveSfx[7][3];
// extern UNK_TYPE1 sCurSfxPlayerChannelIndex;
// extern UNK_TYPE1 gSfxBankMuted;
// extern UNK_TYPE1 sUnusedBankLerp;
// extern UNK_TYPE1 D_801FFD00;
// extern UNK_TYPE1 D_801FFD34;
// extern UNK_TYPE1 D_801FFD40;
// extern UNK_TYPE1 D_80200000;
// extern UNK_TYPE1 D_80200002;
// extern UNK_TYPE1 D_80200004;
// extern UNK_TYPE1 D_80200008;
// extern UNK_TYPE1 D_8020001E;
// extern UNK_TYPE1 D_802000C9;
// extern UNK_TYPE1 D_802000D4;
extern SeqRequest sSeqRequests[][5];
extern u8 sNumSeqRequests[5];
extern u32 sAudioSeqCmds[0xB0];
extern ActiveSequence gActiveSeqs[];
// extern UNK_TYPE1 D_8020034A;
// extern UNK_TYPE1 D_80200B88;
// extern UNK_TYPE1 D_80200BBA;
// extern UNK_TYPE1 D_80200BCC;
// extern UNK_TYPE1 D_80200BCE;
// extern UNK_TYPE1 D_80200BD0;
extern u8 sResetAudioHeapTimer;
extern u16 sResetAudioHeapFadeReverbVolume;
extern u16 sResetAudioHeapFadeReverbVolumeStep;
extern AudioContext gAudioCtx; // at 0x80200C70
extern AudioCustomUpdateFunction gAudioCustomUpdateFunction;
extern AudioCustomSeqFunction gAudioCustomSeqFunction;
include/z64.h
+1
View File
@@ -20,6 +20,7 @@
#include "color.h"
#include "ichain.h"
#include "sequence.h"
#include "seqcmd.h"
#include "sfx.h"
#include "message_data_static.h"
include/z64audio.h
+40 -34
View File
@@ -11,6 +11,12 @@
#define SEQ_NUM_CHANNELS 16
#define SEQ_IO_VAL_NONE -1
typedef enum {
/* 0 */ AUDIO_HEAP_RESET_STATE_NONE,
/* 1 */ AUDIO_HEAP_RESET_STATE_RESETTING,
/* 2 */ AUDIO_HEAP_RESET_STATE_RESETTING_ALT // Never set to
} AudioHeapResetState;
typedef enum {
/* 0x00 */ AUDIO_CUSTOM_FUNCTION_SEQ_0,
/* 0x01 */ AUDIO_CUSTOM_FUNCTION_SEQ_1,
@@ -1090,50 +1096,50 @@ typedef struct {
} AudioHeapInitSizes; // size = 0xC
typedef struct {
/* 0x00 */ f32 unk_00;
/* 0x04 */ f32 unk_04;
/* 0x08 */ f32 unk_08;
/* 0x0C */ f32 unk_10;
/* 0x10 */ f32 unk_14;
/* 0x14 */ f32 unk_18;
/* 0x18 */ u16 unk_0C;
/* 0x1A */ u16 unk_1C;
} unk_50_s; // size = 0x1C
/* 0x00 */ f32 volCur;
/* 0x04 */ f32 volTarget;
/* 0x08 */ f32 volStep;
/* 0x0C */ f32 freqScaleCur;
/* 0x10 */ f32 freqScaleTarget;
/* 0x14 */ f32 freqScaleStep;
/* 0x18 */ u16 volTimer;
/* 0x1A */ u16 freqScaleTimer;
} ActiveSequenceChannelData; // size = 0x1C
typedef struct {
/* 0x000 */ unk_50_s unk_50[0x10];
/* 0x000 */ ActiveSequenceChannelData channelData[SEQ_NUM_CHANNELS];
/* 0x1C0 */ f32 volCur;
/* 0x1C4 */ f32 volTarget;
/* 0x1C8 */ f32 unk_08;
/* 0x1CC */ u32 unk_14;
/* 0x1D0 */ f32 unk_1C;
/* 0x1D4 */ f32 unk_20;
/* 0x1D8 */ f32 unk_24;
/* 0x1DC */ u32 unk_2C[8];
/* 0x1FC */ u32 unk_25C;
/* 0x200 */ u16 unk_0C;
/* 0x202 */ u16 unk_18;
/* 0x204 */ u16 unk_28;
/* 0x206 */ u16 unk_250;
/* 0x208 */ u16 unk_252;
/* 0x1C8 */ f32 volStep;
/* 0x1CC */ u32 tempoCmd;
/* 0x1D0 */ f32 tempoCur;
/* 0x1D4 */ f32 tempoTarget;
/* 0x1D8 */ f32 tempoStep;
/* 0x1DC */ u32 setupCmd[8]; // setup commands
/* 0x1FC */ u32 startAsyncSeqCmd; // temporarily stores the seqCmd used in SEQCMD_PLAY_SEQUENCE, to be called again once the font is reloaded in
/* 0x200 */ u16 volTimer;
/* 0x202 */ u16 tempoOriginal;
/* 0x204 */ u16 tempoTimer;
/* 0x206 */ u16 freqScaleChannelFlags;
/* 0x208 */ u16 volChannelFlags;
/* 0x20A */ u16 seqId;
/* 0x20C */ u16 unk_256;
/* 0x20E */ u16 unk_258;
/* 0x210 */ u8 unk_260;
/* 0x211 */ u8 unk_261[0x1];
/* 0x212 */ u8 volScales[0x4];
/* 0x20C */ u16 prevSeqId; // last seqId played on a player
/* 0x20E */ u16 channelPortMask;
/* 0x210 */ u8 isWaitingForFonts;
/* 0x211 */ u8 fontId;
/* 0x212 */ u8 volScales[VOL_SCALE_INDEX_MAX];
/* 0x216 */ u8 volFadeTimer;
/* 0x217 */ u8 fadeVolUpdate;
/* 0x218 */ u8 unk_4C;
/* 0x219 */ u8 unk_4D;
/* 0x21A */ u8 unk_4E;
/* 0x21B */ u8 unk_21B;
/* 0x218 */ u8 setupCmdTimer;
/* 0x219 */ u8 setupCmdNum; // number of setup commands
/* 0x21A */ u8 setupFadeTimer;
/* 0x21B */ u8 isSeqPlayerInit;
} ActiveSequence; // size = 0x21C
typedef struct {
/* 0x0 */ u8 unk_0;
/* 0x1 */ u8 unk_1; // importance?
} Struct_8016E320; // size = 0x02
/* 0x0 */ u8 seqId;
/* 0x1 */ u8 priority;
} SeqRequest; // size = 0x02
typedef enum {
/* 0 */ BANK_PLAYER,