SoundManager.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.sound;
 
import com.realtime.crossfire.jxclient.guistate.ClientSocketState;
import com.realtime.crossfire.jxclient.guistate.GuiStateListener;
import com.realtime.crossfire.jxclient.guistate.GuiStateManager;
import com.realtime.crossfire.jxclient.util.DebugWriter;
import java.util.Collection;
import java.util.EnumSet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class SoundManager {
 
    @NotNull
    private final ClipManager clipManager;
 
    @Nullable
    private final DebugWriter debugSound;
 
    @NotNull
    private final MusicManager musicManager;
 
    private boolean musicEnabled;
 
    private boolean effectsEnabled;
 
    @NotNull
    private final Collection<Sounds> mutedSounds = EnumSet.allOf(Sounds.class);
 
    @NotNull
    private final SoundTaskExecutor soundTaskExecutor = new SoundTaskExecutor();
 
    @NotNull
    @SuppressWarnings("FieldCanBeLocal")
    private final GuiStateListener guiStateListener = new GuiStateListener() {
 
        @Override
        public void start() {
            muteMusic(true);
            mute(Sounds.CHARACTER, true);
        }
 
        @Override
        public void metaserver() {
            muteMusic(true);
            mute(Sounds.CHARACTER, true);
        }
 
        @Override
        public void preConnecting(@NotNull final String serverInfo) {
            // ignore
        }
 
        @Override
        public void connecting(@NotNull final String serverInfo) {
            muteMusic(true);
            mute(Sounds.CHARACTER, true);
        }
 
        @Override
        public void connecting(@NotNull final ClientSocketState clientSocketState, @NotNull final String param) {
            // ignore
        }
 
        @Override
        public void connected() {
            muteMusic(false);
            mute(Sounds.CHARACTER, false);
        }
 
        @Override
        public void connectFailed(@NotNull final String reason) {
            // ignore
        }
 
    };
 
    public SoundManager(@NotNull final GuiStateManager guiStateManager, @Nullable final DebugWriter debugSound) {
        final AudioFileLoader audioFileLoader = new AudioFileLoader(debugSound);
        clipManager = new ClipManager(audioFileLoader, debugSound, soundTaskExecutor);
        musicManager = new MusicManager(audioFileLoader, debugSound);
        this.debugSound = debugSound;
        guiStateManager.addGuiStateListener(guiStateListener);
    }
 
    public void start() {
        soundTaskExecutor.start();
    }
 
    public void setMusicEnabled(final boolean enabled) {
        if (musicEnabled == enabled) {
            return;
        }
 
        musicEnabled = enabled;
        soundTaskExecutor.execute(() -> musicManager.setEnabled(musicEnabled));
    }
 
    public void setEffectsEnabled(final boolean enabled) {
        if (effectsEnabled == enabled) {
            return;
        }
 
        effectsEnabled = enabled;
    }
 
    public void playClip(@NotNull final Sounds type, @NotNull final CharSequence action) {
        if (!effectsEnabled) {
            if (debugSound != null) {
                debugSound.debugProtocolWrite("playClip(type="+type+", action="+action+"): sound is muted");
            }
            return;
        }
 
        if (mutedSounds.contains(type)) {
            if (debugSound != null) {
                debugSound.debugProtocolWrite("playClip(type="+type+", action="+action+"): sound type is muted");
            }
            return;
        }
 
        if (debugSound != null) {
            debugSound.debugProtocolWrite("playClip(type="+type+", action="+action+")");
        }
        clipManager.play(action);
    }
 
    private void mute(@NotNull final Sounds type, final boolean mute) {
        if (mute) {
            mutedSounds.add(type);
        } else {
            mutedSounds.remove(type);
            // XXX: stop running sounds of type
        }
    }
 
    public void playMusic(@Nullable final CharSequence name) {
        soundTaskExecutor.execute(() -> musicManager.play(name));
    }
 
    private void muteMusic(final boolean muted) {
        soundTaskExecutor.execute(() -> musicManager.setMuted(muted));
    }
 
    public void shutdown() throws InterruptedException {
        if (debugSound != null) {
            debugSound.debugProtocolWrite("shutdown");
        }
        soundTaskExecutor.executeAndWait(musicManager::shutdown);
        clipManager.shutdown();
    }
 
}