tbd-station-14/Content.Client/Audio/AmbientSoundSystem.cs

using System.Collections.Generic;
using System.Linq;
using Content.Shared.Audio;
using Content.Shared.CCVar;
using Robust.Client.Player;
using Robust.Shared.Audio;
using Robust.Shared.Configuration;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Player;
using Robust.Shared.Random;
using Robust.Shared.Timing;
using Robust.Shared.Utility;

namespace Content.Client.Audio
{
    //TODO: This is using a incomplete version of the whole "only play nearest sounds" algo, that breaks down a bit should the ambient sound cap get hit.
    //TODO: This'll be fixed when GetEntitiesInRange produces consistent outputs.

    /// <summary>
    /// Samples nearby <see cref="AmbientSoundComponent"/> and plays audio.
    /// </summary>
    public sealed class AmbientSoundSystem : SharedAmbientSoundSystem
    {
        [Dependency] private EntityLookupSystem _lookup = default!;
        [Dependency] private readonly IGameTiming _gameTiming = default!;
        [Dependency] private readonly IPlayerManager _playerManager = default!;
        [Dependency] private readonly IRobustRandom _random = default!;

        private int _maxAmbientCount;

        private float _maxAmbientRange;
        private float _cooldown;
        private float _accumulator;

        /// <summary>
        /// How many times we can be playing 1 particular sound at once.
        /// </summary>
        private int _maxSingleSound = 8;

        private Dictionary<AmbientSoundComponent, (IPlayingAudioStream? Stream, string Sound)> _playingSounds = new();

        private const float RangeBuffer = 3f;

        public override void Initialize()
        {
            base.Initialize();
            UpdatesOutsidePrediction = true;
            var configManager = IoCManager.Resolve<IConfigurationManager>();
            configManager.OnValueChanged(CCVars.AmbientCooldown, SetCooldown, true);
            configManager.OnValueChanged(CCVars.MaxAmbientSources, SetAmbientCount, true);
            configManager.OnValueChanged(CCVars.AmbientRange, SetAmbientRange, true);

            SubscribeLocalEvent<AmbientSoundComponent, ComponentShutdown>(OnShutdown);
        }

        private void OnShutdown(EntityUid uid, AmbientSoundComponent component, ComponentShutdown args)
        {
            if (_playingSounds.Remove(component, out var sound))
                sound.Stream?.Stop();
        }

        private void SetCooldown(float value) => _cooldown = value;
        private void SetAmbientCount(int value) => _maxAmbientCount = value;
        private void SetAmbientRange(float value) => _maxAmbientRange = value;

        public override void Shutdown()
        {
            base.Shutdown();
            ClearSounds();
            var configManager = IoCManager.Resolve<IConfigurationManager>();
            configManager.UnsubValueChanged(CCVars.AmbientCooldown, SetCooldown);
            configManager.UnsubValueChanged(CCVars.MaxAmbientSources, SetAmbientCount);
            configManager.UnsubValueChanged(CCVars.AmbientRange, SetAmbientRange);
        }

        private int PlayingCount(string countSound)
        {
            var count = 0;

            foreach (var (_, (_, sound)) in _playingSounds)
            {
                if (sound.Equals(countSound)) count++;
            }

            return count;
        }

        public override void Update(float frameTime)
        {
            base.Update(frameTime);

            if (!_gameTiming.IsFirstTimePredicted) return;

            if (_cooldown <= 0f)
            {
                _accumulator = 0f;
                return;
            }

            _accumulator += frameTime;
            if (_accumulator < _cooldown) return;
            _accumulator -= _cooldown;

            var player = _playerManager.LocalPlayer?.ControlledEntity;
            if (!EntityManager.TryGetComponent(player, out TransformComponent? playerManager))
            {
                ClearSounds();
                return;
            }

            var coordinates = playerManager.Coordinates;

            ProcessNearbyAmbience(coordinates);
        }

        private void ClearSounds()
        {
            foreach (var (_, (stream, _)) in _playingSounds)
            {
                stream?.Stop();
            }

            _playingSounds.Clear();
        }

