tables.c

Go to the documentation of this file.

#include "types.h"
 
//--------------------------------------------------------------------------
// Sound library tables.
//--------------------------------------------------------------------------
 
struct SoundPlayer;
struct SoundTrack;
 
typedef void (*SoundFunc)(void);
typedef void (*SoundCommand)(struct SoundPlayer *player,
                             struct SoundTrack *track);
 
void MusicTrack_FinishSequence(void);
void MusicTrack_Goto(void);
void MusicTrack_CallPattern(void);
void MusicTrack_ReturnFromPattern(void);
void MusicTrack_Repeat(void);
void MusicTrack_SetPriorityFromCommand(void);
void MusicPlayer_SetTempoFromCommand(void);
void MusicTrack_SetKeyOffsetFromCommand(void);
void MusicTrack_SetVoiceFromCommand(void);
void MusicTrack_SetVolumeFromCommand(void);
void MusicTrack_SetPanFromCommand(void);
void MusicTrack_SetBendFromCommand(void);
void MusicTrack_SetBendRangeFromCommand(void);
void MusicTrack_SetLfoSpeedFromCommand(void);
void MusicTrack_SetLfoDelayFromCommand(void);
void MusicTrack_SetModulationFromCommand(void);
void MusicTrack_SetModulationTargetFromCommand(void);
void MusicTrack_SetTuneFromCommand(void);
void MusicTrack_WriteSoundRegisterFromCommand(void);
void MusicTrack_ReleaseKey(void);
void AudioEngine_SetPcmRate(void);
void MusicTrack_Stop(void);
void MusicPlayer_StepFade(void);
void MusicTrack_CalcOutput(void);
void SoundNote_Detach(void);
void SoundDriver_ClearBuffer(void);
 
void MusicTrack_ReadVoiceTarget(struct SoundPlayer *player,
                                struct SoundTrack *track);
void MusicTrack_SetVoiceKind(struct SoundPlayer *player,
                             struct SoundTrack *track);
void MusicTrack_SetVoiceAttack(struct SoundPlayer *player,
                               struct SoundTrack *track);
void MusicTrack_SetVoiceDecay(struct SoundPlayer *player,
                              struct SoundTrack *track);
void MusicTrack_SetVoiceSustain(struct SoundPlayer *player,
                                struct SoundTrack *track);
void MusicTrack_SetVoiceRelease(struct SoundPlayer *player,
                                struct SoundTrack *track);
void MusicTrack_SetTailLevel(struct SoundPlayer *player,
                             struct SoundTrack *track);
void MusicTrack_SetTailLength(struct SoundPlayer *player,
                              struct SoundTrack *track);
void MusicTrack_SetVoiceLength(struct SoundPlayer *player,
                               struct SoundTrack *track);
void MusicTrack_SetVoicePanOrSweep(struct SoundPlayer *player,
                                   struct SoundTrack *track);
void Runtime_CallWorkEntryWithArgs();
 
/// Sequence commands copied for each player, and driver entry points.
// clang-format off
const SoundFunc gSound_CommandTableTemplate[] = {
    MusicTrack_FinishSequence,
    MusicTrack_Goto,
    MusicTrack_CallPattern,
    MusicTrack_ReturnFromPattern,
    MusicTrack_Repeat,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_SetPriorityFromCommand,
    MusicPlayer_SetTempoFromCommand,
    MusicTrack_SetKeyOffsetFromCommand,
    MusicTrack_SetVoiceFromCommand,
    MusicTrack_SetVolumeFromCommand,
    MusicTrack_SetPanFromCommand,
    MusicTrack_SetBendFromCommand,
    MusicTrack_SetBendRangeFromCommand,
    MusicTrack_SetLfoSpeedFromCommand,
    MusicTrack_SetLfoDelayFromCommand,
    MusicTrack_SetModulationFromCommand,
    MusicTrack_SetModulationTargetFromCommand,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_SetTuneFromCommand,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_FinishSequence,
    MusicTrack_WriteSoundRegisterFromCommand,
    MusicTrack_FinishSequence,
    MusicTrack_ReleaseKey,
    AudioEngine_SetPcmRate,
    MusicTrack_Stop,
    MusicPlayer_StepFade,
    MusicTrack_CalcOutput,
    SoundNote_Detach,
    SoundDriver_ClearBuffer
};
 
