BACKENDS: Partial merge of gsoc2010-opengl: Audio CD changes only

This commit contains the AudioCDManager changes from the gsoc2010-opengl
branch. The other changes in that branch are restricted to the backends
directory only (plus configure).

The Nintendo DS and Dreamcast ports still need to be ported over to
the new Audio CD system, but that should be fairly easy to do.

svn-id: r54147

5 files changed, 563 insertions, 0 deletions

diff --git a/backends/audiocd/audiocd.h b/backends/audiocd/audiocd.h
new file mode 100644
index 0000000000..f218db7f72
--- /dev/null
+++ b/backends/audiocd/audiocd.h
@@ -0,0 +1,148 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef BACKENDS_AUDIOCD_ABSTRACT_H
+#define BACKENDS_AUDIOCD_ABSTRACT_H
+
+#include "common/scummsys.h"
+#include "common/noncopyable.h"
+
+/**
+* Abstract Audio CD manager class. Subclasses implement the actual
+* functionality.
+*/
+class AudioCDManager : Common::NonCopyable {
+public:
+	virtual ~AudioCDManager() {}
+
+	/**
+	* A structure containing the current playback information
+	*/
+	struct Status {
+		bool playing;
+		int track;
+		int start;
+		int duration;
+		int numLoops;
+		int volume;
+		int balance;
+	};
+
+	/**
+	 * @name Emulated playback functions
+	 * Engines should call these functions. Not all platforms
+	 * support cd playback, and these functions should try to
+	 * emulate it.
+	 */
+	//@{
+
+	/**
+	 * Start audio CD playback
+	 * @param track			the track to play.
+	 * @param num_loops		how often playback should be repeated (-1 = infinitely often).
+	 * @param start_frame	the frame at which playback should start (75 frames = 1 second).
+	 * @param duration		the number of frames to play.
+	 * @param only_emulate	determines if the track should be emulated only
+	 */
+	virtual void play(int track, int numLoops, int startFrame, int duration, bool only_emulate = false) = 0;
+
+	/**
+	 * Get if audio is being played.
+	 * @return true if CD or emulated audio is playing
+	 */
+	virtual bool isPlaying() const = 0;
+
+	/**
+	 * Set the audio volume
+	 */
+	virtual void setVolume(byte volume) = 0;
+
+	/**
+	 * Set the speakers balance
+	 */
+	virtual void setBalance(int8 balance) = 0;
+
+	/**
+	 * Stop CD or emulated audio playback.
+	 */
+	virtual void stop() = 0;
+
+	/**
+	 * Update CD or emulated audio status.
+	 */
+	virtual void update() = 0;
+
+	/**
+	 * Get the playback status.
+	 * @return a Status struct with playback data.
+	 */
+	virtual Status getStatus() const = 0;
+
+	//@}
+
+
+	/**
+	 * @name Real CD audio methods
+	 * These functions should be called from the emulated
+	 * ones if they can't emulate the audio playback.
+	 */
+	//@{
+
+	/**
+	 * Initialise the specified CD drive for audio playback.
+	 * @param drive the drive id
+	 * @return true if the CD drive was inited succesfully
+	 */
+	virtual bool openCD(int drive) = 0;
+	
+	/**
+	 * Poll CD status.
+	 * @return true if CD audio is playing
+	 */
+	virtual bool pollCD() const = 0;
+
+	/**
+	 * Start CD audio playback.
+	 * @param track			the track to play.
+	 * @param num_loops		how often playback should be repeated (-1 = infinitely often).
+	 * @param start_frame	the frame at which playback should start (75 frames = 1 second).
+	 * @param duration		the number of frames to play.
+	 */
+	virtual void playCD(int track, int num_loops, int start_frame, int duration) = 0;
+
+	/**
+	 * Stop CD audio playback.
+	 */
+	virtual void stopCD() = 0;
+
+	/**
+	 * Update CD audio status.
+	 */
+	virtual void updateCD() = 0;
+
+	//@}
+};
+
+#endif
diff --git a/backends/audiocd/default/default-audiocd.cpp b/backends/audiocd/default/default-audiocd.cpp
new file mode 100644
index 0000000000..6d16b26652
--- /dev/null
+++ b/backends/audiocd/default/default-audiocd.cpp
@@ -0,0 +1,157 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#include "backends/audiocd/default/default-audiocd.h"
+#include "sound/audiostream.h"
+#include "common/system.h"
+
+DefaultAudioCDManager::DefaultAudioCDManager() {
+	_cd.playing = false;
+	_cd.track = 0;
+	_cd.start = 0;
+	_cd.duration = 0;
+	_cd.numLoops = 0;
+	_cd.volume = Audio::Mixer::kMaxChannelVolume;
+	_cd.balance = 0;
+	_mixer = g_system->getMixer();
+	_emulating = false;
+	assert(_mixer);
+}
+
+void DefaultAudioCDManager::play(int track, int numLoops, int startFrame, int duration, bool only_emulate) {
+	if (numLoops != 0 || startFrame != 0) {
+		_cd.track = track;
+		_cd.numLoops = numLoops;
+		_cd.start = startFrame;
+		_cd.duration = duration;
+
+		// Try to load the track from a compressed data file, and if found, use
+		// that. If not found, attempt to start regular Audio CD playback of
+		// the requested track.
+		char trackName[2][16];
+		sprintf(trackName[0], "track%d", track);
+		sprintf(trackName[1], "track%02d", track);
+		Audio::SeekableAudioStream *stream = 0;
+
+		for (int i = 0; !stream && i < 2; ++i)
+			stream = Audio::SeekableAudioStream::openStreamFile(trackName[i]);
+
+		// Stop any currently playing emulated track
+		_mixer->stopHandle(_handle);
+
+		if (stream != 0) {
+			Audio::Timestamp start = Audio::Timestamp(0, startFrame, 75);
+			Audio::Timestamp end = duration ? Audio::Timestamp(0, startFrame + duration, 75) : stream->getLength();
+
+			/*
+			FIXME: Seems numLoops == 0 and numLoops == 1 both indicate a single repetition,
+			while all other positive numbers indicate precisely the number of desired
+			repetitions. Finally, -1 means infinitely many
+			*/
+			_emulating = true;
+			_mixer->playStream(Audio::Mixer::kMusicSoundType, &_handle,
+			                        Audio::makeLoopingAudioStream(stream, start, end, (numLoops < 1) ? numLoops + 1 : numLoops), -1, _cd.volume, _cd.balance);
+		} else {
+			_emulating = false;
+			if (!only_emulate)
+				playCD(track, numLoops, startFrame, duration);
+		}
+	}
+}
+
+void DefaultAudioCDManager::stop() {
+	if (_emulating) {
+		// Audio CD emulation
+		_mixer->stopHandle(_handle);
+		_emulating = false;
+	} else {
+		// Real Audio CD
+		stopCD();
+	}
+}
+
+bool DefaultAudioCDManager::isPlaying() const {
+	if (_emulating) {
+		// Audio CD emulation
+		return _mixer->isSoundHandleActive(_handle);
+	} else {
+		// Real Audio CD
+		return pollCD();
+	}
+}
+
+void DefaultAudioCDManager::setVolume(byte volume) {
+	_cd.volume = volume;
+	if (_emulating) {
+		// Audio CD emulation
+		if (_mixer->isSoundHandleActive(_handle))
+			_mixer->setChannelVolume(_handle, _cd.volume);
+	} else {
+		// Real Audio CD
+
+		// Unfortunately I can't implement this atm
+		// since SDL doesn't seem to offer an interface method for this.
+
+		// g_system->setVolumeCD(_cd.volume);
+	}
+}
+
+void DefaultAudioCDManager::setBalance(int8 balance) {
+	_cd.balance = balance;
+	if (_emulating) {
+		// Audio CD emulation
+		if (isPlaying())
+			_mixer->setChannelBalance(_handle, _cd.balance);
+	} else {
+		// Real Audio CD
+
+		// Unfortunately I can't implement this atm
+		// since SDL doesn't seem to offer an interface method for this.
+
+		// g_system->setBalanceCD(_cd.balance);
+	}
+}
+
+void DefaultAudioCDManager::update() {
+	if (_emulating) {
+		// Check whether the audio track stopped playback
+		if (!_mixer->isSoundHandleActive(_handle)) {
+			// FIXME: We do not update the numLoops parameter here (and in fact,
+			// currently can't do that). Luckily, only one engine ever checks
+			// this part of the AudioCD status, namely the SCUMM engine; and it
+			// only checks whether the track is currently set to infinite looping
+			// or not.
+			_emulating = false;
+		}
+	} else {
+		updateCD();
+	}
+}
+
+DefaultAudioCDManager::Status DefaultAudioCDManager::getStatus() const {
+	Status info = _cd;
+	info.playing = isPlaying();
+	return info;
+}
diff --git a/backends/audiocd/default/default-audiocd.h b/backends/audiocd/default/default-audiocd.h
new file mode 100644
index 0000000000..3f9df0bbbb
--- /dev/null
+++ b/backends/audiocd/default/default-audiocd.h
@@ -0,0 +1,62 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef BACKENDS_AUDIOCD_DEFAULT_H
+#define BACKENDS_AUDIOCD_DEFAULT_H
+
+#include "backends/audiocd/audiocd.h"
+#include "sound/mixer.h"
+
+/**
+ * The default audio cd manager. Implements emulation of audio cd playback.
+ */
+class DefaultAudioCDManager : public AudioCDManager {
+public:
+	DefaultAudioCDManager();
+	virtual ~DefaultAudioCDManager() {}
+
+	void play(int track, int numLoops, int startFrame, int duration, bool only_emulate = false);
+	void stop();
+	bool isPlaying() const;
+	void setVolume(byte volume);
+	void setBalance(int8 balance);
+	void update();
+	virtual Status getStatus() const; // Subclasses should override for better status results
+
+	virtual bool openCD(int drive) { return false; }
+	virtual void updateCD() {}
+	virtual bool pollCD() const { return false; }
+	virtual void playCD(int track, int num_loops, int start_frame, int duration) {}
+	virtual void stopCD() {}
+
+protected:
+	Audio::SoundHandle _handle;
+	bool _emulating;
+
+	Status _cd;
+	Audio::Mixer *_mixer;
+};
+
+#endif
diff --git a/backends/audiocd/sdl/sdl-audiocd.cpp b/backends/audiocd/sdl/sdl-audiocd.cpp
new file mode 100644
index 0000000000..62ab333f54
--- /dev/null
+++ b/backends/audiocd/sdl/sdl-audiocd.cpp
@@ -0,0 +1,139 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#if defined(SDL_BACKEND)
+
+// Disable symbol overrides so that we can use system headers.
+#define FORBIDDEN_SYMBOL_ALLOW_ALL
+
+#include "backends/audiocd/sdl/sdl-audiocd.h"
+
+SdlAudioCDManager::SdlAudioCDManager()
+	:
+	_cdrom(0),
+	_cdTrack(0),
+	_cdNumLoops(0),
+	_cdStartFrame(0),
+	_cdDuration(0),
+	_cdEndTime(0),
+	_cdStopTime(0) {
+
+}
+
+SdlAudioCDManager::~SdlAudioCDManager() {
+	if (_cdrom) {
+		SDL_CDStop(_cdrom);
+		SDL_CDClose(_cdrom);
+	}
+}
+
+bool SdlAudioCDManager::openCD(int drive) {
+	if (SDL_InitSubSystem(SDL_INIT_CDROM) == -1)
+		_cdrom = NULL;
+	else {
+		_cdrom = SDL_CDOpen(drive);
+		// Did it open? Check if _cdrom is NULL
+		if (!_cdrom) {
+			warning("Couldn't open drive: %s", SDL_GetError());
+		} else {
+			_cdNumLoops = 0;
+			_cdStopTime = 0;
+			_cdEndTime = 0;
+		}
+	}
+
+	return (_cdrom != NULL);
+}
+
+void SdlAudioCDManager::stopCD() {
+	// Stop CD Audio in 1/10th of a second
+	_cdStopTime = SDL_GetTicks() + 100;
+	_cdNumLoops = 0;
+}
+
+void SdlAudioCDManager::playCD(int track, int num_loops, int start_frame, int duration) {
+	if (!num_loops && !start_frame)
+		return;
+
+	if (!_cdrom)
+		return;
+
+	if (duration > 0)
+		duration += 5;
+
+	_cdTrack = track;
+	_cdNumLoops = num_loops;
+	_cdStartFrame = start_frame;
+
+	SDL_CDStatus(_cdrom);
+	if (start_frame == 0 && duration == 0)
+		SDL_CDPlayTracks(_cdrom, track, 0, 1, 0);
+	else
+		SDL_CDPlayTracks(_cdrom, track, start_frame, 0, duration);
+	_cdDuration = duration;
+	_cdStopTime = 0;
+	_cdEndTime = SDL_GetTicks() + _cdrom->track[track].length * 1000 / CD_FPS;
+}
+
+bool SdlAudioCDManager::pollCD() const {
+	if (!_cdrom)
+		return false;
+
+	return (_cdNumLoops != 0 && (SDL_GetTicks() < _cdEndTime || SDL_CDStatus(_cdrom) == CD_PLAYING));
+}
+
+void SdlAudioCDManager::updateCD() {
+	if (!_cdrom)
+		return;
+
+	if (_cdStopTime != 0 && SDL_GetTicks() >= _cdStopTime) {
+		SDL_CDStop(_cdrom);
+		_cdNumLoops = 0;
+		_cdStopTime = 0;
+		return;
+	}
+
+	if (_cdNumLoops == 0 || SDL_GetTicks() < _cdEndTime)
+		return;
+
+	if (_cdNumLoops != 1 && SDL_CDStatus(_cdrom) != CD_STOPPED) {
+		// Wait another second for it to be done
+		_cdEndTime += 1000;
+		return;
+	}
+
+	if (_cdNumLoops > 0)
+		_cdNumLoops--;
+
+	if (_cdNumLoops != 0) {
+		if (_cdStartFrame == 0 && _cdDuration == 0)
+			SDL_CDPlayTracks(_cdrom, _cdTrack, 0, 1, 0);
+		else
+			SDL_CDPlayTracks(_cdrom, _cdTrack, _cdStartFrame, 0, _cdDuration);
+		_cdEndTime = SDL_GetTicks() + _cdrom->track[_cdTrack].length * 1000 / CD_FPS;
+	}
+}
+
+#endif
diff --git a/backends/audiocd/sdl/sdl-audiocd.h b/backends/audiocd/sdl/sdl-audiocd.h
new file mode 100644
index 0000000000..42ac980c51
--- /dev/null
+++ b/backends/audiocd/sdl/sdl-audiocd.h
@@ -0,0 +1,57 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef BACKENDS_AUDIOCD_SDL_H
+#define BACKENDS_AUDIOCD_SDL_H
+
+#include "backends/audiocd/default/default-audiocd.h"
+
+#if defined(__SYMBIAN32__)
+#include <esdl\SDL.h>
+#else
+#include <SDL.h>
+#endif
+
+/**
+ * The SDL audio cd manager. Implements real audio cd playback.
+ */
+class SdlAudioCDManager : public DefaultAudioCDManager {
+public:
+	SdlAudioCDManager();
+	virtual ~SdlAudioCDManager();
+
+protected:
+	virtual bool openCD(int drive);
+	virtual void updateCD();
+	virtual bool pollCD() const;
+	virtual void playCD(int track, int num_loops, int start_frame, int duration);
+	virtual void stopCD();
+
+	SDL_CD *_cdrom;
+	int _cdTrack, _cdNumLoops, _cdStartFrame, _cdDuration;
+	uint32 _cdEndTime, _cdStopTime;
+};
+
+#endif