aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/fmv/movieplayer.h
blob: c08969a5a20f7d52239544beb87d6e45b3210705 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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 SWORD25_MOVIEPLAYER_H
#define SWORD25_MOVIEPLAYER_H

// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------

#include "sword25/kernel/common.h"
#include "sword25/kernel/service.h"

#include "sword25/kernel/memlog_off.h"
#include <string>
#include "sword25/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