Audio3d.h

Go to the documentation of this file.

#pragma once
 
#include "Nodes/3D/Node3d.h"
 
#include "Assets/SoundWave.h"
 
class POLYPHASE_API Audio3D : public Node3D
{
public:
 
    DECLARE_NODE(Audio3D, Node3D);
 
    Audio3D();
    ~Audio3D();
 
    virtual const char* GetTypeName() const override;
    virtual void GatherProperties(std::vector<Property>& outProps) override;
    virtual void GatherProxyDraws(std::vector<DebugDraw>& inoutDraws) override;
 
    virtual void Create() override;
    virtual void Destroy() override;
    virtual void Start() override;
    virtual void Tick(float deltaTime) override;
    virtual void EditorTick(float deltaTime) override;
 
    void SetSoundWave(SoundWave* soundWave);
    SoundWave* GetSoundWave();
 
    void SetInnerRadius(float innerRadius);
    float GetInnerRadius() const;
 
    void SetOuterRadius(float outerRadius);
    float GetOuterRadius() const;
 
    void SetVolume(float volume);
    float GetVolume() const;
 
    void SetPitch(float pitch);
    float GetPitch() const;
 
    void SetStartOffset(float startOffset);
    float GetStartOffset() const;
 
    void SetPriority(int32_t priority);
    int32_t GetPriority() const;
 
    void SetAttenuationFunc(AttenuationFunc func);
    AttenuationFunc GetAttenuationFunc() const;
 
    void SetAudioClass(int8_t audioClass);
    int8_t GetAudioClass() const;
 
    void SetLoop(bool loop);
    bool GetLoop() const;
 
    void SetAutoPlay(bool autoPlay);
    bool GetAutoPlay() const;
 
    float GetPlayTime() const;
    // Duration of the assigned SoundWave in seconds (0 if no wave).
    float GetDuration() const;
    // Current play position as [0, 1] of the assigned wave's duration. Looping wraps via fmod,
    // non-looping clamps at 1.0. Returns 0 when there's no wave or duration is 0.
    float GetPlayTimeNormalized() const;
    bool IsPlaying() const;
    bool IsAudible() const;
 
    void Play();
    void Stop();
    void Pause();
 
    // Old methods kept for script compatibility; these do the same thing as the above Play/Pause/Stop.
    void PlayAudio();
    void PauseAudio();
    void StopAudio();
    void ResetAudio();
 
 
    void PlayAudio(SoundWave* soundWave, bool loop);
 
    // One-shot 3D voice at this node's world position, using its inner/outer radius
    // and attenuation curve. Pass volume < 0 / pitch < 0 to inherit this node's
    // current values (default). Does not loop.
    void PlayOneShot(SoundWave* soundWave, float volume = -1.0f, float pitch = -1.0f, int priority = 0);
 
    // Seek playback to an absolute time in seconds. If a voice is currently bound it is
    // released; the next AudioManager tick re-spawns it at the new cursor (or stays silent
    // until PlayAudio() if the node is paused). Cursor wraps via mod against duration.
    void Seek(float seconds);
    // Seek to a [0, 1] fraction of the assigned wave's duration. Drop-in for slider scrubbing.
    void SeekNormalized(float t);
 
    // Audio analysis — wraps AUD_Get* on this node's currently-bound voice.
    // All return 0 / zero-fill when the node isn't currently audible.
    float GetRMS() const;
    float GetLoudness() const;
    float GetLoudnessDb() const;
    float GetFrequencies(float startHz, float endHz) const;
    void  GetSpectrum(float startHz, float endHz, float* outBins, uint32_t numBins) const;
 
    void NotifyAudible(bool audible);
 
    // Called by AudioManager when this node's voice plays to its natural end (non-looping).
    // Emits the "OnFinished" signal and invokes the script's OnFinished() callback.
    void OnSoundFinished();
 
    static bool HandlePropChange(Datum* datum, uint32_t index, const void* newValue);
 
protected:
 
    void TickCommon(float deltaTime);
 
    // Properties
    SoundWaveRef mSoundWave;
    float mInnerRadius = 0.0f;
    float mOuterRadius = 15.0f;
    float mVolume = 1.0f;
    float mPitch = 1.0f;
    float mStartOffset = 0.0f;
    int32_t mPriority = 0;
    AttenuationFunc mAttenuationFunc = AttenuationFunc::Linear;
    int8_t mAudioClass = -1;
    bool mLoop = false;
    bool mAutoPlay = false;
 
    // State
    float mPlayTime = 0.0f;
    bool mPlaying = false;
    bool mAudible = false;
};