feat: Speaker Toy

EXILED/Exiled.API/Exiled.API.csproj

@@ -17,6 +17,7 @@
     </ItemGroup>
 
     <ItemGroup>
+        <PackageReference Include="NVorbis" Version="0.10.5" />
         <PackageReference Include="StyleCop.Analyzers" Version="$(StyleCopVersion)" IncludeAssets="All" PrivateAssets="All" />
         <PackageReference Include="System.Memory" Version="4.5.5" />
         <PackageReference Include="Lib.Harmony" Version="$(HarmonyVersion)" />

EXILED/Exiled.API/Features/Toys/Speaker.cs

@@ -8,19 +8,28 @@
 namespace Exiled.API.Features.Toys
 {
     using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
 
     using AdminToys;
     using Enums;
-    using Exiled.API.Interfaces;
+    using Features;
+    using Interfaces;
+    using MEC;
+    using NVorbis;
     using UnityEngine;
+    using VoiceChat.Codec;
     using VoiceChat.Networking;
-    using VoiceChat.Playbacks;
+
+    using Object = UnityEngine.Object;
 
     /// <summary>
     /// A wrapper class for <see cref="SpeakerToy"/>.
     /// </summary>
     public class Speaker : AdminToy, IWrapper<SpeakerToy>
     {
+        private bool stopPlayback;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="Speaker"/> class.
         /// </summary>
@@ -91,29 +100,39 @@ public float MinDistance
         }
 
         /// <summary>
-        /// Gets or sets the controller ID of speaker.
+        /// Gets or sets the controller ID of the SpeakerToy.
         /// </summary>
-        public byte ControllerId
+        public byte ControllerID
         {
             get => Base.NetworkControllerId;
             set => Base.NetworkControllerId = value;
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="Speaker"/> is playing an audio or not. (Use method Stop() to stop the playback).
+        /// </summary>
+        public bool IsPlaying { get; internal set; }
+
+        /// <summary>
+        /// Gets or Sets a list of players that can hear this speaker.
+        /// </summary>
+        public List<Player> BroadcastTo { get; set; }
+
         /// <summary>
         /// Creates a new <see cref="Speaker"/>.
         /// </summary>
+        /// <param name="controllerId">The Identification of the <see cref="Speaker"/>. Playing two speakers with the same identification will cause them to play the same audio.</param>
         /// <param name="position">The position of the <see cref="Speaker"/>.</param>
-        /// <param name="rotation">The rotation of the <see cref="Speaker"/>.</param>
-        /// <param name="scale">The scale of the <see cref="Speaker"/>.</param>
+        /// <param name="isSpatial">Whether the <see cref="Speaker"/> should be a 3d spaced audio, or a 2d spaced audio.</param>
         /// <param name="spawn">Whether the <see cref="Speaker"/> should be initially spawned.</param>
         /// <returns>The new <see cref="Speaker"/>.</returns>
-        public static Speaker Create(Vector3? position, Vector3? rotation, Vector3? scale, bool spawn)
+        public static Speaker Create(byte controllerId, Vector3? position, bool isSpatial, bool spawn)
         {
-            Speaker speaker = new(UnityEngine.Object.Instantiate(Prefab))
+            Speaker speaker = new(Object.Instantiate(Prefab))
             {
                 Position = position ?? Vector3.zero,
-                Rotation = Quaternion.Euler(rotation ?? Vector3.zero),
-                Scale = scale ?? Vector3.one,
+                IsSpatial = isSpatial,
+                Base = { ControllerId = controllerId },
             };
 
             if (spawn)
@@ -122,6 +141,17 @@ public static Speaker Create(Vector3? position, Vector3? rotation, Vector3? scal
             return speaker;
         }
 
+        /// <summary>
+        /// Gets the <see cref="Speaker"/> associated with a given <see cref="SpeakerToy"/>.
+        /// </summary>
+        /// <param name="speakerToy">The SpeakerToy instance.</param>
+        /// <returns>The corresponding Speaker instance.</returns>
+        public static Speaker Get(SpeakerToy speakerToy)
+        {
+            AdminToy adminToy = List.FirstOrDefault(x => x.AdminToyBase == speakerToy);
+            return adminToy is not null ? adminToy as Speaker : new(speakerToy);
+        }
+
         /// <summary>
         /// Plays audio through this speaker.
         /// </summary>
@@ -139,6 +169,132 @@ public static void Play(AudioMessage message, IEnumerable<Player> targets = null
         /// <param name="samples">Audio samples.</param>
         /// <param name="length">The length of the samples array.</param>
         /// <param name="targets">Targets who will hear the audio. If <c>null</c>, audio will be sent to all players.</param>
-        public void Play(byte[] samples, int? length = null, IEnumerable<Player> targets = null) => Play(new AudioMessage(ControllerId, samples, length ?? samples.Length), targets);
+        public void Play(byte[] samples, int? length = null, IEnumerable<Player> targets = null) => Play(new AudioMessage(ControllerID, samples, length ?? samples.Length), targets);
+
+        /// <summary>
+        /// Plays a single audio file through the speaker system. (No Arguments given (assuming you already preset those)).
+        /// </summary>
+        /// <param name="path">Path to the audio file to play.</param>
+        /// <param name="destroyAfter">Whether the Speaker gets destroyed after it's done playing.</param>
+        /// <returns>Return's whether the path was correct or not.</returns>
+        public bool Play(string path, bool destroyAfter = false) => Play(path, Volume, MinDistance, MaxDistance, BroadcastTo, destroyAfter);
+
+        /// <summary>
+        /// Plays a single audio file through the speaker system.
+        /// </summary>
+        /// <param name="path">The file path of the audio file.</param>
+        /// <param name="volume">The desired playback volume. (0 to <see cref="float"/>) max limit.</param>
+        /// <param name="minDistance">The minimum distance at which the audio's max volume is able to be heard.</param>
+        /// <param name="maxDistance">The maximum distance at which the audio is audible.</param>
+        /// <param name="playersToPlayTo">Whether to play it to a specific list of players. Keep null if you want to play it to all.</param>
+        /// <param name="destroyAfter">Whether the Speaker gets destroyed after it's done playing.</param>
+        /// <returns>Return's whether the inputted path was correct or not.</returns>
+        public bool Play(string path, float volume, float minDistance, float maxDistance, List<Player> playersToPlayTo = null, bool destroyAfter = false)
+        {
+            if (IsPlaying)
+                Stop();
+
+            if (!File.Exists(path))
+            {
+                Log.Warn($"Tried playing audio at {path} but no file was found.");
+                return false;
+            }
+
+            Volume = volume;
+            MinDistance = minDistance;
+            MaxDistance = maxDistance;
+            BroadcastTo = playersToPlayTo;
+
+            IsPlaying = true;
+            Timing.RunCoroutine(PlaybackRoutine(path, destroyAfter));
+            return true;
+        }
+
+        /// <summary>
+        /// Stops the current playback.
+        /// </summary>
+        public void Stop()
+        {
+            stopPlayback = true;
+            IsPlaying = false;
+        }
+
+        private IEnumerator<float> PlaybackRoutine(string filePath, bool destroyAfter)
+        {
+            stopPlayback = false;
+
+            string fileExtension = Path.GetExtension(filePath).ToLower();
+            Log.Debug($"Detected file: {filePath}, Extension: {fileExtension}");
+
+            const int sampleRate = 48000; // Enforce 48kHz
+            const int channels = 1; // Enforce mono audio
+            const int frameSize = 480; // Frame size for 10ms of audio at 48kHz
+
+            Queue<float> streamBuffer = new();
+            float[] readBuffer = new float[frameSize * 4];
+            float[] sendBuffer = new float[frameSize];
+            byte[] encodedBuffer = new byte[512];
+            OpusEncoder encoder = new(VoiceChat.Codec.Enums.OpusApplicationType.Voip);
+
+            float playbackInterval = frameSize / (float)sampleRate;
+            float nextPlaybackTime = Timing.LocalTime;
+
+            if (fileExtension != ".ogg")
+            {
+                Log.Error($"Unsupported file format: {fileExtension}");
+                yield break;
+            }
+
+            using VorbisReader vorbisReader = new(filePath);
+
+            if (vorbisReader.SampleRate != sampleRate || vorbisReader.Channels != channels)
+            {
+                Log.Error($"Invalid OGG file. Expected {sampleRate / 1000}kHz mono, got {vorbisReader.SampleRate / 1000}kHz {vorbisReader.Channels} channel(s).");
+                yield break;
+            }
+
+            Log.Debug($"Playing OGG file with Sample Rate: {sampleRate}, Channels: {channels}");
+
+            while (streamBuffer.Count < frameSize * 2 && !stopPlayback && Base.gameObject != null)
+            {
+                int samplesRead = vorbisReader.ReadSamples(readBuffer, 0, readBuffer.Length);
+                if (samplesRead <= 0)
+                    break;
+
+                foreach (float sample in readBuffer.Take(samplesRead))
+                    streamBuffer.Enqueue(sample);
+
+                while (!stopPlayback && streamBuffer.Count > 0)
+                {
+                    if (Timing.LocalTime < nextPlaybackTime)
+                    {
+                        yield return Timing.WaitForOneFrame;
+                        continue;
+                    }
+
+                    for (int i = 0; i < frameSize && streamBuffer.Count > 0; i++)
+                        sendBuffer[i] = streamBuffer.Dequeue();
+
+                    int dataLen = encoder.Encode(sendBuffer, encodedBuffer);
+                    AudioMessage audioMessage = new(ControllerID, encodedBuffer, dataLen);
+
+                    foreach (Player p in BroadcastTo ?? Player.List)
+                        p.ReferenceHub.connectionToClient.Send(audioMessage);
+
+                    nextPlaybackTime += playbackInterval;
+
+                    if (streamBuffer.Count >= frameSize || vorbisReader.IsEndOfStream)
+                        continue;
+                    samplesRead = vorbisReader.ReadSamples(readBuffer, 0, readBuffer.Length);
+                    foreach (float sample in readBuffer.Take(samplesRead))
+                        streamBuffer.Enqueue(sample);
+                }
+            }
+
+            Log.Debug("Playback completed.");
+            IsPlaying = false;
+            if (destroyAfter && Base.gameObject != null)
+                Destroy();
+        }
     }
-}
+}

EXILED/Exiled.Events/Handlers/Internal/Round.cs

@@ -18,6 +18,7 @@ namespace Exiled.Events.Handlers.Internal
     using Exiled.API.Features.Items;
     using Exiled.API.Features.Pools;
     using Exiled.API.Features.Roles;
+    using Exiled.API.Features.Toys;
     using Exiled.API.Structs;
     using Exiled.Events.EventArgs.Player;
     using Exiled.Events.EventArgs.Scp049;
@@ -69,6 +70,14 @@ public static void OnRestartingRound()
             TeslaGate.IgnoredTeams.Clear();
 
             API.Features.Round.IgnoredPlayers.Clear();
+
+            foreach (AdminToy admin in AdminToy.List)
+            {
+                if (admin is Speaker speaker && speaker.IsPlaying)
+                {
+                    speaker.Stop();
+                }
+            }
         }
 
         /// <inheritdoc cref="Handlers.Server.OnRoundStarted" />