Improve the timer accuracy. #128

Author: DeweyReed

app/dependencies/dogReleaseRuntimeClasspath.txt

@@ -157,6 +157,7 @@ com.github.DeweyReed:android-job:a04c817792
 com.github.DeweyReed:tools:0.8.0
 com.github.PhilJay:MPAndroidChart:v3.1.0
 com.github.bumptech.glide:disklrucache:4.16.0
+com.github.cardinalby:accurate-count-down-timer:1.0
 com.github.kizitonwose:CalendarView:1.0.4
 com.github.ultimate-deej:twowaynestedscrollview:0.1.2
 com.github.zawadz88:MaterialPopupMenu:4.1.0

app/dependencies/googleReleaseRuntimeClasspath.txt

@@ -167,6 +167,7 @@ com.github.DeweyReed:android-job:a04c817792
 com.github.DeweyReed:tools:0.8.0
 com.github.PhilJay:MPAndroidChart:v3.1.0
 com.github.bumptech.glide:disklrucache:4.16.0
+com.github.cardinalby:accurate-count-down-timer:1.0
 com.github.kizitonwose:CalendarView:1.0.4
 com.github.ultimate-deej:twowaynestedscrollview:0.1.2
 com.github.zawadz88:MaterialPopupMenu:4.1.0

app/dependencies/otherReleaseRuntimeClasspath.txt

@@ -157,6 +157,7 @@ com.github.DeweyReed:android-job:a04c817792
 com.github.DeweyReed:tools:0.8.0
 com.github.PhilJay:MPAndroidChart:v3.1.0
 com.github.bumptech.glide:disklrucache:4.16.0
+com.github.cardinalby:accurate-count-down-timer:1.0
 com.github.kizitonwose:CalendarView:1.0.4
 com.github.ultimate-deej:twowaynestedscrollview:0.1.2
 com.github.zawadz88:MaterialPopupMenu:4.1.0

gradle/libs.versions.toml

@@ -153,6 +153,7 @@ coil-compose = "io.coil-kt:coil-compose:2.6.0"
 coil-gif = "io.coil-kt:coil-gif:2.6.0"
 zoomable = "net.engawapg.lib:zoomable:1.6.1"
 twoWayNestedScrollView = "com.github.ultimate-deej:twowaynestedscrollview:0.1.2"
+accurateCountDownTimer = "com.github.cardinalby:accurate-count-down-timer:1.0"
 
 [bundles]
 mockito-core = ["mockito-kotlin", "mockito-core"]

presentation/build.gradle

@@ -32,4 +32,5 @@ dependencies {
     implementation libs.hilt.android
     kapt libs.hilt.compiler
 
+    implementation libs.accurateCountDownTimer
 }

presentation/src/main/java/xyz/aprildown/timer/presentation/stream/task/CountDownTimerTask.kt

@@ -1,6 +1,6 @@
 package xyz.aprildown.timer.presentation.stream.task
 
-import android.os.CountDownTimer
+import com.github.cardinalby.accuratecountdowntimer.AccurateCountDownTimer
 import com.github.deweyreed.tools.helper.HandlerHelper
 import xyz.aprildown.timer.presentation.stream.StreamState
 
@@ -50,17 +50,17 @@ internal class CountDownTimerTask(master: TaskMaster, countDownTime: Long) : Tas
 
     private fun onTick(millisUntilFinished: Long) {
         millisLeft = millisUntilFinished
-        master.onTick(this, millisUntilFinished)
-        tickListeners.forEach { it.onNewTime(millisUntilFinished) }
+        master.onTick(this, currentTime)
+        tickListeners.forEach { it.onNewTime(currentTime) }
     }
 
