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
|
/* 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_PLAYER_H
#define GRAPHICS_VIDEO_PLAYER_H
#include "common/events.h"
#include "common/list.h"
#include "common/stream.h"
namespace Common {
class SeekableReadStream;
}
namespace Graphics {
/**
* Implementation of a generic video decoder
*/
class VideoDecoder {
public:
VideoDecoder();
virtual ~VideoDecoder();
/**
* Returns the width of the video
* @return the width of the video
*/
virtual int getWidth();
/**
* Returns the height of the video
* @return the height of the video
*/
virtual int getHeight();
/**
* Returns the current frame number of the video
* @return the current frame number of the video
*/
virtual int32 getCurFrame() const;
/**
* Returns the amount of frames in the video
* @return the amount of frames in the video
*/
virtual int32 getFrameCount() const;
/**
* Returns the frame rate of the video
* @return the frame rate of the video
*/
virtual int32 getFrameRate();
/**
* Returns the time to wait for each frame in 1/100 ms (to avoid rounding errors)
* @return the time to wait for each frame in 1/100 ms (to avoid rounding errors)
*/
virtual int32 getFrameDelay();
/**
* Returns the current A/V lag in 1/100 ms (to avoid rounding errors)
* If > 0, audio lags behind
* If < 0, video lags behind
* @return the current A/V lag in 1/100 ms (to avoid rounding errors)
*/
virtual int32 getAudioLag();
/**
* Returns the time to wait until the next frame in ms, minding any lag
* @return the time to wait until the next frame in ms
*/
virtual uint32 getFrameWaitTime();
/**
* Load a video file
* @param filename the filename to load
*/
virtual bool loadFile(const char *filename) = 0;
/**
* Close a video file
*/
virtual void closeFile() = 0;
/**
* Returns if a video file is loaded or not
*/
bool isVideoLoaded() const { return (_fileStream != NULL); }
/**
* Set RGB palette, based on current frame
* @param pal the RGB palette data
*/
virtual void setPalette(byte *pal);
/**
* Gets the value of the pixel at the specified x and y coordinates
* Note: This method assumes that the video's pitch equals its width, and that
* the video has an 8bpp palette
* @param x the x coordinate of the pixel
* @param y the y coordinate of the pixel
*/
byte getPixel(int x, int y) {
return *(_videoFrameBuffer + y * _videoInfo.width + x * 1);
}
/**
* Gets the value of the pixel at the specified offset
* @param offset the offset of the pixel in the video buffer
*/
byte getPixel(int offset) { return getPixel(offset, 0); }
/**
* Return the black palette color for the current frame
*/
byte getBlack() { return _curFrameBlack; }
/**
* Return the white palette color for the current frame
*/
byte getWhite() { return _curFrameWhite; }
/**
* 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);
/**
* Decode the next frame to _videoFrameBuffer
*/
virtual bool decodeNextFrame() = 0;
/**
* Returns if the video is finished or not
*/
virtual bool endOfVideo() const;
protected:
struct {
uint32 width;
uint32 height;
uint32 frameCount;
int32 frameRate;
int32 frameDelay; // 1/100 ms (to avoid rounding errors)
uint32 firstframeOffset;
int32 currentFrame;
uint32 startTime;
} _videoInfo;
byte _curFrameBlack, _curFrameWhite;
Common::SeekableReadStream *_fileStream;
byte *_videoFrameBuffer;
};
class VideoPlayer {
public:
VideoPlayer(VideoDecoder* decoder) : _skipVideo(false), _decoder(decoder)
{ }
virtual ~VideoPlayer() { }
/**
* A default implementation of a video player
* Plays a non-interactive full screen video till it's stopped by a
* specific event
* @param filename the name of the file to play
* @param stopEvents a list of events that can stop the video
*
* Returns true if the video was played to the end, false if skipped
*/
bool playVideo(Common::List<Common::Event> &stopEvents);
/**
* Provides the same functionality as the video player, and it adds the
* event of skipping the video with the escape key by default
*/
bool playVideo();
protected:
/**
* Perform postprocessing once the frame data is copied to the screen,
* right before the frame is drawn. Called by playVideo()
*/
virtual void performPostProcessing(byte *screen);
bool _skipVideo;
VideoDecoder* _decoder;
void processVideoEvents(Common::List<Common::Event> &stopEvents);
};
} // End of namespace Graphics
#endif
|
