Reworked to now use better defined generics and easier to use API. Added AudioResource to be used in changing volume

This commit is contained in:
lieght
2025-10-11 06:09:13 +02:00
parent 123ecc7d3a
commit b101734fd7
13 changed files with 119 additions and 95 deletions

View File

@@ -5,15 +5,16 @@ import org.toop.framework.audio.interfaces.MusicManager;
import org.toop.framework.audio.interfaces.SoundEffectManager;
import org.toop.framework.audio.interfaces.VolumeManager;
import org.toop.framework.eventbus.EventFlow;
import org.toop.framework.resource.types.AudioResource;
public class AudioEventListener {
private final MusicManager<?> musicManager;
private final SoundEffectManager<?> soundEffectManager;
public class AudioEventListener<T extends AudioResource, K extends AudioResource> {
private final MusicManager<T> musicManager;
private final SoundEffectManager<K> soundEffectManager;
private final VolumeManager audioVolumeManager;
public AudioEventListener(
MusicManager<?> musicManager,
SoundEffectManager<?> soundEffectManager,
MusicManager<T> musicManager,
SoundEffectManager<K> soundEffectManager,
VolumeManager audioVolumeManager
) {
this.musicManager = musicManager;

View File

@@ -1,10 +1,8 @@
package org.toop.framework.audio;
import javafx.scene.media.MediaPlayer;
import javax.sound.sampled.Clip;
import javax.sound.sampled.FloatControl;
import org.toop.framework.audio.interfaces.AudioManager;
import org.toop.framework.audio.interfaces.VolumeManager;
import org.toop.framework.resource.types.AudioResource;
public class AudioVolumeManager implements VolumeManager {
private double volume = 0.0;
@@ -13,54 +11,39 @@ public class AudioVolumeManager implements VolumeManager {
public AudioVolumeManager() {}
private <T extends MediaPlayer> void updateMusicVolume(T mediaPlayer) {
mediaPlayer.setVolume(this.musicVolume * this.volume);
}
private <T extends Clip> void updateSoundEffectVolume(T clip) {
if (clip.isControlSupported(FloatControl.Type.MASTER_GAIN)) {
FloatControl volumeControl =
(FloatControl) clip.getControl(FloatControl.Type.MASTER_GAIN);
float min = volumeControl.getMinimum();
float max = volumeControl.getMaximum();
float dB =
(float)
(Math.log10(Math.max(this.fxVolume * this.volume, 0.0001))
* 20.0); // convert linear to dB
dB = Math.max(min, Math.min(max, dB));
volumeControl.setValue(dB);
}
private <T extends AudioResource> void updateVolume(T resource, double level) {
resource.updateVolume(level);
}
private double limitVolume(double volume) {
if (volume > 1.0) return 1.0;
else return Math.max(volume, 0.0);
return Math.min(1.0, Math.max(0.0, volume / 100));
}
@Override
public void setVolume(double newVolume, AudioManager<?> sm, AudioManager<?> mm) {
this.volume = limitVolume(newVolume / 100);
for (var clip : sm.getActiveAudio()) {
this.updateSoundEffectVolume((Clip) clip);
public <T extends AudioResource, K extends AudioResource> void setVolume(
double newVolume, AudioManager<T> sm, AudioManager<K> mm) {
this.volume = limitVolume(newVolume);
for (T clip : sm.getActiveAudio()) {
this.updateVolume(clip, fxVolume * volume);
}
for (var mediaPlayer : mm.getActiveAudio()) {
this.updateMusicVolume((MediaPlayer) mediaPlayer);
for (K mediaPlayer : mm.getActiveAudio()) {
this.updateVolume(mediaPlayer, musicVolume * volume);
}
}
@Override
public void setFxVolume(double newVolume, AudioManager<?> sm) {
this.fxVolume = limitVolume(newVolume / 100);
for (var clip : sm.getActiveAudio()) {
this.updateSoundEffectVolume((Clip) clip); // TODO: What if not clip
public <T extends AudioResource> void setFxVolume(double newVolume, AudioManager<T> sm) {
this.fxVolume = limitVolume(newVolume);
for (T clip : sm.getActiveAudio()) {
this.updateVolume(clip, fxVolume * volume);
}
}
@Override
public void setMusicVolume(double newVolume, AudioManager<?> mm) {
this.musicVolume = limitVolume(newVolume / 100);
for (var mediaPlayer : mm.getActiveAudio()) {
this.updateMusicVolume((MediaPlayer) mediaPlayer); // TODO; What if not MediaPlayer
public <T extends AudioResource> void setMusicVolume(double newVolume, AudioManager<T> mm) {
this.musicVolume = limitVolume(newVolume);
for (T mediaPlayer : mm.getActiveAudio()) {
this.updateVolume(mediaPlayer, musicVolume * volume);
}
}

View File

@@ -1,7 +1,5 @@
package org.toop.framework.audio;
import javafx.scene.media.MediaPlayer;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.toop.framework.resource.ResourceManager;
@@ -9,35 +7,34 @@ import org.toop.framework.resource.resources.MusicAsset;
import java.util.*;
public class MusicManager implements org.toop.framework.audio.interfaces.MusicManager<MediaPlayer> {
public class MusicManager implements org.toop.framework.audio.interfaces.MusicManager<MusicAsset> {
private static final Logger logger = LogManager.getLogger(MusicManager.class);
// private final List<MusicAsset> musicAssets = new ArrayList<>(); // TODO
private final List<MediaPlayer> backgroundMusic = new LinkedList<>();
private final List<MusicAsset> backgroundMusic = new LinkedList<>();
private int playingIndex = 0;
private boolean playing = false;
public MusicManager() {}
@Override
public Collection<MediaPlayer> getActiveAudio() {
public Collection<MusicAsset> getActiveAudio() {
return backgroundMusic;
}
private void addBackgroundMusic(MusicAsset musicAsset) {
backgroundMusic.add(new MediaPlayer(musicAsset.getMedia()));
backgroundMusic.add(musicAsset);
}
private void addBackgroundMusic(MediaPlayer mediaPlayer) {
backgroundMusic.add(mediaPlayer);
}
public void play() { // TODO maybe remove VolumeManager from input
public void play() {
if (playing) {
logger.warn("MusicManager is already playing.");
return;
}
backgroundMusic.clear();
List<MediaPlayer> shuffledArray =
List<MusicAsset> shuffledArray =
new ArrayList<>(
ResourceManager.getAllOfType(MusicAsset.class).stream()
.map(ma ->
initMediaPlayer(new MediaPlayer(ma.getResource().getMedia())))
initMediaPlayer(ma.getResource()))
.toList());
Collections.shuffle(shuffledArray);
backgroundMusic.addAll(shuffledArray);
@@ -50,35 +47,35 @@ public class MusicManager implements org.toop.framework.audio.interfaces.MusicMa
playingIndex = 0;
}
MediaPlayer ma = backgroundMusic.get(playingIndex);
MusicAsset ma = backgroundMusic.get(playingIndex);
if (ma == null) {
logger.error("Background music player is null. Queue: {}",
backgroundMusic.stream().map(e -> e.getMedia().getSource()));
backgroundMusic.stream().map(e -> e.getMediaPlayer().getMedia().getSource()));
return;
}
logger.info("Background music player is playing: {}", ma.getMedia().getSource()); //TODO shorten to name
ma.play();
logger.info("Background music player is playing: {}", ma.getMediaPlayer().getMedia().getSource()); //TODO shorten to name
ma.getMediaPlayer().play();
this.playing = true;
}
private MediaPlayer initMediaPlayer(MediaPlayer mediaPlayer) {
mediaPlayer.setOnEndOfMedia(mediaPlayer::stop);
private MusicAsset initMediaPlayer(MusicAsset ma) {
ma.getMediaPlayer().setOnEndOfMedia(() -> ma.getMediaPlayer().stop());
mediaPlayer.setOnError( () -> {
logger.error("Error playing music: {}", mediaPlayer.getMedia().getSource());
backgroundMusic.remove(mediaPlayer);
mediaPlayer.stop();
ma.getMediaPlayer().setOnError( () -> {
logger.error("Error playing music: {}", ma.getMediaPlayer().getError()); // TODO
backgroundMusic.remove(ma);
ma.getMediaPlayer().stop();
});
mediaPlayer.setOnStopped( () -> {
mediaPlayer.stop();
ma.getMediaPlayer().setOnStopped( () -> {
ma.getMediaPlayer().stop();
playingIndex++;
this.playing = false;
backgroundMusicPlayer();
});
return mediaPlayer;
return ma;
}
}

View File

@@ -2,18 +2,17 @@ package org.toop.framework.audio;
import org.toop.framework.resource.resources.SoundEffectAsset;
import javax.sound.sampled.Clip;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
public class SoundEffectManager implements org.toop.framework.audio.interfaces.SoundEffectManager<Clip> {
private final Map<Long, Clip> activeSoundEffects = new HashMap<>();
public class SoundEffectManager implements org.toop.framework.audio.interfaces.SoundEffectManager<SoundEffectAsset> {
private final Map<Long, SoundEffectAsset> activeSoundEffects = new HashMap<>();
private final HashMap<String, SoundEffectAsset> audioResources = new HashMap<>();
public Collection<Clip> getActiveAudio() {
return this.activeSoundEffects.values();
@Override
public Collection<SoundEffectAsset> getActiveAudio() {
return this.audioResources.values();
}
@Override

View File

@@ -1,5 +1,7 @@
package org.toop.framework.audio.interfaces;
public interface MusicManager<T> extends AudioManager<T> {
import org.toop.framework.resource.types.AudioResource;
public interface MusicManager<T extends AudioResource> extends AudioManager<T> {
void play();
}

View File

@@ -1,6 +1,9 @@
package org.toop.framework.audio.interfaces;
public interface SoundEffectManager<T> extends AudioManager<T> {
import org.toop.framework.resource.resources.SoundEffectAsset;
import org.toop.framework.resource.types.AudioResource;
public interface SoundEffectManager<T extends AudioResource> extends AudioManager<T> {
void play(String name, boolean loop);
void stop(long clipId);
}

View File

@@ -1,9 +1,11 @@
package org.toop.framework.audio.interfaces;
import org.toop.framework.resource.types.AudioResource;
public interface VolumeManager {
void setVolume(double newVolume, AudioManager<?> sm, AudioManager<?> mm);
void setFxVolume(double newVolume, AudioManager<?> sm);
void setMusicVolume(double newVolume, AudioManager<?> mm);
<T extends AudioResource, K extends AudioResource> void setVolume(double newVolume, AudioManager<T> sm, AudioManager<K> mm);
<T extends AudioResource> void setFxVolume(double newVolume, AudioManager<T> sm);
<T extends AudioResource> void setMusicVolume(double newVolume, AudioManager<T> mm);
double getVolume();
double getFxVolume();
double getMusicVolume();

View File

@@ -2,33 +2,39 @@ package org.toop.framework.resource.resources;
import java.io.*;
import javafx.scene.media.Media;
import javafx.scene.media.MediaPlayer;
import org.toop.framework.resource.types.AudioResource;
import org.toop.framework.resource.types.FileExtension;
import org.toop.framework.resource.types.LoadableResource;
@FileExtension({"mp3"})
public class MusicAsset extends BaseResource implements LoadableResource {
private Media media;
public class MusicAsset extends BaseResource implements LoadableResource, AudioResource {
private MediaPlayer mediaPlayer;
public MusicAsset(final File audioFile) {
super(audioFile);
}
public Media getMedia() {
if (media == null) {
media = new Media(file.toURI().toString());
}
return media;
public MediaPlayer getMediaPlayer() {
load();
return mediaPlayer;
}
@Override
public void load() {
if (media == null) media = new Media(file.toURI().toString());
if (mediaPlayer == null) {
mediaPlayer = new MediaPlayer(new Media(file.toURI().toString()));
}
this.isLoaded = true;
}
@Override
public void unload() {
media = null;
if (mediaPlayer != null) {
mediaPlayer.stop();
mediaPlayer.dispose();
mediaPlayer = null;
}
isLoaded = false;
}
@@ -36,4 +42,11 @@ public class MusicAsset extends BaseResource implements LoadableResource {
public boolean isLoaded() {
return isLoaded;
}
@Override
public void updateVolume(double volume) {
if (mediaPlayer != null) {
mediaPlayer.setVolume(volume);
}
}
}

View File

@@ -3,12 +3,15 @@ package org.toop.framework.resource.resources;
import java.io.*;
import java.nio.file.Files;
import javax.sound.sampled.*;
import org.toop.framework.resource.types.AudioResource;
import org.toop.framework.resource.types.FileExtension;
import org.toop.framework.resource.types.LoadableResource;
@FileExtension({"wav"})
public class SoundEffectAsset extends BaseResource implements LoadableResource {
public class SoundEffectAsset extends BaseResource implements LoadableResource, AudioResource {
private byte[] rawData;
private Clip clip = null;
public SoundEffectAsset(final File audioFile) {
super(audioFile);
@@ -27,6 +30,7 @@ public class SoundEffectAsset extends BaseResource implements LoadableResource {
inputStream = downSampleAudio(inputStream, baseFormat);
clip.open(
inputStream); // ^ Clip can only run 16 bit and lower, thus downsampling necessary.
this.clip = clip;
return clip;
}
@@ -77,4 +81,22 @@ public class SoundEffectAsset extends BaseResource implements LoadableResource {
public boolean isLoaded() {
return this.isLoaded;
}
@Override
public void updateVolume(double volume) {
{
if (clip.isControlSupported(FloatControl.Type.MASTER_GAIN)) {
FloatControl volumeControl =
(FloatControl) clip.getControl(FloatControl.Type.MASTER_GAIN);
float min = volumeControl.getMinimum();
float max = volumeControl.getMaximum();
float dB =
(float)
(Math.log10(Math.max(volume, 0.0001))
* 20.0); // convert linear to dB
dB = Math.max(min, Math.min(max, dB));
volumeControl.setValue(dB);
}
}
}
}

View File

@@ -0,0 +1,6 @@
package org.toop.framework.resource.types;
public interface AudioResource {
void updateVolume(double volume);
// TODO play and stop
}