feat(YouTube Music): Add Force original audio patch (#6036)

patches/src/main/kotlin/app/revanced/patches/music/misc/tracks/ForceOriginalAudioPatch.kt

@@ -0,0 +1,34 @@
+package app.revanced.patches.music.misc.tracks
+
+import app.revanced.patches.music.misc.extension.sharedExtensionPatch
+import app.revanced.patches.music.misc.settings.PreferenceScreen
+import app.revanced.patches.music.misc.settings.settingsPatch
+import app.revanced.patches.music.playservice.is_8_10_or_greater
+import app.revanced.patches.music.playservice.versionCheckPatch
+import app.revanced.patches.music.shared.mainActivityOnCreateFingerprint
+import app.revanced.patches.shared.misc.audio.forceOriginalAudioPatch
+
+private const val EXTENSION_CLASS_DESCRIPTOR =
+    "Lapp/revanced/extension/music/patches/ForceOriginalAudioPatch;"
+
+@Suppress("unused")
+val forceOriginalAudioPatch = forceOriginalAudioPatch(
+    block = {
+        dependsOn(
+            sharedExtensionPatch,
+            settingsPatch,
+            versionCheckPatch
+        )
+
+        compatibleWith(
+            "com.google.android.apps.youtube.music"(
+                "7.29.52",
+                "8.10.52"
+            )
+        )
+    },
+    fixUseLocalizedAudioTrackFlag = is_8_10_or_greater,
+    mainActivityOnCreateFingerprint = mainActivityOnCreateFingerprint,
+    subclassExtensionClassDescriptor = EXTENSION_CLASS_DESCRIPTOR,
+    preferenceScreen = PreferenceScreen.MISC,
+)

patches/src/main/kotlin/app/revanced/patches/music/playservice/VersionCheckPatch.kt

@@ -7,6 +7,8 @@ import app.revanced.util.findPlayStoreServicesVersion
 
 var is_7_33_or_greater = false
     private set
+var is_8_10_or_greater = false
+    private set
 var is_8_11_or_greater = false
     private set
 var is_8_15_or_greater = false
@@ -22,6 +24,7 @@ val versionCheckPatch = resourcePatch(
 
         // All bug fix releases always seem to use the same play store version as the minor version.
         is_7_33_or_greater = 245199000 <= playStoreServicesVersion
+        is_8_10_or_greater = 244799000 <= playStoreServicesVersion
         is_8_11_or_greater = 251199000 <= playStoreServicesVersion
         is_8_15_or_greater = 251530000 <= playStoreServicesVersion
     }

patches/src/main/kotlin/app/revanced/patches/reddit/customclients/boostforreddit/fix/redgifs/FixRedgifsApiPatch.kt

@@ -1,6 +1,5 @@
 package app.revanced.patches.reddit.customclients.boostforreddit.fix.redgifs
 
-import app.revanced.patcher.extensions.InstructionExtensions.instructions
 import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
 import app.revanced.patches.reddit.customclients.CREATE_NEW_CLIENT_METHOD
 import app.revanced.patches.reddit.customclients.boostforreddit.misc.extension.sharedExtensionPatch
@@ -27,9 +26,7 @@ val fixRedgifsApi = fixRedgifsApiPatch(
             }
             replaceInstruction(
                 index,
-                """
-                invoke-static       { }, ${EXTENSION_CLASS_DESCRIPTOR}->$CREATE_NEW_CLIENT_METHOD
-                """
+                "invoke-static { }, $EXTENSION_CLASS_DESCRIPTOR->$CREATE_NEW_CLIENT_METHOD"
             )
         }
 

patches/src/main/kotlin/app/revanced/patches/shared/misc/audio/Fingerprints.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.video.audio
+package app.revanced.patches.shared.misc.audio
 
 import app.revanced.patcher.fingerprint
 import app.revanced.util.containsLiteralInstruction
