scummvm/engines/wintermute/Base/BSoundMgr.cpp

/* 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

/*
 * This file is based on WME Lite.
 * http://dead-code.org/redir.php?target=wmelite
 * Copyright (c) 2011 Jan Nedoma
 */

#include "engines/wintermute/dcgf.h"
#include "engines/wintermute/Base/BSoundMgr.h"
#include "engines/wintermute/Base/BRegistry.h"
#include "engines/wintermute/utils/PathUtil.h"
#include "engines/wintermute/utils/StringUtil.h"
#include "engines/wintermute/Base/BGame.h"
#include "engines/wintermute/Base/BFileManager.h"
#include "engines/wintermute/Base/BSoundBuffer.h"

namespace WinterMute {

//////////////////////////////////////////////////////////////////////
// Construction/Destruction
//////////////////////////////////////////////////////////////////////

//IMPLEMENT_PERSISTENT(CBSoundMgr, true);

//////////////////////////////////////////////////////////////////////////
CBSoundMgr::CBSoundMgr(CBGame *inGame): CBBase(inGame) {
	_soundAvailable = false;

	_volumeSFX = _volumeSpeech = _volumeMusic = _volumeMaster = 100;
}


//////////////////////////////////////////////////////////////////////////
CBSoundMgr::~CBSoundMgr() {
	saveSettings();
	cleanup();
}


//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::cleanup() {
	for (int i = 0; i < _sounds.getSize(); i++)
		delete _sounds[i];
	_sounds.removeAll();
#if 0
	BASS_Free();
#endif
	return STATUS_OK;
}

//////////////////////////////////////////////////////////////////////////
void CBSoundMgr::saveSettings() {
	if (_soundAvailable) {
		Game->_registry->writeInt("Audio", "MasterVolume", _volumeMaster);

		Game->_registry->writeInt("Audio", "SFXVolume",    _volumeSFX);
		Game->_registry->writeInt("Audio", "SpeechVolume", _volumeSpeech);
		Game->_registry->writeInt("Audio", "MusicVolume",  _volumeMusic);
	}
}

//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::initialize() {
	_soundAvailable = false;
#if 0

#ifdef __IPHONEOS__
#define BASS_CONFIG_IOS_MIXAUDIO 34
	BASS_SetConfig(BASS_CONFIG_IOS_MIXAUDIO, 0);
#endif


	if (HIWORD(BASS_GetVersion()) != BASSVERSION) {
		Game->LOG(0, "An incorrect version of BASS was loaded");
		return STATUS_FAILED;
	}

	if (!BASS_Init(-1, 44100, 0, 0, NULL)) {
		Game->LOG(0, "Can't initialize sound device");
		return STATUS_FAILED;
	}
#endif

	_volumeMaster = Game->_registry->readInt("Audio", "MasterVolume", 100);

	_volumeSFX    = Game->_registry->readInt("Audio", "SFXVolume",    100);
	_volumeSpeech = Game->_registry->readInt("Audio", "SpeechVolume", 100);
	_volumeMusic  = Game->_registry->readInt("Audio", "MusicVolume",  100);

	_soundAvailable = true;
	setMasterVolumePercent(_volumeMaster);

	return STATUS_OK;
}


//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::initLoop() {
	if (!_soundAvailable)
		return STATUS_OK;
#if 0

	BASS_Update(500);
#endif
	return STATUS_OK;
}


//////////////////////////////////////////////////////////////////////////
CBSoundBuffer *CBSoundMgr::addSound(const char *filename, TSoundType type, bool streamed) {
	if (!_soundAvailable)
		return NULL;

	CBSoundBuffer *sound;

	// try to switch WAV to OGG file (if available)
	AnsiString ext = PathUtil::getExtension(filename);
	if (StringUtil::compareNoCase(ext, "wav")) {
		AnsiString path = PathUtil::getDirectoryName(filename);
		AnsiString name = PathUtil::getFileNameWithoutExtension(filename);

		AnsiString newFile = PathUtil::combine(path, name + "ogg");
		if (Game->_fileManager->hasFile(newFile)) {
			filename = newFile.c_str();
		}
	}

	sound = new CBSoundBuffer(Game);
	if (!sound) return NULL;

	sound->setStreaming(streamed);
	sound->setType(type);


	ERRORCODE res = sound->loadFromFile(filename);
	if (DID_FAIL(res)) {
		Game->LOG(res, "Error loading sound '%s'", filename);
		delete sound;
		return NULL;
	}

	// set volume appropriately
	switch (type) {
	case SOUND_SFX:
		sound->setVolume(_volumeSFX);
		break;
	case SOUND_SPEECH:
		sound->setVolume(_volumeSpeech);
		break;
	case SOUND_MUSIC:
		sound->setVolume(_volumeMusic);
		break;
	}

	// register sound
	_sounds.add(sound);

	return sound;

	return NULL;
}

