#include <C4SoundInstance.h>

Collaboration diagram for C4SoundInstance:

Public Member Functions
	~C4SoundInstance ()

C4Object *	getObj () const

bool	isStarted () const

void	Clear ()

bool	Create (C4SoundEffect pEffect, bool fLoop=false, int32_t iVolume=100, C4Object pObj=nullptr, int32_t iNearInstanceMax=0, int32_t iFalloffDistance=0, int32_t inPitch=0, C4SoundModifier *modifier=nullptr)

bool	CheckStart ()

bool	Start ()

bool	Stop ()

bool	Playing ()

void	Execute ()

void	SetVolume (int32_t inVolume)

void	SetPan (int32_t inPan)

void	SetPitch (int32_t inPitch)

void	SetVolumeByPos (int32_t x, int32_t y, int32_t relative_volume=100)

void	SetObj (C4Object *pnObj)

void	ClearPointers (C4Object *pObj)

bool	Inside (int32_t iX, int32_t iY, int32_t iRad)

C4SoundModifier *	GetModifier () const

void	SetModifier (C4SoundModifier *new_modifier, bool is_global)

void	SetPlayer (int32_t new_player)

Protected Member Functions
	C4SoundInstance ()

Protected Attributes
C4SoundEffect *	pEffect {nullptr}

int32_t	iVolume {0}

int32_t	iPan {0}

int32_t	iPitch {0}

int32_t	iChannel {-1}

bool	pitch_dirty {false}

C4TimeMilliseconds	tStarted

int32_t	iNearInstanceMax

bool	fLooping

C4Object *	pObj

int32_t	iFalloffDistance

C4SoundModifier *	modifier {nullptr}

bool	has_local_modifier {false}

C4SoundInstance *	pNext {nullptr}

int32_t	player

Friends
class	C4SoundEffect

class	C4SoundSystem

class	C4SoundModifier

Detailed Description

Definition at line 57 of file C4SoundInstance.h.

Constructor & Destructor Documentation

◆ C4SoundInstance()

C4SoundInstance::C4SoundInstance ( )

protected

Definition at line 196 of file C4SoundInstance.cpp.

                                 :
         player(NO_OWNER)
 {
 }

◆ ~C4SoundInstance()

C4SoundInstance::~C4SoundInstance ( )

Definition at line 201 of file C4SoundInstance.cpp.

 {
     Clear();
 }

References Clear().

Here is the call graph for this function:

Member Function Documentation

◆ CheckStart()

bool C4SoundInstance::CheckStart ( )

Definition at line 252 of file C4SoundInstance.cpp.

 {
     // already started?
     if (isStarted()) return true;
     // don't bother if half the time is up and the sound is not looping
     if (C4TimeMilliseconds::Now() > tStarted + pEffect->Length / 2 && !fLooping)
         return false;
     // do near-instances check
     int32_t iNearInstances = pObj ? pEffect->GetStartedInstanceCount(pObj->GetX(), pObj->GetY(), C4NearSoundRadius)
                              : pEffect->GetStartedInstanceCount();
     // over maximum?
     if (iNearInstances > iNearInstanceMax) return false;
     // Start
     return Start();
 }

References C4NearSoundRadius, fLooping, C4SoundEffect::GetStartedInstanceCount(), C4Object::GetX(), C4Object::GetY(), iNearInstanceMax, isStarted(), C4SoundEffect::Length, C4TimeMilliseconds::Now(), pEffect, pObj, Start(), and tStarted.

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clear()

void C4SoundInstance::Clear ( )

Definition at line 206 of file C4SoundInstance.cpp.

 {
     Stop();
     iChannel = -1;
     if (modifier)
     {
         modifier->DelRef();
         modifier = nullptr;
         has_local_modifier = false;
     }
 }

References C4SoundModifier::DelRef(), has_local_modifier, iChannel, modifier, and Stop().

Referenced by ~C4SoundInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearPointers()

void C4SoundInstance::ClearPointers ( C4Object * pObj )

Definition at line 397 of file C4SoundInstance.cpp.

 {
     if (!Playing()) { Stop(); return; }
     if (pObj == pDelete)
     {
         // stop if looping (would most likely loop forever)
         if (fLooping)
             Stop();
         // otherwise: set volume by last position
         else
             SetVolumeByPos(pObj->GetX(), pObj->GetY());
         pObj = nullptr;
     }
 }

