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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
/* 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/debug.h"
#include "common/endian.h"
#include "common/stream.h"
#include "common/substream.h"
#include "common/textconsole.h"
#include "graphics/surface.h"
#include "graphics/decoders/jpeg.h"
#include "graphics/decoders/pict.h"
namespace Graphics {
// The PICT code is based off of the QuickDraw specs:
// http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-461.html
// http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-269.html
PICTDecoder::PICTDecoder() {
_outputSurface = 0;
}
PICTDecoder::~PICTDecoder() {
destroy();
}
void PICTDecoder::destroy() {
if (_outputSurface) {
_outputSurface->free();
delete _outputSurface;
_outputSurface = 0;
}
}
#define OPCODE(a, b, c) _opcodes.push_back(PICTOpcode(a, &PICTDecoder::b, c))
void PICTDecoder::setupOpcodesCommon() {
OPCODE(0x0000, o_nop, "NOP");
OPCODE(0x0001, o_clip, "Clip");
OPCODE(0x0003, o_txFont, "TxFont");
OPCODE(0x0004, o_txFace, "TxFace");
OPCODE(0x0007, o_pnSize, "PnSize");
OPCODE(0x000D, o_txSize, "TxSize");
OPCODE(0x0010, o_txRatio, "TxRatio");
OPCODE(0x0011, o_versionOp, "VersionOp");
OPCODE(0x001E, o_nop, "DefHilite");
OPCODE(0x0028, o_longText, "LongText");
OPCODE(0x00A1, o_longComment, "LongComment");
OPCODE(0x00FF, o_opEndPic, "OpEndPic");
OPCODE(0x0C00, o_headerOp, "HeaderOp");
}
void PICTDecoder::setupOpcodesNormal() {
setupOpcodesCommon();
OPCODE(0x0098, on_packBitsRect, "PackBitsRect");
OPCODE(0x009A, on_directBitsRect, "DirectBitsRect");
OPCODE(0x8200, on_compressedQuickTime, "CompressedQuickTime");
}
void PICTDecoder::setupOpcodesQuickTime() {
setupOpcodesCommon();
OPCODE(0x0098, oq_packBitsRect, "PackBitsRect");
OPCODE(0x009A, oq_directBitsRect, "DirectBitsRect");
OPCODE(0x8200, oq_compressedQuickTime, "CompressedQuickTime");
}
#undef OPCODE
void PICTDecoder::o_nop(Common::SeekableReadStream &) {
// Nothing to do
}
void PICTDecoder::o_clip(Common::SeekableReadStream &stream) {
// Ignore
stream.skip(stream.readUint16BE() - 2);
}
void PICTDecoder::o_txFont(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
}
void PICTDecoder::o_txFace(Common::SeekableReadStream &stream) {
// Ignore
stream.readByte();
}
void PICTDecoder::o_pnSize(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
stream.readUint16BE();
}
void PICTDecoder::o_txSize(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
}
void PICTDecoder::o_txRatio(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
stream.readUint16BE();
stream.readUint16BE();
stream.readUint16BE();
}
void PICTDecoder::o_versionOp(Common::SeekableReadStream &stream) {
// We only support v2 extended
if (stream.readUint16BE() != 0x02FF)
error("Unknown PICT version");
}
void PICTDecoder::o_longText(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
stream.readUint16BE();
stream.skip(stream.readByte());
}
void PICTDecoder::o_longComment(Common::SeekableReadStream &stream) {
// Ignore
stream.readUint16BE();
stream.skip(stream.readUint16BE());
}
void PICTDecoder::o_opEndPic(Common::SeekableReadStream &stream) {
// We've reached the end of the picture
_continueParsing = false;
}
void PICTDecoder::o_headerOp(Common::SeekableReadStream &stream) {
// Read the basic header, but we don't really have to do anything with it
/* uint16 version = */ stream.readUint16BE();
stream.readUint16BE(); // Reserved
/* uint32 hRes = */ stream.readUint32BE();
/* uint32 vRes = */ stream.readUint32BE();
Common::Rect origResRect;
origResRect.top = stream.readUint16BE();
origResRect.left = stream.readUint16BE();
origResRect.bottom = stream.readUint16BE();
origResRect.right = stream.readUint16BE();
stream.readUint32BE(); // Reserved
}
void PICTDecoder::on_packBitsRect(Common::SeekableReadStream &stream) {
// Unpack data (8bpp or lower)
unpackBitsRect(stream, true);
}
void PICTDecoder::on_directBitsRect(Common::SeekableReadStream &stream) {
// Unpack data (16bpp or higher)
unpackBitsRect(stream, false);
}
void PICTDecoder::on_compressedQuickTime(Common::SeekableReadStream &stream) {
// OK, here's the fun. We get to completely change how QuickDraw draws
// the data in PICT files.
// Swap out the opcodes to the new ones
_opcodes.clear();
setupOpcodesQuickTime();
// We'll decode the first QuickTime data from here, but the QuickTime-specific
// opcodes will take over from here on out. Normal opcodes, signing off.
decodeCompressedQuickTime(stream);
}
void PICTDecoder::oq_packBitsRect(Common::SeekableReadStream &stream) {
// Skip any data here (8bpp or lower)
skipBitsRect(stream, true);
}
void PICTDecoder::oq_directBitsRect(Common::SeekableReadStream &stream) {
// Skip any data here (16bpp or higher)
skipBitsRect(stream, false);
}
void PICTDecoder::oq_compressedQuickTime(Common::SeekableReadStream &stream) {
// Just pass the data along
decodeCompressedQuickTime(stream);
}
bool PICTDecoder::loadStream(Common::SeekableReadStream &stream) {
destroy();
// Initialize opcodes to their normal state
_opcodes.clear();
setupOpcodesNormal();
_continueParsing = true;
memset(_palette, 0, sizeof(_palette));
uint16 fileSize = stream.readUint16BE();
// If we have no file size here, we probably have a PICT from a file
// and not a resource. The other two bytes are the fileSize which we
// don't actually need (and already read if from a resource).
if (!fileSize)
stream.seek(512 + 2);
_imageRect.top = stream.readUint16BE();
_imageRect.left = stream.readUint16BE();
_imageRect.bottom = stream.readUint16BE();
_imageRect.right = stream.readUint16BE();
_imageRect.debugPrint(0, "PICT Rect:");
// NOTE: This is only a subset of the full PICT format.
// - Only V2 (Extended) Images Supported
// - CompressedQuickTime (JPEG) compressed data is supported
// - DirectBitsRect/PackBitsRect compressed data is supported
for (uint32 opNum = 0; !stream.eos() && !stream.err() && stream.pos() < stream.size() && _continueParsing; opNum++) {
// PICT v2 opcodes are two bytes
uint16 opcode = stream.readUint16BE();
if (opNum == 0 && opcode != 0x0011)
error("Cannot find PICT version opcode");
else if (opNum == 1 && opcode != 0x0C00)
error("Cannot find PICT header opcode");
// Since opcodes are word-aligned, we need to mark our starting
// position here.
uint32 startPos = stream.pos();
for (uint32 i = 0; i < _opcodes.size(); i++) {
if (_opcodes[i].op == opcode) {
debug(4, "Running PICT opcode %04x '%s'", opcode, _opcodes[i].desc);
(this->*(_opcodes[i].proc))(stream);
break;
} else if (i == _opcodes.size() - 1) {
// Unknown opcode; attempt to continue forward
warning("Unknown PICT opcode %04x", opcode);
}
}
// Align
stream.skip((stream.pos() - startPos) & 1);
}
return _outputSurface;
}
PICTDecoder::PixMap PICTDecoder::readPixMap(Common::SeekableReadStream &stream, bool hasBaseAddr) {
PixMap pixMap;
pixMap.baseAddr = hasBaseAddr ? stream.readUint32BE() : 0;
pixMap.rowBytes = stream.readUint16BE() & 0x3fff;
pixMap.bounds.top = stream.readUint16BE();
pixMap.bounds.left = stream.readUint16BE();
pixMap.bounds.bottom = stream.readUint16BE();
pixMap.bounds.right = stream.readUint16BE();
pixMap.pmVersion = stream.readUint16BE();
pixMap.packType = stream.readUint16BE();
pixMap.packSize = stream.readUint32BE();
pixMap.hRes = stream.readUint32BE();
pixMap.vRes = stream.readUint32BE();
pixMap.pixelType = stream.readUint16BE();
pixMap.pixelSize = stream.readUint16BE();
pixMap.cmpCount = stream.readUint16BE();
pixMap.cmpSize = stream.readUint16BE();
pixMap.planeBytes = stream.readUint32BE();
pixMap.pmTable = stream.readUint32BE();
pixMap.pmReserved = stream.readUint32BE();
return pixMap;
}
struct PackBitsRectData {
PICTDecoder::PixMap pixMap;
Common::Rect srcRect;
Common::Rect dstRect;
uint16 mode;
};
void PICTDecoder::unpackBitsRect(Common::SeekableReadStream &stream, bool hasPalette) {
PackBitsRectData packBitsData;
packBitsData.pixMap = readPixMap(stream, !hasPalette);
// Read in the palette if there is one present
if (hasPalette) {
// See http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-267.html
stream.readUint32BE(); // seed
stream.readUint16BE(); // flags
uint16 colorCount = stream.readUint16BE() + 1;
for (uint32 i = 0; i < colorCount; i++) {
stream.readUint16BE();
_palette[i * 3] = stream.readUint16BE() >> 8;
_palette[i * 3 + 1] = stream.readUint16BE() >> 8;
_palette[i * 3 + 2] = stream.readUint16BE() >> 8;
}
}
packBitsData.srcRect.top = stream.readUint16BE();
packBitsData.srcRect.left = stream.readUint16BE();
packBitsData.srcRect.bottom = stream.readUint16BE();
packBitsData.srcRect.right = stream.readUint16BE();
packBitsData.dstRect.top = stream.readUint16BE();
packBitsData.dstRect.left = stream.readUint16BE();
packBitsData.dstRect.bottom = stream.readUint16BE();
packBitsData.dstRect.right = stream.readUint16BE();
packBitsData.mode = stream.readUint16BE();
uint16 width = packBitsData.srcRect.width();
uint16 height = packBitsData.srcRect.height();
byte bytesPerPixel = 0;
if (packBitsData.pixMap.pixelSize <= 8)
bytesPerPixel = 1;
else if (packBitsData.pixMap.pixelSize == 32)
bytesPerPixel = packBitsData.pixMap.cmpCount;
else
bytesPerPixel = packBitsData.pixMap.pixelSize / 8;
// Ensure we have enough space in the buffer to hold an entire line's worth of pixels
uint32 lineSize = MAX<int>(width * bytesPerPixel + (8 * 2 / packBitsData.pixMap.pixelSize), packBitsData.pixMap.rowBytes);
byte *buffer = new byte[lineSize * height];
// Read in amount of data per row
for (uint16 i = 0; i < packBitsData.pixMap.bounds.height(); i++) {
// NOTE: Compression 0 is "default". The format in SCI games is packed when 0.
// In the future, we may need to have something to set the "default" packing
// format, but this is good for now.
if (packBitsData.pixMap.packType == 1 || packBitsData.pixMap.rowBytes < 8) { // Unpacked, Pad-Byte (on 24-bit)
// TODO: Finish this. Hasn't been needed (yet).
error("Unpacked DirectBitsRect data (padded)");
} else if (packBitsData.pixMap.packType == 2) { // Unpacked, No Pad-Byte (on 24-bit)
// TODO: Finish this. Hasn't been needed (yet).
error("Unpacked DirectBitsRect data (not padded)");
} else if (packBitsData.pixMap.packType == 0 || packBitsData.pixMap.packType > 2) { // Packed
uint16 byteCount = (packBitsData.pixMap.rowBytes > 250) ? stream.readUint16BE() : stream.readByte();
unpackBitsLine(buffer + i * width * bytesPerPixel, packBitsData.pixMap.rowBytes, stream.readStream(byteCount), packBitsData.pixMap.pixelSize, bytesPerPixel);
}
}
_outputSurface = new Graphics::Surface();
switch (bytesPerPixel) {
case 1:
// Just copy to the image
_outputSurface->create(width, height, PixelFormat::createFormatCLUT8());
memcpy(_outputSurface->pixels, buffer, _outputSurface->w * _outputSurface->h);
break;
case 2:
// We have a 16-bit surface
_outputSurface->create(width, height, PixelFormat(2, 5, 5, 5, 0, 10, 5, 0, 0));
for (uint16 y = 0; y < _outputSurface->h; y++)
for (uint16 x = 0; x < _outputSurface->w; x++)
WRITE_UINT16(_outputSurface->getBasePtr(x, y), READ_UINT16(buffer + (y * _outputSurface->w + x) * 2));
break;
case 3:
// We have a planar 24-bit surface
_outputSurface->create(width, height, Graphics::PixelFormat(4, 8, 8, 8, 8, 24, 16, 8, 0));
for (uint16 y = 0; y < _outputSurface->h; y++) {
for (uint16 x = 0; x < _outputSurface->w; x++) {
byte r = *(buffer + y * _outputSurface->w * 3 + x);
byte g = *(buffer + y * _outputSurface->w * 3 + _outputSurface->w + x);
byte b = *(buffer + y * _outputSurface->w * 3 + _outputSurface->w * 2 + x);
*((uint32 *)_outputSurface->getBasePtr(x, y)) = _outputSurface->format.RGBToColor(r, g, b);
}
}
break;
case 4:
// We have a planar 32-bit surface
// Note that we ignore the alpha channel since it seems to not be correct
// Mac OS X does not ignore it, but then displays it incorrectly. Photoshop
// does ignore it and displays it correctly.
_outputSurface->create(width, height, Graphics::PixelFormat(4, 8, 8, 8, 8, 24, 16, 8, 0));
for (uint16 y = 0; y < _outputSurface->h; y++) {
for (uint16 x = 0; x < _outputSurface->w; x++) {
byte a = 0xFF;
byte r = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w + x);
byte g = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w * 2 + x);
byte b = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w * 3 + x);
*((uint32 *)_outputSurface->getBasePtr(x, y)) = _outputSurface->format.ARGBToColor(a, r, g, b);
}
}
break;
}
delete[] buffer;
}
void PICTDecoder::unpackBitsLine(byte *out, uint32 length, Common::SeekableReadStream *data, byte bitsPerPixel, byte bytesPerPixel) {
uint32 dataDecoded = 0;
byte bytesPerDecode = (bytesPerPixel == 2) ? 2 : 1;
while (data->pos() < data->size() && dataDecoded < length) {
byte op = data->readByte();
if (op & 0x80) {
uint32 runSize = (op ^ 255) + 2;
uint16 value = (bytesPerDecode == 2) ? data->readUint16BE() : data->readByte();
for (uint32 i = 0; i < runSize; i++) {
if (bytesPerDecode == 2) {
WRITE_UINT16(out, value);
out += 2;
} else {
outputPixelBuffer(out, value, bitsPerPixel);
}
}
dataDecoded += runSize * bytesPerDecode;
} else {
uint32 runSize = op + 1;
if (bytesPerDecode == 1) {
for (uint32 i = 0; i < runSize; i++)
outputPixelBuffer(out, data->readByte(), bitsPerPixel);
} else {
for (uint32 i = 0; i < runSize; i++) {
WRITE_UINT16(out, data->readUint16BE());
out += 2;
}
}
dataDecoded += runSize * bytesPerDecode;
}
}
// HACK: Even if the data is 24-bit, rowBytes is still 32-bit
if (bytesPerPixel == 3)
dataDecoded += length / 4;
if (length != dataDecoded)
warning("Mismatched PackBits read (%d/%d)", dataDecoded, length);
delete data;
}
void PICTDecoder::outputPixelBuffer(byte *&out, byte value, byte bitsPerPixel) {
switch (bitsPerPixel) {
case 1:
for (int i = 7; i >= 0; i--)
*out++ = (value >> i) & 1;
break;
case 2:
for (int i = 6; i >= 0; i -= 2)
*out++ = (value >> i) & 3;
break;
case 4:
*out++ = (value >> 4) & 0xf;
*out++ = value & 0xf;
break;
default:
*out++ = value;
}
}
void PICTDecoder::skipBitsRect(Common::SeekableReadStream &stream, bool hasPalette) {
// Step through a PackBitsRect/DirectBitsRect function
if (!hasPalette)
stream.readUint32BE();
uint16 rowBytes = stream.readUint16BE();
uint16 height = stream.readUint16BE();
stream.readUint16BE();
height = stream.readUint16BE() - height;
stream.readUint16BE();
uint16 packType;
// Top two bits signify PixMap vs BitMap
if (rowBytes & 0xC000) {
// PixMap
stream.readUint16BE();
packType = stream.readUint16BE();
stream.skip(14);
stream.readUint16BE(); // pixelSize
stream.skip(16);
if (hasPalette) {
stream.readUint32BE();
stream.readUint16BE();
stream.skip((stream.readUint16BE() + 1) * 8);
}
rowBytes &= 0x3FFF;
} else {
// BitMap
packType = 0;
}
stream.skip(18);
for (uint16 i = 0; i < height; i++) {
if (packType == 1 || packType == 2 || rowBytes < 8)
error("Unpacked PackBitsRect data");
else if (packType == 0 || packType > 2)
stream.skip((rowBytes > 250) ? stream.readUint16BE() : stream.readByte());
}
}
// Compressed QuickTime details can be found here:
// http://developer.apple.com/legacy/mac/library/#documentation/QuickTime/Rm/CompressDecompress/ImageComprMgr/B-Chapter/2TheImageCompression.html
// http://developer.apple.com/legacy/mac/library/#documentation/QuickTime/Rm/CompressDecompress/ImageComprMgr/F-Chapter/6WorkingwiththeImage.html
void PICTDecoder::decodeCompressedQuickTime(Common::SeekableReadStream &stream) {
// First, read all the fields from the opcode
uint32 dataSize = stream.readUint32BE();
uint32 startPos = stream.pos();
/* uint16 version = */ stream.readUint16BE();
// Read in the display matrix
uint32 matrix[3][3];
for (uint32 i = 0; i < 3; i++)
for (uint32 j = 0; j < 3; j++)
matrix[i][j] = stream.readUint32BE();
// We currently only support offseting images vertically from the matrix
uint16 xOffset = 0;
uint16 yOffset = matrix[2][1] >> 16;
uint32 matteSize = stream.readUint32BE();
stream.skip(8); // matte rect
/* uint16 transferMode = */ stream.readUint16BE();
stream.skip(8); // src rect
/* uint32 accuracy = */ stream.readUint32BE();
uint32 maskSize = stream.readUint32BE();
// Skip the matte and mask
stream.skip(matteSize + maskSize);
// Now we've reached the image descriptor, so read the relevant data from that
uint32 idStart = stream.pos();
uint32 idSize = stream.readUint32BE();
uint32 codec = stream.readUint32BE();
stream.skip(36); // miscellaneous stuff
uint32 jpegSize = stream.readUint32BE();
stream.skip(idSize - (stream.pos() - idStart)); // more useless stuff
if (codec != MKTAG('j', 'p', 'e', 'g'))
error("Unhandled CompressedQuickTime format '%s'", tag2str(codec));
Common::SeekableSubReadStream jpegStream(&stream, stream.pos(), stream.pos() + jpegSize);
JPEGDecoder jpeg;
if (!jpeg.loadStream(jpegStream))
error("PICTDecoder::decodeCompressedQuickTime(): Could not decode JPEG data");
const Graphics::Surface *jpegSurface = jpeg.getSurface();
if (!_outputSurface) {
_outputSurface = new Graphics::Surface();
_outputSurface->create(_imageRect.width(), _imageRect.height(), jpegSurface->format);
}
for (uint16 y = 0; y < jpegSurface->h; y++)
memcpy(_outputSurface->getBasePtr(0 + xOffset, y + yOffset), jpegSurface->getBasePtr(0, y), jpegSurface->w * jpegSurface->format.bytesPerPixel);
stream.seek(startPos + dataSize);
}
} // End of namespace Graphics
|