ClipManager.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.util.DebugWriter;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletionService;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorCompletionService;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.Semaphore;
import javax.sound.sampled.DataLine;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ClipManager {
 
    @Nullable
    private final DebugWriter debugSound;
 
    @NotNull
    private final SoundTaskExecutor soundTaskExecutor;
 
    @NotNull
    private final ExecutorService executorService = Executors.newCachedThreadPool();
 
    @NotNull
    private final CompletionService<@Nullable Task> executorCompletionService = new ExecutorCompletionService<>(executorService);
 
    @NotNull
    private final ClipLoader clipLoader;
 
    @NotNull
    private final Semaphore concurrentClips = new Semaphore(8);
 
    private int nextClipId;
 
    public ClipManager(@NotNull final AudioFileLoader audioFileLoader, @Nullable final DebugWriter debugSound, @NotNull final SoundTaskExecutor soundTaskExecutor) {
        this.debugSound = debugSound;
        this.soundTaskExecutor = soundTaskExecutor;
        clipLoader = new ClipLoader(audioFileLoader, debugSound);
        executorService.execute(this::playClips);
    }
 
    public void play(@NotNull final CharSequence action) {
        if (concurrentClips.tryAcquire()) {
            final int id = nextClipId++;
            if (debugSound != null) {
                debugSound.debugProtocolWrite(id+".0 starting sound clip '"+action+"'");
            }
            executorCompletionService.submit(() -> new ClipLoadTask(id, action));
        } else if (debugSound != null) {
            debugSound.debugProtocolWrite("not playing sound clip '"+action+"' because too many sound clips are already active");
        }
    }
 
    private void playClips() {
        if (debugSound != null) {
            debugSound.debugProtocolWrite("sound clip thread started");
        }
        try {
            while (!Thread.currentThread().isInterrupted()) {
                final Future<@Nullable Task> future;
                try {
                    future = executorCompletionService.take();
                } catch (final InterruptedException ignored) {
                    Thread.currentThread().interrupt();
                    break;
                }
 
                final Task task;
                try {
                    task = future.get();
                } catch (final InterruptedException ex) {
                    Thread.currentThread().interrupt();
                    if (debugSound != null) {
                        debugSound.debugProtocolWrite("interrupted while allocating clip", ex);
                    }
                    return;
                } catch (final ExecutionException ex) {
                    if (debugSound != null) {
                        debugSound.debugProtocolWrite("failed to allocate clip", ex);
                    }
                    return;
                }
 
                if (task == null) {
                    continue;
                }
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(task+" scheduling next step");
                }
 
                executorCompletionService.submit(task.getCallable());
            }
        } finally {
            if (debugSound != null) {
                debugSound.debugProtocolWrite("sound clip thread existed");
            }
        }
    }
 
    public void shutdown() throws InterruptedException {
        soundTaskExecutor.executeAndWait(executorService::shutdownNow);
    }
 
    private interface Task {
 
        @NotNull
        Callable<@Nullable Task> getCallable();
 
    }
 
    private static abstract class AbstractTask {
 
        private final int id;
 
        private final int subId;
 
        private AbstractTask(final int id) {
            this.id = id;
            subId = 1;
        }
 
        private AbstractTask(@NotNull final AbstractTask parent) {
            id = parent.id;
            subId = parent.subId+1;
        }
 
        @NotNull
        @Override
        public String toString() {
            return id+"."+subId+"/"+getClass().getSimpleName();
        }
 
    }
 
    private class ClipLoadTask extends AbstractTask implements Task {
 
        @NotNull
        private final CharSequence action;
 
        private ClipLoadTask(final int id, @NotNull final CharSequence action) {
            super(id);
            this.action = action;
        }
 
        @NotNull
        @Override
        public Callable<@Nullable Task> getCallable() {
            return () -> {
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" loading sound clip for action="+action);
                }
                final long t0 = System.currentTimeMillis();
                final DataLine clip = clipLoader.allocateClip(action);
                if (clip == null) {
                    concurrentClips.release();
                    if (debugSound != null) {
                        debugSound.debugProtocolWrite(this+" done (could not load sound clip for action="+action+")");
                    }
                    return null;
                }
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" loading sound clip took "+(System.currentTimeMillis()-t0)+"ms");
                }
                return new ClipStartTask(this, clip);
            };
        }
 
    }
 
    private class ClipStartTask extends AbstractTask implements Task {
 
        @NotNull
        private final DataLine clip;
 
        private ClipStartTask(@NotNull final AbstractTask parent, @NotNull final DataLine clip) {
            super(parent);
            this.clip = clip;
        }
 
        @NotNull
        @Override
        public Callable<@NotNull Task> getCallable() {
            return () -> {
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" starting to play sound clip");
                }
                clip.start();
                return new ClipPlayTask(this, clip);
            };
        }
 
    }
 
    private class ClipPlayTask extends AbstractTask implements Task {
 
        @NotNull
        private final DataLine clip;
 
        private ClipPlayTask(@NotNull final AbstractTask parent, @NotNull final DataLine clip) {
            super(parent);
            this.clip = clip;
        }
 
        @NotNull
        @Override
        public Callable<@NotNull Task> getCallable() {
            return () -> {
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" waiting until sound clip has finished playing");
                }
                clip.drain();
                return new ClipStopTask(this, clip);
            };
        }
 
    }
 
    private class ClipStopTask extends AbstractTask implements Task {
 
        @NotNull
        private final DataLine clip;
 
        private ClipStopTask(@NotNull final AbstractTask parent, @NotNull final DataLine clip) {
            super(parent);
            this.clip = clip;
        }
 
        @NotNull
        @Override
        public Callable<@NotNull Task> getCallable() {
            return () -> {
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" stopping to play sound clip");
                }
                clip.stop();
                return new ClipFreeTask(this, clip);
            };
        }
 
    }
 
    private class ClipFreeTask extends AbstractTask implements Task {
 
        @NotNull
        private final DataLine clip;
 
        private ClipFreeTask(@NotNull final AbstractTask parent, @NotNull final DataLine clip) {
            super(parent);
            this.clip = clip;
        }
 
        @NotNull
        @Override
        public Callable<@Nullable Task> getCallable() {
            return () -> {
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" deallocating sound clip");
                }
                final long t0 = System.currentTimeMillis();
                clipLoader.freeClip(clip);
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" deallocating sound clip took "+(System.currentTimeMillis()-t0)+"ms");
                }
                concurrentClips.release();
                if (debugSound != null) {
                    debugSound.debugProtocolWrite(this+" done");
                }
                return null;
            };
        }
 
    }
 
}