fix(YouTube - Client spoof): Spoof client to fix playback

api/revanced-patches.api

@@ -759,6 +759,7 @@ public final class app/revanced/patches/shared/mapping/ResourceMappingPatch : ap
 	public static final field INSTANCE Lapp/revanced/patches/shared/mapping/ResourceMappingPatch;
 	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 	public fun execute (Lapp/revanced/patcher/data/ResourceContext;)V
+	public final fun get (Ljava/lang/String;Ljava/lang/String;)J
 	public final fun getId (Lapp/revanced/patches/shared/mapping/ResourceType;Ljava/lang/String;)J
 }
 
@@ -1284,8 +1285,12 @@ public final class app/revanced/patches/youtube/utils/controlsoverlay/ControlsOv
 	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 }
 
-public final class app/revanced/patches/youtube/utils/fix/clientspoof/ClientSpoofPatch : app/revanced/patches/shared/clientspoof/BaseClientSpoofPatch {
-	public static final field INSTANCE Lapp/revanced/patches/youtube/utils/fix/clientspoof/ClientSpoofPatch;
+public final class app/revanced/patches/youtube/utils/fix/clientspoof/UserAgentClientSpoofPatch : app/revanced/patches/shared/transformation/BaseTransformInstructionsPatch {
+	public static final field INSTANCE Lapp/revanced/patches/youtube/utils/fix/clientspoof/UserAgentClientSpoofPatch;
+	public synthetic fun filterMap (Lcom/android/tools/smali/dexlib2/iface/ClassDef;Lcom/android/tools/smali/dexlib2/iface/Method;Lcom/android/tools/smali/dexlib2/iface/instruction/Instruction;I)Ljava/lang/Object;
+	public fun filterMap (Lcom/android/tools/smali/dexlib2/iface/ClassDef;Lcom/android/tools/smali/dexlib2/iface/Method;Lcom/android/tools/smali/dexlib2/iface/instruction/Instruction;I)Lkotlin/Triple;
+	public synthetic fun transform (Lapp/revanced/patcher/util/proxy/mutableTypes/MutableMethod;Ljava/lang/Object;)V
+	public fun transform (Lapp/revanced/patcher/util/proxy/mutableTypes/MutableMethod;Lkotlin/Triple;)V
 }
 
 public final class app/revanced/patches/youtube/utils/fix/doublebacktoclose/DoubleBackToClosePatch : app/revanced/patcher/patch/BytecodePatch {

src/main/kotlin/app/revanced/patches/shared/mapping/ResourceMappingPatch.kt

@@ -3,7 +3,7 @@ package app.revanced.patches.shared.mapping
 import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.ResourcePatch
 import org.w3c.dom.Element
-import java.util.Collections
+import java.util.*
 import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 
@@ -57,6 +57,10 @@ object ResourceMappingPatch : ResourcePatch() {
         resourceMappings = mappings
     }
 
+    operator fun get(type: String, name: String) = resourceMappings.first {
+        it.type == type && it.name == name
+    }.id
+
     data class ResourceElement(val type: String, val name: String, val id: Long)
 
     fun getId(resourceType: ResourceType, resourceName: String) = resourceMappings

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/UserAgentClientSpoofPatch.kt

@@ -0,0 +1,77 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof
+
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
+import app.revanced.patches.shared.transformation.BaseTransformInstructionsPatch
+import app.revanced.patches.shared.transformation.IMethodCall
+import app.revanced.patches.shared.transformation.Instruction35cInfo
+import app.revanced.patches.shared.transformation.filterMapInstruction35c
+import app.revanced.util.getReference
+import com.android.tools.smali.dexlib2.iface.ClassDef
+import com.android.tools.smali.dexlib2.iface.Method
+import com.android.tools.smali.dexlib2.iface.instruction.Instruction
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
+import com.android.tools.smali.dexlib2.iface.reference.MethodReference
+
+object UserAgentClientSpoofPatch : BaseTransformInstructionsPatch<Instruction35cInfo>() {
+    private const val ORIGINAL_PACKAGE_NAME = "com.google.android.youtube"
+    private const val USER_AGENT_STRING_BUILDER_APPEND_METHOD_REFERENCE =
+        "Ljava/lang/StringBuilder;->append(Ljava/lang/String;)Ljava/lang/StringBuilder;"
+
+    override fun filterMap(
+        classDef: ClassDef,
+        method: Method,
+        instruction: Instruction,
+        instructionIndex: Int,
+    ) = filterMapInstruction35c<MethodCall>(
+        "Lapp/revanced/integrations",
+        classDef,
+        instruction,
+        instructionIndex,
+    )
+
+    override fun transform(mutableMethod: MutableMethod, entry: Instruction35cInfo) {
+        val (_, _, instructionIndex) = entry
+
+        // Replace the result of context.getPackageName(), if it is used in a user agent string.
+        mutableMethod.apply {
+            // After context.getPackageName() the result is moved to a register.
+            val targetRegister = (
+                    getInstruction(instructionIndex + 1)
+                            as? OneRegisterInstruction ?: return
+                    ).registerA
+
+            // IndexOutOfBoundsException is not possible here,
+            // but no such occurrences are present in the app.
+            val referee = getInstruction(instructionIndex + 2).getReference<MethodReference>()?.toString()
+
+            // This can technically also match non-user agent string builder append methods,
+            // but no such occurrences are present in the app.
+            if (referee != USER_AGENT_STRING_BUILDER_APPEND_METHOD_REFERENCE) {
+                return
+            }
+
+            // Overwrite the result of context.getPackageName() with the original package name.
+            replaceInstruction(
+                instructionIndex + 1,
+                "const-string v$targetRegister, \"$ORIGINAL_PACKAGE_NAME\"",
+            )
+        }
+    }
+
+    @Suppress("unused")
+    private enum class MethodCall(
+        override val definedClassName: String,
+        override val methodName: String,
+        override val methodParams: Array<String>,
+        override val returnType: String,
+    ) : IMethodCall {
+        GetPackageName(
+            "Landroid/content/Context;",
+            "getPackageName",
+            emptyArray(),
+            "Ljava/lang/String;",
+        ),
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/fingerprints/BuildInitPlaybackRequestFingerprint.kt

@@ -0,0 +1,16 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof.fingerprints
+
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object BuildInitPlaybackRequestFingerprint : MethodFingerprint(
+    returnType = "Lorg/chromium/net/UrlRequest\$Builder;",
+    opcodes = listOf(
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.IGET_OBJECT, // Moves the request URI string to a register to build the request with.
+    ),
+    strings = listOf(
+        "Content-Type",
+        "Range",
+    ),
+)

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/fingerprints/BuildPlayerRequestURIFingerprint.kt

@@ -0,0 +1,21 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof.fingerprints
+
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object BuildPlayerRequestURIFingerprint : MethodFingerprint(
+    returnType = "Ljava/lang/String;",
+    opcodes = listOf(
+        Opcode.INVOKE_VIRTUAL, // Register holds player request URI.
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.IPUT_OBJECT,
+        Opcode.IGET_OBJECT,
+        Opcode.MONITOR_EXIT,
+        Opcode.RETURN_OBJECT,
+    ),
+    strings = listOf(
+        "youtubei/v1",
+        "key",
+        "asig",
+    ),
+)

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/fingerprints/CreatePlayerRequestBodyFingerprint.kt

@@ -0,0 +1,15 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof.fingerprints
+
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object CreatePlayerRequestBodyFingerprint : MethodFingerprint(
+    returnType = "V",
+    parameters = listOf("L"),
+    opcodes = listOf(
+        Opcode.CHECK_CAST,
+        Opcode.IGET,
+        Opcode.AND_INT_LIT16,
+    ),
+    strings = listOf("ms"),
+)

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/fingerprints/CreatePlayerRequestBodyWithModelFingerprint.kt

@@ -0,0 +1,18 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import app.revanced.util.getReference
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.iface.reference.FieldReference
+
+internal object CreatePlayerRequestBodyWithModelFingerprint : MethodFingerprint(
+    returnType = "L",
+    accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
+    parameters = listOf(),
+    customFingerprint = { methodDef, _ ->
+        methodDef.implementation!!.instructions.any {
+            it.getReference<FieldReference>().toString() == "Landroid/os/Build;->MODEL:Ljava/lang/String;"
+        }
+    },
+)

src/main/kotlin/app/revanced/patches/youtube/utils/fix/clientspoof/fingerprints/SetPlayerRequestClientTypeFingerprint.kt

@@ -0,0 +1,12 @@
+package app.revanced.patches.youtube.utils.fix.clientspoof.fingerprints
+
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object SetPlayerRequestClientTypeFingerprint : MethodFingerprint(
+    strings = listOf("10.29"),
+    opcodes = listOf(
+        Opcode.IGET,
+        Opcode.IPUT, // Sets ClientInfo.clientId.
+    ),
+)

src/main/kotlin/app/revanced/patches/youtube/utils/gms/GmsCoreSupportPatch.kt

@@ -3,8 +3,8 @@ package app.revanced.patches.youtube.utils.gms
 import app.revanced.patches.shared.gms.BaseGmsCoreSupportPatch
 import app.revanced.patches.shared.packagename.PackageNamePatch
 import app.revanced.patches.shared.packagename.PackageNamePatch.ORIGINAL_PACKAGE_NAME_YOUTUBE
+import app.revanced.patches.youtube.misc.test.SpoofTestClientPatch
 import app.revanced.patches.youtube.utils.compatibility.Constants.COMPATIBLE_PACKAGE
-import app.revanced.patches.youtube.utils.fix.clientspoof.ClientSpoofPatch
 import app.revanced.patches.youtube.utils.integrations.IntegrationsPatch
 import app.revanced.patches.youtube.utils.mainactivity.fingerprints.MainActivityFingerprint
 import app.revanced.patches.youtube.utils.settings.SettingsPatch
@@ -14,7 +14,7 @@ object GmsCoreSupportPatch : BaseGmsCoreSupportPatch(
     fromPackageName = ORIGINAL_PACKAGE_NAME_YOUTUBE,
     mainActivityOnCreateFingerprint = MainActivityFingerprint,
     integrationsPatchDependency = IntegrationsPatch::class,
-    dependencies = setOf(ClientSpoofPatch::class, PackageNamePatch::class, SettingsPatch::class),
+    dependencies = setOf(SpoofTestClientPatch::class, PackageNamePatch::class, SettingsPatch::class),
     gmsCoreSupportResourcePatch = GmsCoreSupportResourcePatch,
     compatiblePackages = COMPATIBLE_PACKAGE
 )

src/main/resources/youtube/settings/host/values/strings.xml

@@ -1293,6 +1293,12 @@ Limitations:
 • This client is used for testing purposes, so most YouTube features are not available.
 • There are no playback buffer issues in the test client."</string>
 	<string name="revanced_spoof_test_client_title">Spoof test client</string>
+	<string name="revanced_spoof_client_use_testsuite_title">Spoof client to Android Testsuite</string>
+	<string name="revanced_spoof_client_use_testsuite_summary">Spoof the client to Android Testsuite</string>
+	<string name="revanced_spoof_client_use_testsuite_summary_on">Client is spoofed to an Android Testsuite client (iOS client is used for live streams)\n\nSide effects include, but are not limited to:\n• Speed flyout menu is missing\n• Captions are missing\n• Player swipe gestures may not work\n• Low quality Shorts seekbar thumbnails\n• Watch history may not work</string>
+	<string name="revanced_spoof_client_use_testsuite_summary_off">Client is spoofed to an iOS client\n\nSide effects include:\n• No HDR video\n• Speed flyout menu is missing</string>
+
+
 	<string name="revanced_swipe_gestures_lock_mode_summary_off">"Swipe gestures are disabled in 'Lock screen' mode."</string>
 	<string name="revanced_swipe_gestures_lock_mode_summary_on">"Swipe gestures are enabled in 'Lock screen' mode."</string>
 	<string name="revanced_swipe_gestures_lock_mode_title">"Swipe gestures in 'Lock screen' mode"</string>