Initial commit

engines/scumm/soundse.h

@@ -0,0 +1,213 @@
+/* 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_SOUNDSE_H
+#define SCUMM_SOUNDSE_H
+
+#include "common/scummsys.h"
+#include "audio/audiostream.h"
+#include "audio/mixer.h"
+#include "scumm/file.h"
+
+namespace Common {
+class SeekableSubReadStream;
+}
+
+namespace Audio {
+class WMACodec;
+}
+
+namespace Scumm {
+
+class ScummEngine;
+
+enum SoundSEType {
+	kSoundSETypeMusic,
+	kSoundSETypeCDAudio,
+	kSoundSETypeSpeech,
+	kSoundSETypeSFX,
+	kSoundSETypeAmbience,
+	kSoundSETypeCommentary,
+	kSoundSETypePatch
+};
+
+enum AudioCodec {
+	kXWBCodecPCM = 0,
+	kXWBCodecXMA = 1,
+	kXWBCodecADPCM = 2,
+	kXWBCodecWMA = 3,
+	kFSBCodecMP3 = 4
+};
+
+struct AudioEntry {
+	uint64 offset;
+	uint32 length;
+	AudioCodec codec;
+	byte channels;
+	uint16 rate;
+	uint16 align;
+	byte bits;
+	Common::String name;
+	bool isPatched;
+};
+
+class SoundSE {
+
+public:
+	SoundSE(ScummEngine *parent, Audio::Mixer *mixer);
+	~SoundSE() = default;
+
+	Audio::SeekableAudioStream *getAudioStreamFromIndex(int32 index, SoundSEType type);
+	Audio::SeekableAudioStream *getAudioStreamFromOffset(uint32 offset, SoundSEType type);
+
+	int32 handleMISESpeech(const char *msgString,
+								const char *speechFilenameSubstitution,
+								uint16 roomNumber,
+								uint16 actorTalking,
+								uint16 numWaits);
+
+	void setupMISEAudioParams(int32 scriptNum, int32 scriptOffset) {
+		_currentScriptSavedForSpeechMI = scriptNum;
+		_currentScriptOffsetSavedForSpeechMI = scriptOffset;
+	}
+
+	void startAmbience(int32 musicTrack);
+	void stopAmbience();
+
+private:
+	enum XWBSegmentType {
+		kXWBSegmentBankData = 0,
+		kXWBSegmentEntryMetaData = 1,
+		kXWBSegmentSeekTables = 2,
+		kXWBSegmentEntryNames = 3,
+		kXWBSegmentEntryWaveData = 4
+	};
+
+	// Used in MI1 + MI2
+	struct AudioEntryMI {
+		uint32 hash;
+		uint16 room;
+		uint16 script;
+		uint16 localScriptOffset;
+		uint16 messageIndex;        // message index, used in messages split with wait()
+		uint16 isEgoTalking;        // 1 if ego is talking, 0 otherwise
+		uint16 wait;                // wait time in ms
+		Common::String textEnglish; // 256 bytes, English text
+		Common::String textFrench;  // 256 bytes, French text
+		Common::String textItalian; // 256 bytes, Italian text
+		Common::String textGerman;  // 256 bytes, German text
+		Common::String textSpanish; // 256 bytes, Spanish text
+		Common::String speechFile;  // 32 bytes
+
+		int32 hashFourCharString; // Hash calculated on a four char string, from disasm
+	};
+
+	ScummEngine *_vm;
+	Audio::Mixer *_mixer;
+
+	typedef Common::Array<AudioEntry> AudioIndex;
+	typedef Common::HashMap<uint32, uint32> OffsetToIndexMap;
+	typedef Common::HashMap<Common::String, int32> NameToIndexMap;
+	typedef Common::HashMap<Common::String, uint32> NameToOffsetMap;
+
+	OffsetToIndexMap _offsetToIndexDOTTAndFT;
+	NameToOffsetMap _nameToOffsetDOTTAndFT;
+	NameToIndexMap _nameToIndexMISpeech;
+	NameToIndexMap _nameToIndexMISpeechPatched;
+
+	AudioIndex _musicEntries;
+	AudioIndex _speechEntries;
+	AudioIndex _sfxEntries;
+	AudioIndex _ambienceEntries;
+	AudioIndex _commentaryEntries;
+	AudioIndex _patchEntries;
+
+	typedef Common::Array<AudioEntryMI> AudioIndexMI;
+	AudioIndexMI _audioEntriesMI;
+
+	/* MI SE injected speech */
+	int32 _currentScriptSavedForSpeechMI = 0;
+	int32 _currentScriptOffsetSavedForSpeechMI = 0;
+
+	Audio::SoundHandle _ambienceHandle;
+
+	int32 getSoundIndexFromOffset(uint32 offset);
+	int32 getAppropriateSpeechCue(const char *msgString,
+								  const char *speechFilenameSubstitution,
+								  uint16 roomNumber,
+								  uint16 actorTalking,
+								  uint16 scriptNum,
+								  uint16 scriptOffset,
+								  uint16 numWaits);
+
+	void initAudioMappingMI();
+	void initAudioMappingDOTTAndFT();
+	void initSoundFiles();
+
+	// Index XWB audio files and XSB cue files - used in MI1SE and MI2SE
+	void indexXWBFile(SoundSEType type);
+	void indexSpeechXSBFile();
+
+	// Index FSB audio files - used in DOTT and FT
+	void indexFSBFile(SoundSEType type);
+
+	Common::String getAudioFilename(SoundSEType type);
+	Common::SeekableReadStream *getAudioFile(const Common::String &filename);
+	Common::SeekableReadStream *getAudioFile(SoundSEType type);
+	AudioIndex *getAudioEntries(SoundSEType type);
+	int32 getAmbienceTrack(int32 musicTrack);
+
+	Audio::SeekableAudioStream *createSoundStream(Common::SeekableSubReadStream *stream, AudioEntry entry, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+};
+
+#if 0
+/**
+ * A special headerless WMA stream, used in MI1:SE and MI2:SE
+ */
+class HeaderlessWMAStream : public Audio::SeekableAudioStream {
+public:
+	HeaderlessWMAStream(Common::SeekableReadStream *stream,
+						AudioEntry entry,
+						DisposeAfterUse::Flag disposeAfterUse);
+	~HeaderlessWMAStream() override;
+
+	int readBuffer(int16 *buffer, const int numSamples) override;
+
+	bool endOfData() const override { return _stream->eos(); }
+	bool isStereo() const override { return _entry.channels == 2; }
+	int getRate() const override { return _entry.rate; }
+	Audio::Timestamp getLength() const override {
+		return Audio::Timestamp(_entry.length / 10000, _entry.rate);
+	}
+	bool seek(const Audio::Timestamp &where) override;
+
+private:
+	Common::SeekableReadStream *_stream = nullptr;
+	AudioStream *_audioStream = nullptr;
+	AudioEntry _entry;
+	DisposeAfterUse::Flag _disposeAfterUse;
+	Audio::WMACodec *_wmaCodec = nullptr;
+};
+#endif
+
+} // End of namespace Scumm
+
+#endif