From 85e3a22510fe40d245f5a5e9c9661462c555510c Mon Sep 17 00:00:00 2001
From: Kaloyan Chehlarski <strahy@outlook.com>
Date: Wed, 1 Mar 2023 00:01:07 +0200
Subject: [PATCH] NANCY: Secondary video improvements

Added support for The Vampire Diaries' looping secondary videos.
Added support for disabling the hotspot. Fixed the incorrect start
frame when the mouse stops hovering. Fixed a bug where the
hover animation could stop working after panning the viewport.
---
 engines/nancy/action/secondaryvideo.cpp | 49 ++++++++++++++++---------
 engines/nancy/action/secondaryvideo.h   |  5 +++
 2 files changed, 36 insertions(+), 18 deletions(-)

diff --git a/engines/nancy/action/secondaryvideo.cpp b/engines/nancy/action/secondaryvideo.cpp
index 135fcf9484b..4a1d26bab83 100644
--- a/engines/nancy/action/secondaryvideo.cpp
+++ b/engines/nancy/action/secondaryvideo.cpp
@@ -61,7 +61,7 @@ void PlaySecondaryVideo::updateGraphics() {
 		return;
 	}
 
-	if (_isInFrame) {
+	if (_isInFrame && _decoder.isPlaying() ? _decoder.needsUpdate() || _decoder.atEnd() : true) {
 		int lastAnimationFrame = -1;
 		switch (_hoverState) {
 		case kNoHover:
@@ -82,7 +82,6 @@ void PlaySecondaryVideo::updateGraphics() {
 					_decoder.start();
 				}
 
-				_decoder.seekToFrame(_onHoverEndLastFrame);
 				_decoder.setRate(-_decoder.getRate());
 			} else {
 				lastAnimationFrame = _onHoverLastFrame;
@@ -100,11 +99,15 @@ void PlaySecondaryVideo::updateGraphics() {
 			}
 		}
 
-		if (_decoder.isPlaying() && _decoder.needsUpdate()) {
-			GraphicsManager::copyToManaged(*_decoder.decodeNextFrame(), _fullFrame, _paletteFilename.size() > 0);
-			_needsRedraw = true;
+		if (_decoder.isPlaying()) {
+			if (_decoder.needsUpdate()) {
+				GraphicsManager::copyToManaged(*_decoder.decodeNextFrame(), _fullFrame, _paletteFilename.size() > 0);
+				_needsRedraw = true;
+			}
 
-			if (lastAnimationFrame > -1 && _decoder.getCurFrame() == lastAnimationFrame + (_decoder.getRate().getNumerator() > 0 ? 1 : -1)) {
+			if (lastAnimationFrame > -1 &&
+					(_decoder.atEnd() ||
+					 _decoder.getCurFrame() == lastAnimationFrame + (_decoder.getRate().getNumerator() > 0 ? 1 : -1))) {
 				if (_hoverState == kNoHover) {
 					_decoder.seekToFrame(_loopFirstFrame);
 				} else {
@@ -112,18 +115,21 @@ void PlaySecondaryVideo::updateGraphics() {
 				}
 			}
 		}
+	}
 
-		if (_needsRedraw && _isVisible) {
-			int vpFrame = -1;
-			for (uint i = 0; i < _videoDescs.size(); ++i) {
-				if (_videoDescs[i].frameID == _currentViewportFrame) {
-					vpFrame = i;
-					break;
-				}
+	if (_needsRedraw && _isVisible) {
+		int vpFrame = -1;
+		for (uint i = 0; i < _videoDescs.size(); ++i) {
+			if (_videoDescs[i].frameID == _currentViewportFrame) {
+				vpFrame = i;
+				break;
 			}
+		}
 
-			_drawSurface.create(_fullFrame, _videoDescs[vpFrame].srcRect);
-			moveTo(_videoDescs[vpFrame].destRect);
+		_drawSurface.create(_fullFrame, _videoDescs[vpFrame].srcRect);
+		moveTo(_videoDescs[vpFrame].destRect);
+
+		if (_enableHotspot == kTrue) {
 			_hotspot = _screenPosition;
 			_hotspot.clip(NancySceneState.getViewport().getBounds());
 			_hasHotspot = true;
@@ -152,10 +158,17 @@ void PlaySecondaryVideo::handleInput(NancyInput &input) {
 void PlaySecondaryVideo::readData(Common::SeekableReadStream &stream) {
 	readFilename(stream, _filename);
 	readFilename(stream, _paletteFilename);
-	stream.skip(10);
+	stream.skip(10); // video overlay bitmap filename
 
 	if (_paletteFilename.size()) {
-		stream.skip(14); // unknown data
+		stream.skip(12);
+		// videoSource (HD, CD, cache)
+		// ??
+		// _paletteStart
+		// _paletteSize
+		// hasOverlayBitmap
+		// ignoreHoverAnimation??
+		_enableHotspot = (NancyFlag)stream.readUint16LE();
 	}
 
 	_loopFirstFrame = stream.readUint16LE();
@@ -212,13 +225,13 @@ void PlaySecondaryVideo::execute() {
 				}
 
 				_isInFrame = true;
-				_hoverState = kNoHover;
 				setVisible(true);
 			} else {
 				if (_isVisible) {
 					setVisible(false);
 					_hasHotspot = false;
 					_isInFrame = false;
+					_hoverState = kNoHover;
 					_decoder.stop();
 				}
 			}
diff --git a/engines/nancy/action/secondaryvideo.h b/engines/nancy/action/secondaryvideo.h
index 8cc50d491b5..56b02c01a1b 100644
--- a/engines/nancy/action/secondaryvideo.h
+++ b/engines/nancy/action/secondaryvideo.h
@@ -50,6 +50,11 @@ public:
 
 	Common::String _filename;
 	Common::String _paletteFilename;
+	// Common::String _bitmapOverlayFilename
+
+	// TVD only
+	NancyFlag _enableHotspot = kTrue;
+
 	uint16 _loopFirstFrame = 0; // 0x1E
 	uint16 _loopLastFrame = 0; // 0x20
 	uint16 _onHoverFirstFrame = 0; // 0x22