JSIDPlay2TeaVM.java

package client.teavm;

import client.teavm.common.ExportedApi;
import client.teavm.common.IExportedApi;
import client.teavm.common.MainArgs;
import client.teavm.common.autoplay.KeyEventType;
import client.teavm.common.config.FilterSectionTeaVM;
import libsidplay.common.*;
import libsidplay.components.c1530.Datasette.Control;
import libsidplay.components.c1541.FloppyType;
import libsidplay.components.keyboard.KeyTableEntry;
import libsidplay.components.printer.PrinterConnection;
import libsidplay.components.printer.PrinterModel;
import org.teavm.jso.JSExport;

/**
 * The main entry point for the TeaVM-based implementation of JSIDPlay2, designed to generate JavaScript and WebAssembly
 * (WASM) code.
 *
 * <p>
 * This class serves as a bridge between the browser's JavaScript environment and the Java-based SID emulation engine.
 * It uses TeaVM's {@link JSExport} annotation to expose SID playback functionality directly to JavaScript.
 * </p>
 *
 * <h2>Execution Modes</h2>
 * <ul>
 * <li><b>Standard (Worker):</b> Uses {@link ImportedApi} for standard
 * JavaScript interop.</li>
 * <li><b>High Performance (Worker + SharedArrayBuffer):</b> Uses
 * {@link ImportedApiSAB} when the {@code --shared} argument is present,
 * enabling zero-copy audio/video data exchange via shared memory.</li>
 * </ul>
 *
 * <h2>Exported API</h2>
 * <p>
 * The class provides a comprehensive set of static methods prefixed with
 * {@code js2} that are accessible from JavaScript. These include:
 * </p>
 * <ul>
 * <li><b>Playback Control:</b> {@link #js2open}, {@link #js2clock},
 * {@link #js2fastForward}, {@link #js2normalSpeed}.</li>
 * <li><b>Configuration:</b> {@link #js2defaultPlayLength}, {@link #js2loop},
 * {@link #js2palEmulationEnable}, etc.</li>
 * <li><b>Input Handling:</b> {@link #js2pressKey}, {@link #js2releaseKey},
 * {@link #js2insertDisk}, {@link #js2insertTape}.</li>
 * </ul>
 */
public class JSIDPlay2TeaVM {

    private static IExportedApi jsidplay2;

    //
    // Exports to JavaScript
    //

    public static void main(String[] args) {
        jsidplay2 = new ExportedApi(new MainArgs(args).isShared() ? new ImportedApiSAB() : new ImportedApi(), args);
    }

    @JSExport
    public static void js2open(byte[] sidContents, String sidContentsName, int song, int nthFrame,
                               boolean addSidListener, byte[] cartContents, String cartContentsName, String command,
                               double songLength, boolean sfxSoundExpander, int sfxSoundExpanderType,
                               byte[] companionContents, String companionName) {
        jsidplay2.open(sidContents, sidContentsName, song, nthFrame, addSidListener, cartContents, cartContentsName,
                command, songLength, sfxSoundExpander, sfxSoundExpanderType, companionContents, companionName);
    }

    @JSExport
    public static void js2clock() {
        jsidplay2.clock();
    }

    @JSExport
    public static void js2pollStartupWarp() {
        jsidplay2.pollStartupWarp();
    }

    @JSExport
    public static void js2inspection(String action, int channels, String type, int target, int value, int mask,
                                    boolean oneShot) {
        jsidplay2.inspection(action, channels, type, target, value, mask, oneShot);
    }

    //
    // ISidplay2Section methods
    //

    @JSExport
    public static void js2defaultPlayLength(double defaultPlayLength) {
        jsidplay2.defaultPlayLength(defaultPlayLength);
    }

    @JSExport
    public static void js2loop(boolean loop) {
        jsidplay2.loop(loop);
    }

    @JSExport
    public static void js2single(boolean single) {
        jsidplay2.single(single);
    }

    @JSExport
    public static void js2palEmulationEnable(boolean palEmulationEnable, String palEmulationMode) {
        jsidplay2.palEmulationEnable(palEmulationEnable, PalEmulationMode.valueOf(palEmulationMode));
    }

    @JSExport
    public static void js2turboTape(boolean turboTape) {
        jsidplay2.turboTape(turboTape);
    }

    @JSExport
    public static void js2startupWarp(boolean warpOnStartup, int warpStartupTimeout) {
        jsidplay2.startupWarp(warpOnStartup, warpStartupTimeout);
    }

