SimpleAudioPlayer.cs

Go to the documentation of this file.

using UnityEngine;
using System.Text;
using System.Collections;
using System.Collections.Generic;
using HKI.Core.Loc;

namespace HKI.Core.Audio
{
    public class SimpleAudioPlayer : MonoBehaviour
    {
        // Subclass
        [System.Serializable]
        public class AudioPlayerSettings
        {
            // Public enums
            public enum Playmodes
            {
                SingleOutput,
                SingleOutputWithCrossfade,
                MultiOutput
            }

            // Public variables
            [SerializeField] Playmodes Playmode = Playmodes.SingleOutputWithCrossfade;
            [SerializeField] float FadingTimeInSeconds = 5.0f;
            [SerializeField] bool AtSetupStartPlayingPlaylist = true;
            [SerializeField] Playlist StartPlaylist = null;

            [SerializeField] UnityEngine.Audio.AudioMixerGroup AudioMixerGroup = null;
            [SerializeField] Language LocalizationLanguage = null;

            [SerializeField] bool DontGetDestroyedOnLoad = false;

            // Getter
            public Playmodes GetPlaymode { get { return Playmode; } }
            public float GetFadingTimeInSeconds { get { return FadingTimeInSeconds; } }
            public bool GetAtSetupStartPlayingPlaylist { get { return AtSetupStartPlayingPlaylist; } }
            public Playlist GetStartPlaylist { get { return StartPlaylist; } }

            public UnityEngine.Audio.AudioMixerGroup GetAudioMixerGroup { get { return AudioMixerGroup; } }
            public Language GetLocalizationLanguage { get { return LocalizationLanguage; } }

            public bool GetDontGetDestroyedOnLoad { get { return DontGetDestroyedOnLoad; } }

            // Interface functions
            public string GetInfoString()
            {
                StringBuilder infoString = new StringBuilder();
                infoString.AppendLine("Audio Player Settings:");

                infoString.Append("Playmode: ");
                infoString.AppendLine(Playmode.ToString());

                infoString.Append("FadingTimeInSeconds: ");
                infoString.AppendLine(FadingTimeInSeconds.ToString());

                infoString.Append("AtSetupStartPlayingPlaylist: ");
                infoString.AppendLine(AtSetupStartPlayingPlaylist.ToString());

                infoString.Append("StartPlaylist: ");
                infoString.AppendLine(StartPlaylist != null ? StartPlaylist.name : "null");

                infoString.Append("AudioMixerGroup: ");
                infoString.AppendLine(AudioMixerGroup != null ? AudioMixerGroup.name : "null");

                infoString.Append("LocalizationLanguage: ");
                infoString.AppendLine(LocalizationLanguage != null ? LocalizationLanguage.name : "null");

                infoString.Append("DontGetDestroyedOnLoad: ");
                infoString.AppendLine(DontGetDestroyedOnLoad.ToString());
                
                return infoString.ToString();
            }
        }
        
        // Private variables
        AudioPlayerSettings currentSettings = null;

        List<AudioSource> audioSources = new List<AudioSource>();
        int currentMainAudioSourceId = 0;

        bool isPlayingPlaylist = false;
        Playlist currentPlaylist = null;

        Coroutine crossfadeCoroutine = null;
        Coroutine playNextSoundClipOfPlaylistCoroutine = null;

        // Getter
        public AudioPlayerSettings GetSettings { get { return currentSettings; } }

        public bool IsPlayingPlaylist { get { return isPlayingPlaylist; } }
        public Playlist GetCurrentPlaylist { get { return currentPlaylist; } }
        
