blob: f4d3d7dd3699db606cd1df8b1da7149c177256c0 (
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
|
/* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD 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, version 2.
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file music_driver.hpp Base for all music playback. */
#ifndef MUSIC_MUSIC_DRIVER_HPP
#define MUSIC_MUSIC_DRIVER_HPP
#include "../driver.h"
struct MusicSongInfo;
/** Driver for all music playback. */
class MusicDriver : public Driver {
public:
/**
* Play a particular song.
* @param song The information for the song to play.
*/
virtual void PlaySong(const MusicSongInfo &song) = 0;
/**
* Stop playing the current song.
*/
virtual void StopSong() = 0;
/**
* Are we currently playing a song?
* @return True if a song is being played.
*/
virtual bool IsSongPlaying() = 0;
/**
* Set the volume, if possible.
* @param vol The new volume.
*/
virtual void SetVolume(byte vol) = 0;
/**
* Get the currently active instance of the music driver.
*/
static MusicDriver *GetInstance() {
return static_cast<MusicDriver*>(*DriverFactoryBase::GetActiveDriver(Driver::DT_MUSIC));
}
};
extern char *_ini_musicdriver;
#endif /* MUSIC_MUSIC_DRIVER_HPP */
|
