1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/* 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.
*
*/
/*
* This file is based on Wintermute Engine
* http://dead-code.org/redir.php?target=wme
* Copyright (c) 2011 Jan Nedoma
*/
#include "engines/wintermute/video/video_subtitler.h"
#include "engines/wintermute/base/base_file_manager.h"
#include "engines/wintermute/utils/path_util.h"
#include "engines/wintermute/base/font/base_font.h"
#include "engines/wintermute/base/base_game.h"
#include "engines/wintermute/base/gfx/base_renderer.h"
namespace Wintermute {
VideoSubtitler::VideoSubtitler(BaseGame *inGame): BaseClass(inGame) {
_lastSample = -1;
_currentSubtitle = 0;
_showSubtitle = false;
}
VideoSubtitler::~VideoSubtitler(void) {
for (uint i = 0; i < _subtitles.size(); i++) {
delete _subtitles[i];
}
_subtitles.clear();
}
bool VideoSubtitler::loadSubtitles(const Common::String &filename, const Common::String &subtitleFile) {
if (filename.size() == 0) {
return false;
}
for (uint i = 0; i < _subtitles.size(); i++) {
delete _subtitles[i];
}
_subtitles.clear();
_lastSample = -1;
_currentSubtitle = 0;
_showSubtitle = false;
Common::String newFile;
/*
* Okay, the expected behaviour is this: either we are
* provided with a subtitle file to use by the script when
* calling PlayTheora(), or we try to autodetect a suitable
* one which, for /some/path/movie/ogg is to be called
* /some/path/movie.sub
*/
if (subtitleFile.size() != 0) {
newFile = Common::String(subtitleFile);
} else {
Common::String path = PathUtil::getDirectoryName(filename);
Common::String name = PathUtil::getFileNameWithoutExtension(filename);
Common::String ext = ".SUB";
newFile = PathUtil::combine(path, name + ext);
}
int size;
Common::SeekableReadStream *file = BaseFileManager::getEngineInstance()->openFile(newFile, true, false);
if (file == nullptr) {
return false; // no subtitles
}
size = file->size();
char *buffer = new char[size];
file->read(buffer, size);
int start, end;
bool inToken;
char *tokenStart;
int tokenLength;
int tokenPos;
int pos = 0;
int lineLength = 0;
while (pos < size) {
start = end = -1;
inToken = false;
tokenPos = -1;
lineLength = 0;
while (pos + lineLength < size &&
buffer[pos + lineLength] != '\n' &&
buffer[pos + lineLength] != '\0') {
lineLength++;
}
int realLength;
if (pos + lineLength >= size) {
realLength = lineLength - 0;
} else {
realLength = lineLength - 1;
}
Common::String text;
char *line = (char *)&buffer[pos];
for (int i = 0; i < realLength; i++) {
if (line[i] == '{') {
if (!inToken) {
inToken = true;
tokenStart = line + i + 1;
tokenLength = 0;
tokenPos++;
} else {
tokenLength++;
}
} else if (line[i] == '}') {
if (inToken) {
inToken = false;
char *token = new char[tokenLength + 1];
strncpy(token, tokenStart, tokenLength);
token[tokenLength] = '\0';
if (tokenPos == 0) {
start = atoi(token);
} else if (tokenPos == 1) {
end = atoi(token);
}
delete[] token;
} else {
text += line[i];
}
} else {
if (inToken) {
tokenLength++;
} else {
if (line[i] == '|') {
text += '\n';
} else {
text += line[i];
}
}
}
}
if (start != -1 && text.size() > 0 && (start != 1 || end != 1)) {
_subtitles.push_back(new VideoSubtitle(_gameRef, text, start, end));
}
pos += lineLength + 1;
}
delete[] buffer;
// Succeeded loading subtitles!
return true;
}
void VideoSubtitler::display() {
if (_showSubtitle) {
BaseFont *font;
if (_gameRef->getVideoFont() == nullptr) {
font = _gameRef->getSystemFont();
} else {
font = _gameRef->getVideoFont();
}
int textHeight = font->getTextHeight(
(const byte *)_subtitles[_currentSubtitle]->getText().c_str(),
_gameRef->_renderer->getWidth());
font->drawText((const byte *)_subtitles[_currentSubtitle]->getText().c_str(),
0,
(_gameRef->_renderer->getHeight() - textHeight - 5),
(_gameRef->_renderer->getWidth()),
TAL_CENTER);
}
}
void VideoSubtitler::update(uint32 frame) {
if (_subtitles.size() == 0) {
// Edge case: we have loaded subtitles early on... from a blank file.
return;
}
if (frame != _lastSample) {
/*
* If the frame count hasn't advanced the previous state still matches
* the current frame (obviously).
*/
_lastSample = frame;
// Otherwise, we update _lastSample; see above.
_showSubtitle = false;
bool overdue = (frame > _subtitles[_currentSubtitle]->getEndFrame());
bool hasNext = (_currentSubtitle + 1 < _subtitles.size());
bool nextStarted = false;
if (hasNext) {
nextStarted = (_subtitles[_currentSubtitle + 1]->getStartFrame() <= frame);
}
while (_currentSubtitle < _subtitles.size() &&
overdue && hasNext && nextStarted) {
/*
* We advance until we get past all overdue subtitles.
* We should exit the cycle when we either reach the first
* subtitle which is not overdue whose subsequent subtitle
* has not started yet (aka the one we must display now or
* the one which WILL be displayed when its time comes)
* and / or when we reach the last one.
*/
_currentSubtitle++;
overdue = (frame > _subtitles[_currentSubtitle]->getEndFrame());
hasNext = (_currentSubtitle + 1 < _subtitles.size());
if (hasNext) {
nextStarted = (_subtitles[_currentSubtitle + 1]->getStartFrame() <= frame);
} else {
nextStarted = false;
}
}
bool currentValid = (_subtitles[_currentSubtitle]->getEndFrame() != 0);
/*
* No idea why we do this check, carried over from Mnemonic's code.
* Possibly a workaround for buggy subtitles or some kind of sentinel? :-\
*/
bool currentStarted = frame >= _subtitles[_currentSubtitle]->getStartFrame();
if (currentStarted && !overdue && currentValid) {
_showSubtitle = true;
}
}
}
} // End of namespace Wintermute
|