| | | 1 | | using DCL.Helpers; |
| | | 2 | | using System.Collections; |
| | | 3 | | using DCL.Controllers; |
| | | 4 | | using UnityEngine; |
| | | 5 | | using DCL.Models; |
| | | 6 | | using DCL.SettingsCommon; |
| | | 7 | | using AudioSettings = DCL.SettingsCommon.AudioSettings; |
| | | 8 | | |
| | | 9 | | namespace DCL.Components |
| | | 10 | | { |
| | | 11 | | public class DCLAudioSource : BaseComponent, IOutOfSceneBoundariesHandler |
| | | 12 | | { |
| | | 13 | | [System.Serializable] |
| | | 14 | | public class Model : BaseModel |
| | | 15 | | { |
| | | 16 | | public string audioClipId; |
| | | 17 | | public bool playing = false; |
| | 45 | 18 | | public float volume = 1f; |
| | | 19 | | public bool loop = false; |
| | 45 | 20 | | public float pitch = 1f; |
| | | 21 | | public long playedAtTimestamp = 0; |
| | | 22 | | |
| | 16 | 23 | | public override BaseModel GetDataFromJSON(string json) { return Utils.SafeFromJson<Model>(json); } |
| | | 24 | | } |
| | | 25 | | |
| | 1 | 26 | | public float playTime => audioSource.time; |
| | | 27 | | internal AudioSource audioSource; |
| | | 28 | | DCLAudioClip lastDCLAudioClip; |
| | | 29 | | |
| | | 30 | | private bool isDestroyed = false; |
| | | 31 | | public long playedAtTimestamp = 0; |
| | | 32 | | private bool isOutOfBoundaries = false; |
| | | 33 | | |
| | | 34 | | private void Awake() |
| | | 35 | | { |
| | 13 | 36 | | audioSource = gameObject.GetOrCreateComponent<AudioSource>(); |
| | 13 | 37 | | model = new Model(); |
| | | 38 | | |
| | 13 | 39 | | if (Settings.i != null) |
| | 13 | 40 | | Settings.i.audioSettings.OnChanged += OnAudioSettingsChanged; |
| | | 41 | | |
| | 13 | 42 | | DataStore.i.virtualAudioMixer.sceneSFXVolume.OnChange += OnVirtualAudioMixerChangedValue; |
| | 13 | 43 | | } |
| | | 44 | | |
| | | 45 | | public void InitDCLAudioClip(DCLAudioClip dclAudioClip) |
| | | 46 | | { |
| | 25 | 47 | | if (lastDCLAudioClip != null) |
| | | 48 | | { |
| | 12 | 49 | | lastDCLAudioClip.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | | 50 | | } |
| | | 51 | | |
| | 25 | 52 | | lastDCLAudioClip = dclAudioClip; |
| | 25 | 53 | | } |
| | | 54 | | |
| | 0 | 55 | | public double volume => ((Model) model).volume; |
| | | 56 | | |
| | | 57 | | public override IEnumerator ApplyChanges(BaseModel baseModel) |
| | | 58 | | { |
| | 32 | 59 | | yield return new WaitUntil(() => CommonScriptableObjects.rendererState.Get()); |
| | | 60 | | |
| | | 61 | | //If the scene creates and destroy an audiosource before our renderer has been turned on bad things happen! |
| | | 62 | | //TODO: Analyze if we can catch this upstream and stop the IEnumerator |
| | 16 | 63 | | if (isDestroyed) |
| | 0 | 64 | | yield break; |
| | | 65 | | |
| | 16 | 66 | | CommonScriptableObjects.sceneID.OnChange -= OnCurrentSceneChanged; |
| | 16 | 67 | | CommonScriptableObjects.sceneID.OnChange += OnCurrentSceneChanged; |
| | | 68 | | |
| | 16 | 69 | | ApplyCurrentModel(); |
| | | 70 | | |
| | 16 | 71 | | yield return null; |
| | 16 | 72 | | } |
| | | 73 | | |
| | | 74 | | private void ApplyCurrentModel() |
| | | 75 | | { |
| | 16 | 76 | | if (audioSource == null) |
| | | 77 | | { |
| | 0 | 78 | | Debug.LogWarning("AudioSource is null!."); |
| | 0 | 79 | | return; |
| | | 80 | | } |
| | | 81 | | |
| | 16 | 82 | | Model model = (Model) this.model; |
| | 16 | 83 | | UpdateAudioSourceVolume(); |
| | 16 | 84 | | audioSource.loop = model.loop; |
| | 16 | 85 | | audioSource.pitch = model.pitch; |
| | 16 | 86 | | audioSource.spatialBlend = 1; |
| | 16 | 87 | | audioSource.dopplerLevel = 0.1f; |
| | | 88 | | |
| | 16 | 89 | | if (model.playing) |
| | | 90 | | { |
| | 12 | 91 | | DCLAudioClip dclAudioClip = scene.GetSharedComponent(model.audioClipId) as DCLAudioClip; |
| | | 92 | | |
| | 12 | 93 | | if (dclAudioClip != null) |
| | | 94 | | { |
| | 12 | 95 | | InitDCLAudioClip(dclAudioClip); |
| | | 96 | | //NOTE(Brian): Play if finished loading, otherwise will wait for the loading to complete (or fail). |
| | 12 | 97 | | if (dclAudioClip.loadingState == DCLAudioClip.LoadState.LOADING_COMPLETED) |
| | | 98 | | { |
| | 12 | 99 | | ApplyLoadedAudioClip(dclAudioClip); |
| | 12 | 100 | | } |
| | | 101 | | else |
| | | 102 | | { |
| | 0 | 103 | | dclAudioClip.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | 0 | 104 | | dclAudioClip.OnLoadingFinished += DclAudioClip_OnLoadingFinished; |
| | | 105 | | } |
| | 0 | 106 | | } |
| | | 107 | | else |
| | | 108 | | { |
| | 0 | 109 | | Debug.LogError("Wrong audio clip type when playing audiosource!!"); |
| | | 110 | | } |
| | 0 | 111 | | } |
| | | 112 | | else |
| | | 113 | | { |
| | 4 | 114 | | if (audioSource.isPlaying) |
| | | 115 | | { |
| | 2 | 116 | | audioSource.Stop(); |
| | | 117 | | } |
| | | 118 | | } |
| | 4 | 119 | | } |
| | | 120 | | |
| | | 121 | | private void OnAudioSettingsChanged(AudioSettings settings) |
| | | 122 | | { |
| | 0 | 123 | | UpdateAudioSourceVolume(); |
| | 0 | 124 | | } |
| | | 125 | | |
| | | 126 | | private void OnVirtualAudioMixerChangedValue(float currentValue, float previousValue) |
| | | 127 | | { |
| | 0 | 128 | | UpdateAudioSourceVolume(); |
| | 0 | 129 | | } |
| | | 130 | | |
| | | 131 | | private void UpdateAudioSourceVolume() |
| | | 132 | | { |
| | 20 | 133 | | AudioSettings audioSettingsData = Settings.i != null ? Settings.i.audioSettings.Data : new AudioSettings(); |
| | 20 | 134 | | float newVolume = ((Model)model).volume * Utils.ToVolumeCurve(DataStore.i.virtualAudioMixer.sceneSFXVolume.G |
| | | 135 | | |
| | 20 | 136 | | if (scene is GlobalScene globalScene && globalScene.isPortableExperience) |
| | | 137 | | { |
| | 0 | 138 | | audioSource.volume = newVolume; |
| | 0 | 139 | | return; |
| | | 140 | | } |
| | | 141 | | |
| | 20 | 142 | | if (isOutOfBoundaries) |
| | | 143 | | { |
| | 6 | 144 | | audioSource.volume = 0; |
| | 6 | 145 | | return; |
| | | 146 | | } |
| | | 147 | | |
| | 14 | 148 | | audioSource.volume = scene.sceneData.id == CommonScriptableObjects.sceneID.Get() ? newVolume : 0f; |
| | 14 | 149 | | } |
| | | 150 | | |
| | | 151 | | private void OnCurrentSceneChanged(string currentSceneId, string previousSceneId) |
| | | 152 | | { |
| | 2 | 153 | | if (audioSource != null) |
| | | 154 | | { |
| | 2 | 155 | | Model model = (Model) this.model; |
| | 2 | 156 | | float volume = 0; |
| | 2 | 157 | | if ((scene.sceneData.id == currentSceneId) || (scene is GlobalScene globalScene && globalScene.isPortabl |
| | | 158 | | { |
| | 1 | 159 | | volume = model.volume; |
| | | 160 | | } |
| | | 161 | | |
| | 2 | 162 | | audioSource.volume = volume; |
| | | 163 | | } |
| | 2 | 164 | | } |
| | | 165 | | |
| | | 166 | | private void OnDestroy() |
| | | 167 | | { |
| | 13 | 168 | | isDestroyed = true; |
| | 13 | 169 | | CommonScriptableObjects.sceneID.OnChange -= OnCurrentSceneChanged; |
| | | 170 | | |
| | | 171 | | //NOTE(Brian): Unsubscribe events. |
| | 13 | 172 | | InitDCLAudioClip(null); |
| | | 173 | | |
| | 13 | 174 | | if (Settings.i != null) |
| | 13 | 175 | | Settings.i.audioSettings.OnChanged -= OnAudioSettingsChanged; |
| | | 176 | | |
| | 13 | 177 | | DataStore.i.virtualAudioMixer.sceneSFXVolume.OnChange -= OnVirtualAudioMixerChangedValue; |
| | 13 | 178 | | } |
| | | 179 | | |
| | | 180 | | public void UpdateOutOfBoundariesState(bool isEnabled) |
| | | 181 | | { |
| | 4 | 182 | | isOutOfBoundaries = !isEnabled; |
| | 4 | 183 | | UpdateAudioSourceVolume(); |
| | 4 | 184 | | } |
| | | 185 | | |
| | | 186 | | private void DclAudioClip_OnLoadingFinished(DCLAudioClip obj) |
| | | 187 | | { |
| | 0 | 188 | | if (obj.loadingState == DCLAudioClip.LoadState.LOADING_COMPLETED && audioSource != null) |
| | | 189 | | { |
| | 0 | 190 | | ApplyLoadedAudioClip(obj); |
| | | 191 | | } |
| | | 192 | | |
| | 0 | 193 | | obj.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | 0 | 194 | | } |
| | | 195 | | |
| | | 196 | | private void ApplyLoadedAudioClip(DCLAudioClip clip) |
| | | 197 | | { |
| | 12 | 198 | | if (audioSource.clip != clip.audioClip) |
| | | 199 | | { |
| | 12 | 200 | | audioSource.clip = clip.audioClip; |
| | | 201 | | } |
| | | 202 | | |
| | 12 | 203 | | Model model = (Model) this.model; |
| | 12 | 204 | | bool shouldPlay = playedAtTimestamp != model.playedAtTimestamp || |
| | | 205 | | (model.playing && !audioSource.isPlaying); |
| | | 206 | | |
| | 12 | 207 | | if (audioSource.enabled && model.playing && shouldPlay) |
| | | 208 | | { |
| | | 209 | | //To remove a pesky and quite unlikely warning when the audiosource is out of scenebounds |
| | 12 | 210 | | audioSource.Play(); |
| | | 211 | | } |
| | | 212 | | |
| | 12 | 213 | | playedAtTimestamp = model.playedAtTimestamp; |
| | 12 | 214 | | } |
| | | 215 | | |
| | 0 | 216 | | public override int GetClassId() { return (int) CLASS_ID_COMPONENT.AUDIO_SOURCE; } |
| | | 217 | | } |
| | | 218 | | } |