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