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

OpenTTD Source 15.0-beta1

fluidsynth.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_FLUIDSYNTH_H
11#define MUSIC_FLUIDSYNTH_H
12
13#include "music_driver.hpp"
14
16 class MusicDriver_FluidSynth : public MusicDriver {
17public:
18 std::optional<std::string_view> Start(const StringList &param) override;
19
20 void Stop() override;
21
22 void PlaySong(const MusicSongInfo &song) override;
23
24 void StopSong() override;
25
26 bool IsSongPlaying() override;
27
28 void SetVolume(uint8_t vol) override;
29 std::string_view GetName() const override { return "fluidsynth"; }
30};
31
33 class FMusicDriver_FluidSynth : public DriverFactoryBase {
34public:
35 FMusicDriver_FluidSynth() : DriverFactoryBase(Driver::DT_MUSIC, 5, "fluidsynth", "FluidSynth MIDI Driver") {}
36 Driver *CreateInstance() const override { return new MusicDriver_FluidSynth(); }
37};
38
39#endif /* MUSIC_FLUIDSYNTH_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_FluidSynth
Factory for the fluidsynth driver.
Definition fluidsynth.h:33
FMusicDriver_FluidSynth::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition fluidsynth.h:36
MusicDriver_FluidSynth
Music driver making use of FluidSynth.
Definition fluidsynth.h:16
MusicDriver_FluidSynth::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition fluidsynth.cpp:61
MusicDriver_FluidSynth::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition fluidsynth.h:29
MusicDriver_FluidSynth::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition fluidsynth.cpp:132
MusicDriver_FluidSynth::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition fluidsynth.cpp:178
MusicDriver_FluidSynth::StopSong
void StopSong() override
Stop playing the current song.
Definition fluidsynth.cpp:164
MusicDriver_FluidSynth::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition fluidsynth.cpp:186
MusicDriver_FluidSynth::Stop
void Stop() override
Stop this driver.
Definition fluidsynth.cpp:116
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