aboutsummaryrefslogtreecommitdiff
path: root/engines/zvision/video/rlf_decoder.h
blob: f0f31c2128c687ea6f580a48a47d2a1a933e661f (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
/* 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.
 *
 */

#ifndef ZVISION_RLF_DECODER_H
#define ZVISION_RLF_DECODER_H

#include "common/file.h"
#include "video/video_decoder.h"

#include "graphics/surface.h"

namespace ZVision {

class RLFDecoder : public Video::VideoDecoder {
public:
	RLFDecoder() {}
	~RLFDecoder();

	bool loadStream(Common::SeekableReadStream *stream);

private:
	class RLFVideoTrack : public FixedRateVideoTrack {
	public:
		RLFVideoTrack(Common::SeekableReadStream *stream);
		~RLFVideoTrack();

		uint16 getWidth() const { return _width; }
		uint16 getHeight() const { return _height; }
		Graphics::PixelFormat getPixelFormat() const { return Graphics::PixelFormat(2, 5, 6, 5, 0, 11, 5, 0, 0); /*RGB 565*/ }
		int getCurFrame() const { return _curFrame; }
		int getFrameCount() const { return _frameCount; }
		const Graphics::Surface *decodeNextFrame();
		bool isSeekable() const { return true; }
		bool seek(const Audio::Timestamp &time);

	protected:
		Common::Rational getFrameRate() const { return Common::Rational(60, _frameTime); }

	private:
		enum EncodingType {
			Masked,
			Simple
		};

		struct Frame {
			EncodingType type;
			int8 *encodedData;
			uint32 encodedSize;
		};

		/**
		 * Reads in the header of the RLF file
		 *
		 * @return    Will return false if the header magic number is wrong
		 */
		bool readHeader();

		/**
		 * Reads the next frame from the RLF file, stores the data in
		 * a Frame object, then returns the object
		 *
		 * @return    A Frame object representing the frame data
		 */
		Frame readNextFrame();

		/**
		 * Applies the frame corresponding to frameNumber on top of _currentFrameBuffer.
		 * This function requires _stream = false so it can look up the Frame object
		 * referenced by frameNumber.
		 *
		 * @param frameNumber    The frame number to apply to _currentFrameBuffer
		 */
		void applyFrameToCurrent(uint frameNumber);

		/**
		 * Decode frame data that uses masked run length encoding. This is the encoding
		 * used by P-frames.
		 *
		 * @param source        The source pixel data
		 * @param dest          The destination buffer
		 * @param sourceSize    The size of the source pixel data
		 * @param destSize      The size of the destination buffer
		 */
		void decodeMaskedRunLengthEncoding(int8 *source, int8 *dest, uint32 sourceSize, uint32 destSize) const;
		/**
		 * Decode frame data that uses simple run length encoding. This is the encoding
		 * used by I-frames.
		 *
		 * @param source        The source pixel data
		 * @param dest          The destination buffer
		 * @param sourceSize    The size of the source pixel data
		 * @param destSize      The size of the destination buffer
		 */
		void decodeSimpleRunLengthEncoding(int8 *source, int8 *dest, uint32 sourceSize, uint32 destSize) const;

		uint _lastFrameRead;

		uint _frameCount;
		uint _width;
		uint _height;
		uint32 _frameTime; // In milliseconds
		Frame *_frames;
		Common::Array<uint> _completeFrames;

		int _curFrame;
		Graphics::Surface _currentFrameBuffer;
		uint32 _frameBufferByteSize;

		Common::SeekableReadStream *_readStream;
	};	// RLFVideoTrack
};

} // End of namespace ZVision

#endif