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

api/revanced-patches.api

@@ -1631,12 +1631,10 @@ public final class app/revanced/patches/youtube/misc/dimensions/spoof/SpoofDevic
  public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 }
 
-public final class app/revanced/patches/youtube/misc/fix/playback/ClientSpoofPatch : app/revanced/patches/all/misc/transformation/BaseTransformInstructionsPatch {
- public static final field INSTANCE Lapp/revanced/patches/youtube/misc/fix/playback/ClientSpoofPatch;
- 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/misc/fix/playback/SpoofClientPatch : app/revanced/patcher/patch/BytecodePatch {
+ public static final field INSTANCE Lapp/revanced/patches/youtube/misc/fix/playback/SpoofClientPatch;
+ public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
+ public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 }
 
 public final class app/revanced/patches/youtube/misc/fix/playback/SpoofSignaturePatch : app/revanced/patcher/patch/BytecodePatch {
@@ -1651,6 +1649,14 @@ public final class app/revanced/patches/youtube/misc/fix/playback/SpoofSignature
  public fun execute (Lapp/revanced/patcher/data/ResourceContext;)V
 }
 
+public final class app/revanced/patches/youtube/misc/fix/playback/UserAgentClientSpoofPatch : app/revanced/patches/all/misc/transformation/BaseTransformInstructionsPatch {
+ public static final field INSTANCE Lapp/revanced/patches/youtube/misc/fix/playback/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/misc/gms/GmsCoreSupportPatch : app/revanced/patches/shared/misc/gms/BaseGmsCoreSupportPatch {
  public static final field INSTANCE Lapp/revanced/patches/youtube/misc/gms/GmsCoreSupportPatch;
 }

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

@@ -0,0 +1,335 @@
+package app.revanced.patches.youtube.misc.fix.playback
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.getInstructions
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.PatchException
+import app.revanced.patcher.patch.annotation.CompatiblePackage
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patches.all.misc.resources.AddResourcesPatch
+import app.revanced.patches.shared.misc.settings.preference.PreferenceScreen
+import app.revanced.patches.shared.misc.settings.preference.PreferenceScreen.Sorting
+import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
+import app.revanced.patches.youtube.misc.fix.playback.fingerprints.*
+import app.revanced.patches.youtube.misc.settings.SettingsPatch
+import app.revanced.patches.youtube.video.playerresponse.PlayerResponseMethodHookPatch
+import app.revanced.util.getReference
+import app.revanced.util.resultOrThrow
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.builder.MutableMethodImplementation
+import com.android.tools.smali.dexlib2.iface.instruction.FiveRegisterInstruction
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
+import com.android.tools.smali.dexlib2.iface.reference.FieldReference
+import com.android.tools.smali.dexlib2.iface.reference.TypeReference
+import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
+import com.android.tools.smali.dexlib2.immutable.ImmutableMethodParameter
+
+@Patch(
+ name = "Spoof client",
+ description = "Spoofs the client to allow video playback.",
+ dependencies = [
+ SpoofClientResourcePatch::class,
+ PlayerResponseMethodHookPatch::class,
+ SettingsPatch::class,
+ AddResourcesPatch::class,
+ UserAgentClientSpoofPatch::class,
+ PlayerResponseMethodHookPatch::class,
+ ],
+ compatiblePackages = [
+ CompatiblePackage(
+ "com.google.android.youtube",
+ [
+ "18.37.36",
+ "18.38.44",
+ "18.43.45",
+ "18.44.41",
+ "18.45.43",
+ "18.48.39",
+ "18.49.37",
+ "19.01.34",
+ "19.02.39",
+ "19.03.36",
+ "19.04.38",
+ "19.05.36",
+ "19.06.39",
+ "19.07.40",
+ "19.08.36",
+ "19.09.38",
+ "19.10.39",
+ "19.11.43",
+ ],
+ ),
+ ],
+)
+object SpoofClientPatch : BytecodePatch(
+ setOf(
+ // Client type spoof.
+ BuildInitPlaybackRequestFingerprint,
+ BuildPlayerRequestURIFingerprint,
+ SetPlayerRequestClientTypeFingerprint,
+ CreatePlayerRequestBodyFingerprint,
+
+ // Storyboard spoof.
+ StoryboardRendererSpecFingerprint,
+ PlayerResponseModelImplRecommendedLevelFingerprint,
+ StoryboardRendererDecoderRecommendedLevelFingerprint,
+ PlayerResponseModelImplGeneralFingerprint,
+ StoryboardRendererDecoderSpecFingerprint,
+ ),
+) {
+ private const val INTEGRATIONS_CLASS_DESCRIPTOR =
+ "Lapp/revanced/integrations/youtube/patches/spoof/SpoofClientPatch;"
+ private const val CLIENT_INFO_CLASS_DESCRIPTOR =
+ "Lcom/google/protos/youtube/api/innertube/InnertubeContext\$ClientInfo;"
+
+ override fun execute(context: BytecodeContext) {
+ AddResourcesPatch(this::class)
+
+ SettingsPatch.PreferenceScreen.MISC.addPreferences(
+ PreferenceScreen(
+ key = "revanced_spoof_client_screen",
+ sorting = Sorting.UNSORTED,
+ preferences = setOf(
+ SwitchPreference("revanced_spoof_client"),
+ SwitchPreference("revanced_spoof_client_use_ios"),
+ ),
+ ),
+
+ )
+
+ // region Block /initplayback requests to fall back to /get_watch requests.
+
+ BuildInitPlaybackRequestFingerprint.resultOrThrow().let {
+ val moveUriStringIndex = it.scanResult.patternScanResult!!.startIndex
+
+ it.mutableMethod.apply {
+ val targetRegister = getInstruction<OneRegisterInstruction>(moveUriStringIndex).registerA
+
+ addInstructions(
+ moveUriStringIndex + 1,
+ """
+ invoke-static { v$targetRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->blockInitPlaybackRequest(Ljava/lang/String;)Ljava/lang/String;
+ move-result-object v$targetRegister
+ """,
+ )
+ }
+ }
+
+ // endregion
+
+ // region Block /get_watch requests to fall back to /player requests.
+
+ BuildPlayerRequestURIFingerprint.resultOrThrow().let {
+ val invokeToStringIndex = it.scanResult.patternScanResult!!.startIndex
+
+ it.mutableMethod.apply {
+ val uriRegister = getInstruction<FiveRegisterInstruction>(invokeToStringIndex).registerC
+
+ addInstructions(
+ invokeToStringIndex,
+ """
+ invoke-static { v$uriRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->blockGetWatchRequest(Landroid/net/Uri;)Landroid/net/Uri;
+ move-result-object v$uriRegister
+ """,
+ )
+ }
+ }
+
+ // endregion
+
+ // region Get field references to be used below.
+
+ val (clientInfoField, clientInfoClientTypeField, clientInfoClientVersionField) =
+ SetPlayerRequestClientTypeFingerprint.resultOrThrow().let { result ->
+ // Field in the player request object that holds the client info object.
+ val clientInfoField = result.mutableMethod
+ .getInstructions().first { instruction ->
+ // requestMessage.clientInfo = clientInfoBuilder.build();
+ instruction.opcode == Opcode.IPUT_OBJECT &&
+ instruction.getReference<FieldReference>()?.type == CLIENT_INFO_CLASS_DESCRIPTOR
+ }.getReference<FieldReference>() ?: throw PatchException("Could not find clientInfoField")
+
+ // Client info object's client type field.
+ val clientInfoClientTypeField = result.mutableMethod
+ .getInstruction(result.scanResult.patternScanResult!!.endIndex)
+ .getReference<FieldReference>() ?: throw PatchException("Could not find clientInfoClientTypeField")
+
+ // Client info object's client version field.
+ val clientInfoClientVersionField = result.mutableMethod
+ .getInstruction(result.scanResult.stringsScanResult!!.matches.first().index + 1)
+ .getReference<FieldReference>() ?: throw PatchException("Could not find clientInfoClientVersionField")
+
+ Triple(clientInfoField, clientInfoClientTypeField, clientInfoClientVersionField)
+ }
+
+ // endregion
+
+ // region Spoof client type for /player requests.
+
+ CreatePlayerRequestBodyFingerprint.resultOrThrow().let { result ->
+ val setClientInfoMethodName = "patch_setClientInfo"
+ val checkCastIndex = result.scanResult.patternScanResult!!.startIndex
+ var clientInfoContainerClassName: String
+
+ result.mutableMethod.apply {
+ val checkCastInstruction = getInstruction<OneRegisterInstruction>(checkCastIndex)
+ val requestMessageInstanceRegister = checkCastInstruction.registerA
+ clientInfoContainerClassName = checkCastInstruction.getReference<TypeReference>()!!.type
+
+ addInstruction(
+ checkCastIndex + 1,
+ "invoke-static { v$requestMessageInstanceRegister }," +
+ " ${result.classDef.type}->$setClientInfoMethodName($clientInfoContainerClassName)V",
+ )
+ }
+
+ // Change requestMessage.clientInfo.clientType and requestMessage.clientInfo.clientVersion to the spoofed values.
+ // Do this in a helper method, to remove the need of picking out multiple free registers from the hooked code.
+ result.mutableClass.methods.add(
+ ImmutableMethod(
+ result.mutableClass.type,
+ setClientInfoMethodName,
+ listOf(ImmutableMethodParameter(clientInfoContainerClassName, null, "clientInfoContainer")),
+ "V",
+ AccessFlags.PRIVATE or AccessFlags.STATIC,
+ null,
+ null,
+ MutableMethodImplementation(3),
+ ).toMutable().apply {
+ addInstructions(
+ """
+ invoke-static { }, $INTEGRATIONS_CLASS_DESCRIPTOR->isClientSpoofingEnabled()Z
+ move-result v0
+ if-eqz v0, :disabled
+
+ iget-object v0, p0, $clientInfoField
+
+ # Set client type to the spoofed value.
+ iget v1, v0, $clientInfoClientTypeField
+ invoke-static { v1 }, $INTEGRATIONS_CLASS_DESCRIPTOR->getClientTypeId(I)I
+ move-result v1
+ iput v1, v0, $clientInfoClientTypeField
+
+ # Set client version to the spoofed value.
+ iget-object v1, v0, $clientInfoClientVersionField
+ invoke-static { v1 }, $INTEGRATIONS_CLASS_DESCRIPTOR->getClientVersion(Ljava/lang/String;)Ljava/lang/String;
+ move-result-object v1
+ iput-object v1, v0, $clientInfoClientVersionField
+
+ :disabled
+ return-void
+ """,
+ )
+ },
+ )
+ }
+
+ // endregion
+
+ // region Fix storyboard if Android Testsuite is used.
+
+ PlayerResponseMethodHookPatch += PlayerResponseMethodHookPatch.Hook.ProtoBufferParameter(
+ "$INTEGRATIONS_CLASS_DESCRIPTOR->setPlayerResponseVideoId(" +
+ "Ljava/lang/String;Ljava/lang/String;Z)Ljava/lang/String;",
+ )
+
+ // Hook recommended seekbar thumbnails quality level for regular videos.
+ StoryboardRendererDecoderRecommendedLevelFingerprint.resultOrThrow().let {
+ val endIndex = it.scanResult.patternScanResult!!.endIndex
+
+ it.mutableMethod.apply {
+ val originalValueRegister =
+ getInstruction<OneRegisterInstruction>(endIndex).registerA
+
+ addInstructions(
+ endIndex + 1,
+ """
+ invoke-static { v$originalValueRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getRecommendedLevel(I)I
+ move-result v$originalValueRegister
+ """,
+ )
+ }
+ }
+
+ // Hook the recommended precise seeking thumbnails quality.
+ PlayerResponseModelImplRecommendedLevelFingerprint.resultOrThrow().let {
+ val endIndex = it.scanResult.patternScanResult!!.endIndex
+
+ it.mutableMethod.apply {
+ val originalValueRegister =
+ getInstruction<OneRegisterInstruction>(endIndex).registerA
+
+ addInstructions(
+ endIndex,
+ """
+ invoke-static { v$originalValueRegister }, $INTEGRATIONS_CLASS_DESCRIPTOR->getRecommendedLevel(I)I
+ move-result v$originalValueRegister
+ """,
+ )
+ }
+ }
+
+ // TODO: Hook the seekbar recommended level for Shorts to fix Shorts low quality seekbar thumbnails.
+
+ /**
+ * Hook StoryBoard renderer url.
+ */
+ PlayerResponseModelImplGeneralFingerprint.resultOrThrow().let {
+ val getStoryBoardIndex = it.scanResult.patternScanResult!!.endIndex
+
+ it.mutableMethod.apply {
+ 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 the seekbar thumbnail decoder, required for Shorts.
+ StoryboardRendererDecoderSpecFingerprint.resultOrThrow().let {
+ val storyBoardUrlIndex = it.scanResult.patternScanResult!!.startIndex + 1
+
+ it.mutableMethod.apply {
+ val getStoryBoardRegister = getInstruction<OneRegisterInstruction>(storyBoardUrlIndex).registerA
+
+ addInstructions(
+ storyBoardUrlIndex + 1,
+ """
+ invoke-static { v$getStoryBoardRegister }, ${INTEGRATIONS_CLASS_DESCRIPTOR}->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
+ move-result-object v$getStoryBoardRegister
+ """,
+ )
+ }
+ }
+
+ StoryboardRendererSpecFingerprint.resultOrThrow().let {
+ it.mutableMethod.apply {
+ val storyBoardUrlParams = "p0"
+
+ addInstructions(
+ 0,
+ """
+ if-nez $storyBoardUrlParams, :ignore
+ invoke-static { $storyBoardUrlParams }, $INTEGRATIONS_CLASS_DESCRIPTOR->getStoryboardRendererSpec(Ljava/lang/String;)Ljava/lang/String;
+ move-result-object $storyBoardUrlParams
+ :ignore
+ nop
+ """,
+ )
+ }
+ }
+
+ // endregion
+ }
+}

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

@@ -0,0 +1,18 @@
+package app.revanced.patches.youtube.misc.fix.playback
+
+import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.ResourcePatch
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patches.shared.misc.mapping.ResourceMappingPatch
+
+@Patch(dependencies = [ResourceMappingPatch::class])
+internal object SpoofClientResourcePatch : ResourcePatch() {
+ internal var scrubbedPreviewThumbnailResourceId: Long = -1
+
+ override fun execute(context: ResourceContext) {
+ scrubbedPreviewThumbnailResourceId = ResourceMappingPatch[
+ "id",
+ "thumbnail",
+ ]
+ }
+}