Pyrogenesis  trunk
CSoundBase.h
Go to the documentation of this file.
1 /* Copyright (C) 2015 Wildfire Games.
2  * This file is part of 0 A.D.
3  *
4  * 0 A.D. is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * 0 A.D. is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef INCLUDED_CSOUNDBASE_H
19 #define INCLUDED_CSOUNDBASE_H
20 
21 #include "lib/config2.h"
22 
23 #if CONFIG2_AUDIO
24 
26 #include "ps/ThreadUtil.h"
29 
30 class CSoundBase : public ISoundItem
31 {
32 protected:
33 
34  ALuint m_ALSource;
36 
37  bool m_LastPlay;
38  bool m_Looping;
41  bool m_IsPaused;
42 
44  double m_EndFadeTime;
45 
46  ALfloat m_StartVolume;
47  ALfloat m_EndVolume;
49 
50 public:
51  CSoundBase();
52 
53  virtual ~CSoundBase();
54 
55  bool InitOpenAL();
56  void ResetVars();
57  void EnsurePlay();
58 
59  void SetGain(ALfloat gain);
60  void SetRollOff(ALfloat gain);
61  void SetPitch(ALfloat pitch);
62  void SetDirection(const CVector3D& direction);
63  void SetCone(ALfloat innerCone, ALfloat outerCone, ALfloat coneGain);
64  void SetLastPlay(bool last);
65  void ReleaseOpenAL();
66  bool IsFading();
67  bool Finished();
68 
69  void Play();
70  void PlayAndDelete();
71  void PlayLoop();
72  void Stop();
73  void StopAndDelete();
74  void FadeToIn(ALfloat newVolume, double fadeDuration);
75 
76  bool GetLooping();
77  bool IsPlaying();
78 
79  void SetLocation(const CVector3D& position);
80  void FadeAndDelete(double fadeTime);
81  void FadeAndPause(double fadeTime);
82 
83  void Pause();
84  void Resume();
85 
86  const Path GetName();
87 
88  virtual void SetLooping(bool loops);
89  virtual bool IdleTask();
90  virtual void Attach(CSoundData* itemData);
91 
92 protected:
93 
94  void SetNameFromPath(VfsPath& itemPath);
95  void ResetFade();
96  bool HandleFade();
97 };
98 
99 #endif // CONFIG2_AUDIO
100 
101 #endif // INCLUDED_CSOUNDBASE_H
void PlayLoop()
Definition: CSoundBase.cpp:320
CSoundBase()
Definition: CSoundBase.cpp:29
void SetLocation(const CVector3D &position)
Definition: CSoundBase.cpp:210
void SetRollOff(ALfloat gain)
Definition: CSoundBase.cpp:130
ALuint m_ALSource
Definition: CSoundBase.h:34
void FadeAndDelete(double fadeTime)
Definition: CSoundBase.cpp:308
void StopAndDelete()
Definition: CSoundBase.cpp:314
void Pause()
Definition: CSoundBase.cpp:370
Definition: ISoundItem.h:29
bool m_ShouldBePlaying
Definition: CSoundBase.h:39
Definition: Vector3D.h:28
void Play()
Definition: CSoundBase.cpp:275
void Resume()
Definition: CSoundBase.cpp:380
void ReleaseOpenAL()
Definition: CSoundBase.cpp:40
virtual ~CSoundBase()
Definition: CSoundBase.cpp:34
Definition: CSoundBase.h:30
A non-recursive mutual exclusion lock.
Definition: ThreadUtil.h:45
ALfloat m_StartVolume
Definition: CSoundBase.h:46
bool m_LastPlay
Definition: CSoundBase.h:37
virtual bool IdleTask()
Definition: CSoundBase.cpp:205
bool m_Looping
Definition: CSoundBase.h:38
void SetGain(ALfloat gain)
Definition: CSoundBase.cpp:118
void Stop()
Definition: CSoundBase.cpp:347
void SetPitch(ALfloat pitch)
Definition: CSoundBase.cpp:165
Definition: SoundData.h:34
Definition: path.h:77
virtual void SetLooping(bool loops)
Definition: CSoundBase.cpp:265
bool m_PauseAfterFade
Definition: CSoundBase.h:40
bool GetLooping()
Definition: CSoundBase.cpp:260
bool HandleFade()
Definition: CSoundBase.cpp:220
void PlayAndDelete()
Definition: CSoundBase.cpp:296
void ResetFade()
Definition: CSoundBase.cpp:80
void ResetVars()
Definition: CSoundBase.cpp:65
CMutex m_ItemMutex
Definition: CSoundBase.h:48
bool m_IsPaused
Definition: CSoundBase.h:41
void SetCone(ALfloat innerCone, ALfloat outerCone, ALfloat coneGain)
Definition: CSoundBase.cpp:150
bool IsPlaying()
Definition: CSoundBase.cpp:186
double m_StartFadeTime
Definition: CSoundBase.h:43
bool InitOpenAL()
Definition: CSoundBase.cpp:94
virtual void Attach(CSoundData *itemData)
Definition: CSoundBase.cpp:60
CSoundData * m_SoundData
Definition: CSoundBase.h:35
void EnsurePlay()
Definition: CSoundBase.cpp:144
bool Finished()
Definition: CSoundBase.cpp:89
ALfloat m_EndVolume
Definition: CSoundBase.h:47
double m_EndFadeTime
Definition: CSoundBase.h:44
void SetDirection(const CVector3D &direction)
Definition: CSoundBase.cpp:175
void FadeAndPause(double fadeTime)
Definition: CSoundBase.cpp:302
void SetNameFromPath(VfsPath &itemPath)
bool IsFading()
Definition: CSoundBase.cpp:254
void FadeToIn(ALfloat newVolume, double fadeDuration)
Definition: CSoundBase.cpp:330
void SetLastPlay(bool last)
Definition: CSoundBase.cpp:200
const Path GetName()
Definition: CSoundBase.cpp:362