OpenTTD Source: src/music/extmidi.h Source File

OpenTTD Source 15.0-beta1

extmidi.h
Go to the documentation of this file.
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
10#ifndef MUSIC_EXTERNAL_H
11#define MUSIC_EXTERNAL_H
12
13#include "music_driver.hpp"
14
15 class MusicDriver_ExtMidi : public MusicDriver {
16private:
17 std::vector<std::string> command_tokens;
18 std::string song;
19 pid_t pid;
20
21 void DoPlay();
22 void DoStop();
23
24public:
25 std::optional<std::string_view> Start(const StringList &param) override;
26
27 void Stop() override;
28
29 void PlaySong(const MusicSongInfo &song) override;
30
31 void StopSong() override;
32
33 bool IsSongPlaying() override;
34
35 void SetVolume(uint8_t vol) override;
36 std::string_view GetName() const override { return "extmidi"; }
37};
38
39 class FMusicDriver_ExtMidi : public DriverFactoryBase {
40public:
41 FMusicDriver_ExtMidi() : DriverFactoryBase(Driver::DT_MUSIC, 3, "extmidi", "External MIDI Driver") {}
42 Driver *CreateInstance() const override { return new MusicDriver_ExtMidi(); }
43};
44
45#endif /* MUSIC_EXTERNAL_H */
DriverFactoryBase
Base for all driver factories.
Definition driver.h:57
Driver
A driver for communicating with the user.
Definition driver.h:21
Driver::DT_MUSIC
@ DT_MUSIC
A music driver, needs to be before sound to properly shut down extmidi forked music players.
Definition driver.h:40
FMusicDriver_ExtMidi
Definition extmidi.h:39
FMusicDriver_ExtMidi::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition extmidi.h:42
MusicDriver_ExtMidi
Definition extmidi.h:15
MusicDriver_ExtMidi::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition extmidi.cpp:74
MusicDriver_ExtMidi::Stop
void Stop() override
Stop this driver.
Definition extmidi.cpp:68
MusicDriver_ExtMidi::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition extmidi.cpp:38
MusicDriver_ExtMidi::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition extmidi.h:36
MusicDriver_ExtMidi::StopSong
void StopSong() override
Stop playing the current song.
Definition extmidi.cpp:83
MusicDriver_ExtMidi::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition extmidi.cpp:89
MusicDriver_ExtMidi::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition extmidi.cpp:98
MusicDriver
Driver for all music playback.
Definition music_driver.hpp:18
music_driver.hpp
Base for all music playback.
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition string_type.h:60
MusicSongInfo
Metadata about a music track.
Definition base_media_base.h:325