feat(YouTube - Alternative Thumbnails): Add option to use DeArrow

[shadow578]

adds the option to use thumbnails provided by DeArrow to the existing alternative thumbnails patch

requires ReVanced/revanced-patches#3378

[oSumAtrIX]

@LisoUseInAIKyrios I have moved lines of code for review; look into the commits separately for simplicity

[oSumAtrIX]

The original reason why DeArrow was not used for this patch, was that the patch blocks the UI thread. This means, if the API times out, the UI will be blocked for the timeout duration. Does this PR consider this in any way?

[LisoUseInAIKyrios]

This patch actually does not block the UI, everything happens off the main thread. The only reason DeArrow was not added was because nobody took the time to finish adding it until now.

[LisoUseInAIKyrios]

It would be fantastic if DeArrow added a parameter to only provide user selected thumbnails. But that's something DeArrow would need to implement.

[LisoUseInAIKyrios]

Because the settings menu is not dynamically changed the same way SponsorBlock or RYD is, the settings menu for this is now a bit confusing as to what the end user will get.

This was the largest reason I put off adding DeArrow to the first iteration of this.

I think this might be better if it had it's own settings UI fragment, as then it can give a single 'about' entry and explain what the end result is for the user based on the current setting values. It can also disable settings that don't apply (such as fast still images, when the currently selected settings do not use still images).

Edit: Added an 'about' preference that is updated based on the current settings.

[LisoUseInAIKyrios]

I think this PR is nearly ready.

On a related topic, navigating to the alt thumbnails menus is quite a journey that needs a lot of scrolling.

Not for this PR, but perhaps the ReVanced/RYD/SB menu can be moved to the top of the settings menu. So they are first and above the stock YouTube general settings. Stock YT settings are rarely changed, but ReVanced settings can often be changed and each time it requires scrolling past a lot of mostly unused stock settings.

And similarly, maybe move the ReVanced sub menus to the top of each list. So Alt thumbnails, Action bar settings, etc, all appear first and before all the single item preferences.

[LisoUseInAIKyrios]

@oSumAtrIX When you have time look this over and add your review. Otherwise I think it's ready to merge.

[oSumAtrIX]

Currently, the submenu is very rich in content:

How about moving DeArrow and VideoStills each in a submenu and keeping the "Thumbnails in use" text preference where it is now? You'd navigate to the submenus to enable or disable DeArrow and see its respective settings and About. Alternatively, the toggles can be kept in the current menu, whereas a submenu is made for DeArrow and Video stills called "DeArrow settings" and "Video stills settings."

[LisoUseInAIKyrios]

If they're moved to a submenu, then the base menu would be only a status with more menus under that.

It's already a long navigation journey to reach the menu (every time I scroll thru the enormous layout menu to reach the thumbnail menu i can almost imagine Lord of the Rings memes of Frodo's journey)

I agree the two sections can be more segregated. I think two PreferenceCategorys on the same screen might work to visually separate them. I'll give this a try and see how it looks.

[oSumAtrIX]

Currently, categories do not exist as components in the SettingsPatch. They would be highly welcome as they will be useful to separate settings sections. The SettingsPatch would need a new interface, for example, SettingsComponent, which Preference and Category could implement. A category can then have additional settings components as its children.

[oSumAtrIX]

Here is the diff in case a submenu fits more into this PR

Open

>

Subject: [PATCH] feat: Simplify settings screen
---
Index: src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt b/src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt	(revision dd3e72a0f6a172b3ec808a38bf0f72f322139f22)
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt	(revision cc4a0eabaec5270f5b617780d617473c359750e0)
@@ -117,102 +117,144 @@
                         null, // Summary is dynamically updated based on the current settings.
                         tag = "app.revanced.integrations.settingsmenu.AlternativeThumbnailsStatusPreference"
                     ),
