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
178
179
180
181
182
183
184
185
186
187
188
|
/* 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/>.
*
*/
#ifndef SCUMM_SOUND_H
#define SCUMM_SOUND_H
#include "common/scummsys.h"
#include "common/serializer.h"
#include "common/str.h"
#include "audio/mididrv.h"
#include "backends/audiocd/audiocd.h"
#include "scumm/file.h"
// The number of "ticks" (1/10th of a second) into the Overture that the
// LucasFilm logo should appear. This corresponds to a timer value of 204.
// The default value is selected to work well with the Ozawa recording.
#define DEFAULT_LOOM_OVERTURE_TRANSITION 1160
#define DIGI_SND_MODE_EMPTY 0
#define DIGI_SND_MODE_SFX 1
#define DIGI_SND_MODE_TALKIE 2
namespace Audio {
class Mixer;
class SoundHandle;
}
namespace Scumm {
class ScummEngine;
struct MP3OffsetTable;
enum {
kTalkSoundID = 10000
};
// TODO: Consider splitting Sound into even more subclasses.
// E.g. for v1-v4, v5, v6+, ...
class Sound : public Common::Serializable {
public:
enum SoundMode {
kVOCMode,
kMP3Mode,
kVorbisMode,
kFLACMode
};
protected:
ScummEngine *_vm;
Audio::Mixer *_mixer;
int16 _midiQueuePos, _midiQueue[0x100];
int16 _soundQueuePos;
struct {
int16 sound;
int32 offset;
int16 channel;
int16 flags;
int16 freq;
int16 pan;
int16 vol;
} _soundQueue[10];
Common::String _sfxFilename;
byte _sfxFileEncByte;
SoundMode _soundMode;
MP3OffsetTable *_offsetTable; // For compressed audio
int _numSoundEffects; // For compressed audio
uint32 _queuedSfxOffset, _queuedTalkieOffset, _queuedSfxLen, _queuedTalkieLen;
byte _queuedSoundMode, _queuedSfxChannel;
bool _mouthSyncMode;
bool _endOfMouthSync;
uint16 _mouthSyncTimes[64];
uint _curSoundPos;
int16 _currentCDSound;
int16 _currentMusic;
Audio::SoundHandle *_loomSteamCDAudioHandle;
bool _isLoomSteam;
AudioCDManager::Status _loomSteamCD;
bool _useReplacementAudioTracks;
int _musicTimer;
int _loomOvertureTransition;
uint32 _replacementTrackStartTime;
public:
Audio::SoundHandle *_talkChannelHandle; // Handle of mixer channel actor is talking on
bool _soundsPaused;
byte _digiSndMode;
uint _lastSound;
uint32 _cdMusicTimerMod;
uint32 _cdMusicTimer;
uint32 _speechTimerMod;
MidiDriverFlags _musicType;
public:
Sound(ScummEngine *parent, Audio::Mixer *mixer, bool useReplacementAudioTracks);
~Sound() override;
virtual void startSound(int sound, int heOffset = 0, int heChannel = 0, int heFlags = 0, int heFreq = 0, int hePan = 0, int heVol = 0);
virtual void addSoundToQueue(int sound, int heOffset = 0, int heChannel = 0, int heFlags = 0, int heFreq = 0, int hePan = 0, int heVol = 0);
void processSound();
virtual void modifySound(int sound, int offset, int frequencyShift, int pan, int volume, int flags) {};
void triggerSound(int soundID);
void startTalkSound(uint32 offset, uint32 b, int mode, Audio::SoundHandle *handle = NULL);
void stopTalkSound();
bool isMouthSyncOff(uint pos);
virtual int isSoundRunning(int sound) const;
virtual bool isSoundInUse(int sound) const;
virtual void stopSound(int sound);
virtual void stopAllSounds();
void soundKludge(int *list, int num);
void talkSound(uint32 offset, uint32 length, int mode, int channel = 0);
virtual void setupSound();
virtual void pauseSounds(bool pause);
bool isSfxFileCompressed();
bool hasSfxFile() const;
ScummFile *restoreDiMUSESpeechFile(const char *fileName);
void extractSyncsFromDiMUSEMarker(const char *marker);
void incrementSpeechTimer();
void resetSpeechTimer();
void startSpeechTimer();
void stopSpeechTimer();
bool speechIsPlaying(); // Used within MIDI iMUSE
void startCDTimer();
void stopCDTimer();
void playCDTrack(int track, int numLoops, int startFrame, int duration);
void playCDTrackInternal(int track, int numLoops, int startFrame, int duration);
void stopCD();
int pollCD() const;
void updateCD();
AudioCDManager::Status getCDStatus();
int getCurrentCDSound() const { return _currentCDSound; }
int getCDTrackIdFromSoundId(int soundId, int &loops, int &start);
bool isRolandLoom() const;
bool useReplacementAudio() const { return _useReplacementAudioTracks; }
void updateMusicTimer();
int getMusicTimer() const { return _musicTimer; }
int getCDMusicTimer() const { return _cdMusicTimer; }
void saveLoadWithSerializer(Common::Serializer &ser) override;
void restoreAfterLoad();
bool isAudioDisabled();
protected:
void setupSfxFile();
bool isSfxFinished() const;
void processSfxQueues();
bool isSoundInQueue(int sound) const;
virtual void processSoundQueues();
int getReplacementAudioTrack(int soundID);
};
} // End of namespace Scumm
#endif
|
