feat(YouTube - Swipe controls): Add separate color settings for the brightness and volume bars (#5043)

Author: MarcaDian

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

@@ -337,13 +337,17 @@ 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));
-    public static final StringSetting SWIPE_OVERLAY_PROGRESS_COLOR = new StringSetting("revanced_swipe_overlay_progress_color", "#FFFFFF", true,
-            parentsAny(SWIPE_BRIGHTNESS, SWIPE_VOLUME));
+    public static final StringSetting SWIPE_OVERLAY_BRIGHTNESS_COLOR = new StringSetting("revanced_swipe_overlay_progress_brightness_color", "#FFFFFF", true,
+            parent(SWIPE_BRIGHTNESS));
+    public static final StringSetting SWIPE_OVERLAY_VOLUME_COLOR = new StringSetting("revanced_swipe_overlay_progress_volume_color", "#FFFFFF", true,
+            parent(SWIPE_VOLUME));
     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));
+    public static final BooleanSetting SWIPE_SAVE_AND_RESTORE_BRIGHTNESS = new BooleanSetting("revanced_swipe_save_and_restore_brightness", TRUE, true,
+            parent(SWIPE_BRIGHTNESS));
     public static final FloatSetting SWIPE_BRIGHTNESS_VALUE = new FloatSetting("revanced_swipe_brightness_value", -1f);
-    public static final BooleanSetting SWIPE_LOWEST_VALUE_ENABLE_AUTO_BRIGHTNESS = new BooleanSetting("revanced_swipe_lowest_value_enable_auto_brightness", FALSE, true, parent(SWIPE_BRIGHTNESS));
+    public static final BooleanSetting SWIPE_LOWEST_VALUE_ENABLE_AUTO_BRIGHTNESS = new BooleanSetting("revanced_swipe_lowest_value_enable_auto_brightness", FALSE, true,
+            parent(SWIPE_BRIGHTNESS));
 
     // ReturnYoutubeDislike
     public static final BooleanSetting RYD_ENABLED = new BooleanSetting("revanced_ryd_enabled", TRUE);

extensions/youtube/src/main/java/app/revanced/extension/youtube/swipecontrols/SwipeControlsConfigurationProvider.kt

@@ -1,10 +1,10 @@
 package app.revanced.extension.youtube.swipecontrols
 
-import android.annotation.SuppressLint
 import android.graphics.Color
 import app.revanced.extension.shared.Logger
 import app.revanced.extension.shared.StringRef.str
 import app.revanced.extension.shared.Utils
+import app.revanced.extension.shared.settings.StringSetting
 import app.revanced.extension.youtube.settings.Settings
 import app.revanced.extension.youtube.shared.PlayerType
 