    @JSExport
    public static void js2fade(double fadeInTime, double fadeOutTime) {
        jsidplay2.fade(fadeInTime, fadeOutTime);
    }

    //
    // IAudioSection methods
    //

    @JSExport
    public static void js2samplingRate(String samplingRate) {
        jsidplay2.samplingRate(SamplingRate.valueOf(samplingRate));
    }

    @JSExport
    public static void js2sampling(String sampling) {
        jsidplay2.sampling(SamplingMethod.valueOf(sampling));
    }

    @JSExport
    public static void js2volumeLevels(float mainVolume, float secondVolume, float thirdVolume, float mainBalance,
                                       float secondBalance, float thirdBalance, int mainDelay, int secondDelay, int thirdDelay) {
        jsidplay2.volumeLevels(mainVolume, secondVolume, thirdVolume, mainBalance, secondBalance, thirdBalance,
                mainDelay, secondDelay, thirdDelay);
    }

    @JSExport
    public static void js2bufferSize(int bufferSize) {
        jsidplay2.bufferSize(bufferSize);
    }

    @JSExport
    public static void js2audioBufferSize(int audioBufferSize) {
        jsidplay2.audioBufferSize(audioBufferSize);
    }

    @JSExport
    public static void js2delay(boolean delayBypass, int delay, int delayWetLevel, int delayDryLevel,
                                int delayFeedbackLevel) {
        jsidplay2.delay(delayBypass, delay, delayWetLevel, delayDryLevel, delayFeedbackLevel);
    }

    @JSExport
    public static void js2reverb(boolean reverbBypass, float reverbComb1Delay, float reverbComb2Delay,
                                 float reverbComb3Delay, float reverbComb4Delay, float reverbAllPass1Delay, float reverbAllPass2Delay,
                                 float reverbSustainDelay, float reverbDryWetMix) {
        jsidplay2.reverb(reverbBypass, reverbComb1Delay, reverbComb2Delay, reverbComb3Delay, reverbComb4Delay,
                reverbAllPass1Delay, reverbAllPass2Delay, reverbSustainDelay, reverbDryWetMix);
    }

    //
    // IEmulationSection methods
    //

    @JSExport
    public static void js2engine(String engine) {
        jsidplay2.engine(Engine.valueOf(engine));
    }

    @JSExport
    public static void js2defaultEmulation(String emulation) {
        jsidplay2.defaultEmulation(Emulation.valueOf(emulation));
    }

    @JSExport
    public static void js2userEmulation(String userEmulation, String stereoEmulation, String thirdEmulation) {
        jsidplay2.userEmulation(Emulation.valueOf(userEmulation), Emulation.valueOf(stereoEmulation),
                Emulation.valueOf(thirdEmulation));
    }

    @JSExport
    public static void js2defaultClockSpeed(String defaultClockSpeed) {
        jsidplay2.defaultClockSpeed(CPUClock.valueOf(defaultClockSpeed));
    }

    @JSExport
    public static void js2userClockSpeed(String userClockSpeed) {
        jsidplay2.userClockSpeed(CPUClock.valueOf(userClockSpeed));
    }

    @JSExport
    public static void js2defaultChipModel(String chipModel) {
        jsidplay2.defaultChipModel(ChipModel.valueOf(chipModel));
    }

    @JSExport
    public static void js2userChipModel(String userSidModel, String stereoSidModel, String thirdSIDModel) {
        jsidplay2.userChipModel(ChipModel.valueOf(userSidModel), ChipModel.valueOf(stereoSidModel),
                ChipModel.valueOf(thirdSIDModel));
    }

    @JSExport
    public static void js2overrideChipModel(String chipModel) {
        jsidplay2.overrideChipModel(ChipModel.valueOf(chipModel));
    }

    @JSExport
    public static String js2hardSidMapping(int chipCount, int hardsid6581, int hardsid8580) {
        return jsidplay2.hardSidMapping(chipCount, hardsid6581, hardsid8580);
    }

    @JSExport
    public static String js2exSidMapping() {
        return jsidplay2.exSidMapping();
    }

    @JSExport
    public static String js2usbSidMapping() {
        return jsidplay2.usbSidMapping();
    }

    @JSExport
    public static void js2filterEnable(int sidNum, boolean filterEnable) {
        jsidplay2.filterEnable(sidNum, filterEnable);
    }

