Audio Sequences: Scene/Ambience/SeqFlags Functions OK (#1033)

* import audio scene seq docs

* cleanup

* fix scene cmd

* small fixes

* more PR suggestions

* missed comment

* rename spot to resume

* cleanup comments

* SEQ_IO_VAL_NONE

* Empty-Commit

* another PR suggestion
This commit is contained in:
engineer124
2022-09-30 07:49:35 -04:00
committed by GitHub
parent 3a723efb15
commit 1af942ae12
50 changed files with 1445 additions and 855 deletions
+106 -104
View File
@@ -4,7 +4,7 @@
#define NA_BGM_STOP 0x100000FF
#define NA_BGM_GENERAL_SFX 0x00 // General Sound Effects
#define NA_BGM_NATURE_AMBIENCE 0x01 // Ambient background noises
#define NA_BGM_AMBIENCE 0x01 // Ambient background noises
#define NA_BGM_TERMINA_FIELD 0x02 // Termina Field
#define NA_BGM_CHASE 0x03 // Forest Chase
#define NA_BGM_MAJORAS_THEME 0x04 // Majora's Theme "STALKID"
@@ -40,7 +40,7 @@
#define NA_BGM_GET_ITEM 0x22 // Item Catch
#define NA_BGM_GATE_OPEN 0x23 // Clock Town Day 2 Duplicate of #16. In MM3D, it shares its filename with the Door of Time song from OoT
#define NA_BGM_GET_HEART 0x24 // Complete a Heart Piece
#define NA_BGM_MINI_GAME_2 0x25 // Playing Minigame
#define NA_BGM_TIMED_MINI_GAME 0x25 // Playing a timed Minigame
#define NA_BGM_GORON_RACE 0x26 // Goron Race
#define NA_BGM_MUSIC_BOX_HOUSE 0x27 // Music Box House "ORGEL_HOUSE"
#define NA_BGM_FAIRY_FOUNTAIN 0x28 // Fairy's Fountain In MM3D, it shares its filename with the Door of Time song from OoT "GODESS"
@@ -134,11 +134,12 @@
#define NA_BGM_DISABLED 0xFFFF
typedef enum {
/* 0 */ SEQ_PLAYER_BGM_MAIN,
/* 1 */ SEQ_PLAYER_FANFARE,
/* 2 */ SEQ_PLAYER_SFX,
/* 3 */ SEQ_PLAYER_BGM_SUB,
/* 4 */ SEQ_PLAYER_NATURE
/* 0 */ SEQ_PLAYER_BGM_MAIN,
/* 1 */ SEQ_PLAYER_FANFARE,
/* 2 */ SEQ_PLAYER_SFX,
/* 3 */ SEQ_PLAYER_BGM_SUB,
/* 4 */ SEQ_PLAYER_AMBIENCE,
/* 0xFF */ SEQ_PLAYER_INVALID = 0xFF
} SequencePlayerId;
typedef enum {
@@ -160,119 +161,120 @@ typedef enum {
} ChannelIOPort;
typedef enum {
/* 0x0 */ NATURE_CHANNEL_STREAM_0,
/* 0x1 */ NATURE_CHANNEL_CRITTER_0,
/* 0x2 */ NATURE_CHANNEL_CRITTER_1,
/* 0x3 */ NATURE_CHANNEL_CRITTER_2,
/* 0x4 */ NATURE_CHANNEL_CRITTER_3,
/* 0x5 */ NATURE_CHANNEL_CRITTER_4,
/* 0x6 */ NATURE_CHANNEL_CRITTER_5,
/* 0x7 */ NATURE_CHANNEL_CRITTER_6,
/* 0x8 */ NATURE_CHANNEL_CRITTER_7,
/* 0xC */ NATURE_CHANNEL_STREAM_1 = 12,
/* 0xD */ NATURE_CHANNEL_UNK,
/* 0xE */ NATURE_CHANNEL_RAIN,
/* 0xF */ NATURE_CHANNEL_LIGHTNING
} NatureChannelIdx; // playerIdx = 4
/* 0x0 */ AMBIENCE_CHANNEL_STREAM_0,
/* 0x1 */ AMBIENCE_CHANNEL_CRITTER_0,
/* 0x2 */ AMBIENCE_CHANNEL_CRITTER_1,
/* 0x3 */ AMBIENCE_CHANNEL_CRITTER_2,
/* 0x4 */ AMBIENCE_CHANNEL_CRITTER_3,
/* 0x5 */ AMBIENCE_CHANNEL_CRITTER_4,
/* 0x6 */ AMBIENCE_CHANNEL_CRITTER_5,
/* 0x7 */ AMBIENCE_CHANNEL_CRITTER_6,
/* 0x8 */ AMBIENCE_CHANNEL_CRITTER_7,
/* 0xC */ AMBIENCE_CHANNEL_STREAM_1 = 12,
/* 0xD */ AMBIENCE_CHANNEL_SOUND_MODE,
/* 0xE */ AMBIENCE_CHANNEL_RAIN,
/* 0xF */ AMBIENCE_CHANNEL_LIGHTNING
} AmbienceChannelIndex; // playerIndex = SEQ_PLAYER_AMBIENCE
typedef enum {
/* 0x00 */ NATURE_AMBIENCE_0,
/* 0x01 */ NATURE_AMBIENCE_1,
/* 0x02 */ NATURE_AMBIENCE_2,
/* 0x03 */ NATURE_AMBIENCE_3,
/* 0x04 */ NATURE_AMBIENCE_4,
/* 0x05 */ NATURE_AMBIENCE_5,
/* 0x06 */ NATURE_AMBIENCE_6,
/* 0x07 */ NATURE_AMBIENCE_7,
/* 0x08 */ NATURE_AMBIENCE_8,
/* 0x09 */ NATURE_AMBIENCE_9,
/* 0x0A */ NATURE_AMBIENCE_A,
/* 0x0B */ NATURE_AMBIENCE_B,
/* 0x0C */ NATURE_AMBIENCE_C,
/* 0x0D */ NATURE_AMBIENCE_D,
/* 0x0E */ NATURE_AMBIENCE_E,
/* 0x0F */ NATURE_AMBIENCE_F,
/* 0x10 */ NATURE_AMBIENCE_10,
/* 0x11 */ NATURE_AMBIENCE_11,
/* 0x12 */ NATURE_AMBIENCE_12,
/* 0x13 */ NATURE_AMBIENCE_13
} NatureAmbienceId; // playerIdx = 4
/* 0x00 */ AMBIENCE_ID_00,
/* 0x01 */ AMBIENCE_ID_01,
/* 0x02 */ AMBIENCE_ID_02,
/* 0x03 */ AMBIENCE_ID_03,
/* 0x04 */ AMBIENCE_ID_04,
/* 0x05 */ AMBIENCE_ID_05,
/* 0x06 */ AMBIENCE_ID_06,
/* 0x07 */ AMBIENCE_ID_07,
/* 0x08 */ AMBIENCE_ID_08,
/* 0x09 */ AMBIENCE_ID_09,
/* 0x0A */ AMBIENCE_ID_0A,
/* 0x0B */ AMBIENCE_ID_0B,
/* 0x0C */ AMBIENCE_ID_0C,
/* 0x0D */ AMBIENCE_ID_0D,
/* 0x0E */ AMBIENCE_ID_0E,
/* 0x0F */ AMBIENCE_ID_0F,
/* 0x10 */ AMBIENCE_ID_10,
/* 0x11 */ AMBIENCE_ID_11,
/* 0x12 */ AMBIENCE_ID_12,
/* 0x13 */ AMBIENCE_ID_13,
/* 0xFF */ AMBIENCE_ID_DISABLED = 0xFF
} AmbienceId; // playerIndex = SEQ_PLAYER_AMBIENCE
typedef enum {
/* 0x00 */ NATURE_STREAM_0,
/* 0x01 */ NATURE_STREAM_1,
/* 0x02 */ NATURE_STREAM_2,
/* 0x03 */ NATURE_STREAM_3
} NatureStreamId;
/* 0x00 */ AMBIENCE_STREAM_0,
/* 0x01 */ AMBIENCE_STREAM_1,
/* 0x02 */ AMBIENCE_STREAM_2,
/* 0x03 */ AMBIENCE_STREAM_3
} AmbienceStreamId;
typedef enum {
/* 0x00 */ NATURE_CRITTER_00,
/* 0x01 */ NATURE_CRITTER_01,
/* 0x02 */ NATURE_CRITTER_02,
/* 0x03 */ NATURE_CRITTER_03,
/* 0x04 */ NATURE_CRITTER_04,
/* 0x05 */ NATURE_CRITTER_05,
/* 0x06 */ NATURE_CRITTER_06,
/* 0x07 */ NATURE_CRITTER_07,
/* 0x08 */ NATURE_CRITTER_08,
/* 0x09 */ NATURE_CRITTER_09,
/* 0x0A */ NATURE_CRITTER_10,
/* 0x0B */ NATURE_CRITTER_11,
/* 0x0C */ NATURE_CRITTER_12,
/* 0x0D */ NATURE_CRITTER_13,
/* 0x0E */ NATURE_CRITTER_14,
/* 0x0F */ NATURE_CRITTER_15,
/* 0x10 */ NATURE_CRITTER_16,
/* 0x11 */ NATURE_CRITTER_17,
/* 0x12 */ NATURE_CRITTER_18,
/* 0x13 */ NATURE_CRITTER_19
} NatureAmimalId;
/* 0x00 */ AMBIENCE_CRITTER_00,
/* 0x01 */ AMBIENCE_CRITTER_01,
/* 0x02 */ AMBIENCE_CRITTER_02,
/* 0x03 */ AMBIENCE_CRITTER_03,
/* 0x04 */ AMBIENCE_CRITTER_04,
/* 0x05 */ AMBIENCE_CRITTER_05,
/* 0x06 */ AMBIENCE_CRITTER_06,
/* 0x07 */ AMBIENCE_CRITTER_07,
/* 0x08 */ AMBIENCE_CRITTER_08,
/* 0x09 */ AMBIENCE_CRITTER_09,
/* 0x0A */ AMBIENCE_CRITTER_10,
/* 0x0B */ AMBIENCE_CRITTER_11,
/* 0x0C */ AMBIENCE_CRITTER_12,
/* 0x0D */ AMBIENCE_CRITTER_13,
/* 0x0E */ AMBIENCE_CRITTER_14,
/* 0x0F */ AMBIENCE_CRITTER_15,
/* 0x10 */ AMBIENCE_CRITTER_16,
/* 0x11 */ AMBIENCE_CRITTER_17,
/* 0x12 */ AMBIENCE_CRITTER_18,
/* 0x13 */ AMBIENCE_CRITTER_19
} AmbienceCritterId;
#define NATURE_IO_CRITTER_0_TYPE(type) NATURE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_0_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_0_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_0_PORT5(reverb) NATURE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_0_TYPE(type) AMBIENCE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_0_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_0_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_0_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_0, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_1_TYPE(type) NATURE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_1_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_1_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_1_PORT5(reverb) NATURE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_1_TYPE(type) AMBIENCE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_1_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_1_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_1_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_1, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_2_TYPE(type) NATURE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_2_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_2_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_2_PORT5(reverb) NATURE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_2_TYPE(type) AMBIENCE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_2_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_2_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_2_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_2, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_3_TYPE(type) NATURE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_3_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_3_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_3_PORT5(reverb) NATURE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_3_TYPE(type) AMBIENCE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_3_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_3_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_3_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_3, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_4_TYPE(type) NATURE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_4_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_4_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_4_PORT5(reverb) NATURE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_4_TYPE(type) AMBIENCE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_4_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_4_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_4_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_4, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_5_TYPE(type) NATURE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_5_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_5_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_5_PORT5(reverb) NATURE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_5_TYPE(type) AMBIENCE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_5_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_5_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_5_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_5, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_CRITTER_6_TYPE(type) NATURE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_2, type
#define NATURE_IO_CRITTER_6_BEND_PITCH(bend) NATURE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_3, bend
#define NATURE_IO_CRITTER_6_NUM_LAYERS(num) NATURE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_4, num
#define NATURE_IO_CRITTER_6_PORT5(reverb) NATURE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_5, reverb
#define AMBIENCE_IO_CRITTER_6_TYPE(type) AMBIENCE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_CRITTER_6_BEND_PITCH(bend) AMBIENCE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_3, bend
#define AMBIENCE_IO_CRITTER_6_NUM_LAYERS(num) AMBIENCE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_4, num
#define AMBIENCE_IO_CRITTER_6_PORT5(reverb) AMBIENCE_CHANNEL_CRITTER_6, CHANNEL_IO_PORT_5, reverb
#define NATURE_IO_STREAM_0_TYPE(type) NATURE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_2, type
#define NATURE_IO_STREAM_0_PORT3(data) NATURE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_3, data
#define NATURE_IO_STREAM_0_PORT4(data) NATURE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_4, data
#define AMBIENCE_IO_STREAM_0_TYPE(type) AMBIENCE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_STREAM_0_PORT3(data) AMBIENCE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_3, data
#define AMBIENCE_IO_STREAM_0_PORT4(data) AMBIENCE_CHANNEL_STREAM_0, CHANNEL_IO_PORT_4, data
#define NATURE_IO_STREAM_1_TYPE(type) NATURE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_2, type
#define NATURE_IO_STREAM_1_PORT3(data) NATURE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_3, data
#define NATURE_IO_STREAM_1_PORT4(data) NATURE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_4, data
#define AMBIENCE_IO_STREAM_1_TYPE(type) AMBIENCE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_2, type
#define AMBIENCE_IO_STREAM_1_PORT3(data) AMBIENCE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_3, data
#define AMBIENCE_IO_STREAM_1_PORT4(data) AMBIENCE_CHANNEL_STREAM_1, CHANNEL_IO_PORT_4, data
#define NATURE_IO_RAIN_PORT4(data) NATURE_CHANNEL_RAIN, CHANNEL_IO_PORT_4, data
#define AMBIENCE_IO_RAIN_PORT4(data) AMBIENCE_CHANNEL_RAIN, CHANNEL_IO_PORT_4, data
#define NATURE_IO_ENTRIES_END 0xFF
#define AMBIENCE_IO_ENTRIES_END 0xFF
#endif