scummvm/engines/sludge/sound.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.
 *
 */

#if 0
#include "AL/alure.h"
#endif

#include "common/debug.h"
#include "common/file.h"

#include "audio/audiostream.h"
#include "audio/mixer.h"
#include "audio/decoders/wave.h"
#include "audio/decoders/vorbis.h"

#include "sludge/allfiles.h"
#include "sludge/debug.h"
#include "sludge/newfatal.h"
#include "sludge/sound.h"
#include "sludge/moreio.h"
#include "sludge/fileset.h"
#include "sludge/sludge.h"

#define MAX_SAMPLES 8
#define MAX_MODS 3
#define NUM_BUFS 3

namespace Sludge {

bool soundOK = false;
bool cacheLoopySound = false;
bool SilenceIKillYou = false;

struct soundThing {
#if 0
	alureStream *stream;
	ALuint playingOnSource;
#endif
	bool playing;
	int fileLoaded, vol;    //Used for sounds only.
	bool looping;           //Used for sounds only.
};

soundThing soundCache[MAX_SAMPLES];
soundThing modCache[MAX_MODS];
int intpointers[MAX_SAMPLES];

int defVol = 128;
int defSoundVol = 255;
const float modLoudness = 0.95f;

/*
 * Set up, tear down:
 */

bool initSoundStuff(HWND hwnd) {
#if 0
	if (!alureInitDevice(NULL, NULL)) {
		debugOut("Failed to open OpenAL device: %s\n", alureGetErrorString());
		return 1;
	}

	int a;
	for (a = 0; a < MAX_SAMPLES; a ++) {
		soundCache[a].stream = NULL;
		soundCache[a].playing = false;
		soundCache[a].fileLoaded = -1;
		soundCache[a].looping = false;
		intpointers[a] = a;
	}

	for (a = 0; a < MAX_MODS; a ++) {
		modCache[a].stream = NULL;
		modCache[a].playing = false;
	}

	if (! alureUpdateInterval(0.01)) {
		debugOut("Failed to set Alure update interval: %s\n", alureGetErrorString());
		return 1;
	}
#endif
	return soundOK = true;
}

void killSoundStuff() {
	if (!soundOK)
		return;
#if 0
	SilenceIKillYou = true;
	for (int i = 0; i < MAX_SAMPLES; i ++) {
		if (soundCache[i].playing) {

			if (! alureStopSource(soundCache[i].playingOnSource, AL_TRUE)) {
				debugOut("Failed to stop source: %s\n",
						alureGetErrorString());
			}

		}

		if (soundCache[i].stream != NULL) {

			if (! alureDestroyStream(soundCache[i].stream, 0, NULL)) {
				debugOut("Failed to destroy stream: %s\n",
						alureGetErrorString());
			}

		}
	}

	for (int i = 0; i < MAX_MODS; i ++) {
		if (modCache[i].playing) {

			if (! alureStopSource(modCache[i].playingOnSource, AL_TRUE)) {
				debugOut("Failed to stop source: %s\n",
						alureGetErrorString());
			}

		}

		if (modCache[i].stream != NULL) {

			if (! alureDestroyStream(modCache[i].stream, 0, NULL)) {
				debugOut("Failed to destroy stream: %s\n",
						alureGetErrorString());
			}

		}
	}

	SilenceIKillYou = false;

	alureShutdownDevice();
#endif
}

/*
 * Some setters:
 */

void setMusicVolume(int a, int v) {
	if (!soundOK)
		return;

	if (modCache[a].playing) {
#if 0
		alSourcef(modCache[a].playingOnSource, AL_GAIN, (float) modLoudness * v / 256);
#endif
	}
}

void setDefaultMusicVolume(int v) {
	defVol = v;
}

void setSoundVolume(int a, int v) {
	if (!soundOK)
		return;
	int ch = findInSoundCache(a);
	if (ch != -1) {
		if (soundCache[ch].playing) {
			soundCache[ch].vol = v;
#if 0
			alSourcef(soundCache[ch].playingOnSource, AL_GAIN, (float) v / 256);
#endif
		}
	}
}

void setDefaultSoundVolume(int v) {
	defSoundVol = v;
}

void setSoundLoop(int a, int s, int e) {
//#pragma unused (a,s,e)
}

/*
 * End of stream callbacks:
 */

#if 0
static void sound_eos_callback(void *cacheIndex, ALuint source) {
	int *a = (int *)cacheIndex;

	alDeleteSources(1, &source);
	if (alGetError() != AL_NO_ERROR) {
		debugOut("Failed to delete OpenAL source!\n");
	}

	soundCache[*a].playingOnSource = 0;
	soundCache[*a].playing = false;
	soundCache[*a].looping = false;

}
#endif

#if 0
static void mod_eos_callback(void *cacheIndex, ALuint source) {
	int *a = (int *)cacheIndex;

	alDeleteSources(1, &source);
	if (alGetError() != AL_NO_ERROR) {
		debugOut("Failed to delete OpenAL source!\n");
	}

	modCache[*a].playingOnSource = 0;

	if (! alureDestroyStream(modCache[*a].stream, 0, NULL)) {
		debugOut("Failed to destroy stream: %s\n",
				alureGetErrorString());
	}

	modCache[*a].stream = NULL;
	modCache[*a].playing = false;
}
#endif

/*
 * Stopping things:
 */

int findInSoundCache(int a) {
	int i;
	for (i = 0; i < MAX_SAMPLES; i++) {
		if (soundCache[i].fileLoaded == a) {
			return i;
		}
	}
	return -1;
}

void stopMOD(int i) {
	if (!soundOK)
		return;
#if 0
	alGetError();
	if (modCache[i].playing) {
		if (! alureStopSource(modCache[i].playingOnSource, AL_TRUE)) {
			debugOut("Failed to stop source: %s\n", alureGetErrorString());
		}
	}
#endif
}

void huntKillSound(int filenum) {
	if (!soundOK)
		return;
#if 0
	// Clear OpenAL errors to make sure they don't block anything:
	alGetError();

	int gotSlot = findInSoundCache(filenum);
	if (gotSlot == -1) return;

	SilenceIKillYou = true;

	if (soundCache[gotSlot].playing) {
		if (! alureStopSource(soundCache[gotSlot].playingOnSource, AL_TRUE)) {
			debugOut("Failed to stop source: %s\n", alureGetErrorString());
		}
	}
#endif
	SilenceIKillYou = false;
}

void freeSound(int a) {
	if (!soundOK)
		return;
#if 0
	// Clear OpenAL errors to make sure they don't block anything:
	alGetError();

	SilenceIKillYou = true;

	if (soundCache[a].playing) {
		if (! alureStopSource(soundCache[a].playingOnSource, AL_TRUE)) {
			debugOut("Failed to stop source: %s\n",
					alureGetErrorString());
		}
	}
	if (! alureDestroyStream(soundCache[a].stream, 0, NULL)) {
		debugOut("Failed to destroy stream: %s\n",
				alureGetErrorString());
	}

	soundCache[a].stream = NULL;
	soundCache[a].fileLoaded = -1;
#endif
	SilenceIKillYou = false;
}

void huntKillFreeSound(int filenum) {
	if (!soundOK)
		return;
	int gotSlot = findInSoundCache(filenum);
	if (gotSlot == -1)
		return;
	freeSound(gotSlot);
}

/*
 * Loading and playing:
 */

void playStream(int a, bool isMOD, bool loopy) {
#if 0
	if (! soundOK) return;
	ALboolean ok;
	ALuint src;
	soundThing *st;
	void (*eos_callback)(void *userdata, ALuint source);

	if (isMOD) {
		st = &modCache[a];
		eos_callback = mod_eos_callback;
	} else {
		st = &soundCache[a];
		eos_callback = sound_eos_callback;
	}

	alGenSources(1, &src);
	if (alGetError() != AL_NO_ERROR) {
		debugOut("Failed to create OpenAL source!\n");
		return;
	}

	if (isMOD) {
		alSourcef(src, AL_GAIN, (float) modLoudness * defVol / 256);
	} else {
		alSourcef(src, AL_GAIN, (float) soundCache[a].vol / 256);
	}

	if (loopy) {
		ok = alurePlaySourceStream(src, (*st).stream,
				NUM_BUFS, -1, eos_callback, &intpointers[a]);
	} else {
		ok = alurePlaySourceStream(src, (*st).stream,
				NUM_BUFS, 0, eos_callback, &intpointers[a]);
	}

	if (!ok) {

		debugOut("Failed to play stream: %s\n", alureGetErrorString());
		alDeleteSources(1, &src);
		if (alGetError() != AL_NO_ERROR) {
			debugOut("Failed to delete OpenAL source!\n");
		}

		(*st).playingOnSource = 0;
	} else {
		(*st).playingOnSource = src;
		(*st).playing = true;
	}
#endif
}

char *loadEntireFileToMemory(Common::SeekableReadStream *inputFile,
		uint32 size) {
	char *allData = new char[size];
	if (!allData)
		return NULL;

	size_t bytes_read = inputFile->read(allData, size);
	if (bytes_read != size && inputFile->err()) {
		debugOut("Reading error in loadEntireFileToMemory.\n");
	}

	finishAccess();

	return allData;
}

bool playMOD(int f, int a, int fromTrack) {
	if (!soundOK)
		return true;
	stopMOD(a);

	setResourceForFatal(f);
	uint32 length = openFileFromNum(f);
	if (length == 0) {
		finishAccess();
		setResourceForFatal(-1);
		return false;
	}
#if 0
	unsigned char *memImage;
	memImage = (unsigned char *) loadEntireFileToMemory(bigDataFile, length);
	if (! memImage) return fatal(ERROR_MUSIC_MEMORY_LOW);

	modCache[a].stream = alureCreateStreamFromMemory(memImage, length, 19200, 0, NULL);

	delete memImage;

	if (modCache[a].stream != NULL) {
		setMusicVolume(a, defVol);

		if (! alureSetStreamOrder(modCache[a].stream, fromTrack)) {
			debugOut("Failed to set stream order: %s\n",
					alureGetErrorString());
		}

		playStream(a, true, true);

	} else {

		debugOut("Failed to create stream from MOD: %s\n",
				alureGetErrorString());

		warning(ERROR_MUSIC_ODDNESS);
		soundCache[a].stream = NULL;
		soundCache[a].playing = false;
		soundCache[a].playingOnSource = 0;
	}
	setResourceForFatal(-1);
#endif
	return true;
}

bool stillPlayingSound(int ch) {
	if (soundOK)
		if (ch != -1)
			if (soundCache[ch].fileLoaded != -1)
				if (soundCache[ch].playing)
					return true;

	return false;
}

bool forceRemoveSound() {
	for (int a = 0; a < MAX_SAMPLES; a++) {
		if (soundCache[a].fileLoaded != -1 && !stillPlayingSound(a)) {
//			soundWarning ("Deleting silent sound", a);
			freeSound(a);
			return 1;
		}
	}

	for (int a = 0; a < MAX_SAMPLES; a++) {
		if (soundCache[a].fileLoaded != -1) {
//			soundWarning ("Deleting playing sound", a);
			freeSound(a);
			return 1;
		}
	}
//	soundWarning ("Cache is empty!", 0);
	return 0;
}

int emptySoundSlot = 0;

int findEmptySoundSlot() {
	int t;
	for (t = 0; t < MAX_SAMPLES; t++) {
		emptySoundSlot++;
		emptySoundSlot %= MAX_SAMPLES;
#if 0
		if (soundCache[emptySoundSlot].stream == NULL)
		return emptySoundSlot;
#endif
	}

	for (t = 0; t < MAX_SAMPLES; t++) {
		emptySoundSlot++;
		emptySoundSlot %= MAX_SAMPLES;
		if (!soundCache[emptySoundSlot].playing)
			return emptySoundSlot;
	}

	// Argh! They're all playing! Let's trash the oldest that's not looping...

	for (t = 0; t < MAX_SAMPLES; t++) {
		emptySoundSlot++;
		emptySoundSlot %= MAX_SAMPLES;
		if (!soundCache[emptySoundSlot].looping)
			return emptySoundSlot;
	}

	// Holy crap, they're all looping! What's this twat playing at?

	emptySoundSlot++;
	emptySoundSlot %= MAX_SAMPLES;
	return emptySoundSlot;
}

int cacheSound(int f) {

	if (!soundOK)
		return -1;

	unsigned int chunkLength;
	int retval;
	bool loopy;
#if 0
	loopy = cacheLoopySound;
	cacheLoopySound = false;

	setResourceForFatal(f);

	if (! soundOK) return 0;

	int a = findInSoundCache(f);
	if (a != -1) {

		if (soundCache[a].playing) {
			if (! alureStopSource(soundCache[a].playingOnSource, AL_TRUE)) {
				debugOut("Failed to stop source: %s\n",
						alureGetErrorString());
			}
		}
		if (! alureRewindStream(soundCache[a].stream)) {
			debugOut("Failed to rewind stream: %s\n",
					alureGetErrorString());
		}

		return a;
	}
	if (f == -2) return -1;
	a = findEmptySoundSlot();
	freeSound(a);

	uint32 length = openFileFromNum(f);
	if (! length) return -1;

	unsigned char *memImage;

	bool tryAgain = true;

	while (tryAgain) {
		memImage = (unsigned char *)loadEntireFileToMemory(bigDataFile, length);
		tryAgain = memImage == NULL;
		if (tryAgain) {
			if (! forceRemoveSound()) {
				fatal(ERROR_SOUND_MEMORY_LOW);
				return -1;
			}
		}
	}

	chunkLength = 19200;

	// Small looping sounds need small chunklengths.
	if (loopy) {
		if (length < NUM_BUFS * chunkLength) {
			chunkLength = length / NUM_BUFS;
		}
	} else if (length < chunkLength) {
		chunkLength = length;
	}

	soundCache[a].stream = alureCreateStreamFromMemory(memImage, length, chunkLength, 0, NULL);

	delete[] memImage;

	if (soundCache[a].stream != NULL) {
		soundCache[a].fileLoaded = f;
		setResourceForFatal(-1);
		retval = a;
	} else {

		debugOut("Failed to create stream from sound: %s\n",
				alureGetErrorString());

		warning(ERROR_SOUND_ODDNESS);
		soundCache[a].stream = NULL;
		soundCache[a].playing = false;
		soundCache[a].playingOnSource = 0;
		soundCache[a].fileLoaded = -1;
		soundCache[a].looping = false;
		retval = -1;
	}
#endif
	return retval;
}

bool startSound(int f, bool loopy) {
	if (loopy) // TODO: don't consider loop sound yet at this stage
		return false;
	// load sound
	setResourceForFatal(f);
	uint32 length = openFileFromNum(f);
	Common::SeekableReadStream *memImage = bigDataFile->readStream(length);
	if (memImage->size() != length || bigDataFile->err())
		debug("Sound reading failed");
	Audio::AudioStream *stream = Audio::makeWAVStream(memImage, DisposeAfterUse::NO);
#ifdef USE_VORBIS
	if (!stream) {
		stream = Audio::makeVorbisStream(memImage, DisposeAfterUse::NO);
	}
#endif
	delete memImage;
	if (!stream)
		return false;

	// play sound
	Audio::SoundHandle soundHandle;
	g_sludge->_mixer->playStream(Audio::Mixer::kSFXSoundType, &soundHandle, stream, -1, Audio::Mixer::kMaxChannelVolume);
#if 0
	if (soundOK) {

		cacheLoopySound = loopy;
		int a = cacheSound(f);
		if (a == -1) {
			debugOut("Failed to cache sound!\n");
			return false;
		}
		soundCache[a].looping = loopy;
		soundCache[a].vol = defSoundVol;

		playStream(a, false, loopy);
	}
#endif
	return true;
}

void saveSounds(Common::WriteStream *stream) {
	if (soundOK) {
		for (int i = 0; i < MAX_SAMPLES; i++) {
			if (soundCache[i].looping) {
				stream->writeByte(1);
				stream->writeUint16BE(soundCache[i].fileLoaded);
				stream->writeUint16BE(soundCache[i].vol);
			}
		}
	}
	stream->writeByte(0);
	stream->writeUint16BE(defSoundVol);
	stream->writeUint16BE(defVol);
}

void loadSounds(Common::SeekableReadStream *stream) {
	for (int i = 0; i < MAX_SAMPLES; i++)
		freeSound(i);

	while (stream->readByte()) {
		int fileLoaded = stream->readUint16BE();
		defSoundVol = stream->readUint16BE();
		startSound(fileLoaded, 1);
	}

	defSoundVol = stream->readUint16BE();
	defVol = stream->readUint16BE();
}

bool getSoundCacheStack(stackHandler *sH) {
	variable newFileHandle;
	newFileHandle.varType = SVT_NULL;

	for (int a = 0; a < MAX_SAMPLES; a++) {
		if (soundCache[a].fileLoaded != -1) {
			setVariable(newFileHandle, SVT_FILE, soundCache[a].fileLoaded);
			if (!addVarToStackQuick(newFileHandle, sH->first))
				return false;
			if (sH->last == NULL)
				sH->last = sH->first;
		}
	}
	return true;
}

soundList *deleteSoundFromList(soundList *s) {
	// Don't delete a playing sound.
	if (s->cacheIndex)
		return NULL;

	soundList *o = NULL;
	if (!s->next) {
		o = s->prev;
		if (o)
			o->next = NULL;
		delete s;
		return o;
	}
	if (s != s->next) {
		o = s->next;
		o->prev = s->prev;
		if (o->prev)
			o->prev->next = o;
	}
	delete s;
	return o;
}

#if 0
static void list_eos_callback(void *list, ALuint source) {
	soundList *s = (soundList *) list;

	int a = s->cacheIndex;
#if 0
	alDeleteSources(1, &source);
	if (alGetError() != AL_NO_ERROR) {
		debugOut("Failed to delete OpenAL source!\n");
	}
#endif
	soundCache[a].playingOnSource = 0;
	soundCache[a].playing = false;
	soundCache[a].looping = false;
	s-> cacheIndex = false;
	if (SilenceIKillYou) {
		while (s = deleteSoundFromList(s));
	} else {
		if (s->next) {
			if (s->next == s) {
				int v = defSoundVol;
				defSoundVol = soundCache[a].vol;
				startSound(s->sound, true);
				defSoundVol = v;
				while (s = deleteSoundFromList(s));
				return;
			}
			s->next->vol = soundCache[a].vol;
			playSoundList(s->next);
		} else {
			while (s = deleteSoundFromList(s));
		}
	}
}
#endif

void playSoundList(soundList *s) {
#if 0
	if (soundOK) {
		cacheLoopySound = true;
		int a = cacheSound(s->sound);
		if (a == -1) {
			debugOut("Failed to cache sound!\n");
			return;
		}
		soundCache[a].looping = false;
		if (s->vol < 0)
		soundCache[a].vol = defSoundVol;
		else
		soundCache[a].vol = s->vol;
		s-> cacheIndex = a;

		ALboolean ok;
		ALuint src;
		soundThing *st;

		st = &soundCache[a];

		alGenSources(1, &src);
		if (alGetError() != AL_NO_ERROR) {
			debugOut("Failed to create OpenAL source!\n");
			return;
		}

		alSourcef(src, AL_GAIN, (float) soundCache[a].vol / 256);

		ok = alurePlaySourceStream(src, (*st).stream,
				NUM_BUFS, 0, list_eos_callback, s);

		if (!ok) {

			debugOut("Failed to play stream: %s\n", alureGetErrorString());
			alDeleteSources(1, &src);
			if (alGetError() != AL_NO_ERROR) {
				debugOut("Failed to delete OpenAL source!\n");
			}

			(*st).playingOnSource = 0;
		} else {
			(*st).playingOnSource = src;
			(*st).playing = true;
		}
	}
#endif
}

void playMovieStream(int a) {
#if 0
	if (! soundOK) return;
	ALboolean ok;
	ALuint src;

	alGenSources(1, &src);
	if (alGetError() != AL_NO_ERROR) {
		debugOut("Failed to create OpenAL source!\n");
		return;
	}

	alSourcef(src, AL_GAIN, (float) soundCache[a].vol / 256);

	ok = alurePlaySourceStream(src, soundCache[a].stream,
			10, 0, sound_eos_callback, &intpointers[a]);
	if (!ok) {
		debugOut("Failed to play stream: %s\n", alureGetErrorString());
		alDeleteSources(1, &src);
		if (alGetError() != AL_NO_ERROR) {
			debugOut("Failed to delete OpenAL source!\n");
		}

		soundCache[a].playingOnSource = 0;
	} else {
		soundCache[a].playingOnSource = src;
		soundCache[a].playing = true;
	}
#endif
}

#if 0
int initMovieSound(int f, ALenum format, int audioChannels, ALuint samplerate,
		ALuint(*callback)(void *userdata, ALubyte *data, ALuint bytes)) {
	if (! soundOK) return 0;

	int retval;
	int a = findEmptySoundSlot();
	freeSound(a);

	soundCache[a].looping = false;
#if 0
	// audioChannel * sampleRate gives us a buffer of half a second. Not much, but it should be enough.
	soundCache[a].stream = alureCreateStreamFromCallback(
			callback,
			&intpointers[a], format, samplerate,
			audioChannels * samplerate, 0, NULL);
#endif
	if (soundCache[a].stream != NULL) {
		soundCache[a].fileLoaded = f;
		soundCache[a].vol = defSoundVol;
		retval = a;
	} else {
#if 0
		debugOut("Failed to create stream from sound: %s\n",
				alureGetErrorString());
#endif
		warning(ERROR_SOUND_ODDNESS);
		soundCache[a].stream = NULL;
		soundCache[a].playing = false;
		soundCache[a].playingOnSource = 0;
		soundCache[a].fileLoaded = -1;
		retval = -1;
	}
	//fprintf (stderr, "Stream %d created. Sample rate: %d Channels: %d\n", retval, samplerate, audioChannels);

	return retval;
}
#endif

unsigned int getSoundSource(int index) {
	return 0; /*soundCache[index].playingOnSource;*/ //TODO:false value
}

} // End of namespace Sludge