| | | 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; |
| | 50 | 18 | | public float volume = 1f; |
| | | 19 | | public bool loop = false; |
| | 50 | 20 | | public float pitch = 1f; |
| | | 21 | | public long playedAtTimestamp = 0; |
| | | 22 | | |
| | 18 | 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 | | |
| | 5 | 34 | | public override string componentName => "AudioSource"; |
| | | 35 | | |
| | | 36 | | private void Awake() |
| | | 37 | | { |
| | 15 | 38 | | audioSource = gameObject.GetOrCreateComponent<AudioSource>(); |
| | 15 | 39 | | model = new Model(); |
| | | 40 | | |
| | 15 | 41 | | if (Settings.i != null) |
| | 15 | 42 | | Settings.i.audioSettings.OnChanged += OnAudioSettingsChanged; |
| | | 43 | | |
| | 15 | 44 | | DataStore.i.virtualAudioMixer.sceneSFXVolume.OnChange += OnVirtualAudioMixerChangedValue; |
| | 15 | 45 | | } |
| | | 46 | | |
| | | 47 | | public override void Initialize(IParcelScene scene, IDCLEntity entity) |
| | | 48 | | { |
| | 15 | 49 | | base.Initialize(scene, entity); |
| | 15 | 50 | | DataStore.i.sceneBoundariesChecker.Add(entity,this); |
| | 15 | 51 | | } |
| | | 52 | | |
| | | 53 | | public void InitDCLAudioClip(DCLAudioClip dclAudioClip) |
| | | 54 | | { |
| | 28 | 55 | | if (lastDCLAudioClip != null) |
| | | 56 | | { |
| | 13 | 57 | | lastDCLAudioClip.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | | 58 | | } |
| | | 59 | | |
| | 28 | 60 | | lastDCLAudioClip = dclAudioClip; |
| | 28 | 61 | | } |
| | | 62 | | |
| | 2 | 63 | | public double volume => ((Model) model).volume; |
| | | 64 | | |
| | | 65 | | public override IEnumerator ApplyChanges(BaseModel baseModel) |
| | | 66 | | { |
| | 36 | 67 | | yield return new WaitUntil(() => CommonScriptableObjects.rendererState.Get()); |
| | | 68 | | |
| | | 69 | | //If the scene creates and destroy an audiosource before our renderer has been turned on bad things happen! |
| | | 70 | | //TODO: Analyze if we can catch this upstream and stop the IEnumerator |
| | 18 | 71 | | if (isDestroyed) |
| | 0 | 72 | | yield break; |
| | | 73 | | |
| | 18 | 74 | | CommonScriptableObjects.sceneNumber.OnChange -= OnCurrentSceneChanged; |
| | 18 | 75 | | CommonScriptableObjects.sceneNumber.OnChange += OnCurrentSceneChanged; |
| | | 76 | | |
| | 18 | 77 | | ApplyCurrentModel(); |
| | | 78 | | |
| | 18 | 79 | | yield return null; |
| | 17 | 80 | | } |
| | | 81 | | |
| | | 82 | | private void ApplyCurrentModel() |
| | | 83 | | { |
| | 18 | 84 | | if (audioSource == null) |
| | | 85 | | { |
| | 0 | 86 | | Debug.LogWarning("AudioSource is null!."); |
| | 0 | 87 | | return; |
| | | 88 | | } |
| | | 89 | | |
| | 18 | 90 | | Model model = (Model) this.model; |
| | 18 | 91 | | UpdateAudioSourceVolume(); |
| | 18 | 92 | | audioSource.loop = model.loop; |
| | 18 | 93 | | audioSource.pitch = model.pitch; |
| | 18 | 94 | | audioSource.spatialBlend = 1; |
| | 18 | 95 | | audioSource.dopplerLevel = 0.1f; |
| | | 96 | | |
| | 18 | 97 | | if (model.playing) |
| | | 98 | | { |
| | 13 | 99 | | DCLAudioClip dclAudioClip = scene.componentsManagerLegacy.GetSceneSharedComponent(model.audioClipId) as |
| | | 100 | | |
| | 13 | 101 | | if (dclAudioClip != null) |
| | | 102 | | { |
| | 13 | 103 | | InitDCLAudioClip(dclAudioClip); |
| | | 104 | | //NOTE(Brian): Play if finished loading, otherwise will wait for the loading to complete (or fail). |
| | 13 | 105 | | if (dclAudioClip.loadingState == DCLAudioClip.LoadState.LOADING_COMPLETED) |
| | | 106 | | { |
| | 13 | 107 | | ApplyLoadedAudioClip(dclAudioClip); |
| | | 108 | | } |
| | | 109 | | else |
| | | 110 | | { |
| | 0 | 111 | | dclAudioClip.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | 0 | 112 | | dclAudioClip.OnLoadingFinished += DclAudioClip_OnLoadingFinished; |
| | | 113 | | } |
| | | 114 | | } |
| | | 115 | | else |
| | | 116 | | { |
| | 0 | 117 | | Debug.LogError("Wrong audio clip type when playing audiosource!!"); |
| | | 118 | | } |
| | | 119 | | } |
| | | 120 | | else |
| | | 121 | | { |
| | 5 | 122 | | if (audioSource.isPlaying) |
| | | 123 | | { |
| | 2 | 124 | | audioSource.Stop(); |
| | | 125 | | } |
| | | 126 | | } |
| | 5 | 127 | | } |
| | | 128 | | |
| | | 129 | | private void OnAudioSettingsChanged(AudioSettings settings) |
| | | 130 | | { |
| | 0 | 131 | | UpdateAudioSourceVolume(); |
| | 0 | 132 | | } |
| | | 133 | | |
| | | 134 | | private void OnVirtualAudioMixerChangedValue(float currentValue, float previousValue) |
| | | 135 | | { |
| | 0 | 136 | | UpdateAudioSourceVolume(); |
| | 0 | 137 | | } |
| | | 138 | | |
| | | 139 | | private void UpdateAudioSourceVolume() |
| | | 140 | | { |
| | 19 | 141 | | float newVolume = 0; |
| | | 142 | | |
| | | 143 | | // isOutOfBoundaries will always be false for global scenes. |
| | 19 | 144 | | if (!isOutOfBoundaries) |
| | | 145 | | { |
| | 19 | 146 | | AudioSettings audioSettingsData = |
| | | 147 | | Settings.i != null ? Settings.i.audioSettings.Data : new AudioSettings(); |
| | 19 | 148 | | newVolume = ((Model) model).volume * Utils.ToVolumeCurve( |
| | | 149 | | DataStore.i.virtualAudioMixer.sceneSFXVolume.Get() * audioSettingsData.sceneSFXVolume * |
| | | 150 | | audioSettingsData.masterVolume); |
| | | 151 | | } |
| | | 152 | | |
| | 19 | 153 | | bool isCurrentScene = scene.isPersistent || scene.sceneData.sceneNumber == CommonScriptableObjects.sceneNumb |
| | | 154 | | |
| | 19 | 155 | | audioSource.volume = isCurrentScene ? newVolume : 0f; |
| | 19 | 156 | | } |
| | | 157 | | |
| | | 158 | | private void OnCurrentSceneChanged(int currentSceneNumber, int previousSceneNumber) |
| | | 159 | | { |
| | 3 | 160 | | if (audioSource == null) |
| | 0 | 161 | | return; |
| | | 162 | | |
| | 3 | 163 | | Model model = (Model) this.model; |
| | 3 | 164 | | float volume = 0; |
| | | 165 | | |
| | 3 | 166 | | if (scene.isPersistent || scene.sceneData.sceneNumber == currentSceneNumber) |
| | | 167 | | { |
| | 2 | 168 | | volume = model.volume; |
| | | 169 | | } |
| | | 170 | | |
| | 3 | 171 | | audioSource.volume = volume; |
| | 3 | 172 | | } |
| | | 173 | | |
| | | 174 | | private void OnDestroy() |
| | | 175 | | { |
| | 15 | 176 | | isDestroyed = true; |
| | 15 | 177 | | CommonScriptableObjects.sceneNumber.OnChange -= OnCurrentSceneChanged; |
| | | 178 | | |
| | | 179 | | //NOTE(Brian): Unsubscribe events. |
| | 15 | 180 | | InitDCLAudioClip(null); |
| | | 181 | | |
| | 15 | 182 | | if (Settings.i != null) |
| | 15 | 183 | | Settings.i.audioSettings.OnChanged -= OnAudioSettingsChanged; |
| | | 184 | | |
| | 15 | 185 | | DataStore.i.virtualAudioMixer.sceneSFXVolume.OnChange -= OnVirtualAudioMixerChangedValue; |
| | 15 | 186 | | DataStore.i.sceneBoundariesChecker.Remove(entity,this); |
| | | 187 | | |
| | 15 | 188 | | lastDCLAudioClip = null; |
| | 15 | 189 | | audioSource = null; |
| | 15 | 190 | | } |
| | | 191 | | |
| | | 192 | | public void UpdateOutOfBoundariesState(bool isInsideBoundaries) |
| | | 193 | | { |
| | 1 | 194 | | if (scene.isPersistent) |
| | 0 | 195 | | isInsideBoundaries = true; |
| | | 196 | | |
| | 1 | 197 | | isOutOfBoundaries = !isInsideBoundaries; |
| | 1 | 198 | | UpdateAudioSourceVolume(); |
| | 1 | 199 | | } |
| | | 200 | | |
| | | 201 | | private void DclAudioClip_OnLoadingFinished(DCLAudioClip obj) |
| | | 202 | | { |
| | 0 | 203 | | if (obj.loadingState == DCLAudioClip.LoadState.LOADING_COMPLETED && audioSource != null) |
| | | 204 | | { |
| | 0 | 205 | | ApplyLoadedAudioClip(obj); |
| | | 206 | | } |
| | | 207 | | |
| | 0 | 208 | | obj.OnLoadingFinished -= DclAudioClip_OnLoadingFinished; |
| | 0 | 209 | | } |
| | | 210 | | |
| | | 211 | | private void ApplyLoadedAudioClip(DCLAudioClip clip) |
| | | 212 | | { |
| | 13 | 213 | | if (audioSource.clip != clip.audioClip) |
| | | 214 | | { |
| | 13 | 215 | | audioSource.clip = clip.audioClip; |
| | | 216 | | } |
| | | 217 | | |
| | 13 | 218 | | Model model = (Model) this.model; |
| | 13 | 219 | | bool shouldPlay = playedAtTimestamp != model.playedAtTimestamp || |
| | | 220 | | (model.playing && !audioSource.isPlaying); |
| | | 221 | | |
| | 13 | 222 | | if (audioSource.enabled && model.playing && shouldPlay) |
| | | 223 | | { |
| | | 224 | | //To remove a pesky and quite unlikely warning when the audiosource is out of scenebounds |
| | 13 | 225 | | audioSource.Play(); |
| | | 226 | | } |
| | | 227 | | |
| | 13 | 228 | | playedAtTimestamp = model.playedAtTimestamp; |
| | 13 | 229 | | } |
| | | 230 | | |
| | 1 | 231 | | public override int GetClassId() { return (int) CLASS_ID_COMPONENT.AUDIO_SOURCE; } |
| | | 232 | | } |
| | | 233 | | } |