BLADERUNNER: Added subtitles support and checkbox in KIA

1 files changed, 778 insertions, 0 deletions

diff --git a/engines/bladerunner/subtitles.cpp b/engines/bladerunner/subtitles.cpp
new file mode 100644
index 0000000000..b66360f81f
--- /dev/null
+++ b/engines/bladerunner/subtitles.cpp
@@ -0,0 +1,778 @@
+/* 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.
+ *
+ */
+
+#include "bladerunner/subtitles.h"
+
+#if SUBTITLES_SUPPORT
+
+#include "bladerunner/bladerunner.h"
+#include "bladerunner/font.h"
+#include "bladerunner/text_resource.h"
+#include "bladerunner/audio_speech.h"
+//#include "bladerunner/script/scene_script.h" // for Game_Flag_Query declaration (actually script.h, but this seems to be included in other source files instead)
+#include "bladerunner/game_flags.h" // for Game_Flag_Query declaration (actually script.h, but this seems to be included in other source files instead)
+#include "bladerunner/game_constants.h" // for EDS flags - for subtitle checkbox flag state
+#include "common/debug.h"
+#include "common/util.h"
+
+namespace BladeRunner {
+
+/*
+ * Optional support for subtitles
+ * CHECK what happens in VQA where the audio plays separately (are the finales such VQAs ?)
+ *
+ * TODO in python script (FON from png glyphs) check if you can have semi-transparent pixels to better outline the fringe points of the glyphs - check what happens when MSB is set (transparency) and the rest of the color value is not all 0s.
+ * TODO Catch error for bad symbol in a quote (one that causes the font to crash) - this could happen with the corrupted internal font (TAHOMA18) -> font crash or bad font display / garbage character
+ * TODO add a keyboard shortcut key to enable / disable subtitles?
+ * TODO have a debug script to detect/report problematic lines (too long)
+ *
+ * TODO? put external FON and TRE in a new folder "SUBS" - case insensitive (?)
+ * TODO? Use another escape sequence to progressively display text in a line (like in SCUMM games) <-- this could be very useful with very long lines - might also need an extra manual time or ticks parameter to determine when during the display of the first segment we should switch to the second.
+ * TODO? A more advanced subtitles system
+ *          TODO: subtitles could be independent from sound playing (but should disappear when switching between UI screens)
+ *          TODO?: Support for queuing subtitles when more than one subtitle should play for a spoken dialogue (due to a very long quote)
+ *          TODO?: Predefine a minimum time for a subtitle to appear, before it is interrupted by the next one. (might need queuing)
+ *          TODO?: If the subtitle is the last one then extend its duration to another predefined delay.
+ *          TODO?: A system to auto-split a dialogue after some max characters per both lines to a new dialogue set (delete previous 2 lines, start a new one(s) with the rest of the quote).
+ *
+ * DONE Minor fixes In internal font TAHOMA18 some letters like 'P' and 'o' and not rightly aligned in the font. also not good spacing with '-' and a few other chars
+ *          Also seems that this particular font is corrupted!
+ *          Create and Support proper external FON for subtitles.
+ * DONE split at new line character (priority over auto-split)
+ * DONE auto-split a long line into two
+ * DONE support the basic 2 line subtitles
+ * DONE support a third line for subtitles (some quotes are too long for 2 lines). Are there quotes that are too long for 3 lines?
+ * DONE handle missing subtitle files! Gracefully don't show subtitles for VQAs or in-game dialogue if the required respective files are missing!
+ * DONE add subtitle files for the rest of VQAs that have spoken dialogue
+ * DONE A system to auto-split a dialogue after some max total width of character glyphs per line.
+ * DONE - OK - CHECK What happens with skipped dialogue (enter / skip dialogue key pressed)
+ * DONE - OK - CHECK what happens in VQA when no corresponding TRE subs file?
+ */
+
+#if SUBTITLES_EXTERNAL_FONT
+const Common::String Subtitles::SUBTITLES_FONT_FILENAME = "SUBTITLES.FON";
+#else
+const Common::String Subtitles::SUBTITLES_FONT_FILENAME = "TAHOMA18.FON";
+#endif
+
+/*
+* All entries need to have the language code appended (after a '_').
+* The outtakes then need a substring ".VQA"
+* And all entries should have the suffix extension ".TRE"
+* If/When adding new TRE resources here --> Update kMaxTextResourceEntries and also update method getIdxForSubsTreName()
+*/
+const Common::String Subtitles::SUBTITLES_FILENAME_PREFIXES[kMaxTextResourceEntries] = {
+	"outQuotes",        // 0 // (in-game subtitles, not VQA subtitles)
+	"WSTLGO",           // 1
+	"BRLOGO",           // 2
+	"INTRO",            // 3
+	"MW_A",             // 4
+	"MW_B01",           // 5
+	"MW_B02",           // 6
+	"MW_B03",           // 7
+	"MW_B04",           // 8
+	"MW_B05",           // 9
+	"INTRGT",           // 10
+	"MW_C01",           // 11
+	"MW_C02",           // 12
+	"MW_C03",           // 13
+	"MW_D",             // 14
+	"END04A",           // 15
+	"END04B",           // 16
+	"END04C",           // 17
+	"END06",            // 18
+	"END07",            // 19
+	"END01A",           // 20
+	"END01B",           // 21
+	"END01C",           // 22
+	"END01D",           // 23
+	"END01E",           // 24
+	"END01F",           // 25
+	"END03"             // 26
+};
+
+/**
+* Subtitles Constructor
+*/
+Subtitles::Subtitles(BladeRunnerEngine *vm) {
+	_vm = vm;
+	// Initializing and reseting Subtitles
+	for (int i = 0; i < kMaxTextResourceEntries; i++) {
+		_gameSubsFdEntries[i] = nullptr;
+		_vqaSubsTextResourceEntries[i] = nullptr;
+	}
+#if SUBTITLES_EXTERNAL_FONT
+	_gameSubsFontsFd = nullptr;
+	_subsFont = nullptr;
+#else
+	_subsFont = nullptr;
+	_subsBgFont = nullptr;
+#endif // SUBTITLES_EXTERNAL_FONT
+	reset();
+	// Done - Subtitles Reset
+	//
+	// Loading text resources
+	for (int i = 0; i < kMaxTextResourceEntries; i++) {
+		_gameSubsFdEntries[i] = new Common::File();
+		_vqaSubsTextResourceEntries[i] = new TextResource(_vm);
+		Common::String tmpConstructedFileName = "";
+		tmpConstructedFileName = SUBTITLES_FILENAME_PREFIXES[i] + "_" + _vm->_languageCode;
+		if (i > 0) {
+			tmpConstructedFileName += ".VQA";
+		}
+		tmpConstructedFileName += ".TRE";
+		if (openGameSubs(tmpConstructedFileName) && loadGameSubsText(i)) {
+			_gameSubsFdEntriesFound[i] = true;
+		}
+	}
+	// Done - Loading text resources
+	//
+	// Initializing/Loading Subtitles' Fonts
+#if SUBTITLES_EXTERNAL_FONT
+	// Open external fonts file (FON file) and load fonts
+	_gameSubsFontsFd = new Common::File();
+	_subsFont = new Font(_vm);
+	if (openSubsFontFile() && loadSubsFont()) {
+		_subsFontsLoaded = true;
+	}
+#else
+	_subsFont = new Font(_vm);
+	// Use TAHOMA18.FON (is corrupted in places)
+	// 10PT or TAHOMA24 or KIA6PT  have all caps glyphs (and also are too big or too small) so they are not appropriate.
+	if (_subsFont ->open(SUBTITLES_FONT_FILENAME, 640, 480, -1, 0, 0)) { // Color setting does not seem to affect the TAHOMA fonts or does it affect the black outline since we give 0 here?
+		_subsFont->setSpacing(1, 0);
+		_subsFont->setWhiteColor();
+		_subsFontsLoaded = true;
+	} else {
+		_subsFontsLoaded = false;
+	}
+	_subsBgFont = new Font(_vm);
+	if (_subsFontsLoaded && _subsBgFont ->open(SUBTITLES_FONT_FILENAME, 640, 480, -1, 0, 0)) { // TODO dark color? --- color does not seem to affect the TAHOMA fonts or does it affect the black outline since we give 0 here? ?? - we should give the original color here. What is it for TAHOMA?
+		_subsBgFont ->setSpacing(1, 0);
+		_subsBgFont ->setBlackColor();
+	} else {
+		_subsFontsLoaded = false;
+	}
+#endif // SUBTITLES_EXTERNAL_FONT
+	//Done - Initializing/Loading Subtitles' Fonts
+	//
+	// calculate the Screen Y position of the subtitle lines
+	// getTextHeight("") returns the maxHeight of the font glyphs regardless of the actual text parameter
+	//  debug("Max height %d", _subsFont->getTextHeight(""));
+	if (_subsFontsLoaded) {
+		for (int i = 0; i < kMaxNumOfSubtitlesLines; ++i) {
+			_subtitleLineScreenY[i] = 479 - ((kMaxNumOfSubtitlesLines - i) * (_subsFont->getTextHeight("") + 1));
+		}
+	}
+}
+
+/**
+* Subtitles Destructor
+*/
+Subtitles::~Subtitles() {
+	// delete any resource entries in the _vqaSubsTextResourceEntries table
+	// and close any open text resource files
+	for (int i = 0; i != kMaxTextResourceEntries; ++i) {
+		if (_vqaSubsTextResourceEntries[i] != nullptr) {
+			delete _vqaSubsTextResourceEntries[i];
+			_vqaSubsTextResourceEntries[i] = nullptr;
+		}
+		if (_gameSubsFdEntries[i] != nullptr) {
+
+			if (isOpenGameSubs(i)) {
+				closeGameSubs(i);
+			}
+			delete _gameSubsFdEntries[i];
+			_gameSubsFdEntries[i] = nullptr;
+		}
+	}
+#if SUBTITLES_EXTERNAL_FONT
+	if (_subsFont != nullptr) {
+		_subsFont->close();
+		delete _subsFont;
+		_subsFont = nullptr;
+	}
+	if (_gameSubsFontsFd != nullptr) {
+		if (isOpenSubsFontFile()) {
+			closeSubsFontFile();
+		}
+		delete _gameSubsFontsFd;
+		_gameSubsFontsFd = nullptr;
+	}
+#else
+	if (_subsFont != nullptr) {
+		_subsFont->close();
+		delete _subsFont;
+		_subsFont = nullptr;
+	}
+	if (_subsBgFont != nullptr) {
+		_subsBgFont->close();
+		delete _subsBgFont;
+		_subsBgFont = nullptr;
+	}
+#endif // SUBTITLES_EXTERNAL_FONT
+}
+
+/**
+*
+* Returns the index of the specified .TRE filename in the SUBTITLES_FILENAME_PREFIXES table
+*/
+int Subtitles::getIdxForSubsTreName(const Common::String &treName) const {
+	Common::String tmpConstructedFileName = "";
+	for (int i = 0; i < kMaxTextResourceEntries; ++i) {
+		tmpConstructedFileName = SUBTITLES_FILENAME_PREFIXES[i] + "_" + _vm->_languageCode;
+		if (i > 0) {
+			tmpConstructedFileName += ".VQA";
+		}
+		tmpConstructedFileName += ".TRE";
+		if (tmpConstructedFileName == treName) {
+			return i;
+		}
+	}
+	// error case
+	return -1;
+}
+
+
+/**
+* Open an external subtitles File and store its file descriptor
+* @return true if successful, false otherwise
+*/
+bool Subtitles::openGameSubs(const Common::String &filename) {
+	uint32 gameSubsEntryCount = 0;
+	int subTreIdx = getIdxForSubsTreName(filename);
+
+	if (subTreIdx < 0 || _gameSubsFdEntries[subTreIdx] == nullptr) {
+		debug("Subtitles::open(): Could not open %s", filename.c_str());
+		return false;
+	}
+//    debug("Now opening subs file: %s", filename.c_str());
+
+	if (!_gameSubsFdEntries[subTreIdx]->open(filename)) {
+		debug("Subtitles::open(): Could not open %s", filename.c_str());
+		return false;
+	}
+	gameSubsEntryCount = _gameSubsFdEntries[subTreIdx]->readUint32LE();
+
+	if (_gameSubsFdEntries[subTreIdx]->err()) {
+		error("Subtitles::open(): Error reading entries in %s", filename.c_str());
+		_gameSubsFdEntries[subTreIdx]->close();
+		return false;
+	}
+	debug("Subtitles::open: Opened in-game external subs file %s with %d entries", filename.c_str(), gameSubsEntryCount);
+	return true;
+}
+
+/**
+* Close an open external subtitles File
+*/
+void Subtitles::closeGameSubs(int subTreIdx) {
+	if (subTreIdx < 0 || _gameSubsFdEntries[subTreIdx] == nullptr) {
+		debug("Subtitles::close(): Could not close file with Idx %d", subTreIdx);
+		return;
+	}
+	return _gameSubsFdEntries[subTreIdx]->close();
+}
+
+/**
+* Check whether an external subtitles File is open
+*/
+bool Subtitles::isOpenGameSubs(int subTreIdx) const {
+	if (subTreIdx < 0 || _gameSubsFdEntries[subTreIdx] == nullptr) {
+		return false;
+	}
+	return _gameSubsFdEntries[subTreIdx]->isOpen();
+}
+
+/**
+* Load the game subs as a TRE resource and store them in a specific entry in _vqaSubsTextResourceEntries table
+*/
+bool Subtitles::loadGameSubsText(int subTreIdx) {
+	bool r = false;
+	Common::SeekableReadStream *stream = createReadStreamForGameSubs(subTreIdx);
+	if (stream != nullptr) {
+		Common::ScopedPtr<Common::SeekableReadStream> s(stream);
+		r = _vqaSubsTextResourceEntries[subTreIdx]->openFromStream(s);
+		if (!r) {
+			error("Failed to load subtitle text");
+		}
+		closeGameSubs(subTreIdx);
+	}
+	return r;
+}
+
+/**
+* Auxiliary method for loadGameSubsText
+* @return nullptr if failure, otherwise return a pointer to a new SafeSeekableSubReadStream
+*/
+Common::SeekableReadStream *Subtitles::createReadStreamForGameSubs(int subTreIdx) {
+	if (subTreIdx < 0 || _gameSubsFdEntries[subTreIdx] == nullptr) {
+		return nullptr;
+	}
+	if (!isOpenGameSubs(subTreIdx)) {
+		return nullptr;
+	}
+	return new Common::SafeSeekableSubReadStream(_gameSubsFdEntries[subTreIdx], 0, _gameSubsFdEntries[subTreIdx]->size(), DisposeAfterUse::YES); // TODO changed to YES from NO is this ok?
+}
+
+#if SUBTITLES_EXTERNAL_FONT
+//
+// EXTERN FONT MANAGEMENT - Font Open/ Create Read Stream / Load / Close methods
+//
+
+/**
+* @return true if successfully opened the external fonts (FON) file, false otherwise
+*/
+bool Subtitles::openSubsFontFile() {
+	uint32 subFontsTableEntryCount = 0;
+//    debug("Now opening subs file: %s", SUBTITLES_FONT_FILENAME.c_str());
+
+	if (_gameSubsFontsFd == nullptr || !_gameSubsFontsFd->open(SUBTITLES_FONT_FILENAME)) {
+		debug("Subtitles FONT::open(): Could not open %s", SUBTITLES_FONT_FILENAME.c_str());
+		return false;
+	}
+	subFontsTableEntryCount = _gameSubsFontsFd->readUint32LE(); // only for debug report purposes
+
+	if (_gameSubsFontsFd->err()) {
+		error("Subtitles FONT::open(): Error reading entries in %s", SUBTITLES_FONT_FILENAME.c_str());
+		_gameSubsFontsFd->close();
+		return false;
+	}
+
+	debug("Subtitles FONT::open: Opened in-game external subs FONT file %s with %d entries", SUBTITLES_FONT_FILENAME.c_str(), subFontsTableEntryCount);
+	return true;
+}
+
+/**
+* Close the external Fonts (FON) file
+*/
+void Subtitles::closeSubsFontFile() {
+	if (_gameSubsFontsFd != nullptr) {
+		_gameSubsFontsFd->close();
+	}
+}
+
+/**
+* Checks whether the external fonts (FON) file has been opened
+*/
+bool Subtitles::isOpenSubsFontFile() const {
+	return _gameSubsFontsFd != nullptr && _gameSubsFontsFd->isOpen();
+}
+
+/**
+* Auxiliary function to create a read stream fro the external fonts file
+* @return a pointer to the stream if successful, or nullptr otherwise
+*/
+Common::SeekableReadStream *Subtitles::createReadStreamForSubFonts() {
+	if (_gameSubsFontsFd == nullptr || !isOpenSubsFontFile()) {
+		return nullptr;
+	}
+	return new Common::SafeSeekableSubReadStream(_gameSubsFontsFd, 0, _gameSubsFontsFd->size(), DisposeAfterUse::YES); // TODO changed to YES from NO is this ok?
+}
+
+/**
+* Loads the font from the external font file
+* @return true if successful, or false otherwise
+*/
+bool Subtitles::loadSubsFont() {
+	bool r = false;
+	Common::SeekableReadStream *stream = createReadStreamForSubFonts();
+	if (stream != nullptr) {
+		Common::ScopedPtr<Common::SeekableReadStream> s(stream);
+		r = _subsFont->openFromStream(s, 640, 480, -1, 0, 0);
+
+		if (!r) {
+			error("Failed to load subtitle FONT");
+		} else {
+			_subsFont->setSpacing(-1, 0);
+		}
+		//_subsFont->setSpacing(0, 0);
+		closeSubsFontFile();
+	}
+	return r;
+}
+
+//
+// END OF EXTERNAL FONT MANAGEMENT
+//
+#endif // SUBTITLES_EXTERNAL_FONT
+
+/**
+* Get the active subtitle text by searching with actor ID and speech ID
+* Use this method for in-game dialogue - Not dialogue during a VQA cutscene
+* Returns the dialogue quote, but also sets the private _currentSubtitleTextFull member
+*/
+const char *Subtitles::getInGameSubsText(int actorId, int speech_id)  {
+	int32 id = 10000 * actorId + speech_id;
+	if (!_gameSubsFdEntriesFound[0]) {
+		if (_currentSubtitleTextFull  != "") {
+			_currentSubtitleTextFull = "";
+			_subtitlesQuoteChanged = true;
+		}
+		return "";
+	}
+	// Search in the first TextResource of the _vqaSubsTextResourceEntries table, which is the TextResource for in-game dialogue (i.e. not VQA dialogue)
+	const Common::String &text = _vqaSubsTextResourceEntries[0]->getText((uint32)id);
+	_currentSubtitleTextFull = Common::String(text);
+	_subtitlesQuoteChanged = true;
+	return _currentSubtitleTextFull.c_str();
+}
+
+/**
+* Use this method for dialogue during VQA cutscenes
+* Returns the dialogue quote, but also sets the private _currentSubtitleTextFull member
+*/
+const char *Subtitles::getOuttakeSubsText(const Common::String &outtakesName, int frame) {
+	int fileIdx = getIdxForSubsTreName(outtakesName);
+	if (fileIdx == -1 || !_gameSubsFdEntriesFound[fileIdx]) {
+		if (_currentSubtitleTextFull != "") {
+			_currentSubtitleTextFull = "";
+			_subtitlesQuoteChanged = true;
+		}
+		return "";
+	}
+	// Search in the requested TextResource at the fileIdx index of the _vqaSubsTextResourceEntries table for a quote that corresponds to the specified video frame
+	// debug("Number of resource quotes to search: %d, requested frame: %u", _vqaSubsTextResourceEntries[fileIdx]->getCount(), (uint32)frame );
+	const Common::String &text = _vqaSubsTextResourceEntries[fileIdx]->getOuttakeTextByFrame((uint32)frame);
+	//if(text != "") {
+	//    debug("Text = %s", text.c_str());
+	//}
+	if (_currentSubtitleTextFull != Common::String(text)) {
+		_currentSubtitleTextFull = Common::String(text);
+		_subtitlesQuoteChanged = true;
+	}
+	return _currentSubtitleTextFull.c_str();
+}
+
+/**
+* Explicitly set the active subtitle text to be displayed
+* Used for debug purposes mainly.
+*/
+void Subtitles::setGameSubsText(Common::String dbgQuote) {
+	if (_currentSubtitleTextFull != dbgQuote) {
+		_currentSubtitleTextFull = dbgQuote;
+		_subtitlesQuoteChanged = true;
+	}
+}
+
+/**
+* Sets the _isVisible member var to true if it's not already set
+* @return true if the member was set now, false if the member was already set
+*/
+bool Subtitles::show() {
+
+	if (_isVisible) {
+		return false;
+	}
+	_isVisible = true;
+	return true;
+}
+
+/**
+* Clears the _isVisible member var if not already clear.
+* @return true if the member was cleared, false if it was already clear.
+*/
+bool Subtitles::hide() {
+	if (!_isVisible) {
+		return false;
+	}
+
+	_isVisible = false;
+	return true;
+}
+
+/**
+* Checks whether the subtitles should be visible or not
+* @return the value of the _isVisible member boolean var
+*/
+bool Subtitles::isVisible() const {
+	return _isVisible;
+}
+
+/**
+* Tick method specific for outtakes (VQA videos)
+*/
+void Subtitles::tickOuttakes(Graphics::Surface &s) {
+	if (_currentSubtitleTextFull.empty()) {
+		_vm->_subtitles->hide();
+	} else {
+		_vm->_subtitles->show();
+	}
+#if BLADERUNNER_RESTORED_CONTENT_GAME
+	if (!_vm->_extraGameFlagsForRestoredContent->query(kEDSFlagSubtitlesEnable)) {
+		return;
+	}
+#endif
+	if (!_isVisible) { // keep it as a separate if
+		return;
+	}
+	draw(s);
+}
+
+/**
+* Tick method for in-game subtitles -- Not for outtake cutscenes (VQA videos)
+*/
+void Subtitles::tick(Graphics::Surface &s) {
+	if (!_vm->_audioSpeech->isPlaying()) {
+		_vm->_subtitles->hide(); // TODO might need a better system. Don't call it always.
+
+	}
+#if BLADERUNNER_RESTORED_CONTENT_GAME
+	if (!_vm->_extraGameFlagsForRestoredContent->query(kEDSFlagSubtitlesEnable)) {
+		return;
+	}
+#endif
+	if (!_isVisible)  { // keep it as a separate if
+		return;
+	}
+	draw(s);
+}
+
+/**
+* Draw method for drawing the subtitles on the display surface
+*/
+void Subtitles::draw(Graphics::Surface &s) {
+	if (!_isVisible || _currentSubtitleTextFull.empty() || !_subsFontsLoaded) {
+		return;
+	}
+	if (_subtitlesQuoteChanged) {
+		calculatePosition(); // Don't always call calc position, only when quote has changed
+		_subtitlesQuoteChanged = false;
+	}
+
+#if SUBTITLES_EXTERNAL_FONT
+	for (int i = 0; i < _currentSubtitleLines; ++i) {
+		_subsFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i], _subtitleLineScreenY[i]);
+	}
+#else
+	// INTERNAL FONT. NEEDS HACK (_subsBgFont) FOR SHADOW EFFECT
+	for (int i = 0; i < _currentSubtitleLines; ++i) {
+		_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i], _subtitleLineScreenY[i] - 1);
+		_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i], _subtitleLineScreenY[i] + 1);
+		_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i] + 1, _subtitleLineScreenY[i] + 1);
+		_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i] + 1, _subtitleLineScreenY[i] - 1);
+		if (_subtitleLineScreenX[i] > 0) {
+			_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i] - 1, _subtitleLineScreenY[i] - 1);
+			_subsBgFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i] - 1, _subtitleLineScreenY[i] + 1);
+		}
+		_subsFont->draw(_subtitleLineQuote[i], s, _subtitleLineScreenX[i],  _subtitleLineScreenY[i]);
+	}
+#endif // SUBTITLES_EXTERNAL_FONT
+}
+
+/**
+* Calculate the position (X axis - horizontal) where the current active subtitle text should be displayed/drawn
+* This also determines if more than one lines should be drawn and what text goes into each line; splitting into multiple lines is done here
+*/
+void Subtitles::calculatePosition() {
+
+	// wOrig is in pixels, origQuoteLength is num of chars in string
+	int wOrig = _subsFont->getTextWidth(_currentSubtitleTextFull) + 2; // +2 to account for left/ right shadow pixels (or for good measure)
+	int origQuoteLength = _currentSubtitleTextFull.size();
+	int tmpCharIndex = 0;
+	bool drawSingleLineQuote = false;
+
+	const uint8 *textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();
+	int tmpLineWidth[kMaxNumOfSubtitlesLines];
+
+	_currentSubtitleLines = 1;
+	for (int i = 0; i < kMaxNumOfSubtitlesLines; ++i) {
+		_subtitleLineSplitAtCharIndex[i] = 0;
+		_subtitleLineQuote[i] = "";
+		_subtitleLineScreenX[i] = 0;
+		tmpLineWidth[i] = 0;
+	}
+
+	while (*textCharacters != 0) {
+		// check for new line explicit split
+		if (_currentSubtitleLines < kMaxNumOfSubtitlesLines && *textCharacters == 0x0A && tmpCharIndex != 0 && _subtitleLineSplitAtCharIndex[_currentSubtitleLines - 1] == 0) {
+			_subtitleLineSplitAtCharIndex[_currentSubtitleLines - 1] = tmpCharIndex;
+			_currentSubtitleLines += 1;
+		}
+		tmpCharIndex += 1;
+		textCharacters += 1;
+	}
+	_subtitleLineSplitAtCharIndex[_currentSubtitleLines - 1] = tmpCharIndex;
+	if (_currentSubtitleLines > 1) {
+		// if we can split at new line characters:
+		//
+		int j = 0;
+		textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();  // reset pointer to the start of subtitle quote
+		for (int i = 0; i < origQuoteLength ; ++i) {
+			if (j < _currentSubtitleLines && i < _subtitleLineSplitAtCharIndex[j]) {
+				_subtitleLineQuote[j] += textCharacters[i];
+			} else { // i is at split point
+				_subtitleLineQuote[j] += '\0';
+				j += 1;
+			}
+		}
+		_subtitleLineQuote[j] += '\0'; // the last line should also be NULL terminated
+		//
+		// Check widths
+		for (int i = 0; i < _currentSubtitleLines; ++i) {
+			tmpLineWidth[i] = _subsFont->getTextWidth(_subtitleLineQuote[i]) + 2;
+			_subtitleLineScreenX[i] = (639 - tmpLineWidth[i]) / 2;
+			_subtitleLineScreenX[i] = CLIP(_subtitleLineScreenX[i], 0, 639 - tmpLineWidth[i]);
+		}
+	} else {
+		// Here we initially have _currentSubtitleLines == 1
+		// Check quote for auto-splitting
+		// Auto splitting requires space characters in the quote string (which should be ok for the typical cases)
+		if (wOrig > kMaxWidthPerLineToAutoSplitThresholdPx) { // kMaxWidthPerLineToAutoSplitThresholdPx is a practical chosen threshold for width for auto-splitting quotes purposes
+			// Start by splitting in two lines. If the new parts are still too lengthy, re-try by splitting in three lines, etc.
+			for (int linesToSplitInto = 2; linesToSplitInto <= kMaxNumOfSubtitlesLines; ++linesToSplitInto) {
+				// find the first blank space after the middle
+				_subtitleLineQuote[0] = "";
+				_currentSubtitleLines = 1;
+
+				textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();   // reset pointer to the start of subtitle quote
+				textCharacters += (origQuoteLength / linesToSplitInto);
+				_subtitleLineSplitAtCharIndex[0] = (origQuoteLength / linesToSplitInto);
+				while (*textCharacters != 0 && *textCharacters != 0x20) {   // seek for a blank space character
+					_subtitleLineSplitAtCharIndex[0] += 1;
+					textCharacters += 1;
+				}
+//                debug("space blank at: %d", _subtitleLineSplitAtCharIndex[0]);
+				if (*textCharacters == 0x20) { // if we found a blank space
+					textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();
+					for (int i = 0; i < _subtitleLineSplitAtCharIndex[0] ; ++i) {
+						_subtitleLineQuote[0] += textCharacters[i];
+					}
+					_subtitleLineQuote[0] += '\0';
+//                    debug(" Line 0 quote %s", _subtitleLineQuote[0].c_str());
+					tmpLineWidth[0] = _subsFont->getTextWidth(_subtitleLineQuote[0]) + 2; // check the width of the first segment of the quote
+					if (tmpLineWidth[0] > kMaxWidthPerLineToAutoSplitThresholdPx && linesToSplitInto < kMaxNumOfSubtitlesLines) {
+						// reset process by trying to split into more lines
+						continue; // try the for loop with increased linesToSplitInto by 1
+					} else {
+						// keep current split, proceed with splitting the quote for the rest of the subtitle lines (linesToSplitInto)
+						for (int j = 2; j <= linesToSplitInto; ++j) {
+							textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();   // reset pointer to the start of subtitle quote
+							textCharacters += ((j * origQuoteLength) / linesToSplitInto);
+							_subtitleLineSplitAtCharIndex[_currentSubtitleLines] = ((j * origQuoteLength) / linesToSplitInto);
+							while (*textCharacters != 0 && *textCharacters != 0x20) {
+								_subtitleLineSplitAtCharIndex[_currentSubtitleLines] += 1;
+								textCharacters += 1;
+							}
+							textCharacters = (const uint8 *)_currentSubtitleTextFull.c_str();   // reset pointer to the start of subtitle quote
+							for (int i = _subtitleLineSplitAtCharIndex[_currentSubtitleLines - 1] + 1; i < _subtitleLineSplitAtCharIndex[_currentSubtitleLines]; ++i) {
+								_subtitleLineQuote[_currentSubtitleLines] += textCharacters[i];
+							}
+							_subtitleLineQuote[_currentSubtitleLines] +=  '\0';
+//                            debug(" Line %d, space blank at: %d, quote %s", _currentSubtitleLines, _subtitleLineSplitAtCharIndex[_currentSubtitleLines], _subtitleLineQuote[_currentSubtitleLines].c_str());
+							_currentSubtitleLines += 1;
+						}
+						//
+						// Check widths
+						for (int i = 0; i < _currentSubtitleLines; ++i) {
+							tmpLineWidth[i] = _subsFont->getTextWidth(_subtitleLineQuote[i]) + 2;
+							_subtitleLineScreenX[i] = (639 - tmpLineWidth[i]) / 2;
+							_subtitleLineScreenX[i] = CLIP(_subtitleLineScreenX[i], 0, 639 - tmpLineWidth[i]);
+						}
+						break; // from for loop about linesToSplitInto
+					}
+				} else {
+					drawSingleLineQuote = true;
+					break;  // from for loop about linesToSplitInto
+				}
+			}
+		} else {
+			drawSingleLineQuote = true;
+		}
+		if (drawSingleLineQuote) {
+			_subtitleLineQuote[0] = _currentSubtitleTextFull;
+			_subtitleLineScreenX[0] = (639 - wOrig) / 2;
+			_subtitleLineScreenX[0] = CLIP(_subtitleLineScreenX[0], 0, 639 - wOrig);
+		}
+	}
+	//debug("calculatePosition: %d %d", w, _screenFirstLineX);
+}
+
+/**
+* Initialize a few basic member vars
+*/
+void Subtitles::clear() {
+	_isVisible = false;
+	_currentSubtitleTextFull = "";
+	for (int i = 0; i < kMaxNumOfSubtitlesLines; ++i) {
+		_subtitleLineQuote[i] = "";
+		_subtitleLineScreenY[i] = 0;
+		_subtitleLineScreenX[i] = 0;
+		_subtitleLineSplitAtCharIndex[i] = 0;
+	}
+	_subtitlesQuoteChanged = true;
+	_currentSubtitleLines = 0;
+}
+
+/**
+* Initialize/ reset member vars, close open file descriptors and garbage collect subtitle fonts and text resource
+*/
+void Subtitles::reset() {
+	clear();
+
+	for (int i = 0; i != kMaxTextResourceEntries; ++i) {
+		if (_vqaSubsTextResourceEntries[i] != nullptr) {
+			delete _vqaSubsTextResourceEntries[i];
+			_vqaSubsTextResourceEntries[i] = nullptr;
+		}
+		_gameSubsFdEntriesFound[i] = false;
+
+		if (_gameSubsFdEntries[i] != nullptr) {
+			if (isOpenGameSubs(i)) {
+				closeGameSubs(i);
+			}
+			delete _gameSubsFdEntries[i];
+			_gameSubsFdEntries[i] = nullptr;
+		}
+	}
+
+#if SUBTITLES_EXTERNAL_FONT
+	if (_subsFont != nullptr) {
+		_subsFont->close();
+		delete _subsFont;
+		_subsFont = nullptr;
+	}
+
+	if (_gameSubsFontsFd != nullptr) {
+		if (isOpenSubsFontFile()) {
+			closeSubsFontFile();
+		}
+		delete _gameSubsFontsFd;
+		_gameSubsFontsFd = nullptr;
+	}
+#else
+	if (_subsFont != nullptr) {
+		_subsFont->close();
+		delete _subsFont;
+		_subsFont = nullptr;
+	}
+	if (_subsBgFont != nullptr) {
+		_subsBgFont->close();
+		delete _subsBgFont;
+		_subsBgFont = nullptr;
+	}
+#endif // SUBTITLES_EXTERNAL_FONT
+	_subsFontsLoaded = false;
+}
+
+} // End of namespace BladeRunner
+#endif