aboutsummaryrefslogtreecommitdiff
path: root/graphics/video/flic_player.h
blob: 43f3775bddf0b4fbc59314f8b01bbfc757505d58 (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
/* 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$
 *
 */

#ifndef GRAPHICS_VIDEO_FLICPLAYER_H
#define GRAPHICS_VIDEO_FLICPLAYER_H

#include "common/scummsys.h"
#include "common/list.h"
#include "common/rect.h"

namespace Common {
	class SeekableReadStream;
}

namespace Graphics {

struct ChunkHeader {
	uint32 size;
	uint16 type;
};

struct FrameTypeChunkHeader {
	ChunkHeader header;
	uint16 numChunks;
	uint16 delay;
	uint16 reserved; // always zero
	uint16 widthOverride;
	uint16 heightOverride;
};

class FlicPlayer {
public:
	FlicPlayer();
	~FlicPlayer();

	/**
	 * Returns the width of the video
	 * @return the width of the video
	 */
	int getWidth();

	/**
	 * Returns the height of the video
	 * @return the height of the video
	 */
	int getHeight();

	/**
	 * Returns the current frame number of the video
	 * @return the current frame number of the video
	 */
	int32 getCurFrame();

	/**
	 * Returns the amount of frames in the video
	 * @return the amount of frames in the video
	 */
	int32 getFrameCount();

	/**
	 * Load a FLIC encoded video file
	 * @param filename	the filename to load
	 */
	bool loadFile(const char *fileName);

	/**
	 * Close a FLIC encoded video file
	 */
	void closeFile();

	/**
	 * Decode the next frame
	 */
	void decodeNextFrame();

	bool isLastFrame() const { return _currFrame == _flicInfo.numFrames; }
	uint32 getSpeed() const { return _flicInfo.speed; }
	bool isPaletteDirty() const { return _paletteDirty; }
	const uint8 *getPalette() { _paletteDirty = false; return _palette; }
	const uint8 *getOffscreen() const { return _offscreen; }
	const Common::List<Common::Rect> *getDirtyRects() const { return &_dirtyRects; }
	void clearDirtyRects() { _dirtyRects.clear(); }
	void redraw();
	void reset();

	/**
	 * Copy current frame into the specified position of the destination
	 * buffer.
	 * @param dst		the buffer
	 * @param x		the x position of the buffer
	 * @param y		the y position of the buffer
	 * @param pitch		the pitch of buffer
	 */
	void copyFrameToBuffer(byte *dst, uint x, uint y, uint pitch);

private:
	struct FlicHeader {
		uint32 size;
		uint16 type;
		uint16 numFrames;
		uint16 width;
		uint16 height;
		uint32 speed;
		uint16 offsetFrame1;
		uint16 offsetFrame2;
	};

	ChunkHeader readChunkHeader();
	FrameTypeChunkHeader readFrameTypeChunkHeader(ChunkHeader chunkHead);
	void decodeByteRun(uint8 *data);
	void decodeDeltaFLC(uint8 *data);
	void setPalette(uint8 *mem);

	Common::SeekableReadStream *_fileStream;
	bool _paletteDirty;
	uint8 *_offscreen;
	uint8 _palette[256 * 4];
	FlicHeader _flicInfo;
	uint16 _currFrame;
	Common::List<Common::Rect> _dirtyRects;
};

} // End of namespace Graphics

#endif