References fLooping, C4Object::GetX(), C4Object::GetY(), Playing(), pObj, SetVolumeByPos(), and Stop().

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

bool C4SoundInstance::Create	(	C4SoundEffect *	pEffect,
		bool	fLoop = `false`,
		int32_t	iVolume = `100`,
		C4Object *	pObj = `nullptr`,
		int32_t	iNearInstanceMax = `0`,
		int32_t	iFalloffDistance = `0`,
		int32_t	inPitch = `0`,
		C4SoundModifier *	modifier = `nullptr`
	)

Definition at line 218 of file C4SoundInstance.cpp.

 {
     // Sound check
     if (!Config.Sound.RXSound || !pnEffect) return false;
     // Already playing? Stop
     if (Playing()) { Stop(); return false; }
     // Set effect
     pEffect = pnEffect;
     // Set
     tStarted = C4TimeMilliseconds::Now();
     iVolume = inVolume; iPan = 0; iChannel = -1;
     iPitch = inPitch; pitch_dirty = (iPitch != 0);
     iNearInstanceMax = inNearInstanceMax;
     this->iFalloffDistance = iFalloffDistance;
     pObj = pnObj;
     fLooping = fLoop;
     if ((this->modifier = modifier))
     {
         modifier->AddRef();
         has_local_modifier = true;
     }
     SetPlayer(NO_OWNER); // may be updated on first execution
     // Start
     Execute();
     return true;
 }

References C4SoundModifier::AddRef(), Config, Execute(), fLooping, has_local_modifier, iChannel, iFalloffDistance, iNearInstanceMax, iPan, iPitch, iVolume, modifier, NO_OWNER, C4TimeMilliseconds::Now(), pEffect, pitch_dirty, Playing(), pObj, C4ConfigSound::RXSound, SetPlayer(), C4Config::Sound, Stop(), and tStarted.

Referenced by C4SoundEffect::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Execute()

void C4SoundInstance::Execute ( )

Definition at line 334 of file C4SoundInstance.cpp.

 {
     // Object deleted?
     if (pObj && !pObj->Status) ClearPointers(pObj);
     // initial values
     int32_t iVol = iVolume * 256 * Config.Sound.SoundVolume / 100, iPan = C4SoundInstance::iPan;
     // bound to an object?
     if (pObj)
     {
         int iAudibility = pObj->Audible;
         if (pObj->AudiblePlayer != player) SetPlayer(pObj->AudiblePlayer);
         // apply custom falloff distance
         if (iFalloffDistance)
         {
             iAudibility = Clamp<int32_t>(100 + (iAudibility - 100) * C4AudibilityRadius / iFalloffDistance, 0,100);
         }
         iVol = iVol * iAudibility / 100;
         iPan += pObj->AudiblePan;
     }
     // sound off?
     if (!iVol)
     {
         // stop, if started
         if (isStarted())
         {
 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
             Mix_HaltChannel(iChannel);
 #elif AUDIO_TK == AUDIO_TK_OPENAL
             alDeleteSources(1, (ALuint*)&iChannel);
 #endif
             iChannel = -1;
         }
     }
     else
     {
         // start
         if (!isStarted())
             if (!CheckStart())
                 return;
         // set volume & panning
 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
         Mix_Volume(iChannel, (iVol * MIX_MAX_VOLUME) / (100 * 256));
         Mix_SetPanning(iChannel, Clamp((100 - iPan) * 256 / 100, 0, 255), Clamp((100 + iPan) * 256 / 100, 0, 255));
 #elif AUDIO_TK == AUDIO_TK_OPENAL
         alSource3f(iChannel, AL_POSITION, Clamp<float>(float(iPan)/100.0f, -1.0f, +1.0f), 0, -0.7f);
         alSourcef(iChannel, AL_GAIN, float(iVol) / (100.0f*256.0f));
         if (pitch_dirty)
         {
             // set pitch; map -90..+100 range to 0.1f..2.0f
             alSourcef(iChannel, AL_PITCH, std::max(float(iPitch + 100) / 100.0f, 0.1f));
             pitch_dirty = false;
         }
 #endif
     }
 }

References C4Object::Audible, C4Object::AudiblePan, C4Object::AudiblePlayer, C4AudibilityRadius, CheckStart(), Clamp(), ClearPointers(), Config, iChannel, iFalloffDistance, iPan, iPitch, isStarted(), iVolume, pitch_dirty, player, pObj, SetPlayer(), C4Config::Sound, C4ConfigSound::SoundVolume, and C4PropList::Status.