/// PCM pitches: the high four bits hold the octave, the low four the note.
const u8 gSound_PcmPitchCodes[] = {
    0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb,
    0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xda, 0xdb,
    0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb,
    0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb,
    0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab,
    0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b,
    0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b,
    0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b,
    0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b,
    0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b,
    0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b,
    0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b,
    0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b,
    0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b,
    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b
};
 
/// Frequencies by note at octave zero, in 32-bit fixed point.
const u32 gSound_PcmFrequencySteps[] = {
    0x80000000, 0x879c7c97, 0x8facd61e, 0x9837f052,
    0xa14517cc, 0xaadc0848, 0xb504f334, 0xbfc886bb,
    0xcb2ff52a, 0xd744fccb, 0xe411f03a, 0xf1a1bf39
};
 
/// Samples per frame for each playback frequency setting.
const u16 gSound_FrameLengths[] = {
    96, 132, 176, 224, 264, 304, 352, 448, 528, 608, 672, 704
};
 
/// CGB channel pitches.
const u8 gSound_CgbPitchCodes[] = {
    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b,
    0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b,
    0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b,
    0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b,
    0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b,
    0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b,
    0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b,
    0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b,
    0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b,
    0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b,
    0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab
};
 
/// Frequencies by note for CGB channels.
const s16 gSound_CgbFrequencySteps[] = {
    -2004, -1891, -1785, -1685, -1591, -1501, -1417, -1337, -1262, -1192, -1125, -1062
};
 
/// Noise channel pitches.
const u8 gSound_NoisePitchCodes[] = {
    0xd7, 0xd6, 0xd5, 0xd4, 0xc7, 0xc6, 0xc5, 0xc4, 0xb7, 0xb6, 0xb5, 0xb4,
    0xa7, 0xa6, 0xa5, 0xa4, 0x97, 0x96, 0x95, 0x94, 0x87, 0x86, 0x85, 0x84,
    0x77, 0x76, 0x75, 0x74, 0x67, 0x66, 0x65, 0x64, 0x57, 0x56, 0x55, 0x54,
    0x47, 0x46, 0x45, 0x44, 0x37, 0x36, 0x35, 0x34, 0x27, 0x26, 0x25, 0x24,
    0x17, 0x16, 0x15, 0x14, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00
};
 
/// CGB channel 3 waveform volumes.
const u8 gSound_Cgb3LevelCodes[] = {
    0x00, 0x00, 0x60, 0x60, 0x60, 0x60, 0x40, 0x40, 0x40, 0x40, 0x80, 0x80, 0x80, 0x80, 0x20, 0x20
};
 
/// Note durations in clock ticks.
const u8 gSound_ClockLengths[] = {
    0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15,
    16, 17, 18, 19, 20, 21, 22, 23, 24, 28, 30, 32, 36, 40, 42, 44,
    48, 52, 54, 56, 60, 64, 66, 68, 72, 76, 78, 80, 84, 88, 90, 92,
    96
};
 
/// Extended commands; entries zero and three do nothing.
const SoundCommand gSound_ExtendedCommandTable[] = {
    (SoundCommand)Runtime_CallWorkEntryWithArgs,
    MusicTrack_ReadVoiceTarget,
    MusicTrack_SetVoiceKind,
    (SoundCommand)Runtime_CallWorkEntryWithArgs,
    MusicTrack_SetVoiceAttack,
    MusicTrack_SetVoiceDecay,
    MusicTrack_SetVoiceSustain,
    MusicTrack_SetVoiceRelease,
    MusicTrack_SetTailLevel,
    MusicTrack_SetTailLength,
    MusicTrack_SetVoiceLength,
    MusicTrack_SetVoicePanOrSweep
};
// clang-format on