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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2004-2005 The ScummVM project
*
* The ReInherit Engine is (C)2000-2003 by Daniel Balsom.
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header$
*
*/
// Background animation management module
#include "saga/saga.h"
#include "saga/gfx.h"
#include "saga/console.h"
#include "saga/events.h"
#include "saga/render.h"
#include "saga/animation.h"
namespace Saga {
Anim::Anim(SagaEngine *vm) : _vm(vm) {
uint16 i;
for (i = 0; i < MAX_ANIMATIONS; i++)
_animations[i] = NULL;
}
Anim::~Anim(void) {
reset();
}
void Anim::load(uint16 animId, const byte *animResourceData, size_t animResourceLength) {
AnimationData *anim;
uint16 temp;
if (animId >= MAX_ANIMATIONS) {
error("Anim::load could not find unused animation slot");
}
anim = _animations[animId] = new AnimationData(animResourceData, animResourceLength);
MemoryReadStreamEndian headerReadS(anim->resourceData, anim->resourceLength, _vm->isBigEndian());
anim->magic = headerReadS.readUint16LE(); // cause ALWAYS LE
anim->screenWidth = headerReadS.readUint16();
anim->screenHeight = headerReadS.readUint16();
anim->unknown06 = headerReadS.readByte();
anim->unknown07 = headerReadS.readByte();
anim->maxFrame = headerReadS.readByte() - 1;
anim->loopFrame = headerReadS.readByte() - 1;
temp = headerReadS.readUint16BE();
anim->start = headerReadS.pos();
if (temp == (uint16)(-1)) {
temp = 0;
}
anim->start += temp;
// Cache frame offsets
anim->frameOffsets = (size_t *)malloc((anim->maxFrame + 1) * sizeof(*anim->frameOffsets));
if (anim->frameOffsets == NULL) {
memoryError("Anim::load");
}
fillFrameOffsets(anim);
/* char s[200];
sprintf(s, "d:\\anim%i",animId);
long flen=anim->resourceLength;
char *buf=(char*)anim->resourceData;
FILE*f;
f=fopen(s,"wb");
for(long i=0;i<flen;i++)
fputc(buf[i],f);
fclose(f);*/
// Set animation data
anim->currentFrame = 0;
anim->completed = 0;
anim->cycles = anim->maxFrame;
anim->frameTime = DEFAULT_FRAME_TIME;
anim->flags = 0;
anim->linkId = -1;
anim->state = ANIM_PAUSE;
}
void Anim::link(int16 animId1, int16 animId2) {
AnimationData *anim1;
AnimationData *anim2;
anim1 = getAnimation(animId1);
anim1->linkId = animId2;
if (animId2 == -1) {
return;
}
anim2 = getAnimation(animId2);
anim2->frameTime = anim1->frameTime;
}
void Anim::setCycles(uint16 animId, int cycles) {
AnimationData *anim;
anim = getAnimation(animId);
anim->cycles = cycles;
}
void Anim::play(uint16 animId, int vectorTime, bool playing) {
Event event;
Surface *backGroundSurface;
byte *displayBuffer;
uint16 frame;
int frameTime;
AnimationData *anim;
AnimationData *linkAnim;
anim = getAnimation(animId);
backGroundSurface = _vm->_render->getBackGroundSurface();
displayBuffer = (byte*)backGroundSurface->pixels;
if (playing) {
anim->state = ANIM_PLAYING;
}
if (anim->state == ANIM_PAUSE) {
return;
}
if (anim->completed < anim->cycles) {
frame = anim->currentFrame;
// FIXME: if start > 0, then this works incorrectly
decodeFrame(anim, anim->frameOffsets[frame], displayBuffer, _vm->getDisplayWidth() * _vm->getDisplayHeight());
anim->currentFrame++;
if (anim->completed != 65535) {
anim->completed++;
}
if (anim->currentFrame > anim->maxFrame) {
anim->currentFrame = anim->loopFrame;
if (anim->flags & ANIM_STOPPING || anim->currentFrame == -1) {
anim->state = ANIM_PAUSE;
}
}
} else {
// Animation done playing
if (anim->linkId != -1) {
// If this animation has a link, follow it
anim->currentFrame = 0;
anim->completed = 0;
anim->state = ANIM_PAUSE;
} else {
// No link, stop playing
anim->currentFrame = anim->maxFrame;
anim->state = ANIM_PAUSE;
if (anim->flags & ANIM_ENDSCENE) {
// This animation ends the scene
event.type = ONESHOT_EVENT;
event.code = SCENE_EVENT;
event.op = EVENT_END;
event.time = anim->frameTime + vectorTime;
_vm->_events->queue(&event);
}
return;
}
}
if (anim->state == ANIM_PAUSE && anim->linkId != -1) {
// If this animation has a link, follow it
linkAnim = getAnimation(anim->linkId);
debug(5, "Animation ended going to %d", anim->linkId);
linkAnim->currentFrame = 0;
linkAnim->completed = 0;
linkAnim->state = ANIM_PLAYING;
animId = anim->linkId;
frameTime = 0;
} else {
frameTime = anim->frameTime + vectorTime;
}
event.type = ONESHOT_EVENT;
event.code = ANIM_EVENT;
event.op = EVENT_FRAME;
event.param = animId;
event.time = frameTime;
_vm->_events->queue(&event);
}
void Anim::stop(uint16 animId) {
AnimationData *anim;
anim = getAnimation(animId);
anim->state = ANIM_PAUSE;
}
void Anim::finish(uint16 animId) {
AnimationData *anim;
anim = getAnimation(animId);
anim->state = ANIM_STOPPING;
}
void Anim::resume(uint16 animId, int cycles) {
AnimationData *anim;
anim = getAnimation(animId);
anim->cycles += cycles;
play(animId, 0, true);
}
void Anim::reset() {
uint16 i;
for (i = 0; i < MAX_ANIMATIONS; i++) {
if (_animations[i] != NULL) {
delete _animations[i];
_animations[i] = NULL;
}
}
}
void Anim::setFlag(uint16 animId, uint16 flag) {
AnimationData *anim;
anim = getAnimation(animId);
anim->flags |= flag;
}
void Anim::clearFlag(uint16 animId, uint16 flag) {
AnimationData *anim;
anim = getAnimation(animId);
anim->flags &= ~flag;
}
void Anim::setFrameTime(uint16 animId, int time) {
AnimationData *anim;
anim = getAnimation(animId);
anim->frameTime = time;
}
int16 Anim::getCurrentFrame(uint16 animId) {
AnimationData *anim;
anim = getAnimation(animId);
return anim->currentFrame;
}
void Anim::decodeFrame(AnimationData *anim, size_t frameOffset, byte *buf, size_t bufLength) {
byte *writePointer = NULL;
uint16 xStart = 0;
uint16 yStart = 0;
uint32 screenWidth;
uint32 screenHeight;
int markByte;
byte dataByte;
int newRow;
uint16 controlChar;
uint16 paramChar;
uint16 runcount;
int xVector;
uint16 i;
bool longData = isLongData();
screenWidth = anim->screenWidth;
screenHeight = anim->screenHeight;
if ((screenWidth * screenHeight) > bufLength) {
// Buffer argument is too small to hold decoded frame, abort.
error("decodeFrame() Buffer size inadequate");
}
MemoryReadStream readS(anim->resourceData + frameOffset, anim->resourceLength - frameOffset);
#if 1
#define VALIDATE_WRITE_POINTER \
if ((writePointer < buf) || (writePointer >= (buf + screenWidth * screenHeight))) { \
error("VALIDATE_WRITE_POINTER: writePointer=%x buf=%x", writePointer, buf); \
}
#else
#define VALIDATE_WRITE_POINTER
#endif
// Begin RLE decompression to output buffer
do {
markByte = readS.readByte();
switch (markByte) {
case SAGA_FRAME_START:
xStart = readS.readUint16BE();
if (longData)
yStart = readS.readUint16BE();
else
yStart = readS.readByte();
readS.readByte(); /* Skip pad byte */
/*xPos = */readS.readUint16BE();
/*yPos = */readS.readUint16BE();
/*width = */readS.readUint16BE();
/*height = */readS.readUint16BE();
// Setup write pointer to the draw origin
writePointer = (buf + (yStart * screenWidth) + xStart);
VALIDATE_WRITE_POINTER;
continue;
break;
case SAGA_FRAME_NOOP: // Does nothing
readS.readByte();
readS.readByte();
readS.readByte();
continue;
break;
case SAGA_FRAME_LONG_UNCOMPRESSED_RUN: // Long Unencoded Run
runcount = readS.readSint16BE();
for (i = 0; i < runcount; i++) {
dataByte = readS.readByte();
if (dataByte != 0) {
*writePointer = dataByte;
}
writePointer++;
VALIDATE_WRITE_POINTER;
}
continue;
break;
case SAGA_FRAME_LONG_COMPRESSED_RUN: // Long encoded run
runcount = readS.readSint16BE();
dataByte = readS.readByte();
for (i = 0; i < runcount; i++) {
*writePointer++ = dataByte;
VALIDATE_WRITE_POINTER;
}
continue;
break;
case SAGA_FRAME_ROW_END: // End of row
xVector = readS.readSint16BE();
if (longData)
newRow = readS.readSint16BE();
else
newRow = readS.readByte();
// Set write pointer to the new draw origin
writePointer = buf + ((yStart + newRow) * screenWidth) + xStart + xVector;
VALIDATE_WRITE_POINTER;
continue;
break;
case SAGA_FRAME_REPOSITION: // Reposition command
xVector = readS.readSint16BE();
writePointer += xVector;
VALIDATE_WRITE_POINTER;
continue;
break;
case SAGA_FRAME_END: // End of frame marker
return;
break;
default:
break;
}
// Mask all but two high order control bits
controlChar = markByte & 0xC0U;
paramChar = markByte & 0x3FU;
switch (controlChar) {
case SAGA_FRAME_EMPTY_RUN: // 1100 0000
// Run of empty pixels
runcount = paramChar + 1;
writePointer += runcount;
VALIDATE_WRITE_POINTER;
continue;
break;
case SAGA_FRAME_COMPRESSED_RUN: // 1000 0000
// Run of compressed data
runcount = paramChar + 1;
dataByte = readS.readByte();
for (i = 0; i < runcount; i++) {
*writePointer++ = dataByte;
VALIDATE_WRITE_POINTER;
}
continue;
break;
case SAGA_FRAME_UNCOMPRESSED_RUN: // 0100 0000
// Uncompressed run
runcount = paramChar + 1;
for (i = 0; i < runcount; i++) {
dataByte = readS.readByte();
if (dataByte != 0) {
*writePointer = dataByte;
}
writePointer++;
VALIDATE_WRITE_POINTER;
}
continue;
break;
default:
// Unknown marker found - abort
error("decodeFrame() Invalid RLE marker encountered");
break;
}
} while (1);
}
void Anim::fillFrameOffsets(AnimationData *anim) {
uint16 currentFrame;
byte markByte;
uint16 control;
uint16 runcount;
int i;
bool longData = isLongData();
MemoryReadStreamEndian readS(anim->resourceData, anim->resourceLength, _vm->isBigEndian());
readS.seek(12);
readS._bigEndian = !_vm->isBigEndian(); // RLE has inversion BE<>LE
for (currentFrame = 0; currentFrame <= anim->maxFrame; currentFrame++) {
anim->frameOffsets[currentFrame] = readS.pos();
// For some strange reason, the animation header is in little
// endian format, but the actual RLE encoded frame data,
// including the frame header, is in big endian format. */
do {
markByte = readS.readByte();
// debug(7, "_pos=%x currentFrame=%i markByte=%x", readS.pos(), currentFrame, markByte);
switch (markByte) {
case SAGA_FRAME_START: // Start of frame
// skip header
if (longData) {
readS.seek(13, SEEK_CUR);
} else {
readS.seek(12, SEEK_CUR);
}
continue;
break;
case SAGA_FRAME_END: // End of frame marker
continue;
break;
case SAGA_FRAME_REPOSITION: // Reposition command
readS.readSint16BE();
continue;
break;
case SAGA_FRAME_ROW_END: // End of row marker
readS.readSint16BE();
if (longData)
readS.readSint16BE();
else
readS.readByte();
continue;
break;
case SAGA_FRAME_LONG_COMPRESSED_RUN: // Long compressed run marker
readS.readSint16BE();
readS.readByte();
continue;
break;
case SAGA_FRAME_LONG_UNCOMPRESSED_RUN: // (16) 0001 0000
// Long Uncompressed Run
runcount = readS.readSint16BE();
for (i = 0; i < runcount; i++)
readS.readByte();
continue;
break;
case SAGA_FRAME_NOOP: // Does nothing
readS.readByte();
readS.readByte();
readS.readByte();
continue;
break;
default:
break;
}
// Mask all but two high order (control) bits
control = markByte & 0xC0;
switch (control) {
case SAGA_FRAME_EMPTY_RUN:
// Run of empty pixels
continue;
break;
case SAGA_FRAME_COMPRESSED_RUN:
// Run of compressed data
readS.readByte(); // Skip data byte
continue;
break;
case SAGA_FRAME_UNCOMPRESSED_RUN:
// Uncompressed run
runcount = (markByte & 0x3f) + 1;
for (i = 0; i < runcount; i++)
readS.readByte();
continue;
break;
default:
error("Encountered unknown RLE marker %i", markByte);
break;
}
} while (markByte != SAGA_FRAME_END);
}
}
void Anim::animInfo() {
uint16 animCount;
uint16 i;
animCount = getAnimationCount();
_vm->_console->DebugPrintf("There are %d animations loaded:\n", animCount);
for (i = 0; i < MAX_ANIMATIONS; i++) {
if (_animations[i] == NULL) {
continue;
}
_vm->_console->DebugPrintf("%02d: Frames: %u Flags: %u\n", i, _animations[i]->maxFrame, _animations[i]->flags);
}
}
} // End of namespace Saga
|