MusicPlayer.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "MusicPlayer.generated.h"
 
#define MAX_FADE_TIME_SECONDS 10.0f
#define MIN_CLIP_LENGTH_SECONDS 2.0f
 
class USoundBase;
class UAudioComponent;
class USoundWave;
 
USTRUCT(Blueprintable)
struct FTrackPlayInfo
{
    GENERATED_USTRUCT_BODY()
 
    /* The track to play */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite)
    USoundBase* Track = nullptr;
    /* Time taken to fade in this track */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "10.0"))
    float FadeInTime = 1.0f;
    /* If a track is currently playing, this is the time taken to fade it out */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "10.0"))
    float FadeOutOldTrackTime = 1.0f;
    /* Volume to play this track at */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "1.0"))
    float Volume = 1.0f;
    /* The music player will begin playing music from it's tracklist (if there are any in its list) after this track completes. This will also prevent queued tracks from playing if false */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite)
    bool bPlayTrackListAfterTrackCompletion = true;
    /* Should we wait after playing this track before playing the next? */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, meta = (EditCondition="bPlayTrackListAfterTrackCompletion"))
    FVector2D PostTrackDelay = FVector2D(0.0f, 0.0f);
    /* The music player will wait for the current track to finish playing before this track begins. */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite)
    bool bQueueTrack = true;
    /* Should we keep this track in the tracklist after playing or is this a one-shot? Be aware that SetTrackList clobbers this. */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite)
    bool bDiscardTrackAfterPlay = false;
 
    float CalculatedPostTrackDelay = 0.0f;
 
    void operator=(const FTrackPlayInfo& Other)
    {
        Track = Other.Track;
        FadeInTime = Other.FadeInTime;
        FadeOutOldTrackTime = Other.FadeOutOldTrackTime;
        Volume = Other.Volume;
        bPlayTrackListAfterTrackCompletion = Other.bPlayTrackListAfterTrackCompletion;
        bQueueTrack = Other.bQueueTrack;
        bDiscardTrackAfterPlay = Other.bDiscardTrackAfterPlay;
        PostTrackDelay = Other.PostTrackDelay;
    }
 
    bool IsValid() const;
 
};
 
UCLASS()
class PROJECTX_API AMusicPlayer : public AActor
{
    GENERATED_BODY()
    
public: 
    AMusicPlayer();
 
    UFUNCTION(BlueprintPure, meta = (WorldContext = "WorldContextObject"))
    static AMusicPlayer* GetMusicPlayer(const UObject* WorldContextObject);
    /* Play the specified track using the following settings */
    UFUNCTION(BlueprintCallable)
    void Play(const FTrackPlayInfo& Track);
    /* Stop Playing Music */
    UFUNCTION(BlueprintCallable)
    void Stop(float FadeOutTime = 1.0f);
    UFUNCTION(BlueprintCallable)
    void Resume(float FadeInTime = 1.0f);
    /* Modifies the tracklist and controls whether to immediately switch to a new tracklist or wait for the current track to complete. Use bShuffleTracks to determine whether to shuffle or play in sequence. */
    UFUNCTION(BlueprintCallable)
    void SetTrackList(const TArray<FTrackPlayInfo>& ListOfTracks, bool bShuffleTracks = true, bool bPlayTrack = true, bool bWaitForTrackToCompleteBeforeSwitching = true);
    UFUNCTION(BlueprintCallable)
    void PlayNextTrack();
 
    FString GetCurrentTrackInfo() const;
 
protected:
    virtual void BeginPlay() override;
    virtual void Tick(float DeltaSeconds) override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
    UFUNCTION()
    void OnTrack1PlaybackPercentChanged(const class USoundWave* PlayingSoundWave, const float PlaybackPercent);
    UFUNCTION()
    void OnTrack2PlaybackPercentChanged(const class USoundWave* PlayingSoundWave, const float PlaybackPercent);
 
    /* The singleton is stored as map because when testing in editor you could have multiple worlds and players.
       This ensures it all runs cleanly per client */
    static TMap<UWorld*, AMusicPlayer*> Singleton;
 
    float GetRemainingTimeForTrack(UAudioComponent* const AudioComponent) const;
    float GetCurrentPlayTimeForTrack(UAudioComponent* const AudioComponent) const;
    float GetDurationForTrack(UAudioComponent* const AudioComponent) const;
    UAudioComponent* GetInactiveAudioComponent() const;
    UAudioComponent* GetActiveAudioComponent() const;
 
    UPROPERTY()
    UAudioComponent* MusicTrack1 = nullptr;
    UPROPERTY()
    UAudioComponent* MusicTrack2 = nullptr;
 
    UAudioComponent* ActiveAudioComponent = nullptr;
 
    bool bShuffle = true;
    int32 CurrentTrackIndex = 0;
    TArray<FTrackPlayInfo> Tracklist;
    FTrackPlayInfo CurrentTrack; //Specifically not a reference incase the tracklist gets clobbered
 
    float Track1CurrentPlaybackTime = 0.0f;
    float Track1CurrentTrackLength = 0.0f;
    float Track2CurrentPlaybackTime = 0.0f;
    float Track2CurrentTrackLength = 0.0f;
};