src/music/music_driver.hpp

   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 music_driver.hpp Base for all music playback. */
   9
  10 #ifndef MUSIC_MUSIC_DRIVER_HPP
  11 #define MUSIC_MUSIC_DRIVER_HPP
  12
  13 #include "../driver.h"
  14
  15 struct MusicSongInfo;
  16
  17 /** Driver for all music playback. */
  18 class MusicDriver : public Driver {
  19 public:
  20         /**
  21          * Play a particular song.
  22          * @param song The information for the song to play.
  23          */
  24         virtual void PlaySong(const MusicSongInfo &song) = 0;
  25
  26         /**
  27          * Stop playing the current song.
  28          */
  29         virtual void StopSong() = 0;
  30
  31         /**
  32          * Are we currently playing a song?
  33          * @return True if a song is being played.
  34          */
  35         virtual bool IsSongPlaying() = 0;
  36
  37         /**
  38          * Set the volume, if possible.
  39          * @param vol The new volume.
  40          */
  41         virtual void SetVolume(uint8_t vol) = 0;
  42
  43         /**
  44          * Get the currently active instance of the music driver.
  45          */
  46         static MusicDriver *GetInstance()
  47         {
  48                 return static_cast<MusicDriver*>(*DriverFactoryBase::GetActiveDriver(Driver::DT_MUSIC));
  49         }
  50 };
  51
  52 extern std::string _ini_musicdriver;
  53
  54 #endif /* MUSIC_MUSIC_DRIVER_HPP */