OpenTTD

dmusic.h
Go to the documentation of this file.
1 /* $Id: dmusic.h 26108 2013-11-25 14:30:22Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef MUSIC_DMUSIC_H
13 #define MUSIC_DMUSIC_H
14
15 #include "music_driver.hpp"
16
18 class MusicDriver_DMusic : public MusicDriver {
19 public:
20 virtual ~MusicDriver_DMusic();
21
22 /* virtual */ const char *Start(const char * const *param);
23
24 /* virtual */ void Stop();
25
26 /* virtual */ void PlaySong(const char *filename);
27
28 /* virtual */ void StopSong();
29
30 /* virtual */ bool IsSongPlaying();
31
32 /* virtual */ void SetVolume(byte vol);
33 /* virtual */ const char *GetName() const { return "dmusic"; }
34 };
35
37 class FMusicDriver_DMusic : public DriverFactoryBase {
38 public:
39 FMusicDriver_DMusic() : DriverFactoryBase(Driver::DT_MUSIC, 10, "dmusic", "DirectMusic MIDI Driver") {}
40 /* virtual */ Driver *CreateInstance() const { return new MusicDriver_DMusic(); }
41 };
42
43 #endif /* MUSIC_DMUSIC_H */
MusicDriver_DMusic::Stop
void Stop()
Stop this driver.
MusicDriver_DMusic::IsSongPlaying
bool IsSongPlaying()
Are we currently playing a song?
FMusicDriver_DMusic::CreateInstance
Driver * CreateInstance() const
Create an instance of this driver-class.
Definition: dmusic.h:40
MusicDriver_DMusic::PlaySong
void PlaySong(const char *filename)
Play a particular song.
MusicDriver_DMusic::GetName
const char * GetName() const
Get the name of this driver.
Definition: dmusic.h:33
Driver::DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players...
Definition: driver.h:43
MusicDriver_DMusic
Music player making use of DirectX.
Definition: dmusic.h:18
music_driver.hpp
Base for all music playback.
MusicDriver_DMusic::SetVolume
void SetVolume(byte vol)
Set the volume, if possible.
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:60
MusicDriver_DMusic::Start
const char * Start(const char *const *param)
Start this driver.
Driver
A driver for communicating with the user.
Definition: driver.h:24
MusicDriver_DMusic::StopSong
void StopSong()
Stop playing the current song.
FMusicDriver_DMusic
Factory for the DirectX music player.
Definition: dmusic.h:37
MusicDriver
Driver for all music playback.
Definition: music_driver.hpp:18