C4SoundEffect Class Reference

#include <C4SoundInstance.h>

Collaboration diagram for C4SoundEffect:

Public Member Functions
	C4SoundEffect ()
	~C4SoundEffect ()
void	Clear ()
bool	Load (const char *szFileName, C4Group &hGroup, const char *namespace_prefix)
bool	Load (BYTE *pData, size_t iDataLen, bool fRaw=false)
void	Execute ()
C4SoundInstance *	New (bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
C4SoundInstance *	GetInstance (C4Object *pObj)
void	ClearPointers (C4Object *pObj)
int32_t	GetStartedInstanceCount (int32_t iX, int32_t iY, int32_t iRad)
int32_t	GetStartedInstanceCount ()
const char *	GetFullName () const

Public Attributes
char	Name [C4MaxSoundName+1]
int32_t	Instances {0}
int32_t	SampleRate
int32_t	Length
C4SoundHandle	pSample {0}
C4SoundInstance *	FirstInst {nullptr}
C4SoundEffect *	Next {nullptr}

Protected Member Functions
void	AddInst (C4SoundInstance *pInst)
void	RemoveInst (C4SoundInstance *pInst)

Friends
class	C4SoundInstance

Detailed Description

Definition at line 27 of file C4SoundInstance.h.

Constructor & Destructor Documentation

C4SoundEffect()

C4SoundEffect::C4SoundEffect

(

)

Definition at line 32 of file C4SoundInstance.cpp.

{
    Name[0]=0;
}

~C4SoundEffect()

C4SoundEffect::~C4SoundEffect

(

)

Definition at line 37 of file C4SoundInstance.cpp.

{
    Clear();
}

Member Function Documentation

AddInst()

void C4SoundEffect::AddInst ( C4SoundInstance *  pInst )

protected

Definition at line 174 of file C4SoundInstance.cpp.

{
    pInst->pNext = FirstInst;
    FirstInst = pInst;
    Instances++;
}

References C4SoundInstance::pNext.

Clear()

void C4SoundEffect::Clear

(

)

Definition at line 42 of file C4SoundInstance.cpp.

{
    while (FirstInst) RemoveInst(FirstInst);
#if AUDIO_TK == AUDIO_TK_SDL_MIXER
    if (pSample) Mix_FreeChunk(pSample);
#elif AUDIO_TK == AUDIO_TK_OPENAL
    if (pSample) alDeleteBuffers(1, &pSample);
#endif
    pSample = 0;
}

ClearPointers()

void C4SoundEffect::ClearPointers

(

C4Object *

pObj

)

Definition at line 150 of file C4SoundInstance.cpp.

{
    for (C4SoundInstance *pInst = FirstInst; pInst; pInst = pInst->pNext)
        pInst->ClearPointers(pObj);
}

References C4SoundInstance::pNext.

Execute()

void C4SoundEffect::Execute

(

)

Definition at line 115 of file C4SoundInstance.cpp.

{
    // check for instances that have stopped and volume changes
    for (C4SoundInstance *pInst = FirstInst; pInst; )
    {
        C4SoundInstance *pNext = pInst->pNext;
        if (!pInst->Playing())
            RemoveInst(pInst);
        else
            pInst->Execute();
        pInst = pNext;
    }
}

References C4SoundInstance::pNext.

Referenced by C4SoundSystem::Execute().

Here is the caller graph for this function:

GetFullName()

const char* C4SoundEffect::GetFullName ( ) const

inline

Definition at line 51 of file C4SoundInstance.h.

{ return Name; }; // return full name including the path prefix

References Name.

GetInstance()

C4SoundInstance * C4SoundEffect::GetInstance

(

C4Object *

pObj

)

Definition at line 142 of file C4SoundInstance.cpp.

{
    for (C4SoundInstance *pInst = FirstInst; pInst; pInst = pInst->pNext)
        if (pInst->getObj() == pObj)
            return pInst;
    return nullptr;
}

References C4SoundInstance::pNext.

GetStartedInstanceCount() [1/2]

int32_t C4SoundEffect::GetStartedInstanceCount

(

)

Definition at line 165 of file C4SoundInstance.cpp.

{
    int32_t cnt = 0;
    for (C4SoundInstance *pInst = FirstInst; pInst; pInst = pInst->pNext)
        if (pInst->isStarted() && pInst->Playing() && !pInst->getObj())
            cnt++;
    return cnt;
}

References C4SoundInstance::pNext.

GetStartedInstanceCount() [2/2]

int32_t C4SoundEffect::GetStartedInstanceCount	(	int32_t	iX,
		int32_t	iY,
		int32_t	iRad
	)

Definition at line 156 of file C4SoundInstance.cpp.

{
    int32_t cnt = 0;
    for (C4SoundInstance *pInst = FirstInst; pInst; pInst = pInst->pNext)
        if (pInst->isStarted() && pInst->getObj() && pInst->Inside(iX, iY, iRad))
            cnt++;
    return cnt;
}

References C4SoundInstance::pNext.

Referenced by C4SoundInstance::CheckStart().

Here is the caller graph for this function:

Load() [1/2]

bool C4SoundEffect::Load	(	BYTE *	pData,
		size_t	iDataLen,
		bool	fRaw = false
	)

Definition at line 78 of file C4SoundInstance.cpp.

{
    // Sound check
    if (!Config.Sound.RXSound) return false;
 
    SoundInfo info;
    int32_t options = 0;
    if (fRaw)
        options |= SoundLoader::OPTION_Raw;
    for (SoundLoader* loader = SoundLoader::first_loader; loader; loader = loader->next)
    {
        if (loader->ReadInfo(&info, pData, iDataLen))
        {
            if (info.final_handle)
            {
                // loader supplied the handle specific to the sound system used; just assign to pSample
                pSample = info.final_handle;
            }
            else
            {
#if AUDIO_TK == AUDIO_TK_OPENAL
                Application.MusicSystem.SelectContext();
                alGenBuffers(1, &pSample);
                alBufferData(pSample, info.format, &info.sound_data[0], info.sound_data.size(), info.sample_rate);
#else
                Log("SoundLoader does not provide a ready-made handle");
#endif
            }
            SampleRate = info.sample_rate;
            Length = info.sample_length*1000;
            break;
        }
    }
    *Name = '\0';
    return !!pSample;
}

References Application, Config, C4SoundLoaders::SoundInfo::final_handle, C4SoundLoaders::SoundLoader::first_loader, C4SoundLoaders::SoundInfo::format, Log(), C4Application::MusicSystem, C4SoundLoaders::SoundLoader::next, C4SoundLoaders::SoundLoader::OPTION_Raw, C4ConfigSound::RXSound, C4SoundLoaders::SoundInfo::sample_length, C4SoundLoaders::SoundInfo::sample_rate, C4MusicSystem::SelectContext(), C4Config::Sound, and C4SoundLoaders::SoundInfo::sound_data.

Here is the call graph for this function:

Load() [2/2]

bool C4SoundEffect::Load	(	const char *	szFileName,
		C4Group &	hGroup,
		const char *	namespace_prefix
	)

Definition at line 53 of file C4SoundInstance.cpp.

{
    // Sound check
    if (!Config.Sound.RXSound) return false;
    // Locate sound in file
    StdBuf WaveBuffer;
    if (!hGroup.LoadEntry(szFileName, &WaveBuffer)) return false;
    // load it from mem
    if (!Load((BYTE*)WaveBuffer.getMData(), WaveBuffer.getSize())) return false;
    // Set name
    if (namespace_prefix)
    {
        // Local sound name
        SAppend(namespace_prefix, Name, C4MaxSoundName);
        SAppend("::", Name, C4MaxSoundName);
        SAppend(szFileName, Name, C4MaxSoundName);
    }
    else
    {
        // Global sound name
        SCopy(szFileName, Name, C4MaxSoundName);
    }
    return true;
}

References C4MaxSoundName, Config, StdBuf::getMData(), StdBuf::getSize(), C4Group::LoadEntry(), C4ConfigSound::RXSound, SAppend(), SCopy(), and C4Config::Sound.

Referenced by C4SoundSystem::LoadEffects().

Here is the call graph for this function:

Here is the caller graph for this function:

New()

C4SoundInstance * C4SoundEffect::New	(	bool	fLoop = false,
		int32_t	iVolume = 100,
		C4Object *	pObj = nullptr,
		int32_t	iCustomFalloffDistance = 0,
		int32_t	iPitch = 0,
		C4SoundModifier *	modifier = nullptr
	)

Definition at line 129 of file C4SoundInstance.cpp.

{
    // check: too many instances?
    if (!fLoop && Instances >= C4MaxSoundInstances) return nullptr;
    // create & init sound instance
    C4SoundInstance *pInst = new C4SoundInstance();
    if (!pInst->Create(this, fLoop, iVolume, pObj, 0, iCustomFalloffDistance, iPitch, modifier)) { delete pInst; return nullptr; }
    // add to list
    AddInst(pInst);
    // return
    return pInst;
}

References C4MaxSoundInstances, and C4SoundInstance::Create().

Referenced by C4SoundSystem::NewEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveInst()

void C4SoundEffect::RemoveInst ( C4SoundInstance *  pInst )

protected

Definition at line 180 of file C4SoundInstance.cpp.

{
    if (pInst == FirstInst)
        FirstInst = pInst->pNext;
    else
    {
        C4SoundInstance *pPos = FirstInst;
        while (pPos && pPos->pNext != pInst) pPos = pPos->pNext;
        if (pPos)
            pPos->pNext = pInst->pNext;
    }
    delete pInst;
    Instances--;
}

References C4SoundInstance::pNext.

Friends And Related Function Documentation

C4SoundInstance

friend class C4SoundInstance

friend

Definition at line 29 of file C4SoundInstance.h.

Member Data Documentation

FirstInst

C4SoundInstance* C4SoundEffect::FirstInst {nullptr}

Definition at line 38 of file C4SoundInstance.h.

Instances

int32_t C4SoundEffect::Instances {0}

Definition at line 35 of file C4SoundInstance.h.

Length

int32_t C4SoundEffect::Length

Definition at line 36 of file C4SoundInstance.h.

Referenced by C4SoundInstance::CheckStart().

Name

char C4SoundEffect::Name[C4MaxSoundName+1]

Definition at line 34 of file C4SoundInstance.h.

Referenced by C4SoundSystem::GetEffect(), GetFullName(), and C4SoundSystem::LoadEffects().

Next

C4SoundEffect* C4SoundEffect::Next {nullptr}

Definition at line 39 of file C4SoundInstance.h.

Referenced by C4SoundSystem::ClearEffects(), C4SoundSystem::ClearPointers(), C4SoundSystem::Execute(), C4SoundSystem::FindInstance(), C4SoundSystem::GetEffect(), C4SoundSystem::GetFirstInstance(), C4SoundSystem::GetNextInstance(), C4SoundSystem::LoadEffects(), and C4SoundSystem::RemoveEffect().

pSample

C4SoundHandle C4SoundEffect::pSample {0}

Definition at line 37 of file C4SoundInstance.h.

Referenced by C4SoundInstance::Start().

SampleRate

int32_t C4SoundEffect::SampleRate

Definition at line 36 of file C4SoundInstance.h.

---

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

• C4SoundInstance.h
• C4SoundInstance.cpp