Repository navigation
fix(android): pace frame-rate caps like rive-android #417
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mfazekas
wants to merge
3
commits into
fix/android-idle-frame-loops
Choose a base branch
from
fix/android-frame-pacer
base: fix/android-idle-frame-loops
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+96
−16
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package com.rive | ||
|
|
||
| /** | ||
| * Copy of rive-android's internal `RiveFramePacer` (app/rive/RiveFrameRate.kt); keep the two in | ||
| * sync. Tracks frame-rate cap timing without owning platform frame callbacks. | ||
| * | ||
| * The caller should use [delayBeforeNextFrameNs] to sleep until close to the next target render | ||
| * time, then still await the platform frame clock before rendering. | ||
| * | ||
| * @param framesPerSecond Maximum frames per second, or null to render on every frame callback. | ||
| */ | ||
| internal class RiveFramePacer(framesPerSecond: Double?) { | ||
| private val periodNs = framesPerSecond | ||
| ?.takeIf { it.isFinite() && it > 0 } | ||
| ?.let { Math.round(1_000_000_000.0 / it).coerceAtLeast(1L) } | ||
| private var nextRenderTimeNs = 0L | ||
|
|
||
| /** | ||
| * Returns how long to delay before requesting another platform frame callback, or 0 when no | ||
| * delay should be applied. | ||
| * | ||
| * @param nowNs Current monotonic time, in the same time base as frame callbacks. | ||
| */ | ||
| fun delayBeforeNextFrameNs(nowNs: Long): Long { | ||
| val activePeriodNs = periodNs ?: return 0L | ||
| if (nextRenderTimeNs == 0L) { | ||
| return 0L | ||
| } | ||
|
|
||
| // Wake before the target time so the caller can await the next platform frame callback. | ||
| return (nextRenderTimeNs - nowNs - EARLY_WAKE_NS) | ||
| .coerceAtLeast(0L) | ||
| .coerceAtMost(activePeriodNs) | ||
| } | ||
|
|
||
| /** Attempts to accept [frameTimeNs] as the next Rive frame; true when the caller should draw. */ | ||
| fun tryScheduleFrame(frameTimeNs: Long): Boolean { | ||
| val activePeriodNs = periodNs ?: return true | ||
| if (nextRenderTimeNs != 0L && frameTimeNs < nextRenderTimeNs) { | ||
| return false | ||
| } | ||
|
|
||
| if (nextRenderTimeNs == 0L) { | ||
| nextRenderTimeNs = frameTimeNs + activePeriodNs | ||
| return true | ||
| } | ||
|
|
||
| val periodsMissed = ((frameTimeNs - nextRenderTimeNs) / activePeriodNs) + 1L | ||
| nextRenderTimeNs += periodsMissed * activePeriodNs | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| /** Restarts pacing so the next frame callback renders immediately. */ | ||
| fun reset() { | ||
| nextRenderTimeNs = 0L | ||
| } | ||
|
|
||
| private companion object { | ||
| // Coarse wake headroom before the next target frame time. | ||
| const val EARLY_WAKE_NS = 4_000_000L | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.