Bump vcpkg and favour fluidsynth #2322

TheCycoONE · 2023-04-23T02:31:30Z

vcpkg dependencies are bumped. The new set is listed below.

SDL2_Mixer has some vcpkg changes. native_midi is no longer an option when installing through vcpkg. This is a packaging change, not a code change upstream. Manually adding the dependency dlls for sdl2_mixer is also no longer required, they are pulled in properly on build now.

Since fluidsynth is now the preferred midi engine for CorsixTH and it only works if a soundfont is loaded, some initialization code to find soundfonts has been added. It is expected that we will be able to ship one with the installer for the next release version.

To give us more options in case of problems with appveyor a windows github action pipeline was added.

vcpkg packages:

brotli 1.0.9#5
bzip2 1.0.8#4
catch2 3.3.2
dirent 1.23.2#2
ffmpeg 5.1.2#6
fluidsynth 2.3.2#2
freetype 2.12.1#3
gettext 0.21.1
glib 2.76.1#1
libffi 3.4.4#1
libflac 1.4.2
libiconv 1.17#1
libmodplug 0.8.9.0#10
libogg 1.3.5#1
libpng 1.6.39#1
libsndfile 1.2.0
libvorbis 1.3.7#2
lpeg 1.0.2#4
lua 5.4.4#7
luafilesystem 1.8.0#4
luasec 1.3.1
luasocket 3.1.0
mp3lame 3.10
mpg123 1.31.3
openssl 3.1.0#3
opus 1.4
opusfile 0.12+20221121#1
pcre2 10.40#1
pkgconf 1.8.0#5
sdl2-mixer 2.6.3#1
sdl2 2.26.5
yasm-tool-helper 2020-03-11#1
yasm-tool 2021-12-14
yasm 1.3.0#5
zlib 1.2.13

TheCycoONE · 2023-04-24T01:13:23Z

Unfortunately I cannot build release only because some of the vcpkg ports don't work with that triplet.

The first one that fails is luasocket, which was also outdated, I've submitted a PR: microsoft/vcpkg#31078

SDL2_Mixer has some vcpkg changes. native_midi is no longer an option so fluidsynth is now defined. Midi will no longer work without a soundfont specified e.g. with the SDL_SOUNDFONTS environment variable. brotli 1.0.9#5 bzip2 1.0.8#4 catch2 3.3.2 dirent 1.23.2#2 ffmpeg 5.1.2#6 fluidsynth 2.3.2#2 freetype 2.12.1#3 gettext 0.21.1 glib 2.76.1#1 libffi 3.4.4#1 libflac 1.4.2 libiconv 1.17#1 libmodplug 0.8.9.0#10 libogg 1.3.5#1 libpng 1.6.39#1 libsndfile 1.2.0 libvorbis 1.3.7#2 lpeg 1.0.2#4 lua 5.4.4#7 luafilesystem 1.8.0#4 luasec 1.3.1 luasocket 3.1.0 mpg123 1.31.3 openssl 3.1.0#3 opus 1.4 opusfile 0.12+20221121#1 pcre2 10.40#1 pkgconf 1.8.0#5 sdl2-mixer 2.6.3#1 sdl2 2.26.5 yasm-tool-helper 2020-03-11#1 yasm-tool 2021-12-14 yasm 1.3.0#5 zlib 1.2.13

Search for a soundfont in some common locations and use it if available.

Without native_midi we don't have the bug that made us disable proper pause.

Adds the following indirect dependencies: libsndfile 1.2.0 mp3lame 3.10 opus 1.3.1 opusfile 0.12+20221121

To cut down the build time when vcpkg cannot be loaded from cache.

Alberth289346 · 2023-05-06T05:34:16Z

I don't see anything weird, although I must say most of the stuff I don't know much about.

lewri

Artefact generated for windows crashed on launch (cmd flashes then shuts) -- probably needs addressing.
Edit: Only Github Actions one crashes, appveyor is fine.

@colinjmatt will run a test MacOS build too when he has time, but the test won't block PR merge.

Other comments generally are just trivial but worth noting.

lewri · 2023-04-24T17:20:24Z

CorsixTH/Lua/app.lua

+
+  for _, sf_path in ipairs(possible_locations) do
+    if sf_path and lfs.attributes(sf_path) then
+      return sf_path


A warning would be potentially beneficial here to the user if a soundfont wasn't found. However, there is an error catch anyway at audio.lua L167, but may be catching a different kind of problem.

Though to be fair it an error shouldn't ever happen here...

Not finding a soundfont degrades to timidity on supporting platforms. Maybe a console message.

actually if SDL_SOUNDFONT is defined it can not find anything here and still use freesynth; there just isn't enough information to warn at this point.

lewri · 2023-05-06T10:21:05Z

CorsixTH/Lua/app.lua

