GxUnitSound.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================
#pragma once
 
GX_SOUND_NAMESPACE_BEGIN()
 
//===========================================================================
//===========================================================================
class GxUnitSound : public GxUnitLocate
{
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
#if defined(_WINDOWS) || defined(_XBOX_XS)
    class GxVoiceCallback : public IXAudio2VoiceCallback
    {
        //-------------------------------------------------------------
        //-------------------------------------------------------------
    public:
        GxVoiceCallback(GxUnitSound* pOwner)
        : _pOwner(pOwner)
        {
        }
        ~GxVoiceCallback(void) { }
 
        //-----------------------------------------------------------
        //-----------------------------------------------------------
 
        GX_FORCE_INLINE void OnStreamEnd(void) { _pOwner->stop(); }
        
        // Called just before this voice's processing pass begins.
        void OnVoiceProcessingPassStart(u32 /*SamplesRequired*/) override {}
        // Called just after this voice's processing pass ends.
        void OnVoiceProcessingPassEnd(void) override {}
        // Called when this voice is about to start processing a new buffer.
        void OnBufferStart(void* /*pBufferContext*/) override {}
        // Called when this voice has just finished processing a buffer.
        // The buffer can now be reused or destroyed.
        void OnBufferEnd(void* /*pBufferContext*/) override {}
        // Called when this voice has just reached the end position of a loop.
        void OnLoopEnd(void* /*pBufferContext*/) override {}
        // Called in the event of a critical error during voice processing,
        // such as a failing xAPO or an error from the hardware XMA decoder.
        // The voice may have to be destroyed and re-created to recover from
        // the error.  The callback arguments report which buffer was being
        // processed when the error occurred, and its HRESULT code.
        void OnVoiceError(void* /*pBufferContext*/, HRESULT error) override { GX_ERROR(false, "GxUnitSound error(0x%x)", error); }
 
        //-----------------------------------------------------------
        //-----------------------------------------------------------
    private:
        GxUnitSound* _pOwner;
 
    };
#endif //_WINDOWS || _XBOX_XS
 
    static constexpr u32 SRC_CHANNEL_MAX = static_cast<u32>(GxSysSoundBase::CHANNEL_COUNT::MAX);    
    static constexpr u32 DST_CHANNEL_MAX = SRC_CHANNEL_MAX;     
    static constexpr f32 PAN_INVALID_VALUE = -1.1f;             
 
    enum class EFFECT
    {
        ECHO,               
        EQ,                 
        MASTERING_LIMITER,  
        REVERB,             
        MAX,                
    };
 
    // RTTI宣言
    GX_RTTI_CLASS_ICON(GxUnitSound, GxUnitLocate, GxRtti::ICON_TYPE::UNIT_SOUND)
    // GxClassBaseReference継承クラス用禁止宣言
    GX_PROHIBIT_CLASS_BASE_REFERENCE(GxUnitSound)
 
    
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    GxUnitSound(void);
    void cleanup(void) override;
private:
#if defined(_WINDOWS) || defined(_XBOX_XS)
    b32 initializeX3dAudio(u32 channelCount);
#endif //_WINDOWS || _XBOX_XS
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    void asyncUpdate(void) override;
    void render(void) override;
    void play(s32 loopCount = GxSysSound::LOOP_DEFAULT, f32 volume = 1.0f, f32 pitch = 1.0f, b32 is3D = true, f32 fadeTime = 0.f);
    void stop(f32 duration = 0);
#if defined(_WINDOWS) || defined(_XBOX_XS)
    void setEffect(const EFFECT* pEffects, void** ppEffectParameters, u32 count);
    void setEffectEnable(u32 index, b32 enable) const;
    FXECHO_PARAMETERS getDefaultEchoParameters(void) const;
    FXEQ_PARAMETERS getDefaultEqParameters(void) const;
    FXMASTERINGLIMITER_PARAMETERS getDefaultMasteringLimiterParameters(void) const;
    FXREVERB_PARAMETERS getDefaultReverbParameters(void) const;
#endif //_WINDOWS || _XBOX_XS
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    f32 getVolume(void) const;
    void setVolume(f32 volume);
    f32 getPitch(void) const;
    void setPitch(f32 pitch);
    void set3dConeParameter(f32 innerAngle, f32 outerAngle, f32 outerVolume);
    void set3dMinMaxAttenuationDistance(f32 min, f32 max);
    void setSoundResource(GxResSound* pResSound);
    constexpr f32 getPan(void) const { return _pan; }
    GX_FORCE_INLINE void setPan(f32 pan) { _is3D = (pan == PAN_INVALID_VALUE); _pan = pan; }
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
private:
    GxResSound*             _pResSound;             
    GxVector3               _positionBefore;        
    f32                     _matrixCoefficients[SRC_CHANNEL_MAX * DST_CHANNEL_MAX]; 
    f32                     _channelAzimuths[SRC_CHANNEL_MAX];                      
    b32                     _is3D;                  
    u32                     _streamingSetSize;      
    b32                     _isStreaming;           
    b32                     _isPlay;                
    f32                     _pan;                   
    f32                     _fadeTime;              
    f32                     _fadeTimeCount;         
#if defined(_WINDOWS) || defined(_XBOX_XS)
    GxVoiceCallback         _callback;              
    IXAudio2SourceVoice*    _pXAudio2SourceVoice;   
    X3DAUDIO_EMITTER        _x3dAudioEmitter;       
    X3DAUDIO_CONE           _x3dAudioCone;          
    X3DAUDIO_DISTANCE_CURVE _x3dAudioDistanceCurve; 
    X3DAUDIO_DISTANCE_CURVE_POINT   _x3dAudioDistanceCurvePoint[2]; 
    X3DAUDIO_DSP_SETTINGS   _x3dAudioDspSettings;   
#endif //_WINDOWS || _XBOX_XS
 
};
 
GX_SOUND_NAMESPACE_END()