diff --git a/src/Pixely.Audio/AudioSource.cs b/src/Pixely.Audio/AudioSource.cs index f73bc1d7..ab34045f 100644 --- a/src/Pixely.Audio/AudioSource.cs +++ b/src/Pixely.Audio/AudioSource.cs @@ -10,7 +10,7 @@ public sealed class AudioSource : IDisposable internal Pointer Pointer { get; set; } private AudioClip? _clip; private AudioGroup? _group; - private Vector3 _position; + private Vector3? _position; private float _gain = 1.0f; private bool _looping; @@ -106,7 +106,9 @@ public bool Looping } } - public Vector3 Position + // Null plays the clip unspatialized, with its own channels. SDL_mixer spatializes a track with any position, Vector3.Zero + // included, and then mixes it down to mono. + public Vector3? Position { get { diff --git a/src/Pixely.Audio/AudioSystem.cs b/src/Pixely.Audio/AudioSystem.cs index e207edf4..f515c74b 100644 --- a/src/Pixely.Audio/AudioSystem.cs +++ b/src/Pixely.Audio/AudioSystem.cs @@ -155,7 +155,10 @@ internal void UpdateSourcePositions() { foreach (AudioSource source in _sources.Copy()) { - source.ApplyPosition(); + if (source.Position is not null) + { + source.ApplyPosition(); + } } } @@ -236,8 +239,8 @@ internal static void ThrowIfNegative(float value, string parameterName) // -1 loops forever, 0 plays once. internal abstract void SetTrackLoopsCore(Pointer track, int loopCount); - // Relative to the listener. - internal abstract void SetTrack3DPositionCore(Pointer track, Vector3 position); + // Relative to the listener. Null turns spatialization off. + internal abstract void SetTrack3DPositionCore(Pointer track, Vector3? position); internal abstract void TagTrackCore(Pointer track, string tag); diff --git a/src/Pixely.Audio/Pixely.Audio.csproj b/src/Pixely.Audio/Pixely.Audio.csproj index 32f59fd4..0e75209d 100644 --- a/src/Pixely.Audio/Pixely.Audio.csproj +++ b/src/Pixely.Audio/Pixely.Audio.csproj @@ -10,6 +10,7 @@ + diff --git a/src/Pixely.Audio/SdlAudioSystem.cs b/src/Pixely.Audio/SdlAudioSystem.cs index 255c5022..0dd09874 100644 --- a/src/Pixely.Audio/SdlAudioSystem.cs +++ b/src/Pixely.Audio/SdlAudioSystem.cs @@ -139,13 +139,19 @@ internal override void SetTrackLoopsCore(Pointer track, int loopCount SdlError.ThrowOnFalse(MIX_SetTrackLoops(track, loopCount), nameof(MIX_SetTrackLoops)); } - internal override void SetTrack3DPositionCore(Pointer track, Vector3 position) + internal override void SetTrack3DPositionCore(Pointer track, Vector3? position) { + if (position is not Vector3 value) + { + SdlError.ThrowOnFalse(MIX_SetTrack3DPosition(track, null), nameof(MIX_SetTrack3DPosition)); + return; + } + MIX_Point3D point = new() { - x = position.X, - y = position.Y, - z = position.Z + x = value.X, + y = value.Y, + z = value.Z }; SdlError.ThrowOnFalse(MIX_SetTrack3DPosition(track, &point), nameof(MIX_SetTrack3DPosition)); diff --git a/src/Pixely.Testing/StubAudioSystem.cs b/src/Pixely.Testing/StubAudioSystem.cs index 118049e9..ada0f70a 100644 --- a/src/Pixely.Testing/StubAudioSystem.cs +++ b/src/Pixely.Testing/StubAudioSystem.cs @@ -133,7 +133,7 @@ internal override void SetTrackLoopsCore(Pointer track, int loopCount { } - internal override void SetTrack3DPositionCore(Pointer track, Vector3 position) + internal override void SetTrack3DPositionCore(Pointer track, Vector3? position) { } diff --git a/tests/Pixely.Tests/AudioSystemTests.cs b/tests/Pixely.Tests/AudioSystemTests.cs index 54ccebba..3779b498 100644 --- a/tests/Pixely.Tests/AudioSystemTests.cs +++ b/tests/Pixely.Tests/AudioSystemTests.cs @@ -1,9 +1,11 @@ using System.Collections.Frozen; using System.Collections.Immutable; +using System.Numerics; using System.Runtime.InteropServices; using Pixely.App; using Pixely.Audio; using Pixely.Content; +using XdlSharp; using static XdlSharp.Xdl; namespace Pixely.Tests; @@ -89,6 +91,34 @@ public void Play_WithoutAClip_Throws() Assert.That(source.Play, Throws.InvalidOperationException); } + [Test] + public void Position_ByDefault_IsNullAndLeavesTheTrackUnspatialized() + { + AudioSource source = CreateSourceWithBuffer(); + _audioSystem.Listener.Position = new Vector3(4, 0, 0); + + source.Play(); + + Assert.That((source.Position, GetTrackPosition(source)), Is.EqualTo(((Vector3?)null, Vector3.Zero))); + } + + [Test] + public void Position_SetWhilePlaying_SpatializesRelativeToTheListener_AndNullUndoesIt() + { + AudioSource source = CreateSourceWithBuffer(); + _audioSystem.Listener.Position = new Vector3(4, 0, 0); + source.Play(); + + source.Position = new Vector3(1, 2, 3); + Vector3 positioned = GetTrackPosition(source); + _audioSystem.Listener.Position = new Vector3(0, 0, 1); + Vector3 listenerMoved = GetTrackPosition(source); + source.Position = null; + Vector3 cleared = GetTrackPosition(source); + + Assert.That((positioned, listenerMoved, cleared, source.Position), Is.EqualTo((new Vector3(-3, 2, 3), new Vector3(1, 2, 2), Vector3.Zero, (Vector3?)null))); + } + [Test] public void Gains_KeepTheirValues_AndRefuseNegativeOnes() { @@ -287,6 +317,14 @@ public void Dispose_OfTheAudioSystem_ReleasesEverything() }); } + // SDL_mixer reports the origin for an unspatialized track. + private static unsafe Vector3 GetTrackPosition(AudioSource source) + { + MIX_Point3D point; + Assert.That(MIX_GetTrack3DPosition(source.Pointer, &point), Is.True); + return new Vector3(point.x, point.y, point.z); + } + private AudioSource CreateSourceWithBuffer() { AudioSource source = _audioSystem.CreateSource();