OpenTTD
libtimidity.h
Go to the documentation of this file.
1 /* $Id: libtimidity.h 26108 2013-11-25 14:30:22Z rubidium $ */
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_LIBTIMIDITY_H
13 #define MUSIC_LIBTIMIDITY_H
14 
15 #include "music_driver.hpp"
16 
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 
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 */
const char * Start(const char *const *param)
Start this driver.
Definition: libtimidity.cpp:60
bool IsSongPlaying()
Are we currently playing a song?
Music driver making use of libtimidity.
Definition: libtimidity.h:18
A music driver, needs to be before sound to properly shut down extmidi forked music players...
Definition: driver.h:43
void PlaySong(const char *filename)
Play a particular song.
Definition: libtimidity.cpp:99
Base for all music playback.
Base for all driver factories.
Definition: driver.h:60
A driver for communicating with the user.
Definition: driver.h:24
const char * GetName() const
Get the name of this driver.
Definition: libtimidity.h:31
void SetVolume(byte vol)
Set the volume, if possible.
Factory for the libtimidity driver.
Definition: libtimidity.h:35
void Stop()
Stop this driver.
Definition: libtimidity.cpp:93
Driver for all music playback.
void StopSong()
Stop playing the current song.
Driver * CreateInstance() const
Create an instance of this driver-class.
Definition: libtimidity.h:38