ScummVM API documentation
sound_lowlevel.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * Additional copyright for this file:
8 * Copyright (C) 1999-2000 Revolution Software Ltd.
9 * This code is based on source code created by Revolution Software,
10 * used with permission.
11 *
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 *
25 */
26
27#ifndef ICB_SOUND_LOWLEVEL_H
28#define ICB_SOUND_LOWLEVEL_H
29
30#include "engines/icb/common/px_string.h"
31
32namespace ICB {
33
34void SetupSndEngine();
35
36int32 GetSamplePitch(const char *sampleName, bool8 isInSession);
37
38void StartSample(int32 ch, const char *sampleName, bool8 isInSession, int32 looping);
39void StopSample(int32 ch);
40void SetChannelVolumeAndPan(int32 ch, int32 volume, int32 pan);
41void SetChannelPitch(int32 ch, int32 pitch);
42
43void LoadSessionSounds(const char *cluster);
44void LoadMissionSounds(const char *cluster);
45
46// Prototype for useful cluster managing function
47bool8 DoesClusterContainFile(pxString clustername, uint32 hash_to_find, uint32 &fileoffset, uint32 &filesize);
48bool8 IsSpeechPlaying(void);
49
50// returns length of sound in 12ths of second
51int32 PreloadSpeech(uint32 hash); // does nothing on psx
52int32 SayLineOfSpeech(uint32 speechHash);
53void StopSpeechPlayback(void);
54void CancelSpeechPlayback(void);
55
56} // End of namespace ICB
57
58#endif // SOUND_LOWLEVEL_H