aboutsummaryrefslogtreecommitdiff
path: root/graphics/flic_player.cpp
blob: 7a7e155838c1a1d3aa9bd8888f98c63b8c8cd7d2 (plain)
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
/* 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.
 *
 * $URL$
 * $Id$
 *
 */

#include "flic_player.h"

namespace Graphics {

FlicPlayer::FlicPlayer()
	: _paletteDirty(false), _offscreen(0), _currFrame(0) {
	memset(&_flicInfo, 0, sizeof(_flicInfo));
}

FlicPlayer::~FlicPlayer() {
	closeFile();
}

bool FlicPlayer::loadFile(const char *fileName) {
	closeFile();

	if (!_fileStream.open(fileName)) {
		return false;
	}

	_flicInfo.size = _fileStream.readUint32LE();
	_flicInfo.type = _fileStream.readUint16LE();
	_flicInfo.numFrames = _fileStream.readUint16LE();
	_flicInfo.width = _fileStream.readUint16LE();
	_flicInfo.height = _fileStream.readUint16LE();
	_fileStream.skip(4);
	_flicInfo.speed = _fileStream.readUint32LE();

	_fileStream.seek(80);
	_flicInfo.offsetFrame1 = _fileStream.readUint32LE();
	_flicInfo.offsetFrame2 = _fileStream.readUint32LE();

	// Check FLC magic number
	if (_flicInfo.type != 0xAF12) {
		error("FlicPlayer::FlicPlayer(): attempted to load non-FLC data (type = 0x%04X)", _flicInfo.type);
	}

	_offscreen = new uint8[_flicInfo.width * _flicInfo.height];
	memset(_palette, 0, sizeof(_palette));
	_paletteDirty = false;

	// Seek to the first frame
	_currFrame = 0;
	_fileStream.seek(_flicInfo.offsetFrame1);
	return true;
}

void FlicPlayer::closeFile() {
	memset(&_flicInfo, 0, sizeof(_flicInfo));
	_fileStream.close();
	delete[] _offscreen;
	_offscreen = 0;
}

void FlicPlayer::redraw() {
	_dirtyRects.clear();
	_dirtyRects.push_back(Common::Rect(0, 0, _flicInfo.width, _flicInfo.height));
}

ChunkHeader FlicPlayer::readChunkHeader() {
	ChunkHeader head;

	head.size = _fileStream.readUint32LE();
	head.type = _fileStream.readUint16LE();

	return head;
}

FrameTypeChunkHeader FlicPlayer::readFrameTypeChunkHeader(ChunkHeader chunkHead) {
	FrameTypeChunkHeader head;

	head.header = chunkHead;
	head.numChunks = _fileStream.readUint16LE();
	head.delay = _fileStream.readUint16LE();
	head.reserved = _fileStream.readUint16LE();
	head.widthOverride = _fileStream.readUint16LE();
	head.heightOverride = _fileStream.readUint16LE();

	return head;
}

void FlicPlayer::decodeByteRun(uint8 *data) {
	uint8 *ptr = (uint8 *)_offscreen;
	while ((ptr - _offscreen) < (_flicInfo.width * _flicInfo.height)) {
		int chunks = *data++;
		while (chunks--) {
			int count = (int8)*data++;
			if (count > 0) {
				memset(ptr, *data++, count);
			} else {
				count = -count;
				memcpy(ptr, data, count);
				data += count;
			}
			ptr += count;
		}
	}

	redraw();
}

#define OP_PACKETCOUNT   0
#define OP_UNDEFINED     1
#define OP_LASTPIXEL     2
#define OP_LINESKIPCOUNT 3

void FlicPlayer::decodeDeltaFLC(uint8 *data) {
	uint16 linesInChunk = READ_LE_UINT16(data); data += 2;
	uint16 currentLine = 0;
	uint16 packetCount = 0;

	while (linesInChunk--) {
		uint16 opcode;

		// First process all the opcodes.
		do {
			opcode = READ_LE_UINT16(data); data += 2;

			switch ((opcode >> 14) & 3) {
			case OP_PACKETCOUNT:
				packetCount = opcode;
				break;
			case OP_UNDEFINED:
				break;
			case OP_LASTPIXEL:
				_offscreen[currentLine * _flicInfo.width + _flicInfo.width - 1] = (opcode & 0xFF);
				_dirtyRects.push_back(Common::Rect(_flicInfo.width - 1, currentLine, _flicInfo.width, currentLine + 1));
				break;
			case OP_LINESKIPCOUNT:
				currentLine += -(int16)opcode;
				break;
			}
		} while (((opcode >> 14) & 3) != OP_PACKETCOUNT);

		uint16 column = 0;

		// Now interpret the RLE data
		while (packetCount--) {
			column += *data++;
			int rleCount = (int8)*data++;
			if (rleCount > 0) {
				memcpy(_offscreen + (currentLine * _flicInfo.width) + column, data, rleCount * 2);
				data += rleCount * 2;
				_dirtyRects.push_back(Common::Rect(column, currentLine, column + rleCount * 2, currentLine + 1));
			} else if (rleCount < 0) {
				rleCount = -rleCount;
				uint16 dataWord = READ_UINT16(data); data += 2;
				for (int i = 0; i < rleCount; ++i) {
					WRITE_UINT16(_offscreen + currentLine * _flicInfo.width + column + i * 2, dataWord);
				}
				_dirtyRects.push_back(Common::Rect(column, currentLine, column + rleCount * 2, currentLine + 1));
			} else { // End of cutscene ?
				return;
			}
			column += rleCount * 2;
		}

		currentLine++;
	}
}

#define COLOR_256  4
#define FLI_SS2    7
#define FLI_BRUN   15
#define PSTAMP     18
#define FRAME_TYPE 0xF1FA

void FlicPlayer::decodeFrame() {
	FrameTypeChunkHeader frameHeader;

	// Read chunk
	ChunkHeader cHeader = readChunkHeader();
	switch (cHeader.type) {
	case FRAME_TYPE:
		frameHeader = readFrameTypeChunkHeader(cHeader);
		_currFrame++;
		break;
	default:
		error("FlicPlayer::decodeFrame(): unknown main chunk type (type = 0x%02X)", cHeader.type);
		break;
	 }

	// Read subchunks
	if (cHeader.type == FRAME_TYPE) {
		for (int i = 0; i < frameHeader.numChunks; ++i) {
			cHeader = readChunkHeader();
			uint8 *data = new uint8[cHeader.size - 6];
			_fileStream.read(data, cHeader.size - 6);
			switch (cHeader.type) {
			case COLOR_256:
				setPalette(data);
				_paletteDirty = true;
				break;
			case FLI_SS2:
				decodeDeltaFLC(data);
				break;
			case FLI_BRUN:
				decodeByteRun(data);
				break;
			case PSTAMP:
				/* PSTAMP - skip for now */
				break;
			default:
				error("FlicPlayer::decodeFrame(): unknown subchunk type (type = 0x%02X)", cHeader.type);
				break;
			 }

			delete[] data;
		}
	}

	// If we just processed the ring frame, set the next frame
	if (_currFrame == _flicInfo.numFrames + 1) {
		_currFrame = 1;
		_fileStream.seek(_flicInfo.offsetFrame2);
	}
}

void FlicPlayer::reset() {
	_currFrame = 0;
	_fileStream.seek(_flicInfo.offsetFrame1);
}

void FlicPlayer::setPalette(uint8 *mem) {
	uint16 numPackets = READ_LE_UINT16(mem); mem += 2;

	if (0 == READ_LE_UINT16(mem)) { //special case
		mem += 2;
		for (int i = 0; i < 256; ++i) {
			memcpy(_palette + i * 4, mem + i * 3, 3);
			_palette[i * 4 + 3] = 0;
		}
	} else {
		uint8 palPos = 0;

		while (numPackets--) {
			palPos += *mem++;
			uint8 change = *mem++;

			for (int i = 0; i < change; ++i) {
				memcpy(_palette + (palPos + i) * 4, mem + i * 3, 3);
				_palette[(palPos + i) * 4 + 3] = 0;
			}

			palPos += change;
			mem += (change * 3);
		}
	}
}

} // End of namespace Graphics