acdream/src/AcDream.UI.Abstractions/Panels/Settings/AudioSettings.cs
Erik dd2cb92b99 chore(audio): Campaign A slice A6 — delete what retail does not have
Retail EoR has no music system: the linked winmm MIDI player has zero
callers, 'music' appears zero times in the 65 MB decomp, SoundType has no
music member, InitPrefs registers no music key, and the install ships no
music files. So PlayMusic/StopMusic/MusicVolume and the AudioSettings
Music knob are deleted rather than left as an API modelling dead code —
the string-keyed signature was the tell, since every other entry point is
DID-keyed. Old settings.json files carrying a 'music' key still load; the
reader ignores unknown keys and the next save drops it.

The Ambient slider is now surfaced, because slice A5 gave it something to
drive, and its default returns to retail's 1.0 from an invented 0.8 —
InitPrefs defaults every sound preference to unity. The panel rule is
unchanged: no slider that does nothing.

r05-audio-sound.md gets a SUPERSEDED banner naming its five wrong
sections (falloff, pan, voice pool, selection, music, ambient) so a
future reader reaches the lane notes instead of the Ghidra-era reads that
this campaign spent its first two slices undoing.

TS-9 re-scoped from 'any MP3 cue' to the measured blast radius: exactly 1
MP3 among 786 shipped waves, a ~2 s mono clip. Its original framing
assumed a music system that does not exist. The ADPCM count remains
unmeasured and is named as the open question.

Deferred deliberately: #321's sound-cache decode-dedup race. It is a
pre-existing concurrency flake rather than audio-parity behaviour, and
shipping a speculative fix to a race I have not reproduced is exactly the
shortcut this project's no-workarounds rule exists to prevent.

Campaign A is code-complete; the plan carries the closeout.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-08 22:58:50 +02:00

36 lines
1.3 KiB
C#

namespace AcDream.UI.Abstractions.Panels.Settings;
/// <summary>
/// Audio mixer preferences persisted to <c>settings.json</c>. The host wires
/// these into <c>OpenAlAudioEngine.MasterVolume</c> / <c>SfxVolume</c> /
/// <c>AmbientVolume</c> on Save and on startup.
///
/// <para>
/// A <c>Music</c> field lived here until 2026-08-08 (Campaign A slice A6).
/// Retail has no music system to turn down — see the note on
/// <c>IAudioEngine</c> — so the knob moved nothing. Old <c>settings.json</c>
/// files carrying a <c>"music"</c> key still load: the reader simply ignores
/// keys it does not know, and the next save drops it.
/// </para>
///
/// <para>
/// Defaults match the engine's hard-coded starting values so a user
/// who never opens the Audio tab gets identical behaviour to the
/// previous env-var-only world.
/// </para>
/// </summary>
public sealed record AudioSettings(
float Master,
float Sfx,
float Ambient)
{
/// <summary>
/// Values used on first launch. Retail's own defaults are 1.0 for every
/// sound preference (<c>SoundManager::InitPrefs</c> @ <c>0x005503F0</c>),
/// so ambient starts at unity rather than the invented 0.8.
/// </summary>
public static AudioSettings Default { get; } = new(
Master: 1.0f,
Sfx: 1.0f,
Ambient: 1.0f);
}