RimeFramework v0.1.0

AstoraGray · AstoraGray · commit c9dc6cfb6a59 · 2024-11-14T01:26:06.000+08:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# Rime Framework
+# Rime Framework v0.0.1
 「Rime Framework」很轻，就像雾凇上的白霜一般，覆之于上，将其包裹着的物体装饰的冰洁、神圣。
 
-「Rime Framework」是Unity的一个超轻量级框架，目的是提供简洁的接口，使用起来不会破坏原代码的结构，就像没有一样。目前目前主要有八个模块：Consoles、Controls、States、Pools、Cycles、Animators、Scenes、Navigations。RimeManager负责启动模块。
+「Rime Framework」是Unity的一个超轻量级框架，目的是提供简洁的接口，使用起来不会破坏原代码的结构，就像没有一样。目前目前主要有九个模块：Consoles、Controls、States、Pools、Cycles、Animators、Scenes、Navigations、Audios。RimeManager负责启动模块。
 
 Consoles 💻
 
@@ -37,46 +37,46 @@ Rime Framework的导航组，对游戏中的所有面板进行导航，并且有
 
 Audios 🔊
 
-即将到来，敬请期待！
+Rime Framework的音效师，管理游戏中的所有声音，并且与Pools联动
 
 ------
 
-The "Rime Framework" is lightweight, akin to the white frost on rime ice, enveloping objects in an ice-like purity and sanctity.
+The "Rime Framework" is lightweight, like the white frost on rime ice, enveloping objects and adorning them with purity and sanctity.
 
-The "Rime Framework" is an ultra-lightweight framework for Unity, designed to provide a concise interface that won't disrupt the original code structure—it's as if it's not even there. Currently, there are eight main modules: Consoles、Controls、States、Pools、Cycles、Animators、Scenes and Navigations. The RimeManager is responsible for launching these modules.
+The "Rime Framework" is an ultra-lightweight framework for Unity, designed to provide a concise interface that does not disrupt the structure of the original code, making it feel almost invisible. Currently, it features nine main modules: Consoles, Controls, States, Pools, Cycles, Animators, Scenes, Navigations, and Audios. The RimeManager is responsible for initializing these modules.
 
 **Consoles 💻**
 
-The console of the Rime Framework is responsible for printing logs from the Rime Framework, supporting the printing of instances and types.
+The console of the Rime Framework, responsible for printing out the logs of RimeFramework. It supports logging for instances and types.
 
 **Controls 🎮**
 
-The controller of the Rime Framework is developed based on the InputSystem. It uses event-driven mechanisms to control input events, supports hot-swapping of devices, long press charging, and is easily extensible and adaptable.
+The controller of the Rime Framework, developed based on the InputSystem. It uses event-driven mechanisms to manage input events, supports hot-swapping of devices, and allows for long press actions. It is also easily extensible and customizable.
 
 **States 🗡️**
 
-The state machine of the Rime Framework is very simple and easy to use, allowing collaboration with Controls to facilitate character control development. It also effectively handles state transitions and animation switches.
+The state machine of the Rime Framework, which is simple and easy to use, can work in conjunction with Controls to facilitate the development of character manipulation, and effectively handle state and animation transitions.
 
 **Pools 💧**
 
-The object pool of the Rime Framework supports threefold management of Objects, Monobehaviours, and GameObjects, and works with Cycles to achieve a complete Unity lifecycle for non-Mono classes.
+The object pool of the Rime Framework, which supports triple management of Objects, Monobehaviour, and GameObjects, and integrates well with Cycles to achieve a complete Unity lifecycle without using Mono.
 
 **Cycles 🕙**
 
-The lifecycle management of the Rime Framework, in conjunction with Pools, optimizes memory usage and allows for straightforward integration of non-Mono classes into the Unity loop.
+The lifecycle management of the Rime Framework, which optimizes memory in conjunction with Pools and makes it easy to add non-Mono classes into the Unity loop.
 
 **Animators ✍️**
 
-The animator of the Rime Framework registers animations for playback, facilitates animation blending and groups, and supports success and failure callbacks, allowing independence from Animator connections.
+The animator of the Rime Framework, which registers animations for playback, blending animations, and supports callback mechanisms for success and failure, allowing it to operate independently of Animator connections.
 
 **Scenes 🎬**
 
-The scenographer of the Rime Framework is responsible for the asynchronous loading and unloading of scenes, supporting completion callbacks and cancellation callbacks.
+The scene manager of the Rime Framework, responsible for asynchronously loading and unloading scenes, supporting completion callbacks and cancellation callbacks.
 
 **Navigations ➡️**
 
-The navigation group of the Rime Framework manages navigation for all panels in the game, featuring a loop prevention mechanism.
+The navigation group of the Rime Framework, which manages navigation for all panels in the game and includes a mechanism to prevent loops.
 
 **Audios 🔊**
 
