src/music/libtimidity.h

   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
  10 /** @file libtimidity.h Base for LibTimidity music playback. */
  11
  12 #ifndef MUSIC_LIBTIMIDITY_H
  13 #define MUSIC_LIBTIMIDITY_H
  14
  15 #include "music_driver.hpp"
  16
  17 /** Music driver making use of libtimidity. */
  18 class MusicDriver_LibTimidity : public MusicDriver {
  19 public:
  20         /* virtual */ const char *Start(const char * const *param);
  21
  22         /* virtual */ void Stop();
  23
  24         /* virtual */ void PlaySong(const char *filename);
  25
  26         /* virtual */ void StopSong();
  27
  28         /* virtual */ bool IsSongPlaying();
  29
  30         /* virtual */ void SetVolume(byte vol);
  31         /* virtual */ const char *GetName() const { return "libtimidity"; }
  32 };
  33
  34 /** Factory for the libtimidity driver. */
  35 class FMusicDriver_LibTimidity : public DriverFactoryBase {
  36 public:
  37         FMusicDriver_LibTimidity() : DriverFactoryBase(Driver::DT_MUSIC, 5, "libtimidity", "LibTimidity MIDI Driver") {}
  38         /* virtual */ Driver *CreateInstance() const { return new MusicDriver_LibTimidity(); }
  39 };
  40
  41 #endif /* MUSIC_LIBTIMIDITY_H */