OpenTTD Source  20241108-master-g80f628063a
null_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_NULL_H
11 #define MUSIC_NULL_H
12 
13 #include "music_driver.hpp"
14 
16 class MusicDriver_Null : public MusicDriver {
17 public:
18  std::optional<std::string_view> Start(const StringList &) override { return std::nullopt; }
19 
20  void Stop() override { }
21 
22  void PlaySong(const MusicSongInfo &) override { }
23 
24  void StopSong() override { }
25 
26  bool IsSongPlaying() override { return true; }
27 
28  void SetVolume(uint8_t) override { }
29  std::string_view GetName() const override { return "null"; }
30 };
31 
34 public:
35  FMusicDriver_Null() : DriverFactoryBase(Driver::DT_MUSIC, 1, "null", "Null Music Driver") {}
36  Driver *CreateInstance() const override { return new MusicDriver_Null(); }
37 };
38 
39 #endif /* MUSIC_NULL_H */
Base for all driver factories.
Definition: driver.h:57
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
A driver for communicating with the user.
Definition: driver.h:21
@ DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players.
Definition: driver.h:40
Factory for the null music player.
Definition: null_m.h:33
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: null_m.h:36
The music player that does nothing.
Definition: null_m.h:16
bool IsSongPlaying() override
Are we currently playing a song?
Definition: null_m.h:26
void PlaySong(const MusicSongInfo &) override
Play a particular song.
Definition: null_m.h:22
std::optional< std::string_view > Start(const StringList &) override
Start this driver.
Definition: null_m.h:18
void SetVolume(uint8_t) override
Set the volume, if possible.
Definition: null_m.h:28
std::string_view GetName() const override
Get the name of this driver.
Definition: null_m.h:29
void StopSong() override
Stop playing the current song.
Definition: null_m.h:24
void Stop() override
Stop this driver.
Definition: null_m.h:20
Driver for all music playback.
Base for all music playback.
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
Metadata about a music track.