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
|
/* 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 GOB_VIDEOPLAYER_H
#define GOB_VIDEOPLAYER_H
#include "common/array.h"
#include "common/list.h"
#include "common/rect.h"
#include "common/str.h"
#include "graphics/surface.h"
#include "graphics/video/coktel_decoder.h"
#include "gob/util.h"
#include "gob/draw.h"
namespace Gob {
class GobEngine;
class DataStream;
class VideoPlayer {
public:
enum Flags {
kFlagNone = 0x000000,
kFlagUseBackSurfaceContent = 0x000040, ///< Use the back surface as a video "base".
kFlagFrontSurface = 0x000080, ///< Draw directly into the front surface.
kFlagNoVideo = 0x000100, ///< Only sound.
kFlagOtherSurface = 0x000800, ///< Draw into a specific sprite.
kFlagScreenSurface = 0x400000 ///< Draw into a newly created sprite of screen dimensions.
};
/** Video format. */
enum Type {
kVideoTypeTry = -1, ///< Try any format.
kVideoTypeIMD = 0,
kVideoTypePreIMD = 1, ///< Early IMD format found in Fascination.
kVideoTypeVMD = 2,
kVideoTypeRMD = 3 ///< VMD containing "reversed" video.
};
struct Properties {
Type type; ///< Type of the video to open.
int sprite; ///< The sprite onto which to draw the video.
int32 x; ///< X coordinate of the video.
int32 y; ///< Y coordinate of the video.
int32 width; ///< Width of the video.
int32 height; ///< Height of the video.
uint32 flags; ///< Video flags.
int32 startFrame; ///< Frame to start playback from.
int32 lastFrame; ///< Frame to stop playback at.
int32 endFrame; ///< Last frame of this playback cycle.
int16 breakKey; ///< Keycode of the break/abort key.
uint16 palCmd; ///< Palette command.
int16 palStart; ///< Palette entry to start with.
int16 palEnd; ///< Palette entry to end at.
int32 palFrame; ///< Frame to apply the palette command at.
bool fade; ///< Fade in?
bool waitEndFrame; ///< Wait for the frame's time to run out?
bool canceled; ///< Was the video canceled?
Properties();
};
VideoPlayer(GobEngine *vm);
~VideoPlayer();
void evaluateFlags(Properties &properties);
int openVideo(bool primary, const Common::String &file, Properties &properties);
bool closeVideo(int slot = 0);
bool play(int slot, Properties &properties);
void waitEndFrame(int slot);
bool slotIsOpen(int slot = 0) const;
Common::String getFileName(int slot = 0) const;
uint32 getFrameCount (int slot = 0) const;
uint32 getCurrentFrame(int slot = 0) const;
uint16 getWidth (int slot = 0) const;
uint16 getHeight (int slot = 0) const;
uint16 getDefaultX (int slot = 0) const;
uint16 getDefaultY (int slot = 0) const;
const Common::List<Common::Rect> *getDirtyRects(int slot = 0) const;
bool hasEmbeddedFile(const Common::String &fileName, int slot = 0) const;
Common::MemoryReadStream *getEmbeddedFile(const Common::String &fileName, int slot = 0);
void writeVideoInfo(const Common::String &file, int16 varX, int16 varY,
int16 varFrames, int16 varWidth, int16 varHeight);
bool copyFrame(int slot, byte *dest,
uint16 left, uint16 top, uint16 width, uint16 height,
uint16 x, uint16 y, uint16 pitch, int16 transp = -1) const;
// Obsolete, to be deleted
bool primaryOpen(const char *videoFile, int16 x = -1, int16 y = -1,
int32 flags = kFlagFrontSurface, Type which = kVideoTypeTry,
int16 width = -1, int16 height = -1);
bool primaryPlay(int16 startFrame = -1, int16 lastFrame = -1,
int16 breakKey = kShortKeyEscape,
uint16 palCmd = 8, int16 palStart = 0, int16 palEnd = 255,
int16 palFrame = -1, int16 endFrame = -1, bool fade = false,
int16 reverseTo = -1, bool forceSeek = false);
void primaryClose();
int slotOpen(const char *videoFile, Type which = kVideoTypeTry,
int16 width = -1, int16 height = -1);
void slotPlay(int slot, int16 frame = -1);
void slotClose(int slot);
void slotCopyFrame(int slot, byte *dest,
uint16 left, uint16 top, uint16 width, uint16 height,
uint16 x, uint16 y, uint16 pitch, int16 transp = -1);
void slotCopyPalette(int slot, int16 palStart = -1, int16 palEnd = -1);
void slotWaitEndFrame(int slot = -1, bool onlySound = false);
void slotSetDoubleMode(int slot, bool doubleMode);
private:
struct Video {
Graphics::CoktelDecoder *decoder;
Common::String fileName;
SurfaceDescPtr surface;
Video();
bool isEmpty() const;
void close();
};
static const int kVideoSlotCount = 32;
static const char *_extensions[];
GobEngine *_vm;
// _videoSlots[0] is reserved for the "primary" video
Video _videoSlots[kVideoSlotCount];
bool _needBlit;
bool _noCursorSwitch;
bool _woodruffCohCottWorkaround;
const Video *getVideoBySlot(int slot) const;
Video *getVideoBySlot(int slot);
int getNextFreeSlot();
Common::String findFile(const Common::String &file, Properties &properties);
Graphics::CoktelDecoder *openVideo(const Common::String &file, Properties &properties);
bool playFrame(int slot, Properties &properties);
void checkAbort(Video &video, Properties &properties);
void evalBgShading(Video &video);
void copyPalette(const Video &video, int16 palStart, int16 palEnd);
};
} // End of namespace Gob
#endif // GOB_VIDEOPLAYER_H
|