Add functions to change sound effect parameters

Client/mods/deathmatch/logic/CBassAudio.cpp

@@ -843,6 +843,16 @@ void CBassAudio::ApplyFxEffects()
     }
 }
 
+BOOL CBassAudio::SetFxParameters(uint iFxEffect, void* params)
+{
+    return BASS_FXSetParameters(m_FxEffects[iFxEffect], params);
+}
+
+BOOL CBassAudio::GetFxParameters(uint iFxEffect, void* params)
+{
+    return BASS_FXGetParameters(m_FxEffects[iFxEffect], params);
+}
+
 //
 // Must be call every frame
 //

Client/mods/deathmatch/logic/CBassAudio.h

@@ -1,14 +1,13 @@
 /*****************************************************************************
  *
- *  PROJECT:     Multi Theft Auto v1.0
- *               (Shared logic for modifications)
+ *  PROJECT:     Multi Theft Auto
  *  LICENSE:     See LICENSE in the top level directory
- *  FILE:
- *  PURPOSE:
+ *
+ *  Multi Theft Auto is available from http://www.multitheftauto.com/
  *
  *****************************************************************************/
 
-#define CUT_OFF 5.0f //Cut off point at which volume is regarded as 0 in the function e^-x
+#define CUT_OFF 5.0f            // Cut off point at which volume is regarded as 0 in the function e^-x
 
 enum eSoundEventType
 {
@@ -76,6 +75,8 @@ class CBassAudio
     bool    GetPanEnabled() { return m_bPan; };
     void    SetPanEnabled(bool bPan) { m_bPan = bPan; };
     void    SetFxEffects(int* pEnabledEffects, uint iNumElements);
+    BOOL    SetFxParameters(uint iFxEffect, void* params);
+    BOOL    GetFxParameters(uint iFxEffect, void* params);
     SString GetMetaTags(const SString& strFormat);
     uint    GetReachedEndCount();
     bool    IsFreed();

Client/mods/deathmatch/logic/CClientPlayerVoice.h

@@ -72,6 +72,7 @@ class CClientPlayerVoice
 
     bool SetFxEffect(uint uiFxEffect, bool bEnable);
     bool IsFxEffectEnabled(uint uiFxEffect);
+
     bool IsActive() { return m_bVoiceActive; }
 
 private:

Client/mods/deathmatch/logic/CClientSound.cpp

@@ -13,7 +13,7 @@
 CClientSound::CClientSound(CClientManager* pManager, ElementID ID) : ClassInit(this), CClientEntity(ID)
 {
     m_pSoundManager = pManager->GetSoundManager();
-    m_pAudio = NULL;
+    m_pAudio = nullptr;
 
     SetTypeName("sound");
 
@@ -26,7 +26,7 @@ CClientSound::CClientSound(CClientManager* pManager, ElementID ID) : ClassInit(t
     m_bPan = true;
     m_fPan = 0.0f;
 
-    m_pBuffer = NULL;
+    m_pBuffer = nullptr;
     m_uiFrameNumberCreated = g_pClientGame->GetFrameCount();
 }
 
@@ -643,6 +643,30 @@ bool CClientSound::IsFxEffectEnabled(uint uiFxEffect)
     return m_EnabledEffects[uiFxEffect] ? true : false;
 }
 
+bool CClientSound::SetFxEffectParameters(uint uiFxEffect, void* params)
+{
+    if (uiFxEffect >= NUMELMS(m_EnabledEffects))
+        return false;
+
+    if (m_pAudio)
+        if (m_pAudio->SetFxParameters(uiFxEffect, params))
+            return true;
+
+    return false;
+}
+
+bool CClientSound::GetFxEffectParameters(uint uiFxEffect, void* params)
+{
+    if (uiFxEffect >= NUMELMS(m_EnabledEffects))
+        return false;
+
+    if (m_pAudio)
+        if (m_pAudio->GetFxParameters(uiFxEffect, params))
+            return true;
+
+    return false;
+}
+
 ////////////////////////////////////////////////////////////
 //
 // CClientSound::Process3D
@@ -726,7 +750,7 @@ void CClientSound::Process3D(const CVector& vecPlayerPosition, const CVector& ve
         }
         else if (eventInfo.type == SOUND_EVENT_STREAM_RESULT)
         {
-            // Call onClientSoundStream LUA event
+            // Call onClientSoundStream Lua event
             CLuaArguments Arguments;
             Arguments.PushBoolean(eventInfo.bBool);
             Arguments.PushNumber(eventInfo.dNumber);

Client/mods/deathmatch/logic/CClientSound.h

@@ -82,6 +82,9 @@ class CClientSound final : public CClientEntity
 
     bool SetFxEffect(uint uiFxEffect, bool bEnable);
     bool IsFxEffectEnabled(uint uiFxEffect);
+
+    bool SetFxEffectParameters(uint uiFxEffect, void* params);
+    bool GetFxEffectParameters(uint uiFxEffect, void* params);
 
     void Unlink(){};
 

Client/mods/deathmatch/logic/lua/CLuaFunctionParseHelpers.cpp

@@ -667,6 +667,97 @@ ADD_ENUM(eClientModelType::OBJECT, "object")
 ADD_ENUM(eClientModelType::VEHICLE, "vehicle")
 IMPLEMENT_ENUM_CLASS_END("client-model-type")
 
+// Sound effects
+IMPLEMENT_ENUM_BEGIN(eSoundEffectType)
+ADD_ENUM(BASS_FX_DX8_CHORUS, "chorus")
+ADD_ENUM(BASS_FX_DX8_COMPRESSOR, "compressor")
+ADD_ENUM(BASS_FX_DX8_DISTORTION, "distortion")
+ADD_ENUM(BASS_FX_DX8_ECHO, "echo")
+ADD_ENUM(BASS_FX_DX8_FLANGER, "flanger")
+ADD_ENUM(BASS_FX_DX8_GARGLE, "gargle")
+ADD_ENUM(BASS_FX_DX8_I3DL2REVERB, "i3dl2reverb")
+ADD_ENUM(BASS_FX_DX8_PARAMEQ, "parameq")
+ADD_ENUM(BASS_FX_DX8_REVERB, "reverb")
+IMPLEMENT_ENUM_END("soundeffect-type")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Chorus)
+ADD_ENUM(eSoundEffectParams::Chorus::WET_DRY_MIX, "wetDryMix")
+ADD_ENUM(eSoundEffectParams::Chorus::DEPTH, "depth")
+ADD_ENUM(eSoundEffectParams::Chorus::FEEDBACK, "feedback")
+ADD_ENUM(eSoundEffectParams::Chorus::FREQUENCY, "frequency")
+ADD_ENUM(eSoundEffectParams::Chorus::WAVEFORM, "waveform")
+ADD_ENUM(eSoundEffectParams::Chorus::DELAY, "delay")
+ADD_ENUM(eSoundEffectParams::Chorus::PHASE, "phase")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-chorus")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Compressor)
+ADD_ENUM(eSoundEffectParams::Compressor::GAIN, "gain")
+ADD_ENUM(eSoundEffectParams::Compressor::ATTACK, "attack")
+ADD_ENUM(eSoundEffectParams::Compressor::RELEASE, "release")
+ADD_ENUM(eSoundEffectParams::Compressor::THRESHOLD, "threshold")
+ADD_ENUM(eSoundEffectParams::Compressor::RATIO, "ratio")
+ADD_ENUM(eSoundEffectParams::Compressor::PREDELAY, "predelay")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-compressor")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Distortion)
+ADD_ENUM(eSoundEffectParams::Distortion::GAIN, "gain")
+ADD_ENUM(eSoundEffectParams::Distortion::EDGE, "edge")
+ADD_ENUM(eSoundEffectParams::Distortion::POST_EQ_CENTER_FREQUENCY, "postEQCenterFrequency")
+ADD_ENUM(eSoundEffectParams::Distortion::POST_EQ_BANDWIDTH, "postEQBandwidth")
+ADD_ENUM(eSoundEffectParams::Distortion::PRE_LOWPASS_CUTOFF, "preLowpassCutoff")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-distortion")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Echo)
+ADD_ENUM(eSoundEffectParams::Echo::WET_DRY_MIX, "wetDryMix")
+ADD_ENUM(eSoundEffectParams::Echo::FEEDBACK, "feedback")
+ADD_ENUM(eSoundEffectParams::Echo::LEFT_DELAY, "leftDelay")
+ADD_ENUM(eSoundEffectParams::Echo::RIGHT_DELAY, "rightDelay")
+ADD_ENUM(eSoundEffectParams::Echo::PAN_DELAY, "panDelay")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-echo")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Flanger)
+ADD_ENUM(eSoundEffectParams::Flanger::WET_DRY_MIX, "wetDryMix")
+ADD_ENUM(eSoundEffectParams::Flanger::DEPTH, "depth")
+ADD_ENUM(eSoundEffectParams::Flanger::FEEDBACK, "feedback")
+ADD_ENUM(eSoundEffectParams::Flanger::FREQUENCY, "frequency")
+ADD_ENUM(eSoundEffectParams::Flanger::WAVEFORM, "waveform")
+ADD_ENUM(eSoundEffectParams::Flanger::DELAY, "delay")
+ADD_ENUM(eSoundEffectParams::Flanger::PHASE, "phase")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-flanger")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Gargle)
+ADD_ENUM(eSoundEffectParams::Gargle::RATE_HZ, "rateHz")
+ADD_ENUM(eSoundEffectParams::Gargle::WAVE_SHAPE, "waveShape")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-gargle")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::I3DL2Reverb)
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::ROOM, "room")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::ROOM_HF, "roomHF")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::ROOM_ROLLOFF_FACTOR, "roomRolloffFactor")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::DECAY_TIME, "decayTime")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::DECAY_HF_RATIO, "decayHFRatio")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::REFLECTIONS, "reflections")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::REFLECTIONS_DELAY, "reflectionsDelay")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::REVERB, "reverb")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::REVERB_DELAY, "reverbDelay")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::DIFFUSION, "diffusion")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::DENSITY, "density")
+ADD_ENUM(eSoundEffectParams::I3DL2Reverb::HF_REFERENCE, "HFReference")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-i3dl2reverb")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::ParamEq)
+ADD_ENUM(eSoundEffectParams::ParamEq::CENTER, "center")
+ADD_ENUM(eSoundEffectParams::ParamEq::BANDWIDTH, "bandwidth")
+ADD_ENUM(eSoundEffectParams::ParamEq::GAIN, "gain")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-parameq")
+
+IMPLEMENT_ENUM_CLASS_BEGIN(eSoundEffectParams::Reverb)
+ADD_ENUM(eSoundEffectParams::Reverb::IN_GAIN, "inGain")
+ADD_ENUM(eSoundEffectParams::Reverb::REVERB_MIX, "reverbMix")
+ADD_ENUM(eSoundEffectParams::Reverb::REVERB_TIME, "reverbTime")
+ADD_ENUM(eSoundEffectParams::Reverb::HIGH_FREQ_RT_RATIO, "highFreqRTRatio")
+IMPLEMENT_ENUM_CLASS_END("soundeffect-params-reverb")
+
 //
 // Get best guess at name of userdata type
 //

