chore(release): 2.191.0-dev.20 [skip ci]

# [2.191.0-dev.20](https://github.com/ReVanced/revanced-patches/compare/v2.191.0-dev.19...v2.191.0-dev.20) (2023-09-28)

### Bug Fixes

* **YouTube - Video Id:** Fix video id not showing the currently playing video ([#3038](https://github.com/ReVanced/revanced-patches/issues/3038)) ([47c858e](47c858ef4e))

CHANGELOG.md

@@ -1,3 +1,24 @@
+# [2.191.0-dev.20](https://github.com/ReVanced/revanced-patches/compare/v2.191.0-dev.19...v2.191.0-dev.20) (2023-09-28)
+
+
+### Bug Fixes
+
+* **YouTube - Video Id:** Fix video id not showing the currently playing video ([#3038](https://github.com/ReVanced/revanced-patches/issues/3038)) ([f6f226b](https://github.com/ReVanced/revanced-patches/commit/f6f226ba281823cb5d2d468c32f6e48551971726))
+
+# [2.191.0-dev.19](https://github.com/ReVanced/revanced-patches/compare/v2.191.0-dev.18...v2.191.0-dev.19) (2023-09-28)
+
+
+### Features
+
+* **YouTube:** Add `Bypass URL redirects` patch ([125cac5](https://github.com/ReVanced/revanced-patches/commit/125cac5928c9b71d35253f1fd7651f4a30e15529))
+
+# [2.191.0-dev.18](https://github.com/ReVanced/revanced-patches/compare/v2.191.0-dev.17...v2.191.0-dev.18) (2023-09-28)
+
+
+### Features
+
+* **YouTube - Premium heading:** Allow using default heading ([#3029](https://github.com/ReVanced/revanced-patches/issues/3029)) ([d5ab35a](https://github.com/ReVanced/revanced-patches/commit/d5ab35a444523baa0586fcb9513d6ae4f2518946))
+
 # [2.191.0-dev.17](https://github.com/ReVanced/revanced-patches/compare/v2.191.0-dev.16...v2.191.0-dev.17) (2023-09-27)
 
 

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 2.191.0-dev.17
+version = 2.191.0-dev.20

src/main/kotlin/app/revanced/patches/youtube/layout/branding/header/PremiumHeadingPatch.kt

@@ -5,39 +5,57 @@ import app.revanced.patcher.patch.PatchException
 import app.revanced.patcher.patch.ResourcePatch
 import app.revanced.patcher.patch.annotation.CompatiblePackage
 import app.revanced.patcher.patch.annotation.Patch
-import java.nio.file.Files
+import app.revanced.patcher.patch.options.types.BooleanPatchOption.Companion.booleanPatchOption
-import java.nio.file.StandardCopyOption
+import kotlin.io.path.copyTo
-import kotlin.io.path.exists
 
 @Patch(
     name = "Premium heading",
-    description = "Shows premium branding on the home screen.",
+    description = "Show or hide the premium heading.",
     compatiblePackages = [
         CompatiblePackage("com.google.android.youtube")
     ]
 )
 @Suppress("unused")
 object PremiumHeadingPatch : ResourcePatch() {
+    private const val DEFAULT_HEADING_RES = "yt_wordmark_header"
+    private const val PREMIUM_HEADING_RES = "yt_premium_wordmark_header"
+
+    private val usePremiumHeading by booleanPatchOption(
+        key = "usePremiumHeading",
+        default = true,
+        title = "Use premium heading",
+        description = "Whether to use the premium heading.",
+        required = true,
+    )
+
     override fun execute(context: ResourceContext) {
         val resDirectory = context["res"]
-        if (!resDirectory.isDirectory) throw PatchException("The res folder can not be found.")
 
-        val (original, replacement) = "yt_premium_wordmark_header" to "yt_wordmark_header"
+        val (original, replacement) = if (usePremiumHeading!!)
-        val modes = arrayOf("light", "dark")
+            DEFAULT_HEADING_RES to PREMIUM_HEADING_RES
+        else
+            PREMIUM_HEADING_RES to DEFAULT_HEADING_RES
 
-        arrayOf("xxxhdpi", "xxhdpi", "xhdpi", "hdpi", "mdpi").forEach { size ->
+        val variants = arrayOf("light", "dark")
-            val headingDirectory = resDirectory.resolve("drawable-$size")
-            modes.forEach { mode ->
-                val fromPath = headingDirectory.resolve("${original}_$mode.png").toPath()
-                val toPath = headingDirectory.resolve("${replacement}_$mode.png").toPath()
 
-                if (!fromPath.exists())
+        arrayOf(
-                    throw PatchException("The file $fromPath does not exist in the resources. Therefore, this patch can not succeed.")
+            "xxxhdpi",
-                Files.copy(
+            "xxhdpi",
-                    fromPath,
+            "xhdpi",
-                    toPath,
+            "hdpi",
-                    StandardCopyOption.REPLACE_EXISTING
+            "mdpi"
-                )
+        ).mapNotNull { dpi ->
+            resDirectory.resolve("drawable-$dpi").takeIf { it.exists() }?.toPath()
+        }.also {
+            if (it.isEmpty())
+                throw PatchException("The drawable folder can not be found. Therefore, the patch can not be applied.")
+        }.forEach { path ->
+
+            variants.forEach { mode ->
+                val fromPath = path.resolve("${original}_$mode.png")
+                val toPath = path.resolve("${replacement}_$mode.png")
+
+                fromPath.copyTo(toPath, true)
             }
         }
     }

src/main/kotlin/app/revanced/patches/youtube/layout/hide/player/flyoutmenupanel/HidePlayerFlyoutMenuPatch.kt

@@ -24,7 +24,8 @@ import app.revanced.patches.youtube.misc.settings.SettingsPatch
             "18.20.39",
             "18.23.35",
             "18.29.38",
-            "18.32.39"
+            "18.32.39",
+            "18.37.36"
         ])
     ]
 )

src/main/kotlin/app/revanced/patches/youtube/layout/returnyoutubedislike/ReturnYouTubeDislikePatch.kt

@@ -51,9 +51,7 @@ object ReturnYouTubeDislikePatch : BytecodePatch(
     override fun execute(context: BytecodeContext) {
         // region Inject newVideoLoaded event handler to update dislikes when a new video is loaded.
 
-        // This patch needs a few adjustments and lots of testing before it can change to the new video id hook.
+        VideoIdPatch.hookVideoId("$INTEGRATIONS_CLASS_DESCRIPTOR->newVideoLoaded(Ljava/lang/String;)V")
-        // There's a few corner cases and some weirdness when loading new videos (specifically with detecting shorts).
-        VideoIdPatch.legacyInjectCall("$INTEGRATIONS_CLASS_DESCRIPTOR->newVideoLoaded(Ljava/lang/String;)V")
 
         // endregion
 

src/main/kotlin/app/revanced/patches/youtube/layout/sponsorblock/SponsorBlockBytecodePatch.kt

@@ -96,11 +96,8 @@ object SponsorBlockBytecodePatch : BytecodePatch(
 
         /*
          * Set current video id.
-         *
-         * The new video id hook seems to work without issues,
-         * but it's easier to keep using this hook as it's well tested and has no known problems.
          */
-        VideoIdPatch.legacyInjectCallBackgroundPlay("$INTEGRATIONS_SEGMENT_PLAYBACK_CONTROLLER_CLASS_DESCRIPTOR->setCurrentVideoId(Ljava/lang/String;)V")
+        VideoIdPatch.hookBackgroundPlayVideoId("$INTEGRATIONS_SEGMENT_PLAYBACK_CONTROLLER_CLASS_DESCRIPTOR->setCurrentVideoId(Ljava/lang/String;)V")
 
         /*
          * Seekbar drawing

src/main/kotlin/app/revanced/patches/youtube/misc/fix/playback/SpoofSignaturePatch.kt

@@ -88,7 +88,9 @@ object SpoofSignaturePatch : BytecodePatch(
         )
 
         // Hook the player parameters.
-        PlayerResponseMethodHookPatch.injectProtoBufferHook("$INTEGRATIONS_CLASS_DESCRIPTOR->spoofParameter(Ljava/lang/String;)Ljava/lang/String;")
+        PlayerResponseMethodHookPatch + PlayerResponseMethodHookPatch.Hook.ProtoBufferParameter(
+            "$INTEGRATIONS_CLASS_DESCRIPTOR->spoofParameter(Ljava/lang/String;)Ljava/lang/String;"
+        )
 
         // Force the seekbar time and chapters to always show up.
         // This is used only if the storyboard spec fetch fails, or when viewing paid videos.

src/main/kotlin/app/revanced/patches/youtube/misc/links/BypassURLRedirectsPatch.kt

@@ -0,0 +1,70 @@
+package app.revanced.patches.youtube.misc.links
+
+import app.revanced.extensions.exception
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.annotation.CompatiblePackage
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patches.shared.settings.preference.impl.StringResource
+import app.revanced.patches.shared.settings.preference.impl.SwitchPreference
+import app.revanced.patches.youtube.misc.integrations.IntegrationsPatch
+import app.revanced.patches.youtube.misc.links.fingerprints.OpenLinksDirectlyPrimaryFingerprint
+import app.revanced.patches.youtube.misc.links.fingerprints.OpenLinksDirectlySecondaryFingerprint
+import app.revanced.patches.youtube.misc.settings.SettingsPatch
+import com.android.tools.smali.dexlib2.iface.instruction.FiveRegisterInstruction
+
+@Patch(
+    name = "Bypass URL redirects",
+    description = "Bypass URL redirects and open the original URL directly.",
+    dependencies = [IntegrationsPatch::class, SettingsPatch::class],
+    compatiblePackages = [
+        CompatiblePackage(
+            "com.google.android.youtube",
+            [
+                "18.16.37",
+                "18.19.35",
+                "18.20.39",
+                "18.23.35",
+                "18.29.38",
+                "18.32.39",
+                "18.37.36"
+            ]
+        )
+    ]
+)
+object BypassURLRedirectsPatch : BytecodePatch(
+    setOf(OpenLinksDirectlyPrimaryFingerprint, OpenLinksDirectlySecondaryFingerprint)
+) {
+    override fun execute(context: BytecodeContext) {
+        SettingsPatch.PreferenceScreen.MISC.addPreferences(
+            SwitchPreference(
+                "revanced_bypass_url_redirects",
+                StringResource("revanced_bypass_url_redirects_title", "Bypass URL redirects"),
+                StringResource("revanced_bypass_url_redirects_summary_on", "URL redirects are bypassed"),
+                StringResource("revanced_bypass_url_redirects_summary_off", "URL redirects are not bypassed"),
+            )
+        )
+
+        arrayOf(
+            OpenLinksDirectlyPrimaryFingerprint,
+            OpenLinksDirectlySecondaryFingerprint
+        ).map {
+            it.result ?: throw it.exception
+        }.forEach { result ->
+            result.mutableMethod.apply {
+                val insertIndex = result.scanResult.patternScanResult!!.startIndex
+                val uriStringRegister = getInstruction<FiveRegisterInstruction>(insertIndex).registerC
+
+                replaceInstruction(
+                    insertIndex,
+                    "invoke-static {v$uriStringRegister}," +
+                            "Lapp/revanced/integrations/patches/BypassURLRedirectsPatch;" +
+                            "->" +
+                            "parseRedirectUri(Ljava/lang/String;)Landroid/net/Uri;"
+                )
+            }
+        }
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/misc/links/fingerprints/OpenLinksDirectlyPrimaryFingerprint.kt

@@ -0,0 +1,20 @@
+package app.revanced.patches.youtube.misc.links.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+
+object OpenLinksDirectlyPrimaryFingerprint : MethodFingerprint(
+    returnType = "Ljava/lang/Object",
+    accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
+    parameters = listOf("Ljava/lang/Object"),
+    opcodes = listOf(
+        Opcode.INVOKE_STATIC,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.RETURN_OBJECT,
+        Opcode.CHECK_CAST,
+        Opcode.SGET,
+        Opcode.SGET_OBJECT
+    )
+)

src/main/kotlin/app/revanced/patches/youtube/misc/links/fingerprints/OpenLinksDirectlySecondaryFingerprint.kt

@@ -0,0 +1,17 @@
+package app.revanced.patches.youtube.misc.links.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+
+object OpenLinksDirectlySecondaryFingerprint : MethodFingerprint(
+    returnType = "Landroid/net/Uri",
+    accessFlags = AccessFlags.PUBLIC or AccessFlags.STATIC,
+    parameters = listOf("Ljava/lang/String"),
+    opcodes = listOf(
+        Opcode.INVOKE_STATIC,
+        Opcode.MOVE_RESULT_OBJECT
+    ),
+    strings = listOf("://")
+)

src/main/kotlin/app/revanced/patches/youtube/video/information/VideoInformationPatch.kt

@@ -109,9 +109,13 @@ object VideoInformationPatch : BytecodePatch(
         }
 
         /*
-         * Inject call for video id
+         * Inject call for video ids
          */
-        VideoIdPatch.injectCall("$INTEGRATIONS_CLASS_DESCRIPTOR->setVideoId(Ljava/lang/String;)V")
+        val videoIdMethodDescriptor = "$INTEGRATIONS_CLASS_DESCRIPTOR->setVideoId(Ljava/lang/String;)V"
+        VideoIdPatch.hookVideoId(videoIdMethodDescriptor)
+        VideoIdPatch.hookBackgroundPlayVideoId(videoIdMethodDescriptor)
+        VideoIdPatch.hookPlayerResponseVideoId(
+            "$INTEGRATIONS_CLASS_DESCRIPTOR->setPlayerResponseVideoId(Ljava/lang/String;)V")
 
         /*
          * Set the video time method

src/main/kotlin/app/revanced/patches/youtube/video/playerresponse/PlayerResponseMethodHookPatch.kt

@@ -7,66 +7,58 @@ import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
 import app.revanced.patcher.patch.BytecodePatch
 import app.revanced.patcher.patch.annotation.Patch
 import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
-import app.revanced.patches.youtube.misc.fix.playback.SpoofSignaturePatch
 import app.revanced.patches.youtube.misc.integrations.IntegrationsPatch
 import app.revanced.patches.youtube.video.playerresponse.fingerprint.PlayerParameterBuilderFingerprint
-import app.revanced.patches.youtube.video.videoid.VideoIdPatch
+import java.io.Closeable
 
 @Patch(
     dependencies = [IntegrationsPatch::class],
 )
-object PlayerResponseMethodHookPatch : BytecodePatch(
+object PlayerResponseMethodHookPatch :
-    setOf(
+    BytecodePatch(setOf(PlayerParameterBuilderFingerprint)),
-        PlayerParameterBuilderFingerprint,
+    Closeable,
-    )
+    MutableSet<PlayerResponseMethodHookPatch.Hook> by mutableSetOf() {
-) {
+    private const val VIDEO_ID_PARAMETER = 1
-    private const val playerResponseVideoIdParameter = 1
+    private const val PROTO_BUFFER_PARAMETER_PARAMETER = 3
-    private const val playerResponseProtoBufferParameter = 3
+
-    /**
-     * Insert index when adding a video id hook.
-     */
-    private var playerResponseVideoIdInsertIndex = 0
-    /**
-     * Insert index when adding a proto buffer override.
-     * Must be after all video id hooks in the same method.
-     */
-    private var playerResponseProtoBufferInsertIndex = 0
     private lateinit var playerResponseMethod: MutableMethod
 
     override fun execute(context: BytecodeContext) {
-
+        playerResponseMethod = PlayerParameterBuilderFingerprint.result?.mutableMethod
-        // Hook player parameter.
+            ?: throw PlayerParameterBuilderFingerprint.exception
-        PlayerParameterBuilderFingerprint.result?.let {
-            playerResponseMethod = it.mutableMethod
-        } ?: throw PlayerParameterBuilderFingerprint.exception
     }
 
-    /**
+    override fun close() {
-     * Modify the player parameter proto buffer value.
+        fun hookVideoId(hook: Hook) = playerResponseMethod.addInstruction(
-     * Used exclusively by [SpoofSignaturePatch].
+            0, "invoke-static {p$VIDEO_ID_PARAMETER}, $hook"
-     */
+        )
-    fun injectProtoBufferHook(methodDescriptor: String) {
+
-        playerResponseMethod.addInstructions(
+        fun hookProtoBufferParameter(hook: Hook) = playerResponseMethod.addInstructions(
-            playerResponseProtoBufferInsertIndex,
+            0,
             """
-               invoke-static {p$playerResponseProtoBufferParameter}, $methodDescriptor
+                invoke-static {p$PROTO_BUFFER_PARAMETER_PARAMETER}, $hook
-               move-result-object p$playerResponseProtoBufferParameter
+                move-result-object p$PROTO_BUFFER_PARAMETER_PARAMETER
             """
         )
-        playerResponseProtoBufferInsertIndex += 2
+
+        // Reverse the order in order to preserve insertion order of the hooks.
+        val beforeVideoIdHooks = filterIsInstance<Hook.ProtoBufferParameterBeforeVideoId>().asReversed()
+        val videoIdHooks = filterIsInstance<Hook.VideoId>().asReversed()
+        val afterVideoIdHooks = filterIsInstance<Hook.ProtoBufferParameter>().asReversed()
+
+        // Add the hooks in this specific order as they insert instructions at the beginning of the method.
+        afterVideoIdHooks.forEach(::hookProtoBufferParameter)
+        videoIdHooks.forEach(::hookVideoId)
+        beforeVideoIdHooks.forEach(::hookProtoBufferParameter)
     }
 
-    /**
+    internal abstract class Hook(private val methodDescriptor: String) {
-     * Used by [VideoIdPatch].
+        internal class VideoId(methodDescriptor: String) : Hook(methodDescriptor)
-     */
+
-    internal fun injectVideoIdHook(methodDescriptor: String) {
+        internal class ProtoBufferParameter(methodDescriptor: String) : Hook(methodDescriptor)
-        playerResponseMethod.addInstruction(
+        internal class ProtoBufferParameterBeforeVideoId(methodDescriptor: String) : Hook(methodDescriptor)
-            // Keep injection calls in the order they're added,
+
-            // and all video id hooks run before proto buffer hooks.
+        override fun toString() = methodDescriptor
-            playerResponseVideoIdInsertIndex++,
-            "invoke-static {p$playerResponseVideoIdParameter}, $methodDescriptor"
-        )
-        playerResponseProtoBufferInsertIndex++
     }
 }
 

src/main/kotlin/app/revanced/patches/youtube/video/videoid/VideoIdPatch.kt

@@ -26,8 +26,8 @@ object VideoIdPatch : BytecodePatch(
     )
 ) {
     private var videoIdRegister = 0
-    private var insertIndex = 0
+    private var videoIdInsertIndex = 0
-    private lateinit var insertMethod: MutableMethod
+    private lateinit var videoIdMethod: MutableMethod
 
     private var backgroundPlaybackVideoIdRegister = 0
     private var backgroundPlaybackInsertIndex = 0
@@ -52,8 +52,8 @@ object VideoIdPatch : BytecodePatch(
         } ?: throw VideoIdFingerprint.exception
 
         VideoIdFingerprint.setFields { method, index, register ->
-            insertMethod = method
+            videoIdMethod = method
-            insertIndex = index
+            videoIdInsertIndex = index
             videoIdRegister = register
         }
 
@@ -65,21 +65,7 @@ object VideoIdPatch : BytecodePatch(
     }
 
     /**
-     * Adds an invoke-static instruction, called with the new id when the video changes.
+     * Hooks the new video id when the video changes.
-     *
-     * Called as soon as the player response is parsed, and called before many other hooks are
-     * updated such as [PlayerTypeHookPatch].
-     *
-     * Supports all videos and functions in all situations.
-     *
-     * Be aware, this can be called multiple times for the same video id.
-     *
-     * @param methodDescriptor which method to call. Params have to be `Ljava/lang/String;`
-     */
-    fun injectCall(methodDescriptor: String) = PlayerResponseMethodHookPatch.injectVideoIdHook(methodDescriptor)
-
-    /**
-     * Adds an invoke-static instruction, called with the new id when the video changes.
      *
      * Supports all videos (regular videos and Shorts).
      *
@@ -89,10 +75,10 @@ object VideoIdPatch : BytecodePatch(
      *
      * @param methodDescriptor which method to call. Params have to be `Ljava/lang/String;`
      */
-    fun legacyInjectCall(
+    fun hookVideoId(
         methodDescriptor: String
-    ) = insertMethod.addInstruction(
+    ) = videoIdMethod.addInstruction(
-        insertIndex++,
+        videoIdInsertIndex++,
         "invoke-static {v$videoIdRegister}, $methodDescriptor"
     )
 
@@ -106,11 +92,37 @@ object VideoIdPatch : BytecodePatch(
      *
      * @param methodDescriptor which method to call. Params have to be `Ljava/lang/String;`
      */
-    fun legacyInjectCallBackgroundPlay(
+    fun hookBackgroundPlayVideoId(
         methodDescriptor: String
     ) = backgroundPlaybackMethod.addInstruction(
         backgroundPlaybackInsertIndex++, // move-result-object offset
         "invoke-static {v$backgroundPlaybackVideoIdRegister}, $methodDescriptor"
     )
+
+    /**
+     * Hooks the video id of every video when loaded.
+     * Supports all videos and functions in all situations.
+     *
+     * Hook is always called off the main thread.
+     *
+     * This hook is called as soon as the player response is parsed,
+     * and called before many other hooks are updated such as [PlayerTypeHookPatch].
+     *
+     * Note: The video id returned here may not be the current video that's being played.
+     * It's common for multiple Shorts to load at once in preparation
+     * for the user swiping to the next Short.
+     *
+     * For most use cases, you probably want to use
+     * [hookVideoId] or [hookBackgroundPlayVideoId] instead.
+     *
+     * Be aware, this can be called multiple times for the same video id.
+     *
+     * @param methodDescriptor which method to call. Params have to be `Ljava/lang/String;`
+     */
+    fun hookPlayerResponseVideoId(methodDescriptor: String) {
+        PlayerResponseMethodHookPatch + PlayerResponseMethodHookPatch.Hook.VideoId(
+            methodDescriptor
+        )
+    }
 }