        private Dictionary<string, List<AmbientSoundComponent>> GetNearbySources(EntityCoordinates coordinates)
        {
            //TODO: Make this produce a hashset of nearby entities again.
            var sourceDict = new Dictionary<string, List<AmbientSoundComponent>>(16);

            foreach (var entity in _lookup.GetEntitiesInRange(coordinates, _maxAmbientRange + RangeBuffer, LookupFlags.IncludeAnchored | LookupFlags.Approximate))
            {
                if (!EntityManager.TryGetComponent(entity, out AmbientSoundComponent? ambientComp) ||
                    !ambientComp.Enabled ||
                    !EntityManager.GetComponent<TransformComponent>(entity).Coordinates.TryDistance(EntityManager, coordinates, out var range) ||
                    range > ambientComp.Range)
                {
                    continue;
                }

                var key = ambientComp.Sound.GetSound();

                if (!sourceDict.ContainsKey(key))
                    sourceDict[key] = new List<AmbientSoundComponent>(_maxSingleSound);

                sourceDict[key].Add(ambientComp);
            }

            foreach (var (key, val) in sourceDict)
            {
                sourceDict[key] = val.OrderByDescending(x =>
                    Transform(x.Owner).Coordinates.TryDistance(EntityManager, coordinates, out var dist) ? dist : float.MaxValue).ToList();
            }

            return sourceDict;
        }

        /// <summary>
        /// Get a list of ambient components in range and determine which ones to start playing.
        /// </summary>
        private void ProcessNearbyAmbience(EntityCoordinates coordinates)
        {
            var compsInRange= GetNearbySources(coordinates);

            var keys = compsInRange.Keys.ToHashSet();

            while (keys.Count != 0)
            {
                if (_playingSounds.Count >= _maxAmbientCount)
                {
                    /*
                    // Go through and remove everything from compSet
                    foreach (var toRemove in keys.SelectMany(key => compsInRange[key]))
                    {
                        compSet.Remove(toRemove.Owner);
                    }
                    */

                    break;
                }

                foreach (var key in keys)
                {
                    if (_playingSounds.Count >= _maxAmbientCount)
                        break;

                    if (compsInRange[key].Count == 0)
                    {
                        keys.Remove(key);
                        continue;
                    }

                    var comp = compsInRange[key].Pop();
                    if (_playingSounds.ContainsKey(comp))
                        continue;

                    var sound = comp.Sound.GetSound();

                    if (PlayingCount(sound) >= _maxSingleSound)
                    {
                        keys.Remove(key);
                        /*foreach (var toRemove in compsInRange[key])
                        {
                            Logger.Debug($"removing {toRemove.Owner} from set.");
                            compSet.Remove(toRemove.Owner);
                        }*/
                        compsInRange[key].Clear(); // reduce work later should we overrun the max sounds.
                        continue;
                    }

                    var audioParams = AudioHelpers
                        .WithVariation(0.01f)
                        .WithVolume(comp.Volume)
                        .WithLoop(true)
                        .WithAttenuation(Attenuation.LinearDistance)
                        // Randomise start so 2 sources don't increase their volume.
                        .WithPlayOffset(_random.NextFloat(0.0f, 100.0f))
                        .WithMaxDistance(comp.Range);

                    var stream = SoundSystem.Play(
                        Filter.Local(),
                        sound,
                        comp.Owner,
                        audioParams);

                    if (stream == null) continue;

                    _playingSounds[comp] = (stream, sound);
                }
            }

            foreach (var (comp, sound) in _playingSounds)
            {
                var entity = comp.Owner;
                if (comp.Deleted || // includes entity deletion
                    !comp.Enabled ||
                    !EntityManager.GetComponent<TransformComponent>(entity).Coordinates
                        .TryDistance(EntityManager, coordinates, out var range) ||
                    range > comp.Range)
                {
                    sound.Stream?.Stop();
                    _playingSounds.Remove(comp);
                }
            }

            //TODO: Put this code back in place! Currently not done this way because of GetEntitiesInRange being funny.
            /*
            foreach (var (comp, sound) in _playingSounds)
            {
                if (compSet.Contains(comp.Owner)) continue;

                Logger.Debug($"Cancelled {comp.Owner}");
                _playingSounds[comp].Stream?.Stop();
                _playingSounds.Remove(comp);
            }
            */
        }
    }
}