Function loadCaptions

TheForceEngine/TFE_A11y/accessibility.cpp:321–397

Load the caption file with the given name and parse the subs/captions from it

	// Load the caption file with the given name and parse the subs/captions from it
	void loadCaptions(const string path)
	{
		s_captionMap.clear();

		// Try to open the file
		s_currentCaptionFile.path = path;
		if (!s_captionsStream.open(path.c_str(), Stream::AccessMode::MODE_READ))
		{
			onFileError(path);
			return;
		}

		// Parse language name; for example, if file name is "subtitles-de.txt", the language is "de".
		// The idea is for the language name to be an ISO 639-1 two-letter code, but for now the system
		// doesn't actually care how long the language name is or whether it's a valid 639-1 code.
		size_t start = path.find(FILE_NAME_START);
		if (start != string::npos)
		{
			s_currentCaptionFile.name = path.substr(start);
			string language = path.substr(start + FILE_NAME_START.length());
			language = language.substr(0, language.length() - FILE_NAME_EXT.length());
			TFE_Settings::getA11ySettings()->language = language;
		}

		// Read file into buffer.
		auto size = (u32)s_captionsStream.getSize();
		s_captionsBuffer = (char*)malloc(size);
		s_captionsStream.readBuffer(s_captionsBuffer, size);

		// Init parser (configured to ignore comment lines).
		s_parser.init(s_captionsBuffer, size);
		s_parser.addCommentString("#");
		s_parser.addCommentString("//");

		// Parse each line from the caption file.
		size_t bufferPos = 0;
		while (bufferPos < size)
		{
			const char* line = s_parser.readLine(bufferPos);
			if (!line) { break; }

			TokenList tokens;
			s_parser.tokenizeLine(line, tokens);
			if (tokens.size() < 2) { continue; }

			Caption caption = Caption();
			caption.text = tokens[1];

			// Optional third field is duration in seconds, mainly useful for cutscenes.
			if (tokens.size() > 2)
			{
				try
				{
					caption.microsecondsRemaining = secondsToMicroseconds(std::stof(tokens[2]));
				}
				catch(...) {
				}
			}