SoundScape.h

/*
 * Copyright (c) 2024 Vera Visions LLC.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
enumflags
{
    SOUNDSCAPE_ORIGIN,
    SOUNDSCAPE_REVERB,
    SOUNDSCAPE_DECAY,
    SOUNDSCAPE_REFLECTION,
    SOUNDSCAPE_LATE,
    SOUNDSCAPE_ECHO,
    SOUNDSCAPE_MODULATION,
    SOUNDSCAPE_MISC
};

class
ncSoundScape:ncPointTrigger
{
public:
    void ncSoundScape(void);
 
    /* overrides */
    
 
#ifdef SERVER
    nonvirtual void SetDensity(float);
    nonvirtual void SetDiffusion(float);
    nonvirtual void SetGain(float);
    nonvirtual void SetGainHF(float);
    nonvirtual void SetGainLF(float);
    nonvirtual void SetDecayTime(float);
    nonvirtual void SetDecayHFRatio(float);
    nonvirtual void SetDecayLFRatio(float);
    nonvirtual void SetReflectionGain(float);
    nonvirtual void SetReflectionDelay(float);
    nonvirtual void SetReflectionPan(vector);
    nonvirtual void SetLateGain(float);
    nonvirtual void SetLateDelay(float);
    nonvirtual void SetLatePan(vector);
    nonvirtual void SetEchoTime(float);
    nonvirtual void SetEchoDepth(float);
    nonvirtual void SetModulationTime(float);
    nonvirtual void SetModulationDepth(float);
    nonvirtual void SetAirAbsorptionGainHF(float);
    nonvirtual void SetHFReference(float);
    nonvirtual void SetLFReference(float);
    nonvirtual void SetRoomRolloffFactor(float);
    nonvirtual void SetDecayHFLimit(int);

    nonvirtual void SetRadius(float);
#endif
 
#ifdef CLIENT
    nonvirtual float GetDensity(void);
    nonvirtual float GetDiffusion(void);
    nonvirtual float GetGain(void);
    nonvirtual float GetGainHF(void);
    nonvirtual float GetGainLF(void);
    nonvirtual float GetDecayTime(void);
    nonvirtual float GetDecayHFRatio(void);
    nonvirtual float GetDecayLFRatio(void);
    nonvirtual float GetReflectionGain(void);
    nonvirtual float GetReflectionDelay(void);
    nonvirtual vector GetReflectionPan(void);
    nonvirtual float GetLateGain(void);
    nonvirtual float GetLateDelay(void);
    nonvirtual vector GetLatePan(void);
    nonvirtual float GetEchoTime(void);
    nonvirtual float GetEchoDepth(void);
    nonvirtual float GetModulationTime(void);
    nonvirtual float GetModulationDepth(void);
    nonvirtual float GetAirAbsorptionGainHF(void);
    nonvirtual float GetHFReference(void);
    nonvirtual float GetLFReference(void);
    nonvirtual float GetRoomRolloffFactor(void);
    nonvirtual int GetDecayHFLimit(void);
    nonvirtual float GetRadius(void);
#endif
 
 
#ifdef SERVER
    virtual void SpawnKey(string, string);
    virtual void Input(entity,string, string);
    virtual void EvaluateEntity(void);
    virtual float SendEntity(entity, float);
    virtual void Save(float);
    virtual void Restore(string,string);
#endif
 
    nonvirtual bool LoadFromEFX(string);
 
#ifdef CLIENT
    virtual void DebugDraw(void);
    virtual void ReceiveEntity(float, float);
    nonvirtual void SetupEFXReverb(reverbinfo_t *);
#endif
 
 
private:
    NETWORKED_FLOAT(m_density)
    NETWORKED_FLOAT(m_diffusion)
    NETWORKED_FLOAT(m_gain)
    NETWORKED_FLOAT(m_gainHF)
    NETWORKED_FLOAT(m_gainLF)
    NETWORKED_FLOAT(m_decayTime)
    NETWORKED_FLOAT(m_decayHFRatio)
    NETWORKED_FLOAT(m_decayLFRatio)
    NETWORKED_FLOAT(m_reflectionGain)
    NETWORKED_FLOAT(m_reflectionDelay)
    NETWORKED_VECTOR(m_reflectionPan)
    NETWORKED_FLOAT(m_LateGain)
    NETWORKED_FLOAT(m_LateDelay)
    NETWORKED_VECTOR(m_LatePan)
    NETWORKED_FLOAT(m_echoTime)
    NETWORKED_FLOAT(m_echoDepth)
    NETWORKED_FLOAT(m_modulationTime)
    NETWORKED_FLOAT(m_modulationDepth)
    NETWORKED_FLOAT(m_airAbsorptionGainHF)
    NETWORKED_FLOAT(m_HFReference)
    NETWORKED_FLOAT(m_LFReference)
    NETWORKED_FLOAT(m_roomRolloffFactor)
    NETWORKED_INT(m_decayHFLimit)
    NETWORKED_FLOAT(m_radius)
};

 // end of decl_efx
 
#ifdef CLIENT
void EFX_UpdateSoundScape(ncSoundScape);
#endif