        // Interface function
        public void Setup(AudioPlayerSettings settings)
        {
            if(settings == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to setup the (AudioPlayer) but the new (AudioPlayerSettings) settings is null!");
                return;
            }

            StopPlayingAllClips();

            if(audioSources != null && audioSources.Count > 0)
            {
                for (int i = 0; i < audioSources.Count; i++)
                    Destroy(audioSources[i]);

                audioSources.Clear();
            }

            currentSettings = settings;
            currentPlaylist = currentSettings.GetStartPlaylist;

            switch(currentSettings.GetPlaymode)
            {
                case AudioPlayerSettings.Playmodes.SingleOutput:
                case AudioPlayerSettings.Playmodes.MultiOutput:
                    audioSources.Add(CreateAudioSource());
                    break;

                case AudioPlayerSettings.Playmodes.SingleOutputWithCrossfade:
                    audioSources.Add(CreateAudioSource());
                    audioSources.Add(CreateAudioSource());
                    break;
            }

            if(currentSettings.GetDontGetDestroyedOnLoad)
                DontDestroyOnLoad(gameObject);

            if(currentSettings.GetAtSetupStartPlayingPlaylist)
                PlayPlaylist(true);
        }

        public void PlayPlaylist(bool playPlaylist, bool debugLog = true)
        {
            if(playPlaylist && currentPlaylist == null && debugLog)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a clip from the current playlist but the current playlist is null!");
                return;
            }

            if(playPlaylist && currentPlaylist.GetNumberOfClips == 0 && debugLog)
            {
                Debug.LogWarning("(SimpleAudioPlayer)" + gameObject.name + " you try to play a clip from the current playlist " + currentPlaylist.name + " but the current playlist has no sound clips in it!");
                return;
            }

            if (!isPlayingPlaylist && playPlaylist)
            {
                isPlayingPlaylist = playPlaylist;
                PlaySoundClip(currentPlaylist.GetNextClip());
            }
            else if(isPlayingPlaylist && !playPlaylist)
            {
                isPlayingPlaylist = playPlaylist;
                StopPlayingAllClips();
            }
        }

        public void ChangePlaylist(Playlist playlist)
        {
            if(playlist == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to change the (Playlist) but the new playlist is null!");
                return;
            }

            currentPlaylist = playlist;

            if(isPlayingPlaylist)
                PlaySoundClip(currentPlaylist.GetNextClip());
        }

        public void ChangePlaylist(Playlist playlist, bool playPlaylist)
        {
            PlayPlaylist(playPlaylist);
            ChangePlaylist(playlist);
        }

        public void PlaySoundClip(SoundClip clip)
        {
            if(clip == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (SoundClip) but the clip is null!");
                return;
            }

            if(currentSettings == null || audioSources.Count == 0)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (SoundClip) but the AudioPlayer isn't setuped!");
                return;
            }