Referenced by Create(), SoundLevel(), SoundPan(), SoundPitch(), SoundUpdate(), and Start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetModifier()

C4SoundModifier* C4SoundInstance::GetModifier ( ) const

inline

Definition at line 101 of file C4SoundInstance.h.

101 { return modifier; }

References modifier.

◆ getObj()

C4Object* C4SoundInstance::getObj ( ) const

inline

Definition at line 85 of file C4SoundInstance.h.

85 { return pObj; }

References pObj.

◆ Inside()

bool C4SoundInstance::Inside	(	int32_t	iX,
		int32_t	iY,
		int32_t	iRad
	)

Definition at line 412 of file C4SoundInstance.cpp.

 {
     return pObj &&
            (pObj->GetX() - iX) * (pObj->GetX() - iX) + (pObj->GetY() - iY) * (pObj->GetY() - iY) <= iRad * iRad;
 }

References C4Object::GetX(), C4Object::GetY(), and pObj.

Here is the call graph for this function:

◆ isStarted()

bool C4SoundInstance::isStarted ( ) const

inline

Definition at line 86 of file C4SoundInstance.h.

86 { return iChannel != -1; }

References iChannel.

Referenced by CheckStart(), Execute(), SetModifier(), and Start().

Here is the caller graph for this function:

◆ Playing()

bool C4SoundInstance::Playing ( )

Definition at line 315 of file C4SoundInstance.cpp.

 {
     if (!pEffect) return false;
     if (fLooping) return true;
 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
     return Application.MusicSystem.MODInitialized && (iChannel != -1) && Mix_Playing(iChannel);
 #elif AUDIO_TK == AUDIO_TK_OPENAL
     if (iChannel == -1)
         return false;
     else
     {
         ALint state;
         alGetSourcei(iChannel, AL_SOURCE_STATE, &state);
         return state == AL_PLAYING;
     }
 #endif
     return false;
 }

References Application, fLooping, iChannel, C4MusicSystem::MODInitialized, C4Application::MusicSystem, and pEffect.

Referenced by ClearPointers(), Create(), and Stop().

Here is the caller graph for this function:

◆ SetModifier()

void C4SoundInstance::SetModifier	(	C4SoundModifier *	new_modifier,
		bool	is_global
	)

Definition at line 418 of file C4SoundInstance.cpp.

 {
     // do not overwrite local modifier with global one
     if (is_global)
     {
         if (has_local_modifier) return;
     }
     else
     {
         // this sound has its own modifier now and doesn't care for global ones
         has_local_modifier = (new_modifier != nullptr);
     }
     if (new_modifier != modifier)
     {
         // update modifier and ref-count
         C4SoundModifier *old_modifier = modifier;
         modifier = new_modifier;
         if (modifier) modifier->AddRef();
         if (old_modifier) old_modifier->DelRef();
         // Apply new modifier
         if (isStarted())
         {
             if (modifier)
             {
 #if AUDIO_TK == AUDIO_TK_OPENAL
                 modifier->ApplyTo(iChannel);
 #endif
             }
             else
             {
 #if (AUDIO_TK == AUDIO_TK_OPENAL) && defined(HAVE_ALEXT)
                 alSource3i(iChannel, AL_AUXILIARY_SEND_FILTER, AL_EFFECTSLOT_NULL, 0, AL_FILTER_NULL);
 #endif
             }
         }
     }
 }

References C4SoundModifier::AddRef(), C4SoundModifier::ApplyTo(), C4SoundModifier::DelRef(), has_local_modifier, iChannel, isStarted(), and modifier.

Referenced by SetPlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetObj()

void C4SoundInstance::SetObj ( C4Object * pnObj )

inline

Definition at line 98 of file C4SoundInstance.h.

98 { pObj = pnObj; }

References pObj.

◆ SetPan()

void C4SoundInstance::SetPan ( int32_t inPan )

inline

Definition at line 95 of file C4SoundInstance.h.

95 { iPan = inPan; }

References iPan.

Referenced by SoundPan().

Here is the caller graph for this function:

◆ SetPitch()

void C4SoundInstance::SetPitch ( int32_t inPitch )

Definition at line 245 of file C4SoundInstance.cpp.

 {
     // set pitch and update on next call to Execute
     iPitch = inPitch;
     pitch_dirty = true;
 }

