Initial commit

engines/stark/resources/speech.cpp

@@ -0,0 +1,247 @@
+/* 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/>.
+ *
+ */
+
+#include "engines/stark/resources/speech.h"
+
+#include "engines/stark/formats/xrc.h"
+
+#include "engines/stark/services/services.h"
+#include "engines/stark/services/settings.h"
+#include "engines/stark/services/dialogplayer.h"
+#include "engines/stark/services/global.h"
+#include "engines/stark/services/stateprovider.h"
+
+#include "engines/stark/resources/anim.h"
+#include "engines/stark/resources/item.h"
+#include "engines/stark/resources/level.h"
+#include "engines/stark/resources/lipsync.h"
+#include "engines/stark/resources/location.h"
+#include "engines/stark/resources/sound.h"
+
+namespace Stark {
+namespace Resources {
+
+Speech::~Speech() {
+}
+
+Speech::Speech(Object *parent, byte subType, uint16 index, const Common::String &name) :
+		Object(parent, subType, index, name),
+		_character(0),
+		_soundResource(nullptr),
+		_playTalkAnim(true),
+		_removeTalkAnimWhenComplete(true),
+		_lipSync(nullptr),
+		_waitTimeRemaining(-1) {
+	_type = TYPE;
+}
+
+Common::String Speech::getPhrase() const {
+	return _phrase;
+}
+
+void Speech::playSound() {
+	StarkGlobal->setNormalSpeed();
+
+	if (_playTalkAnim) {
+		setCharacterTalkAnim();
+	}
+
+	stopOtherSpeechesFromSameCharacter();
+
+	_soundResource = findChild<Sound>();
+	_soundResource->play();
+}
+
+void Speech::setCharacterTalkAnim() {
+	ItemVisual *characterItem = getCharacterItem();
+	if (characterItem) {
+		characterItem->setAnimActivity(Anim::kActorActivityTalk);
+
+		_lipSync = findChild<LipSync>();
+		if (_lipSync) {
+			_lipSync->setItem(characterItem, _playTalkAnim);
+		}
+	}
+}
+
+void Speech::removeCharacterTalkAnim() const {
+	ItemVisual *characterItem = getCharacterItem();
+	if (characterItem && characterItem->getAnimActivity() == Anim::kActorActivityTalk) {
+		characterItem->setAnimActivity(Anim::kActorActivityIdle);
+	}
+}
+
+ItemVisual *Speech::getCharacterItem() const {
+	Current *current = StarkGlobal->getCurrent();
+	if (!current) {
+		return nullptr;
+	}
+
+	Location *location = current->getLocation();
+	if (!location) {
+		return nullptr;
+	}
+
+	return location->getCharacterItem(_character);
+}
+
+int32 Speech::getCharacterId() {
+	return _character;
+}
+
+bool Speech::isPlaying() {
+	return _soundResource || _waitTimeRemaining > 0;
+}
+
+void Speech::stop() {
+	if (_soundResource) {
+		_soundResource->stop();
+		_soundResource = nullptr;
+	}
+
+	_waitTimeRemaining = -1;
+
+	if (_lipSync) {
+		_lipSync->reset();
+	}
+
+	if (_removeTalkAnimWhenComplete) {
+		removeCharacterTalkAnim();
+	}
+
+	_removeTalkAnimWhenComplete = true;
+	_playTalkAnim = true;
+}
+
+bool Speech::characterIsApril() const {
+	int32 aprilCharacterIndex = StarkGlobal->getApril()->getCharacterIndex();
+	return _character == aprilCharacterIndex;
+}
+
+int32 Speech::getPauseAfterSpeechDuration() const {
+	if (_phrase.hasSuffix("...")) {
+		return 1400;
+	} else if (_phrase.hasSuffix("--")) {
+		return 0;
+	} else {
+		return 1000;
+	}
+}
+
+void Speech::readData(Formats::XRCReadStream *stream) {
+	Object::readData(stream);
+
+	_phrase = stream->readString();
+	_character = stream->readSint32LE();
+
+	// bug fix for #12967 (STARK: Cortez says "no", but subtitles say "si")
+	if (StarkSettings->getLanguage() == Common::EN_ANY
+	    && _character == 1 // Cortez
+	    && getIndex() == 1
+	    && getSubType() == 0
+	    && getName().equals("Cortez_Laying low #1")) {
+		_phrase = "Nyo! So it was a good thing I didn't stick my head out the door to look for you, then, no?";
+	}
+
+	// For debug purposes
+	//printData();
+}
+
+void Speech::onGameLoop() {
+	Object::onGameLoop();
+
+	if (_soundResource && !_soundResource->isPlaying()) {
+		_soundResource->stop();
+		_soundResource = nullptr;
+		_waitTimeRemaining = getPauseAfterSpeechDuration();
+	}
+
+	if (_waitTimeRemaining >= 0) {
+		_waitTimeRemaining -= StarkGlobal->getMillisecondsPerGameloop();
+
+		if (StarkGlobal->isFastForward()) {
+			_waitTimeRemaining = -1;
+		}
+
+		if (_waitTimeRemaining <= 0) {
+			stop();
+		}
+	}
+}
+
+void Speech::onExitLocation() {
+	stop();
+}
+
+void Speech::onPreDestroy() {
+	stop();
+}
+
+void Speech::printData() {
+	Object::printData();
+
+	debug("phrase: %s", _phrase.c_str());
+	debug("character: %d", _character);
+}
+
+void Speech::setPlayTalkAnim(bool playTalkAnim) {
+	_playTalkAnim = playTalkAnim;
+}
+
+void Speech::stopOtherSpeechesFromSameCharacter() {
+	Level *globalLevel = StarkGlobal->getLevel();
+	Level *currentLevel = StarkGlobal->getCurrent()->getLevel();
+	Location *currentLocation = StarkGlobal->getCurrent()->getLocation();
+
+	Common::Array<Speech *> globalLevelSpeeches = globalLevel->listChildrenRecursive<Speech>();
+	Common::Array<Speech *> currentLevelSpeeches = currentLevel->listChildrenRecursive<Speech>();
+	Common::Array<Speech *> currentLocationSpeeches = currentLocation->listChildrenRecursive<Speech>();
+
+	Common::Array<Speech *> speeches;
+	speeches.push_back(globalLevelSpeeches);
+	speeches.push_back(currentLevelSpeeches);
+	speeches.push_back(currentLocationSpeeches);
+
+	for (uint i = 0; i < speeches.size(); i++) {
+		Speech *speech = speeches[i];
+		if (speech->_character == _character && speech->isPlaying()) {
+			speech->stop();
+		}
+	}
+}
+
+void Speech::saveLoadCurrent(ResourceSerializer *serializer) {
+	bool playing = isPlaying();
+	serializer->syncAsUint32LE(playing);
+
+	if (playing) {
+		serializer->syncAsUint32LE(_removeTalkAnimWhenComplete);
+		serializer->syncAsResourceReference(&_soundResource);
+		serializer->syncAsResourceReference(&_lipSync);
+
+		if (serializer->isLoading()) {
+			StarkDialogPlayer->playSingle(this);
+		}
+	}
+}
+
+} // End of namespace Resources
+} // End of namespace Stark