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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
/* 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 "common/scummsys.h"
#include "common/stream.h"
#include "common/textconsole.h"
#include "audio/audiostream.h"
#include "audio/decoders/raw.h"
#include "audio/decoders/3do.h"
#include "sherlock/scalpel/3do/movie_decoder.h"
#include "image/codecs/cinepak.h"
// for Test-Code
#include "common/system.h"
#include "common/events.h"
#include "common/keyboard.h"
#include "engines/engine.h"
#include "engines/util.h"
#include "graphics/palette.h"
#include "graphics/pixelformat.h"
#include "graphics/surface.h"
namespace Sherlock {
Scalpel3DOMovieDecoder::Scalpel3DOMovieDecoder()
: _stream(0), _videoTrack(0), _audioTrack(0) {
_streamVideoOffset = 0;
_streamAudioOffset = 0;
}
Scalpel3DOMovieDecoder::~Scalpel3DOMovieDecoder() {
close();
}
bool Scalpel3DOMovieDecoder::loadStream(Common::SeekableReadStream *stream) {
uint32 videoSubType = 0;
uint32 videoCodecTag = 0;
uint32 videoHeight = 0;
uint32 videoWidth = 0;
uint32 videoFrameCount = 0;
uint32 audioSubType = 0;
uint32 audioCodecTag = 0;
uint32 audioChannels = 0;
uint32 audioSampleRate = 0;
close();
_stream = stream;
_streamVideoOffset = 0;
_streamAudioOffset = 0;
// Look for packets that we care about
static const int maxPacketCheckCount = 20;
for (int i = 0; i < maxPacketCheckCount; i++) {
uint32 tag = _stream->readUint32BE();
uint32 chunkSize = _stream->readUint32BE() - 8;
// Bail out if done
if (_stream->eos())
break;
uint32 dataStartOffset = _stream->pos();
switch (tag) {
case MKTAG('F','I','L','M'): {
// See if this is a FILM header
_stream->skip(4); // time stamp (based on 240 per second)
_stream->skip(4); // Unknown 0x00000000
videoSubType = _stream->readUint32BE();
switch (videoSubType) {
case MKTAG('F', 'H', 'D', 'R'):
// FILM header found
if (_videoTrack) {
warning("Sherlock 3DO movie: Multiple FILM headers found");
close();
return false;
}
_stream->readUint32BE();
videoCodecTag = _stream->readUint32BE();
videoHeight = _stream->readUint32BE();
videoWidth = _stream->readUint32BE();
_stream->skip(4); // time scale
videoFrameCount = _stream->readUint32BE();
_videoTrack = new StreamVideoTrack(videoWidth, videoHeight, videoCodecTag, videoFrameCount);
addTrack(_videoTrack);
break;
case MKTAG('F', 'R', 'M', 'E'):
break;
default:
warning("Sherlock 3DO movie: Unknown subtype inside FILM packet");
close();
return false;
}
break;
}
case MKTAG('S','N','D','S'): {
_stream->skip(8);
audioSubType = _stream->readUint32BE();
switch (audioSubType) {
case MKTAG('S', 'H', 'D', 'R'):
// Audio header
// Bail if we already have a track
if (_audioTrack) {
warning("Sherlock 3DO movie: Multiple SNDS headers found");
close();
return false;
}
// OK, this is the start of a audio stream
_stream->readUint32BE(); // Version, always 0x00000000
_stream->readUint32BE(); // Unknown 0x00000008 ?!
_stream->readUint32BE(); // Unknown 0x00007500
_stream->readUint32BE(); // Unknown 0x00004000
_stream->readUint32BE(); // Unknown 0x00000000
_stream->readUint32BE(); // Unknown 0x00000010
audioSampleRate = _stream->readUint32BE();
audioChannels = _stream->readUint32BE();
audioCodecTag = _stream->readUint32BE();
_stream->readUint32BE(); // Unknown 0x00000004 compression ratio?
_stream->readUint32BE(); // Unknown 0x00000A2C
_audioTrack = new StreamAudioTrack(audioCodecTag, audioSampleRate, audioChannels);
addTrack(_audioTrack);
break;
case MKTAG('S', 'S', 'M', 'P'):
// Audio data
break;
default:
warning("Sherlock 3DO movie: Unknown subtype inside FILM packet");
close();
return false;
}
break;
}
case MKTAG('C','T','R','L'):
case MKTAG('F','I','L','L'):
// Ignore but also accept CTRL + FILL packets
break;
case MKTAG('S','H','D','R'):
// Happens for EA logo, seems to be garbage data right at the start of the file
break;
default:
warning("Unknown header inside Sherlock 3DO movie");
close();
return false;
}
if ((_videoTrack) && (_audioTrack))
break;
// Seek to next chunk
_stream->seek(dataStartOffset + chunkSize);
}
// Bail if we didn't find video + audio
if ((!_videoTrack) || (!_audioTrack)) {
close();
return false;
}
// Rewind back to the beginning
_stream->seek(0);
return true;
}
void Scalpel3DOMovieDecoder::close() {
Video::VideoDecoder::close();
delete _stream; _stream = 0;
_videoTrack = 0;
}
// We try to at least decode 1 frame
// and also try to get at least 0.5 seconds of audio queued up
void Scalpel3DOMovieDecoder::readNextPacket() {
uint32 currentMovieTime = getTime();
uint32 wantedAudioQueued = currentMovieTime + 500; // always try to be 0.500 seconds in front of movie time
int32 chunkOffset = 0;
int32 dataStartOffset = 0;
int32 nextChunkOffset = 0;
uint32 chunkTag = 0;
uint32 chunkSize = 0;
uint32 videoSubType = 0;
uint32 videoTimeStamp = 0;
uint32 videoFrameSize = 0;
uint32 audioSubType = 0;
uint32 audioBytes = 0;
bool videoGotFrame = false;
bool videoDone = false;
bool audioDone = false;
// Seek to smallest stream offset
if (_streamVideoOffset <= _streamAudioOffset) {
_stream->seek(_streamVideoOffset);
} else {
_stream->seek(_streamAudioOffset);
}
if (wantedAudioQueued <= _audioTrack->getTotalAudioQueued()) {
// already got enough audio queued up
audioDone = true;
}
while (1) {
chunkOffset = _stream->pos();
assert(chunkOffset >= 0);
// Read chunk header
chunkTag = _stream->readUint32BE();
chunkSize = _stream->readUint32BE() - 8;
// Calculate offsets
dataStartOffset = _stream->pos();
assert(dataStartOffset >= 0);
nextChunkOffset = dataStartOffset + chunkSize;
//warning("offset %lx - tag %lx", dataStartOffset, tag);
if (_stream->eos())
break;
switch (chunkTag) {
case MKTAG('F','I','L','M'):
videoTimeStamp = _stream->readUint32BE();
_stream->skip(4); // Unknown
videoSubType = _stream->readUint32BE();
switch (videoSubType) {
case MKTAG('F', 'H', 'D', 'R'):
// Ignore video header
break;
case MKTAG('F', 'R', 'M', 'E'):
// Found frame data
if (_streamVideoOffset <= chunkOffset) {
// We are at an offset that is still relevant to video decoding
if (!videoDone) {
if (!videoGotFrame) {
// We haven't decoded any frame yet, so do so now
_stream->readUint32BE();
videoFrameSize = _stream->readUint32BE();
_videoTrack->decodeFrame(_stream->readStream(videoFrameSize), videoTimeStamp);
_streamVideoOffset = nextChunkOffset;
videoGotFrame = true;
} else {
// Already decoded a frame, so get timestamp of follow-up frame
// and then we are done with video
// Calculate next frame time
// 3DO clock time for movies runs at 240Hh, that's why timestamps are based on 240.
uint32 currentFrameStartTime = _videoTrack->getNextFrameStartTime();
uint32 nextFrameStartTime = videoTimeStamp * 1000 / 240;
assert(currentFrameStartTime <= nextFrameStartTime);
_videoTrack->setNextFrameStartTime(nextFrameStartTime);
// next time we want to start at the current chunk
_streamVideoOffset = chunkOffset;
videoDone = true;
}
}
}
break;
default:
error("Sherlock 3DO movie: Unknown subtype inside FILM packet");
break;
}
break;
case MKTAG('S','N','D','S'):
_stream->skip(8);
audioSubType = _stream->readUint32BE();
switch (audioSubType) {
case MKTAG('S', 'H', 'D', 'R'):
// Ignore the audio header
break;
case MKTAG('S', 'S', 'M', 'P'):
// Got audio chunk
if (_streamAudioOffset <= chunkOffset) {
// We are at an offset that is still relevant to audio decoding
if (!audioDone) {
audioBytes = _stream->readUint32BE();
_audioTrack->queueAudio(_stream, audioBytes);
_streamAudioOffset = nextChunkOffset;
if (wantedAudioQueued <= _audioTrack->getTotalAudioQueued()) {
// Got enough audio
audioDone = true;
}
}
}
break;
default:
error("Sherlock 3DO movie: Unknown subtype inside SNDS packet");
break;
}
break;
case MKTAG('C','T','R','L'):
case MKTAG('F','I','L','L'):
// Ignore but also accept CTRL + FILL packets
break;
case MKTAG('S','H','D','R'):
// Happens for EA logo, seems to be garbage data right at the start of the file
break;
default:
error("Unknown header inside Sherlock 3DO movie");
}
// Always seek to end of chunk
// Sometimes not all of the chunk is filled with audio
_stream->seek(nextChunkOffset);
if ((videoDone) && (audioDone)) {
return;
}
}
}
Scalpel3DOMovieDecoder::StreamVideoTrack::StreamVideoTrack(uint32 width, uint32 height, uint32 codecTag, uint32 frameCount) {
_width = width;
_height = height;
_frameCount = frameCount;
_curFrame = -1;
_nextFrameStartTime = 0;
// Create the Cinepak decoder, if we're using it
if (codecTag == MKTAG('c', 'v', 'i', 'd'))
_codec = new Image::CinepakDecoder();
else
error("Unknown Sherlock 3DO stream codec tag '%s'", tag2str(codecTag));
}
Scalpel3DOMovieDecoder::StreamVideoTrack::~StreamVideoTrack() {
delete _codec;
}
bool Scalpel3DOMovieDecoder::StreamVideoTrack::endOfTrack() const {
return getCurFrame() >= getFrameCount() - 1;
}
Graphics::PixelFormat Scalpel3DOMovieDecoder::StreamVideoTrack::getPixelFormat() const {
return _codec->getPixelFormat();
}
void Scalpel3DOMovieDecoder::StreamVideoTrack::decodeFrame(Common::SeekableReadStream *stream, uint32 videoTimeStamp) {
_surface = _codec->decodeFrame(*stream);
_curFrame++;
}
Scalpel3DOMovieDecoder::StreamAudioTrack::StreamAudioTrack(uint32 codecTag, uint32 sampleRate, uint32 channels) {
switch (codecTag) {
case MKTAG('A','D','P','4'):
case MKTAG('S','D','X','2'):
// ADP4 + SDX2 are both allowed
break;
default:
error("Sherlock 3DO stream audio is not using codec ADP4");
}
_totalAudioQueued = 0; // currently 0 milliseconds queued
_codecTag = codecTag;
_sampleRate = sampleRate;
_audioFlags = Audio::FLAG_16BITS;
if (channels > 1)
_audioFlags |= Audio::FLAG_STEREO;
if (_audioFlags & Audio::FLAG_STEREO) {
_audioStream = Audio::makeQueuingAudioStream(sampleRate, true);
} else {
_audioStream = Audio::makeQueuingAudioStream(sampleRate, false);
}
// reset audio decoder persistant spaces
memset(&_ADP4_PersistentSpace, 0, sizeof(_ADP4_PersistentSpace));
memset(&_SDX2_PersistentSpace, 0, sizeof(_SDX2_PersistentSpace));
}
Scalpel3DOMovieDecoder::StreamAudioTrack::~StreamAudioTrack() {
delete _audioStream;
}
void Scalpel3DOMovieDecoder::StreamAudioTrack::queueAudio(Common::SeekableReadStream *stream, uint32 size) {
Audio::SeekableAudioStream *audioStream = 0;
switch(_codecTag) {
case MKTAG('A','D','P','4'):
audioStream = Audio::make3DO_ADP4Stream(stream, size, _sampleRate, _audioFlags, DisposeAfterUse::NO, &_ADP4_PersistentSpace);
break;
case MKTAG('S','D','X','2'):
audioStream = Audio::make3DO_SDX2Stream(stream, size, _sampleRate, _audioFlags, DisposeAfterUse::NO, &_SDX2_PersistentSpace);
break;
default:
break;
}
if (audioStream) {
_totalAudioQueued += audioStream->getLength().msecs();
_audioStream->queueAudioStream(audioStream, DisposeAfterUse::YES);
}
}
Audio::AudioStream *Scalpel3DOMovieDecoder::StreamAudioTrack::getAudioStream() const {
return _audioStream;
}
// Test-code
// Code for showing a movie. Only meant for testing/debug purposes
void Scalpel3DOMoviePlay(const char *filename) {
// HACK
initGraphics(320, 200, false, NULL);
Scalpel3DOMovieDecoder *videoDecoder = new Scalpel3DOMovieDecoder();
if (!videoDecoder->loadFile(filename)) {
// HACK
initGraphics(320, 200, false);
return;
}
bool skipVideo = false;
//byte bytesPerPixel = videoDecoder->getPixelFormat().bytesPerPixel;
uint16 width = videoDecoder->getWidth();
uint16 height = videoDecoder->getHeight();
//uint16 pitch = videoDecoder->getWidth() * bytesPerPixel;
videoDecoder->start();
while (!g_engine->shouldQuit() && !videoDecoder->endOfVideo() && (!skipVideo)) {
if (videoDecoder->needsUpdate()) {
const Graphics::Surface *frame = videoDecoder->decodeNextFrame();
if (frame) {
g_system->copyRectToScreen(frame->getPixels(), frame->pitch, 0, 0, width, height);
if (videoDecoder->hasDirtyPalette()) {
const byte *palette = videoDecoder->getPalette();
g_system->getPaletteManager()->setPalette(palette, 0, 255);
}
g_system->updateScreen();
}
}
Common::Event event;
while (g_system->getEventManager()->pollEvent(event)) {
if ((event.type == Common::EVENT_KEYDOWN && event.kbd.keycode == Common::KEYCODE_ESCAPE))
skipVideo = true;
}
g_system->delayMillis(10);
}
// HACK: switch back to 8bpp
initGraphics(320, 200, false);
}
} // End of namespace Sherlock
|