Merge pull request #2152 from pygame-community/starbuck5-tracker-music

Fixes for tracker music support, add test

Author: MyreMylar

buildconfig/download_win_prebuilt.py

@@ -90,8 +90,8 @@ def get_urls(x86=True, x64=True):
         'dee48e9c5184c139aa8bcab34a937d1b3df4f503'
         ],
         [
-        'https://github.com/libsdl-org/SDL_mixer/releases/download/release-2.6.3/SDL2_mixer-devel-2.6.3-VC.zip',
-        '4e8d47098446d58fbedbe4a741cec9acedcc4957',
+        'https://github.com/libsdl-org/SDL_mixer/releases/download/release-2.6.2/SDL2_mixer-devel-2.6.2-VC.zip',
+        '000e3ea8a50261d46dbd200fb450b93c59ed4482',
         ],
     ])
     if x86:
@@ -212,12 +212,12 @@ def copy(src, dst):
         copy(
             os.path.join(
                 temp_dir,
-                'SDL2_mixer-devel-2.6.3-VC/SDL2_mixer-2.6.3'
+                'SDL2_mixer-devel-2.6.2-VC/SDL2_mixer-2.6.2'
             ),
             os.path.join(
                 move_to_dir,
                 prebuilt_dir,
-                'SDL2_mixer-2.6.3'
+                'SDL2_mixer-2.6.2'
             )
         )
         copy(

buildconfig/manylinux-build/docker_base/sdl_libs/build-sdl2-libs.sh

@@ -6,7 +6,7 @@ cd $(dirname `readlink -f "$0"`)
 SDL2="SDL2-2.26.4"
 IMG2="SDL2_image-2.0.5"
 TTF2="SDL2_ttf-2.20.2"
-MIX2="SDL2_mixer-2.6.3"
+MIX2="SDL2_mixer-2.6.2"
 
 
 # Download
@@ -115,7 +115,8 @@ cd $MIX2
       --disable-music-ogg-vorbis-shared \
       --disable-music-ogg-tremor-shared \
       --disable-music-flac-libflac-shared \
-      --disable-music-mp3-mpg123-shared
+      --disable-music-mp3-mpg123-shared \
+      --disable-music-mod-modplug-shared
 
 make
 make install

buildconfig/manylinux-build/docker_base/sdl_libs/sdl2.sha512

@@ -1,4 +1,4 @@
 138f52a23d796803c450722c8a4db8226214522e99f1e5ae657e2b28eb45abf0c81c9c3df9ab16f1a07d59722ed9415d64dd04332ff040cdfbbc0329f0d05ce4  SDL2-2.26.4.tar.gz
 77e743d3f32707e015b290c1379ae3c7d7a3fe265995713267f0d0ec6517de4808f0de9890b5ab28445941af5bc9fbff346620629e0d7d7e9f365262cab05ee7  SDL2_image-2.0.5.tar.gz
-2e9da045d2fdab97236c3901b3d441834a67a47c8851ddfb817c9db6f23ed9fb355a5ef8d2158d0c9959a83934e8cd1b95db8a69eaddf8f7fcca115f01818740  SDL2_mixer-2.6.3.tar.gz
+16baa9d8b345bf0224538cbfb2ae9fc5d3deea2b454f41a98006c938fe7a65d5a8c84e28a76f98a4dd971c4fe5cf0219d8bf73331cf11f2702e01600eb197658  SDL2_mixer-2.6.2.tar.gz
 b54e93b100712e3764cd80d4e4b16cd4c2a6853620f675941a4214320b0ee29a583d57ad56cd5fdb5c7a32d7615cbf43bc3fa55337b01623cee7219ebb43667c  SDL2_ttf-2.20.2.tar.gz

examples/data/attributions.txt

@@ -0,0 +1,3 @@
+surfonasinewave.xm:
+By FearofDark
+https://modarchive.org/index.php?request=view_by_moduleid&query=169104

examples/data/surfonasinewave.xm

@@ -26,20 +26,24 @@ def setUp(cls):
 
     def test_load_mp3(self):
         "|tags:music|"
-        self.music_load("mp3")
+        self.music_load("house_lo.mp3")
 
     def test_load_ogg(self):
         "|tags:music|"
-        self.music_load("ogg")
+        self.music_load("house_lo.ogg")
 
     def test_load_wav(self):
         "|tags:music|"
-        self.music_load("wav")
+        self.music_load("house_lo.wav")
 
-    def music_load(self, format):
+    def test_load_xm(self):
+        "|tags:music|"
+        self.music_load("surfonasinewave.xm")
+
+    def music_load(self, filename):
         data_fname = example_path("data")
 
-        path = os.path.join(data_fname, f"house_lo.{format}")
+        path = os.path.join(data_fname, filename)
         if os.sep == "\\":
             path = path.replace("\\", "\\\\")
         umusfn = str(path)
@@ -50,10 +54,10 @@ def music_load(self, format):
 
     def test_load_object(self):
         """test loading music from file-like objects."""
-        formats = ["ogg", "wav"]
+        filenames = ["house_lo.ogg", "house_lo.wav", "surfonasinewave.xm"]
         data_fname = example_path("data")
-        for f in formats:
-            path = os.path.join(data_fname, f"house_lo.{f}")
+        for file in filenames:
+            path = os.path.join(data_fname, file)
             if os.sep == "\\":
                 path = path.replace("\\", "\\\\")
             bmusfn = path.encode()
@@ -63,26 +67,28 @@ def test_load_object(self):
 
     def test_object_namehint(self):
         """test loading & queuing music from file-like objects with namehint argument."""
-        formats = ["wav", "ogg"]
+        filenames = ["house_lo.ogg", "house_lo.wav", "surfonasinewave.xm"]
         data_fname = example_path("data")
-        for f in formats:
-            path = os.path.join(data_fname, f"house_lo.{f}")
+        for file in filenames:
+            path = os.path.join(data_fname, file)
             if os.sep == "\\":
                 path = path.replace("\\", "\\\\")
             bmusfn = path.encode()
 
+            *_, format = file.split(".")
+
             # these two "with open" blocks need to be separate, which is kinda weird
             with open(bmusfn, "rb") as musf:
-                pygame.mixer.music.load(musf, f)
+                pygame.mixer.music.load(musf, format)
 
             with open(bmusfn, "rb") as musf:
-                pygame.mixer.music.queue(musf, f)
+                pygame.mixer.music.queue(musf, format)
 
             with open(bmusfn, "rb") as musf:
-                pygame.mixer.music.load(musf, namehint=f)
+                pygame.mixer.music.load(musf, namehint=format)
 
             with open(bmusfn, "rb") as musf:
-                pygame.mixer.music.queue(musf, namehint=f)
+                pygame.mixer.music.queue(musf, namehint=format)
 
     def test_load_unicode(self):
         """test non-ASCII unicode path"""
@@ -143,6 +149,14 @@ def test_queue_wav(self):
         filename = example_path(os.path.join("data", "house_lo.wav"))
         pygame.mixer.music.queue(filename)
 
+    def test_queue_xm(self):
+        """Ensures queue() accepts xm files (tracker music files).
+
+        |tags:music|
+        """
+        filename = example_path(os.path.join("data", "surfonasinewave.xm"))
+        pygame.mixer.music.queue(filename)
+
     def test_queue__multiple_calls(self):
         """Ensures queue() can be called multiple times."""
         ogg_file = example_path(os.path.join("data", "house_lo.ogg"))
@@ -358,7 +372,7 @@ def test_get_busy(self):
         # music is idle this returns False.
         #
 
-        self.music_load("ogg")
+        self.music_load("house_lo.ogg")
         self.assertFalse(pygame.mixer.music.get_busy())
         pygame.mixer.music.play()
         self.assertTrue(pygame.mixer.music.get_busy())