fixed a bug that causes audio service to not load properly on embedded devices

AlmasB · AlmasB · commit 842b079b2850 · 2021-07-28T17:35:52.000+01:00
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/AudioPlayer.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/AudioPlayer.kt
@@ -189,7 +189,7 @@ class AudioPlayer : EngineService() {
         stopAllMusic()
     }
 
-    fun loadAudio(audioType: AudioType, url: URL, isDesktop: Boolean): Audio {
-        return loader.loadAudio(audioType, url, isDesktop)
+    fun loadAudio(audioType: AudioType, url: URL, isMobile: Boolean): Audio {
+        return loader.loadAudio(audioType, url, isMobile)
     }
 }
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/impl/AudioLoader.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/impl/AudioLoader.kt
@@ -19,9 +19,9 @@ interface AudioLoader {
      * Perform an IO operation to load an audio object from [resourceURL] as a given [type].
      * No caching is done by this method -- the IO operation will take place on each call.
      *
-     * @param isDesktop if we are loading on a desktop platform
+     * @param isMobile if we are loading on a mobile platform
      */
-    fun loadAudio(type: AudioType, resourceURL: URL, isDesktop: Boolean): Audio
+    fun loadAudio(type: AudioType, resourceURL: URL, isMobile: Boolean): Audio
 
     /**
      * Release native resources associated with [audio].
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/impl/DesktopAndMobileAudioLoader.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/audio/impl/DesktopAndMobileAudioLoader.kt
@@ -27,8 +27,8 @@ class DesktopAndMobileAudioLoader : AudioLoader {
         private val attachService by lazy { AudioService.create() }
     }
 
-    override fun loadAudio(type: AudioType, resourceURL: URL, isDesktop: Boolean): Audio {
-        if (isDesktop) {
+    override fun loadAudio(type: AudioType, resourceURL: URL, isMobile: Boolean): Audio {
+        if (!isMobile) {
             val url = resourceURL.toExternalForm()
 
             return if (type === AudioType.MUSIC) {
diff --git a/fxgl-core/src/test/kotlin/com/almasb/fxgl/audio/impl/AudioLoaderTest.kt b/fxgl-core/src/test/kotlin/com/almasb/fxgl/audio/impl/AudioLoaderTest.kt
@@ -30,7 +30,7 @@ class AudioLoaderTest {
 
     @Test
     fun `Load sound file`() {
-        val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isDesktop = true)
+        val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isMobile = false)
 
         assertThat(audio, `is`(not(getDummyAudio())))
     }
@@ -39,7 +39,7 @@ class AudioLoaderTest {
     @EnabledOnOs(OS.WINDOWS)
     @Test
     fun `Loading on mobile does not crash if Attach is not present`() {
-        val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isDesktop = false)
+        val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isMobile = true)
 
         assertThat(audio, `is`(getDummyAudio()))
     }
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt
@@ -101,8 +101,8 @@ class FXGLAssetLoaderService : AssetLoaderService() {
         }
     }
 
-    @Inject("isDesktop")
-    private var isDesktop = true
+    @Inject("isMobile")
+    private var isMobile = false
 
     @Inject("userAppClass")
     private lateinit var userAppClass: Class<*>
@@ -112,8 +112,8 @@ class FXGLAssetLoaderService : AssetLoaderService() {
     private val cachedAssets = hashMapOf<String, Any>()
 
     override fun onInit() {
-        assetData[SOUND] = SoundAssetLoader(audioService, isDesktop)
-        assetData[MUSIC] = MusicAssetLoader(audioService, isDesktop)
+        assetData[SOUND] = SoundAssetLoader(audioService, isMobile)
+        assetData[MUSIC] = MusicAssetLoader(audioService, isMobile)
 
         log.debug("User app class for loading assets: $userAppClass")
     }
@@ -674,20 +674,20 @@ private class ResizableImageAssetLoader : AssetLoader<Image>(
     override fun getDummy(): Image = getDummyImage()
 }
 
-private class SoundAssetLoader(val audioService: AudioPlayer, val isDesktop: Boolean) : AssetLoader<Sound>(
+private class SoundAssetLoader(val audioService: AudioPlayer, val isMobile: Boolean) : AssetLoader<Sound>(
         Sound::class.java,
         SOUNDS_DIR
 ) {
-    override fun load(url: URL): Sound = Sound(audioService.loadAudio(AudioType.SOUND, url, isDesktop))
+    override fun load(url: URL): Sound = Sound(audioService.loadAudio(AudioType.SOUND, url, isMobile))
 
     override fun getDummy(): Sound = Sound(getDummyAudio())
 }
 
-private class MusicAssetLoader(val audioService: AudioPlayer, val isDesktop: Boolean) : AssetLoader<Music>(
+private class MusicAssetLoader(val audioService: AudioPlayer, val isMobile: Boolean) : AssetLoader<Music>(
         Music::class.java,
         MUSIC_DIR
 ) {
-    override fun load(url: URL): Music = Music(audioService.loadAudio(AudioType.MUSIC, url, isDesktop))
+    override fun load(url: URL): Music = Music(audioService.loadAudio(AudioType.MUSIC, url, isMobile))
 
     override fun getDummy(): Music = Music(getDummyAudio())
 }

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ class AudioPlayer : EngineService() {`
`189`	`189`	`stopAllMusic()`
`190`	`190`	`}`
`191`	`191`
`192`		`- fun loadAudio(audioType: AudioType, url: URL, isDesktop: Boolean): Audio {`
`193`		`- return loader.loadAudio(audioType, url, isDesktop)`
	`192`	`+ fun loadAudio(audioType: AudioType, url: URL, isMobile: Boolean): Audio {`
	`193`	`+ return loader.loadAudio(audioType, url, isMobile)`
`194`	`194`	`}`
`195`	`195`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ class DesktopAndMobileAudioLoader : AudioLoader {`
`27`	`27`	`private val attachService by lazy { AudioService.create() }`
`28`	`28`	`}`
`29`	`29`
`30`		`- override fun loadAudio(type: AudioType, resourceURL: URL, isDesktop: Boolean): Audio {`
`31`		`- if (isDesktop) {`
	`30`	`+ override fun loadAudio(type: AudioType, resourceURL: URL, isMobile: Boolean): Audio {`
	`31`	`+ if (!isMobile) {`
`32`	`32`	`val url = resourceURL.toExternalForm()`
`33`	`33`
`34`	`34`	`return if (type === AudioType.MUSIC) {`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class AudioLoaderTest {`
`30`	`30`
`31`	`31`	`@Test`
`32`	`32`	fun `Load sound file`() {
`33`		`- val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isDesktop = true)`
	`33`	`+ val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isMobile = false)`
`34`	`34`
`35`	`35`	assertThat(audio, `is`(not(getDummyAudio())))
`36`	`36`	`}`
`@@ -39,7 +39,7 @@ class AudioLoaderTest {`
`39`	`39`	`@EnabledOnOs(OS.WINDOWS)`
`40`	`40`	`@Test`
`41`	`41`	fun `Loading on mobile does not crash if Attach is not present`() {
`42`		`- val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isDesktop = false)`
	`42`	`+ val audio = loader.loadAudio(AudioType.SOUND, javaClass.getResource("sound_effect.wav"), isMobile = true)`
`43`	`43`
`44`	`44`	assertThat(audio, `is`(getDummyAudio()))
`45`	`45`	`}`