-                    SwitchPreference(
-                        "revanced_alt_thumbnail_dearrow",
-                        StringResource("revanced_alt_thumbnail_dearrow_title", "Enable DeArrow"),
-                        StringResource("revanced_alt_thumbnail_dearrow_summary_on", "Using DeArrow"),
-                        StringResource("revanced_alt_thumbnail_dearrow_summary_off", "Not using DeArrow")
-                    ),
-                    SwitchPreference(
-                        "revanced_alt_thumbnail_dearrow_connection_toast",
-                        StringResource("revanced_alt_thumbnail_dearrow_connection_toast_title", "Show toast if API is not available"),
-                        StringResource("revanced_alt_thumbnail_dearrow_connection_toast_summary_on", "Toast shown if DeArrow is not available"),
-                        StringResource("revanced_alt_thumbnail_dearrow_connection_toast_summary_off", "Toast not shown if DeArrow is not available")
-                    ),
-                    TextPreference(
-                        "revanced_alt_thumbnail_dearrow_api_url",
-                        StringResource(
-                            "revanced_alt_thumbnail_dearrow_api_url_title",
-                            "DeArrow API endpoint"
-                        ),
-                        StringResource(
-                            "revanced_alt_thumbnail_dearrow_api_url_summary",
-                            "The URL of the DeArrow thumbnail cache endpoint. " +
-                                    "Do not change this unless you know what you\\\'re doing"
-                        ),
-                    ),
-                    NonInteractivePreference(
-                        StringResource(
-                            "revanced_alt_thumbnail_dearrow_about_title",
-                            "About DeArrow"
-                        ),
-                        StringResource(
-                            "revanced_alt_thumbnail_dearrow_about_summary",
-                            "DeArrow provides crowd sourced thumbnails for YouTube videos. " +
+                    PreferenceScreen(
+                        "revanced_alt_thumbnails_dearrow_preference_screen",
+                        StringResource("revanced_alt_thumbnails_dearrow_preference_screen_title", "DeArrow"),
+                        listOf(
+                            SwitchPreference(
+                                "revanced_alt_thumbnail_dearrow",
+                                StringResource("revanced_alt_thumbnail_dearrow_title", "Enable DeArrow"),
+                                StringResource("revanced_alt_thumbnail_dearrow_summary_on", "Using DeArrow"),
+                                StringResource("revanced_alt_thumbnail_dearrow_summary_off", "Not using DeArrow")
+                            ),
+                            SwitchPreference(
+                                "revanced_alt_thumbnail_dearrow_connection_toast",
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_connection_toast_title",
+                                    "Show toast if API is not available"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_connection_toast_summary_on",
+                                    "Toast shown if DeArrow is not available"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_connection_toast_summary_off",
+                                    "Toast not shown if DeArrow is not available"
+                                )
+                            ),
+                            TextPreference(
+                                "revanced_alt_thumbnail_dearrow_api_url",
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_api_url_title",
+                                    "DeArrow API endpoint"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_api_url_summary",
+                                    "The URL of the DeArrow thumbnail cache endpoint. " +
+                                            "Do not change this unless you know what you\\\'re doing"
+                                ),
+                            ),
+                            NonInteractivePreference(
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_about_title",
+                                    "About DeArrow"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_dearrow_about_summary",
                                     "These thumbnails are often more relevant than those provided by YouTube. " +
-                                    "If enabled, video URLs will be sent to the API server and no other data is sent."
-                                    + "\\n\\nTap here to learn more about DeArrow"
-                        ),
-                        // Custom about preference with link to the DeArrow website.
-                        tag = "app.revanced.integrations.settingsmenu.AlternativeThumbnailsAboutDeArrowPreference",
-                        selectable = true
+                                            "If enabled, video URLs will be sent to the API server and no other data is sent."
+                                            + "\\n\\nTap here to learn more about DeArrow"
+                                ),
+                                // Custom about preference with link to the DeArrow website.
+                                tag = "app.revanced.integrations.settingsmenu.AlternativeThumbnailsAboutDeArrowPreference",
+                                selectable = true
+                            )
+                        ),
+                        StringResource(
+                            "revanced_alt_thumbnails_dearrow_preference_screen_summary",
+                            "DeArrow provides crowd sourced thumbnails for YouTube videos"
+                        )
                     ),
