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 239 of file C4SoundSystem.cpp.

References FirstSound, and C4SoundEffect::Next.

Referenced by C4Game::ClearPointers().

240 {
241  for (C4SoundEffect *pEff=FirstSound; pEff; pEff=pEff->Next)
242  pEff->ClearPointers(pObj);
243 }
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 140 of file C4SoundSystem.cpp.

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

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

141 {
142  char szName[C4MaxSoundName+2+1];
143  // Evaluate sound name (see GetEffect)
144  SCopy(szSndName,szName,C4MaxSoundName);
145  DefaultExtension(szName,"*");
146  // Find an effect with a matching instance
147  for (C4SoundEffect *csfx = FirstSound; csfx; csfx = csfx->Next)
148  if (WildcardMatch(szName, csfx->Name))
149  {
150  C4SoundInstance *pInst = csfx->GetInstance(pObj);
151  if (pInst) return pInst;
152  }
153  return nullptr;
154 }
void SCopy(const char *szSource, char *sTarget, size_t iMaxL)
Definition: Standard.cpp:152
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:152
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:320
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 245 of file C4SoundSystem.cpp.

References FirstSound, and C4SoundEffect::Next.

Referenced by C4SoundModifierList::SetGlobalModifier().

246 {
247  // Return by searching through effect linked list.
248  for (C4SoundEffect *pSfx = FirstSound; pSfx; pSfx = pSfx->Next)
249  if (pSfx->FirstInst) return pSfx->FirstInst;
250  return nullptr;
251 }
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 253 of file C4SoundSystem.cpp.

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

Referenced by C4SoundModifierList::SetGlobalModifier().

254 {
255  // Return by searching through instance linked list and parent linked list of effects
256  assert(prev && prev->pEffect);
257  if (prev->pNext) return prev->pNext;
258  for (C4SoundEffect *pSfx = prev->pEffect->Next; pSfx; pSfx = pSfx->Next)
259  if (pSfx->FirstInst) return pSfx->FirstInst;
260  return nullptr;
261 }
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:82
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 158 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().

159 {
160  // Local definition sounds: If there is a Sound.ocg in the group, load the sound from there
161  if(group_is_root && hGroup.FindEntry(C4CFN_Sound))
162  {
163  C4Group g;
164  g.OpenAsChild(&hGroup, C4CFN_Sound, false, false);
165  return LoadEffects(g, namespace_prefix, false);
166  }
167  int32_t iNum=0;
168  char szFilename[_MAX_FNAME+1];
169  char szFileType[_MAX_FNAME+1];
170  C4SoundEffect *nsfx;
171  // Process segmented list of file types
172  for (int32_t i = 0; SCopySegment(C4CFN_SoundFiles, i, szFileType, '|', _MAX_FNAME); i++)
173  {
174  // Search all sound files in group
175  hGroup.ResetSearch();
176  while (hGroup.FindNextEntry(szFileType, szFilename))
177  // Create and load effect
178  if ((nsfx = new C4SoundEffect))
179  {
180  if (nsfx->Load(szFilename, hGroup, namespace_prefix))
181  {
182  // Overload same name effects
183  RemoveEffect(nsfx->Name);
184  // Add effect
185  nsfx->Next=FirstSound;
186  FirstSound=nsfx;
187  iNum++;
188  }
189  else
190  delete nsfx;
191  }
192  }
193  // Load subgroups from Sound.ocg and other subgroups
194  if (!group_is_root)
195  {
196  hGroup.ResetSearch();
197  while (hGroup.FindNextEntry(C4CFN_SoundSubgroups, szFilename))
198  {
199  // Load from subgroup as a sub-namespace
200  // get namespace name
201  StdStrBuf sub_namespace;
202  if (namespace_prefix)
203  {
204  sub_namespace.Copy(namespace_prefix);
205  sub_namespace.Append("::");
206  }
207  sub_namespace.Append(szFilename, strlen(szFilename) - strlen(C4CFN_SoundSubgroups) + 1);
208  // load from child group
209  C4Group subgroup;
210  if (subgroup.OpenAsChild(&hGroup, szFilename, false, false))
211  {
212  iNum += LoadEffects(subgroup, sub_namespace.getData(), false);
213  }
214  }
215  }
216  return iNum;
217 }
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:273
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:172
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 #if !defined(USE_CONSOLE)
132  DebugLogF("Warning: could not find sound matching '%s'", szSndName);
133 #endif
134  return nullptr;
135  }
136  // Play
137  return csfx->New(fLoop, iVolume, pObj, iCustomFalloffDistance, iPitch, modifier);
138 }
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:288
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 219 of file C4SoundSystem.cpp.

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

Referenced by LoadEffects().

220 {
221  int32_t iResult=0;
222  C4SoundEffect *pNext,*pPrev=nullptr;
223  for (C4SoundEffect *pSfx=FirstSound; pSfx; pSfx=pNext)
224  {
225  pNext=pSfx->Next;
226  if (WildcardMatch(szFilename,pSfx->Name))
227  {
228  delete pSfx;
229  if (pPrev) pPrev->Next=pNext;
230  else FirstSound=pNext;
231  iResult++;
232  }
233  else
234  pPrev=pSfx;
235  }
236  return iResult;
237 }
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: