1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef I_AUDIO_CHANNEL_H
#define I_AUDIO_CHANNEL_H
#include <string.h>
#include "System/float3.h"
struct GuiSoundSet;
class CSoundSource;
class CUnit;
class CWorldObject;
/**
* @brief Channel for playing sounds
*
* Has its own volume "slider", and can be enabled / disabled seperately.
* Abstract base class.
*/
class IAudioChannel {
protected:
IAudioChannel();
virtual ~IAudioChannel();
public:
virtual void Enable(bool newState) = 0;
bool IsEnabled() const
{
return enabled;
}
/**
* @param newVolume [0.0, 1.0]
*/
virtual void SetVolume(float newVolume) = 0;
/**
* @return [0.0, 1.0]
*/
float GetVolume() const
{
return volume;
}
virtual void PlaySample(size_t id, float volume = 1.0f) = 0;
virtual void PlaySample(size_t id, const float3& p, float volume = 1.0f) = 0;
virtual void PlaySample(size_t id, const float3& p, const float3& velocity, float volume = 1.0f) = 0;
virtual void PlaySample(size_t id, const CUnit* u, float volume = 1.0f) = 0;
virtual void PlaySample(size_t id, const CWorldObject* p, float volume = 1.0f) = 0;
virtual void PlayRandomSample(const GuiSoundSet& soundSet, const CUnit* unit) = 0;
virtual void PlayRandomSample(const GuiSoundSet& soundSet, const float3& pos) = 0;
/**
* @brief Start playing an ogg-file
*
* NOT threadsafe, unlike the other functions!
* If another file is playing, it will stop it and play the new one instead.
*/
virtual void StreamPlay(const std::string& path, float volume = 1.0f, bool enqueue = false) = 0;
/**
* @brief Stop playback
*
* Don't call this if you just want to play another file (for performance).
*/
virtual void StreamStop() = 0;
virtual void StreamPause() = 0;
virtual float StreamGetTime() = 0;
virtual float StreamGetPlayTime() = 0;
void UpdateFrame() {
emmitsThisFrame = 0;
}
void SetMaxEmmits(unsigned max) {
emmitsPerFrame = max;
}
void SetMaxConcurrent(unsigned max) {
maxConcurrentSources = max;
}
protected:
virtual void FindSourceAndPlay(size_t id, const float3& p, const float3& velocity, float volume, bool relative) = 0;
virtual void SoundSourceFinished(CSoundSource* sndSource) = 0;
friend class CSoundSource;
public:
float volume;
bool enabled;
protected:
unsigned emmitsPerFrame;
unsigned emmitsThisFrame;
unsigned maxConcurrentSources;
};
#endif // I_AUDIO_CHANNEL_H
|