Client/mods/deathmatch/logic/lua/CLuaFunctionParseHelpers.h

@@ -66,6 +66,16 @@ DECLARE_ENUM(eSurfaceWheelEffect);
 DECLARE_ENUM(eSurfaceSkidMarkType);
 DECLARE_ENUM(eSurfaceAdhesionGroup);
 DECLARE_ENUM_CLASS(eClientModelType);
+DECLARE_ENUM(eSoundEffectType);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Chorus);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Compressor);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Distortion);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Echo);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Flanger);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Gargle);
+DECLARE_ENUM_CLASS(eSoundEffectParams::I3DL2Reverb);
+DECLARE_ENUM_CLASS(eSoundEffectParams::ParamEq);
+DECLARE_ENUM_CLASS(eSoundEffectParams::Reverb);
 
 class CRemoteCall;
 
@@ -455,6 +465,46 @@ inline SString GetClassByTypeName(eObjectGroup::BreakMode*)
 {
     return "objectgroup-breakmode";
 }
+inline SString GetClassTypeName(eSoundEffectType*)
+{
+    return "soundeffect-type";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Chorus*)
+{
+    return "soundeffect-params-chorus";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Compressor*)
+{
+    return "soundeffect-params-compressor";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Distortion*)
+{
+    return "soundeffect-params-distortion";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Echo*)
+{
+    return "soundeffect-params-echo";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Flanger*)
+{
+    return "soundeffect-params-flanger";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Gargle*)
+{
+    return "soundeffect-params-gargle";
+}
+inline SString GetClassTypeName(eSoundEffectParams::I3DL2Reverb*)
+{
+    return "soundeffect-params-i3dl2reverb";
+}
+inline SString GetClassTypeName(eSoundEffectParams::ParamEq*)
+{
+    return "soundeffect-params-parameq";
+}
+inline SString GetClassTypeName(eSoundEffectParams::Reverb*)
+{
+    return "soundeffect-params-reverb";
+}
 
 inline SString GetClassByTypeName(eClientModelType)
 {