    @JSExport
    public static void js2filterName(String emulation, String chipModel, int sidNum, String filterName) {
        jsidplay2.filterName(Emulation.valueOf(emulation), ChipModel.valueOf(chipModel), sidNum, filterName);
    }

    @JSExport
    public static void js2filter(String name,
                                 float filter6581CurvePosition, float voiceNonLinearity, float steepness,
                                 float resonanceFactor, float offset, float nonLinearity, float minFetResistance,
                                 float k, float filter8580CurvePosition, float baseResistance, float b,
                                 float attenuation) {
        jsidplay2.filter(new FilterSectionTeaVM(name,
                filter6581CurvePosition, voiceNonLinearity, steepness, resonanceFactor,
                offset, nonLinearity, minFetResistance, k, filter8580CurvePosition, baseResistance, b,
                attenuation));
    }

    @JSExport
    public static void js2circuitFilter(String name, String circuitModel, float circuitCurve, float circuitRange,
                                      float circuitCapacitance, float voiceNonlinearity, float resonanceFactor) {
        FilterSectionTeaVM filter = new FilterSectionTeaVM();
        filter.setName(name);
        filter.setVoiceNonlinearity(voiceNonlinearity);
        filter.setResonanceFactor(resonanceFactor);
        jsidplay2.filter(filter.withCircuit(circuitModel, circuitCurve, circuitRange, circuitCapacitance));
    }

    @JSExport
    public static void js2digiBoosted8580(boolean boost) {
        jsidplay2.digiBoosted8580(boost);
    }

    @JSExport
    public static void js2stereo(String stereoMode, int dualSidBase, int thirdSIDBase, boolean fakeStereo,
                                 String sidToRead) {
        jsidplay2.stereo(StereoMode.valueOf(stereoMode), dualSidBase, thirdSIDBase, fakeStereo,
                SidReads.valueOf(sidToRead));
    }

    @JSExport
    public static void js2mute(int sidNum, int voice, boolean value) {
        jsidplay2.mute(sidNum, voice, value);
    }

    @JSExport
    public static void js2detectPSID64ChipModel(boolean detectPSID64ChipModel) {
        jsidplay2.detectPSID64ChipModel(detectPSID64ChipModel);
    }

    @JSExport
    public static void js2stereoSniffer(boolean stereoSniffer) {
        jsidplay2.stereoSniffer(stereoSniffer);
    }

    @JSExport
    public static void js2silenceTimeout(int silenceTimeout) {
        jsidplay2.silenceTimeout(silenceTimeout);
    }

    @JSExport
    public static void js2c64Model(String c64Model) {
        jsidplay2.c64Model(C64Model.valueOf(c64Model));
    }

    @JSExport
    public static void js2vicModel(String vicModel) {
        jsidplay2.vicModel(VICModel.valueOf(vicModel));
    }

    //
    // IC1541Section methods
    //

    @JSExport
    public static void js2turnDriveOn(boolean driveOn) {
        jsidplay2.turnDriveOn(driveOn);
    }

    @JSExport
    public static void js2parallelCable(boolean parallelCable) {
        jsidplay2.parallelCable(parallelCable);
    }

    @JSExport
    public static void js2jiffyDosInstalled(boolean jiffyDosInstalled) {
        jsidplay2.jiffyDosInstalled(jiffyDosInstalled);
    }

    @JSExport
    public static void js2ramExpansion(boolean ramExpansion0, boolean ramExpansion1, boolean ramExpansion2,
                                       boolean ramExpansion3, boolean ramExpansion4) {
        jsidplay2.ramExpansion(ramExpansion0, ramExpansion1, ramExpansion2, ramExpansion3, ramExpansion4);
    }

    @JSExport
    public static void js2floppyType(String floppyType) {
        jsidplay2.floppyType(FloppyType.valueOf(floppyType));
    }

    //
    // IPrinterSection methods
    //

    @JSExport
    public static void js2printerOn(boolean printerOn) {
        jsidplay2.printerOn(printerOn);
    }

    @JSExport
    public static void js2printerSettings(String printerModel, String printerConnection) {
        jsidplay2.printerSettings(PrinterModel.valueOf(printerModel), PrinterConnection.valueOf(printerConnection));
    }

    @JSExport
    public static void js2flushPrinter() {
        jsidplay2.flushPrinter();
    }

    //
    // IWhatsSidSection methods
    //

    @JSExport
    public static void js2whatsSID(boolean enable, int captureTime, int matchStartTime, int matchRetryTime,
                                   float minimumRelativeConfidence) {
        jsidplay2.whatsSID(enable, captureTime, matchStartTime, matchRetryTime, minimumRelativeConfidence);
    }