References iPitch, and pitch_dirty.

Referenced by SoundPitch(), and SoundUpdate().

Here is the caller graph for this function:

◆ SetPlayer()

void C4SoundInstance::SetPlayer ( int32_t new_player )

Definition at line 456 of file C4SoundInstance.cpp.

 {
     // update player and associated sound modifier
     player = new_player;
     SetModifier(::Application.SoundSystem.Modifiers.GetGlobalModifier(player), true);
 }

References Application, C4SoundModifierList::GetGlobalModifier(), C4SoundSystem::Modifiers, player, SetModifier(), and C4Application::SoundSystem.

Referenced by Create(), Execute(), and SetVolumeByPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetVolume()

void C4SoundInstance::SetVolume ( int32_t inVolume )

inline

Definition at line 94 of file C4SoundInstance.h.

94 { iVolume = inVolume; }

References iVolume.

Referenced by SoundLevel(), and SoundUpdate().

Here is the caller graph for this function:

◆ SetVolumeByPos()

void C4SoundInstance::SetVolumeByPos	(	int32_t	x,
		int32_t	y,
		int32_t	relative_volume = `100`
	)

Definition at line 390 of file C4SoundInstance.cpp.

 {
     int32_t vol_player = NO_OWNER;
     iVolume = ::Viewports.GetAudibility(x, y, &iPan, 0, &vol_player) * relative_vol / 100.0f;
     if (vol_player != player) SetPlayer(vol_player);
 }

References C4ViewportList::GetAudibility(), iPan, iVolume, NO_OWNER, player, SetPlayer(), and Viewports.

Referenced by ClearPointers(), and StartSoundEffectAt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Start()

bool C4SoundInstance::Start ( )

Definition at line 268 of file C4SoundInstance.cpp.

 {
 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
     // Be paranoid about SDL_Mixer initialisation
     if (!Application.MusicSystem.MODInitialized) return false;
     if ((iChannel = Mix_PlayChannel(-1, pEffect->pSample, fLooping? -1 : 0)) == -1)
         return false;
 #elif AUDIO_TK == AUDIO_TK_OPENAL
     Application.MusicSystem.SelectContext();
     alGenSources(1, (ALuint*)&iChannel);
     alSourcei(iChannel, AL_BUFFER, pEffect->pSample);
     alSourcei(iChannel, AL_LOOPING,  fLooping ? AL_TRUE : AL_FALSE);
     if (modifier) modifier->ApplyTo(iChannel);
     alSourcePlay(iChannel);
 #else
     return false;
 #endif
     // Safety: Don't execute if start failed, or Execute() would try to start again
     if (!isStarted()) return false;
     // Update volume
     Execute();
     return true;
 }

References Application, C4SoundModifier::ApplyTo(), Execute(), fLooping, iChannel, isStarted(), modifier, C4MusicSystem::MODInitialized, C4Application::MusicSystem, pEffect, C4SoundEffect::pSample, and C4MusicSystem::SelectContext().

Referenced by CheckStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Stop()

bool C4SoundInstance::Stop ( )

Definition at line 292 of file C4SoundInstance.cpp.

 {
     if (!pEffect) return false;
     // Stop sound
     bool fRet = true;
 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
     // iChannel == -1 will halt all channels. Is that right?
     if (Playing())
         Mix_HaltChannel(iChannel);
 #elif AUDIO_TK == AUDIO_TK_OPENAL
     if (iChannel != -1)
     {
         if (Playing()) alSourceStop(iChannel);
         ALuint c = iChannel;
         alDeleteSources(1, &c);
     }
 #endif
     iChannel = -1;
     tStarted = 0;
     fLooping = false;
     return fRet;
 }

References fLooping, iChannel, pEffect, Playing(), and tStarted.

Referenced by Clear(), ClearPointers(), Create(), and StopSoundEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ C4SoundEffect

friend class C4SoundEffect

friend

Definition at line 59 of file C4SoundInstance.h.

◆ C4SoundModifier

friend class C4SoundModifier

friend

Definition at line 61 of file C4SoundInstance.h.

◆ C4SoundSystem

friend class C4SoundSystem

friend

Definition at line 60 of file C4SoundInstance.h.

Member Data Documentation

◆ fLooping

bool C4SoundInstance::fLooping

protected

Definition at line 72 of file C4SoundInstance.h.

