1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #include "kyra/sound/sound_intern.h"
24 #include "kyra/resource/resource.h"
25 
26 #include "audio/softsynth/fmtowns_pc98/towns_euphony.h"
27 
28 #include "common/config-manager.h"
29 
30 #include "backends/audiocd/audiocd.h"
31 
32 namespace Kyra {
33 
SoundTowns_LoK(KyraEngine_v1 * vm,Audio::Mixer * mixer)34 SoundTowns_LoK::SoundTowns_LoK(KyraEngine_v1 *vm, Audio::Mixer *mixer)
35 	: Sound(vm, mixer), _lastTrack(-1), _musicTrackData(0), _sfxFileData(0), _cdaPlaying(0),
36 	_sfxFileIndex((uint)-1), _musicFadeTable(0), _sfxWDTable(0), _sfxBTTable(0), _sfxChannel(0x46), _currentResourceSet(0) {
37 	memset(&_resInfo, 0, sizeof(_resInfo));
38 	_player = new EuphonyPlayer(_mixer);
39 }
40 
~SoundTowns_LoK()41 SoundTowns_LoK::~SoundTowns_LoK() {
42 	g_system->getAudioCDManager()->stop();
43 	haltTrack();
44 	delete _player;
45 	delete[] _musicTrackData;
46 	delete[] _sfxFileData;
47 	for (int i = 0; i < 3; i++)
48 		initAudioResourceInfo(i, 0);
49 }
50 
init()51 bool SoundTowns_LoK::init() {
52 	if (!_vm->existExtractedCDAudioFiles()
53 	    && !_vm->isDataAndCDAudioReadFromSameCD()) {
54 		_vm->warnMissingExtractedCDAudio();
55 	}
56 	int unused = 0;
57 	_musicFadeTable = _vm->staticres()->loadRawData(k1TownsMusicFadeTable, unused);
58 	_sfxWDTable = _vm->staticres()->loadRawData(k1TownsSFXwdTable, unused);
59 	_sfxBTTable = _vm->staticres()->loadRawData(k1TownsSFXbtTable, unused);
60 	_musicTrackData = new uint8[50570];
61 
62 	if (!_player->init())
63 		return false;
64 
65 	if (!loadInstruments())
66 		return false;
67 
68 	/*_player->driver()->intf()->callback(68);
69 	_player->driver()->intf()->callback(70, 0x33);*/
70 	_player->driver()->setOutputVolume(1, 118, 118);
71 
72 	// Initialize CD for audio
73 	g_system->getAudioCDManager()->open();
74 
75 	return true;
76 }
77 
process()78 void SoundTowns_LoK::process() {
79 	g_system->getAudioCDManager()->update();
80 }
81 
playTrack(uint8 track)82 void SoundTowns_LoK::playTrack(uint8 track) {
83 	if (track < 2)
84 		return;
85 	track -= 2;
86 
87 	uint tTableIndex = 3 * track;
88 
89 	assert(tTableIndex + 2 < res()->cdaTableSize);
90 
91 	int trackNum = (int)READ_LE_UINT32(&res()->cdaTable[tTableIndex + 2]);
92 	int32 loop = (int32)READ_LE_UINT32(&res()->cdaTable[tTableIndex + 1]);
93 
94 	if (track == _lastTrack && _musicEnabled)
95 		return;
96 
97 	beginFadeOut();
98 
99 	if (_musicEnabled == 2 && trackNum != -1) {
100 		_player->driver()->setOutputVolume(1, 118, 118);
101 		g_system->getAudioCDManager()->play(trackNum + 1, loop ? -1 : 1, 0, 0);
102 		g_system->getAudioCDManager()->update();
103 		_cdaPlaying = true;
104 	} else if (_musicEnabled) {
105 		playEuphonyTrack(READ_LE_UINT32(&res()->cdaTable[tTableIndex]), loop);
106 		_cdaPlaying = false;
107 	}
108 
109 	_lastTrack = track;
110 }
111 
haltTrack()112 void SoundTowns_LoK::haltTrack() {
113 	_lastTrack = -1;
114 	g_system->getAudioCDManager()->stop();
115 	g_system->getAudioCDManager()->update();
116 	_cdaPlaying = false;
117 
118 	for (int i = 0; i < 6; i++)
119 		_player->driver()->channelVolume(i, 0);
120 	for (int i = 0x40; i < 0x46; i++)
121 		_player->driver()->channelVolume(i, 0);
122 	for (int i = 0; i < 32; i++)
123 		_player->configPart_enable(i, 0);
124 	_player->stop();
125 }
126 
initAudioResourceInfo(int set,void * info)127 void SoundTowns_LoK::initAudioResourceInfo(int set, void *info) {
128 	if (set >= kMusicIntro && set <= kMusicFinale) {
129 		delete _resInfo[set];
130 		_resInfo[set] = info ? new SoundResourceInfo_Towns(*(SoundResourceInfo_Towns*)info) : 0;
131 	}
132 }
133 
selectAudioResourceSet(int set)134 void SoundTowns_LoK::selectAudioResourceSet(int set) {
135 	if (set >= kMusicIntro && set <= kMusicFinale) {
136 		if (_resInfo[set])
137 			_currentResourceSet = set;
138 	}
139 }
140 
hasSoundFile(uint file) const141 bool SoundTowns_LoK::hasSoundFile(uint file) const {
142 	if (file < res()->fileListSize)
143 		return (res()->fileList[file] != 0);
144 	return false;
145 }
146 
loadSoundFile(uint file)147 void SoundTowns_LoK::loadSoundFile(uint file) {
148 	if (_sfxFileIndex == file || file >= res()->fileListSize)
149 		return;
150 	_sfxFileIndex = file;
151 	delete[] _sfxFileData;
152 	_sfxFileData = _vm->resource()->fileData(res()->fileList[file], 0);
153 }
154 
playSoundEffect(uint16 track,uint8)155 void SoundTowns_LoK::playSoundEffect(uint16 track, uint8) {
156 	if (!_sfxEnabled || !_sfxFileData)
157 		return;
158 
159 	if (track == 0 || track == 10) {
160 		stopAllSoundEffects();
161 		return;
162 	} else if (track == 1) {
163 		fadeOutSoundEffects();
164 		return;
165 	}
166 
167 	uint8 note = 60;
168 	if (_sfxFileIndex == 5) {
169 		if (track == 16) {
170 			note = 62;
171 			track = 15;
172 		} else if (track == 17) {
173 			note = 64;
174 			track = 15;
175 		} else if (track == 18) {
176 			note = 65;
177 			track = 15;
178 		}
179 	}
180 
181 	uint8 *fileBody = _sfxFileData + 0x01B8;
182 	int32 offset = (int32)READ_LE_UINT32(_sfxFileData + (track - 0x0B) * 4);
183 	if (offset == -1)
184 		return;
185 
186 	if (!_player->driver()->soundEffectIsPlaying(_sfxChannel ^ 1)) {
187 		_sfxChannel ^= 1;
188 	} else if (_player->driver()->soundEffectIsPlaying(_sfxChannel)) {
189 		_sfxChannel ^= 1;
190 		_player->driver()->stopSoundEffect(_sfxChannel);
191 	}
192 
193 	uint32 *sfxHeader = (uint32 *)(fileBody + offset);
194 	uint32 sfxHeaderID = READ_LE_UINT32(sfxHeader);
195 	uint32 playbackBufferSize = sfxHeaderID == 1 ? 30704 : READ_LE_UINT32(&sfxHeader[3]);
196 
197 	uint8 *sfxPlaybackBuffer = new uint8[playbackBufferSize + 32];
198 	memcpy(sfxPlaybackBuffer, fileBody + offset, 32);
199 
200 	uint8 *dst = sfxPlaybackBuffer + 32;
201 	memset(dst, 0x80, playbackBufferSize);
202 
203 	uint8 *sfxBody = ((uint8 *)sfxHeader) + 0x20;
204 
205 	if (!sfxHeaderID) {
206 		memcpy(dst, sfxBody, playbackBufferSize);
207 	} else if (sfxHeaderID == 1) {
208 		Screen::decodeFrame4(sfxBody, dst, playbackBufferSize);
209 	} else if (_sfxWDTable) {
210 		uint8 *tgt = dst;
211 		uint32 sfx_BtTable_Offset = 0;
212 		uint32 sfx_WdTable_Offset = 0;
213 		uint32 sfx_WdTable_Number = 5;
214 		uint32 inSize = READ_LE_UINT32(&sfxHeader[1]);
215 
216 		for (uint32 i = 0; i < inSize; i++) {
217 			sfx_WdTable_Offset = (sfx_WdTable_Number * 3 << 9) + sfxBody[i] * 6;
218 			sfx_WdTable_Number = READ_LE_UINT16(_sfxWDTable + sfx_WdTable_Offset);
219 
220 			sfx_BtTable_Offset += (int16)READ_LE_UINT16(_sfxWDTable + sfx_WdTable_Offset + 2);
221 			*tgt++ = _sfxBTTable[((sfx_BtTable_Offset >> 2) & 0xFF)];
222 
223 			sfx_BtTable_Offset += (int16)READ_LE_UINT16(_sfxWDTable + sfx_WdTable_Offset + 4);
224 			*tgt++ = _sfxBTTable[((sfx_BtTable_Offset >> 2) & 0xFF)];
225 		}
226 	}
227 
228 	_player->driver()->channelVolume(_sfxChannel, 127);
229 	_player->driver()->channelPan(_sfxChannel, 0x40);
230 	_player->driver()->channelPitch(_sfxChannel, 0);
231 	_player->driver()->playSoundEffect(_sfxChannel, note, 127, sfxPlaybackBuffer);
232 	delete[] sfxPlaybackBuffer;
233 }
234 
updateVolumeSettings()235 void SoundTowns_LoK::updateVolumeSettings() {
236 	if (!_player)
237 		return;
238 
239 	bool mute = false;
240 	if (ConfMan.hasKey("mute"))
241 		mute = ConfMan.getBool("mute");
242 
243 	_player->driver()->setMusicVolume((mute ? 0 : ConfMan.getInt("music_volume")));
244 	_player->driver()->setSoundEffectVolume((mute ? 0 : ConfMan.getInt("sfx_volume")));
245 }
246 
stopAllSoundEffects()247 void SoundTowns_LoK::stopAllSoundEffects() {
248 	_player->driver()->channelVolume(0x46, 0);
249 	_player->driver()->channelVolume(0x47, 0);
250 	_player->driver()->stopSoundEffect(0x46);
251 	_player->driver()->stopSoundEffect(0x47);
252 	_sfxChannel = 0x46;
253 }
254 
beginFadeOut()255 void SoundTowns_LoK::beginFadeOut() {
256 	if (_cdaPlaying) {
257 		for (int i = 118; i > 103; i--) {
258 			_player->driver()->setOutputVolume(1, i, i);
259 			_vm->delay(2 * _vm->tickLength());
260 		}
261 
262 		for (int i = 103; i > 83; i -= 2) {
263 			_player->driver()->setOutputVolume(1, i, i);
264 			_vm->delay(2 * _vm->tickLength());
265 		}
266 
267 		for (int i = 83; i > 58; i -= 2) {
268 			_player->driver()->setOutputVolume(1, i, i);
269 			_vm->delay(_vm->tickLength());
270 		}
271 
272 		for (int i = 58; i > 0; i--) {
273 			_player->driver()->setOutputVolume(1, i, i);
274 			_vm->delay(1);
275 		}
276 
277 		_player->driver()->setOutputVolume(1, 0, 0);
278 
279 	} else {
280 		if (_lastTrack == -1)
281 			return;
282 
283 		uint32 ticks = 2;
284 		int tickAdv = 0;
285 
286 		uint16 fadeVolCur[12];
287 		uint16 fadeVolStep[12];
288 
289 		for (int i = 0; i < 6; i++) {
290 			fadeVolCur[i] = READ_LE_UINT16(&_musicFadeTable[(_lastTrack * 12 + i) * 2]);
291 			fadeVolStep[i] = fadeVolCur[i] / 50;
292 			fadeVolCur[i + 6] = READ_LE_UINT16(&_musicFadeTable[(_lastTrack * 12 + 6 + i) * 2]);
293 			fadeVolStep[i + 6] = fadeVolCur[i + 6] / 30;
294 		}
295 
296 		for (int i = 0; i < 12; i++) {
297 			for (int ii = 0; ii < 6; ii++)
298 				_player->driver()->channelVolume(ii, fadeVolCur[ii]);
299 			for (int ii = 0x40; ii < 0x46; ii++)
300 				_player->driver()->channelVolume(ii, fadeVolCur[ii - 0x3A]);
301 
302 			for (int ii = 0; ii < 6; ii++) {
303 				fadeVolCur[ii] -= fadeVolStep[ii];
304 				if (fadeVolCur[ii] < 10)
305 					fadeVolCur[ii] = 0;
306 				fadeVolCur[ii + 6] -= fadeVolStep[ii + 6];
307 				if (fadeVolCur[ii + 6] < 10)
308 					fadeVolCur[ii + 6] = 0;
309 			}
310 
311 			if (++tickAdv == 3) {
312 				tickAdv = 0;
313 				ticks += 2;
314 			}
315 			_vm->delay(ticks * _vm->tickLength());
316 		}
317 	}
318 
319 	haltTrack();
320 }
321 
loadInstruments()322 bool SoundTowns_LoK::loadInstruments() {
323 	uint8 *twm = _vm->resource()->fileData("twmusic.pak", 0);
324 	if (!twm)
325 		return false;
326 
327 	Screen::decodeFrame4(twm, _musicTrackData, 50570);
328 	for (int i = 0; i < 128; i++)
329 		_player->driver()->loadInstrument(0, i, &_musicTrackData[i * 48 + 8]);
330 
331 	Screen::decodeFrame4(twm + 3232, _musicTrackData, 50570);
332 	for (int i = 0; i < 32; i++)
333 		_player->driver()->loadInstrument(0x40, i, &_musicTrackData[i * 128 + 8]);
334 
335 	_player->driver()->unloadWaveTable(-1);
336 	uint8 *src = &_musicTrackData[32 * 128 + 8];
337 	for (int i = 0; i < 10; i++) {
338 		_player->driver()->loadWaveTable(src);
339 		src = src + READ_LE_UINT16(&src[12]) + 32;
340 	}
341 
342 	_player->driver()->reserveSoundEffectChannels(2);
343 
344 	delete[] twm;
345 
346 	return true;
347 }
348 
playEuphonyTrack(uint32 offset,int loop)349 void SoundTowns_LoK::playEuphonyTrack(uint32 offset, int loop) {
350 	uint8 *twm = _vm->resource()->fileData("twmusic.pak", 0);
351 	Screen::decodeFrame4(twm + 19312 + offset, _musicTrackData, 50570);
352 	delete[] twm;
353 
354 	const uint8 *src = _musicTrackData + 852;
355 	for (int i = 0; i < 32; i++)
356 		_player->configPart_enable(i, *src++);
357 	for (int i = 0; i < 32; i++)
358 		_player->configPart_setType(i, *src++);
359 	for (int i = 0; i < 32; i++)
360 		_player->configPart_remap(i, *src++);
361 	for (int i = 0; i < 32; i++)
362 		_player->configPart_adjustVolume(i, *src++);
363 	for (int i = 0; i < 32; i++)
364 		_player->configPart_setTranspose(i, *src++);
365 
366 	src = _musicTrackData + 1748;
367 	for (int i = 0; i < 6; i++)
368 		_player->driver()->assignPartToChannel(i, *src++);
369 	for (int i = 0x40; i < 0x46; i++)
370 		_player->driver()->assignPartToChannel(i, *src++);
371 
372 	uint32 trackSize = READ_LE_UINT32(_musicTrackData + 2048);
373 	uint8 startTick = _musicTrackData[2052];
374 
375 	_player->setTempo(_musicTrackData[2053]);
376 
377 	src = _musicTrackData + 2054;
378 	uint32 l = READ_LE_UINT32(src + trackSize);
379 	trackSize += (l + 4);
380 	l = READ_LE_UINT32(src + trackSize);
381 	trackSize += (l + 4);
382 
383 	_player->setLoopStatus(loop);
384 	_player->startTrack(src, trackSize, startTick);
385 }
386 
fadeOutSoundEffects()387 void SoundTowns_LoK::fadeOutSoundEffects() {
388 	for (int i = 127; i > 0; i-= 12) {
389 		_player->driver()->channelVolume(0x46, i);
390 		_player->driver()->channelVolume(0x47, i);
391 		_vm->delay(_vm->tickLength());
392 	}
393 	stopAllSoundEffects();
394 }
395 
396 } // End of namespace Kyra
397 
398