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
|
/* 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_MUSICHANDLER_H
#define HPL_MUSICHANDLER_H
#include "common/list.h"
#include "hpl1/engine/system/SystemTypes.h"
namespace hpl {
class iLowLevelSound;
class iSoundChannel;
////////////////////////////////////////////////////
//////////// MUSIC LOCK ///////////////////////////
////////////////////////////////////////////////////
class cMusicLock {
public:
cMusicLock() : msFileName(""), mfVolume(0) {}
tString msFileName;
float mfVolume;
bool mbLoop;
};
////////////////////////////////////////////////////
//////////// MUSIC ENTRY ///////////////////////////
////////////////////////////////////////////////////
class cMusicEntry {
public:
cMusicEntry() : msFileName(""), mpStream(NULL), mfMaxVolume(1),
mfVolume(0), mfVolumeAdd(0.01f) {}
tString msFileName;
iSoundChannel *mpStream;
float mfMaxVolume;
float mfVolume;
float mfVolumeAdd;
bool mbLoop;
};
typedef Common::List<cMusicEntry *> tMusicEntryList;
typedef tMusicEntryList::iterator tMusicEntryListIt;
////////////////////////////////////////////////////
//////////// MUSIC HANDLER ///////////////////////
////////////////////////////////////////////////////
class cResources;
class cMusicHandler {
public:
cMusicHandler(iLowLevelSound *apLowLevelSound, cResources *apResources);
~cMusicHandler();
/**
* Play a song. Playing a song that is already playing updates it's properties.
* \param asFileName file to be played
* \param afVolume volume to be played at
* \param afFadeStepSize volume increse/decrease per app step when fading to new volume.
* \param abLoop If the music should be looped or not.
* \return
*/
bool Play(const tString &asFileName, float afVolume, float afFadeStepSize, bool abLoop);
/**
* Stop playing the current music.
* \param afFadeStepSize volume increse/decrease per app step when fading volume to 0.
*/
void Stop(float afFadeStepSize);
void Pause();
void Resume();
/**
* No more music can be played when locked. Latest song that has been tried to be palyed is saved in lock.
* \param apLock
*/
void Lock(cMusicLock *apLock);
/**
* Remove lock.
*/
void UnLock();
tString GetCurrentSongName();
float GetCurrentSongVolume();
cMusicEntry *GetCurrentSong();
void Update(float afTimeStep);
private:
iLowLevelSound *mpLowLevelSound;
cResources *mpResources;
tMusicEntryList mlstFadingSongs;
cMusicEntry *mpMainSong;
cMusicLock *mpLock;
bool mbIsPaused;
bool LoadAndStart(const tString &asFileName, cMusicEntry *apSong, float afVolume, bool abLoop);
};
} // namespace hpl
#endif // HPL_MUSICHANDLER_H
|
