Initial commit

engines/titanic/support/avi_surface.h

@@ -0,0 +1,273 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef TITANIC_AVI_SURFACE_H
+#define TITANIC_AVI_SURFACE_H
+
+#include "common/stream.h"
+#include "video/avi_decoder.h"
+#include "graphics/managed_surface.h"
+#include "titanic/core/resource_key.h"
+#include "titanic/support/movie_range_info.h"
+
+namespace Titanic {
+
+class CSoundManager;
+class CVideoSurface;
+
+enum MovieFlag {
+	MOVIE_REPEAT = 1,				// Repeat movie
+	MOVIE_STOP_PREVIOUS = 2,		// Stop any prior movie playing on the object
+	MOVIE_NOTIFY_OBJECT = 4,		// Notify the object when the movie finishes
+	MOVIE_REVERSE = 8,				// Play the movie in reverse
+	MOVIE_WAIT_FOR_FINISH = 0x10	// Let finish before playing next movie for object
+};
+
+/**
+ * This implements a special read stream for the y222.avi video
+ * that fixes that totalFrames field of the header from it's
+ * incorrect value of 1 to a correct 1085.
+ */
+class y222 : virtual public Common::SeekableReadStream {
+private:
+	File *_innerStream;
+public:
+	y222();
+	~y222() override;
+
+	uint32 read(void *dataPtr, uint32 dataSize) override;
+	bool eos() const override { return _innerStream->eos(); }
+	int64 pos() const override { return _innerStream->pos(); }
+	int64 size() const override { return _innerStream->size(); }
+	bool seek(int64 offset, int whence = SEEK_SET) override {
+		return _innerStream->seek(offset, whence);
+	}
+	bool skip(uint32 offset) override {
+		return _innerStream->skip(offset);
+	}
+	char *readLine(char *s, size_t bufSize, bool handleCR = true) override {
+		return _innerStream->readLine(s, bufSize, handleCR);
+	}
+	Common::String readLine(bool handleCR = true) override {
+		return _innerStream->readLine(handleCR);
+	}
+};
+
+
+class AVIDecoder : public Video::AVIDecoder {
+public:
+	AVIDecoder() {}
+	AVIDecoder(const Common::Rational &frameRateOverride) :
+		Video::AVIDecoder(frameRateOverride) {}
+
+	/**
+	 * Returns the number of video tracks the decoder has
+	 */
+	uint videoTrackCount() const { return _videoTracks.size(); }
+
+	/**
+	 * Returns the specified video track
+	 */
+	Video::AVIDecoder::AVIVideoTrack &getVideoTrack(uint idx);
+
+	/**
+	 * Returns the transparency video track, if present
+	 */
+	AVIVideoTrack *getTransparencyTrack() {
+		return static_cast<AVIVideoTrack *>(_transparencyTrack.track);
+	}
+};
+
+class AVISurface {
+private:
+	AVIDecoder *_decoder;
+	CVideoSurface *_videoSurface;
+	CMovieRangeInfoList _movieRangeInfo;
+	int _streamCount;
+	Graphics::ManagedSurface *_movieFrameSurface[2];
+	bool _framePixels;
+	double _frameRate;
+	int _currentFrame, _priorFrame;
+	uint32 _priorFrameTime;
+	Common::String _movieName;
+private:
+	/**
+	 * Render a frame to the video surface
+	 */
+	bool renderFrame();
+
+	/**
+	 * Sets up for video decompression
+	 */
+	void setupDecompressor();
+
+	/**
+	 * Copys a movie frame into a local 16-bit frame surface
+	 * @param src	Source raw movie frame
+	 * @param dest	Destination 16-bit copy of the frame
+	 * @remarks		The important thing this methods different from a straight
+	 * copy is that any pixels marked as fully transparent are replaced with
+	 * the special transparent color value.
+	 */
+	void copyMovieFrame(const Graphics::Surface &src, Graphics::ManagedSurface &dest);
+protected:
+	/**
+	 * Start playback at the specified frame
+	 */
+	bool startAtFrame(int frameNumber);
+
+	/**
+	 * Seeks to a given frame number in the video
+	 */
+	virtual void seekToFrame(uint frameNumber);
+public:
+	CSoundManager *_soundManager;
+	bool _hasAudio;
+public:
+	AVISurface(const CResourceKey &key);
+	virtual ~AVISurface();
+
+	/**
+	 * Start playing the loaded AVI video
+	 */
+	virtual bool play(uint flags, CGameObject *obj);
+
+	/**
+	 * Start playing the loaded AVI video
+	 */
+	virtual bool play(int startFrame, int endFrame, uint flags, CGameObject *obj);
+
+	/**
+	 * Start playing the loaded AVI video
+	 */
+	virtual bool play(int startFrame, int endFrame, int initialFrame, uint flags, CGameObject *obj);
+
+	/**
+	 * Stop the currently playing video
+	 */
+	virtual void stop();
+
+	/**
+	 * Pauses video playback
+	 */
+	virtual void pause();
+
+	/**
+	 * Resumes the video if it's paused
+	 */
+	virtual void resume();
+
+	/**
+	 * Return true if a video is currently playing
+	 */
+	virtual bool isPlaying() const {
+		return _decoder->isPlaying();
+	}
+
+	/**
+	 * Sets whether the video is playing (versus paused)
+	 */
+	virtual void setPlaying(bool playingFlag) {
+		_decoder->pauseVideo(!playingFlag);
+	}
+
+	/**
+	 * Handle any movie events relevant for the frame
+	 */
+	virtual bool handleEvents(CMovieEventList &events);
+
+	/**
+	 * Set the video surface the AVI Surface will render on
+	 */
+	void setVideoSurface(CVideoSurface *surface);
+
+	/**
+	 * Get the width of the video
+	 */
+	uint getWidth() const;
+
+	/**
+	 * Get the height of the video
+	 */
+	uint getHeight() const;
+
+	/**
+	 * Set the current frame
+	 */
+	void setFrame(int frameNumber);
+
+	/**
+	 * Gets the current frame
+	 */
+	int getFrame() const { return _priorFrame; }
+
+	/**
+	 * Add a movie event
+	 */
+	bool addEvent(int *frameNumber, CGameObject *obj);
+
+	/**
+	 * Set the frame rate
+	 */
+	void setFrameRate(double rate);
+
+	/**
+	 * Returns the surface for the secondary video track frame, if present
+	 */
+	Graphics::ManagedSurface *getSecondarySurface();
+
+	/**
+	 * Get a reference to the movie range info list
+	 */
+	const CMovieRangeInfoList *getMovieRangeInfo() const {
+		return &_movieRangeInfo;
+	}
+
+	/**
+	 * Duplicates the transparency mask for the frame, if the movie includes it
+	 */
+	Graphics::ManagedSurface *duplicateTransparency() const;
+
+	/**
+	 * Returns true if it's time for the next
+	 */
+	bool isNextFrame();
+
+	/**
+	 * Plays an interruptable cutscene
+	 * @returns		True if the cutscene was not interrupted
+	 */
+	bool playCutscene(const Rect &r, uint startFrame, uint endFrame);
+
+	/**
+	 * Returns the pixel depth of the movie in bits
+	 */
+	uint getBitDepth() const;
+
+	/**
+	 * Returns true if the movie is to play backwards
+	 */
+	bool isReversed() const { return _frameRate < 0.0; }
+};
+
+} // End of namespace Titanic
+
+#endif /* TITANIC_AVI_SURFACE_H */