Referenced by CheckStart(), ClearPointers(), Create(), Playing(), Start(), and Stop().

◆ has_local_modifier

bool C4SoundInstance::has_local_modifier {false}

protected

Definition at line 76 of file C4SoundInstance.h.

Referenced by Clear(), Create(), and SetModifier().

◆ iChannel

int32_t C4SoundInstance::iChannel {-1}

protected

Definition at line 68 of file C4SoundInstance.h.

Referenced by Clear(), Create(), Execute(), isStarted(), Playing(), SetModifier(), Start(), and Stop().

◆ iFalloffDistance

int32_t C4SoundInstance::iFalloffDistance

protected

Definition at line 74 of file C4SoundInstance.h.

Referenced by Create(), and Execute().

◆ iNearInstanceMax

int32_t C4SoundInstance::iNearInstanceMax

protected

Definition at line 71 of file C4SoundInstance.h.

Referenced by CheckStart(), and Create().

◆ iPan

int32_t C4SoundInstance::iPan {0}

protected

Definition at line 68 of file C4SoundInstance.h.

Referenced by Create(), Execute(), SetPan(), and SetVolumeByPos().

◆ iPitch

int32_t C4SoundInstance::iPitch {0}

protected

Definition at line 68 of file C4SoundInstance.h.

Referenced by Create(), Execute(), and SetPitch().

◆ iVolume

int32_t C4SoundInstance::iVolume {0}

protected

Definition at line 68 of file C4SoundInstance.h.

Referenced by Create(), Execute(), SetVolume(), and SetVolumeByPos().

◆ modifier

C4SoundModifier* C4SoundInstance::modifier {nullptr}

protected

Definition at line 75 of file C4SoundInstance.h.

Referenced by Clear(), Create(), GetModifier(), SetModifier(), and Start().

◆ pEffect

C4SoundEffect* C4SoundInstance::pEffect {nullptr}

protected

Definition at line 67 of file C4SoundInstance.h.

Referenced by CheckStart(), Create(), C4SoundSystem::GetNextInstance(), Playing(), Start(), and Stop().

◆ pitch_dirty

bool C4SoundInstance::pitch_dirty {false}

protected

Definition at line 69 of file C4SoundInstance.h.

Referenced by Create(), Execute(), and SetPitch().

◆ player

int32_t C4SoundInstance::player

protected

Definition at line 83 of file C4SoundInstance.h.

Referenced by Execute(), SetPlayer(), and SetVolumeByPos().

◆ pNext

C4SoundInstance* C4SoundInstance::pNext {nullptr}

protected

Definition at line 77 of file C4SoundInstance.h.

Referenced by C4SoundEffect::AddInst(), C4SoundEffect::ClearPointers(), C4SoundEffect::Execute(), C4SoundEffect::GetInstance(), C4SoundSystem::GetNextInstance(), C4SoundEffect::GetStartedInstanceCount(), and C4SoundEffect::RemoveInst().

◆ pObj

C4Object* C4SoundInstance::pObj

protected

Definition at line 73 of file C4SoundInstance.h.

Referenced by CheckStart(), ClearPointers(), Create(), Execute(), getObj(), Inside(), and SetObj().

◆ tStarted

C4TimeMilliseconds C4SoundInstance::tStarted

protected

Definition at line 70 of file C4SoundInstance.h.

Referenced by CheckStart(), Create(), and Stop().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ C4SoundInstance()

◆ ~C4SoundInstance()

Member Function Documentation

◆ CheckStart()

◆ Clear()

◆ ClearPointers()

◆ Create()

◆ Execute()

◆ GetModifier()

◆ getObj()

◆ Inside()

◆ isStarted()

◆ Playing()

◆ SetModifier()

◆ SetObj()

◆ SetPan()

◆ SetPitch()

◆ SetPlayer()

◆ SetVolume()

◆ SetVolumeByPos()

◆ Start()

◆ Stop()

Friends And Related Function Documentation

◆ C4SoundEffect

◆ C4SoundModifier

◆ C4SoundSystem

Member Data Documentation

◆ fLooping

◆ has_local_modifier

◆ iChannel

◆ iFalloffDistance

◆ iNearInstanceMax

◆ iPan

◆ iPitch

◆ iVolume

◆ modifier

◆ pEffect

◆ pitch_dirty

◆ player

◆ pNext

◆ pObj

◆ tStarted