aboutsummaryrefslogtreecommitdiff
path: root/engines/sci/sound/soundcmd.h
blob: cac3ff794b5fffd424abaaae744f335e1b9b805c (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
/* 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.
 *
 */

#ifndef SCI_SOUNDCMD_H
#define SCI_SOUNDCMD_H

#include "common/list.h"
#include "audio/mididrv.h"	// for MusicType
#include "sci/engine/state.h"

namespace Sci {

class Console;
class SciMusic;
class SoundCommandParser;
class MusicEntry;
//typedef void (SoundCommandParser::*SoundCommand)(reg_t obj, int16 value);

//struct MusicEntryCommand {
//	MusicEntryCommand(const char *d, SoundCommand c) : sndCmd(c), desc(d) {}
//	SoundCommand sndCmd;
//	const char *desc;
//};

class SoundCommandParser {
public:
	SoundCommandParser(ResourceManager *resMan, SegManager *segMan, Kernel *kernel, AudioPlayer *audio, SciVersion soundVersion);
	~SoundCommandParser();

	//reg_t parseCommand(EngineState *s, int argc, reg_t *argv);

	// Functions used for game state loading
	void clearPlayList();
	void syncPlayList(Common::Serializer &s);
	void reconstructPlayList();

	// Functions used for the ScummVM menus
	void setMasterVolume(int vol);
	void pauseAll(bool pause);
#ifdef ENABLE_SCI32
	void setVolume(const reg_t obj, const int vol);
#endif

	// Debug console functions
	void startNewSound(int number);
	void stopAllSounds();
	void printPlayList(Console *con);
	void printSongInfo(reg_t obj, Console *con);

	void processPlaySound(reg_t obj, bool playBed);
	void processStopSound(reg_t obj, bool sampleFinishedPlaying);
	void initSoundResource(MusicEntry *newSound);

	MusicType getMusicType() const;

	ResourceType getSoundResourceType(const uint16 resourceNo) const {
		if (_useDigitalSFX && _resMan->testResource(ResourceId(kResourceTypeAudio, resourceNo)))
			return kResourceTypeAudio;
		else
			return kResourceTypeSound;
	}

	/**
	 * Synchronizes the current state of the music list to the rest of the engine, so that
	 * the changes that the sound thread makes to the music are registered with the engine
	 * scripts. In SCI0, we invoke this from kAnimate (which is called very often). SCI01
	 * and later have a specific callback function, cmdUpdateCues, which is called regularly
	 * by the engine scripts themselves, so the engine itself polls for changes to the music
	 */
	void updateSci0Cues();

	reg_t kDoSoundInit(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundPlay(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundRestore(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundMute(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundPause(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundResumeAfterRestore(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundStop(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundStopAll(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundDispose(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundMasterVolume(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundFade(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundGetPolyphony(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundUpdate(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundUpdateCues(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSendMidi(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundGlobalReverb(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSetHold(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundDummy(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundGetAudioCapability(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSetVolume(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSetPriority(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSetLoop(EngineState *s, int argc, reg_t *argv);
	reg_t kDoSoundSuspend(EngineState *s, int argc, reg_t *argv);

private:
	//typedef Common::Array<MusicEntryCommand *> SoundCommandContainer;
	//SoundCommandContainer _soundCommands;
	ResourceManager *_resMan;
	SegManager *_segMan;
	Kernel *_kernel;
	SciMusic *_music;
	AudioPlayer *_audio;
	SciVersion _soundVersion;
	// If true and an alternative digital sound effect exists, the digital
	// sound effect is preferred instead
	bool _useDigitalSFX;

	void processInitSound(reg_t obj);
	void processDisposeSound(reg_t obj);
	void processUpdateCues(reg_t obj);
	int getSoundResourceId(reg_t obj);
};

} // End of namespace Sci

#endif // SCI_SOUNDCMD_H