File: SoundEntity.h

package info (click to toggle)
scummvm 2.9.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 450,268 kB
  • sloc: cpp: 4,297,604; asm: 28,322; python: 12,901; sh: 11,219; java: 8,477; xml: 7,843; perl: 2,633; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (177 lines) | stat: -rw-r--r-- 4,562 bytes parent folder | download | duplicates (2)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*
 * Copyright (C) 2006-2010 - Frictional Games
 *
 * This file is part of HPL1 Engine.
 */

#ifndef HPL_SOUND_ENTITY_H
#define HPL_SOUND_ENTITY_H

#include "hpl1/engine/scene/Entity3D.h"
#include "hpl1/engine/sound/SoundChannel.h"

namespace hpl {

class cSoundHandler;
class cSoundEntityData;
class cSoundEntityManager;
class cWorld3D;
class cSoundEntry;

enum eSoundEntityType {
	eSoundEntityType_Main,
	eSoundEntityType_Start,
	eSoundEntityType_Stop,
	eSoundEntityType_LastEnum
};

class cSoundEntity;

class cSoundEntityChannelCallback : public iSoundChannelCallback {
public:
	virtual ~cSoundEntityChannelCallback() = default;
	void OnPriorityRelease();

	cSoundEntity *mpEntity;
};

//----------------------------------------

kSaveData_ChildClass(iEntity3D, cSoundEntity) {
	kSaveData_ClassInit(cSoundEntity) public : tString msData;
	bool mbStopped;
	bool mbRemoveWhenOver;
	bool mbStarted;
	bool mbFadingOut;
	float mfVolume;

	virtual iSaveObject *CreateSaveObject(cSaveObjectHandler * apSaveObjectHandler, cGame * apGame);
	virtual int GetSaveCreatePrio();
};

//------------------------------------------

class iSoundEntityGlobalCallback {
public:
	virtual ~iSoundEntityGlobalCallback() = default;
	virtual void OnStart(cSoundEntity *apSoundEntity) = 0;
};

typedef Common::List<iSoundEntityGlobalCallback *> tSoundEntityGlobalCallbackList;
typedef tSoundEntityGlobalCallbackList::iterator tSoundEntityGlobalCallbackListIt;

//------------------------------------------

class cSoundEntity : public iEntity3D {
	typedef iEntity3D super;
	friend class cSoundEntityChannelCallback;

public:
	static void initGlobalCallbackList();
	static void finalizeGlobalCallbackList();

	cSoundEntity(const tString &asName, cSoundEntityData *apData,
				 cSoundEntityManager *apSoundEntityManager,
				 cWorld3D *apWorld,
				 cSoundHandler *apSoundHandler, bool abRemoveWhenOver);
	virtual ~cSoundEntity();

	void Play(bool abPlayStart = true);
	void Stop(bool abPlayEnd = true);

	void FadeIn(float afSpeed);
	void FadeOut(float afSpeed);

	bool IsStopped();
	bool IsFadingOut();
	float getFadingSpeed() { return _fadeSpeed; }
	bool GetRemoveWhenOver();

	void SetVolume(float afX) { mfVolume = afX; }
	float GetVolume() { return mfVolume; }

	iSoundChannel *GetSound(eSoundEntityType aType) { return mvSounds[aType]; }
	cSoundEntry *GetSoundEntry(eSoundEntityType aType);

	// Entity implementation
	void UpdateLogic(float afTimeStep);

	tString GetEntityType() { return "SoundEntity"; }

	cSoundEntityData *GetData() { return mpData; }

	static void AddGlobalCallback(iSoundEntityGlobalCallback *apCallback);
	static void RemoveGlobalCallback(iSoundEntityGlobalCallback *apCallback);

	// SaveObject implementation
	virtual iSaveData *CreateSaveData();
	virtual void SaveToSaveData(iSaveData *apSaveData);
	virtual void LoadFromSaveData(iSaveData *apSaveData);
	virtual void SaveDataSetup(cSaveObjectHandler *apSaveObjectHandler, cGame *apGame);

private:
	bool PlaySound(const tString &asName, bool abLoop, eSoundEntityType aType);

	float GetListenerSqrLength();

	cSoundEntityManager *mpSoundEntityManager;
	cSoundHandler *mpSoundHandler;
	cSoundEntityData *mpData;
	cWorld3D *mpWorld;

	iSoundChannel *mvSounds[3];
	// cSoundEntry *mvSoundEntries[3];
	int mvSoundId[3];

	bool mbStopped;
	bool mbRemoveWhenOver;

	bool mbOutOfRange;

	float mfIntervalCount;

	cSoundEntityChannelCallback *mpSoundCallback;

	bool mbStarted;

	bool mbFadingOut;

	bool mbLog;

	float mfVolume;

	bool mbPrioRemove;

	bool mbSkipStartEnd;

	float mfSleepCount;

	float _fadeSpeed;

	static tSoundEntityGlobalCallbackList *mlstGlobalCallbacks;
};

} // namespace hpl

#endif // HPL_SOUND_ENTITY_H