diff --git a/glsm/src/main/java/com/gtnewhorizons/angelica/glsm/backend/RenderBackend.java b/glsm/src/main/java/com/gtnewhorizons/angelica/glsm/backend/RenderBackend.java index ffccb8bf6..2d498af4f 100644 --- a/glsm/src/main/java/com/gtnewhorizons/angelica/glsm/backend/RenderBackend.java +++ b/glsm/src/main/java/com/gtnewhorizons/angelica/glsm/backend/RenderBackend.java @@ -99,7 +99,7 @@ public abstract class RenderBackend { static VSyncMode resolveTearFreeMode(VSyncMode preferred, Predicate supported) { if (preferred != null && preferred.tearFree() && supported.test(preferred)) return preferred; - return supported.test(VSyncMode.MAILBOX) ? VSyncMode.MAILBOX : VSyncMode.ON; + return VSyncMode.ON; } protected abstract VSyncMode applyVSyncMode(VSyncMode preferred); diff --git a/glsm/src/test/java/com/gtnewhorizons/angelica/glsm/backend/BackendPolicyTest.java b/glsm/src/test/java/com/gtnewhorizons/angelica/glsm/backend/BackendPolicyTest.java index 71fa4683a..7a6b186db 100644 --- a/glsm/src/test/java/com/gtnewhorizons/angelica/glsm/backend/BackendPolicyTest.java +++ b/glsm/src/test/java/com/gtnewhorizons/angelica/glsm/backend/BackendPolicyTest.java @@ -19,12 +19,12 @@ class BackendPolicyTest { @ParameterizedTest(name = "{0}") @CsvSource({ - "mailbox is taken when the backend offers it, , true, MAILBOX", - "vsync is the fallback when mailbox is unsupported, , false, ON", + "vsync is the default even when the backend offers mailbox, , true, ON", + "vsync is the default when mailbox is unsupported, , false, ON", "an unsupported mailbox preference falls back to vsync, MAILBOX, false, ON", "an explicit supported vsync preference wins, ON, true, ON", "an explicit supported mailbox preference wins, MAILBOX, true, MAILBOX", - "off is never a tear-free preference with mailbox, OFF, true, MAILBOX", + "off is never a tear-free preference with mailbox, OFF, true, ON", "off is never a tear-free preference without mailbox, OFF, false, ON", }) void tearFreeModeResolution(String label, VSyncMode preference, boolean mailboxSupported, VSyncMode expected) { diff --git a/src/main/java/com/gtnewhorizons/angelica/rendering/FramePacer.java b/src/main/java/com/gtnewhorizons/angelica/rendering/FramePacer.java index 3e9d9506b..0b9f543d6 100644 --- a/src/main/java/com/gtnewhorizons/angelica/rendering/FramePacer.java +++ b/src/main/java/com/gtnewhorizons/angelica/rendering/FramePacer.java @@ -112,7 +112,7 @@ public final class FramePacer { final int refreshHz = refreshHz(mode, cap, refreshPeriodNanos); core.setRefreshPeriodNanos(refreshPeriodNanos); - core.setTearFree(mode.tearFree()); + core.setFifo(mode == VSyncMode.ON); core.setVsyncOn(mode == VSyncMode.ON && honored); core.setCap(cap); @@ -216,7 +216,7 @@ public final class FramePacer { private static int refreshHz(VSyncMode mode, int capHz, long refreshPeriodNanos) { final int hz = RenderBackend.hzFromPeriod(refreshPeriodNanos); - if (hz == 0 && capHz == 0 && mode.tearFree() && !warnedUncapped) { + if (hz == 0 && capHz == 0 && mode == VSyncMode.ON && !warnedUncapped) { warnedUncapped = true; AngelicaMod.LOGGER.warn("Display refresh rate is unknown, so the frame rate cannot be bounded if the driver ignores vsync. Set Max Framerate to bound it."); } diff --git a/src/main/java/com/gtnewhorizons/angelica/rendering/PacerCore.java b/src/main/java/com/gtnewhorizons/angelica/rendering/PacerCore.java index e8556eac8..50fe633f8 100644 --- a/src/main/java/com/gtnewhorizons/angelica/rendering/PacerCore.java +++ b/src/main/java/com/gtnewhorizons/angelica/rendering/PacerCore.java @@ -38,7 +38,7 @@ final class PacerCore { private LongConsumer idleWork; private long refreshPeriodNanos; - private boolean tearFree = true; + private boolean fifo = true; private boolean vsyncOn = true; private int capHz; @@ -109,9 +109,9 @@ final class PacerCore { dropLock(); } - void setTearFree(boolean value) { - if (value == tearFree) return; - tearFree = value; + void setFifo(boolean value) { + if (value == fifo) return; + fifo = value; dropLock(); } @@ -159,8 +159,8 @@ final class PacerCore { lastGpuWaitNanos = pendingGpuWaitNanos; pendingGpuWaitNanos = 0L; - final long c = cadencePeriodNanos(capHz, refreshPeriodNanos, tearFree); - final boolean candidate = sample && vsyncOn && tearFree && refreshPeriodNanos > 0L + final long c = cadencePeriodNanos(capHz, refreshPeriodNanos, fifo); + final boolean candidate = sample && vsyncOn && fifo && refreshPeriodNanos > 0L && sampleDuration > gateThresholdNanos(c); updateLock(candidate, sampleEnd); @@ -307,9 +307,9 @@ final class PacerCore { return lastPresentIntervalNanos; } - static long cadencePeriodNanos(int capHz, long refreshPeriodNanos, boolean tearFree) { + static long cadencePeriodNanos(int capHz, long refreshPeriodNanos, boolean fifo) { final long cap = Math.max(capHz, 0); - if (tearFree && refreshPeriodNanos > 0L) { + if (fifo && refreshPeriodNanos > 0L) { if (cap == 0L || cap * refreshPeriodNanos * CAP_EQ_DIVISOR >= NANOS_PER_SECOND * (CAP_EQ_DIVISOR - 1)) { return refreshPeriodNanos; } diff --git a/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreSimTest.java b/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreSimTest.java index 9cf94d4b8..c3c625bd8 100644 --- a/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreSimTest.java +++ b/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreSimTest.java @@ -192,7 +192,7 @@ class PacerCoreSimTest { private static final class Sim { long refreshPeriod = P60; long displayPeriod; - boolean tearFree = true; + boolean fifo = true; boolean vsyncOn = true; int cap; Mode mode = Mode.FIFO; @@ -265,7 +265,7 @@ class PacerCoreSimTest { final PacerSleeper sleeper = new PacerSleeper(clock.clock(), parker, false); final PacerCore core = new PacerCore(clock.clock(), sleeper); core.setRefreshPeriodNanos(sim.refreshPeriod); - core.setTearFree(sim.tearFree); + core.setFifo(sim.fifo); core.setVsyncOn(sim.vsyncOn); core.setCap(sim.cap); @@ -379,7 +379,7 @@ class PacerCoreSimTest { private static Sim tearingSim(String name, int cap) { final Sim sim = new Sim().named(name); - sim.tearFree = false; + sim.fifo = false; sim.vsyncOn = false; sim.mode = Mode.IMMEDIATE; sim.gate = Gate.NONE; @@ -504,18 +504,21 @@ class PacerCoreSimTest { } @Test - void mailboxIsPacedToTheRefreshRateInsteadOfBeatingAgainstIt() { + void mailboxRendersPastTheRefreshRateAndShowsTheNewestFrame() { final Sim sim = new Sim().named("mailbox144"); sim.refreshPeriod = P144; sim.mode = Mode.MAILBOX; sim.gate = Gate.SWAP; + sim.fifo = false; sim.vsyncOn = false; sim.work = 3 * MS; sim.gpuTail = MS; final Result r = run(sim); - assertTrue(r.dropped <= 1, r + " must not drop presents it paid to render"); - assertTrue(r.intervalSd < 200 * US, r.toString()); + assertEquals(0L, r.cadence, r + " mailbox must not be capped"); + assertTrue(r.meanInterval < P144 * 3 / 4, r + " must render past the refresh rate"); + assertEquals(0, r.repeats, r + " must have a fresh frame for every vblank"); + assertTrue(r.dropped > 0, r + " surplus frames are replaced in the mailbox"); } @Test diff --git a/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreTest.java b/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreTest.java index d67c1661e..66eec8f1c 100644 --- a/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreTest.java +++ b/src/test/java/com/gtnewhorizons/angelica/rendering/PacerCoreTest.java @@ -28,15 +28,15 @@ class PacerCoreTest { final PacerCore core; final List presents = new ArrayList<>(); - Rig(long refreshPeriodNanos, boolean tearFree, int capHz) { - this(refreshPeriodNanos, tearFree, tearFree, capHz); + Rig(long refreshPeriodNanos, boolean fifo, int capHz) { + this(refreshPeriodNanos, fifo, fifo, capHz); } - Rig(long refreshPeriodNanos, boolean tearFree, boolean vsyncOn, int capHz) { + Rig(long refreshPeriodNanos, boolean fifo, boolean vsyncOn, int capHz) { final PacerSleeper sleeper = new PacerSleeper(time.clock(), time.parker(), false); core = new PacerCore(time.clock(), sleeper); core.setRefreshPeriodNanos(refreshPeriodNanos); - core.setTearFree(tearFree); + core.setFifo(fifo); core.setVsyncOn(vsyncOn); core.setCap(capHz); } @@ -100,22 +100,22 @@ class PacerCoreTest { return Stream.of( Arguments.of("a cap at the refresh rate collapses onto the refresh period", 60, P5994, true, P5994), Arguments.of("a cap near the refresh rate collapses onto the refresh period", 58, P60, true, P60), - Arguments.of("no cap uses the refresh period when tear free", 0, P60, true, P60), + Arguments.of("no cap uses the refresh period under fifo", 0, P60, true, P60), Arguments.of("a cap above the refresh rate collapses onto the refresh period", 240, P60, true, P60), Arguments.of("a cap far from every multiple keeps its literal period", 45, P60, true, 1_000_000_000L / 45), Arguments.of("a cap far from every multiple keeps its literal period", 100, P144, true, 1_000_000_000L / 100), Arguments.of("a cap near a vblank multiple snaps to that multiple", 30, P60, true, 2 * P60), Arguments.of("a cap near a vblank multiple snaps to that multiple", 50, P144, true, 3 * P144), - Arguments.of("a tearing mode ignores the refresh period", 100, P60, false, 10 * MS), - Arguments.of("a tearing mode with no cap is unpaced", 0, P60, false, 0L), + Arguments.of("a non-fifo mode ignores the refresh period", 100, P60, false, 10 * MS), + Arguments.of("a non-fifo mode with no cap is unpaced", 0, P60, false, 0L), Arguments.of("a zero refresh period with no cap is unpaced", 0, 0L, true, 0L), Arguments.of("a zero refresh period keeps the literal cap", 100, 0L, true, 10 * MS)); } @ParameterizedTest(name = "{0}: cadencePeriodNanos({1}, {2}, {3}) -> {4}") @MethodSource("cadencePeriods") - void cadencePeriodNanos(String name, int capHz, long refreshPeriodNanos, boolean tearFree, long expected) { - assertEquals(expected, PacerCore.cadencePeriodNanos(capHz, refreshPeriodNanos, tearFree)); + void cadencePeriodNanos(String name, int capHz, long refreshPeriodNanos, boolean fifo, long expected) { + assertEquals(expected, PacerCore.cadencePeriodNanos(capHz, refreshPeriodNanos, fifo)); } @Test @@ -390,15 +390,23 @@ class PacerCoreTest { } @Test - void mailboxIsNeverProbedAndNeverLocks() { - final Rig rig = new Rig(P60, true, false, 0); + void mailboxIsNeverProbedNeverLocksAndIsUncapped() { + final Rig rig = new Rig(P60, false, false, 0); for (int i = 0; i < 40; i++) { final long end = 20 * MS + i * P60; rig.feed(end, 5 * MS, end); assertFalse(rig.core.probing()); } assertFalse(rig.core.locked()); - assertEquals(P60, cadenceNanos(rig.core)); + assertFalse(rig.core.paced(), "mailbox must render past the refresh rate"); + assertEquals(0L, cadenceNanos(rig.core)); + } + + @Test + void aMailboxCapIsLiteralRatherThanSnappedToTheRefreshRate() { + final Rig rig = new Rig(P60, false, false, 240); + rig.frame(MS); + assertEquals(1_000_000_000L / 240, cadenceNanos(rig.core)); } @Test