feat(Spotify - Custom theme): Add option to use unmodified player background gradient

patches/api/patches.api

@@ -1515,7 +1515,11 @@ public final class app/revanced/patches/yuka/misc/unlockpremium/UnlockPremiumPat
 }
 
 public final class app/revanced/util/BytecodeUtilsKt {
+	public static final fun addInstructionsAtControlFlowLabel (Lapp/revanced/patcher/util/proxy/mutableTypes/MutableMethod;ILjava/lang/String;)V
+	public static final fun containsLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;D)Z
+	public static final fun containsLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;F)Z
 	public static final fun containsLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;J)Z
+	public static final fun findFreeRegister (Lcom/android/tools/smali/dexlib2/iface/Method;I[I)I
 	public static final fun findInstructionIndicesReversed (Lcom/android/tools/smali/dexlib2/iface/Method;Lcom/android/tools/smali/dexlib2/Opcode;)Ljava/util/List;
 	public static final fun findInstructionIndicesReversed (Lcom/android/tools/smali/dexlib2/iface/Method;Lkotlin/jvm/functions/Function1;)Ljava/util/List;
 	public static final fun findInstructionIndicesReversedOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;Lcom/android/tools/smali/dexlib2/Opcode;)Ljava/util/List;
@@ -1542,9 +1546,17 @@ public final class app/revanced/util/BytecodeUtilsKt {
 	public static final fun indexOfFirstInstructionReversedOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;Ljava/lang/Integer;Lkotlin/jvm/functions/Function1;)I
 	public static synthetic fun indexOfFirstInstructionReversedOrThrow$default (Lcom/android/tools/smali/dexlib2/iface/Method;Ljava/lang/Integer;Lcom/android/tools/smali/dexlib2/Opcode;ILjava/lang/Object;)I
 	public static synthetic fun indexOfFirstInstructionReversedOrThrow$default (Lcom/android/tools/smali/dexlib2/iface/Method;Ljava/lang/Integer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)I
+	public static final fun indexOfFirstLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;D)I
+	public static final fun indexOfFirstLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;F)I
 	public static final fun indexOfFirstLiteralInstruction (Lcom/android/tools/smali/dexlib2/iface/Method;J)I
+	public static final fun indexOfFirstLiteralInstructionOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;D)I
+	public static final fun indexOfFirstLiteralInstructionOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;F)I
 	public static final fun indexOfFirstLiteralInstructionOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;J)I
+	public static final fun indexOfFirstLiteralInstructionReversed (Lcom/android/tools/smali/dexlib2/iface/Method;D)I
+	public static final fun indexOfFirstLiteralInstructionReversed (Lcom/android/tools/smali/dexlib2/iface/Method;F)I
 	public static final fun indexOfFirstLiteralInstructionReversed (Lcom/android/tools/smali/dexlib2/iface/Method;J)I
+	public static final fun indexOfFirstLiteralInstructionReversedOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;D)I
+	public static final fun indexOfFirstLiteralInstructionReversedOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;F)I
 	public static final fun indexOfFirstLiteralInstructionReversedOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;J)I
 	public static final fun indexOfFirstResourceId (Lcom/android/tools/smali/dexlib2/iface/Method;Ljava/lang/String;)I
 	public static final fun indexOfFirstResourceIdOrThrow (Lcom/android/tools/smali/dexlib2/iface/Method;Ljava/lang/String;)I

patches/src/main/kotlin/app/revanced/patches/spotify/layout/theme/CustomThemePatch.kt

@@ -1,8 +1,126 @@
 package app.revanced.patches.spotify.layout.theme
 
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.fingerprint
+import app.revanced.patcher.patch.booleanOption
+import app.revanced.patcher.patch.bytecodePatch
 import app.revanced.patcher.patch.resourcePatch
+import app.revanced.patcher.patch.stringOption
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
+import app.revanced.patches.spotify.misc.extension.sharedExtensionPatch
+import app.revanced.util.*
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
+import com.android.tools.smali.dexlib2.iface.reference.FieldReference
 import org.w3c.dom.Element
 
