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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
|
/* 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 DIRECTOR_SCORE_H
#define DIRECTOR_SCORE_H
#include "common/rect.h"
#include "common/stream.h"
#include "common/array.h"
#include "director/resource.h"
#include "graphics/managed_surface.h"
#include "common/str.h"
#include "image/image_decoder.h"
#include "graphics/font.h"
namespace Director {
class Lingo;
class DirectorSound;
class Score;
class DirectorEngine;
#define CHANNEL_COUNT 24
enum CastType {
kCastBitmap = 1,
kCastFilmLoop,
kCastText,
kCastPalette,
kCastPicture,
kCastSound,
kCastButton,
kCastShape,
kCastMovie,
kCastDigitalVideo,
kCastScript
};
//Director v4
enum SpriteType {
kInactiveSprite, //turns the sprite off
kBitmapSprite,
kRectangleSprite,
kRoundedRectangleSprite,
kOvalSprite,
kLineTopBottomSprite, //line from top left to bottom right
kLineBottomTopSprite, //line from bottom left to top right
kTextSprite,
kButtonSprite,
kCheckboxSprite,
kRadioButtonSprite,
kUndeterminedSprite = 16 //use castType property to examine the type of cast member associated with sprite
};
enum SpritePosition {
kSpritePositionUnk1 = 0,
kSpritePositionEnabled,
kSpritePositionUnk2,
kSpritePositionFlags = 4,
kSpritePositionCastId = 6,
kSpritePositionY = 8,
kSpritePositionX = 10,
kSpritePositionHeight = 12,
kSpritePositionWidth = 14
};
enum MainChannelsPosition {
kScriptIdPosition = 0,
kSoundType1Position,
kTransFlagsPosition,
kTransChunkSizePosition,
kTempoPosition,
kTransTypePosition,
kSound1Position,
kSkipFrameFlagsPosition = 8,
kBlendPosition,
kSound2Position,
kSound2TypePosition = 11,
kPaletePosition = 15
};
enum InkType {
kInkTypeCopy,
kInkTypeTransparent,
kInkTypeReverse,
kInkTypeGhost,
kInkTypeNotCopy,
kInkTypeNotTrans,
kInkTypeNotReverse,
kInkTypeNotGhost,
kInkTypeMatte,
kInkTypeMask,
//10-31 Not used (Lingo in a Nutshell)
kInkTypeBlend = 32,
kInkTypeAddPin,
kInkTypeAdd,
kInkTypeSubPin,
kInkTypeBackgndTrans,
kInkTypeLight,
kInkTypeSub,
kInkTypeDark
};
enum ScriptType {
kMovieScript = 0,
kSpriteScript = 1,
kFrameScript = 2,
kMaxScriptType = 2
};
enum TransitionType {
kTransNone,
kTransWipeRight,
kTransWipeLeft,
kTransWipeDown,
kTransWipeUp,
kTransCenterOutHorizontal,
kTransEdgesInHorizontal,
kTransCenterOutVertical,
kTransEdgesInVertical,
kTransCenterOutSquare,
kTransEdgesInSquare,
kTransPushLeft,
kTransPushRight,
kTransPushDown,
kTransPushUp,
kTransRevealUp,
kTransRevealUpRight,
kTransRevealRight,
kTransRevealDown,
kTransRevealDownRight,
kTransRevealDownLeft,
kTransRevealLeft,
kTransRevealUpLeft,
kTransDissolvePixelsFast,
kTransDissolveBoxyRects,
kTransDissolveBoxySquares,
kTransDissolvePatterns,
kTransRandomRows,
kTransRandomColumns,
kTransCoverDown,
kTransCoverDownLeft,
kTransCoverDownRight,
kTransCoverLeft,
kTransCoverRight,
kTransCoverUp,
kTransCoverUpLeft,
kTransCoverUpRight,
kTransTypeVenitianBlind,
kTransTypeCheckerboard,
kTransTypeStripsBottomBuildLeft,
kTransTypeStripsBottomBuildRight,
kTransTypeStripsLeftBuildDown,
kTransTypeStripsLeftBuildUp,
kTransTypeStripsRightBuildDown,
kTransTypeStripsRightBuildUp,
kTransTypeStripsTopBuildLeft,
kTransTypeStripsTopBuildRight,
kTransZoomOpen,
kTransZoomClose,
kTransVerticalBinds,
kTransDissolveBitsTrans,
kTransDissolvePixels,
kTransDissolveBits
};
struct Cast {
CastType type;
Common::Rect initialRect;
byte modified;
};
struct BitmapCast : Cast {
BitmapCast(Common::SeekableSubReadStreamEndian &stream);
Common::Rect boundingRect;
uint16 regX;
uint16 regY;
uint8 flags;
};
enum ShapeType {
kShapeRectangle,
kShapeRoundRect,
kShapeOval,
kShapeLine
};
struct ShapeCast : Cast {
ShapeCast(Common::SeekableSubReadStreamEndian &stream);
ShapeType shapeType;
uint16 pattern;
byte fgCol;
byte bgCol;
byte fillType;
byte lineThickness;
byte lineDirection;
};
enum TextType {
kTextTypeAdjustToFit,
kTextTypeScrolling,
kTextTypeFixed
};
enum TextAlignType {
kTextAlignRight = -1,
kTextAlignLeft,
kTextAlignCenter
};
enum TextFlag {
kTextFlagEditable,
kTextFlagAutoTab,
kTextFlagDoNotWrap
};
enum SizeType {
kSizeNone,
kSizeSmallest,
kSizeSmall,
kSizeMedium,
kSizeLarge,
kSizeLargest
};
struct TextCast : Cast {
TextCast(Common::SeekableSubReadStreamEndian &stream);
SizeType borderSize;
SizeType gutterSize;
SizeType boxShadow;
uint32 fontId;
uint16 fontSize;
TextType textType;
TextAlignType textAlign;
SizeType textShadow;
Common::Array<TextFlag> textFlags;
};
enum ButtonType {
kTypeButton,
kTypeCheckBox,
kTypeRadio
};
struct ButtonCast : TextCast {
ButtonCast(Common::SeekableSubReadStreamEndian &stream) : TextCast(stream) {
buttonType = static_cast<ButtonType>(stream.readUint16BE());
}
ButtonType buttonType;
};
struct CastInfo {
Common::String script;
Common::String name;
Common::String directory;
Common::String fileName;
Common::String type;
};
struct PaletteInfo {
uint8 firstColor;
uint8 lastColor;
uint8 flags;
uint8 speed;
uint16 frameCount;
};
class Sprite {
public:
Sprite();
Sprite(const Sprite &sprite);
~Sprite();
bool _enabled;
byte _castId;
InkType _ink;
uint16 _trails;
Cast *_cast;
uint16 _flags;
Common::Point _startPoint;
uint16 _width;
uint16 _height;
//TODO: default constraint = 0, if turned on, sprite is constrainted to the bounding rect
//As i know, constrainted != 0 only if sprite moveable
byte _constraint;
byte _moveable;
byte _backColor;
byte _foreColor;
uint16 _left;
uint16 _right;
uint16 _top;
uint16 _bottom;
byte _blend;
bool _visible;
byte _type;
//Using in digital movie sprites
byte _movieRate;
uint16 _movieTime;
uint16 _startTime;
uint16 _stopTime;
byte _volume;
byte _stretch;
//Using in shape sprites
byte _lineSize;
//Using in text sprites
Common::String _editableText;
};
class Frame {
public:
Frame(DirectorEngine *vm);
Frame(const Frame &frame);
~Frame();
void readChannel(Common::SeekableSubReadStreamEndian &stream, uint16 offset, uint16 size);
void prepareFrame(Score *score);
uint16 getSpriteIDFromPos(Common::Point pos);
private:
void playTransition(Score *score);
void playSoundChannel();
void renderSprites(Graphics::ManagedSurface &surface, bool renderTrail);
void renderText(Graphics::ManagedSurface &surface, uint16 spriteId);
void renderButton(Graphics::ManagedSurface &surface, uint16 spriteId);
void readPaletteInfo(Common::SeekableSubReadStreamEndian &stream);
void readSprite(Common::SeekableSubReadStreamEndian &stream, uint16 offset, uint16 size);
void readMainChannels(Common::SeekableSubReadStreamEndian &stream, uint16 offset, uint16 size);
Image::ImageDecoder *getImageFrom(uint16 spriteID);
void drawBackgndTransSprite(Graphics::ManagedSurface &target, const Graphics::Surface &sprite, Common::Rect &drawRect);
void drawMatteSprite(Graphics::ManagedSurface &target, const Graphics::Surface &sprite, Common::Rect &drawRect);
void drawGhostSprite(Graphics::ManagedSurface &target, const Graphics::Surface &sprite, Common::Rect &drawRect);
void drawReverseSprite(Graphics::ManagedSurface &target, const Graphics::Surface &sprite, Common::Rect &drawRect);
public:
uint8 _actionId;
uint8 _transDuration;
uint8 _transArea; //1 - Whole Stage, 0 - Changing Area
uint8 _transChunkSize;
TransitionType _transType;
PaletteInfo *_palette;
uint8 _tempo;
uint16 _sound1;
uint8 _soundType1;
uint16 _sound2;
uint8 _soundType2;
uint8 _skipFrameFlag;
uint8 _blend;
Common::Array<Sprite *> _sprites;
Common::Array<Common::Rect > _drawRects;
DirectorEngine *_vm;
};
struct Label {
Common::String name;
uint16 number;
Label(Common::String name1, uint16 number1) { name = name1; number = number1; }
};
class Score {
public:
Score(DirectorEngine *vm);
~Score();
static Common::Rect readRect(Common::SeekableSubReadStreamEndian &stream);
static int compareLabels(const void *a, const void *b);
void loadArchive();
void setStartToLabel(Common::String label);
void gotoloop();
void gotonext();
void gotoprevious();
void startLoop();
void processEvents();
Archive *getArchive() const { return _movieArchive; };
void loadCastData(Common::SeekableSubReadStreamEndian &stream);
void setCurrentFrame(uint16 frameId) { _currentFrame = frameId; }
Common::String getMacName() const { return _macName; }
Sprite *getSpriteById(uint16 id);
private:
void update();
void readVersion(uint32 rid);
void loadConfig(Common::SeekableSubReadStreamEndian &stream);
void loadMacFonts();
void loadPalette(Common::SeekableSubReadStreamEndian &stream);
void loadFrames(Common::SeekableSubReadStreamEndian &stream);
void loadLabels(Common::SeekableSubReadStreamEndian &stream);
void loadActions(Common::SeekableSubReadStreamEndian &stream);
void loadCastInfo(Common::SeekableSubReadStreamEndian &stream, uint16 id);
void loadScriptText(Common::SeekableSubReadStreamEndian &stream);
void loadFileInfo(Common::SeekableSubReadStreamEndian &stream);
void loadFontMap(Common::SeekableSubReadStreamEndian &stream);
void dumpScript(const char *script, ScriptType type, uint16 id);
Common::String getString(Common::String str);
Common::Array<Common::String> loadStrings(Common::SeekableSubReadStreamEndian &stream, uint32 &entryType, bool hasHeader = true);
public:
Common::Array<Frame *> _frames;
Common::HashMap<int, Cast *> _casts;
Common::HashMap<uint16, CastInfo *> _castsInfo;
Common::SortedArray<Label *> *_labels;
Common::HashMap<uint16, Common::String> _actions;
Common::HashMap<uint16, Common::String> _fontMap;
Graphics::ManagedSurface *_surface;
Graphics::ManagedSurface *_trailSurface;
Graphics::Font *_font;
Archive *_movieArchive;
Common::Rect _movieRect;
private:
uint16 _versionMinor;
uint16 _versionMajor;
Common::String _macName;
Common::String _createdBy;
Common::String _changedBy;
Common::String _script;
Common::String _directory;
byte _currentFrameRate;
uint16 _castArrayStart;
uint16 _currentFrame;
Common::String _currentLabel;
uint32 _nextFrameTime;
uint32 _flags;
bool _stopPlay;
uint16 _castArrayEnd;
uint16 _movieScriptCount;
uint16 _stageColor;
Lingo *_lingo;
DirectorSound *_soundManager;
DirectorEngine *_vm;
};
} //End of namespace Director
#endif
|