coastline 0.0.4
Loading...
Searching...
No Matches
SdlMusicState Struct Reference

XM playback storage and game volumes for one SDL audio context. More...

#include <audio.h>

Collaboration diagram for SdlMusicState:

Public Attributes

s32 channelCount
u8 bgmVolume
u8 sfxVolume
u8 sfxMasterVolume
f32 noteFrequencies [MUSIC_NOTES]
s32 patternRow
s8 silence [SILENCE_SAMPLE_BYTES]
s16 ring [AUDIO_RING_BYTES/sizeof(s16)]
XmSample * instruments [128]
u8 * patterns [256]
MusicChannel channels [MIXER_CHANNELS]
SoundEffectSample samples [SOUND_EFFECT_CHANNELS]
s32 playbackEnabled
MusicPlayer player
u64 frequencySteps [MUSIC_OCTAVES][MUSIC_NOTES]
u8 moduleWork [0x100000]
 Writable module decoding workspace, valid for this context.

Detailed Description

XM playback storage and game volumes for one SDL audio context.

Member Data Documentation

◆ channelCount

s32 SdlMusicState::channelCount

The number of active music mixer channels, at most MIXER_CHANNELS.

◆ bgmVolume

u8 SdlMusicState::bgmVolume

The BGM volume applied to module playback, with zero disabling processing.

◆ sfxVolume

u8 SdlMusicState::sfxVolume

The transient effects level applied beneath the master volume.

◆ sfxMasterVolume

u8 SdlMusicState::sfxMasterVolume

The effects master volume, with zero disabling effects processing.

◆ noteFrequencies

f32 SdlMusicState::noteFrequencies[MUSIC_NOTES]

Base note frequencies used to build the pitch table.

◆ patternRow

s32 SdlMusicState::patternRow

The current row within the active music pattern.

◆ silence

s8 SdlMusicState::silence[SILENCE_SAMPLE_BYTES]

Zero-valued sample storage for inactive channels.

◆ ring

s16 SdlMusicState::ring[AUDIO_RING_BYTES/sizeof(s16)]

The interleaved stereo PCM ring buffer.

◆ instruments

XmSample* SdlMusicState::instruments[128]

Decoded instrument headers and samples in moduleWork.

◆ patterns

u8* SdlMusicState::patterns[256]

Pattern headers and packed rows in moduleWork.

◆ channels

MusicChannel SdlMusicState::channels[MIXER_CHANNELS]

Per-channel XM note and effect playback state.

◆ samples

SoundEffectSample SdlMusicState::samples[SOUND_EFFECT_CHANNELS]

Loaded effect sample descriptors.

◆ playbackEnabled

s32 SdlMusicState::playbackEnabled

Whether the XM player advances music playback.

◆ player

MusicPlayer SdlMusicState::player

The current XM order, row timing, and pattern playback state.

◆ frequencySteps

u64 SdlMusicState::frequencySteps[MUSIC_OCTAVES][MUSIC_NOTES]

32.32 sample-position increments.

◆ moduleWork

u8 SdlMusicState::moduleWork[0x100000]

Writable module decoding workspace, valid for this context.


The documentation for this struct was generated from the following file: