refactor: cleanup and simplify SponsorBlock code

Author: Bnyro

app/src/main/java/com/github/libretube/enums/SbSkipOptions.kt

@@ -2,7 +2,6 @@ package com.github.libretube.enums
 
 enum class SbSkipOptions {
     OFF,
-    VISIBLE,
     MANUAL,
     AUTOMATIC,
     AUTOMATIC_ONCE

app/src/main/java/com/github/libretube/helpers/PlayerHelper.kt

@@ -41,7 +41,6 @@ import com.github.libretube.db.obj.WatchPosition
 import com.github.libretube.enums.PlayerEvent
 import com.github.libretube.enums.SbSkipOptions
 import com.github.libretube.extensions.seekBy
-import com.github.libretube.extensions.toastFromMainThread
 import com.github.libretube.extensions.togglePlayPauseState
 import com.github.libretube.extensions.updateParameters
 import com.github.libretube.obj.VideoStats
@@ -50,7 +49,6 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import java.util.Locale
-import kotlin.math.absoluteValue
 import kotlin.math.max
 import kotlin.math.roundToInt
 
@@ -199,7 +197,7 @@ object PlayerHelper {
             true
         )
 
-    private val sponsorBlockNotifications: Boolean
+    val sponsorBlockNotifications: Boolean
         get() = PreferenceHelper.getBoolean(
             "sb_notifications_key",
             true
@@ -586,44 +584,29 @@ object PlayerHelper {
 
     /**
      * Check for SponsorBlock segments matching the current player position
-     * @param context A main dispatcher context
+     * Please make sure to set [Segment#skipped] to true after seeking to the segment end
+     *
      * @param segments List of the SponsorBlock segments
      * @return If segment found and should skip manually, the end position of the segment in ms, otherwise null
      */
     fun Player.checkForSegments(
-        context: Context,
         segments: List<Segment>,
         sponsorBlockConfig: MutableMap<String, SbSkipOptions>,
-        skipAutomaticallyIfEnabled: Boolean
-    ): Segment? {
+    ): Pair<Segment, SbSkipOptions>? {
         for (segment in segments.filter { it.category != SPONSOR_HIGHLIGHT_CATEGORY }) {
             val (start, end) = segment.segmentStartAndEnd
             val (segmentStart, segmentEnd) = (start * 1000f).toLong() to (end * 1000f).toLong()
 
             // avoid seeking to the same segment multiple times, e.g. when the SB segment is at the end of the video
-            if ((duration - currentPosition).absoluteValue < 500) continue
+            if (segmentEnd - currentPosition in 0..1000) continue
             if (currentPosition !in segmentStart until segmentEnd) continue
 
             val key = sponsorBlockConfig[segment.category]
+            if (key == SbSkipOptions.AUTOMATIC_ONCE && segment.skipped) continue
 
-            if (!skipAutomaticallyIfEnabled || key == SbSkipOptions.MANUAL ||
-                (key == SbSkipOptions.AUTOMATIC_ONCE && segment.skipped)
-            ) {
-                return segment
-            } else if (key == SbSkipOptions.AUTOMATIC ||
-                (key == SbSkipOptions.AUTOMATIC_ONCE && !segment.skipped)
-            ) {
-                if (sponsorBlockNotifications) {
-                    runCatching {
-                        context.toastFromMainThread(R.string.segment_skipped)
-                    }
-                }
-                seekTo(segmentEnd)
-                segment.skipped = true
-            } else {
-                return null
-            }
+            return segment to (key ?: SbSkipOptions.AUTOMATIC)
         }
+
         return null
     }
 

app/src/main/java/com/github/libretube/services/OnlinePlayerService.kt

@@ -22,6 +22,7 @@ import com.github.libretube.constants.IntentData
 import com.github.libretube.constants.PreferenceKeys
 import com.github.libretube.db.DatabaseHelper
 import com.github.libretube.enums.PlayerCommand
+import com.github.libretube.enums.SbSkipOptions
 import com.github.libretube.extensions.parcelable
 import com.github.libretube.extensions.setMetadata
 import com.github.libretube.extensions.toastFromMainDispatcher
@@ -219,7 +220,7 @@ open class OnlinePlayerService : AbstractPlayerService() {
             sponsorBlockSegments = MediaServiceRepository.instance.getSegments(
                 videoId,
                 sponsorBlockConfig.keys.toList(),
-                listOf("skip","mute","full","poi","chapter")
+                listOf("skip", "mute", "full", "poi", "chapter")
             ).segments
 
             withContext(Dispatchers.Main) {
@@ -241,12 +242,17 @@ open class OnlinePlayerService : AbstractPlayerService() {
     private fun checkForSegments() {
         handler.postDelayed(this::checkForSegments, 100)
 
-        exoPlayer?.checkForSegments(
-            this,
+        val (currentSegment, sbSkipOption) = exoPlayer?.checkForSegments(
             sponsorBlockSegments,
-            sponsorBlockConfig,
-            skipAutomaticallyIfEnabled = sponsorBlockAutoSkip
-        )
+            sponsorBlockConfig
+        ) ?: return
+
+        if (sbSkipOption in arrayOf(SbSkipOptions.AUTOMATIC, SbSkipOptions.AUTOMATIC_ONCE)) {
+            exoPlayer?.seekTo(currentSegment.segmentStartAndEnd.second.toLong() * 1000)
+            currentSegment.skipped = true
+
+            if (PlayerHelper.sponsorBlockNotifications) toastFromMainThread(R.string.segment_skipped)
+        }
     }
 
     override fun runPlayerCommand(args: Bundle) {

app/src/main/java/com/github/libretube/ui/fragments/PlayerFragment.kt

@@ -63,6 +63,7 @@ import com.github.libretube.databinding.FragmentPlayerBinding
 import com.github.libretube.db.DatabaseHolder
 import com.github.libretube.enums.PlayerCommand
 import com.github.libretube.enums.PlayerEvent
+import com.github.libretube.enums.SbSkipOptions
 import com.github.libretube.enums.ShareObjectType
 import com.github.libretube.extensions.formatShort
 import com.github.libretube.extensions.parcelable
@@ -504,7 +505,10 @@ class PlayerFragment : Fragment(R.layout.fragment_player), OnlinePlayerOptions {
         BackgroundHelper.startMediaService(
             requireContext(),
             OnlinePlayerService::class.java,
-            if (startNewSession) bundleOf(IntentData.playerData to playerData, IntentData.audioOnly to false) else Bundle.EMPTY,
+            if (startNewSession) bundleOf(
+                IntentData.playerData to playerData,
+                IntentData.audioOnly to false
+            ) else Bundle.EMPTY,
         ) {
             if (_binding == null) {
                 playerController.sendCustomCommand(
@@ -1004,25 +1008,24 @@ class PlayerFragment : Fragment(R.layout.fragment_player), OnlinePlayerOptions {
         if (viewModel.segments.value.isNullOrEmpty()) return
 
         playerController.checkForSegments(
-            requireContext(),
             viewModel.segments.value.orEmpty(),
-            viewModel.sponsorBlockConfig,
-            // skipping is done by player service
-            skipAutomaticallyIfEnabled = false
-        )
-            ?.let { segment ->
-                if (commonPlayerViewModel.isMiniPlayerVisible.value == true) return@let
+            viewModel.sponsorBlockConfig
+        )?.let { (segment, sbSkipOption) ->
+            if (commonPlayerViewModel.isMiniPlayerVisible.value == true) return@let
 
+            if (sbSkipOption in arrayOf(SbSkipOptions.AUTOMATIC_ONCE, SbSkipOptions.MANUAL)) {
                 binding.sbSkipBtn.isVisible = true
                 binding.sbSkipBtn.setOnClickListener {
                     playerController.seekTo((segment.segmentStartAndEnd.second * 1000f).toLong())
                     segment.skipped = true
                 }
-                return
             }
+            return
+        }
 
-        if (!playerController.isInSegment(viewModel.segments.value.orEmpty())) binding.sbSkipBtn.isGone =
-            true
+        if (!playerController.isInSegment(viewModel.segments.value.orEmpty())) {
+            binding.sbSkipBtn.isGone = true
+        }
     }
 
     private fun setPlayerDefaults() {