feat: swipe-controls rewrite (#131)

* move patch 'fenster' to 'swipe-controls'

* remove 'injectIntoNamedMethod' function

* move updatePlayerType hook into its own patch

* refactor 'swipe-controls' patch

* add resources for new ui to patch

Co-authored-by: TheJeterLP <joey.peter1998@gmail.com>

src/main/kotlin/app/revanced/patches/youtube/interaction/fenster/patch/FensterPatch.kt

@@ -1,121 +0,0 @@
-package app.revanced.patches.youtube.interaction.fenster.patch
-
-import app.revanced.extensions.injectConsumableEventHook
-import app.revanced.extensions.injectIntoNamedMethod
-import app.revanced.patcher.annotation.Description
-import app.revanced.patcher.annotation.Name
-import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.impl.BytecodeData
-import app.revanced.patcher.extensions.addInstruction
-import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
-import app.revanced.patcher.patch.PatchResult
-import app.revanced.patcher.patch.PatchResultError
-import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patcher.patch.annotations.Dependencies
-import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.impl.BytecodePatch
-import app.revanced.patches.youtube.interaction.fenster.annotation.FensterCompatibility
-import app.revanced.patches.youtube.interaction.fenster.fingerprints.UpdatePlayerTypeFingerprint
-import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
-import org.jf.dexlib2.immutable.reference.ImmutableMethodReference
-
-@Patch
-@Name("fenster-swipe-controls")
-@Description("Adds volume and brightness swipe controls.")
-@FensterCompatibility
-@Version("0.0.1")
-@Dependencies(dependencies = [IntegrationsPatch::class])
-class FensterPatch : BytecodePatch(
-    listOf(
-        UpdatePlayerTypeFingerprint
-    )
-) {
-    override fun execute(data: BytecodeData): PatchResult {
-        // hook WatchWhileActivity.onStart (main activity lifecycle hook)
-        data.injectIntoNamedMethod(
-            "com/google/android/apps/youtube/app/watchwhile/WatchWhileActivity",
-            "onStart",
-            0,
-            "invoke-static { p0 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->WatchWhileActivity_onStartHookEX(Ljava/lang/Object;)V"
-        )
-
-        // hook YoutubePlayerOverlaysLayout.onFinishInflate (player overlays init hook)
-        data.injectIntoNamedMethod(
-            "com/google/android/apps/youtube/app/common/player/overlay/YouTubePlayerOverlaysLayout",
-            "onFinishInflate",
-            -2,
-            "invoke-static { p0 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->YouTubePlayerOverlaysLayout_onFinishInflateHookEX(Ljava/lang/Object;)V"
-        )
-
-        // hook YoutubePlayerOverlaysLayout.UpdatePlayerType
-        injectUpdatePlayerTypeHook(
-            UpdatePlayerTypeFingerprint.result!!,
-            "com/google/android/apps/youtube/app/common/player/overlay/YouTubePlayerOverlaysLayout"
-        )
-
-        // hook NextGenWatchLayout.onTouchEvent and NextGenWatchLayout.onInterceptTouchEvent (player touch event hook)
-        injectWatchLayoutTouchHooks(
-            data,
-            "com/google/android/apps/youtube/app/watch/nextgenwatch/ui/NextGenWatchLayout"
-        )
-
-        return PatchResultSuccess()
-    }
-
-    @Suppress("SameParameterValue")
-    private fun injectUpdatePlayerTypeHook(fingerPrintResult: MethodFingerprintResult, targetClass: String) {
-        // validate fingerprint found the right class
-        if (!fingerPrintResult.classDef.type.endsWith("$targetClass;")) {
-            throw PatchResultError("$targetClass.UpdatePlayerType fingerprint could not be validated")
-        }
-
-        // insert the hook
-        fingerPrintResult.mutableMethod.addInstruction(
-            0,
-            "invoke-static { p1 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->YouTubePlayerOverlaysLayout_updatePlayerTypeHookEX(Ljava/lang/Object;)V"
-        )
-    }
-
-    /**
-     * Inject onTouch event hooks into the watch layout class
-     *
-     * @param data bytecode data
-     * @param targetClass watch layout class name
-     */
-    @Suppress("SameParameterValue")
-    private fun injectWatchLayoutTouchHooks(data: BytecodeData, targetClass: String) {
-        var touchHooksCount = 0
-        data.classes.filter { it.type.endsWith("$targetClass;") }.forEach { classDef ->
-            // hook onTouchEvent
-            data.proxy(classDef).resolve().methods.filter { it.name == "onTouchEvent" }.forEach { methodDef ->
-                touchHooksCount++
-                methodDef.injectConsumableEventHook(
-                    ImmutableMethodReference(
-                        "Lapp/revanced/integrations/patches/FensterSwipePatch;",
-                        "NextGenWatchLayout_onTouchEventHookEX",
-                        listOf("Ljava/lang/Object;", "Ljava/lang/Object;"),
-                        "Z"
-                    )
-                )
-            }
-
-            // hook onInterceptTouchEvent
-            data.proxy(classDef).resolve().methods.filter { it.name == "onInterceptTouchEvent" }.forEach { methodDef ->
-                touchHooksCount++
-                methodDef.injectConsumableEventHook(
-                    ImmutableMethodReference(
-                        "Lapp/revanced/integrations/patches/FensterSwipePatch;",
-                        "NextGenWatchLayout_onInterceptTouchEventHookEX",
-                        listOf("Ljava/lang/Object;", "Ljava/lang/Object;"),
-                        "Z"
-                    )
-                )
-            }
-        }
-
-        // fail if no touch hooks were inserted
-        if (touchHooksCount <= 0) {
-            throw PatchResultError("failed to inject onTouchEvent hook into NextGenWatchLayout: none found")
-        }
-    }
-}

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/annotation/SwipeControlsCompatibility.kt

@@ -0,0 +1,13 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.annotation
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Package
+
+@Compatibility(
+    [Package(
+        "com.google.android.youtube", arrayOf("17.24.34", "17.25.34")
+    )]
+)
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+internal annotation class SwipeControlsCompatibility

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/fingerprints/WatchWhileOnStartFingerprint.kt

@@ -0,0 +1,21 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.fingerprints
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.fingerprint.method.annotation.DirectPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+
+@Name("watch-while-onStart-fingerprint")
+@MatchingMethod(
+    "LWatchWhileActivity;", "onCreate"
+)
+@DirectPatternScanMethod
+@SwipeControlsCompatibility
+@Version("0.0.1")
+object WatchWhileOnStartFingerprint : MethodFingerprint(
+    null, null, null, null, null, { methodDef ->
+        methodDef.definingClass.endsWith("WatchWhileActivity;") && methodDef.name == "onStart"
+    }
+)

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/patch/SwipeControlsPatch.kt

@@ -0,0 +1,42 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.annotations.Dependencies
+import app.revanced.patcher.patch.annotations.Patch
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+import app.revanced.patches.youtube.interaction.swipecontrols.fingerprints.WatchWhileOnStartFingerprint
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playertype.patch.PlayerTypeHookPatch
+
+@Patch
+@Name("swipe-controls")
+@Description("Adds volume and brightness swipe controls.")
+@SwipeControlsCompatibility
+@Version("0.0.2")
+@Dependencies(
+    dependencies = [
+        IntegrationsPatch::class,
+        PlayerTypeHookPatch::class,
+        SwipeControlsResourcesPatch::class
+    ]
+)
+class SwipeControlsPatch : BytecodePatch(
+    listOf(
+        WatchWhileOnStartFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        WatchWhileOnStartFingerprint.result!!.mutableMethod.addInstruction(
+            0,
+            "invoke-static { p0 }, Lapp/revanced/integrations/patches/SwipeControlsPatch;->WatchWhileActivity_onStartHookEX(Ljava/lang/Object;)V"
+        )
+        return PatchResultSuccess()
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/patch/SwipeControlsResourcesPatch.kt

@@ -0,0 +1,32 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.patch
+
+import app.revanced.extensions.injectResources
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.impl.ResourceData
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.impl.ResourcePatch
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+
+@Name("swipe-controls-resource-patch")
+@SwipeControlsCompatibility
+@Version("0.0.1")
+class SwipeControlsResourcesPatch : ResourcePatch() {
+    override fun execute(data: ResourceData): PatchResult {
+        val resourcesDir = "swipecontrols"
+
+        data.injectResources(
+            this.javaClass.classLoader,
+            resourcesDir,
+            "drawable",
+            listOf(
+                "ic_sc_brightness_auto",
+                "ic_sc_brightness_manual",
+                "ic_sc_volume_mute",
+                "ic_sc_volume_normal"
+            ).map { "$it.xml" }
+        )
+        return PatchResultSuccess()
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/annotation/PlayerTypeHookCompatibility.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.interaction.fenster.annotation
+package app.revanced.patches.youtube.misc.playertype.annotation
 
 import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Package
@@ -10,4 +10,4 @@ import app.revanced.patcher.annotation.Package
 )
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
-internal annotation class FensterCompatibility
+internal annotation class PlayerTypeHookCompatibility

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/fingerprint/UpdatePlayerTypeFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.interaction.fenster.fingerprints
+package app.revanced.patches.youtube.misc.playertype.fingerprint
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
@@ -6,17 +6,18 @@ import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
 import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
-import app.revanced.patches.youtube.interaction.fenster.annotation.FensterCompatibility
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
+//TODO constrain to only match in YoutubePlayerOverlaysLayout?
 @Name("update-player-type-fingerprint")
 @MatchingMethod(
     "LYoutubePlayerOverlaysLayout;",
     "nM"
 )
 @FuzzyPatternScanMethod(2)
-@FensterCompatibility
+@SwipeControlsCompatibility
 @Version("0.0.1")
 object UpdatePlayerTypeFingerprint : MethodFingerprint(
     "V",

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/patch/PlayerTypeHookPatch.kt

@@ -0,0 +1,34 @@
+package app.revanced.patches.youtube.misc.playertype.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.annotations.Dependencies
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playertype.annotation.PlayerTypeHookCompatibility
+import app.revanced.patches.youtube.misc.playertype.fingerprint.UpdatePlayerTypeFingerprint
+
+@Name("player-type-hook")
+@Description("hook to get the current player type of WatchWhileActivity")
+@PlayerTypeHookCompatibility
+@Version("0.0.1")
+@Dependencies(dependencies = [IntegrationsPatch::class])
+class PlayerTypeHookPatch : BytecodePatch(
+    listOf(
+        UpdatePlayerTypeFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        // hook YouTubePlayerOverlaysLayout.updatePlayerLayout()
+        UpdatePlayerTypeFingerprint.result!!.mutableMethod.addInstruction(
+            0,
+            "invoke-static { p1 }, Lapp/revanced/integrations/patches/PlayerTypeHookPatch;->YouTubePlayerOverlaysLayout_updatePlayerTypeHookEX(Ljava/lang/Object;)V"
+        )
+        return PatchResultSuccess()
+    }
+}