+private const val EXTENSION_CLASS_DESCRIPTOR = "Lapp/revanced/extension/spotify/layout/theme/CustomThemePatch;"
+
+internal val spotifyBackgroundColor = stringOption(
+    key = "backgroundColor",
+    default = "@android:color/black",
+    title = "Primary background color",
+    description = "The background color. Can be a hex color or a resource reference.",
+    required = true,
+)
+
+internal val overridePlayerGradientColor = booleanOption(
+    key = "overridePlayerGradientColor",
+    default = true,
+    title = "Override player gradient color",
+    description = "Apply primary background color to the player gradient color, which changes dynamically with the song.",
+    required = false
+)
+
+internal val spotifyBackgroundColorSecondary = stringOption(
+    key = "backgroundColorSecondary",
+    default = "#FF121212",
+    title = "Secondary background color",
+    description =
+        "The secondary background color. (e.g. playlist list in home, player artist, song credits). Can be a hex color or a resource reference.",
+    required = true,
+)
+
+internal val spotifyAccentColor = stringOption(
+    key = "accentColor",
+    default = "#FF1ED760",
+    title = "Accent color",
+    description = "The accent color ('Spotify green' by default). Can be a hex color or a resource reference.",
+    required = true,
+)
+
+internal val spotifyAccentColorPressed = stringOption(
+    key = "accentColorPressed",
+    default = "#FF169C46",
+    title = "Pressed dark theme accent color",
+    description =
+        "The color when accented buttons are pressed, by default slightly darker than accent. Can be a hex color or a resource reference.",
+    required = true,
+)
+
+internal val customThemeBytecodePatch = bytecodePatch {
+    dependsOn(sharedExtensionPatch)
+
+    execute {
+        fun MutableMethod.addColorChangeInstructions(literal: Long, colorString: String) {
+            val index = indexOfFirstLiteralInstructionOrThrow(literal)
+            val register = getInstruction<OneRegisterInstruction>(index).registerA
+
+            addInstructions(
+                index + 1,
+                """
+                    const-string v$register, "$colorString"
+                    invoke-static { v$register }, $EXTENSION_CLASS_DESCRIPTOR->getThemeColor(Ljava/lang/String;)J
+                    move-result-wide v$register
+                """
+            )
+        }
+
+        val encoreColorsClassName = with(encoreThemeFingerprint.originalMethod) {
+            // "Encore" colors are referenced right before the value of POSITIVE_INFINITY is returned.
+            // Begin the instruction find using the index of where POSITIVE_INFINITY is set into the register.
+            val positiveInfinityIndex = indexOfFirstLiteralInstructionOrThrow(
+                Float.POSITIVE_INFINITY
+            )
+            val encoreColorsFieldReferenceIndex = indexOfFirstInstructionReversedOrThrow(
+                positiveInfinityIndex,
+                Opcode.SGET_OBJECT
+            )
+
+            getInstruction(encoreColorsFieldReferenceIndex)
+                .getReference<FieldReference>()!!.definingClass
+        }
+
+        val encoreColorsConstructorFingerprint = fingerprint {
+            accessFlags(AccessFlags.STATIC, AccessFlags.CONSTRUCTOR)
+            custom { method, classDef ->
+                classDef.type == encoreColorsClassName &&
+                        method.containsLiteralInstruction(PLAYLIST_BACKGROUND_COLOR_LITERAL)
+            }
+        }
+
+        val backgroundColor by spotifyBackgroundColor
+        val backgroundColorSecondary by spotifyBackgroundColorSecondary
+
+        encoreColorsConstructorFingerprint.method.apply {
+            addColorChangeInstructions(PLAYLIST_BACKGROUND_COLOR_LITERAL, backgroundColor!!)
+            addColorChangeInstructions(SHARE_MENU_BACKGROUND_COLOR_LITERAL, backgroundColorSecondary!!)
+        }
+
+        homeCategoryPillColorsFingerprint.method.addColorChangeInstructions(
+            HOME_CATEGORY_PILL_COLOR_LITERAL,
+            backgroundColorSecondary!!
+        )
+
+        settingsHeaderColorFingerprint.method.addColorChangeInstructions(
+            SETTINGS_HEADER_COLOR_LITERAL,
+            backgroundColorSecondary!!
+        )
+    }
+}
+
 @Suppress("unused")
 val customThemePatch = resourcePatch(
     name = "Custom theme",
@@ -11,9 +129,10 @@ val customThemePatch = resourcePatch(
 ) {
     compatibleWith("com.spotify.music")
 
-    dependsOn(customThemeByteCodePatch)
+    dependsOn(customThemeBytecodePatch)
 
     val backgroundColor by spotifyBackgroundColor()
+    val overridePlayerGradientColor by overridePlayerGradientColor()
     val backgroundColorSecondary by spotifyBackgroundColorSecondary()
     val accentColor by spotifyAccentColor()
     val accentColorPressed by spotifyAccentColorPressed()
@@ -25,31 +144,39 @@ val customThemePatch = resourcePatch(
             val childNodes = resourcesNode.childNodes
             for (i in 0 until childNodes.length) {
                 val node = childNodes.item(i) as? Element ?: continue
+                val name = node.getAttribute("name")
+
+                // Skip overriding song/player gradient start color if the option is disabled.
+                // Gradient end color should be themed regardless to allow the gradient to connect with
+                // our primary background color.
+                if (name == "bg_gradient_start_color" && !overridePlayerGradientColor!!) {
+                    continue
+                }
 
-                node.textContent = when (node.getAttribute("name")) {
-                    // Gradient next to user photo and "All" in home page
+                node.textContent = when (name) {
+                    // Gradient next to user photo and "All" in home page.
                     "dark_base_background_base",
-                    // Main background
+                    // Main background.
                     "gray_7",
-                    // Left sidebar background in tablet mode
+                    // Left sidebar background in tablet mode.
                     "gray_10",
-                    // Add account, Settings and privacy, View Profile left sidebar background
+                    // "Add account", "Settings and privacy", "View Profile" left sidebar background.
                     "dark_base_background_elevated_base",
-                    // Song/player background
+                    // Song/player gradient start/end color.
                     "bg_gradient_start_color", "bg_gradient_end_color",
-                    // Login screen
+                    // Login screen background.
                     "sthlm_blk", "sthlm_blk_grad_start", "stockholm_black",
-                    // Misc
+                    // Misc.
                     "image_placeholder_color",
                         -> backgroundColor
 
-                    // Track credits, merch in song player
+                    // Track credits, merch background in song player.
                     "track_credits_card_bg", "benefit_list_default_color", "merch_card_background",
-                    // Playlist list background in home page
+                    // Playlist list background in home page.
                     "opacity_white_10",
-                    // About artist background in song player
+                    // "About the artist" background in song player.
                     "gray_15",
-                    // What's New pills background
+                    // "What's New" pills background.
                     "dark_base_background_tinted_highlight"
                         -> backgroundColorSecondary
 

patches/src/main/kotlin/app/revanced/patches/spotify/layout/theme/Fingerprints.kt

@@ -5,13 +5,13 @@ import app.revanced.util.containsLiteralInstruction
 import com.android.tools.smali.dexlib2.AccessFlags
 
 internal val encoreThemeFingerprint = fingerprint {
-    strings("Encore theme was not provided.") // Partial string match.
+    strings("No EncoreLayoutTheme provided")
 }
 
-internal const val SETTINGS_HEADER_COLOR_LITERAL = 0xFF282828
-internal const val HOME_CATEGORY_PILL_COLOR_LITERAL = 0xFF333333
 internal const val PLAYLIST_BACKGROUND_COLOR_LITERAL = 0xFF121212
 internal const val SHARE_MENU_BACKGROUND_COLOR_LITERAL = 0xFF1F1F1F
+internal const val HOME_CATEGORY_PILL_COLOR_LITERAL = 0xFF333333
+internal const val SETTINGS_HEADER_COLOR_LITERAL = 0xFF282828
 
 internal val homeCategoryPillColorsFingerprint = fingerprint{
     accessFlags(AccessFlags.STATIC, AccessFlags.CONSTRUCTOR)