-Coming soon, stay tuned!
+The sound engineer of the Rime Framework, which manages all audio in the game and interacts with Pools.
diff --git a/RimeFramework/Core/Animators/Animators.cs b/RimeFramework/Core/Animators/Animators.cs
@@ -25,10 +25,7 @@ public class Animators : Singleton<Animators>
         /// </summary>
         /// <param name="groupName">组名</param>
         /// <param name="animations">序列动画名</param>
-        public static void Register(string groupName,params string[] animations)
-        {
-            _dicGroups[groupName] = animations;
-        }
+        public static void Register(string groupName,params string[] animations) => _dicGroups[groupName] = animations;
 
         /// <summary>
         /// 播放 动画/动画组,组优先级 > 动画
diff --git a/RimeFramework/Core/Audios/Audios.cs b/RimeFramework/Core/Audios/Audios.cs
@@ -1,12 +1,242 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
 using RimeFramework.Tool;
+using UnityEngine;
 
 namespace RimeFramework.Core
 {
     /// <summary>
-    /// 霜 · 声音 🔊
+    /// 霜 · 音效师 🔊
     /// </summary>
+    /// <b> 支持多通道播放声音、BGM淡入淡出、3D音效、循环播放、提供最简单的调用接口
+    /// <see cref="PlayS3D(MonoBehaviour,string,PlayingCall,bool)"/> 播放3D声音，需要一个拥有者
+    /// <see cref="PlayS3D(string,PlayingCall,bool)"/> 播放2D声音
+    /// <see cref="PlaySUI(string,PlayingCall,bool)"/> 播放UI声音
+    /// <see cref="PlayS3D(string)"/> 播放BGM，淡入淡出
+    /// <remarks>Author: AstoraGray</remarks>
+    [RequireComponent(typeof(AudioSource))]
     public class Audios : Singleton<Audios>
     {
+        private static AudioSource _audioMusic; // BGM音轨
+
+        public static readonly float musicVolume = 1; // BGM音量
+
+        public static readonly float s2dVolume = 1; // 2D音量
+        
+        public static readonly float s3dVolume = 1; // 3D音量
+        
+        public static readonly float suiVolume = 1; // UI音量
+
+        private static readonly Dictionary<string, AudioClip> _dicClips = new(); // 缓存音频
+
+        private static Coroutine _coroutineMusicFade; // 淡入淡出协程
+
+        private static AudioClip _clipCurMusic; // 当前BGM
+        
+        private const float FADE_TIME = 2f; // 淡入淡出时间（真实时间）
+
+        private const string AUDIO_PATH = "Audios/"; // 音频文件路径
+        
+        private enum AudioType
+        {
+            S2D, // 2D声音（无距离、可多个）
+            S3D, // 3D声音（有距离、可多个）
+            SUI, // UI声音（无距离、可多个）
+            Music // BGM（无距离、单一、淡入淡出）
+        }
+
+        private enum FadeType
+        {
+            In, // 淡入
+            Out // 淡出
+        }
+        /// <summary>
+        /// 初始化
+        /// </summary>
+        protected override void Awake()
+        {
+            base.Awake();
+            _audioMusic = GetComponent<AudioSource>();
+            _audioMusic.loop = true;
+            _audioMusic.volume = 0f;
+        }
+
+        /// <summary>
+        /// 播放3D声音
+        /// </summary>
+        public static void PlayS3D(MonoBehaviour own, string name,PlayingCall call = null,bool loop = false) => Play(own, name, AudioType.S3D,call,loop);
+        /// <summary>
+        /// 播放2D声音
+        /// </summary>
+        public static void PlayS2D(string name,PlayingCall call = null,bool loop = false) => Play(null, name, AudioType.S2D,call,loop);
+        /// <summary>
+        /// 播放UI声音
+        /// </summary>
+        public static void PlaySUI(string name,PlayingCall call = null,bool loop = false) => Play(null, name, AudioType.SUI,call,loop);
+        /// <summary>
+        /// 播放BGM
+        /// </summary>
+        public static void PlayMusic(string name) => Play(null, name, AudioType.Music,null,true);
+        /// <summary>
+        /// 播放声音
+        /// </summary>
+        /// <param name="own">拥有者</param>
+        /// <param name="name">音频名称</param>
+        /// <param name="type">音频类型</param>
+        /// <param name="call">播放回调</param>
+        /// <param name="loop">是否循环</param>
+        private static void Play(MonoBehaviour own, string name, AudioType type,PlayingCall call,bool loop)
+        {
+            AudioClip clip;
+            if (!_dicClips.ContainsKey(name))
+            {
+                string path = $"{AUDIO_PATH}{name}";
+                clip = Resources.Load<AudioClip>(path);
+                if (clip == null)
+                {
+                    Consoles.Print(typeof(Audios),$"找不到音频文件{path}");
+                    return;
+                }
+                _dicClips[name] = clip;
+            }
+
+            clip = _dicClips[name];
+            
+            AudioSource audio = null;
+            switch (type)
+            {
+                case AudioType.S2D:
+                    audio = Pools.Take<AudioSource>();
+                    audio.clip = clip;
+                    audio.volume = s2dVolume;
+                    audio.spatialBlend = 0;
+                    audio.loop = loop;
+                    Instance.StartCoroutine(PlaySound(null, audio,call));
+                    break;
+                case AudioType.S3D:
+                    if (own == null)
+                    {
+                        Consoles.Print(typeof(Audios),$"播放{name}声音失败，3D声音需要指定一个拥有者");
+                        return;
+                    }
+                    audio = Pools.Take<AudioSource>();
+                    audio.clip = clip;
+                    audio.volume = s3dVolume;
+                    audio.spatialBlend = 1;
+                    audio.loop = loop;
+                    Instance.StartCoroutine(PlaySound(own, audio,call));
+                    break;
+                case AudioType.SUI:
+                    audio = Pools.Take<AudioSource>();
+                    audio.clip = clip;
+                    audio.volume = suiVolume;
+                    audio.spatialBlend = 0;
+                    audio.loop = loop;
+                    Instance.StartCoroutine(PlaySound(null, audio,call));
+                    break;
+                case AudioType.Music:
+                    if (clip == _clipCurMusic)
+                    {
+                        return;
+                    }
+
+                    _clipCurMusic = clip;
+                    
+                    if (_audioMusic.isPlaying)
+                    {
+                        Consoles.Print(typeof(Audios),$"开始淡出BGM {_audioMusic.name}");
+                        _coroutineMusicFade = Instance.StartCoroutine(FadeMusic(_audioMusic.volume,0,FADE_TIME,FadeType.Out, () =>
+                        {
+                            _audioMusic.clip = clip;
+                            Consoles.Print(typeof(Audios),$"开始淡入BGM {name}");
+                            _coroutineMusicFade = Instance.StartCoroutine(FadeMusic(_audioMusic.volume,musicVolume,FADE_TIME,FadeType.In));
+                        }));
+                    }
+                    else
+                    {
+                        _audioMusic.clip = clip;
+                        Consoles.Print(typeof(Audios),$"开始淡入BGM {name}");
+                        _coroutineMusicFade = Instance.StartCoroutine(FadeMusic(_audioMusic.volume,musicVolume,FADE_TIME,FadeType.In));
+                    }
+                    break;
+            }
+        }
+        /// <summary>
+        /// 淡入淡出BGM
+        /// </summary>
+        /// <param name="startVolume">开始音量</param>
+        /// <param name="endVolume">结束音量</param>
+        /// <param name="duration">持续时间</param>
+        /// <param name="fadeType">淡入/淡出</param>
+        /// <param name="onComplete">结束回调</param>
+        /// <returns></returns>
+        private static IEnumerator FadeMusic(float startVolume, float endVolume, float duration,FadeType fadeType, Action onComplete = null)
+        {
+            yield return null;
+            Coroutine coroutine = _coroutineMusicFade;
+            float startTime = Time.time;
+            _audioMusic.volume = startVolume;
+            
+            if (fadeType == FadeType.In)
+            {
+                _audioMusic.Play();
+            }
+
+            while (Time.time < startTime + duration)
+            {
+                if (coroutine != _coroutineMusicFade)
+                {
+                    yield break;
+                }
+                _audioMusic.volume = Mathf.Lerp(startVolume, endVolume, 1 - (startTime + duration - Time.time) / duration);
+                yield return null;
+            }
+
+            _audioMusic.volume = endVolume;
+
+            if (fadeType == FadeType.Out)
+            {
+                _audioMusic.Stop();
+            }
+            
+            onComplete?.Invoke();
+        }
+        /// <summary>
+        /// 播放条件（可空）
+        /// </summary>
+        public delegate bool PlayingCall(MonoBehaviour own, string name);
         
+        /// <summary>
+        /// 播放声音协程
+        /// </summary>
+        /// <param name="own">拥有者</param>
+        /// <param name="audio">音频</param>
+        /// <param name="call">播放条件回调</param>
+        /// <returns></returns>
+        private static IEnumerator PlaySound(MonoBehaviour own, AudioSource audio, PlayingCall call)
+        {
+            audio.Play();
+            float clipLength = audio.clip.length;
+            float endTime = Time.time + clipLength;
+            
+            while (call?.Invoke(own,audio.clip.name) ?? (audio.loop || Time.time < endTime))
+            {
+                if (own != null)
+                {
+                    audio.transform.position = own.transform.position;
+                }
+
+                if (!audio.isPlaying)
+                {
+                    break;
+                }
+
+                yield return null;
+            }
+
+            audio.Stop();
+            Pools.Put(audio);
+        }
     }
 }
diff --git a/RimeFramework/Core/Pools/Pools.cs b/RimeFramework/Core/Pools/Pools.cs
