SWORD25: Importing original sources

svn-id: r53171

1 files changed, 138 insertions, 0 deletions

diff --git a/engines/sword25/fmv/movieplayer.h b/engines/sword25/fmv/movieplayer.h
new file mode 100755
index 0000000000..ed9e94edad
--- /dev/null
+++ b/engines/sword25/fmv/movieplayer.h
@@ -0,0 +1,138 @@
+// -----------------------------------------------------------------------------
+// This file is part of Broken Sword 2.5
+// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdörfer
+//
+// Broken Sword 2.5 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.
+//
+// Broken Sword 2.5 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 Broken Sword 2.5; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+// -----------------------------------------------------------------------------
+
+#ifndef BS_MOVIEPLAYER_H
+#define BS_MOVIEPLAYER_H
+
+// -----------------------------------------------------------------------------
+// Includes
+// -----------------------------------------------------------------------------
+
+#include "kernel/common.h"
+#include "kernel/service.h"
+
+#include "kernel/memlog_off.h"
+#include <string>
+#include "kernel/memlog_on.h"
+
+// -----------------------------------------------------------------------------
+// Klassendefinition
+// -----------------------------------------------------------------------------
+
+class BS_MoviePlayer : public BS_Service
+{
+public:
+	// -----------------------------------------------------------------------------
+	// Konstruktion / Destruktion
+	// -----------------------------------------------------------------------------
+
+	BS_MoviePlayer(BS_Kernel * pKernel);
+	virtual ~BS_MoviePlayer() {};
+
+	// -----------------------------------------------------------------------------
+	// Abstraktes Interface, muss von jedem MoviePlayer implementiert werden
+	// -----------------------------------------------------------------------------
+
+	/**
+		@brief Lädt eine Filmdatei
+
+		Diese Methode lädt eine Filmdatei und bereitet sie zur Wiedergabe vor.
+		Es kann immer nur eine Filmdatei zur Zeit geladen sein. Falls bereits eine Filmdatei geladen
+		ist, wird diese entladen und nötigenfalls die Wiedergabe gestoppt.
+
+		@param Filename der Dateiname der zu ladenden Filmdatei
+		@param Z gibt die Z Position des Films auf dem Graphik-Hauptlayer an
+		@return Gibt false zurück, wenn beim Laden ein Fehler aufgetreten ist, ansonsten true.
+	*/
+	virtual bool LoadMovie(const std::string & Filename, unsigned int Z) = 0;
+
+	/**
+		@brief Entlädt die gerade geladene Filmdatei
+
+		@return Gibt false zurück, wenn beim Entladen ein Fehler aufgetreten ist, ansonsten true.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual bool UnloadMovie() = 0;
+
+	/**
+		@brief Spielt den Film ab.
+
+		Der Film wird unter Beibehaltung der Seitenverhältnisse auf Bildschirmgröße skaliert.<br>
+		Falls der Film mit einem Aufruf von Pause() pausiert wurde, fährt der Film an dieser Stelle fort.
+
+		@return Gibt false zurück, wenn ein Fehler aufgetreten ist, ansonsten true.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual bool Play() = 0;
+
+	/**
+		@brief Pausiert die Filmwiedergabe.
+
+		Bei einem späteren Aufruf von Play() fährt die Wiedergabe an der Stelle fort an der der Film Pausiert wurde.
+
+		@return Gibt false zurück, wenn ein Fehler aufgetreten ist, ansonsten true.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual bool Pause() = 0;
+
+	/**
+		@brief Diese Funktion muss ein mal pro Frame aufgerufen werden.
+	*/
+	virtual void Update() = 0;
+
+	/**
+		@brief Gibt zurück, ob ein Film zur Wiedergabe geladen wurde.
+	*/
+	virtual bool IsMovieLoaded() = 0;
+
+	/**
+		@brief Gibt zurück, ob die Filmwiedergabe pausiert wurde.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual bool IsPaused() = 0;
+
+	/**
+		@brief Gibt den Faktor zurück um den der geladene Film skaliert wird.
+
+		Beim Laden wird der Skalierungsfaktor automatisch so gewählt, dass der Film die maximal mögliche Bildschirmfläche einnimmt, ohne dass der
+		Film verzerrt wird.
+
+		@return Gibt den Skalierungsfaktor des Filmes zurück.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual float GetScaleFactor() = 0;
+
+	/**
+		@brief Legt den Faktor fest um den der geladene Film skaliert werden soll.
+		@param ScaleFactor der gewünschte Skalierungsfaktor.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual void SetScaleFactor(float ScaleFactor) = 0;
+
+	/**
+		@brief Gibt die aktuelle Abspielposition in Sekunden zurück.
+		@remark Diese Methode darf nur aufgerufen werden, wenn IsMovieLoaded() true zurückgibt.
+	*/
+	virtual double GetTime() = 0;
+
+private:
+	bool _RegisterScriptBindings();
+};
+
+#endif