Switch to libxmp for tracker music (#721)

* Revert "Merge pull request #678 from qookei/libopenmpt"

This reverts commit afa3eea, reversing
changes made to 0653a51.

* Switch to libxmp for tracker music

* Set initial volume

* Update vcpkg.json

Author: ceski-1

.github/workflows/continuous_integration.yml

@@ -83,7 +83,7 @@ jobs:
             ${{ matrix.config.msys-env }}-cmake
             ${{ matrix.config.msys-env }}-ninja
             ${{ matrix.config.msys-env }}-pkgconf
-            ${{ matrix.config.msys-env }}-libopenmpt
+            ${{ matrix.config.msys-env }}-libxmp
             ${{ matrix.config.msys-env }}-fluidsynth
             ${{ matrix.config.msys-env }}-libmad
             ${{ matrix.config.msys-env }}-libvorbis
@@ -103,7 +103,7 @@ jobs:
             gcc \
             ninja-build \
             pkg-config \
-            libopenmpt-dev \
+            libxmp-dev \
             libfluidsynth-dev \
             fluidsynth \
             libgl-dev \
@@ -129,7 +129,7 @@ jobs:
               python \
               ninja \
               pkg-config \
-              libopenmpt \
+              libxmp \
               fluid-synth \
               libvorbis \
               libzip \

docs/guides/building_on_macos.md

@@ -13,7 +13,7 @@ On arm64 machines, brew will be installed in `/opt/homebrew`.
 ## Install Build Dependencies
 Install cmake, SDL2 and additional dependencies for DSDA-Doom:
 ```
-brew install cmake pkgconf libopenmpt fluid-synth libvorbis libzip mad portmidi sdl2 sdl2_image sdl2_mixer
+brew install cmake pkgconf libxmp fluid-synth libvorbis libzip mad portmidi sdl2 sdl2_image sdl2_mixer
 ```
 ## Build DSDA-Doom
 Make a clone of the DSDA-Doom Git repository:

docs/guides/building_on_windows.md

@@ -123,7 +123,7 @@ pacman -S mingw-w64-ucrt-x86_64-gcc cmake git ninja pkgconf
 Additionally, you will need the following external libraries:
 
 ```
-pacman -S mingw-w64-ucrt-x86_64-libopenmpt mingw-w64-ucrt-x86_64-fluidsynth mingw-w64-ucrt-x86_64-libmad mingw-w64-ucrt-x86_64-libvorbis mingw-w64-ucrt-x86_64-libzip mingw-w64-ucrt-x86_64-portmidi mingw-w64-ucrt-x86_64-SDL2 mingw-w64-ucrt-x86_64-SDL2_image mingw-w64-ucrt-x86_64-SDL2_mixer
+pacman -S mingw-w64-ucrt-x86_64-libxmp mingw-w64-ucrt-x86_64-fluidsynth mingw-w64-ucrt-x86_64-libmad mingw-w64-ucrt-x86_64-libvorbis mingw-w64-ucrt-x86_64-libzip mingw-w64-ucrt-x86_64-portmidi mingw-w64-ucrt-x86_64-SDL2 mingw-w64-ucrt-x86_64-SDL2_image mingw-w64-ucrt-x86_64-SDL2_mixer
 ```
 
 ### Building

prboom2/CMakeLists.txt

@@ -1,5 +1,10 @@
 cmake_minimum_required(VERSION 3.9)
 
+option(WITH_XMP "Use libxmp if available" ON)
+if(WITH_XMP)
+    list(APPEND VCPKG_MANIFEST_FEATURES "libxmp")
+endif()
+
 option(WITH_FLUIDSYNTH "Use FluidSynth if available" ON)
 if(WITH_FLUIDSYNTH)
     list(APPEND VCPKG_MANIFEST_FEATURES "fluidsynth")
@@ -25,11 +30,6 @@ if(WITH_VORBISFILE)
     list(APPEND VCPKG_MANIFEST_FEATURES "libvorbis")
 endif()
 
-option(WITH_LIBOPENMPT "Use libopenmpt if available" ON)
-if(WITH_LIBOPENMPT)
-    list(APPEND VCPKG_MANIFEST_FEATURES "libopenmpt")
-endif()
-
 # Automatically install dependencies
 set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
 set(X_VCPKG_APPLOCAL_DEPS_INSTALL TRUE)
@@ -121,6 +121,20 @@ if(WITH_FLUIDSYNTH)
     endif()
 endif()
 
+if(WITH_XMP)
+    find_package(libxmp)
+    if(libxmp_FOUND)
+        set(HAVE_LIBXMP TRUE)
+        if(NOT TARGET libxmp::xmp)
+            if(TARGET libxmp::xmp_shared)
+                add_library(libxmp::xmp ALIAS libxmp::xmp_shared)
+            else()
+                add_library(libxmp::xmp ALIAS libxmp::xmp_static)
+            endif()
+        endif()
+    endif()
+endif()
+
 if(WITH_VORBISFILE)
     find_package(Vorbis COMPONENTS File)
     if(Vorbis_File_FOUND)
@@ -135,13 +149,6 @@ if(WITH_PORTMIDI)
     endif()
 endif()
 
-if(WITH_LIBOPENMPT)
-    find_package(libopenmpt)
-    if(libopenmpt_FOUND)
-        set(HAVE_LIBOPENMPT TRUE)
-    endif()
-endif()
-
 if(WIN32)
     set(DEFAULT_WAD_DIR ".")
 else()

prboom2/INSTALL

@@ -9,7 +9,7 @@ Prerequisites
      * FluidSynth (MIDI)
      * PortMidi (MIDI)
      * MAD (MP3)
-     * libopenmpt (various tracker-style formats)
+     * libxmp (various tracker-style formats)
      * vorbisfile (OGG)
 
 You will need `cmake` and `make` if you haven't already installed them.
@@ -18,13 +18,13 @@ On a typical Debian or Ubuntu system, these commands may be sufficient:
 `sudo apt install build-essential cmake git`
 
 As well as the following:
-`sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libfluidsynth-dev libportmidi-dev libmad0-dev libopenmpt-dev libvorbis-dev libzip-dev zipcmp zipmerge ziptool fluidsynth libglu1-mesa-dev`
+`sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libfluidsynth-dev libportmidi-dev libmad0-dev libxmp-dev libvorbis-dev libzip-dev zipcmp zipmerge ziptool fluidsynth libglu1-mesa-dev`
 
 On a typical Fedora system, these commands may be sufficient:
 `dnf install cmake git gcc gcc-g++`
 
 As well as the following:
-`sudo dnf install SDL2_mixer-devel SDL2_image-devel mesa-libGLU-devel libzip-devel libzip-tools zlib-static libvorbis-devel libmad-devel libopenmpt-devel portmidi-devel fluidsynth-devel`
+`sudo dnf install SDL2_mixer-devel SDL2_image-devel mesa-libGLU-devel libzip-devel libzip-tools zlib-static libvorbis-devel libmad-devel libxmp-devel portmidi-devel fluidsynth-devel`
 
 2. Clone the repository and navigate to the directory containing the DSDA-Doom distribution (the directory this file is in, prboom2).
 `git clone https://github.com/kraflab/dsda-doom.git`

prboom2/cmake/Findlibopenmpt.cmake

@@ -0,0 +1,30 @@
+# Variables defined:
+#  libxmp_FOUND
+#  libxmp_INCLUDE_DIR
+#  libxmp_LIBRARY
+
+find_package(PkgConfig QUIET)
+pkg_check_modules(PC_libxmp QUIET libxmp)
+
+find_library(libxmp_LIBRARY
+    NAMES xmp
+    HINTS "${PC_libxmp_LIBDIR}")
+
+find_path(libxmp_INCLUDE_DIR
+    NAMES xmp.h
+    HINTS "${PC_libxmp_INCLUDEDIR}")
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(libxmp
+    REQUIRED_VARS libxmp_LIBRARY libxmp_INCLUDE_DIR)
+
+if(libxmp_FOUND)
+    if(NOT TARGET libxmp::xmp)
+        add_library(libxmp::xmp UNKNOWN IMPORTED)
+        set_target_properties(libxmp::xmp PROPERTIES
+            IMPORTED_LOCATION "${libxmp_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${libxmp_INCLUDE_DIR}")
+    endif()
+endif()
+
+mark_as_advanced(libxmp_LIBRARY libxmp_INCLUDE_DIR)

prboom2/cmake/Findlibxmp.cmake

@@ -26,9 +26,9 @@
 
 #cmakedefine HAVE_LIBMAD
 #cmakedefine HAVE_LIBFLUIDSYNTH
+#cmakedefine HAVE_LIBXMP
 #cmakedefine HAVE_LIBVORBISFILE
 #cmakedefine HAVE_LIBPORTMIDI
-#cmakedefine HAVE_LIBOPENMPT
 #cmakedefine HAVE_SNDFILE_MPEG
 
 #cmakedefine SIMPLECHECKS

prboom2/cmake/config.h.cin

@@ -454,6 +454,8 @@ set(SDLDOOM_SOURCES
 )
 
 set(DOOMMUSIC_SOURCES
+    MUSIC/xmpplayer.c
+    MUSIC/xmpplayer.h
     MUSIC/flplayer.c
     MUSIC/flplayer.h
     MUSIC/madplayer.c
@@ -473,8 +475,6 @@ set(DOOMMUSIC_SOURCES
     MUSIC/portmidiplayer.h
     MUSIC/vorbisplayer.c
     MUSIC/vorbisplayer.h
-    MUSIC/libopenmptplayer.c
-    MUSIC/libopenmptplayer.h
 )
 
 set(EXTRA_FILES
@@ -575,6 +575,10 @@ function(AddGameExecutable TARGET SOURCES)
         target_link_libraries(${TARGET} PRIVATE FluidSynth::libfluidsynth)
     endif()
 
+    if(HAVE_LIBXMP)
+        target_link_libraries(${TARGET} PRIVATE libxmp::xmp)
+    endif()
+
     if(HAVE_LIBVORBISFILE)
         target_link_libraries(${TARGET} PRIVATE Vorbis::vorbisfile)
     endif()
@@ -583,10 +587,6 @@ function(AddGameExecutable TARGET SOURCES)
         target_link_libraries(${TARGET} PRIVATE PortMidi::portmidi)
     endif()
 
-    if(HAVE_LIBOPENMPT)
-        target_link_libraries(${TARGET} PRIVATE libopenmpt::libopenmpt)
-    endif()
-
     add_dependencies(${TARGET} dsda-doom-wad)
 
     if(MSVC)