fix(YouTube/Spoof client): seekbar thumbnail not shown in Android Testsuite client

src/main/kotlin/app/revanced/patches/youtube/utils/fix/client/SpoofClientPatch.kt

@@ -20,8 +20,8 @@ import app.revanced.patches.youtube.utils.fix.client.fingerprints.NerdsStatsVide
 import app.revanced.patches.youtube.utils.fix.client.fingerprints.PlayerGestureConfigSyntheticFingerprint
 import app.revanced.patches.youtube.utils.fix.client.fingerprints.SetPlayerRequestClientTypeFingerprint
 import app.revanced.patches.youtube.utils.integrations.Constants.MISC_PATH
-import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch
 import app.revanced.patches.youtube.utils.settings.SettingsPatch
+import app.revanced.patches.youtube.utils.storyboard.StoryboardHookPatch
 import app.revanced.patches.youtube.video.information.VideoInformationPatch
 import app.revanced.patches.youtube.video.playerresponse.PlayerResponseMethodHookPatch
 import app.revanced.util.getReference
@@ -49,7 +49,7 @@ object SpoofClientPatch : BaseBytecodePatch(
         SettingsPatch::class,
         VideoInformationPatch::class,
         SpoofUserAgentPatch::class,
-        SharedResourceIdPatch::class,
+        StoryboardHookPatch::class,
     ),
     compatiblePackages = Constants.COMPATIBLE_PACKAGE,
     fingerprints = setOf(
@@ -354,6 +354,12 @@ object SpoofClientPatch : BaseBytecodePatch(
 
         // endregion
 
+        // region hook storyboard.
+
+        StoryboardHookPatch.hook(INTEGRATIONS_CLASS_DESCRIPTOR)
+
+        // endregion
+
         /**
          * Add settings
          */

src/main/kotlin/app/revanced/patches/youtube/utils/fix/parameter/SpoofPlayerParameterPatch.kt

@@ -1,28 +1,14 @@
 package app.revanced.patches.youtube.utils.fix.parameter
 
 import app.revanced.patcher.data.BytecodeContext
-import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
-import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWithLabels
-import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
-import app.revanced.patcher.extensions.InstructionExtensions.removeInstruction
-import app.revanced.patcher.util.smali.ExternalLabel
 import app.revanced.patches.youtube.utils.compatibility.Constants.COMPATIBLE_PACKAGE
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.PlayerResponseModelGeneralStoryboardRendererFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.PlayerResponseModelLiveStreamStoryboardRendererFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.PlayerResponseModelStoryboardRecommendedLevelFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.StoryboardRendererDecoderRecommendedLevelFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.StoryboardRendererDecoderSpecFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.StoryboardRendererSpecFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.StoryboardThumbnailFingerprint
-import app.revanced.patches.youtube.utils.fix.parameter.fingerprints.StoryboardThumbnailParentFingerprint
 import app.revanced.patches.youtube.utils.integrations.Constants.MISC_PATH
 import app.revanced.patches.youtube.utils.playertype.PlayerTypeHookPatch
 import app.revanced.patches.youtube.utils.settings.SettingsPatch
+import app.revanced.patches.youtube.utils.storyboard.StoryboardHookPatch
 import app.revanced.patches.youtube.video.information.VideoInformationPatch
 import app.revanced.patches.youtube.video.playerresponse.PlayerResponseMethodHookPatch
 import app.revanced.util.patch.BaseBytecodePatch
-import app.revanced.util.resultOrThrow
-import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
 
 @Suppress("unused")
 @Deprecated("This patch will be removed in the future.")
@@ -34,17 +20,9 @@ object SpoofPlayerParameterPatch : BaseBytecodePatch(
         PlayerResponseMethodHookPatch::class,
         SettingsPatch::class,
         VideoInformationPatch::class,
+        StoryboardHookPatch::class,
     ),
     compatiblePackages = COMPATIBLE_PACKAGE,
-    fingerprints = setOf(
-        PlayerResponseModelGeneralStoryboardRendererFingerprint,
-        PlayerResponseModelLiveStreamStoryboardRendererFingerprint,
-        PlayerResponseModelStoryboardRecommendedLevelFingerprint,
-        StoryboardRendererDecoderRecommendedLevelFingerprint,
-        StoryboardRendererDecoderSpecFingerprint,
-        StoryboardRendererSpecFingerprint,
-        StoryboardThumbnailParentFingerprint
-    ),
     use = false
 ) {
     private const val INTEGRATIONS_CLASS_DESCRIPTOR =
@@ -57,116 +35,8 @@ object SpoofPlayerParameterPatch : BaseBytecodePatch(
             "$INTEGRATIONS_CLASS_DESCRIPTOR->spoofParameter(Ljava/lang/String;Ljava/lang/String;Z)Ljava/lang/String;"
         )
 
-        // Force the seekbar time and chapters to always show up.
+        // Hook storyboard.
-        // This is used if the storyboard spec fetch fails, for viewing paid videos,
+        StoryboardHookPatch.hook(INTEGRATIONS_CLASS_DESCRIPTOR)
-        // or if storyboard spoofing is turned off.
-        StoryboardThumbnailParentFingerprint.resultOrThrow().classDef.let { classDef ->
-            StoryboardThumbnailFingerprint.also {
-                it.resolve(
-                    context,
-                    classDef
-                )
-            }.resultOrThrow().let {
-                it.mutableMethod.apply {
-                    val targetIndex = it.scanResult.patternScanResult!!.endIndex
-                    val targetRegister =
-                        getInstruction<OneRegisterInstruction>(targetIndex).registerA
-
-                    // Since this is end of the method must replace one line then add the rest.
-                    addInstructions(
-                        targetIndex + 1,
-                        """
-                                invoke-static {}, $INTEGRATIONS_CLASS_DESCRIPTOR->getSeekbarThumbnailOverrideValue()Z
-                                move-result v$targetRegister
-                                return v$targetRegister
-                                """
-                    )
-                    removeInstruction(targetIndex)
-                }
-            }
-        }
-
-        // Hook storyboard renderer url.
-        arrayOf(
-            PlayerResponseModelGeneralStoryboardRendererFingerprint,
-            PlayerResponseModelLiveStreamStoryboardRendererFingerprint
-        ).forEach { fingerprint ->
-            fingerprint.resultOrThrow().let {
-                it.mutableMethod.apply {
-                    val getStoryboardIndex = it.scanResult.patternScanResult!!.endIndex
-                    val getStoryboardRegister =
-                        getInstruction<OneRegisterInstruction>(getStoryboardIndex).registerA
-
-                    addInstructions(
-                        getStoryboardIndex,
-                        """
-                            invoke-static { v$getStoryboardRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
-                            move-result-object v$getStoryboardRegister
-                            """
-                    )
-                }
-            }
-        }
-
-        // Hook recommended seekbar thumbnails quality level.
-        StoryboardRendererDecoderRecommendedLevelFingerprint.resultOrThrow().let {
-            it.mutableMethod.apply {
-                val moveOriginalRecommendedValueIndex = it.scanResult.patternScanResult!!.endIndex
-                val originalValueRegister =
-                    getInstruction<OneRegisterInstruction>(moveOriginalRecommendedValueIndex).registerA
-
-                addInstructions(
-                    moveOriginalRecommendedValueIndex + 1, """
-                        invoke-static { v$originalValueRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getRecommendedLevel(I)I
-                        move-result v$originalValueRegister
-                        """
-                )
-            }
-        }
-
-        // Hook the recommended precise seeking thumbnails quality level.
-        PlayerResponseModelStoryboardRecommendedLevelFingerprint.resultOrThrow().let {
-            it.mutableMethod.apply {
-                val moveOriginalRecommendedValueIndex = it.scanResult.patternScanResult!!.endIndex
-                val originalValueRegister =
-                    getInstruction<OneRegisterInstruction>(moveOriginalRecommendedValueIndex).registerA
-
-                addInstructions(
-                    moveOriginalRecommendedValueIndex, """
-                        invoke-static { v$originalValueRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getRecommendedLevel(I)I
-                        move-result v$originalValueRegister
-                        """
-                )
-            }
-        }
-
-        StoryboardRendererSpecFingerprint.resultOrThrow().let {
-            it.mutableMethod.apply {
-                val storyBoardUrlParams = 0
-
-                addInstructionsWithLabels(
-                    0, """
-                        if-nez p$storyBoardUrlParams, :ignore
-                        invoke-static { p$storyBoardUrlParams }, $INTEGRATIONS_CLASS_DESCRIPTOR->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
-                        move-result-object p$storyBoardUrlParams
-                        """, ExternalLabel("ignore", getInstruction(0))
-                )
-            }
-        }
-
-        // Hook the seekbar thumbnail decoder and use a NULL spec for live streams.
-        StoryboardRendererDecoderSpecFingerprint.resultOrThrow().let {
-            val storyBoardUrlIndex = it.scanResult.patternScanResult!!.startIndex + 1
-            val storyboardUrlRegister =
-                it.mutableMethod.getInstruction<OneRegisterInstruction>(storyBoardUrlIndex).registerA
-
-            it.mutableMethod.addInstructions(
-                storyBoardUrlIndex + 1, """
-                        invoke-static { v$storyboardUrlRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getStoryboardDecoderRendererSpec(Ljava/lang/String;)Ljava/lang/String;
-                        move-result-object v$storyboardUrlRegister
-                        """
-            )
-        }
 
         /**
          * Add settings

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/StoryboardHookPatch.kt

@@ -0,0 +1,154 @@
+package app.revanced.patches.youtube.utils.storyboard
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWithLabels
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.removeInstruction
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patcher.util.smali.ExternalLabel
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.PlayerResponseModelGeneralStoryboardRendererFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.PlayerResponseModelLiveStreamStoryboardRendererFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.PlayerResponseModelStoryboardRecommendedLevelFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.StoryboardRendererDecoderRecommendedLevelFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.StoryboardRendererDecoderSpecFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.StoryboardRendererSpecFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.StoryboardThumbnailFingerprint
+import app.revanced.patches.youtube.utils.storyboard.fingerprints.StoryboardThumbnailParentFingerprint
+import app.revanced.patches.youtube.utils.resourceid.SharedResourceIdPatch
+import app.revanced.util.resultOrThrow
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
+
+@Patch(
+    description = "Force inject the Storyboard by fetching YouTube API.",
+    dependencies = [SharedResourceIdPatch::class],
+)
+object StoryboardHookPatch : BytecodePatch(
+    setOf(
+        PlayerResponseModelGeneralStoryboardRendererFingerprint,
+        PlayerResponseModelLiveStreamStoryboardRendererFingerprint,
+        PlayerResponseModelStoryboardRecommendedLevelFingerprint,
+        StoryboardRendererDecoderRecommendedLevelFingerprint,
+        StoryboardRendererDecoderSpecFingerprint,
+        StoryboardRendererSpecFingerprint,
+        StoryboardThumbnailParentFingerprint,
+    )
+) {
+    private lateinit var context: BytecodeContext
+
+    override fun execute(context: BytecodeContext) {
+        this.context = context
+    }
+
+    internal fun hook(classDescriptor: String) {
+
+        // Force the seekbar time and chapters to always show up.
+        // This is used if the storyboard spec fetch fails, for viewing paid videos,
+        // or if storyboard spoofing is turned off.
+        StoryboardThumbnailFingerprint.resolve(
+            context,
+            StoryboardThumbnailParentFingerprint.resultOrThrow().classDef
+        )
+        StoryboardThumbnailFingerprint.resultOrThrow().let {
+            it.mutableMethod.apply {
+                val targetIndex = it.scanResult.patternScanResult!!.endIndex
+                val targetRegister =
+                    getInstruction<OneRegisterInstruction>(targetIndex).registerA
+
+                // Since this is end of the method must replace one line then add the rest.
+                addInstructions(
+                    targetIndex + 1,
+                    """
+                        invoke-static {}, $classDescriptor->getSeekbarThumbnailOverrideValue()Z
+                        move-result v$targetRegister
+                        return v$targetRegister
+                        """
+                )
+                removeInstruction(targetIndex)
+            }
+        }
+
+        // Hook storyboard renderer url.
+        arrayOf(
+            PlayerResponseModelGeneralStoryboardRendererFingerprint,
+            PlayerResponseModelLiveStreamStoryboardRendererFingerprint
+        ).forEach { fingerprint ->
+            fingerprint.resultOrThrow().let {
+                it.mutableMethod.apply {
+                    val getStoryboardIndex = it.scanResult.patternScanResult!!.endIndex
+                    val getStoryboardRegister =
+                        getInstruction<OneRegisterInstruction>(getStoryboardIndex).registerA
+
+                    addInstructions(
+                        getStoryboardIndex,
+                        """
+                            invoke-static { v$getStoryboardRegister }, $classDescriptor->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
+                            move-result-object v$getStoryboardRegister
+                            """
+                    )
+                }
+            }
+        }
+
+        // Hook recommended seekbar thumbnails quality level.
+        StoryboardRendererDecoderRecommendedLevelFingerprint.resultOrThrow().let {
+            it.mutableMethod.apply {
+                val moveOriginalRecommendedValueIndex = it.scanResult.patternScanResult!!.endIndex
+                val originalValueRegister =
+                    getInstruction<OneRegisterInstruction>(moveOriginalRecommendedValueIndex).registerA
+
+                addInstructions(
+                    moveOriginalRecommendedValueIndex + 1, """
+                        invoke-static { v$originalValueRegister }, $classDescriptor->getStoryboardRecommendedLevel(I)I
+                        move-result v$originalValueRegister
+                        """
+                )
+            }
+        }
+
+        // Hook the recommended precise seeking thumbnails quality level.
+        PlayerResponseModelStoryboardRecommendedLevelFingerprint.resultOrThrow().let {
+            it.mutableMethod.apply {
+                val moveOriginalRecommendedValueIndex = it.scanResult.patternScanResult!!.endIndex
+                val originalValueRegister =
+                    getInstruction<OneRegisterInstruction>(moveOriginalRecommendedValueIndex).registerA
+
+                addInstructions(
+                    moveOriginalRecommendedValueIndex, """
+                        invoke-static { v$originalValueRegister }, $classDescriptor->getStoryboardRecommendedLevel(I)I
+                        move-result v$originalValueRegister
+                        """
+                )
+            }
+        }
+
+        StoryboardRendererSpecFingerprint.resultOrThrow().let {
+            it.mutableMethod.apply {
+                val storyBoardUrlParams = 0
+
+                addInstructionsWithLabels(
+                    0, """
+                        if-nez p$storyBoardUrlParams, :ignore
+                        invoke-static { p$storyBoardUrlParams }, $classDescriptor->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
+                        move-result-object p$storyBoardUrlParams
+                        """, ExternalLabel("ignore", getInstruction(0))
+                )
+            }
+        }
+
+        // Hook the seekbar thumbnail decoder and use a NULL spec for live streams.
+        StoryboardRendererDecoderSpecFingerprint.resultOrThrow().let {
+            val storyBoardUrlIndex = it.scanResult.patternScanResult!!.startIndex + 1
+            val storyboardUrlRegister =
+                it.mutableMethod.getInstruction<OneRegisterInstruction>(storyBoardUrlIndex).registerA
+
+            it.mutableMethod.addInstructions(
+                storyBoardUrlIndex + 1, """
+                        invoke-static { v$storyboardUrlRegister }, $classDescriptor->getStoryboardDecoderRendererSpec(Ljava/lang/String;)Ljava/lang/String;
+                        move-result-object v$storyboardUrlRegister
+                        """
+            )
+        }
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/PlayerResponseModelGeneralStoryboardRendererFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/PlayerResponseModelLiveStreamStoryboardRendererFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/PlayerResponseModelStoryboardRecommendedLevelFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/StoryboardRendererDecoderRecommendedLevelFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/StoryboardRendererDecoderSpecFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/StoryboardRendererSpecFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/StoryboardThumbnailFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/utils/storyboard/fingerprints/StoryboardThumbnailParentFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.utils.fix.parameter.fingerprints
+package app.revanced.patches.youtube.utils.storyboard.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint