diff options
Diffstat (limited to 'engines/sword25/fmv/movieplayer.h')
-rwxr-xr-x | engines/sword25/fmv/movieplayer.h | 154 |
1 files changed, 77 insertions, 77 deletions
diff --git a/engines/sword25/fmv/movieplayer.h b/engines/sword25/fmv/movieplayer.h index c08969a5a2..5255e0b8e5 100755 --- a/engines/sword25/fmv/movieplayer.h +++ b/engines/sword25/fmv/movieplayer.h @@ -1,21 +1,27 @@ -// ----------------------------------------------------------------------------- -// 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 -// ----------------------------------------------------------------------------- +/* 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. + * + * $URL$ + * $Id$ + * + */ #ifndef SWORD25_MOVIEPLAYER_H #define SWORD25_MOVIEPLAYER_H @@ -27,112 +33,106 @@ #include "sword25/kernel/common.h" #include "sword25/kernel/service.h" -#include "sword25/kernel/memlog_off.h" -#include <string> -#include "sword25/kernel/memlog_on.h" +namespace Sword25 { // ----------------------------------------------------------------------------- -// Klassendefinition +// Class definitions // ----------------------------------------------------------------------------- -class BS_MoviePlayer : public BS_Service -{ +class BS_MoviePlayer : public BS_Service { public: // ----------------------------------------------------------------------------- - // Konstruktion / Destruktion + // Constructor / Destructor // ----------------------------------------------------------------------------- - BS_MoviePlayer(BS_Kernel * pKernel); + BS_MoviePlayer(BS_Kernel *pKernel); virtual ~BS_MoviePlayer() {}; // ----------------------------------------------------------------------------- - // Abstraktes Interface, muss von jedem MoviePlayer implementiert werden + // Abstract interface must be implemented by each Movie Player // ----------------------------------------------------------------------------- /** - @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. + * Loads a movie file + * + * This method loads a movie file and prepares it for playback. + * There can be oly one movie file loaded at a time. If you already have loaded a + * movie file, it will be unloaded and, if necessary, stopped playing. + * @param Filename The filename of the movie file to be loaded + * @param Z Z indicates the position of the film on the main graphics layer + * @return Returns false if an error occured while loading, otherwise 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. - */ + * Unloads the currently loaded movie file. + * @return Returns false if an error occurred while unloading, otherwise true. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ 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. - */ + * Plays the loaded movie. + * + * The film will be keeping the aspect ratio of the screen. + * If the film was previously paused with Pause(), then the film will resume playing. + * @return Returns false if an error occurred while starting, otherwise true. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ 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. - */ + * Pauses movie playback. + * + * A paused movie can later be resumed by calling the Play() method again. + * @return Returns false if an error occurred while pausing, otherwise true. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ virtual bool Pause() = 0; /** - @brief Diese Funktion muss ein mal pro Frame aufgerufen werden. - */ + * This function must be called once per frame. + */ virtual void Update() = 0; /** - @brief Gibt zurück, ob ein Film zur Wiedergabe geladen wurde. - */ + * Returns whether a film is loaded for playback. + */ 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. + * Returns whether the movie playback is paused. + * @remark This method can only be called when IsMovieLoaded() returns true. */ 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. - */ + * Returns the scaling factor for the loaded film. + * + * When a movie is loaded, the scaling factor is automatically selected so that the film + * takes the maximum screen space, without the film being distorted. + * @return Returns the scaling factor of the film. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ 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. - */ + * Sets the factor by which the loaded film is to be scaled. + * @param ScaleFactor The desired scale factor. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ 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. - */ + * Returns the current playing position in seconds. + * @remark This method can only be called when IsMovieLoaded() returns true. + */ virtual double GetTime() = 0; private: bool _RegisterScriptBindings(); }; +} // End of namespace Sword25 + #endif |