+  local data_dir = debug.getinfo(1, "S").source:sub(2, -12)
+
+  local possible_locations = {
+    self.config.soundfont or false,


Code for the relevant config file areas affected will need to be added either now or in a future PR, ideally before 0.67.

Preferably yes.

lewri · 2023-05-06T10:38:20Z

Artefact generated for windows crashed on launch (cmd flashes then shuts) -- probably needs addressing.
Edit: Only Github Actions one crashes, appveyor is fine.

There are file/folder differences inc missng files on the github actions one (most notably all the lua is missing)

TheCycoONE · 2023-05-06T16:52:08Z

Ok I'll add the data files. Didn't realize that appveyor made ready to play artifacts

The new action produces RelWithDebInfo artifacts that can be downloaded. Like appveyor the vcpkg builds are cached between runs.

lewri · 2023-05-06T21:12:04Z

Just to note -- this is what happens when there isn't a soundfont target found. The game hangs for quite a bit when the movie ends/skipped:

Running: The callback handler.
A stack trace is included below, and the handler has been disconnected.
Lua\audio.lua:583: Could not load music file 'Sound\Midi\ATLANTIS.XMI' (No SoundFonts have been requested)
stack traceback:
        [C]: in function 'coroutine.yield'
        Lua\app.lua:1084: in function <Lua\app.lua:1079>

An error has occurred!
Almost anything can be the cause, but the detailed information below can help the developers find the source of the error.
Running: The callback handler.
A stack trace is included below, and the handler has been disconnected.
Lua\audio.lua:583: Could not load music file 'Sound\Midi\STEADY.XMI' (No SoundFonts have been requested)
stack traceback:
        [C]: in function 'coroutine.yield'
        Lua\app.lua:1084: in function <Lua\app.lua:1079>

TheCycoONE marked this pull request as draft April 23, 2023 02:31

TheCycoONE changed the title ~~Bump vcpkg~~ Bump vcpkg and favour fluidsynth Apr 23, 2023

This was linked to issues Apr 23, 2023

[Bug] Changing music volume level also changes the all sound volume level. #2309

Closed

audio:pauseBackgroundTrack mutes all sound in windows #524

Closed

TheCycoONE marked this pull request as ready for review April 23, 2023 14:16

TheCycoONE force-pushed the vcpkg_2304 branch from d841e2a to ce79e70 Compare April 23, 2023 22:31

TheCycoONE changed the title ~~Bump vcpkg and favour fluidsynth~~ [WIP] Bump vcpkg and favour fluidsynth Apr 24, 2023

TheCycoONE added 6 commits May 3, 2023 20:14

Load soundfont for midi playback

06ba0a8

Search for a soundfont in some common locations and use it if available.

Restore old pause logic

f410a3b

Without native_midi we don't have the bug that made us disable proper pause.

Add support for compressed sf3 soundfonts

e920f8c

Adds the following indirect dependencies: libsndfile 1.2.0 mp3lame 3.10 opus 1.3.1 opusfile 0.12+20221121

Include more dependency licenses in LICENSE.txt

c7bda10

Only build release dependencies appveyor

dc30786

To cut down the build time when vcpkg cannot be loaded from cache.

TheCycoONE force-pushed the vcpkg_2304 branch from d087ec3 to 18aede1 Compare May 4, 2023 00:20

TheCycoONE requested a review from Alberth289346 May 4, 2023 00:23

TheCycoONE changed the title ~~[WIP] Bump vcpkg and favour fluidsynth~~ Bump vcpkg and favour fluidsynth May 4, 2023

Alberth289346 approved these changes May 6, 2023

View reviewed changes

lewri reviewed May 6, 2023

View reviewed changes

Add windows github action

4c734a2

The new action produces RelWithDebInfo artifacts that can be downloaded. Like appveyor the vcpkg builds are cached between runs.

TheCycoONE force-pushed the vcpkg_2304 branch from e22001d to 4c734a2 Compare May 6, 2023 18:27

Add FluidR3.sf3 to Windows github artifact

c8a7b75

TheCycoONE force-pushed the vcpkg_2304 branch from 4efea1b to c8a7b75 Compare May 6, 2023 18:53

lewri mentioned this pull request May 6, 2023

[Bug] Crash in _StaffWaitToggle for loop #2325

Closed

lewri approved these changes May 6, 2023

View reviewed changes

Add soundfont to appveyor

3e11b55

TheCycoONE force-pushed the vcpkg_2304 branch from 4d4a944 to 3e11b55 Compare May 7, 2023 00:07

TheCycoONE merged commit 0765784 into CorsixTH:master May 7, 2023

lewri mentioned this pull request May 7, 2023

[Bug] No music in Linux #1815

Closed

lewri mentioned this pull request May 8, 2023

[Bug] Pause Logic for Jukebox over-remembering #2328

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump vcpkg and favour fluidsynth #2322

Bump vcpkg and favour fluidsynth #2322

TheCycoONE commented Apr 23, 2023 •

edited

Loading

TheCycoONE commented Apr 24, 2023

Alberth289346 commented May 6, 2023

lewri left a comment •

edited

Loading

lewri Apr 24, 2023

TheCycoONE May 6, 2023

TheCycoONE May 6, 2023 •

edited

Loading

lewri May 6, 2023

TheCycoONE May 6, 2023

lewri commented May 6, 2023 •

edited

Loading

TheCycoONE commented May 6, 2023

lewri commented May 6, 2023

Bump vcpkg and favour fluidsynth #2322

Bump vcpkg and favour fluidsynth #2322

Conversation

TheCycoONE commented Apr 23, 2023 • edited Loading

TheCycoONE commented Apr 24, 2023

Alberth289346 commented May 6, 2023

lewri left a comment • edited Loading

Choose a reason for hiding this comment

lewri Apr 24, 2023

Choose a reason for hiding this comment

TheCycoONE May 6, 2023

Choose a reason for hiding this comment

TheCycoONE May 6, 2023 • edited Loading

Choose a reason for hiding this comment

lewri May 6, 2023

Choose a reason for hiding this comment

TheCycoONE May 6, 2023

Choose a reason for hiding this comment

lewri commented May 6, 2023 • edited Loading

TheCycoONE commented May 6, 2023

lewri commented May 6, 2023

TheCycoONE commented Apr 23, 2023 •

edited

Loading

lewri left a comment •

edited

Loading

TheCycoONE May 6, 2023 •

edited

Loading

lewri commented May 6, 2023 •

edited

Loading