            PlayAudioClip(clip.GetClip, clip.GetVolume, clip.GetPitch.GetRandomValue());
        }

        public void PlayAudioLocalization(AudioLocalization audioLocalization)
        {
            if(audioLocalization == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (AudioLocalization) but the audioLocalization is null!");
                return;
            }

            if(currentSettings == null || audioSources.Count == 0)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (AudioLocalization) but the audio player isn't setuped!");
                return;
            }

            if(currentSettings.GetLocalizationLanguage == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (AudioLocalization) but the audio player setting has no localization language!");
                return;
            }
            
            AudioLocalization.AudioLocalizationElement audioLocalizationElement = audioLocalization.GetAudioLocalizationElement(currentSettings.GetLocalizationLanguage.Value);

            if(audioLocalizationElement != null)
                PlayAudioClip(audioLocalizationElement.GetClip, audioLocalizationElement.GetVolume, audioLocalizationElement.GetPitch.GetRandomValue());
        }
        
        public void PlayAudioClip(AudioClip clip, float volume, float pitch)
        {
            if(clip == null)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (AudioClip) but the clip is null!");
                return;
            }

            if(currentSettings == null || audioSources.Count == 0)
            {
                Debug.LogError("(SimpleAudioPlayer)" + gameObject.name + " you try to play a (AudioClip) but the audio player isn't setuped!");
                return;
            }

            switch(currentSettings.GetPlaymode)
            {
                case AudioPlayerSettings.Playmodes.SingleOutput:
                    if(playNextSoundClipOfPlaylistCoroutine != null)
                        StopCoroutine(playNextSoundClipOfPlaylistCoroutine);
                    
                    audioSources[0].clip = clip;
                    audioSources[0].volume = volume;
                    audioSources[0].pitch = pitch;

                    audioSources[0].Play();

                    if(isPlayingPlaylist)
                        playNextSoundClipOfPlaylistCoroutine = StartCoroutine(PlayNextSoundClipOfPlaylist(clip.length));
                    break;

                case AudioPlayerSettings.Playmodes.SingleOutputWithCrossfade:
                    if(crossfadeCoroutine != null)
                        StopCoroutine(crossfadeCoroutine);

                    if(playNextSoundClipOfPlaylistCoroutine != null)
                        StopCoroutine(playNextSoundClipOfPlaylistCoroutine);

                    crossfadeCoroutine = StartCoroutine(PlayClipWithCrossfade(clip, volume, pitch));

                    if(isPlayingPlaylist)
                        playNextSoundClipOfPlaylistCoroutine = StartCoroutine(PlayNextSoundClipOfPlaylist(clip.length - currentSettings.GetFadingTimeInSeconds));
                    break;

                case AudioPlayerSettings.Playmodes.MultiOutput:
                    AudioSource freeAudioSource = null;

                    for(int i = 0; i < audioSources.Count; i++)
                    {
                        if (!audioSources[i].isPlaying)
                            freeAudioSource = audioSources[i];
                    }

                    if(freeAudioSource == null)
                    {
                        freeAudioSource = CreateAudioSource();
                        audioSources.Add(freeAudioSource);
                    }

                    freeAudioSource.clip = clip;
                    freeAudioSource.volume = volume;
                    freeAudioSource.pitch = pitch;

                    freeAudioSource.Play();

                    break;
            }
        }

        public void StopPlayingAllClips()
        {
            isPlayingPlaylist = false;

            if(playNextSoundClipOfPlaylistCoroutine != null)
                StopCoroutine(playNextSoundClipOfPlaylistCoroutine);

            for (int i = 0; i < audioSources.Count; i++)
            {
                audioSources[i].Stop();
                audioSources[i].clip = null;
                audioSources[i].volume = 0.0f;
                audioSources[i].pitch = 1.0f;
            }
        }

        // Helper function
        AudioSource CreateAudioSource()
        {
            AudioSource audioSource = gameObject.AddComponent<AudioSource>();
            audioSource.outputAudioMixerGroup = currentSettings.GetAudioMixerGroup;
            audioSource.playOnAwake = false;
            audioSource.loop = false;
            audioSource.clip = null;
            audioSource.volume = 0.0f;
            audioSource.pitch = 1.0f;

            return audioSource;
        }

        IEnumerator PlayClipWithCrossfade(AudioClip clip, float volume, float pitch)
        {
            AudioSource oldAudioSource = audioSources[currentMainAudioSourceId];
            currentMainAudioSourceId = (currentMainAudioSourceId + 1) % 2;
            AudioSource newAudioSource = audioSources[currentMainAudioSourceId];

            newAudioSource.clip = clip;
            newAudioSource.volume = 0.0f;
            newAudioSource.pitch = pitch;
            
            newAudioSource.Play();
            
            float remainingFadeTime = currentSettings.GetFadingTimeInSeconds;

            float oldVolumeChangePerSecond = oldAudioSource.volume / currentSettings.GetFadingTimeInSeconds;
            float newVolumeChangePerSecond = volume / currentSettings.GetFadingTimeInSeconds;

            while (remainingFadeTime > 0.0f)
            {
                oldAudioSource.volume -= Time.unscaledDeltaTime * oldVolumeChangePerSecond;
                newAudioSource.volume += Time.unscaledDeltaTime * newVolumeChangePerSecond;

                remainingFadeTime -= Time.unscaledDeltaTime;
                yield return null;
            }

            newAudioSource.volume = volume;

            oldAudioSource.Stop();
            oldAudioSource.clip = null;
            oldAudioSource.volume = 0.0f;
            oldAudioSource.pitch = 1.0f;
        }

        IEnumerator PlayNextSoundClipOfPlaylist(float waitTime)
        {
            yield return new WaitForSecondsRealtime(waitTime);

            if(isPlayingPlaylist)
                PlaySoundClip(currentPlaylist.GetNextClip());
        }
    }
}