C4SoundModifierEcho Class Reference

#include <C4SoundModifiers.h>

Inheritance diagram for C4SoundModifierEcho:

Collaboration diagram for C4SoundModifierEcho:

Public Types
enum	Type {   C4SMT_None = 0x0 , C4SMT_Reverb = 0x1 , C4SMT_Echo = 0x4 , C4SMT_Equalizer = 0xc ,   C4SMT_Max = 0xc }

Public Member Functions
	C4SoundModifierEcho (C4PropList *in_props)
void	Update () override
void	Release ()
void	AddRef ()
void	DelRef ()
int32_t	GetRefCount () const
const C4PropList *	GetProps () const
void	ApplyTo (ALuint source)

Protected Member Functions
float	GetFloatProp (C4PropertyName key, float ratio, float default_value)
bool	GetBoolProp (C4PropertyName key, bool default_value)

Protected Attributes
ALuint	effect
ALuint	slot

Detailed Description

Definition at line 92 of file C4SoundModifiers.h.

Member Enumeration Documentation

Type

enum C4SoundModifier::Type

inherited

Enumerator
C4SMT_None
C4SMT_Reverb
C4SMT_Echo
C4SMT_Equalizer
C4SMT_Max

Definition at line 29 of file C4SoundModifiers.h.

    {
        C4SMT_None = 0x0,
        C4SMT_Reverb = 0x1,
        C4SMT_Echo = 0x4,
        C4SMT_Equalizer = 0xc,
        C4SMT_Max = 0xc // value of largest type
    };

Constructor & Destructor Documentation

C4SoundModifierEcho()

C4SoundModifierEcho::C4SoundModifierEcho

(

C4PropList *

in_props

)

Definition at line 146 of file C4SoundModifiers.cpp.

    : C4SoundModifier(in_props)
{
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    alEffecti(effect, AL_EFFECT_TYPE, AL_EFFECT_ECHO);
#endif
}

References C4SoundModifier::effect.

Member Function Documentation

AddRef()

void C4SoundModifier::AddRef ( )

inlineinherited

Definition at line 69 of file C4SoundModifiers.h.

{ ++instance_count; }

Referenced by C4SoundInstance::Create(), C4SoundModifierList::SetGlobalModifier(), and C4SoundInstance::SetModifier().

Here is the caller graph for this function:

ApplyTo()

void C4SoundModifier::ApplyTo ( ALuint  source )

inherited

Definition at line 93 of file C4SoundModifiers.cpp.

{
    // apply slot to source if valid
#if defined(HAVE_ALEXT)
    if (slot) alSource3i(source, AL_AUXILIARY_SEND_FILTER, slot, 0, AL_FILTER_NULL);
#endif
}

References C4SoundModifier::slot.

Referenced by C4SoundInstance::SetModifier(), and C4SoundInstance::Start().

Here is the caller graph for this function:

DelRef()

void C4SoundModifier::DelRef ( )

inlineinherited

Definition at line 70 of file C4SoundModifiers.h.

{ if (!--instance_count && released) delete this; }

Referenced by C4SoundInstance::Clear(), C4SoundModifierList::SetGlobalModifier(), and C4SoundInstance::SetModifier().

Here is the caller graph for this function:

GetBoolProp()

bool C4SoundModifier::GetBoolProp ( C4PropertyName  key, bool  default_value  )

protectedinherited

Definition at line 109 of file C4SoundModifiers.cpp.

{
    // get scaled property and fill in default value
    C4PropList *p = props._getPropList();
    return (p->GetPropertyInt(key, int32_t(default_value ? 1 : 0)) != 0);
}

References C4Value::_getPropList(), and C4PropList::GetPropertyInt().

Referenced by C4SoundModifierReverb::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFloatProp()

float C4SoundModifier::GetFloatProp ( C4PropertyName  key, float  ratio, float  default_value  )

protectedinherited

Definition at line 102 of file C4SoundModifiers.cpp.

{
    // get scaled property and fill in default value
    C4PropList *p = props._getPropList();
    return float(p->GetPropertyInt(key, int32_t(default_value * ratio))) / ratio;
}

References C4Value::_getPropList(), and C4PropList::GetPropertyInt().

Referenced by C4SoundModifierReverb::Update(), Update(), and C4SoundModifierEqualizer::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

GetProps()

const C4PropList* C4SoundModifier::GetProps ( ) const

inlineinherited

Definition at line 73 of file C4SoundModifiers.h.

{ return props._getPropList(); }

References C4Value::_getPropList().

Here is the call graph for this function:

GetRefCount()

int32_t C4SoundModifier::GetRefCount ( ) const

inlineinherited

Definition at line 71 of file C4SoundModifiers.h.

{ return instance_count; }

Referenced by C4SoundModifierList::Clear().

Here is the caller graph for this function:

Release()

void C4SoundModifier::Release ( )

inlineinherited

Definition at line 66 of file C4SoundModifiers.h.

                   {
        if (!instance_count) delete this; else { released = true; props.Set0(); }
    }

References C4Value::Set0().

Referenced by C4SoundModifierList::Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

Update()

void C4SoundModifierEcho::Update ( )

overridevirtual

Reimplemented from C4SoundModifier.

Definition at line 154 of file C4SoundModifiers.cpp.

{
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    // use default OpenAL echo preset
    Application.MusicSystem.SelectContext();
    alEffectf(effect, AL_ECHO_DELAY, GetFloatProp(P_Echo_Delay, 1000, 0.1f));
    alEffectf(effect, AL_ECHO_LRDELAY, GetFloatProp(P_Echo_LRDelay, 1000, 0.1f));
    alEffectf(effect, AL_ECHO_DAMPING, GetFloatProp(P_Echo_Damping, 1000, 0.5f));
    alEffectf(effect, AL_ECHO_FEEDBACK, GetFloatProp(P_Echo_Feedback, 1000, 0.5f));
    alEffectf(effect, AL_ECHO_SPREAD, GetFloatProp(P_Echo_Spread, 1000, -1.0f));
#endif
    C4SoundModifier::Update();
}

References Application, C4SoundModifier::effect, C4SoundModifier::GetFloatProp(), C4Application::MusicSystem, P_Echo_Damping, P_Echo_Delay, P_Echo_Feedback, P_Echo_LRDelay, P_Echo_Spread, C4MusicSystem::SelectContext(), and C4SoundModifier::Update().

Here is the call graph for this function:

Member Data Documentation

effect

ALuint C4SoundModifier::effect

protectedinherited

Definition at line 53 of file C4SoundModifiers.h.

Referenced by C4SoundModifier::C4SoundModifier(), C4SoundModifierEcho(), C4SoundModifierEqualizer::C4SoundModifierEqualizer(), C4SoundModifierReverb::C4SoundModifierReverb(), C4SoundModifier::Update(), C4SoundModifierReverb::Update(), Update(), C4SoundModifierEqualizer::Update(), and C4SoundModifier::~C4SoundModifier().

slot

ALuint C4SoundModifier::slot

protectedinherited

Definition at line 53 of file C4SoundModifiers.h.

Referenced by C4SoundModifier::ApplyTo(), C4SoundModifier::C4SoundModifier(), C4SoundModifier::Update(), and C4SoundModifier::~C4SoundModifier().

---

The documentation for this class was generated from the following files:

• C4SoundModifiers.h
• C4SoundModifiers.cpp