@@ -7,10 +7,14 @@ import com.android.tools.smali.dexlib2.AccessFlags
 internal val formatStreamModelToStringFingerprint = fingerprint {
     accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
     returns("Ljava/lang/String;")
-    custom { method, classDef ->
-        method.name == "toString" && classDef.type ==
-                "Lcom/google/android/libraries/youtube/innertube/model/media/FormatStreamModel;"
+    custom { method, _ ->
+        method.name == "toString"
     }
+    strings(
+        // Strings are partial matches.
+        "isDefaultAudioTrack=",
+        "audioTrackId="
+    )
 }
 
 internal const val AUDIO_STREAM_IGNORE_DEFAULT_FEATURE_FLAG = 45666189L
@@ -20,7 +24,6 @@ internal val selectAudioStreamFingerprint = fingerprint {
     returns("L")
     custom { method, _ ->
         method.parameters.size > 2 // Method has a large number of parameters and may change.
-                && method.parameters[1].type == "Lcom/google/android/libraries/youtube/innertube/model/media/PlayerConfigModel;"
                 && method.containsLiteralInstruction(AUDIO_STREAM_IGNORE_DEFAULT_FEATURE_FLAG)
     }
 }

patches/src/main/kotlin/app/revanced/patches/shared/misc/audio/ForceOriginalAudioPatch.kt

@@ -0,0 +1,157 @@
+package app.revanced.patches.shared.misc.audio
+
+import app.revanced.patcher.Fingerprint
+import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWithLabels
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.patch.BytecodePatchBuilder
+import app.revanced.patcher.patch.BytecodePatchContext
+import app.revanced.patcher.patch.bytecodePatch
+import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patches.all.misc.resources.addResources
+import app.revanced.patches.all.misc.resources.addResourcesPatch
+import app.revanced.patches.shared.misc.settings.preference.BasePreferenceScreen
+import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
+import app.revanced.util.findMethodFromToString
+import app.revanced.util.indexOfFirstInstructionOrThrow
+import app.revanced.util.insertLiteralOverride
+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.OneRegisterInstruction
+import com.android.tools.smali.dexlib2.immutable.ImmutableField
+import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
+import com.android.tools.smali.dexlib2.immutable.ImmutableMethodParameter
+
+private const val EXTENSION_CLASS_DESCRIPTOR =
+    "Lapp/revanced/extension/shared/patches/ForceOriginalAudioPatch;"
+
+/**
+ * Patch shared with YouTube and YT Music.
+ */
+internal fun forceOriginalAudioPatch(
+    block: BytecodePatchBuilder.() -> Unit = {},
+    executeBlock: BytecodePatchContext.() -> Unit = {},
+    fixUseLocalizedAudioTrackFlag: Boolean,
+    mainActivityOnCreateFingerprint: Fingerprint,
+    subclassExtensionClassDescriptor: String,
+    preferenceScreen: BasePreferenceScreen.Screen
+) = bytecodePatch(
+    name = "Force original audio",
+    description = "Adds an option to always use the original audio track.",
+) {
+
+    block()
+
+    dependsOn(addResourcesPatch)
+
+    execute {
+        addResources("shared", "misc.audio.forceOriginalAudioPatch")
+
+        preferenceScreen.addPreferences(
+            SwitchPreference(
+                key = "revanced_force_original_audio",
+                tag = "app.revanced.extension.shared.settings.preference.ForceOriginalAudioSwitchPreference"
+            )
+        )
+
+        mainActivityOnCreateFingerprint.method.addInstruction(
+            0,
+            "invoke-static { }, $subclassExtensionClassDescriptor->setPreferredLanguage()V"
+        )
+
+        // Disable feature flag that ignores the default track flag
+        // and instead overrides to the user region language.
+        if (fixUseLocalizedAudioTrackFlag) {
+            selectAudioStreamFingerprint.method.insertLiteralOverride(
+                AUDIO_STREAM_IGNORE_DEFAULT_FEATURE_FLAG,
+                "$EXTENSION_CLASS_DESCRIPTOR->ignoreDefaultAudioStream(Z)Z"
+            )
+        }
+
+        formatStreamModelToStringFingerprint.let {
+            val isDefaultAudioTrackMethod = it.originalMethod.findMethodFromToString("isDefaultAudioTrack=")
+            val audioTrackDisplayNameMethod = it.originalMethod.findMethodFromToString("audioTrackDisplayName=")
+            val audioTrackIdMethod = it.originalMethod.findMethodFromToString("audioTrackId=")
+
+            it.classDef.apply {
+                // Add a new field to store the override.
+                val helperFieldName = "patch_isDefaultAudioTrackOverride"
+                fields.add(
+                    ImmutableField(
+                        type,
+                        helperFieldName,
+                        "Ljava/lang/Boolean;",
+                        // Boolean is a 100% immutable class (all fields are final)
+                        // and safe to write to a shared field without volatile/synchronization,
+                        // but without volatile the field can show stale data
+                        // and the same field is calculated more than once by different threads.
+                        AccessFlags.PRIVATE.value or AccessFlags.VOLATILE.value,
+                        null,
+                        null,
+                        null
+                    ).toMutable()
+                )
+
+                // Add a helper method because the isDefaultAudioTrack() has only 2 registers and 3 are needed.
+                val helperMethodClass = type
+                val helperMethodName = "patch_isDefaultAudioTrack"
+                val helperMethod = ImmutableMethod(
+                    helperMethodClass,
+                    helperMethodName,
+                    listOf(ImmutableMethodParameter("Z", null, null)),
+                    "Z",
+                    AccessFlags.PRIVATE.value,
+                    null,
+                    null,
+                    MutableMethodImplementation(6),
+                ).toMutable().apply {
+                    addInstructionsWithLabels(
+                        0,
+                        """
+                            iget-object v0, p0, $helperMethodClass->$helperFieldName:Ljava/lang/Boolean;
+                            if-eqz v0, :call_extension            
+                            invoke-virtual { v0 }, Ljava/lang/Boolean;->booleanValue()Z
+                            move-result v3
+                            return v3
+                            
+                            :call_extension
+                            invoke-virtual { p0 }, $audioTrackIdMethod
+                            move-result-object v1
+                            
+                            invoke-virtual { p0 }, $audioTrackDisplayNameMethod
+                            move-result-object v2
+        
+                            invoke-static { p1, v1, v2 }, $EXTENSION_CLASS_DESCRIPTOR->isDefaultAudioStream(ZLjava/lang/String;Ljava/lang/String;)Z
+                            move-result v3
+                            
+                            invoke-static { v3 }, Ljava/lang/Boolean;->valueOf(Z)Ljava/lang/Boolean;
+                            move-result-object v0
+                            iput-object v0, p0, $helperMethodClass->$helperFieldName:Ljava/lang/Boolean;
+                            return v3
+                        """
+                    )
+                }
+                methods.add(helperMethod)
+
+                // Modify isDefaultAudioTrack() to call extension helper method.
+                isDefaultAudioTrackMethod.apply {
+                    val index = indexOfFirstInstructionOrThrow(Opcode.RETURN)
+                    val register = getInstruction<OneRegisterInstruction>(index).registerA
+
+                    addInstructions(
+                        index,
+                        """
+                            invoke-direct { p0, v$register }, $helperMethodClass->$helperMethodName(Z)Z
+                            move-result v$register
+                        """
+                    )
+                }
+            }
+        }
+
+        executeBlock()
+    }
+}

patches/src/main/kotlin/app/revanced/patches/youtube/layout/shortsplayer/OpenShortsInRegularPlayerPatch.kt

@@ -161,7 +161,7 @@ val openShortsInRegularPlayerPatch = bytecodePatch(
             addInstructions(
                 index + 1,
                 """
-                    invoke-static { v$register }, ${EXTENSION_CLASS_DESCRIPTOR}->overrideBackPressToExit(Z)Z    
+                    invoke-static { v$register }, $EXTENSION_CLASS_DESCRIPTOR->overrideBackPressToExit(Z)Z    
                     move-result v$register
                 """
             )

patches/src/main/kotlin/app/revanced/patches/youtube/misc/navigation/NavigationBarHookPatch.kt

@@ -164,7 +164,7 @@ val navigationBarHookPatch = bytecodePatch(description = "Hooks the active navig
 
             addInstruction(
                 index + 1,
-                "invoke-static { v$register }, ${EXTENSION_CLASS_DESCRIPTOR}->setToolbar(Landroid/widget/FrameLayout;)V"
+                "invoke-static { v$register }, $EXTENSION_CLASS_DESCRIPTOR->setToolbar(Landroid/widget/FrameLayout;)V"
             )
         }
 

patches/src/main/kotlin/app/revanced/patches/youtube/video/audio/ForceOriginalAudioPatch.kt

@@ -1,159 +1,36 @@
 package app.revanced.patches.youtube.video.audio
 
-import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
-import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
-import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWithLabels
-import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
-import app.revanced.patcher.patch.bytecodePatch
-import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable
-import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
-import app.revanced.patches.all.misc.resources.addResources
-import app.revanced.patches.all.misc.resources.addResourcesPatch
-import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
+import app.revanced.patches.shared.misc.audio.forceOriginalAudioPatch
 import app.revanced.patches.youtube.misc.extension.sharedExtensionPatch
 import app.revanced.patches.youtube.misc.playservice.is_20_07_or_greater
 import app.revanced.patches.youtube.misc.playservice.versionCheckPatch
 import app.revanced.patches.youtube.misc.settings.PreferenceScreen
 import app.revanced.patches.youtube.misc.settings.settingsPatch
 import app.revanced.patches.youtube.shared.mainActivityOnCreateFingerprint
-import app.revanced.util.findMethodFromToString
-import app.revanced.util.indexOfFirstInstructionOrThrow
-import app.revanced.util.insertLiteralOverride
-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.OneRegisterInstruction
-import com.android.tools.smali.dexlib2.immutable.ImmutableField
-import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
-import com.android.tools.smali.dexlib2.immutable.ImmutableMethodParameter
 
 private const val EXTENSION_CLASS_DESCRIPTOR =
     "Lapp/revanced/extension/youtube/patches/ForceOriginalAudioPatch;"
 
 @Suppress("unused")
-val forceOriginalAudioPatch = bytecodePatch(
-    name = "Force original audio",
-    description = "Adds an option to always use the original audio track.",
-) {
-    dependsOn(
-        sharedExtensionPatch,
-        settingsPatch,
-        addResourcesPatch,
-        versionCheckPatch
-    )
-
-    compatibleWith(
-        "com.google.android.youtube"(
-            "19.34.42",
-            "20.07.39",
-            "20.13.41",
-            "20.14.43",
+val forceOriginalAudioPatch = forceOriginalAudioPatch(
+    block = {
+        dependsOn(
+            sharedExtensionPatch,
+            settingsPatch,
+            versionCheckPatch
         )
-    )
 
-    execute {
-        addResources("youtube", "video.audio.forceOriginalAudioPatch")
-
-        PreferenceScreen.VIDEO.addPreferences(
-            SwitchPreference(
-                key = "revanced_force_original_audio",
-                tag = "app.revanced.extension.youtube.settings.preference.ForceOriginalAudioSwitchPreference"
+        compatibleWith(
+            "com.google.android.youtube"(
+                "19.34.42",
+                "20.07.39",
+                "20.13.41",
+                "20.14.43",
             )
         )
-
-        mainActivityOnCreateFingerprint.method.addInstruction(
-            0,
-            "invoke-static { }, $EXTENSION_CLASS_DESCRIPTOR->setPreferredLanguage()V"
-        )
-
-        // Disable feature flag that ignores the default track flag
-        // and instead overrides to the user region language.
-        if (is_20_07_or_greater) {
-            selectAudioStreamFingerprint.method.insertLiteralOverride(
-                AUDIO_STREAM_IGNORE_DEFAULT_FEATURE_FLAG,
-                "$EXTENSION_CLASS_DESCRIPTOR->ignoreDefaultAudioStream(Z)Z"
-            )
-        }
-
-        formatStreamModelToStringFingerprint.let {
-            val isDefaultAudioTrackMethod = it.originalMethod.findMethodFromToString("isDefaultAudioTrack=")
-            val audioTrackDisplayNameMethod = it.originalMethod.findMethodFromToString("audioTrackDisplayName=")
-            val audioTrackIdMethod = it.originalMethod.findMethodFromToString("audioTrackId=")
-
-            it.classDef.apply {
-                // Add a new field to store the override.
-                val helperFieldName = "patch_isDefaultAudioTrackOverride"
-                fields.add(
-                    ImmutableField(
-                        type,
-                        helperFieldName,
-                        "Ljava/lang/Boolean;",
-                        // Boolean is a 100% immutable class (all fields are final)
-                        // and safe to write to a shared field without volatile/synchronization,
-                        // but without volatile the field can show stale data
-                        // and the same field is calculated more than once by different threads.
-                        AccessFlags.PRIVATE.value or AccessFlags.VOLATILE.value,
-                        null,
-                        null,
-                        null
-                    ).toMutable()
-                )
-
-                // Add a helper method because the isDefaultAudioTrack() has only 2 registers and 3 are needed.
-                val helperMethodClass = type
-                val helperMethodName = "patch_isDefaultAudioTrack"
-                val helperMethod = ImmutableMethod(
-                    helperMethodClass,
-                    helperMethodName,
-                    listOf(ImmutableMethodParameter("Z", null, null)),
-                    "Z",
-                    AccessFlags.PRIVATE.value,
-                    null,
-                    null,
-                    MutableMethodImplementation(6),
-                ).toMutable().apply {
-                    addInstructionsWithLabels(
-                        0,
-                        """
-                            iget-object v0, p0, $helperMethodClass->$helperFieldName:Ljava/lang/Boolean;
-                            if-eqz v0, :call_extension            
-                            invoke-virtual { v0 }, Ljava/lang/Boolean;->booleanValue()Z
-                            move-result v3
-                            return v3
-                            
-                            :call_extension
-                            invoke-virtual { p0 }, $audioTrackIdMethod
-                            move-result-object v1
-                            
-                            invoke-virtual { p0 }, $audioTrackDisplayNameMethod
-                            move-result-object v2
-        
-                            invoke-static { p1, v1, v2 }, $EXTENSION_CLASS_DESCRIPTOR->isDefaultAudioStream(ZLjava/lang/String;Ljava/lang/String;)Z
-                            move-result v3
-                            
-                            invoke-static { v3 }, Ljava/lang/Boolean;->valueOf(Z)Ljava/lang/Boolean;
-                            move-result-object v0
-                            iput-object v0, p0, $helperMethodClass->$helperFieldName:Ljava/lang/Boolean;
-                            return v3
-                        """
-                    )
-                }
-                methods.add(helperMethod)
-
-                // Modify isDefaultAudioTrack() to call extension helper method.
-                isDefaultAudioTrackMethod.apply {
-                    val index = indexOfFirstInstructionOrThrow(Opcode.RETURN)
-                    val register = getInstruction<OneRegisterInstruction>(index).registerA
-
-                    addInstructions(
-                        index,
-                        """
-                            invoke-direct { p0, v$register }, $helperMethodClass->$helperMethodName(Z)Z
-                            move-result v$register
-                        """
-                    )
-                }
-            }
-        }
-    }
-}
+    },
+    fixUseLocalizedAudioTrackFlag = is_20_07_or_greater,
+    mainActivityOnCreateFingerprint = mainActivityOnCreateFingerprint,
+    subclassExtensionClassDescriptor = EXTENSION_CLASS_DESCRIPTOR,
+    preferenceScreen = PreferenceScreen.VIDEO,
+)

patches/src/main/resources/addresources/values/strings.xml

@@ -176,6 +176,13 @@ Playback may not work"</string>
             <string name="revanced_spoof_video_streams_user_dialog_message">Turning off this setting may cause playback issues.</string>
             <string name="revanced_spoof_video_streams_client_type_title">Default client</string>
         </patch>
+        <patch id="misc.audio.forceOriginalAudioPatch">
+            <string name="revanced_force_original_audio_title">Force original audio language</string>
+            <string name="revanced_force_original_audio_summary_on">Using original audio language</string>
+            <string name="revanced_force_original_audio_summary_off">Using default audio</string>
+            <!-- 'Spoof video streams' should be the same translation used for 'revanced_spoof_video_streams_screen_title'. -->
+            <string name="revanced_force_original_audio_not_available">To use this feature, change \'Spoof video streams\' to any client except Android Studio</string>
+        </patch>
         <patch id="misc.debugging.enableDebuggingPatch">
             <string name="revanced_debug_screen_title">Debugging</string>
             <string name="revanced_debug_screen_summary">Enable or disable debugging options</string>
@@ -1590,13 +1597,6 @@ Enabling this can unlock higher video qualities"</string>
             <string name="revanced_external_browser_summary_on">Opening links in external browser</string>
             <string name="revanced_external_browser_summary_off">Opening links in in-app browser</string>
         </patch>
-        <patch id="video.audio.forceOriginalAudioPatch">
-            <string name="revanced_force_original_audio_title">Force original audio language</string>
-            <string name="revanced_force_original_audio_summary_on">Using original audio language</string>
-            <string name="revanced_force_original_audio_summary_off">Using default audio</string>
-            <!-- 'Spoof video streams' should be the same translation used for 'revanced_spoof_video_streams_screen_title'. -->
-            <string name="revanced_force_original_audio_not_available">To use this feature, change \'Spoof video streams\' to any client except Android Studio</string>
-        </patch>
         <patch id="video.quality.rememberVideoQualityPatch">
             <!-- Translations should use the same text as 'revanced_custom_playback_speeds_auto'. -->
             <string name="revanced_video_quality_default_entry_1">Auto</string>