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

OpenTTD Source 15.0-RC2

fluidsynth.cpp
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "../stdafx.h"
11
12#include "fluidsynth.h"
13
14#include <filesystem>
15#include <fluidsynth.h>
16#include <mutex>
17
18#include "../debug.h"
19#include "../mixer.h"
20#include "midifile.hpp"
21
22#include "../safeguards.h"
23
24static struct {
25 fluid_settings_t *settings;
26 fluid_synth_t *synth;
27 fluid_player_t *player;
28 std::mutex synth_mutex;
29} _midi;
30
32 static FMusicDriver_FluidSynth iFMusicDriver_FluidSynth;
33
35 static const char *_default_soundfonts[] = {
36 /* FluidSynth preferred */
37 /* See: https://www.fluidsynth.org/api/settings_synth.html#settings_synth_default-soundfont */
38 "/usr/share/soundfonts/default.sf2",
39
40 /* Debian/Ubuntu preferred */
41 /* See: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=929185 */
42 "/usr/share/sounds/sf3/default-GM.sf3",
43
44 /* OpenSUSE preferred */
45 "/usr/share/sounds/sf2/FluidR3_GM.sf2",
46
47 /* RedHat/Fedora/Arch preferred */
48 "/usr/share/soundfonts/FluidR3_GM.sf2",
49
50 /* Debian/Ubuntu/OpenSUSE alternatives */
51 "/usr/share/sounds/sf2/TimGM6mb.sf2",
52 "/usr/share/sounds/sf2/FluidR3_GS.sf2",
53};
54
55static void RenderMusicStream(int16_t *buffer, size_t samples)
56{
57 std::unique_lock<std::mutex> lock{_midi.synth_mutex, std::try_to_lock};
58
59 if (!lock.owns_lock() || _midi.synth == nullptr || _midi.player == nullptr) return;
60 fluid_synth_write_s16(_midi.synth, samples, buffer, 0, 2, buffer, 1, 2);
61}
62
63std::optional<std::string_view> MusicDriver_FluidSynth::Start(const StringList &param)
64{
65 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
66
67 auto sfont_name = GetDriverParam(param, "soundfont");
68 int sfont_id;
69
70 Debug(driver, 1, "Fluidsynth: sf {}", sfont_name.has_value() ? *sfont_name : "(null)");
71
72 /* Create the settings. */
73 _midi.settings = new_fluid_settings();
74 if (_midi.settings == nullptr) return "Could not create midi settings";
75 /* Don't try to lock sample data in memory, OTTD usually does not run with privileges allowing that */
76 fluid_settings_setint(_midi.settings, "synth.lock-memory", 0);
77
78 /* Install the music render routine and set up the samplerate */
79 uint32_t samplerate = MxSetMusicSource(RenderMusicStream);
80 fluid_settings_setnum(_midi.settings, "synth.sample-rate", samplerate);
81 Debug(driver, 1, "Fluidsynth: samplerate {:.0f}", (float)samplerate);
82
83 /* Create the synthesizer. */
84 _midi.synth = new_fluid_synth(_midi.settings);
85 if (_midi.synth == nullptr) return "Could not open synth";
86
87 /* Load a SoundFont and reset presets (so that new instruments
88 * get used from the SoundFont) */
89 if (!sfont_name.has_value()) {
90 sfont_id = FLUID_FAILED;
91
92 /* Try loading the default soundfont registered with FluidSynth. */
93 char *default_soundfont;
94 fluid_settings_dupstr(_midi.settings, "synth.default-soundfont", &default_soundfont);
95 if (fluid_is_soundfont(default_soundfont)) {
96 sfont_id = fluid_synth_sfload(_midi.synth, default_soundfont, 1);
97 }
98
99 /* If no default soundfont found, try our own list. */
100 if (sfont_id == FLUID_FAILED) {
101 for (const char *soundfont : _default_soundfonts) {
102 if (!std::filesystem::exists(soundfont) || !fluid_is_soundfont(soundfont)) continue;
103 sfont_id = fluid_synth_sfload(_midi.synth, soundfont, 1);
104 if (sfont_id != FLUID_FAILED) break;
105 }
106 }
107 if (sfont_id == FLUID_FAILED) return "Could not open any sound font";
108 } else {
109 std::string name{sfont_name.value()};
110 sfont_id = fluid_synth_sfload(_midi.synth, name.c_str(), 1);
111 if (sfont_id == FLUID_FAILED) return "Could not open sound font";
112 }
113
114 _midi.player = nullptr;
115
116 return std::nullopt;
117}
118
119 void MusicDriver_FluidSynth::Stop()
120{
121 MxSetMusicSource(nullptr);
122
123 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
124
125 if (_midi.player != nullptr) delete_fluid_player(_midi.player);
126 _midi.player = nullptr;
127
128 if (_midi.synth != nullptr) delete_fluid_synth(_midi.synth);
129 _midi.synth = nullptr;
130
131 if (_midi.settings != nullptr) delete_fluid_settings(_midi.settings);
132 _midi.settings = nullptr;
133}
134
135 void MusicDriver_FluidSynth::PlaySong(const MusicSongInfo &song)
136{
137 std::string filename = MidiFile::GetSMFFile(song);
138
139 this->StopSong();
140
141 if (filename.empty()) {
142 return;
143 }
144
145 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
146
147 _midi.player = new_fluid_player(_midi.synth);
148 if (_midi.player == nullptr) {
149 Debug(driver, 0, "Could not create midi player");
150 return;
151 }
152
153 if (fluid_player_add(_midi.player, filename.c_str()) != FLUID_OK) {
154 Debug(driver, 0, "Could not open music file");
155 delete_fluid_player(_midi.player);
156 _midi.player = nullptr;
157 return;
158 }
159 if (fluid_player_play(_midi.player) != FLUID_OK) {
160 Debug(driver, 0, "Could not start midi player");
161 delete_fluid_player(_midi.player);
162 _midi.player = nullptr;
163 return;
164 }
165}
166
167 void MusicDriver_FluidSynth::StopSong()
168{
169 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
170
171 if (_midi.player == nullptr) return;
172
173 fluid_player_stop(_midi.player);
174 /* No fluid_player_join needed */
175 delete_fluid_player(_midi.player);
176 fluid_synth_system_reset(_midi.synth);
177 fluid_synth_all_sounds_off(_midi.synth, -1);
178 _midi.player = nullptr;
179}
180
181 bool MusicDriver_FluidSynth::IsSongPlaying()
182{
183 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
184 if (_midi.player == nullptr) return false;
185
186 return fluid_player_get_status(_midi.player) == FLUID_PLAYER_PLAYING;
187}
188
189 void MusicDriver_FluidSynth::SetVolume(uint8_t vol)
190{
191 std::lock_guard<std::mutex> lock{_midi.synth_mutex};
192 if (_midi.settings == nullptr) return;
193
194 /* Allowed range of synth.gain is 0.0 to 10.0 */
195 /* fluidsynth's default gain is 0.2, so use this as "full
196 * volume". Set gain using OpenTTD's volume, as a number between 0
197 * and 0.2. */
198 double gain = (1.0 * vol) / (128.0 * 5.0);
199 if (fluid_settings_setnum(_midi.settings, "synth.gain", gain) != FLUID_OK) {
200 Debug(driver, 0, "Could not set volume");
201 }
202}
FMusicDriver_FluidSynth
Factory for the fluidsynth driver.
Definition fluidsynth.h:33
MusicDriver_FluidSynth::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition fluidsynth.cpp:63
MusicDriver_FluidSynth::PlaySong
void PlaySong(const MusicSongInfo &song) override
Play a particular song.
Definition fluidsynth.cpp:135
MusicDriver_FluidSynth::IsSongPlaying
bool IsSongPlaying() override
Are we currently playing a song?
Definition fluidsynth.cpp:181
MusicDriver_FluidSynth::StopSong
void StopSong() override
Stop playing the current song.
Definition fluidsynth.cpp:167
MusicDriver_FluidSynth::SetVolume
void SetVolume(uint8_t vol) override
Set the volume, if possible.
Definition fluidsynth.cpp:189
MusicDriver_FluidSynth::Stop
void Stop() override
Stop this driver.
Definition fluidsynth.cpp:119
Debug
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
GetDriverParam
std::optional< std::string_view > GetDriverParam(const StringList &parm, std::string_view name)
Get a string parameter the list of parameters.
Definition driver.cpp:47
_midi
static struct @13 _midi
Metadata about the midi we're playing.
synth_mutex
std::mutex synth_mutex
Guard mutex for synth access.
Definition fluidsynth.cpp:28
iFMusicDriver_FluidSynth
static FMusicDriver_FluidSynth iFMusicDriver_FluidSynth
Factory for the FluidSynth driver.
Definition fluidsynth.cpp:32
_default_soundfonts
static const char * _default_soundfonts[]
List of sound fonts to try by default.
Definition fluidsynth.cpp:35
player
fluid_player_t * player
FluidSynth MIDI player handle.
Definition fluidsynth.cpp:27
synth
fluid_synth_t * synth
FluidSynth synthesizer handle.
Definition fluidsynth.cpp:26
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition fluidsynth.cpp:25
fluidsynth.h
Base for FluidSynth music playback.
MxSetMusicSource
uint32_t MxSetMusicSource(MxStreamCallback music_callback)
Set source of PCM music.
Definition mixer.cpp:234
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition string_type.h:60
MidiFile::GetSMFFile
static std::string GetSMFFile(const MusicSongInfo &song)
Get the name of a Standard MIDI File for a given song.
Definition midifile.cpp:1033
MusicSongInfo
Metadata about a music track.
Definition base_media_music.h:35
lock
std::mutex lock
synchronization for playback status fields
Definition win32_m.cpp:35