//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::addSound(CBSoundBuffer *sound, TSoundType type) {
	if (!sound)
		return STATUS_FAILED;

	// set volume appropriately
	switch (type) {
	case SOUND_SFX:
		sound->setVolume(_volumeSFX);
		break;
	case SOUND_SPEECH:
		sound->setVolume(_volumeSpeech);
		break;
	case SOUND_MUSIC:
		sound->setVolume(_volumeMusic);
		break;
	}

	// register sound
	_sounds.add(sound);

	return STATUS_OK;
}

//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::removeSound(CBSoundBuffer *sound) {
	for (int i = 0; i < _sounds.getSize(); i++) {
		if (_sounds[i] == sound) {
			delete _sounds[i];
			_sounds.removeAt(i);
			return STATUS_OK;
		}
	}

	return STATUS_FAILED;
}


//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::setVolume(TSoundType type, int volume) {
	if (!_soundAvailable)
		return STATUS_OK;

	switch (type) {
	case SOUND_SFX:
		_volumeSFX = volume;
		break;
	case SOUND_SPEECH:
		_volumeSpeech = volume;
		break;
	case SOUND_MUSIC:
		_volumeMusic  = volume;
		break;
	}

	for (int i = 0; i < _sounds.getSize(); i++) {
		if (_sounds[i]->_type == type) _sounds[i]->setVolume(volume);
	}

	return STATUS_OK;
}

//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::setVolumePercent(TSoundType type, byte percent) {
	return setVolume(type, percent);
}


//////////////////////////////////////////////////////////////////////////
byte CBSoundMgr::getVolumePercent(TSoundType type) {
	int volume = 0;
	switch (type) {
	case SOUND_SFX:
		volume = _volumeSFX;
		break;
	case SOUND_SPEECH:
		volume = _volumeSpeech;
		break;
	case SOUND_MUSIC:
		volume = _volumeMusic;
		break;
	default:
		error("Sound-type not set");
		break;
	}

	return (byte)volume;
}


//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::setMasterVolumePercent(byte percent) {
	_volumeMaster = percent;
#if 0
	BASS_SetConfig(BASS_CONFIG_GVOL_STREAM, (uint32)(10000.0f / 100.0f * (float)Percent));
#endif
	return STATUS_OK;
}


//////////////////////////////////////////////////////////////////////////
byte CBSoundMgr::getMasterVolumePercent() {
#if 0
	uint32 val = BASS_GetConfig(BASS_CONFIG_GVOL_STREAM);
	return (float)val / 10000.0f * 100.0f;
#endif
	return 0;
}



//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::pauseAll(bool includingMusic) {

	for (int i = 0; i < _sounds.getSize(); i++) {
		if (_sounds[i]->isPlaying() && (_sounds[i]->_type != SOUND_MUSIC || includingMusic)) {
			_sounds[i]->pause();
			_sounds[i]->_freezePaused = true;
		}
	}

	return STATUS_OK;
}


//////////////////////////////////////////////////////////////////////////
ERRORCODE CBSoundMgr::resumeAll() {

	for (int i = 0; i < _sounds.getSize(); i++) {
		if (_sounds[i]->_freezePaused) {
			_sounds[i]->resume();
			_sounds[i]->_freezePaused = false;
		}
	}

	return STATUS_OK;
}


//////////////////////////////////////////////////////////////////////////
float CBSoundMgr::posToPan(int x, int y) {
	float relPos = (float)x / ((float)Game->_renderer->_width);

	float minPan = -0.7f;
	float maxPan = 0.7f;

	return minPan + relPos * (maxPan - minPan);
}

} // end of namespace WinterMute