src/music/null_m.h

   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
   8 /** @file null_m.h Base for the silent music playback. */
   9
  10 #ifndef MUSIC_NULL_H
  11 #define MUSIC_NULL_H
  12
  13 #include "music_driver.hpp"
  14
  15 /** The music player that does nothing. */
  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
  32 /** Factory for the null music player. */
  33 class FMusicDriver_Null : public DriverFactoryBase {
  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 */