C4SoundModifier Class Reference

#include <C4SoundModifiers.h>

Inheritance diagram for C4SoundModifier:

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

Public Member Functions
	C4SoundModifier (C4PropList *in_props)
virtual	~C4SoundModifier ()
virtual void	Update ()
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 26 of file C4SoundModifiers.h.

Member Enumeration Documentation

Type

enum C4SoundModifier::Type

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

C4SoundModifier()

C4SoundModifier::C4SoundModifier

(

C4PropList *

in_props

)

Definition at line 53 of file C4SoundModifiers.cpp.

                                                     : instance_count(0)
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    , effect(0u), slot(0u)
#endif
{
    props.SetPropList(in_props);
    Application.SoundSystem.Modifiers.Add(this);
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    Application.MusicSystem.SelectContext();
    alGenEffects(1, &effect);
    alGenAuxiliaryEffectSlots(1, &slot);
#endif
}

References C4SoundModifierList::Add(), Application, effect, C4SoundSystem::Modifiers, C4Application::MusicSystem, C4MusicSystem::SelectContext(), C4Value::SetPropList(), slot, and C4Application::SoundSystem.

Here is the call graph for this function:

~C4SoundModifier()

C4SoundModifier::~C4SoundModifier ( )

virtual

Definition at line 67 of file C4SoundModifiers.cpp.

{
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    // failsafe effect removal
    if (alIsEffect(effect))
        alDeleteEffects(1, &effect);
    if (alIsAuxiliaryEffectSlot(slot))
        alDeleteAuxiliaryEffectSlots(1, &slot);
#endif
    Application.SoundSystem.Modifiers.Remove(this);
}

References Application, effect, C4SoundSystem::Modifiers, C4SoundModifierList::Remove(), slot, and C4Application::SoundSystem.

Here is the call graph for this function:

Member Function Documentation

AddRef()

void C4SoundModifier::AddRef ( )

inline

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

)

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 slot.

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

Here is the caller graph for this function:

DelRef()

void C4SoundModifier::DelRef ( )

inline

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  )

protected

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  )

protected

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(), C4SoundModifierEcho::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

inline

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

inline

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 ( )

inline

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 C4SoundModifier::Update ( )

virtual

Reimplemented in C4SoundModifierEqualizer, C4SoundModifierEcho, and C4SoundModifierReverb.

Definition at line 79 of file C4SoundModifiers.cpp.

{
#if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
    // update AL effect slot
    if (slot)
    {
        alAuxiliaryEffectSloti(slot, AL_EFFECTSLOT_EFFECT, effect);
    }
#endif
    // update from props and mark as not released
    released = false;
}

References effect, and slot.

Referenced by C4SoundModifierList::Get(), C4SoundModifierReverb::Update(), C4SoundModifierEcho::Update(), and C4SoundModifierEqualizer::Update().

Here is the caller graph for this function:

Member Data Documentation

effect

ALuint C4SoundModifier::effect

protected

Definition at line 53 of file C4SoundModifiers.h.

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

slot

ALuint C4SoundModifier::slot

protected

Definition at line 53 of file C4SoundModifiers.h.

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

---

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

• C4SoundModifiers.h
• C4SoundModifiers.cpp