Audio.java

package sidplay.audio;

import libsidplay.config.IAudioSection;
import libsidplay.sidtune.AudioTune;
import libsidplay.sidtune.SidTune;

import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;

import static java.util.Arrays.asList;
import static java.util.stream.Collectors.toList;

/**
 * Audio output.
 *
 * @author ken
 *
 */
public enum Audio implements AudioDriverFactory {
    /**
     * Java Sound API.
     */
    SOUNDCARD("sidplay.audio.JavaSound"),
    /**
     * WAV file write.
     */
    WAV("sidplay.audio.WAVDriver$WAVFileDriver"),
    /**
     * WAV file write (Java version).
     */
    JWAV("sidplay.audio.JWAVDriver$JWAVFileDriver"),
    /**
     * FLAC file write.
     */
    FLAC("sidplay.audio.FLACDriver$FLACFileDriver"),
    /**
     * AAC file write.
     */
    AAC("sidplay.audio.AACDriver$AACFileDriver"),
    /**
     * MP3 file write.
     */
    MP3("sidplay.audio.MP3Driver$MP3FileDriver"),
    /**
     * MP3 file write (Java version).
     */
    JMP3("sidplay.audio.JMP3Driver$JMP3FileDriver"),
    /**
     * FLV file write
     */
    FLV("sidplay.audio.FLVDriver$FLVFileDriver"),
    /**
     * AVI file write.
     */
    AVI("sidplay.audio.AVIDriver$AVIFileDriver"),
    /**
     * MP4 file write.
     */
    MP4("sidplay.audio.MP4Driver$MP4FileDriver"),
    /**
     * SID register writes file write.
     */
    SID_REG("sidplay.audio.SIDRegDriver$SIDRegFileDriver"),
    /**
     * SID dump file write.
     */
    SID_DUMP("sidplay.audio.SIDDumpDriver$SIDDumpFileDriver"),
    /**
     * Java Sound API plus WAV file write.
     */
    LIVE_WAV("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.WAVDriver$WAVFileDriver"),
    /**
     * Java Sound API plus WAV file write (java version).
     */
    LIVE_JWAV("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.JWAVDriver$JWAVFileDriver"),
    /**
     * Java Sound API plus FLAC file write.
     */
    LIVE_FLAC("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.FLACDriver$FLACFileDriver"),
    /**
     * Java Sound API plus AAC file write.
     */
    LIVE_AAC("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.AACDriver$AACFileDriver"),
    /**
     * Java Sound API plus MP3 file write.
     */
    LIVE_MP3("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.MP3Driver$MP3FileDriver"),
    /**
     * Java Sound API plus MP3 file write (java version).
     */
    LIVE_JMP3("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.JMP3Driver$JMP3FileDriver"),
    /**
     * Java Sound API plus FLV file write.
     */
    LIVE_FLV("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.FLVDriver$FLVFileDriver"),
    /**
     * Java Sound API plus AVI file write.
     */
    LIVE_AVI("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.AVIDriver$AVIFileDriver"),
    /**
     * Java Sound API plus MP4 file write.
     */
    LIVE_MP4("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.MP4Driver$MP4FileDriver"),
    /**
     * Java Sound API plus FLV live video upload.
     */
    LIVE_VIDEO_STREAMING("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.FLVDriver$FLVStreamDriver"),
    /**
     * Java Sound API plus SID register writes file write.
     */
    LIVE_SID_REG("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.SIDRegDriver$SIDRegFileDriver"),
    /**
     * Java Sound API plus SID dump file write.
     */
    LIVE_SID_DUMP("sidplay.audio.ProxyDriver", "sidplay.audio.JavaSound", "sidplay.audio.SIDDumpDriver$SIDDumpFileDriver"),
    /**
     * Java Sound API plus MP3 recording comparison.
     */
    COMPARE_MP3("sidplay.audio.CmpToMP3FileDriver");

    private final String audioDriverClassName;
    private final String[] parameterClassNames;

    /**
     * Create audio output using the audio driver
     *
     * @param audioDriverClassName audio driver class, resolved only when selected
     * @param parameters           parameters of audio driver class
     */
    Audio(String audioDriverClassName, String... parameters) {
        this.audioDriverClassName = audioDriverClassName;
        this.parameterClassNames = parameters;
    }

    /**
     * Create a fresh audio driver.
     * <p>
     * <B>Note:</B> Audio drivers are instantiated at runtime on demand. We do not
     * want to load unused libraries like jump3r, if not required!<BR>
     *
     * @return audio driver
     */
    public final AudioDriver getAudioDriver() {
        return newAudioDriver();
    }

    public final AudioDriver newAudioDriver() {
        try {
            Class<? extends AudioDriver> audioDriverClass = Class.forName(audioDriverClassName)
                    .asSubclass(AudioDriver.class);
            Class<?>[] parameterTypes = Stream.<Class<?>>generate(() -> AudioDriver.class)
                    .limit(parameterClassNames.length).toArray(Class<?>[]::new);
            Collection<Object> initArgs = new ArrayList<>();
            for (String parameterClassName : parameterClassNames) {
                Class<? extends AudioDriver> parameterClass = Class.forName(parameterClassName)
                        .asSubclass(AudioDriver.class);
                initArgs.add(parameterClass.getConstructor().newInstance());
            }
            return audioDriverClass.getConstructor(parameterTypes).newInstance(initArgs.toArray());
        } catch (ClassNotFoundException e) {
            throw new UnsupportedOperationException("Audio driver is not included: " + audioDriverClassName, e);
        } catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
                 | NoSuchMethodException | SecurityException e) {
            throw new RuntimeException("Audio driver cannot be instantiated: " + audioDriverClassName, e);
        }
    }

    /**
     * Get audio driver for tune.<BR>
     * <B>Note:</B>Use MP3 comparison driver for MP3 play-back.
     *
     * @param audioSection configuration
     * @param tune         SID tune
     */
    public final AudioDriver getAudioDriver(final IAudioSection audioSection, final SidTune tune) {
        return create(audioSection, tune);
    }

    @Override
    public final AudioDriver create(final IAudioSection audioSection, final SidTune tune) {
        if (tune instanceof AudioTune audioTune) {
            audioSection.setMp3(audioTune.getAudioFile());
            audioSection.setPlayOriginal(true);
            return COMPARE_MP3.getAudioDriver();
        }
        return getAudioDriver();
    }

    public static List<Audio> getLiveAudio() {
        return Stream.of(values()).filter(audio -> asList("sidplay.audio.JavaSound", "sidplay.audio.ProxyDriver",
                "sidplay.audio.CmpToMP3FileDriver").contains(audio.audioDriverClassName)).collect(toList());
    }
}