@@ -51,105 +51,112 @@ class SwipeControlsConfigurationProvider {
     /**
      * Indicates whether press-to-swipe mode is enabled, requiring a press before swiping to activate controls.
      */
-    val shouldEnablePressToSwipe: Boolean
-        get() = Settings.SWIPE_PRESS_TO_ENGAGE.get()
+    val shouldEnablePressToSwipe = Settings.SWIPE_PRESS_TO_ENGAGE.get()
 
     /**
      * The threshold for detecting swipe gestures, in pixels.
      * Loaded once to ensure consistent behavior during rapid scroll events.
      */
-    val swipeMagnitudeThreshold: Int
-        get() = Settings.SWIPE_MAGNITUDE_THRESHOLD.get()
+    val swipeMagnitudeThreshold = Settings.SWIPE_MAGNITUDE_THRESHOLD.get()
 
     /**
      * The sensitivity of volume swipe gestures, determining how much volume changes per swipe.
      * Resets to default if set to 0, as it would disable swiping.
      */
-    val volumeSwipeSensitivity: Int
-        get() {
-            val sensitivity = Settings.SWIPE_VOLUME_SENSITIVITY.get()
+    val volumeSwipeSensitivity: Int by lazy {
+        val sensitivity = Settings.SWIPE_VOLUME_SENSITIVITY.get()
 
-            if (sensitivity < 1) {
-                return Settings.SWIPE_VOLUME_SENSITIVITY.resetToDefault()
-            }
-
-            return sensitivity
+        if (sensitivity < 1) {
+            return@lazy Settings.SWIPE_VOLUME_SENSITIVITY.resetToDefault()
         }
+
+        sensitivity
+    }
     //endregion
 
     //region overlay adjustments
     /**
      * Indicates whether haptic feedback should be enabled for swipe control interactions.
      */
-    val shouldEnableHapticFeedback: Boolean
-        get() = Settings.SWIPE_HAPTIC_FEEDBACK.get()
+    val shouldEnableHapticFeedback = Settings.SWIPE_HAPTIC_FEEDBACK.get()
 
     /**
      * The duration in milliseconds that the overlay should remain visible after a change.
      */
-    val overlayShowTimeoutMillis: Long
-        get() = Settings.SWIPE_OVERLAY_TIMEOUT.get()
+    val overlayShowTimeoutMillis = Settings.SWIPE_OVERLAY_TIMEOUT.get()
 
     /**
      * The background opacity of the overlay, converted from a percentage (0-100) to an alpha value (0-255).
      * Resets to default and shows a toast if the value is out of range.
      */
-    val overlayBackgroundOpacity: Int
-        get() {
-            var opacity = Settings.SWIPE_OVERLAY_OPACITY.get()
-
-            if (opacity < 0 || opacity > 100) {
-                Utils.showToastLong(str("revanced_swipe_overlay_background_opacity_invalid_toast"))
-                opacity = Settings.SWIPE_OVERLAY_OPACITY.resetToDefault()
-            }
+    val overlayBackgroundOpacity: Int by lazy {
+        var opacity = Settings.SWIPE_OVERLAY_OPACITY.get()
 
-            opacity = opacity * 255 / 100
-            return Color.argb(opacity, 0, 0, 0)
+        if (opacity < 0 || opacity > 100) {
+            Utils.showToastLong(str("revanced_swipe_overlay_background_opacity_invalid_toast"))
+            opacity = Settings.SWIPE_OVERLAY_OPACITY.resetToDefault()
         }
 
+        opacity = opacity * 255 / 100
+        Color.argb(opacity, 0, 0, 0)
+    }
+
     /**
-     * The color of the progress bar in the overlay.
+     * The color of the progress bar in the overlay for brightness.
      * Resets to default and shows a toast if the color string is invalid or empty.
      */
-    val overlayProgressColor: Int
-        get() {
-            try {
-                @SuppressLint("UseKtx")
-                val color = Color.parseColor(Settings.SWIPE_OVERLAY_PROGRESS_COLOR.get())
-                return (0xBF000000.toInt() or (color and 0xFFFFFF))
-            } catch (ex: IllegalArgumentException) {
-                Logger.printDebug({ "Could not parse color" }, ex)
-                Utils.showToastLong(str("revanced_swipe_overlay_progress_color_invalid_toast"))
-                Settings.SWIPE_OVERLAY_PROGRESS_COLOR.resetToDefault()
-                return overlayProgressColor // Recursively return.
-            }
+    val overlayBrightnessProgressColor: Int by lazy {
+        // Use lazy to avoid repeat parsing. Changing color requires app restart.
+        getSettingColor(Settings.SWIPE_OVERLAY_BRIGHTNESS_COLOR)
+    }
+
+    /**
+     * The color of the progress bar in the overlay for volume.
+     * Resets to default and shows a toast if the color string is invalid or empty.
+     */
+    val overlayVolumeProgressColor: Int by lazy {
+        getSettingColor(Settings.SWIPE_OVERLAY_VOLUME_COLOR)
+    }
+
+    private fun getSettingColor(setting: StringSetting): Int {
+        try {
+            //noinspection UseKtx
+            val color = Color.parseColor(setting.get())
+            return (0xBF000000.toInt() or (color and 0x00FFFFFF))
+        } catch (ex: IllegalArgumentException) {
+            // This code should never be reached.
+            // Color picker rejects and will not save bad colors to a setting.
+            // If a user imports bad data, the color picker preference resets the
+            // bad color before this method can be called.
+            Logger.printDebug({ "Could not parse color: $setting" }, ex)
+            Utils.showToastLong(str("revanced_settings_color_invalid"))
+            setting.resetToDefault()
+            return getSettingColor(setting) // Recursively return.
         }
+    }
 
     /**
      * The background color used for the filled portion of the progress bar in the overlay.
      */
-    val overlayFillBackgroundPaint: Int
-        get() = 0x80D3D3D3.toInt()
+    val overlayFillBackgroundPaint = 0x80D3D3D3.toInt()
 
     /**
      * The color used for text and icons in the overlay.
      */
-    val overlayTextColor: Int
-        get() = Color.WHITE
+    val overlayTextColor = Color.WHITE
 
     /**
      * The text size in the overlay, in density-independent pixels (dp).
      * Must be between 1 and 30 dp; resets to default and shows a toast if invalid.
      */
-    val overlayTextSize: Int
-        get() {
-            val size = Settings.SWIPE_OVERLAY_TEXT_SIZE.get()
-            if (size < 1 || size > 30) {
-                Utils.showToastLong(str("revanced_swipe_text_overlay_size_invalid_toast"))
-                return Settings.SWIPE_OVERLAY_TEXT_SIZE.resetToDefault()
-            }
-            return size
+    val overlayTextSize: Int by lazy {
+        val size = Settings.SWIPE_OVERLAY_TEXT_SIZE.get()
+        if (size < 1 || size > 30) {
+            Utils.showToastLong(str("revanced_swipe_text_overlay_size_invalid_toast"))
+            return@lazy Settings.SWIPE_OVERLAY_TEXT_SIZE.resetToDefault()
         }
+        size
+    }
 
     /**
      * Defines the style of the swipe controls overlay, determining its layout and appearance.
@@ -199,28 +206,25 @@ class SwipeControlsConfigurationProvider {
         /**
          * A minimal vertical progress bar.
          */
-        VERTICAL_MINIMAL(isMinimal =  true, isVertical = true)
+        VERTICAL_MINIMAL(isMinimal = true, isVertical = true)
     }
 
     /**
      * The current style of the overlay, determining its layout and appearance.
      */
-    val overlayStyle: SwipeOverlayStyle
-        get() = Settings.SWIPE_OVERLAY_STYLE.get()
+    val overlayStyle = Settings.SWIPE_OVERLAY_STYLE.get()
     //endregion
 
     //region behaviour
     /**
      * Indicates whether the brightness level should be saved and restored when entering or exiting fullscreen mode.
      */
-    val shouldSaveAndRestoreBrightness: Boolean
-        get() = Settings.SWIPE_SAVE_AND_RESTORE_BRIGHTNESS.get()
+    val shouldSaveAndRestoreBrightness = Settings.SWIPE_SAVE_AND_RESTORE_BRIGHTNESS.get()
 
     /**
      * Indicates whether auto-brightness should be enabled when the brightness gesture reaches its lowest value.
      */
-    val shouldLowestValueEnableAutoBrightness: Boolean
-        get() = Settings.SWIPE_LOWEST_VALUE_ENABLE_AUTO_BRIGHTNESS.get()
+    val shouldLowestValueEnableAutoBrightness = Settings.SWIPE_LOWEST_VALUE_ENABLE_AUTO_BRIGHTNESS.get()
 
     /**
      * The saved brightness value for the swipe gesture, used to restore brightness in fullscreen mode.
@@ -229,4 +233,4 @@ class SwipeControlsConfigurationProvider {
         get() = Settings.SWIPE_BRIGHTNESS_VALUE.get()
         set(value) = Settings.SWIPE_BRIGHTNESS_VALUE.save(value)
     //endregion
-}
+}