SignalState.java

package libsidutils.sound;

import java.nio.ByteBuffer;

/** Presentation-only interpretation of copied registers and frame-aligned software playback flags. */
public record SignalState(int volume, int modes, int playbackFlags, Voice[] voices) {
    public static final int KNOWN = 1, FILTER_ENABLED = 2, DIGI_BOOST = 4;

    public enum Route { DIRECT, FILTER, FILTER_NO_OUTPUT, VOICE3_OFF }

    public record Voice(int number, int waveform, int pulseWidth, boolean gate, boolean test,
                        boolean sync, boolean ring, int source, Route route, boolean bypassed, boolean muted) {
        public boolean ringEffective() { return ring && (waveform & 3) == 1; }
        public double pulseDuty() { return (4096 - pulseWidth) * 100.0 / 4096; }
    }

    public static int flags(boolean filterEnabled, int muteMask, boolean digiBoost) {
        return KNOWN | (filterEnabled ? FILTER_ENABLED : 0) | (digiBoost ? DIGI_BOOST : 0) | (muteMask & 15) << 4;
    }

    public boolean known() { return (playbackFlags & KNOWN) != 0; }
    public boolean digiBoost() { return (playbackFlags & DIGI_BOOST) != 0; }
    public boolean sampleMute() { return (playbackFlags & 128) != 0; }

    public static SignalState decode(ByteBuffer registers, int base, int flags) {
        int routing = registers.get(base + 0x17) & 15, mode = registers.get(base + 0x18) & 255;
        boolean filterEnabled = (flags & FILTER_ENABLED) != 0;
        int modes = mode >> 4 & 7;
        Voice[] voices = new Voice[3];
        for (int voice = 0; voice < 3; voice++) {
            int offset = base + voice * 7, control = registers.get(offset + 4) & 255;
            boolean filtered = filterEnabled && (routing & 1 << voice) != 0;
            Route route = filtered ? modes == 0 ? Route.FILTER_NO_OUTPUT : Route.FILTER
                    : voice == 2 && (mode & 128) != 0 ? Route.VOICE3_OFF : Route.DIRECT;
            voices[voice] = new Voice(voice + 1, control >> 4,
                    (registers.get(offset + 2) & 255) | (registers.get(offset + 3) & 15) << 8,
                    (control & 1) != 0, (control & 8) != 0, (control & 2) != 0, (control & 4) != 0,
                    (voice + 2) % 3 + 1, route, !filterEnabled && (routing & 1 << voice) != 0,
                    (flags & 16 << voice) != 0);
        }
        return new SignalState(mode & 15, modes, flags, voices);
    }
}