feat(YouTube - Remember video quality): Add separate Shorts default quality settings (#4543)

2025-06-12 05:07:45 +02:00 · 2025-03-06 09:46:33 +03:00
parent 74ec83f964
commit 88142ab464
20 changed files with 312 additions and 87 deletions
--- a/patches/src/main/kotlin/app/revanced/patches/shared/misc/settings/preference/BasePreference.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/shared/misc/settings/preference/BasePreference.kt
@ -17,7 +17,7 @@ import org.w3c.dom.Element
@Suppress("MemberVisibilityCanBePrivate")
 abstract class BasePreference(
    val key: String? = null,
-    val titleKey: String = "${key}_title",
+    val titleKey: String? = "${key}_title",
    val summaryKey: String? = "${key}_summary",
    val icon: String? = null,
    val layout: String? = null,
@ -35,7 +35,7 @@ abstract class BasePreference(
    open fun serialize(ownerDocument: Document, resourceCallback: (BaseResource) -> Unit): Element =
        ownerDocument.createElement(tag).apply {
            key?.let { setAttribute("android:key", it) }
-            setAttribute("android:title", "@string/${titleKey}")
+            titleKey?.let { setAttribute("android:title", "@string/${titleKey}") }
            summaryKey?.let { addSummary(it) }
            icon?.let {
                setAttribute("android:icon", it)
--- a/patches/src/main/kotlin/app/revanced/patches/shared/misc/settings/preference/PreferenceCategory.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/shared/misc/settings/preference/PreferenceCategory.kt
@ -17,7 +17,7 @@ import org.w3c.dom.Document
@Suppress("MemberVisibilityCanBePrivate")
 open class PreferenceCategory(
    key: String? = null,
-    titleKey: String = "${key}_title",
+    titleKey: String? = "${key}_title",
    icon: String? = null,
    layout: String? = null,
    sorting: Sorting = Sorting.BY_TITLE,
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/layout/spoofappversion/SpoofAppVersionPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/layout/spoofappversion/SpoofAppVersionPatch.kt
@ -12,6 +12,8 @@ import app.revanced.patches.shared.misc.mapping.get
 import app.revanced.patches.shared.misc.mapping.resourceMappingPatch
 import app.revanced.patches.shared.misc.mapping.resourceMappings
 import app.revanced.patches.shared.misc.settings.preference.ListPreference
+import app.revanced.patches.shared.misc.settings.preference.PreferenceCategory
+import app.revanced.patches.shared.misc.settings.preference.PreferenceScreenPreference.Sorting
 import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
 import app.revanced.patches.youtube.misc.extension.sharedExtensionPatch
 import app.revanced.patches.youtube.misc.playservice.is_19_17_or_greater
@ -71,20 +73,31 @@ val spoofAppVersionPatch = bytecodePatch(
        addResources("youtube", "layout.spoofappversion.spoofAppVersionPatch")

        PreferenceScreen.GENERAL_LAYOUT.addPreferences(
-            SwitchPreference("revanced_spoof_app_version"),
-            if (is_19_17_or_greater) {
-                ListPreference(
-                    key = "revanced_spoof_app_version_target",
-                    summaryKey = null,
+            // Group the switch and list preference together, since General menu is sorted by name
+            // and the preferences can be scattered apart with non English langauges.
+            PreferenceCategory(
+                key = null,
+                // The title does not show, but is used for sorting the group.
+                titleKey = "revanced_spoof_app_version_title",
+                sorting = Sorting.UNSORTED,
+                tag = "app.revanced.extension.shared.settings.preference.NoTitlePreferenceCategory",
+                preferences = setOf(
+                    SwitchPreference("revanced_spoof_app_version"),
+                    if (is_19_17_or_greater) {
+                        ListPreference(
+                            key = "revanced_spoof_app_version_target",
+                            summaryKey = null,
+                        )
+                    } else {
+                        ListPreference(
+                            key = "revanced_spoof_app_version_target",
+                            summaryKey = null,
+                            entriesKey = "revanced_spoof_app_version_target_legacy_entries",
+                            entryValuesKey = "revanced_spoof_app_version_target_legacy_entry_values"
+                        )
+                    }
                )
-            } else {
-                ListPreference(
-                    key = "revanced_spoof_app_version_target",
-                    summaryKey = null,
-                    entriesKey = "revanced_spoof_app_version_target_legacy_entries",
-                    entryValuesKey = "revanced_spoof_app_version_target_legacy_entry_values"
-                )
-            }
+            )
        )

        /**
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/misc/playertype/Fingerprints.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/misc/playertype/Fingerprints.kt
@ -1,6 +1,7 @@
 package app.revanced.patches.youtube.misc.playertype

 import app.revanced.patcher.fingerprint
+import app.revanced.util.literal
 import com.android.tools.smali.dexlib2.AccessFlags
 import com.android.tools.smali.dexlib2.Opcode

@ -15,6 +16,12 @@ internal val playerTypeFingerprint = fingerprint {
    custom { _, classDef -> classDef.endsWith("/YouTubePlayerOverlaysLayout;") }
 }

+internal val reelWatchPagerFingerprint = fingerprint {
+    accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
+    returns("Landroid/view/View;")
+    literal { reelWatchPlayerId }
+}
+
 internal val videoStateFingerprint = fingerprint {
    accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
    returns("V")
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/misc/playertype/PlayerTypeHookPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/misc/playertype/PlayerTypeHookPatch.kt
@ -4,15 +4,34 @@ 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.patch.bytecodePatch
+import app.revanced.patcher.patch.resourcePatch
+import app.revanced.patches.shared.misc.mapping.get
+import app.revanced.patches.shared.misc.mapping.resourceMappingPatch
+import app.revanced.patches.shared.misc.mapping.resourceMappings
 import app.revanced.patches.youtube.misc.extension.sharedExtensionPatch
+import app.revanced.util.indexOfFirstInstructionOrThrow
+import app.revanced.util.indexOfFirstLiteralInstructionOrThrow
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
 import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction

 internal const val EXTENSION_CLASS_DESCRIPTOR = "Lapp/revanced/extension/youtube/patches/PlayerTypeHookPatch;"

+internal var reelWatchPlayerId = -1L
+    private set
+
+private val playerTypeHookResourcePatch = resourcePatch {
+    dependsOn(resourceMappingPatch)
+
+    execute {
+        reelWatchPlayerId = resourceMappings["id", "reel_watch_player"]
+    }
+}
+
 val playerTypeHookPatch = bytecodePatch(
    description = "Hook to get the current player type and video playback state.",
 ) {
-    dependsOn(sharedExtensionPatch)
+    dependsOn(sharedExtensionPatch, playerTypeHookResourcePatch)

    execute {
        playerTypeFingerprint.method.addInstruction(
@ -20,6 +39,17 @@ val playerTypeHookPatch = bytecodePatch(
            "invoke-static {p1}, $EXTENSION_CLASS_DESCRIPTOR->setPlayerType(Ljava/lang/Enum;)V",
        )

+        reelWatchPagerFingerprint.method.apply {
+            val literalIndex = indexOfFirstLiteralInstructionOrThrow(reelWatchPlayerId)
+            val registerIndex = indexOfFirstInstructionOrThrow(literalIndex, Opcode.MOVE_RESULT_OBJECT)
+            val viewRegister = getInstruction<OneRegisterInstruction>(registerIndex).registerA
+
+            addInstruction(
+                registerIndex + 1,
+                "invoke-static { v$viewRegister }, $EXTENSION_CLASS_DESCRIPTOR->onShortsCreate(Landroid/view/View;)V"
+            )
+        }
+
        videoStateFingerprint.method.apply {
            val endIndex = videoStateFingerprint.patternMatch!!.endIndex
            val videoStateFieldName = getInstruction<ReferenceInstruction>(endIndex).reference
@ -27,9 +57,9 @@ val playerTypeHookPatch = bytecodePatch(
            addInstructions(
                0,
                """
-                        iget-object v0, p1, $videoStateFieldName  # copy VideoState parameter field
-                        invoke-static {v0}, $EXTENSION_CLASS_DESCRIPTOR->setVideoState(Ljava/lang/Enum;)V
-                    """,
+                    iget-object v0, p1, $videoStateFieldName  # copy VideoState parameter field
+                    invoke-static {v0}, $EXTENSION_CLASS_DESCRIPTOR->setVideoState(Ljava/lang/Enum;)V
+                """
            )
        }
    }
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/misc/settings/SettingsPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/misc/settings/SettingsPatch.kt
@ -323,6 +323,7 @@ object PreferenceScreen : BasePreferenceScreen() {
    val VIDEO = Screen(
        key = "revanced_settings_screen_12_video",
        summaryKey = null,
+        sorting = Sorting.BY_KEY,
    )

    override fun commit(screen: PreferenceScreenPreference) {
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/video/quality/RememberVideoQualityPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/video/quality/RememberVideoQualityPatch.kt
@ -8,8 +8,11 @@ import app.revanced.patcher.patch.bytecodePatch
 import app.revanced.patches.all.misc.resources.addResources
 import app.revanced.patches.all.misc.resources.addResourcesPatch
 import app.revanced.patches.shared.misc.settings.preference.ListPreference
+import app.revanced.patches.shared.misc.settings.preference.PreferenceCategory
+import app.revanced.patches.shared.misc.settings.preference.PreferenceScreenPreference.Sorting
 import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
 import app.revanced.patches.youtube.misc.extension.sharedExtensionPatch
+import app.revanced.patches.youtube.misc.playertype.playerTypeHookPatch
 import app.revanced.patches.youtube.misc.settings.PreferenceScreen
 import app.revanced.patches.youtube.misc.settings.settingsPatch
 import app.revanced.patches.youtube.shared.newVideoQualityChangedFingerprint
@ -29,6 +32,7 @@ val rememberVideoQualityPatch = bytecodePatch(
    dependsOn(
        sharedExtensionPatch,
        videoInformationPatch,
+        playerTypeHookPatch,
        settingsPatch,
        addResourcesPatch,
    )
@ -49,19 +53,42 @@ val rememberVideoQualityPatch = bytecodePatch(
        addResources("youtube", "video.quality.rememberVideoQualityPatch")

        PreferenceScreen.VIDEO.addPreferences(
-            SwitchPreference("revanced_remember_video_quality_last_selected"),
-            ListPreference(
-                key = "revanced_video_quality_default_wifi",
-                summaryKey = null,
-                entriesKey = "revanced_video_quality_default_entries",
-                entryValuesKey = "revanced_video_quality_default_entry_values",
-            ),
-            ListPreference(
-                key = "revanced_video_quality_default_mobile",
-                summaryKey = null,
-                entriesKey = "revanced_video_quality_default_entries",
-                entryValuesKey = "revanced_video_quality_default_entry_values",
-            ),
+            // Keep the preferences organized together.
+            PreferenceCategory(
+                key = "revanced_01_video_key", // Dummy key to force the quality preferences first.
+                titleKey = null,
+                sorting = Sorting.UNSORTED,
+                tag = "app.revanced.extension.shared.settings.preference.NoTitlePreferenceCategory",
+                preferences = setOf(
+                    ListPreference(
+                        key = "revanced_video_quality_default_mobile",
+                        summaryKey = null,
+                        entriesKey = "revanced_video_quality_default_entries",
+                        entryValuesKey = "revanced_video_quality_default_entry_values",
+                    ),
+                    ListPreference(
+                        key = "revanced_video_quality_default_wifi",
+                        summaryKey = null,
+                        entriesKey = "revanced_video_quality_default_entries",
+                        entryValuesKey = "revanced_video_quality_default_entry_values",
+                    ),
+                    SwitchPreference("revanced_remember_video_quality_last_selected"),
+
+                    ListPreference(
+                        key = "revanced_shorts_quality_default_mobile",
+                        summaryKey = null,
+                        entriesKey = "revanced_video_quality_default_entries",
+                        entryValuesKey = "revanced_video_quality_default_entry_values",
+                    ),
+                    ListPreference(
+                        key = "revanced_shorts_quality_default_wifi",
+                        summaryKey = null,
+                        entriesKey = "revanced_video_quality_default_entries",
+                        entryValuesKey = "revanced_video_quality_default_entry_values",
+                    ),
+                    SwitchPreference("revanced_remember_shorts_quality_last_selected")
+                )
+            )
        )

        /*
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/PlaybackSpeedPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/PlaybackSpeedPatch.kt
@ -1,10 +1,19 @@
 package app.revanced.patches.youtube.video.speed

 import app.revanced.patcher.patch.bytecodePatch
+import app.revanced.patches.shared.misc.settings.preference.BasePreference
+import app.revanced.patches.shared.misc.settings.preference.PreferenceCategory
+import app.revanced.patches.shared.misc.settings.preference.PreferenceScreenPreference.Sorting
+import app.revanced.patches.youtube.misc.settings.PreferenceScreen
 import app.revanced.patches.youtube.video.speed.button.playbackSpeedButtonPatch
 import app.revanced.patches.youtube.video.speed.custom.customPlaybackSpeedPatch
 import app.revanced.patches.youtube.video.speed.remember.rememberPlaybackSpeedPatch

+/**
+ * Speed menu settings.  Used to organize all speed related settings together.
+ */
+internal val settingsMenuVideoSpeedGroup = mutableSetOf<BasePreference>()
+
@Suppress("unused")
 val playbackSpeedPatch = bytecodePatch(
    name = "Playback speed",
@ -26,6 +35,18 @@ val playbackSpeedPatch = bytecodePatch(
            "19.45.38",
            "19.46.42",
            "19.47.53",
-        ),
+        )
    )
+
+    finalize {
+        PreferenceScreen.VIDEO.addPreferences(
+            PreferenceCategory(
+                key = "revanced_zz_key", // Dummy key to force the speed settings last.
+                titleKey = null,
+                sorting = Sorting.UNSORTED,
+                tag = "app.revanced.extension.shared.settings.preference.NoTitlePreferenceCategory",
+                preferences = settingsMenuVideoSpeedGroup
+            )
+        )
+    }
 }
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/custom/CustomPlaybackSpeedPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/custom/CustomPlaybackSpeedPatch.kt
@ -25,8 +25,8 @@ import app.revanced.patches.youtube.misc.playservice.is_19_25_or_greater
 import app.revanced.patches.youtube.misc.playservice.versionCheckPatch
 import app.revanced.patches.youtube.misc.recyclerviewtree.hook.addRecyclerViewTreeHook
 import app.revanced.patches.youtube.misc.recyclerviewtree.hook.recyclerViewTreeHookPatch
-import app.revanced.patches.youtube.misc.settings.PreferenceScreen
 import app.revanced.patches.youtube.misc.settings.settingsPatch
+import app.revanced.patches.youtube.video.speed.settingsMenuVideoSpeedGroup
 import app.revanced.util.*
 import com.android.tools.smali.dexlib2.AccessFlags
 import com.android.tools.smali.dexlib2.iface.instruction.NarrowLiteralInstruction
@ -71,13 +71,18 @@ internal val customPlaybackSpeedPatch = bytecodePatch(
    execute {
        addResources("youtube", "video.speed.custom.customPlaybackSpeedPatch")

-        PreferenceScreen.VIDEO.addPreferences(
-            SwitchPreference("revanced_custom_speed_menu"),
-            TextPreference("revanced_custom_playback_speeds", inputType = InputType.TEXT_MULTI_LINE),
+        settingsMenuVideoSpeedGroup.addAll(
+            listOf(
+                SwitchPreference("revanced_custom_speed_menu"),
+                TextPreference(
+                    "revanced_custom_playback_speeds",
+                    inputType = InputType.TEXT_MULTI_LINE
+                ),
+            )
        )

        if (is_19_25_or_greater) {
-            PreferenceScreen.VIDEO.addPreferences(
+            settingsMenuVideoSpeedGroup.add(
                TextPreference("revanced_speed_tap_and_hold", inputType = InputType.NUMBER_DECIMAL),
            )
        }
--- a/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/remember/RememberPlaybackSpeedPatch.kt
+++ b/patches/src/main/kotlin/app/revanced/patches/youtube/video/speed/remember/RememberPlaybackSpeedPatch.kt
@ -9,10 +9,10 @@ import app.revanced.patches.all.misc.resources.addResourcesPatch
 import app.revanced.patches.shared.misc.settings.preference.ListPreference
 import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
 import app.revanced.patches.youtube.misc.extension.sharedExtensionPatch
-import app.revanced.patches.youtube.misc.settings.PreferenceScreen
 import app.revanced.patches.youtube.misc.settings.settingsPatch
 import app.revanced.patches.youtube.video.information.*
 import app.revanced.patches.youtube.video.speed.custom.customPlaybackSpeedPatch
+import app.revanced.patches.youtube.video.speed.settingsMenuVideoSpeedGroup
 import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction

 private const val EXTENSION_CLASS_DESCRIPTOR =
@ -30,15 +30,17 @@ internal val rememberPlaybackSpeedPatch = bytecodePatch {
    execute {
        addResources("youtube", "video.speed.remember.rememberPlaybackSpeedPatch")

-        PreferenceScreen.VIDEO.addPreferences(
-            SwitchPreference("revanced_remember_playback_speed_last_selected"),
-            ListPreference(
-                key = "revanced_playback_speed_default",
-                summaryKey = null,
-                // Entries and values are set by the extension code based on the actual speeds available.
-                entriesKey = null,
-                entryValuesKey = null,
-            ),
+        settingsMenuVideoSpeedGroup.addAll(
+            listOf(
+                ListPreference(
+                    key = "revanced_playback_speed_default",
+                    summaryKey = null,
+                    // Entries and values are set by the extension code based on the actual speeds available.
+                    entriesKey = null,
+                    entryValuesKey = null,
+                ),
+                SwitchPreference("revanced_remember_playback_speed_last_selected")
+            )
        )

        onCreateHook(EXTENSION_CLASS_DESCRIPTOR, "newVideoStarted")
--- a/patches/src/main/resources/addresources/values/strings.xml
+++ b/patches/src/main/resources/addresources/values/strings.xml
@ -1373,15 +1373,22 @@ Enabling this can unlock higher video qualities"</string>
        </patch>
        <patch id="video.quality.rememberVideoQualityPatch">
            <!-- Translations should use the same text as revanced_custom_playback_speeds_auto -->
+            <string name="revanced_video_quality_screen_title">Video quality</string>
            <string name="revanced_video_quality_default_entry_1">Auto</string>
            <string name="revanced_remember_video_quality_last_selected_title">Remember video quality changes</string>
            <string name="revanced_remember_video_quality_last_selected_summary_on">Quality changes apply to all videos</string>
            <string name="revanced_remember_video_quality_last_selected_summary_off">Quality changes only apply to the current video</string>
            <string name="revanced_video_quality_default_wifi_title">Default video quality on Wi-Fi network</string>
            <string name="revanced_video_quality_default_mobile_title">Default video quality on mobile network</string>
+            <string name="revanced_remember_shorts_quality_last_selected_title">Remember Shorts quality changes</string>
+            <string name="revanced_remember_shorts_quality_last_selected_summary_on">Quality changes apply to all Shorts videos</string>
+            <string name="revanced_remember_shorts_quality_last_selected_summary_off">Quality changes only apply to the current Shorts video</string>
+            <string name="revanced_shorts_quality_default_wifi_title">Default Shorts quality on Wi-Fi network</string>
+            <string name="revanced_shorts_quality_default_mobile_title">Default Shorts quality on mobile network</string>
            <string name="revanced_remember_video_quality_mobile">mobile</string>
            <string name="revanced_remember_video_quality_wifi">wifi</string>
            <string name="revanced_remember_video_quality_toast">Changed default %1$s quality to: %2$s</string>
+            <string name="revanced_remember_video_quality_toast_shorts">Changed Shorts %1$s quality to: %2$s</string>
        </patch>
        <patch id="video.speed.button.playbackSpeedButtonPatch">
            <string name="revanced_playback_speed_dialog_button_title">Show speed dialog button</string>