    //
    // Business methods
    //

    @JSExport
    public static void js2typeInCommand(final String multiLineCommand) {
        jsidplay2.typeInCommand(multiLineCommand);
    }

    @JSExport
    public static void js2typeKey(String keyCode) {
        jsidplay2.typeKey(KeyTableEntry.valueOf(keyCode));
    }

    @JSExport
    public static void js2pressKey(String keyCode) {
        jsidplay2.pressKey(KeyTableEntry.valueOf(keyCode));
    }

    @JSExport
    public static void js2releaseKey(String keyCode) {
        jsidplay2.releaseKey(KeyTableEntry.valueOf(keyCode));
    }

    @JSExport
    public static void js2joystick(int number, int value) {
        jsidplay2.joystick(number, value);
    }

    @JSExport
    public static void js2fastForward() {
        jsidplay2.fastForward();
    }

    @JSExport
    public static void js2normalSpeed() {
        jsidplay2.normalSpeed();
    }

    @JSExport
    public static String js2tuneInfo() {
        return jsidplay2.tuneInfo();
    }

    @JSExport
    public static String js2playerInfo() {
        return jsidplay2.playerInfo();
    }

    @JSExport
    public static String js2playList() {
        return jsidplay2.playList();
    }

    @JSExport
    public static String js2status() {
        return jsidplay2.status();
    }

    @JSExport
    public static String js2activeSettings() {
        return jsidplay2.activeSettings();
    }

    @JSExport
    public static void js2insertDisk(byte[] diskContents, String diskContentsName) {
        jsidplay2.insertDisk(diskContents, diskContentsName);
    }

    @JSExport
    public static void js2ejectDisk() {
        jsidplay2.ejectDisk();
    }

    @JSExport
    public static void js2insertTape(byte[] tapeContents, String tapeContentsName) {
        jsidplay2.insertTape(tapeContents, tapeContentsName);
    }

    @JSExport
    public static void js2ejectTape() {
        jsidplay2.ejectTape();
    }

    @JSExport
    public static void js2controlDatasette(String control) {
        jsidplay2.controlDatasette(Control.valueOf(control));
    }

    @JSExport
    public static void js2insertREUfile(byte[] cartContents, String cartContentsName) {
        jsidplay2.insertREUfile(cartContents, cartContentsName);
    }

    @JSExport
    public static void js2insertREU(int sizeKb) {
        jsidplay2.insertREU(sizeKb);
    }

    @JSExport
    public static void js2starTreuWorkaround(boolean enable) {
        jsidplay2.starTreuWorkaround(enable);
    }

    @JSExport
    public static boolean js2insertGeoRAMfile(byte[] contents, String name) {
        return jsidplay2.insertGeoRAMfile(contents, name);
    }

    @JSExport
    public static boolean js2insertGeoRAM(int sizeKb) {
        return jsidplay2.insertGeoRAM(sizeKb);
    }

    @JSExport
    public static void js2getGeoRAMImage() {
        jsidplay2.getGeoRAMImage();
    }

    @JSExport
    public static void js2freezeCartridge() {
        jsidplay2.freezeCartridge();
    }

    @JSExport
    public static void js2oscilloscope(boolean enable, int width, int height) {
        jsidplay2.oscilloscope(enable, width, height);
    }

    @JSExport
    public static void js2flushOscilloscope() {
        jsidplay2.flushOscilloscope();
    }

    @JSExport
    public static void js2oplOscilloscope(int detailMask) {
        jsidplay2.oplOscilloscope(detailMask);
    }

    @JSExport
    public static void js2forceCheckSongLength(boolean forceCheckSongLength) {
        jsidplay2.forceCheckSongLength(forceCheckSongLength);
    }

    @JSExport
    public static void js2sidListenerEnable(boolean sidListenerEnable) {
        jsidplay2.sidListenerEnable(sidListenerEnable);
    }

    @JSExport
    public static void js2autoDiskChange(byte[] diskContents, String diskContentsName, long ticks) {
        jsidplay2.autoDiskChange(diskContents, diskContentsName, ticks);
    }

    @JSExport
    public static void js2autoKeyType(String keyEventType, String keyCode, long ticks) {
        jsidplay2.autoKeyType(KeyEventType.valueOf(keyEventType), KeyTableEntry.valueOf(keyCode), ticks);
    }

}