-    private inner class MyTimer(countDownTime: Long) : CountDownTimer(countDownTime, 1_000L) {
-
-        private var remainingTime = countDownTime
+    private inner class MyTimer(
+        countDownTime: Long,
+    ) : AccurateCountDownTimer(countDownTime, 1_000L) {
 
         init {
             HandlerHelper.runOnUiThread {
-                this@CountDownTimerTask.onTick(remainingTime)
+                this@CountDownTimerTask.onTick(countDownTime)
             }
         }
 
@@ -72,8 +72,7 @@ internal class CountDownTimerTask(master: TaskMaster, countDownTime: Long) : Tas
 
         override fun onTick(millisUntilFinished: Long) {
             HandlerHelper.runOnUiThread {
-                this@CountDownTimerTask.onTick(remainingTime)
-                remainingTime -= 1_000L
+                this@CountDownTimerTask.onTick(millisUntilFinished.round())
             }
         }
     }

presentation/src/main/java/xyz/aprildown/timer/presentation/stream/task/StopwatchTask.kt

@@ -1,8 +1,8 @@
 package xyz.aprildown.timer.presentation.stream.task
 
-import android.os.Handler
-import android.os.Looper
-import android.os.SystemClock
+import com.github.cardinalby.accuratecountdowntimer.AccurateCountDownTimer
+import com.github.deweyreed.tools.helper.HandlerHelper
+import xyz.aprildown.timer.presentation.stream.StreamState
 
 /**
  * You must call [TaskManager.interfere] to move on.
@@ -11,68 +11,75 @@ internal class StopwatchTask(master: TaskMaster) : Task(master) {
 
     private val tickListeners = mutableListOf<TickListener>()
 
-    private val handler = Handler(Looper.getMainLooper())
-    private var currentStartTime = 0L
-    private var baseElapsedTime = 0L
-    private var currentElapsedTime = 0L
+    private var timer = MyTimer()
+    private var millisPassedBase = 0L
+    private var millisPassedCurrent = 0L
 
-    override val currentTime: Long get() = currentElapsedTime + baseElapsedTime
+    override val currentTime: Long get() = millisPassedBase + millisPassedCurrent
+
+    fun addTickListener(listener: TickListener) {
+        tickListeners.add(listener)
+    }
 
     override fun start() {
         super.start()
-        currentStartTime = SystemClock.elapsedRealtime()
-        currentElapsedTime = 0
-        handler.post(TickRunnable())
+        timer.start()
     }
 
     override fun pause() {
         super.pause()
-        handler.removeCallbacksAndMessages(null)
-        baseElapsedTime += currentElapsedTime
-        currentElapsedTime = 0
+        timer.cancel()
+        millisPassedBase += millisPassedCurrent
+        millisPassedCurrent = 0L
+        timer = MyTimer()
     }
 
     override fun forceStop() {
         super.forceStop()
-        handler.removeCallbacksAndMessages(null)
+        timer.cancel()
     }
 
     override fun adjust(amount: Long, add: Boolean) {
-        handler.removeCallbacksAndMessages(null)
-        baseElapsedTime += if (add) currentElapsedTime + amount else amount
-        currentElapsedTime = 0
+        timer.cancel()
+        millisPassedBase = if (add) millisPassedBase + millisPassedCurrent + amount else amount
+        millisPassedCurrent = 0L
+        timer = MyTimer()
         if (taskState.isRunning) {
-            start()
-        } else {
-            master.onTick(this, currentTime)
+            timer.start()
         }
     }
 
-    /**
-     * newElapsedTime pattern: 26, 1026, 2026, 3026...
-     * So the result is 0, 1, 2, 3
-     */
-    private fun onTick(newElapsedTime: Long) {
-        currentElapsedTime = newElapsedTime
-        val time = currentTime
-        master.onTick(this, time)
-        tickListeners.forEach { it.onNewTime(time) }
+    private fun onFinish() {
+        taskState = StreamState.RESET
+        master.onTaskDone(this)
     }
 
-    fun addTickListener(listener: TickListener) {
-        tickListeners.add(listener)
+    private fun onTick(millisPassed: Long) {
+        millisPassedCurrent = millisPassed
+        master.onTick(this, currentTime)
+        tickListeners.forEach { it.onNewTime(currentTime) }
     }
 
-    private inner class TickRunnable : Runnable {
-        override fun run() {
-            val tickStartTime = SystemClock.elapsedRealtime()
+    private inner class MyTimer : AccurateCountDownTimer(DURATION, 1_000L) {
 
-            val newElapsedTime = tickStartTime - currentStartTime
-            onTick(newElapsedTime)
+        init {
+            HandlerHelper.runOnUiThread {
+                this@StopwatchTask.onTick(0L)
+            }
+        }
 
-            val tickEndTime = SystemClock.elapsedRealtime()
-            val consume = tickEndTime - tickStartTime
-            handler.postDelayed(this, 1_000L - (consume % 1_000L))
+        override fun onFinish() {
+            HandlerHelper.runOnUiThread {
+                this@StopwatchTask.onFinish()
+            }
+        }
+
+        override fun onTick(millisUntilFinished: Long) {
+            HandlerHelper.runOnUiThread {
+                this@StopwatchTask.onTick((DURATION - millisUntilFinished).round())
+            }
         }
     }
 }
+
+private const val DURATION = Long.MAX_VALUE

presentation/src/main/java/xyz/aprildown/timer/presentation/stream/task/Task.kt

@@ -2,6 +2,7 @@ package xyz.aprildown.timer.presentation.stream.task
 
 import androidx.annotation.CallSuper
 import xyz.aprildown.timer.presentation.stream.StreamState
+import kotlin.math.roundToLong
 
 internal abstract class Task(protected val master: TaskMaster) {
 
@@ -29,4 +30,8 @@ internal abstract class Task(protected val master: TaskMaster) {
      * @param add True to add amount to the current time. False to set current time to amount
      */
     abstract fun adjust(amount: Long, add: Boolean)
+
+    protected fun Long.round(): Long {
+        return (toDouble() / 1000f).roundToLong() * 1000L
+    }
 }

settings.gradle

@@ -13,12 +13,13 @@ dependencyResolutionManagement {
         maven {
             url "https://jitpack.io"
             content {
-                includeGroup "com.github.DeweyReed"
-                includeModule "com.github.PhilJay", "MPAndroidChart"
-                includeModule "com.github.kizitonwose", "CalendarView"
-                includeModule "com.github.zawadz88", "MaterialPopupMenu"
-                includeModule "com.github.Carbs0126", "NumberPickerView"
-                includeModule "com.github.ultimate-deej", "twowaynestedscrollview"
+                includeGroup("com.github.DeweyReed")
+                includeModule("com.github.PhilJay", "MPAndroidChart")
+                includeModule("com.github.kizitonwose", "CalendarView")
+                includeModule("com.github.zawadz88", "MaterialPopupMenu")
+                includeModule("com.github.Carbs0126", "NumberPickerView")
+                includeModule("com.github.ultimate-deej", "twowaynestedscrollview")
+                includeModule("com.github.cardinalby", "accurate-count-down-timer")
             }
         }
     }