CWE-ou-minkata/Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//                                                                          //
//  plEAXEffects - Various classes and wrappers to support EAX              //
//                  acceleration.                                           //
//                                                                          //
//////////////////////////////////////////////////////////////////////////////

#ifndef _plEAXEffects_h
#define _plEAXEffects_h


#include "HeadSpin.h"
#include "hsTemplates.h"


//// Listener Settings Class Definition ///////////////////////////////////////

class plDSoundBuffer;
class plEAXListenerMod;

#ifdef EAX_SDK_AVAILABLE
typedef struct _EAXREVERBPROPERTIES EAXREVERBPROPERTIES;
#else
#include "plEAXStructures.h"
#endif

#if HS_BUILD_FOR_WIN32
    typedef struct _GUID GUID;
#else
    typedef char* GUID;
#endif

class plEAXListener 
{   
public:
    ~plEAXListener();
    static plEAXListener    &GetInstance( void );

    bool    Init( void );
    void    Shutdown( void );

    bool SetGlobalEAXProperty(GUID guid, unsigned long ulProperty, void *pData, unsigned long ulDataSize );
    bool GetGlobalEAXProperty(GUID guid, unsigned long ulProperty, void *pData, unsigned long ulDataSize );
    
    void    ProcessMods( hsTArray<plEAXListenerMod *> &modArray );
    void    ClearProcessCache( void );

protected:
    plEAXListener();
    void    IFail( bool major );
    void    IFail( const char *msg, bool major );
    void    IRelease( void );

    void    IMuteProperties( EAXREVERBPROPERTIES *props, float percent );

    bool                fInited;
    
    // Cache info
    int32_t               fLastModCount;
    bool                fLastWasEmpty;
    float            fLastSingleStrength;
    plEAXListenerMod    *fLastBigRegion;

};

//// Soft Buffer Settings Class Definition ////////////////////////////////////
//  Used to hold buffer settings that will be attenuated by a soft volume,
//  to make the main settings class a bit cleaner

class hsStream;
class plEAXSourceSoftSettings
{
public:
        int16_t       fOcclusion;
        float    fOcclusionLFRatio, fOcclusionRoomRatio, fOcclusionDirectRatio;

        void        Read( hsStream *s );
        void        Write( hsStream *s );

        void        SetOcclusion( int16_t occ, float lfRatio, float roomRatio, float directRatio );
        int16_t       GetOcclusion( void ) const { return fOcclusion; }
        float    GetOcclusionLFRatio( void ) const { return fOcclusionLFRatio; }
        float    GetOcclusionRoomRatio( void ) const { return fOcclusionRoomRatio; }
        float    GetOcclusionDirectRatio( void ) const { return fOcclusionDirectRatio; }

        void        Reset( void );
};

//// Buffer Settings Class Definition /////////////////////////////////////////

class plEAXSource;

class plEAXSourceSettings
{
    public:
        plEAXSourceSettings();
        virtual ~plEAXSourceSettings();

        void    Read( hsStream *s );
        void    Write( hsStream *s );

        void    Enable( bool e );
        bool    IsEnabled( void ) const { return fEnabled; }

        void    SetRoomParams( int16_t room, int16_t roomHF, bool roomAuto, bool roomHFAuto );
        int16_t   GetRoom( void ) const   { return fRoom; }
        int16_t   GetRoomHF( void )  const  { return fRoomHF; }
        bool    GetRoomAuto( void ) const   { return fRoomAuto; }
        bool    GetRoomHFAuto( void ) const  { return fRoomHFAuto; }

        void    SetOutsideVolHF( int16_t vol );
        int16_t   GetOutsideVolHF( void ) const { return fOutsideVolHF; }

        void        SetFactors( float airAbsorption, float roomRolloff, float doppler, float rolloff );
        float    GetAirAbsorptionFactor( void ) const { return fAirAbsorptionFactor; }
        float    GetRoomRolloffFactor( void ) const { return fRoomRolloffFactor; }
        float    GetDopplerFactor( void ) const { return fDopplerFactor; }
        float    GetRolloffFactor( void ) const { return fRolloffFactor; }

        plEAXSourceSoftSettings &GetSoftStarts( void ) { return fSoftStarts; }
        plEAXSourceSoftSettings &GetSoftEnds( void ) { return fSoftEnds; }
        
        plEAXSourceSoftSettings &GetCurrSofts( void )  { return fCurrSoftValues; }

        void        SetOcclusionSoftValue( float value );
        float    GetOcclusionSoftValue( void ) const { return fOcclusionSoftValue; }

        void        ClearDirtyParams( void ) const { fDirtyParams = 0; }

    protected:
        friend class plEAXSource;
        friend class plEAXSourceSoftSettings;

        bool        fEnabled;
        int16_t       fRoom, fRoomHF;
        bool        fRoomAuto, fRoomHFAuto;
        int16_t       fOutsideVolHF;
        float    fAirAbsorptionFactor, fRoomRolloffFactor, fDopplerFactor, fRolloffFactor;
        plEAXSourceSoftSettings fSoftStarts, fSoftEnds, fCurrSoftValues;
        float    fOcclusionSoftValue;
        mutable uint32_t      fDirtyParams;

        enum ParamSets
        {
            kOcclusion      = 0x01,
            kRoom           = 0x02,
            kOutsideVolHF   = 0x04,
            kFactors        = 0x08,
            kAll            = 0xff
        };

        void    IRecalcSofts( uint8_t whichOnes );
};

//// Source Class Definition //////////////////////////////////////////////////

class plEAXSource
{
public:
    friend class plEAXSourceSettings;
    friend class plEAXSourceSoftSettings;

    plEAXSource();
    virtual ~plEAXSource();

    void    Init( plDSoundBuffer *parent );
    void    Release( void );
    bool    IsValid( void ) const;
    bool SetSourceEAXProperty(unsigned source, GUID guid, unsigned long ulProperty, void *pData, unsigned long ulDataSize);
    bool GetSourceEAXProperty(unsigned source, GUID guid, unsigned long ulProperty, void *pData, unsigned long ulDataSize);
    void    SetFrom(  plEAXSourceSettings *settings, unsigned source, bool force = false );

private:
    bool    fInit;
};

#endif //_plEAXEffects_h