aboutsummaryrefslogtreecommitdiff
path: root/common/stream.h
blob: 660fb0a02b2b0da4621223ac1708e1838e57c098 (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
/* ScummVM - Scumm Interpreter
 * Copyright (C) 2001  Ludvig Strigeus
 * Copyright (C) 2001/2002 The ScummVM project
 *
 * 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$
 *
 */

#ifndef COMMON_STREAM_H
#define COMMON_STREAM_H

#include "stdafx.h"
#include "common/scummsys.h"


namespace Common {

class WriteStream {
public:
	virtual uint32 write(const void *ptr, uint32 size) = 0;

	// The remaining methods all have default implementations

	void writeByte(byte value);
	void writeSByte(int8 value);

	void writeUint16LE(uint16 value);
	void writeUint24LE(uint32 value);
	void writeUint32LE(uint32 value);

	void writeUint16BE(uint16 value);
	void writeUint24BE(uint32 value);
	void writeUint32BE(uint32 value);

	void writeSint16LE(int16 value);
	void writeSint24LE(int32 value);
	void writeSint32LE(int32 value);

	void writeSint16BE(int16 value);
	void writeSint24BE(int32 value);
	void writeSint32BE(int32 value);
};


class ReadStream {
public:
	virtual uint32 read(void *ptr, uint32 size) = 0;

	// The remaining methods all have default implementations

	byte readByte();
	int8 readSByte();

	uint16 readUint16LE();
	uint32 readUint24LE();
	uint32 readUint32LE();

	uint16 readUint16BE();
	uint32 readUint24BE();
	uint32 readUint32BE();

	int16 readSint16LE();
	int32 readSint24LE();
	int32 readSint32LE();

	int16 readSint16BE();
	int32 readSint24BE();
	int32 readSint32BE();
};

/**
 * XORReadStream is a wrapper around an arbitrary other ReadStream,
 * which 'decrypts' the data being read by XORing all data bytes with the given
 * encryption 'key'.
 *
 * Currently, this is not used anywhere, it's just a demo of how one can chain
 * streams if necessary.
 */
class XORReadStream : public ReadStream {
private:
	byte _encbyte;
	ReadStream *_realStream;
public:
	XORReadStream(ReadStream *in = 0, byte enc = 0) :  _encbyte(enc), _realStream(in) {}
	void setStream(ReadStream *in) { _realStream = in; }
	void setEnc(byte value) { _encbyte = value; }

	uint32 read(void *ptr, uint32 size) {
		assert(_realStream);
		uint32 len = _realStream->read(ptr, size);
		if (_encbyte) {
			byte *p = (byte *)ptr;
			byte *end = p + len;
			while (p < end)
				*p++ ^= _encbyte;
		}
		return len;
	}
};

/**
 * Simple memory based 'stream', which implements the ReadStream interface for
 * a plain memory block.
 */
class MemoryReadStream : public ReadStream {
private:
	const byte *_ptr;
	const byte * const _ptrOrig;
	const uint32 _bufSize;
	uint32 _pos;
public:
	MemoryReadStream(const byte *buf, uint32 len) : _ptr(buf), _ptrOrig(buf), _bufSize(len), _pos(0) {}

	uint32 read(void *ptr, uint32 len) {
		// Read at most as many bytes as are still available...
		if (len > _bufSize - _pos)
			len = _bufSize - _pos;
		memcpy(ptr, _ptr, len);
		_ptr += len;
		_pos += len;
		return len;
	}

	bool eof() { return _pos == _bufSize; }
	uint32 pos() { return _pos; }
	uint32 size() { return _bufSize; }

	void seek(uint32 offs, int whence = SEEK_SET) {
		// Pre-Condition
		assert(_pos <= _bufSize);
		switch (whence) {
		case SEEK_END:
			// SEEK_END works just like SEEK_SET, only 'reversed',
			// i.e. from the end.
			offs = _bufSize - offs;
			// Fall through
		case SEEK_SET:
			_ptr = _ptrOrig + offs;
			_pos = offs;
			break;

		case SEEK_CUR:
			_ptr += offs;
			_pos += offs;
			break;
		}
		// Post-Condition
		assert(_pos <= _bufSize);
	}
};

}	// End of namespace Common

#endif