OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4SoundSystem Class Reference

#include <C4SoundSystem.h>

Collaboration diagram for C4SoundSystem:
[legend]

Public Member Functions

 C4SoundSystem ()
 
 ~C4SoundSystem ()
 
void Clear ()
 
void Execute ()
 
int32_t LoadEffects (C4Group &hGroup, const char *namespace_prefix, bool group_is_root)
 
C4SoundInstanceNewEffect (const char *szSound, bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
 
C4SoundInstanceFindInstance (const char *szSound, C4Object *pObj)
 
C4SoundInstanceGetFirstInstance () const
 
C4SoundInstanceGetNextInstance (C4SoundInstance *prev) const
 
bool Init ()
 
void ClearPointers (C4Object *pObj)
 
C4SoundEffectGetFirstSound () const
 

Public Attributes

C4SoundModifierList Modifiers
 

Protected Member Functions

void ClearEffects ()
 
C4SoundEffectGetEffect (const char *szSound)
 
int32_t RemoveEffect (const char *szFilename)
 

Protected Attributes

C4Group SoundFile
 
C4SoundEffectFirstSound {nullptr}
 

Detailed Description

Definition at line 38 of file C4SoundSystem.h.

Constructor & Destructor Documentation

C4SoundSystem::C4SoundSystem ( )
default
C4SoundSystem::~C4SoundSystem ( )
default

Member Function Documentation

void C4SoundSystem::Clear ( )

Definition at line 56 of file C4SoundSystem.cpp.

References C4SoundModifierList::Clear(), ClearEffects(), C4Group::Close(), Modifiers, and SoundFile.

Referenced by C4Application::Clear(), C4Game::Clear(), and C4MainMenu::MenuCommand().

57 {
58  ClearEffects();
59  Modifiers.Clear();
60  // Close sound file
61  SoundFile.Close();
62 }
C4SoundModifierList Modifiers
Definition: C4SoundSystem.h:54
bool Close()
Definition: C4Group.cpp:755
C4Group SoundFile
Definition: C4SoundSystem.h:56

Here is the call graph for this function:

Here is the caller graph for this function:

void C4SoundSystem::ClearEffects ( )
protected

Definition at line 64 of file C4SoundSystem.cpp.

References FirstSound, and C4SoundEffect::Next.

Referenced by Clear(), and Init().

65 {
66  // Clear sound bank
67  C4SoundEffect *csfx,*next;
68  for (csfx=FirstSound; csfx; csfx=next)
69  {
70  next=csfx->Next;
71  delete csfx;
72  }
73  FirstSound=nullptr;
74 }
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57

Here is the caller graph for this function:

void C4SoundSystem::ClearPointers ( C4Object pObj)

Definition at line 237 of file C4SoundSystem.cpp.

References FirstSound, and C4SoundEffect::Next.

Referenced by C4Game::ClearPointers().

238 {
239  for (C4SoundEffect *pEff=FirstSound; pEff; pEff=pEff->Next)
240  pEff->ClearPointers(pObj);
241 }
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57

Here is the caller graph for this function:

void C4SoundSystem::Execute ( )

Definition at line 76 of file C4SoundSystem.cpp.

References Application, C4SoundEffect::Execute(), FirstSound, C4Application::MusicSystem, C4SoundEffect::Next, and C4MusicSystem::SelectContext().

Referenced by C4Application::GameTick().

77 {
78 #if AUDIO_TK == AUDIO_TK_OPENAL
80 #endif
81  C4SoundEffect *csfx;
82  for (csfx=FirstSound; csfx; csfx=csfx->Next)
83  {
84  // Instance removal check
85  csfx->Execute();
86  }
87 }
void SelectContext()
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
C4Application Application
Definition: C4Globals.cpp:44
C4MusicSystem MusicSystem
Definition: C4Application.h:41

Here is the call graph for this function:

Here is the caller graph for this function:

C4SoundInstance * C4SoundSystem::FindInstance ( const char *  szSound,
C4Object pObj 
)

Definition at line 138 of file C4SoundSystem.cpp.

References C4MaxSoundName, DefaultExtension(), FirstSound, C4SoundEffect::Next, SCopy(), and WildcardMatch().

Referenced by GetSoundInstance(), SoundLevel(), SoundPan(), SoundPitch(), and StopSoundEffect().

139 {
140  char szName[C4MaxSoundName+2+1];
141  // Evaluate sound name (see GetEffect)
142  SCopy(szSndName,szName,C4MaxSoundName);
143  DefaultExtension(szName,"*");
144  // Find an effect with a matching instance
145  for (C4SoundEffect *csfx = FirstSound; csfx; csfx = csfx->Next)
146  if (WildcardMatch(szName, csfx->Name))
147  {
148  C4SoundInstance *pInst = csfx->GetInstance(pObj);
149  if (pInst) return pInst;
150  }
151  return nullptr;
152 }
void SCopy(const char *szSource, char *sTarget, size_t iMaxL)
Definition: Standard.cpp:130
const int32_t C4MaxSoundName
Definition: C4SoundSystem.h:27
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
void DefaultExtension(char *szFilename, const char *szExtension)
Definition: StdFile.cpp:274
bool WildcardMatch(const char *szWildcard, const char *szString)
Definition: StdFile.cpp:374

Here is the call graph for this function:

Here is the caller graph for this function:

C4SoundEffect * C4SoundSystem::GetEffect ( const char *  szSound)
protected

Definition at line 89 of file C4SoundSystem.cpp.

References C4MaxSoundName, DefaultExtension(), FirstSound, C4SoundEffect::Name, C4SoundEffect::Next, SCharCount(), SCopy(), UnsyncedRandom(), and WildcardMatch().

Referenced by NewEffect().

90 {
91  // Remember wildcards before adding .* extension - if there are 2 versions with different file extensions, play the last added
92  bool bRandomSound = SCharCount('?',szSndName) || SCharCount('*',szSndName);
93  // Evaluate sound name
94  char szName[C4MaxSoundName+2+1];
95  SCopy(szSndName,szName,C4MaxSoundName);
96  // Any extension accepted
97  DefaultExtension(szName,"*");
98  // Play nth Sound. Standard: 1
99  int32_t iNumber = 1;
100  // Sound with a wildcard: determine number of available matches
101  if (bRandomSound)
102  {
103  iNumber = 0;
104  // Count matching sounds
105  for (C4SoundEffect *pSfx=FirstSound; pSfx; pSfx=pSfx->Next)
106  if (WildcardMatch(szName,pSfx->Name))
107  ++iNumber;
108  // Nothing found? Abort
109  if(iNumber == 0)
110  return nullptr;
111  iNumber=UnsyncedRandom(iNumber)+1;
112  }
113  // Find requested sound effect in bank
114  C4SoundEffect *pSfx;
115  for (pSfx=FirstSound; pSfx; pSfx=pSfx->Next)
116  if (WildcardMatch(szName,pSfx->Name))
117  if(!--iNumber)
118  break;
119  return pSfx; // Is still nullptr if nothing is found
120 }
void SCopy(const char *szSource, char *sTarget, size_t iMaxL)
Definition: Standard.cpp:130
uint32_t UnsyncedRandom()
Definition: C4Random.cpp:58
char Name[C4MaxSoundName+1]
const int32_t C4MaxSoundName
Definition: C4SoundSystem.h:27
unsigned int SCharCount(char cTarget, const char *szInStr, const char *cpUntil)
Definition: Standard.cpp:298
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
void DefaultExtension(char *szFilename, const char *szExtension)
Definition: StdFile.cpp:274
bool WildcardMatch(const char *szWildcard, const char *szString)
Definition: StdFile.cpp:374

Here is the call graph for this function:

Here is the caller graph for this function:

C4SoundInstance * C4SoundSystem::GetFirstInstance ( ) const

Definition at line 243 of file C4SoundSystem.cpp.

References FirstSound, and C4SoundEffect::Next.

Referenced by C4SoundModifierList::SetGlobalModifier().

244 {
245  // Return by searching through effect linked list.
246  for (C4SoundEffect *pSfx = FirstSound; pSfx; pSfx = pSfx->Next)
247  if (pSfx->FirstInst) return pSfx->FirstInst;
248  return nullptr;
249 }
C4SoundEffect * Next
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57

Here is the caller graph for this function:

C4SoundEffect* C4SoundSystem::GetFirstSound ( ) const
inline

Definition at line 52 of file C4SoundSystem.h.

References FirstSound.

52 { return FirstSound; }
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
C4SoundInstance * C4SoundSystem::GetNextInstance ( C4SoundInstance prev) const

Definition at line 251 of file C4SoundSystem.cpp.

References C4SoundEffect::Next, C4SoundInstance::pEffect, and C4SoundInstance::pNext.

Referenced by C4SoundModifierList::SetGlobalModifier().

252 {
253  // Return by searching through instance linked list and parent linked list of effects
254  assert(prev && prev->pEffect);
255  if (prev->pNext) return prev->pNext;
256  for (C4SoundEffect *pSfx = prev->pEffect->Next; pSfx; pSfx = pSfx->Next)
257  if (pSfx->FirstInst) return pSfx->FirstInst;
258  return nullptr;
259 }
C4SoundInstance * pNext
C4SoundEffect * Next
C4SoundEffect * pEffect

Here is the caller graph for this function:

bool C4SoundSystem::Init ( )

Definition at line 35 of file C4SoundSystem.cpp.

References Application, C4CFN_Sound, C4MaxSoundInstances, ClearEffects(), C4SoundModifierList::Init(), C4MusicSystem::InitializeMOD(), C4Group::IsOpen(), LoadEffects(), Modifiers, C4MusicSystem::MODInitialized, C4Application::MusicSystem, C4Reloc::Open(), Reloc, and SoundFile.

Referenced by C4MainMenu::MenuCommand(), and C4Application::PreInit().

36 {
39  return false;
40 
41  // Might be reinitialisation
42  ClearEffects();
43  // (re)init EFX
44  Modifiers.Init();
45  // Open sound file
46  if (!SoundFile.IsOpen())
47  if (!Reloc.Open(SoundFile, C4CFN_Sound)) return false;
48  // Load static sound from Sound.ocg
49  LoadEffects(SoundFile, nullptr, false);
50 #if AUDIO_TK == AUDIO_TK_SDL_MIXER
51  Mix_AllocateChannels(C4MaxSoundInstances);
52 #endif
53  return true;
54 }
int32_t LoadEffects(C4Group &hGroup, const char *namespace_prefix, bool group_is_root)
C4SoundModifierList Modifiers
Definition: C4SoundSystem.h:54
bool IsOpen() const
Definition: C4Group.cpp:1891
#define C4CFN_Sound
Definition: C4Components.h:26
bool Open(C4Group &hGroup, const char *filename) const
Definition: C4Reloc.cpp:68
const int32_t C4MaxSoundInstances
Definition: C4SoundSystem.h:28
C4Reloc Reloc
Definition: C4Reloc.cpp:21
C4Group SoundFile
Definition: C4SoundSystem.h:56
C4Application Application
Definition: C4Globals.cpp:44
bool InitializeMOD()
C4MusicSystem MusicSystem
Definition: C4Application.h:41

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4SoundSystem::LoadEffects ( C4Group hGroup,
const char *  namespace_prefix,
bool  group_is_root 
)

Definition at line 156 of file C4SoundSystem.cpp.

References _MAX_FNAME, StdStrBuf::Append(), C4CFN_Sound, C4CFN_SoundFiles, C4CFN_SoundSubgroups, StdStrBuf::Copy(), C4Group::FindEntry(), C4Group::FindNextEntry(), FirstSound, StdStrBuf::getData(), C4SoundEffect::Load(), C4SoundEffect::Name, C4SoundEffect::Next, C4Group::OpenAsChild(), RemoveEffect(), C4Group::ResetSearch(), and SCopySegment().

Referenced by Init(), and C4Game::InitGame().

157 {
158  // Local definition sounds: If there is a Sound.ocg in the group, load the sound from there
159  if(group_is_root && hGroup.FindEntry(C4CFN_Sound))
160  {
161  C4Group g;
162  g.OpenAsChild(&hGroup, C4CFN_Sound, false, false);
163  return LoadEffects(g, namespace_prefix, false);
164  }
165  int32_t iNum=0;
166  char szFilename[_MAX_FNAME+1];
167  char szFileType[_MAX_FNAME+1];
168  C4SoundEffect *nsfx;
169  // Process segmented list of file types
170  for (int32_t i = 0; SCopySegment(C4CFN_SoundFiles, i, szFileType, '|', _MAX_FNAME); i++)
171  {
172  // Search all sound files in group
173  hGroup.ResetSearch();
174  while (hGroup.FindNextEntry(szFileType, szFilename))
175  // Create and load effect
176  if ((nsfx = new C4SoundEffect))
177  {
178  if (nsfx->Load(szFilename, hGroup, namespace_prefix))
179  {
180  // Overload same name effects
181  RemoveEffect(nsfx->Name);
182  // Add effect
183  nsfx->Next=FirstSound;
184  FirstSound=nsfx;
185  iNum++;
186  }
187  else
188  delete nsfx;
189  }
190  }
191  // Load subgroups from Sound.ocg and other subgroups
192  if (!group_is_root)
193  {
194  hGroup.ResetSearch();
195  while (hGroup.FindNextEntry(C4CFN_SoundSubgroups, szFilename))
196  {
197  // Load from subgroup as a sub-namespace
198  // get namespace name
199  StdStrBuf sub_namespace;
200  if (namespace_prefix)
201  {
202  sub_namespace.Copy(namespace_prefix);
203  sub_namespace.Append("::");
204  }
205  sub_namespace.Append(szFilename, strlen(szFilename) - strlen(C4CFN_SoundSubgroups) + 1);
206  // load from child group
207  C4Group subgroup;
208  if (subgroup.OpenAsChild(&hGroup, szFilename, false, false))
209  {
210  iNum += LoadEffects(subgroup, sub_namespace.getData(), false);
211  }
212  }
213  }
214  return iNum;
215 }
const char * getData() const
Definition: StdBuf.h:442
bool FindEntry(const char *szWildCard, StdStrBuf *sFileName=nullptr, size_t *iSize=nullptr)
Definition: C4Group.cpp:1774
bool SCopySegment(const char *szString, int iSegment, char *sTarget, char cSeparator, int iMaxL, bool fSkipWhitespace)
Definition: Standard.cpp:251
int32_t LoadEffects(C4Group &hGroup, const char *namespace_prefix, bool group_is_root)
char Name[C4MaxSoundName+1]
#define C4CFN_SoundSubgroups
Definition: C4Components.h:27
C4SoundEffect * Next
#define C4CFN_SoundFiles
Definition: C4Components.h:171
bool Load(const char *szFileName, C4Group &hGroup, const char *namespace_prefix)
void Append(const char *pnData, size_t iChars)
Definition: StdBuf.h:519
#define C4CFN_Sound
Definition: C4Components.h:26
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
#define _MAX_FNAME
bool FindNextEntry(const char *szWildCard, StdStrBuf *sFileName=nullptr, size_t *iSize=nullptr, bool fStartAtFilename=false)
Definition: C4Group.cpp:1780
void ResetSearch(bool reload_contents=false)
Definition: C4Group.cpp:1013
void Copy()
Definition: StdBuf.h:467
int32_t RemoveEffect(const char *szFilename)
bool OpenAsChild(C4Group *pMother, const char *szEntryName, bool fExclusive=false, bool fCreate=false)
Definition: C4Group.cpp:1585

Here is the call graph for this function:

Here is the caller graph for this function:

C4SoundInstance * C4SoundSystem::NewEffect ( const char *  szSound,
bool  fLoop = false,
int32_t  iVolume = 100,
C4Object pObj = nullptr,
int32_t  iCustomFalloffDistance = 0,
int32_t  iPitch = 0,
C4SoundModifier modifier = nullptr 
)

Definition at line 122 of file C4SoundSystem.cpp.

References Config, DebugLogF(), GetEffect(), C4SoundEffect::New(), C4ConfigSound::RXSound, and C4Config::Sound.

Referenced by StartSoundEffect().

123 {
124  // Sound not active
125  if (!Config.Sound.RXSound) return nullptr;
126  // Get sound
127  C4SoundEffect *csfx;
128  if (!(csfx = GetEffect(szSndName)))
129  {
130  // Warn about missing or incorrectly spelled sound to allow finding mistakes earlier.
131  DebugLogF("Warning: could not find sound matching '%s'", szSndName);
132  return nullptr;
133  }
134  // Play
135  return csfx->New(fLoop, iVolume, pObj, iCustomFalloffDistance, iPitch, modifier);
136 }
C4Config Config
Definition: C4Config.cpp:833
int32_t RXSound
Definition: C4Config.h:126
C4SoundEffect * GetEffect(const char *szSound)
bool DebugLogF(const char *strMessage...)
Definition: C4Log.cpp:278
C4SoundInstance * New(bool fLoop=false, int32_t iVolume=100, C4Object *pObj=nullptr, int32_t iCustomFalloffDistance=0, int32_t iPitch=0, C4SoundModifier *modifier=nullptr)
C4ConfigSound Sound
Definition: C4Config.h:254

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t C4SoundSystem::RemoveEffect ( const char *  szFilename)
protected

Definition at line 217 of file C4SoundSystem.cpp.

References FirstSound, iResult, C4SoundEffect::Next, and WildcardMatch().

Referenced by LoadEffects().

218 {
219  int32_t iResult=0;
220  C4SoundEffect *pNext,*pPrev=nullptr;
221  for (C4SoundEffect *pSfx=FirstSound; pSfx; pSfx=pNext)
222  {
223  pNext=pSfx->Next;
224  if (WildcardMatch(szFilename,pSfx->Name))
225  {
226  delete pSfx;
227  if (pPrev) pPrev->Next=pNext;
228  else FirstSound=pNext;
229  iResult++;
230  }
231  else
232  pPrev=pSfx;
233  }
234  return iResult;
235 }
C4SoundEffect * Next
int iResult
Definition: C4GroupMain.cpp:39
C4SoundEffect * FirstSound
Definition: C4SoundSystem.h:57
bool WildcardMatch(const char *szWildcard, const char *szString)
Definition: StdFile.cpp:374

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

C4SoundEffect* C4SoundSystem::FirstSound {nullptr}
protected
C4Group C4SoundSystem::SoundFile
protected

Definition at line 56 of file C4SoundSystem.h.

Referenced by Clear(), and Init().


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