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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
|
/* 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 SCI_GRAPHICS_VIDEO32_H
#define SCI_GRAPHICS_VIDEO32_H
#include "common/rect.h" // for Rect
#include "common/scummsys.h" // for int16, uint8, uint16, int32
#include "common/str.h" // for String
#include "sci/engine/vm_types.h" // for reg_t
#include "sci/video/robot_decoder.h" // for RobotDecoder
#include "sci/sound/audio32.h" // for Audio32::kMaxVolume
#include "video/avi_decoder.h" // for AVIDecoder::setVolume
namespace Video {
class AdvancedVMDDecoder;
}
namespace Sci {
class EventManager;
class Plane;
class ScreenItem;
class SegManager;
class SEQDecoder;
struct Palette;
#pragma mark SEQPlayer
/**
* SEQPlayer is used to play SEQ animations.
* Used by DOS versions of GK1 and QFG4CD.
*/
class SEQPlayer {
public:
SEQPlayer(SegManager *segMan);
/**
* Plays a SEQ animation with the given
* file name, with each frame being displayed
* for `numTicks` ticks.
*/
void play(const Common::String &fileName, const int16 numTicks, const int16 x, const int16 y);
private:
SegManager *_segMan;
SEQDecoder *_decoder;
/**
* The plane where the SEQ will be drawn.
*/
Plane *_plane;
/**
* The screen item representing the SEQ surface.
*/
ScreenItem *_screenItem;
/**
* Renders a single frame of video.
*/
void renderFrame(SciBitmap &bitmap) const;
};
#pragma mark -
#pragma mark AVIPlayer
/**
* AVIPlayer is used to play AVI videos. Used by
* Windows versions of GK1CD, KQ7, and QFG4CD.
*/
class AVIPlayer {
public:
enum IOStatus {
kIOSuccess = 0,
kIOFileNotFound = 2,
kIOSeekFailed = 12
};
enum AVIStatus {
kAVINotOpen = 0,
kAVIOpen = 1,
kAVIPlaying = 2,
kAVIPaused = 3
};
enum EventFlags {
kEventFlagNone = 0,
kEventFlagEnd = 1,
kEventFlagEscapeKey = 2,
kEventFlagMouseDown = 4,
kEventFlagHotRectangle = 8
};
AVIPlayer(SegManager *segMan, EventManager *eventMan);
~AVIPlayer();
/**
* Opens a stream to an AVI resource.
*/
IOStatus open(const Common::String &fileName);
/**
* Initializes the AVI rendering parameters for the
* current AVI. This must be called after `open`.
*/
IOStatus init1x(const int16 x, const int16 y, const int16 width, const int16 height);
/**
* Initializes the AVI rendering parameters for the
* current AVI, in pixel-doubling mode. This must
* be called after `open`.
*/
IOStatus init2x(const int16 x, const int16 y);
/**
* Begins playback of the current AVI.
*/
IOStatus play(const int16 from, const int16 to, const int16 showStyle, const bool cue);
/**
* Stops playback and closes the currently open AVI stream.
*/
IOStatus close();
/**
* Seeks the currently open AVI stream to the given frame.
*/
IOStatus cue(const uint16 frameNo);
/**
* Returns the duration of the current video.
*/
uint16 getDuration() const;
/**
* Plays the AVI until an event occurs (e.g. user
* presses escape, clicks, etc.).
*/
EventFlags playUntilEvent(const EventFlags flags);
private:
typedef Common::HashMap<uint16, AVIStatus> StatusMap;
SegManager *_segMan;
EventManager *_eventMan;
Video::AVIDecoder *_decoder;
/**
* Playback status of the player.
*/
AVIStatus _status;
/**
* The plane where the AVI will be drawn.
*/
Plane *_plane;
/**
* The screen item representing the AVI surface,
* in 8bpp mode. In 24bpp mode, video is drawn
* directly to the screen.
*/
ScreenItem *_screenItem;
/**
* The bitmap used to render video output in
* 8bpp mode.
*/
reg_t _bitmap;
/**
* The rectangle where the video will be drawn,
* in game script coordinates.
*/
Common::Rect _drawRect;
/**
* The scale buffer for pixel-doubled videos
* drawn in 24bpp mode.
*/
void *_scaleBuffer;
/**
* In SCI2.1, whether or not the video should
* be pixel doubled for playback.
*/
bool _pixelDouble;
/**
* Performs common initialisation for both
* scaled and unscaled videos.
*/
void init();
/**
* Renders video without event input until the
* video is complete.
*/
void renderVideo() const;
/**
* Renders a single frame of video.
*/
void renderFrame() const;
};
#pragma mark -
#pragma mark VMDPlayer
/**
* VMDPlayer is used to play VMD videos.
* Used by Phant1, GK2, PQ:SWAT, Shivers, SQ6,
* Torin, and Lighthouse.
*/
class VMDPlayer {
public:
enum OpenFlags {
kOpenFlagNone = 0,
kOpenFlagMute = 1
};
enum IOStatus {
kIOSuccess = 0,
kIOError = 0xFFFF
};
enum PlayFlags {
kPlayFlagNone = 0,
kPlayFlagDoublePixels = 1,
kPlayFlagBlackLines = 4,
kPlayFlagBoost = 0x10,
kPlayFlagLeaveScreenBlack = 0x20,
kPlayFlagLeaveLastFrame = 0x40,
kPlayFlagBlackPalette = 0x80,
kPlayFlagStretchVertical = 0x100
};
enum EventFlags {
kEventFlagNone = 0,
kEventFlagEnd = 1,
kEventFlagEscapeKey = 2,
kEventFlagMouseDown = 4,
kEventFlagHotRectangle = 8,
kEventFlagToFrame = 0x10,
kEventFlagYieldToVM = 0x20,
kEventFlagReverse = 0x80
};
enum VMDStatus {
kVMDNotOpen = 0,
kVMDOpen = 1,
kVMDPlaying = 2,
kVMDPaused = 3,
kVMDStopped = 4,
kVMDFinished = 5
};
VMDPlayer(SegManager *segMan, EventManager *eventMan);
~VMDPlayer();
private:
SegManager *_segMan;
EventManager *_eventMan;
Video::AdvancedVMDDecoder *_decoder;
#pragma mark -
#pragma mark VMDPlayer - Playback
public:
/**
* Opens a stream to a VMD resource.
*/
IOStatus open(const Common::String &fileName, const OpenFlags flags);
/**
* Initializes the VMD rendering parameters for the
* current VMD. This must be called after `open`.
*/
void init(const int16 x, const int16 y, const PlayFlags flags, const int16 boostPercent, const int16 boostStartColor, const int16 boostEndColor);
/**
* Stops playback and closes the currently open VMD stream.
*/
IOStatus close();
/**
* Gets the playback status of the VMD player.
*/
VMDStatus getStatus() const;
// NOTE: Was WaitForEvent in SSCI
EventFlags kernelPlayUntilEvent(const EventFlags flags, const int16 lastFrameNo, const int16 yieldInterval);
private:
/**
* Whether or not a VMD stream has been opened with
* `open`.
*/
bool _isOpen;
/**
* Whether or not a VMD player has been initialised
* with `init`.
*/
bool _isInitialized;
/**
* The Resource object for VMDs that are read out
* of a resource bundle instead of being streamed
* from the filesystem.
*/
Resource *_bundledVmd;
/**
* For VMDs played with the `kEventFlagToFrame` flag,
* the target frame for yielding back to the SCI VM.
*/
int32 _yieldFrame;
/**
* For VMDs played with the `kEventFlagYieldToVM` flag,
* the number of frames that should be rendered until
* yielding back to the SCI VM.
*/
int32 _yieldInterval;
/**
* For VMDs played with the `kEventFlagYieldToVM` flag,
* the last frame when control of the main thread was
* yielded back to the SCI VM.
*/
int _lastYieldedFrameNo;
/**
* Plays the VMD until an event occurs (e.g. user
* presses escape, clicks, etc.).
*/
EventFlags playUntilEvent(const EventFlags flags);
#pragma mark -
#pragma mark VMDPlayer - Rendering
public:
/**
* Causes the VMD player to ignore all palettes in
* the currently playing video.
*/
void ignorePalettes() { _ignorePalettes = true; }
/**
* Sets the plane and plane priority used to render video.
*/
void setPlane(const int16 priority, const reg_t planeId);
private:
/**
* The location of the VMD plane, in game script
* coordinates.
*/
int16 _x, _y;
/**
* The plane where the VMD will be drawn.
*/
Plane *_plane;
/**
* The screen item representing the VMD surface.
*/
ScreenItem *_screenItem;
/**
* The bitmap used to render the VMD.
*/
reg_t _bitmapId;
// TODO: planeIsOwned and priority are used in SCI3+ only
/**
* If true, the plane for this VMD was set
* externally and is not owned by this VMDPlayer.
*/
bool _planeIsOwned;
/**
* The screen priority of the video.
* @see ScreenItem::_priority
*/
int _priority;
/**
* Whether or not the video should be pixel doubled.
*/
bool _doublePixels;
/**
* Whether or not the video should be pixel doubled
* vertically only.
*/
bool _stretchVertical;
/**
* Whether or not black lines should be rendered
* across the video.
*/
bool _blackLines;
/**
* Whether or not the playback area of the VMD
* should be left black at the end of playback.
*/
bool _leaveScreenBlack;
/**
* Whether or not the area of the VMD should be left
* displaying the final frame of the video.
*/
bool _leaveLastFrame;
/**
* Whether or not palettes from the VMD should be ignored.
*/
bool _ignorePalettes;
/**
* Renders a frame of video to the output bitmap.
*/
void renderFrame() const;
/**
* Fills the given palette with RGB values from
* the VMD palette, applying brightness boost if
* it is enabled.
*/
void fillPalette(Palette &palette) const;
#pragma mark -
#pragma mark VMDPlayer - Blackout
public:
/**
* Sets the area of the screen that should be blacked out
* during VMD playback.
*/
void setBlackoutArea(const Common::Rect &rect) { _blackoutRect = rect; }
private:
/**
* The dimensions of the blackout plane.
*/
Common::Rect _blackoutRect;
/**
* An optional plane that will be used to black out
* areas of the screen outside of the VMD surface.
*/
Plane *_blackoutPlane;
#pragma mark -
#pragma mark VMDPlayer - Palette
public:
/**
* Restricts use of the system palette by VMD playback to
* the given range of palette indexes.
*/
void restrictPalette(const uint8 startColor, const int16 endColor);
private:
/**
* The first color in the system palette that the VMD
* can write to.
*/
uint8 _startColor;
/**
* The last color in the system palette that the VMD
* can write to.
*/
uint8 _endColor;
/**
* If true, video frames are rendered after a blank
* palette is submitted to the palette manager,
* which is then restored after the video pixels
* have already been rendered.
*/
bool _blackPalette;
#pragma mark -
#pragma mark VMDPlayer - Brightness boost
private:
/**
* The amount of brightness boost for the video.
* Values above 100 increase brightness; values below
* 100 reduce it.
*/
int16 _boostPercent;
/**
* The first color in the palette that should be
* brightness boosted.
*/
uint8 _boostStartColor;
/**
* The last color in the palette that should be
* brightness boosted.
*/
uint8 _boostEndColor;
#pragma mark -
#pragma mark VMDPlayer - Mouse cursor
public:
/**
* Sets whether or not the mouse cursor should be drawn.
* This does not have any effect during playback, but can
* be used to prevent the mouse cursor from being shown
* again after the video has finished.
*/
void setShowCursor(const bool shouldShow) { _showCursor = shouldShow; }
private:
/**
* Whether or not the mouse cursor should be shown
* during playback.
*/
bool _showCursor;
};
#pragma mark -
#pragma mark DuckPlayer
class DuckPlayer {
public:
enum DuckStatus {
kDuckClosed = 0,
kDuckOpen = 1,
kDuckPlaying = 2,
kDuckPaused = 3
};
DuckPlayer(SegManager *segMan, EventManager *eventMan);
~DuckPlayer();
/**
* Opens a stream to a Duck resource.
*/
void open(const GuiResourceId resourceId, const int displayMode, const int16 x, const int16 y);
/**
* Stops playback and closes the currently open Duck stream.
*/
void close();
/**
* Begins playback of the current Duck video.
*/
void play(const int lastFrameNo);
/**
* Sets a flag indicating that an opaque plane should be added
* to the graphics manager underneath the video surface during
* playback.
*/
void setDoFrameOut(const bool value) { _doFrameOut = value; }
/**
* Sets the volume of the decoder.
*/
void setVolume(const uint8 value) {
_volume = (uint)value * Audio::Mixer::kMaxChannelVolume / Audio32::kMaxVolume;
_decoder->setVolume(_volume);
}
private:
SegManager *_segMan;
EventManager *_eventMan;
Video::AVIDecoder *_decoder;
/**
* An empty plane drawn behind the video when the doFrameOut
* flag is true.
*/
Plane *_plane;
/**
* The player status.
*/
DuckStatus _status;
/**
* The screen rect where the video should be drawn.
*/
Common::Rect _drawRect;
/**
* The playback volume for the player.
*/
uint8 _volume;
/**
* If true, frameOut will be called during Duck video playback to update
* other parts of the screen.
*/
bool _doFrameOut;
/**
* If true, the video will be pixel doubled during playback.
*/
bool _pixelDouble;
/**
* The buffer used to perform scaling of the video.
*/
byte *_scaleBuffer;
/**
* Renders the current frame to the system video buffer.
*/
void renderFrame() const;
};
#pragma mark -
#pragma mark Video32
/**
* Video32 provides facilities for playing back
* video in SCI engine.
*/
class Video32 {
public:
Video32(SegManager *segMan, EventManager *eventMan) :
_SEQPlayer(segMan),
_AVIPlayer(segMan, eventMan),
_VMDPlayer(segMan, eventMan),
_robotPlayer(segMan),
_duckPlayer(segMan, eventMan) {}
SEQPlayer &getSEQPlayer() { return _SEQPlayer; }
AVIPlayer &getAVIPlayer() { return _AVIPlayer; }
VMDPlayer &getVMDPlayer() { return _VMDPlayer; }
RobotDecoder &getRobotPlayer() { return _robotPlayer; }
DuckPlayer &getDuckPlayer() { return _duckPlayer; }
private:
SEQPlayer _SEQPlayer;
AVIPlayer _AVIPlayer;
VMDPlayer _VMDPlayer;
RobotDecoder _robotPlayer;
DuckPlayer _duckPlayer;
};
} // End of namespace Sci
#endif
|