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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef SOUNDITEM_H
#define SOUNDITEM_H
#include <string>
#include <memory>
#include "System/UnorderedMap.hpp"
class SoundBuffer;
/**
* @brief A class representing a sound which can be played
*
* This can be played by CSoundSource.
* Each soundsource has exactly one SoundBuffer it wraps around, while one buffer can be shared among multiple Items.
* You can adjust various playing parameters within this class, so you can have 1 buffer and multiple SoundItems
* which differ in pitch, volume etc.
*/
class SoundItem
{
friend class CSoundSource;
public:
SoundItem() = default;
SoundItem(size_t itemID, size_t bufferID, const spring::unordered_map<std::string, std::string>& items);
SoundItem(SoundItem&& s) { *this = std::move(s); }
SoundItem& operator = (SoundItem&& s) {
soundItemID = s.soundItemID;
soundBufferID = s.soundBufferID;
name = std::move(s.name);
gain = s.gain;
gainMod = s.gainMod;
pitch = s.pitch;
pitchMod = s.pitchMod;
dopplerScale = s.dopplerScale;
maxDist = s.maxDist;
rolloff = s.rolloff;
priority = s.priority;
maxConcurrent = s.maxConcurrent;
currentlyPlaying = s.currentlyPlaying;
loopTime = s.loopTime;
in3D = s.in3D;
return *this;
}
bool PlayNow();
void StopPlay();
size_t GetSoundBufferID() const { return soundBufferID; }
float MaxDistance() const { return maxDist; }
const std::string& Name() const { return name; }
const int GetPriority() const { return priority; }
float GetGain() const;
float GetPitch() const;
private:
size_t soundItemID = 0;
size_t soundBufferID = 0;
/// unique identifier (if no name is specified, this will be the filename)
std::string name;
/// volume gain, applied to this sound
float gain = 1.0f;
float gainMod = 0.0f;
/// sound pitch (multiplied with globalPitch from CSoundSource when played)
float pitch = 1.0f;
float pitchMod = 0.0f;
float dopplerScale = 1.0f;
float maxDist = 0.0f;
float rolloff = 1.0f;
int priority = 0;
unsigned maxConcurrent = 16;
unsigned currentlyPlaying = 0;
unsigned loopTime = 0;
bool in3D = true;
};
#endif
|