-                    SwitchPreference(
-                        "revanced_alt_thumbnail_stills",
-                        StringResource("revanced_alt_thumbnail_stills_title", "Enable still video captures"),
-                        StringResource("revanced_alt_thumbnail_stills_summary_on", "Using YouTube video still captures"),
-                        StringResource("revanced_alt_thumbnail_stills_summary_off", "Not using YouTube video still captures")
-                    ),
-                    ListPreference(
-                        "revanced_alt_thumbnail_stills_time",
-                        StringResource("revanced_alt_thumbnail_stills_time_title", "Video time to take the still from"),
-                        ArrayResource(
-                            "revanced_alt_thumbnail_type_entries",
-                            listOf(
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_1", "Beginning of video"),
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_2", "Middle of video"),
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_3", "End of video"),
-                            )
-                        ),
-                        ArrayResource(
-                            "revanced_alt_thumbnail_stills_time_entry_values",
-                            listOf(
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_value_1", "1"),
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_value_2", "2"),
-                                StringResource("revanced_alt_thumbnail_stills_time_entry_value_3", "3"),
-                            )
-                        )
-                    ),
-                    SwitchPreference(
-                        "revanced_alt_thumbnail_stills_fast",
-                        StringResource(
-                            "revanced_alt_thumbnail_stills_fast_title",
-                            "Use fast still captures"
-                        ),
-                        StringResource(
-                            "revanced_alt_thumbnail_stills_fast_summary_on",
-                            "Using medium quality still captures. " +
-                                    "Thumbnails will load faster, but live streams, unreleased, " +
-                                    "or very old videos may show blank thumbnails"
-                        ),
-                        StringResource(
-                            "revanced_alt_thumbnail_stills_fast_summary_off",
-                            "Using high quality still captures"
-                        )
-                    ),
-                    NonInteractivePreference(
-                        StringResource(
-                            "revanced_alt_thumbnail_stills_about_title",
-                            "About still video captures"
-                        ),
-                        StringResource(
-                            "revanced_alt_thumbnail_stills_about_summary",
-                            "Still captures are taken from the beginning/middle/end of each video. " +
+                    PreferenceScreen(
+                        "revanced_alt_thumbnails_stills_preference_screen",
+                        StringResource(
+                            "revanced_alt_thumbnails_stills_preference_screen_title",
+                            "Still video captures"
+                        ),
+                        listOf(
+                            SwitchPreference(
+                                "revanced_alt_thumbnail_stills",
+                                StringResource("revanced_alt_thumbnail_stills_title", "Enable still video captures"),
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_summary_on",
+                                    "Using YouTube video still captures"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_summary_off",
+                                    "Not using YouTube video still captures"
+                                )
+                            ),
+                            ListPreference(
+                                "revanced_alt_thumbnail_stills_time",
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_time_title",
+                                    "Video time to take the still from"
+                                ),
+                                ArrayResource(
+                                    "revanced_alt_thumbnail_type_entries",
+                                    listOf(
+                                        StringResource(
+                                            "revanced_alt_thumbnail_stills_time_entry_1",
+                                            "Beginning of video"
+                                        ),
+                                        StringResource("revanced_alt_thumbnail_stills_time_entry_2", "Middle of video"),
+                                        StringResource("revanced_alt_thumbnail_stills_time_entry_3", "End of video"),
+                                    )
+                                ),
+                                ArrayResource(
+                                    "revanced_alt_thumbnail_stills_time_entry_values",
+                                    listOf(
+                                        StringResource("revanced_alt_thumbnail_stills_time_entry_value_1", "1"),
+                                        StringResource("revanced_alt_thumbnail_stills_time_entry_value_2", "2"),
+                                        StringResource("revanced_alt_thumbnail_stills_time_entry_value_3", "3"),
+                                    )
+                                )
+                            ),
+                            SwitchPreference(
+                                "revanced_alt_thumbnail_stills_fast",
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_fast_title",
+                                    "Use fast still captures"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_fast_summary_on",
+                                    "Using medium quality still captures. " +
+                                            "Thumbnails will load faster, but live streams, unreleased, " +
+                                            "or very old videos may show blank thumbnails"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_fast_summary_off",
+                                    "Using high quality still captures"
+                                )
+                            ),
+                            NonInteractivePreference(
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_about_title",
+                                    "About still video captures"
+                                ),
+                                StringResource(
+                                    "revanced_alt_thumbnail_stills_about_summary",
                                     "These images are built into YouTube and no external API is used"
-                        ),
-                        // Restore the preference dividers to keep it from looking weird.
-                        selectable = true
-                    )
+                                ),
+                                // Restore the preference dividers to keep it from looking weird.
+                                selectable = true
+                            )
+                        ),
+                        StringResource(
+                            "revanced_alt_thumbnails_stills_preference_screen_summary",
+                            "Still captures are taken from the beginning/middle/end of each video"
+                        )
+                    ),
                 ),
                 StringResource("revanced_alt_thumbnail_preference_screen_summary", "Video thumbnail settings")
             )

[LisoUseInAIKyrios]

In that case settings categories can be a different PR.