fix(youtube/video-ads): add switch to temporarily fix buffering issues

2022-11-01 07:10:54 +01:00
parent f818396243
commit 58dcd172f9
11 changed files with 248 additions and 97 deletions
@@ -0,0 +1,13 @@
+package app.revanced.patches.youtube.misc.playback.annotations
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Package
+
+@Compatibility(
+    [Package(
+        "com.google.android.youtube", arrayOf("17.41.37")
+    )]
+)
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+internal annotation class FixPlaybackCompatibility
@@ -0,0 +1,52 @@
+package app.revanced.patches.youtube.misc.playback.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.ResourcePatch
+import app.revanced.patcher.patch.annotations.DependsOn
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playback.annotations.FixPlaybackCompatibility
+import app.revanced.patches.youtube.misc.playercontroller.patch.PlayerControllerPatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
+import app.revanced.patches.youtube.misc.videoid.patch.VideoIdPatch
+
+@DependsOn([
+    IntegrationsPatch::class,
+    PlayerControllerPatch::class, // updates video length and adds method to seek in video, necessary for this patch
+    SettingsPatch::class,
+    VideoIdPatch::class
+])
+@Name("fix-playback")
+@Description("Fixes the issue with videos not playing when video ads are removed.")
+@FixPlaybackCompatibility
+@Version("0.0.1")
+class FixPlaybackPatch : ResourcePatch {
+    override fun execute(context: ResourceContext): PatchResult {
+        SettingsPatch.PreferenceScreen.MISC.addPreferences(
+            SwitchPreference(
+                "revanced_fix_playback",
+                StringResource("revanced_fix_playback_title", "Fix video playback issues"),
+                false,
+                StringResource(
+                    "revanced_fix_playback_summary_on",
+                    "The fix is enabled"
+                ),
+                StringResource(
+                    "revanced_fix_playback_summary_off",
+                    "The fix is disabled"
+                )
+            )
+        )
+
+        // If a new video loads, fix the playback issue
+        VideoIdPatch.injectCall("Lapp/revanced/integrations/patches/FixPlaybackPatch;->newVideoLoaded(Ljava/lang/String;)V")
+
+        return PatchResultSuccess()
+    }
+}
@@ -0,0 +1,13 @@
+package app.revanced.patches.youtube.misc.playercontroller.annotation
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Package
+
+@Compatibility(
+    [Package(
+        "com.google.android.youtube", arrayOf("17.41.37")
+    )]
+)
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+internal annotation class PlayerControllerCompatibility
@@ -0,0 +1,15 @@
+package app.revanced.patches.youtube.misc.playercontroller.fingerprint
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.sponsorblock.annotations.SponsorBlockCompatibility
+
+@Name("create-video-player-seekbar-fingerprint")
+@SponsorBlockCompatibility
+@Version("0.0.1")
+object CreateVideoPlayerSeekbarFingerprint : MethodFingerprint(
+    "V",
+    strings = listOf("timed_markers_width")
+)
@@ -0,0 +1,17 @@
+package app.revanced.patches.youtube.misc.playercontroller.fingerprint
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.sponsorblock.annotations.SponsorBlockCompatibility
+
+@Name("player-init-fingerprint")
+
+@SponsorBlockCompatibility
+@Version("0.0.1")
+object PlayerInitFingerprint : MethodFingerprint(
+    strings = listOf(
+        "playVideo called on player response with no videoStreamingData."
+    ),
+)
@@ -0,0 +1,15 @@
+package app.revanced.patches.youtube.misc.playercontroller.fingerprint
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.sponsorblock.annotations.SponsorBlockCompatibility
+
+@Name("seek-fingerprint")
+
+@SponsorBlockCompatibility
+@Version("0.0.1")
+object SeekFingerprint : MethodFingerprint(
+    strings = listOf("Attempting to seek during an ad")
+)
@@ -0,0 +1,29 @@
+package app.revanced.patches.youtube.misc.playercontroller.fingerprint
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.sponsorblock.annotations.SponsorBlockCompatibility
+import org.jf.dexlib2.Opcode
+
+@Name("video-length-fingerprint")
+
+@SponsorBlockCompatibility
+@Version("0.0.1")
+object VideoLengthFingerprint : MethodFingerprint(
+    opcodes = listOf(
+        Opcode.MOVE_RESULT_WIDE,
+        Opcode.CMP_LONG,
+        Opcode.IF_LEZ,
+        Opcode.IGET_OBJECT,
+        Opcode.CHECK_CAST,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT_WIDE,
+        Opcode.GOTO,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT_WIDE,
+        Opcode.CONST_4,
+        Opcode.INVOKE_VIRTUAL
+    )
+)
@@ -0,0 +1,116 @@
+package app.revanced.patches.youtube.misc.playercontroller.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.extensions.addInstructions
+import app.revanced.patcher.extensions.instruction
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint.Companion.resolve
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.annotations.DependsOn
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playercontroller.annotation.PlayerControllerCompatibility
+import app.revanced.patches.youtube.misc.playercontroller.fingerprint.CreateVideoPlayerSeekbarFingerprint
+import app.revanced.patches.youtube.misc.playercontroller.fingerprint.PlayerInitFingerprint
+import app.revanced.patches.youtube.misc.playercontroller.fingerprint.SeekFingerprint
+import app.revanced.patches.youtube.misc.playercontroller.fingerprint.VideoLengthFingerprint
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.builder.MutableMethodImplementation
+import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
+import org.jf.dexlib2.immutable.ImmutableMethod
+import org.jf.dexlib2.immutable.ImmutableMethodParameter
+import org.jf.dexlib2.util.MethodUtil
+
+@Name("player-controller-hook")
+@Description("Hooks the player controller")
+@PlayerControllerCompatibility
+@Version("0.0.1")
+@DependsOn([IntegrationsPatch::class])
+class PlayerControllerPatch : BytecodePatch(
+    listOf(
+        PlayerInitFingerprint,
+        CreateVideoPlayerSeekbarFingerprint
+    )
+) {
+    override fun execute(context: BytecodeContext): PatchResult {
+        with(PlayerInitFingerprint.result!!) {
+            playerInitMethod = mutableClass.methods.first { MethodUtil.isConstructor(it) }
+
+            // hook the player controller for use through integrations
+            onCreateHook(INTEGRATIONS_CLASS_DESCRIPTOR, "playerController_onCreateHook")
+
+            // seek method
+            val seekFingerprintResultMethod = SeekFingerprint.also { it.resolve(context, classDef) }.result!!.method
+
+            // create helper method
+            val seekHelperMethod = ImmutableMethod(
+                seekFingerprintResultMethod.definingClass,
+                "seekTo",
+                listOf(ImmutableMethodParameter("J", null, "time")),
+                "Z",
+                AccessFlags.PUBLIC or AccessFlags.FINAL,
+                null, null,
+                MutableMethodImplementation(4)
+            ).toMutable()
+
+            // get enum type for the seek helper method
+            val seekSourceEnumType = seekFingerprintResultMethod.parameterTypes[1].toString()
+
+            // insert helper method instructions
+            seekHelperMethod.addInstructions(
+                0,
+                """
+                sget-object v0, $seekSourceEnumType->a:$seekSourceEnumType
+                invoke-virtual {p0, p1, p2, v0}, ${seekFingerprintResultMethod.definingClass}->${seekFingerprintResultMethod.name}(J$seekSourceEnumType)Z
+                move-result p1
+                return p1
+            """
+            )
+
+            // add the seekTo method to the class for the integrations to call
+            mutableClass.methods.add(seekHelperMethod)
+        }
+
+        with(CreateVideoPlayerSeekbarFingerprint.result!!) {
+            val videoLengthMethodResult = VideoLengthFingerprint.also { it.resolve(context, classDef) }.result!!
+
+            with(videoLengthMethodResult.mutableMethod) {
+                val videoLengthRegisterIndex = videoLengthMethodResult.scanResult.patternScanResult!!.endIndex - 2
+                val videoLengthRegister = (instruction(videoLengthRegisterIndex) as OneRegisterInstruction).registerA
+                val dummyRegisterForLong = videoLengthRegister + 1 // required for long values since they are wide
+
+                addInstruction(
+                    videoLengthMethodResult.scanResult.patternScanResult!!.endIndex,
+                    "invoke-static {v$videoLengthRegister, v$dummyRegisterForLong}, $INTEGRATIONS_CLASS_DESCRIPTOR->setCurrentVideoLength(J)V"
+                )
+            }
+        }
+
+        return PatchResultSuccess()
+    }
+
+    companion object {
+        private const val INTEGRATIONS_CLASS_DESCRIPTOR = "Lapp/revanced/integrations/patches/PlayerControllerPatch;"
+        private const val INSERT_INDEX = 4
+
+        private lateinit var playerInitMethod: MutableMethod
+
+        /**
+         * Hook the player controller.
+         *
+         * @param targetMethodClass The descriptor for the static method to invoke when the player controller is created.
+         */
+        internal fun onCreateHook(targetMethodClass: String, targetMethodName: String) =
+            playerInitMethod.addInstruction(
+                INSERT_INDEX,
+                "invoke-static { v0 }, $targetMethodClass->$targetMethodName(Ljava/lang/Object;)V"
+            )
+    }
+}
@@ -17,7 +17,7 @@ import app.revanced.patches.youtube.misc.videoid.fingerprint.VideoIdFingerprint
 import org.jf.dexlib2.iface.instruction.OneRegisterInstruction

@Name("video-id-hook")
-@Description("Hook to detect when the video id changes")
+@Description("Hooks to detect when the video id changes")
@VideoIdCompatibility
@Version("0.0.1")
@DependsOn([IntegrationsPatch::class])