OpenTTD Source  1.11.0-beta2
os2_m.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef MUSIC_OS2_H
11 #define MUSIC_OS2_H
12 
13 #include "music_driver.hpp"
14 
16 class MusicDriver_OS2 : public MusicDriver {
17 public:
18  const char *Start(const StringList &param) override;
19 
20  void Stop() override;
21 
22  void PlaySong(const MusicSongInfo &song) override;
23 
24  void StopSong() override;
25 
26  bool IsSongPlaying() override;
27 
28  void SetVolume(byte vol) override;
29  const char *GetName() const override { return "os2"; }
30 };
31 
34 public:
35  FMusicDriver_OS2() : DriverFactoryBase(Driver::DT_MUSIC, 10, "os2", "OS/2 Music Driver") {}
36  Driver *CreateInstance() const override { return new MusicDriver_OS2(); }
37 };
38 
39 #endif /* MUSIC_OS2_H */
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:206
MusicDriver_OS2::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition: os2_m.cpp:76
MusicDriver_OS2::Start
const char * Start(const StringList &param) override
Start this driver.
Definition: os2_m.cpp:83
FMusicDriver_OS2::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: os2_m.h:36
MusicDriver_OS2::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition: os2_m.cpp:52
MusicDriver_OS2::SetVolume
void SetVolume(byte vol) override
Set the volume, if possible.
Definition: os2_m.cpp:71
MusicDriver_OS2::GetName
const char * GetName() const override
Get the name of this driver.
Definition: os2_m.h:29
FMusicDriver_OS2
Factory for OS/2's music player.
Definition: os2_m.h:33
MusicSongInfo
Metadata about a music track.
Definition: base_media_base.h:291
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:58
music_driver.hpp
MusicDriver_OS2::Stop
void Stop() override
Stop this driver.
Definition: os2_m.cpp:88
MusicDriver_OS2
OS/2's music player.
Definition: os2_m.h:16
MusicDriver
Driver for all music playback.
Definition: music_driver.hpp:18
Driver
A driver for communicating with the user.
Definition: driver.h:23
Driver::DT_MUSIC
@ DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players.
Definition: driver.h:42
MusicDriver_OS2::StopSong
void StopSong() override
Stop playing the current song.
Definition: os2_m.cpp:66
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:59