VIDEO: Change getElapsedTime() into getTime()

This name change accompanies a slight meaning change; now it means the current time position from the beginning of the video and not from starting the video.

12 files changed, 28 insertions, 23 deletions

diff --git a/video/avi_decoder.cpp b/video/avi_decoder.cpp
index 9685952304..28fa712d4f 100644
--- a/video/avi_decoder.cpp
+++ b/video/avi_decoder.cpp
@@ -305,11 +305,11 @@ void AviDecoder::close() {
 	reset();
 }
 
-uint32 AviDecoder::getElapsedTime() const {
+uint32 AviDecoder::getTime() const {
 	if (_audStream)
 		return _mixer->getSoundElapsedTime(*_audHandle);
 
-	return FixedRateVideoDecoder::getElapsedTime();
+	return FixedRateVideoDecoder::getTime();
 }
 
 const Graphics::Surface *AviDecoder::decodeNextFrame() {
diff --git a/video/avi_decoder.h b/video/avi_decoder.h
index 508760ec89..edd08c42a0 100644
--- a/video/avi_decoder.h
+++ b/video/avi_decoder.h
@@ -195,7 +195,7 @@ public:
 	uint16 getWidth() const { return _header.width; }
 	uint16 getHeight() const { return _header.height; }
 	uint32 getFrameCount() const { return _header.totalFrames; }
-	uint32 getElapsedTime() const;
+	uint32 getTime() const;
 	const Graphics::Surface *decodeNextFrame();
 	Graphics::PixelFormat getPixelFormat() const;
 	const byte *getPalette() { _dirtyPalette = false; return _palette; }
diff --git a/video/bink_decoder.cpp b/video/bink_decoder.cpp
index 884ca69f17..4738c3c8c0 100644
--- a/video/bink_decoder.cpp
+++ b/video/bink_decoder.cpp
@@ -181,7 +181,7 @@ void BinkDecoder::close() {
 	_frames.clear();
 }
 
-uint32 BinkDecoder::getElapsedTime() const {
+uint32 BinkDecoder::getTime() const {
 	if (_audioStream && g_system->getMixer()->isSoundHandleActive(_audioHandle))
 		return g_system->getMixer()->getSoundElapsedTime(_audioHandle) + _audioStartOffset;
 
diff --git a/video/bink_decoder.h b/video/bink_decoder.h
index 3d5e882dd7..f1eadc6f17 100644
--- a/video/bink_decoder.h
+++ b/video/bink_decoder.h
@@ -70,7 +70,7 @@ public:
 	uint16 getHeight() const { return _surface.h; }
 	Graphics::PixelFormat getPixelFormat() const { return _surface.format; }
 	uint32 getFrameCount() const { return _frames.size(); }
-	uint32 getElapsedTime() const;
+	uint32 getTime() const;
 	const Graphics::Surface *decodeNextFrame();
 
 	// FixedRateVideoDecoder
diff --git a/video/psx_decoder.cpp b/video/psx_decoder.cpp
index 7c04b7f041..74f740f614 100644
--- a/video/psx_decoder.cpp
+++ b/video/psx_decoder.cpp
@@ -236,13 +236,13 @@ void PSXStreamDecoder::close() {
 	reset();
 }
 
-uint32 PSXStreamDecoder::getElapsedTime() const {
+uint32 PSXStreamDecoder::getTime() const {
 	// TODO: Currently, the audio is always after the video so using this
 	// can often lead to gaps in the audio...
 	//if (_audStream)
 	//	return _mixer->getSoundElapsedTime(_audHandle);
 
-	return VideoDecoder::getElapsedTime();
+	return VideoDecoder::getTime();
 }
 
 uint32 PSXStreamDecoder::getTimeToNextFrame() const {
@@ -250,7 +250,7 @@ uint32 PSXStreamDecoder::getTimeToNextFrame() const {
 		return 0;
 
 	uint32 nextTimeMillis = _nextFrameStartTime.msecs();
-	uint32 elapsedTime = getElapsedTime();
+	uint32 elapsedTime = getTime();
 
 	if (elapsedTime > nextTimeMillis)
 		return 0;
diff --git a/video/psx_decoder.h b/video/psx_decoder.h
index c8ad92c45a..3695cb0f42 100644
--- a/video/psx_decoder.h
+++ b/video/psx_decoder.h
@@ -75,7 +75,7 @@ public:
 	uint16 getWidth() const { return _surface->w; }
 	uint16 getHeight() const { return _surface->h; }
 	uint32 getFrameCount() const { return _frameCount; }
-	uint32 getElapsedTime() const;
+	uint32 getTime() const;
 	uint32 getTimeToNextFrame() const;
 	const Graphics::Surface *decodeNextFrame();
 	Graphics::PixelFormat getPixelFormat() const { return _surface->format; }
diff --git a/video/qt_decoder.cpp b/video/qt_decoder.cpp
index 0d80c93a1f..5c841b30fb 100644
--- a/video/qt_decoder.cpp
+++ b/video/qt_decoder.cpp
@@ -185,7 +185,7 @@ bool QuickTimeDecoder::endOfVideo() const {
 	return true;
 }
 
-uint32 QuickTimeDecoder::getElapsedTime() const {
+uint32 QuickTimeDecoder::getTime() const {
 	// Try to base sync off an active audio track
 	for (uint32 i = 0; i < _audioHandles.size(); i++) {
 		if (g_system->getMixer()->isSoundHandleActive(_audioHandles[i])) {
@@ -196,7 +196,7 @@ uint32 QuickTimeDecoder::getElapsedTime() const {
 	}
 
 	// Just use time elapsed since the beginning
-	return SeekableVideoDecoder::getElapsedTime();
+	return SeekableVideoDecoder::getTime();
 }
 
 uint32 QuickTimeDecoder::getTimeToNextFrame() const {
@@ -211,7 +211,7 @@ uint32 QuickTimeDecoder::getTimeToNextFrame() const {
 
 		// TODO: Add support for rate modification
 
-		uint32 elapsedTime = getElapsedTime();
+		uint32 elapsedTime = getTime();
 
 		if (elapsedTime < nextFrameStartTime)
 			return nextFrameStartTime - elapsedTime;
diff --git a/video/qt_decoder.h b/video/qt_decoder.h
index 583b4b44b5..7f2d32e515 100644
--- a/video/qt_decoder.h
+++ b/video/qt_decoder.h
@@ -106,7 +106,7 @@ public:
 	bool isVideoLoaded() const { return isOpen(); }
 	const Graphics::Surface *decodeNextFrame();
 	bool endOfVideo() const;
-	uint32 getElapsedTime() const;
+	uint32 getTime() const;
 	uint32 getTimeToNextFrame() const;
 	Graphics::PixelFormat getPixelFormat() const;
 
diff --git a/video/smk_decoder.cpp b/video/smk_decoder.cpp
index 084028300d..439fe9027d 100644
--- a/video/smk_decoder.cpp
+++ b/video/smk_decoder.cpp
@@ -289,11 +289,11 @@ SmackerDecoder::~SmackerDecoder() {
 	close();
 }
 
-uint32 SmackerDecoder::getElapsedTime() const {
+uint32 SmackerDecoder::getTime() const {
 	if (_audioStream && _audioStarted)
 		return _mixer->getSoundElapsedTime(_audioHandle);
 
-	return FixedRateVideoDecoder::getElapsedTime();
+	return FixedRateVideoDecoder::getTime();
 }
 
 bool SmackerDecoder::loadStream(Common::SeekableReadStream *stream) {
diff --git a/video/smk_decoder.h b/video/smk_decoder.h
index 72cd32a222..fd5d658bdd 100644
--- a/video/smk_decoder.h
+++ b/video/smk_decoder.h
@@ -69,7 +69,7 @@ public:
 	uint16 getWidth() const { return _surface->w; }
 	uint16 getHeight() const { return _surface->h; }
 	uint32 getFrameCount() const { return _frameCount; }
-	uint32 getElapsedTime() const;
+	uint32 getTime() const;
 	const Graphics::Surface *decodeNextFrame();
 	Graphics::PixelFormat getPixelFormat() const { return Graphics::PixelFormat::createFormatCLUT8(); }
 	const byte *getPalette() { _dirtyPalette = false; return _palette; }
diff --git a/video/video_decoder.cpp b/video/video_decoder.cpp
index e1122132a8..ae82a3374c 100644
--- a/video/video_decoder.cpp
+++ b/video/video_decoder.cpp
@@ -45,7 +45,7 @@ bool VideoDecoder::loadFile(const Common::String &filename) {
 	return loadStream(file);
 }
 
-uint32 VideoDecoder::getElapsedTime() const {
+uint32 VideoDecoder::getTime() const {
 	return g_system->getMillis() - _startTime;
 }
 
@@ -98,7 +98,7 @@ uint32 FixedRateVideoDecoder::getTimeToNextFrame() const {
 	if (endOfVideo() || _curFrame < 0)
 		return 0;
 
-	uint32 elapsedTime = getElapsedTime();
+	uint32 elapsedTime = getTime();
 	uint32 nextFrameStartTime = getFrameBeginTime(_curFrame + 1);
 
 	// If the time that the next frame should be shown has past
diff --git a/video/video_decoder.h b/video/video_decoder.h
index 91c1ae2f11..73134307a4 100644
--- a/video/video_decoder.h
+++ b/video/video_decoder.h
@@ -125,15 +125,20 @@ public:
 	virtual uint32 getFrameCount() const = 0;
 
 	/**
-	 * Returns the time (in ms) that the video has been running.
-	 * This is based on the "wall clock" time as determined by
-	 * OSystem::getMillis, and takes pausing the video into account.
+	 * Returns the time position (in ms) of the current video.
+	 * This can be based on the "wall clock" time as determined by
+	 * OSystem::getMillis() or the current time of any audio track
+	 * running in the video, and takes pausing the video into account.
 	 *
-	 * As such, it can differ from what multiplying getCurFrame() by
+	 * As such, it will differ from what multiplying getCurFrame() by
 	 * some constant would yield, e.g. for a video with non-constant
 	 * frame rate.
+	 *
+	 * Due to the nature of the timing, this value may not always be
+	 * completely accurate (since our mixer does not have precise
+	 * timing).
 	 */
-	virtual uint32 getElapsedTime() const;
+	virtual uint32 getTime() const;
 
 	/**
 	 * Return the time (in ms) until the next frame should be displayed.