OpenTTD
null_m.h
Go to the documentation of this file.
1 /* $Id$ */
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_NULL_H
13 #define MUSIC_NULL_H
14 
15 #include "music_driver.hpp"
16 
18 class MusicDriver_Null : public MusicDriver {
19 public:
20  const char *Start(const char * const *param) override { return nullptr; }
21 
22  void Stop() override { }
23 
24  void PlaySong(const MusicSongInfo &song) override { }
25 
26  void StopSong() override { }
27 
28  bool IsSongPlaying() override { return true; }
29 
30  void SetVolume(byte vol) override { }
31  const char *GetName() const override { return "null"; }
32 };
33 
36 public:
37  FMusicDriver_Null() : DriverFactoryBase(Driver::DT_MUSIC, 1, "null", "Null Music Driver") {}
38  Driver *CreateInstance() const override { return new MusicDriver_Null(); }
39 };
40 
41 #endif /* MUSIC_NULL_H */
Metadata about a music track.
void StopSong() override
Stop playing the current song.
Definition: null_m.h:26
const char * GetName() const override
Get the name of this driver.
Definition: null_m.h:31
A music driver, needs to be before sound to properly shut down extmidi forked music players...
Definition: driver.h:43
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: null_m.h:38
void Stop() override
Stop this driver.
Definition: null_m.h:22
Base for all music playback.
Base for all driver factories.
Definition: driver.h:60
bool IsSongPlaying() override
Are we currently playing a song?
Definition: null_m.h:28
A driver for communicating with the user.
Definition: driver.h:24
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition: null_m.h:24
const char * Start(const char *const *param) override
Start this driver.
Definition: null_m.h:20
Factory for the null music player.
Definition: null_m.h:35
void SetVolume(byte vol) override
Set the volume, if possible.
Definition: null_m.h:30
Driver for all music playback.
The music player that does nothing.
Definition: null_m.h:18