aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/sfx/fmodexsound.h
blob: a32d6bb4d8b385f3fad62828debec3a950b8ce16 (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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/* 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$
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_FMODEXSOUND_H
#define SWORD25_FMODEXSOUND_H

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

#include "sword25/kernel/memlog_off.h"
#include <vector>
#include <map>
#include "sword25/kernel/memlog_on.h"

#include "sword25/kernel/common.h"
#include "sword25/kernel/hashmap.h"
#include "sword25/sfx/soundengine.h"

// -----------------------------------------------------------------------------
// Forward Declarations
// -----------------------------------------------------------------------------

class BS_FMODExChannel;
struct FMOD_SYSTEM;
struct FMOD_CHANNEL;

// -----------------------------------------------------------------------------
// Klassendefinition
// -----------------------------------------------------------------------------

class BS_FMODExSound : public BS_SoundEngine {
public:
	// -----------------------------------------------------------------------------
	// Konstruktion / Destruktion
	// -----------------------------------------------------------------------------

	BS_FMODExSound(BS_Kernel *pKernel);
	virtual ~BS_FMODExSound();

	bool            Init(unsigned int SampleRate, unsigned int Channels = 32);
	void            Update();
	void            SetVolume(float Volume, SOUND_TYPES Type);
	float           GetVolume(SOUND_TYPES Type);
	void            PauseAll();
	void            ResumeAll();
	void            PauseLayer(unsigned int Layer);
	void            ResumeLayer(unsigned int Layer);
	bool            PlaySound(const std::string &FileName, SOUND_TYPES Type, float Volume, float Pan, bool Loop, int LoopStart, int LoopEnd, unsigned int Layer);
	unsigned int    PlaySoundEx(const std::string &FileName, SOUND_TYPES Type, float Volume, float Pan, bool Loop, int LoopStart, int LoopEnd, unsigned int Layer);
	unsigned int    PlayDynamicSoundEx(DynamicSoundReadCallback ReadCallback, void *UserData, SOUND_TYPES Type, unsigned int SampleRate, unsigned int BitsPerSample, unsigned int Channels, float Volume = 1.0f, float Pan = 0.0f, unsigned int Layer = 0);

	void    SetSoundVolume(unsigned int Handle, float Volume);
	void    SetSoundPanning(unsigned int Handle, float Pan);
	void    PauseSound(unsigned int Handle);
	void    ResumeSound(unsigned int Handle);
	void    StopSound(unsigned int Handle);
	bool    IsSoundPaused(unsigned int Handle);
	bool    IsSoundPlaying(unsigned int Handle);
	float   GetSoundVolume(unsigned int Handle);
	float   GetSoundPanning(unsigned int Handle);
	float   GetSoundTime(unsigned int Handle);

	BS_Resource    *LoadResource(const std::string &FileName);
	bool            CanLoadResource(const std::string &FileName);

	// -----------------------------------------------------------------------------
	// Persistenz
	// -----------------------------------------------------------------------------

	bool Persist(BS_OutputPersistenceBlock &Writer);
	bool Unpersist(BS_InputPersistenceBlock &Reader);

private:
	struct PlayingSoundData {
		PlayingSoundData() {};
		PlayingSoundData(BS_Resource *ResourcePtr_, BS_FMODExChannel *ChannelPtr_, SOUND_TYPES Type_, unsigned int Layer_, float Volume_, DynamicSoundReadCallback ReadCallback_ = 0, void *UserData_ = 0) :
			ResourcePtr(ResourcePtr_),
			ChannelPtr(ChannelPtr_),
			Type(Type_),
			Layer(Layer_),
			Volume(Volume_),
			ReadCallback(ReadCallback_),
			UserData(UserData_),
			Paused(false),
			PausedLayer(false),
			PausedGlobal(false)
		{}

		BS_Resource                *ResourcePtr;
		BS_FMODExChannel           *ChannelPtr;
		SOUND_TYPES                 Type;
		unsigned int                Layer;
		DynamicSoundReadCallback    ReadCallback;
		void                       *UserData;

		float   Volume;
		bool    Paused;
		bool    PausedLayer;
		bool    PausedGlobal;
	};

	typedef BS_Hashmap<unsigned int, PlayingSoundData>                  PSM;
	typedef BS_Hashmap<unsigned int, PlayingSoundData>::iterator        PSM_ITER;
	typedef BS_Hashmap<unsigned int, PlayingSoundData>::const_iterator  PSM_CONST_ITER;
	PSM m_PlayingSoundsMap;

	FMOD_SYSTEM    *m_FMOD;
	float           m_Volumes[3];
	unsigned int    m_NextHandle;

	void                RemoveInactiveSounds();
	PlayingSoundData   *GetPlayingSoundDataByHandle(unsigned int Handle);
	unsigned int        PlaySoundInternal(const std::string &FileName, SOUND_TYPES Type, float Volume, float Pan, bool Loop, int LoopStart, int LoopEnd, unsigned int Layer, unsigned int Handle, unsigned int Position);
	unsigned int        CountPlayingDynamicSounds();

	static FMOD_RESULT F_CALLBACK FMODExDynamicSoundSetPosCallback(FMOD_SOUND *sound, int subsound, unsigned int position, FMOD_TIMEUNIT postype);
	static FMOD_RESULT F_CALLBACK FMODExDynamicSoundReadCallback(FMOD_SOUND *sound, void *data, unsigned int datalen);
	static FMOD_RESULT F_CALLBACK DSPReadCallback(FMOD_DSP_STATE *dsp_state, float *inbuffer, float *outbuffer, unsigned int length, int inchannels, int outchannels);
};

#endif