ScummVM API documentation
music.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 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22/*
23 * This code is based on Labyrinth of Time code with assistance of
24 *
25 * Copyright (c) 1993 Terra Nova Development
26 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
27 *
28 */
29
30#ifndef LAB_MUSIC_H
31#define LAB_MUSIC_H
32
33#include "audio/mixer.h"
34
35namespace Common {
36class File;
37}
38
39namespace Lab {
40
41class LabEngine;
42
43//---------------------------
44//----- From LabMusic.c -----
45//---------------------------
46
47#define MAXBUFFERS 5
48
49class Music {
50private:
51 LabEngine *_vm;
52
53 Common::File *_musicFile;
54 uint32 _storedPos;
55
56 Audio::SoundHandle _musicHandle;
57 Audio::SoundHandle _sfxHandle;
58
59private:
60 byte getSoundFlags();
61
62public:
63 Music(LabEngine *vm);
64
68 void changeMusic(const Common::String &filename, bool storeCurPos, bool seektoStoredPos);
69
70 void resetMusic(bool seekToStoredPos);
71
75 void checkRoomMusic(uint16 prevRoom, uint16 newRoom);
76
80 void freeMusic();
81
82 bool isSoundEffectActive() const;
83 void playSoundEffect(uint16 sampleSpeed, uint32 length, bool loop, Common::File *dataFile);
84
88 void loadSoundEffect(const Common::String &filename, bool loop, bool waitTillFinished);
89
90 void stopSoundEffect();
91};
92
93} // End of namespace Lab
94
95#endif // LAB_MUSIC_H
Definition: mixer.h:49
Definition: file.h:47
Definition: str.h:59
Definition: lab.h:158
Definition: music.h:49
void loadSoundEffect(const Common::String &filename, bool loop, bool waitTillFinished)
void checkRoomMusic(uint16 prevRoom, uint16 newRoom)
void changeMusic(const Common::String &filename, bool storeCurPos, bool seektoStoredPos)
void freeMusic()
Definition: algorithm.h:29