OpenTTD
extmidi.h
Go to the documentation of this file.
1 /* $Id: extmidi.h 27834 2017-03-29 17:36:46Z peter1138 $ */
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_EXTERNAL_H
13 #define MUSIC_EXTERNAL_H
14 
15 #include "music_driver.hpp"
16 
18 private:
19  char **params;
20  char song[MAX_PATH];
21  pid_t pid;
22 
23  void DoPlay();
24  void DoStop();
25 
26 public:
27  /* virtual */ const char *Start(const char * const *param);
28 
29  /* virtual */ void Stop();
30 
31  /* virtual */ void PlaySong(const char *filename);
32 
33  /* virtual */ void StopSong();
34 
35  /* virtual */ bool IsSongPlaying();
36 
37  /* virtual */ void SetVolume(byte vol);
38  /* virtual */ const char *GetName() const { return "extmidi"; }
39 };
40 
42 public:
43  FMusicDriver_ExtMidi() : DriverFactoryBase(Driver::DT_MUSIC, 3, "extmidi", "External MIDI Driver") {}
44  /* virtual */ Driver *CreateInstance() const { return new MusicDriver_ExtMidi(); }
45 };
46 
47 #endif /* MUSIC_EXTERNAL_H */
bool IsSongPlaying()
Are we currently playing a song?
Definition: extmidi.cpp:98
Driver * CreateInstance() const
Create an instance of this driver-class.
Definition: extmidi.h:44
void StopSong()
Stop playing the current song.
Definition: extmidi.cpp:92
void Stop()
Stop this driver.
Definition: extmidi.cpp:78
void SetVolume(byte vol)
Set the volume, if possible.
Definition: extmidi.cpp:107
A music driver, needs to be before sound to properly shut down extmidi forked music players...
Definition: driver.h:43
const char * GetName() const
Get the name of this driver.
Definition: extmidi.h:38
Base for all music playback.
Base for all driver factories.
Definition: driver.h:60
void PlaySong(const char *filename)
Play a particular song.
Definition: extmidi.cpp:86
A driver for communicating with the user.
Definition: driver.h:24
const char * Start(const char *const *param)
Start this driver.
Definition: extmidi.cpp:38
Driver for all music playback.