fix(YouTube - Hide player components): Show correct end video thumbnail if Hide end screen suggested video is enabled (#4502)

Co-authored-by: LisoUseInAIKyrios <118716522+LisoUseInAIKyrios@users.noreply.github.com>

extensions/youtube/src/main/java/app/revanced/extension/youtube/patches/DisableSuggestedVideoEndScreenPatch.java

@@ -1,24 +0,0 @@
-package app.revanced.extension.youtube.patches;
-
-import android.annotation.SuppressLint;
-import android.widget.ImageView;
-
-import app.revanced.extension.youtube.settings.Settings;
-
-/** @noinspection unused*/
-public final class DisableSuggestedVideoEndScreenPatch {
-    @SuppressLint("StaticFieldLeak")
-    private static ImageView lastView;
-
-    public static void closeEndScreen(final ImageView imageView) {
-        if (!Settings.DISABLE_SUGGESTED_VIDEO_END_SCREEN.get()) return;
-
-        // Prevent adding the listener multiple times.
-        if (lastView == imageView) return;
-        lastView = imageView;
-
-        imageView.getViewTreeObserver().addOnGlobalLayoutListener(() -> {
-            if (imageView.isShown()) imageView.callOnClick();
-        });
-    }
-}

extensions/youtube/src/main/java/app/revanced/extension/youtube/patches/HideEndScreenSuggestedVideoPatch.java

@@ -0,0 +1,13 @@
+package app.revanced.extension.youtube.patches;
+
+import app.revanced.extension.youtube.settings.Settings;
+
+@SuppressWarnings("unused")
+public final class HideEndScreenSuggestedVideoPatch {
+    /**
+     * Injection point.
+     */
+    public static boolean hideEndScreenSuggestedVideo() {
+        return Settings.HIDE_END_SCREEN_SUGGESTED_VIDEO.get();
+    }
+}

extensions/youtube/src/main/java/app/revanced/extension/youtube/settings/Settings.java

@@ -125,7 +125,6 @@ public class Settings extends BaseSettings {
     public static final BooleanSetting COPY_VIDEO_URL_TIMESTAMP = new BooleanSetting("revanced_copy_video_url_timestamp", TRUE);
     public static final BooleanSetting DISABLE_FULLSCREEN_AMBIENT_MODE = new BooleanSetting("revanced_disable_fullscreen_ambient_mode", TRUE, true);
     public static final BooleanSetting DISABLE_ROLLING_NUMBER_ANIMATIONS = new BooleanSetting("revanced_disable_rolling_number_animations", FALSE);
-    public static final BooleanSetting DISABLE_SUGGESTED_VIDEO_END_SCREEN = new BooleanSetting("revanced_disable_suggested_video_end_screen", FALSE, true);
     public static final EnumSetting<FullscreenMode> EXIT_FULLSCREEN = new EnumSetting<>("revanced_exit_fullscreen", FullscreenMode.DISABLED);
     public static final BooleanSetting HIDE_AUTOPLAY_BUTTON = new BooleanSetting("revanced_hide_autoplay_button", TRUE, true);
     public static final BooleanSetting HIDE_CAPTIONS_BUTTON = new BooleanSetting("revanced_hide_captions_button", FALSE);
@@ -135,6 +134,7 @@ public class Settings extends BaseSettings {
     public static final BooleanSetting HIDE_COMMUNITY_GUIDELINES = new BooleanSetting("revanced_hide_community_guidelines", TRUE);
     public static final BooleanSetting HIDE_EMERGENCY_BOX = new BooleanSetting("revanced_hide_emergency_box", TRUE);
     public static final BooleanSetting HIDE_ENDSCREEN_CARDS = new BooleanSetting("revanced_hide_endscreen_cards", FALSE);
+    public static final BooleanSetting HIDE_END_SCREEN_SUGGESTED_VIDEO = new BooleanSetting("revanced_end_screen_suggested_video", FALSE, true);
     public static final BooleanSetting HIDE_HIDE_CHANNEL_GUIDELINES = new BooleanSetting("revanced_hide_channel_guidelines", TRUE);
     public static final BooleanSetting HIDE_INFO_PANELS = new BooleanSetting("revanced_hide_info_panels", TRUE);
     public static final BooleanSetting HIDE_INFO_CARDS = new BooleanSetting("revanced_hide_info_cards", FALSE);
@@ -284,7 +284,6 @@ public class Settings extends BaseSettings {
             "revanced_seekbar_thumbnails_high_quality_dialog_message", new SeekbarThumbnailsHighQualityAvailability());
     public static final BooleanSetting SLIDE_TO_SEEK = new BooleanSetting("revanced_slide_to_seek", FALSE, true);
     public static final BooleanSetting SEEKBAR_CUSTOM_COLOR = new BooleanSetting("revanced_seekbar_custom_color", FALSE, true);
-    private static final StringSetting DEPRECATED_SEEKBAR_CUSTOM_COLOR_PRIMARY = new StringSetting("revanced_seekbar_custom_color_value", "#FF0033");
     public static final StringSetting SEEKBAR_CUSTOM_COLOR_PRIMARY = new StringSetting("revanced_seekbar_custom_color_primary", "#FF0033", true, parent(SEEKBAR_CUSTOM_COLOR));
     public static final StringSetting SEEKBAR_CUSTOM_COLOR_ACCENT = new StringSetting("revanced_seekbar_custom_color_accent", "#FF2791", true, parent(SEEKBAR_CUSTOM_COLOR));
 
@@ -322,7 +321,6 @@ public class Settings extends BaseSettings {
             parentsAny(SWIPE_BRIGHTNESS, SWIPE_VOLUME));
     public static final IntegerSetting SWIPE_OVERLAY_OPACITY = new IntegerSetting("revanced_swipe_overlay_background_opacity", 60, true,
             parentsAny(SWIPE_BRIGHTNESS, SWIPE_VOLUME));
-    private static final IntegerSetting DEPRECATED_SWIPE_OVERLAY_BACKGROUND_ALPHA = new IntegerSetting("revanced_swipe_overlay_background_alpha", 127);
     public static final LongSetting SWIPE_OVERLAY_TIMEOUT = new LongSetting("revanced_swipe_overlay_timeout", 500L, true,
             parentsAny(SWIPE_BRIGHTNESS, SWIPE_VOLUME));
     public static final BooleanSetting SWIPE_SAVE_AND_RESTORE_BRIGHTNESS = new BooleanSetting("revanced_swipe_save_and_restore_brightness", TRUE, true, parent(SWIPE_BRIGHTNESS));
@@ -384,9 +382,12 @@ public class Settings extends BaseSettings {
     public static final StringSetting SB_CATEGORY_UNSUBMITTED_COLOR = new StringSetting("sb_unsubmitted_color", "#FFFFFF");
 
     // Deprecated migrations
-    public static final StringSetting DEPRECATED_SB_UUID_OLD_MIGRATION_SETTING = new StringSetting("uuid", ""); // Delete sometime in 2024
+    private static final StringSetting DEPRECATED_SB_UUID_OLD_MIGRATION_SETTING = new StringSetting("uuid", ""); // Delete sometime in 2024
     private static final BooleanSetting DEPRECATED_HIDE_PLAYER_BUTTONS = new BooleanSetting("revanced_hide_player_buttons", FALSE, true);
     private static final BooleanSetting DEPRECATED_HIDE_PLAYER_FLYOUT_VIDEO_QUALITY_FOOTER = new BooleanSetting("revanced_hide_video_quality_menu_footer", FALSE);
+    private static final IntegerSetting DEPRECATED_SWIPE_OVERLAY_BACKGROUND_ALPHA = new IntegerSetting("revanced_swipe_overlay_background_alpha", 127);
+    private static final StringSetting DEPRECATED_SEEKBAR_CUSTOM_COLOR_PRIMARY = new StringSetting("revanced_seekbar_custom_color_value", "#FF0033");
+    private static final BooleanSetting DEPRECATED_DISABLE_SUGGESTED_VIDEO_END_SCREEN = new BooleanSetting("revanced_disable_suggested_video_end_screen", FALSE);
 
     static {
         // region Migration
@@ -405,6 +406,8 @@ public class Settings extends BaseSettings {
 
         migrateOldSettingToNew(DEPRECATED_HIDE_PLAYER_FLYOUT_VIDEO_QUALITY_FOOTER, HIDE_PLAYER_FLYOUT_VIDEO_QUALITY_FOOTER);
 
+        migrateOldSettingToNew(DEPRECATED_DISABLE_SUGGESTED_VIDEO_END_SCREEN, HIDE_END_SCREEN_SUGGESTED_VIDEO);
+
         // Migrate renamed enum.
         //noinspection deprecation
         if (MINIPLAYER_TYPE.get() == MiniplayerType.PHONE) {

patches/api/patches.api

@@ -1116,6 +1116,10 @@ public final class app/revanced/patches/youtube/layout/hide/endscreencards/HideE
 	public static final fun getHideEndscreenCardsPatch ()Lapp/revanced/patcher/patch/BytecodePatch;
 }
 
+public final class app/revanced/patches/youtube/layout/hide/endscreensuggestion/HideEndScreenSuggestedVideoPatchKt {
+	public static final fun getHideEndScreenSuggestedVideoPatch ()Lapp/revanced/patcher/patch/BytecodePatch;
+}
+
 public final class app/revanced/patches/youtube/layout/hide/fullscreenambientmode/DisableFullscreenAmbientModePatchKt {
 	public static final fun getDisableFullscreenAmbientModePatch ()Lapp/revanced/patcher/patch/BytecodePatch;
 }

patches/src/main/kotlin/app/revanced/patches/youtube/layout/hide/endscreencards/HideEndscreenCardsPatch.kt

@@ -44,6 +44,9 @@ private val hideEndscreenCardsResourcePatch = resourcePatch {
     }
 }
 
+private const val EXTENSION_CLASS_DESCRIPTOR =
+    "Lapp/revanced/extension/youtube/patches/HideEndscreenCardsPatch;"
+
 @Suppress("unused")
 val hideEndscreenCardsPatch = bytecodePatch(
     name = "Hide endscreen cards",
@@ -78,9 +81,7 @@ val hideEndscreenCardsPatch = bytecodePatch(
 
                 addInstruction(
                     insertIndex,
-                    "invoke-static { v$viewRegister }, " +
+                    "invoke-static { v$viewRegister }, $EXTENSION_CLASS_DESCRIPTOR->hideEndscreen(Landroid/view/View;)V",
-                        "Lapp/revanced/extension/youtube/patches/HideEndscreenCardsPatch;->" +
-                        "hideEndscreen(Landroid/view/View;)V",
                 )
             }
         }

patches/src/main/kotlin/app/revanced/patches/youtube/layout/hide/endscreensuggestion/Fingerprints.kt

@@ -0,0 +1,38 @@
+package app.revanced.patches.youtube.layout.hide.endscreensuggestion
+
+import app.revanced.patcher.fingerprint
+import app.revanced.util.getReference
+import app.revanced.util.indexOfFirstInstruction
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.iface.reference.MethodReference
+
+internal val autoNavConstructorFingerprint = fingerprint {
+    returns("V")
+    accessFlags(AccessFlags.PUBLIC, AccessFlags.CONSTRUCTOR)
+    strings("main_app_autonav")
+}
+
+internal val autoNavStatusFingerprint = fingerprint {
+    accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
+    returns("Z")
+    parameters()
+}
+
+internal val removeOnLayoutChangeListenerFingerprint = fingerprint {
+    accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
+    returns("V")
+    parameters()
+    opcodes(
+        Opcode.IPUT,
+        Opcode.INVOKE_VIRTUAL
+    )
+    // This is the only reference present in the entire smali.
+    custom { method, _ ->
+        method.indexOfFirstInstruction {
+            val reference = getReference<MethodReference>()
+            reference?.name == "removeOnLayoutChangeListener" &&
+            reference.definingClass.endsWith("/YouTubePlayerOverlaysLayout;")
+        } >= 0
+    }
+}

patches/src/main/kotlin/app/revanced/patches/youtube/layout/hide/endscreensuggestion/HideEndScreenSuggestedVideoPatch.kt

@@ -0,0 +1,92 @@
+package app.revanced.patches.youtube.layout.hide.endscreensuggestion
+
+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.smali.ExternalLabel
+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.youtube.misc.extension.sharedExtensionPatch
+import app.revanced.patches.youtube.misc.settings.PreferenceScreen
+import app.revanced.util.getReference
+import app.revanced.util.indexOfFirstInstructionOrThrow
+import app.revanced.util.indexOfFirstInstructionReversedOrThrow
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction
+import com.android.tools.smali.dexlib2.iface.reference.MethodReference
+
+private const val EXTENSION_CLASS_DESCRIPTOR =
+    "Lapp/revanced/extension/youtube/patches/HideEndScreenSuggestedVideoPatch;"
+
+@Suppress("unused")
+val hideEndScreenSuggestedVideoPatch = bytecodePatch(
+    name = "Hide end screen suggested video",
+    description = "Adds an option to hide the recommended video at the end of each video.",
+) {
+    dependsOn(
+        sharedExtensionPatch,
+        addResourcesPatch,
+    )
+
+    compatibleWith(
+        "com.google.android.youtube"(
+            "19.16.39",
+            "19.25.37",
+            "19.34.42",
+            "19.43.41",
+            "19.45.38",
+            "19.46.42",
+            "19.47.53",
+        ),
+    )
+
+    execute {
+        addResources("youtube", "layout.hide.endscreensuggestion.hideEndScreenSuggestedVideoPatch")
+
+        PreferenceScreen.PLAYER.addPreferences(
+            SwitchPreference("revanced_end_screen_suggested_video"),
+        )
+
+        removeOnLayoutChangeListenerFingerprint.let {
+            val endScreenMethod = navigate(it.originalMethod).to(it.patternMatch!!.endIndex).stop()
+
+            endScreenMethod.apply {
+                val autoNavStatusMethodName = autoNavStatusFingerprint.match(
+                    autoNavConstructorFingerprint.classDef
+                ).originalMethod.name
+
+                val invokeIndex = indexOfFirstInstructionOrThrow {
+                    val reference = getReference<MethodReference>()
+                    reference?.name == autoNavStatusMethodName &&
+                            reference.returnType == "Z" &&
+                            reference.parameterTypes.isEmpty()
+                }
+                val iGetObjectIndex = indexOfFirstInstructionReversedOrThrow(invokeIndex, Opcode.IGET_OBJECT)
+                val invokeReference = getInstruction<ReferenceInstruction>(invokeIndex).reference
+                val iGetObjectReference = getInstruction<ReferenceInstruction>(iGetObjectIndex).reference
+                val opcodeName = getInstruction(invokeIndex).opcode.name
+
+                addInstructionsWithLabels(
+                    0,
+                    """
+                        invoke-static {}, $EXTENSION_CLASS_DESCRIPTOR->hideEndScreenSuggestedVideo()Z
+                        move-result v0
+                        if-eqz v0, :show_end_screen_recommendation
+
+                        iget-object v0, p0, $iGetObjectReference
+
+                        # This reference checks whether autoplay is turned on.
+                        $opcodeName { v0 }, $invokeReference
+                        move-result v0
+
+                        # Hide suggested video end screen only when autoplay is turned off.
+                        if-nez v0, :show_end_screen_recommendation
+                        return-void
+                    """,
+                    ExternalLabel("show_end_screen_recommendation", getInstruction(0))
+                )
+            }
+        }
+    }
+}

patches/src/main/kotlin/app/revanced/patches/youtube/layout/hide/suggestedvideoendscreen/DisableSuggestedVideoEndScreenPatch.kt

@@ -1,79 +1,9 @@
 package app.revanced.patches.youtube.layout.hide.suggestedvideoendscreen
 
-import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
-import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
 import app.revanced.patcher.patch.bytecodePatch
-import app.revanced.patcher.patch.resourcePatch
+import app.revanced.patches.youtube.layout.hide.endscreensuggestion.hideEndScreenSuggestedVideoPatch
-import app.revanced.patches.all.misc.resources.addResources
-import app.revanced.patches.all.misc.resources.addResourcesPatch
-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.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 com.android.tools.smali.dexlib2.iface.instruction.FiveRegisterInstruction
 
-internal var sizeAdjustableLiteAutoNavOverlay = -1L
+@Deprecated("Use 'Hide suggested video end screen' instead.")
-    private set
+val disableSuggestedVideoEndScreenPatch = bytecodePatch {
-
+    dependsOn(hideEndScreenSuggestedVideoPatch)
-internal val disableSuggestedVideoEndScreenResourcePatch = resourcePatch {
+}
-    dependsOn(
-        settingsPatch,
-        resourceMappingPatch,
-        addResourcesPatch,
-    )
-
-    execute {
-        addResources("youtube", "layout.hide.suggestedvideoendscreen.disableSuggestedVideoEndScreenResourcePatch")
-
-        PreferenceScreen.PLAYER.addPreferences(
-            SwitchPreference("revanced_disable_suggested_video_end_screen"),
-        )
-
-        sizeAdjustableLiteAutoNavOverlay = resourceMappings[
-            "layout",
-            "size_adjustable_lite_autonav_overlay",
-        ]
-    }
-}
-
-private const val EXTENSION_CLASS_DESCRIPTOR =
-    "Lapp/revanced/extension/youtube/patches/DisableSuggestedVideoEndScreenPatch;"
-
-@Suppress("unused")
-val disableSuggestedVideoEndScreenPatch = bytecodePatch(
-    name = "Disable suggested video end screen",
-    description = "Adds an option to disable the suggested video end screen at the end of videos.",
-) {
-    dependsOn(
-        sharedExtensionPatch,
-        disableSuggestedVideoEndScreenResourcePatch,
-    )
-
-    compatibleWith(
-        "com.google.android.youtube"(
-            "19.16.39",
-            "19.25.37",
-            "19.34.42",
-            "19.43.41",
-            "19.45.38",
-            "19.46.42",
-            "19.47.53",
-        ),
-    )
-
-    execute {
-        createEndScreenViewFingerprint.method.apply {
-            val addOnClickEventListenerIndex = createEndScreenViewFingerprint.patternMatch!!.endIndex - 1
-            val viewRegister = getInstruction<FiveRegisterInstruction>(addOnClickEventListenerIndex).registerC
-
-            addInstruction(
-                addOnClickEventListenerIndex + 1,
-                "invoke-static {v$viewRegister}, " +
-                    "$EXTENSION_CLASS_DESCRIPTOR->closeEndScreen(Landroid/widget/ImageView;)V",
-            )
-        }
-    }
-}

patches/src/main/kotlin/app/revanced/patches/youtube/layout/hide/suggestedvideoendscreen/Fingerprints.kt

@@ -1,18 +0,0 @@
-package app.revanced.patches.youtube.layout.hide.suggestedvideoendscreen
-
-import app.revanced.patcher.fingerprint
-import app.revanced.util.literal
-import com.android.tools.smali.dexlib2.AccessFlags
-import com.android.tools.smali.dexlib2.Opcode
-
-internal val createEndScreenViewFingerprint = fingerprint {
-    accessFlags(AccessFlags.PUBLIC, AccessFlags.FINAL)
-    returns("Landroid/view/View;")
-    parameters("Landroid/content/Context;")
-    opcodes(
-        Opcode.INVOKE_DIRECT,
-        Opcode.INVOKE_VIRTUAL,
-        Opcode.CONST,
-    )
-    literal { sizeAdjustableLiteAutoNavOverlay }
-}

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

@@ -813,10 +813,13 @@ If changing this setting does not take effect, try switching to Incognito mode."
             <string name="revanced_hide_shorts_navigation_bar_summary_on">Navigation bar is hidden</string>
             <string name="revanced_hide_shorts_navigation_bar_summary_off">Navigation bar is shown</string>
         </patch>
-        <patch id="layout.hide.suggestedvideoendscreen.disableSuggestedVideoEndScreenResourcePatch">
+        <patch id="layout.hide.endscreensuggestion.hideEndScreenSuggestedVideoPatch">
-            <string name="revanced_disable_suggested_video_end_screen_title">Disable suggested video end screen</string>
+            <string name="revanced_end_screen_suggested_video_title">Hide end screen suggested video</string>
-            <string name="revanced_disable_suggested_video_end_screen_summary_on">Suggested videos will be disabled</string>
+            <string name="revanced_end_screen_suggested_video_summary_on">"End screen suggested video is hidden when autoplay is turned off
-            <string name="revanced_disable_suggested_video_end_screen_summary_off">Suggested videos will be shown</string>
+
+Autoplay can be changed in YouTube settings:
+Settings → Playback → Autoplay next video"</string>
+            <string name="revanced_end_screen_suggested_video_summary_off">End screen suggested video is shown</string>
         </patch>
         <patch id="layout.hide.time.hideTimestampPatch">
             <string name="revanced_hide_timestamp_title">Hide video timestamp</string>