Class TimedDevice

src/main/java/jace/core/TimedDevice.java:30–204

A timed device is a device which executes so many ticks in a given time interval. This is the core of the emulator timing mechanics. This basic implementation does not run freely and instead will skip cycles if it is running too fast This allows a parent timer to run at a faster rate without causin

 * @author Brendan Robert (BLuRry) brendan.robert@gmail.com
 */
public abstract class TimedDevice extends Device {
    // From the holy word of Sather 3:5 (Table 3.1) :-)
    // This average speed averages in the "long" cycles
    public static final long NTSC_1MHZ = 1020484L;
    public static final long PAL_1MHZ = 1015625L;
    public static final long SYNC_FREQ_HZ = 60;
    public static final double NANOS_PER_SECOND = 1000000000.0;
    public static final long NANOS_PER_MILLISECOND = 1000000L;
    public static final long SYNC_SLOP = NANOS_PER_MILLISECOND * 10L; // 10ms slop for synchronization
    public static int TEMP_SPEED_MAX_DURATION = 1000000;
    @ConfigurableField(name = "Speed", description = "(Percentage)")
    public int speedRatio = 100;
    @ConfigurableField(name = "Max speed")
    public boolean forceMaxspeed = false;
    public boolean maxspeed = false;
    private long cyclesPerSecond = defaultCyclesPerSecond();
    private int cycleTimer = 0;
    private int tempSpeedDuration = 0;
    private long nanosPerInterval; // How long to wait between pauses
    private long cyclesPerInterval; // How many cycles to wait until a pause interval
    private long nextSync = System.nanoTime(); // When is the next sync interval supposed to finish?
    protected Runnable unthrottledTick = () -> super.doTick();
    Long waitUntil = null;
    protected Runnable throttledTick = () -> {
        if (waitUntil == null || System.nanoTime() >= waitUntil) {
            super.doTick();
            waitUntil = calculateResyncDelay();            
        }
    };
    protected final Runnable tickHandler;

    /**
     * Creates a new instance of TimedDevice, setting default speed
     * Protected as overriding the tick handler should only done
     * for the independent timed device
     */
    protected TimedDevice(boolean throttleUsingTicks) {
        super();
        setSpeedInHz(defaultCyclesPerSecond());
        tickHandler = throttleUsingTicks ? throttledTick : unthrottledTick;
        resetSyncTimer();
    }

    public TimedDevice() {
        this(true);
    }
    
    @Override
    public final void doTick() {
        tickHandler.run();
    }

    public final void resetSyncTimer() {
        nextSync = System.nanoTime() + nanosPerInterval;
        cycleTimer = 0;
    }
    
    @Override