feat(YouTube Music - Custom branding icon): Add patch option RestoreOldSplashIcon

Author: inotia00

src/main/kotlin/app/revanced/patches/music/layout/branding/icon/CustomBrandingIconPatch.kt

@@ -9,8 +9,10 @@ import app.revanced.patches.music.utils.settings.ResourceUtils.setIconType
 import app.revanced.util.ResourceGroup
 import app.revanced.util.Utils.trimIndentMultiline
 import app.revanced.util.copyResources
+import app.revanced.util.getResourceGroup
 import app.revanced.util.patch.BaseResourcePatch
 import app.revanced.util.underBarOrThrow
+import org.w3c.dom.Element
 import java.io.File
 import java.nio.file.Files
 
@@ -84,23 +86,14 @@ object CustomBrandingIconPatch : BaseResourcePatch(
         "record"
     ).map { "$it.png" }.toTypedArray()
 
-    private val headerIconResourceGroups = drawableDirectories.map { directory ->
-        ResourceGroup(
-            directory, *headerIconResourceFileNames
-        )
-    }
+    private val headerIconResourceGroups =
+        drawableDirectories.getResourceGroup(headerIconResourceFileNames)
 
-    private val launcherIconResourceGroups = mipmapDirectories.map { directory ->
-        ResourceGroup(
-            directory, *launcherIconResourceFileNames
-        )
-    }
+    private val launcherIconResourceGroups =
+        mipmapDirectories.getResourceGroup(launcherIconResourceFileNames)
 
-    private val splashIconResourceGroups = largeDrawableDirectories.map { directory ->
-        ResourceGroup(
-            directory, *splashIconResourceFileNames
-        )
-    }
+    private val splashIconResourceGroups =
+        largeDrawableDirectories.getResourceGroup(splashIconResourceFileNames)
 
     val AppIcon = stringPatchOption(
         key = "AppIcon",
@@ -137,13 +130,28 @@ object CustomBrandingIconPatch : BaseResourcePatch(
         required = true
     )
 
+    private val RestoreOldSplashIcon by booleanPatchOption(
+        key = "RestoreOldSplashIcon",
+        default = false,
+        title = "Restore old splash icon",
+        description = """
+            Restore the old style splash icon.
+            
+            If you enable both the old style splash icon and the Cairo splash animation,
+            
+            Old style splash icon will appear first and then the Cairo splash animation will start.
+            """.trimIndentMultiline(),
+        required = true
+    )
+
     override fun execute(context: ResourceContext) {
 
         // Check patch options first.
         val appIcon = AppIcon
             .underBarOrThrow()
 
         val appIconResourcePath = "music/branding/$appIcon"
+        val youtubeMusicIconResourcePath = "music/branding/youtube_music"
 
         // Check if a custom path is used in the patch options.
         if (!availableIcon.containsValue(appIcon)) {
@@ -196,6 +204,39 @@ object CustomBrandingIconPatch : BaseResourcePatch(
                 }
             }
 
+            // Change splash icon.
+            if (RestoreOldSplashIcon == true) {
+                var oldSplashIconNotExists: Boolean
+
+                context.xmlEditor["res/drawable/splash_screen.xml"].use { editor ->
+                    editor.file.apply {
+                        val node = getElementsByTagName("layer-list").item(0)
+                        oldSplashIconNotExists = (node as Element)
+                            .getElementsByTagName("item")
+                            .length == 1
+
+                        if (oldSplashIconNotExists) {
+                            createElement("item").also { itemNode ->
+                                itemNode.appendChild(
+                                    createElement("bitmap").also { bitmapNode ->
+                                        bitmapNode.setAttribute("android:gravity", "center")
+                                        bitmapNode.setAttribute("android:src", "@drawable/record")
+                                    }
+                                )
+                                node.appendChild(itemNode)
+                            }
+                        }
+                    }
+                }
+                if (oldSplashIconNotExists) {
+                    splashIconResourceGroups.let { resourceGroups ->
+                        resourceGroups.forEach {
+                            context.copyResources("$youtubeMusicIconResourcePath/splash", it, createDirectoryIfNotExist = true)
+                        }
+                    }
+                }
+            }
+
             // Change splash icon.
             if (ChangeSplashIcon == true) {
                 // Some resources have been removed in the latest YouTube Music.

src/main/kotlin/app/revanced/patches/youtube/layout/branding/icon/CustomBrandingIconPatch.kt

@@ -11,6 +11,7 @@ import app.revanced.util.Utils.trimIndentMultiline
 import app.revanced.util.copyFile
 import app.revanced.util.copyResources
 import app.revanced.util.copyXmlNode
+import app.revanced.util.getResourceGroup
 import app.revanced.util.patch.BaseResourcePatch
 import app.revanced.util.underBarOrThrow
 
@@ -99,12 +100,6 @@ object CustomBrandingIconPatch : BaseResourcePatch(
         "avd_anim"
     ).map { "$it.xml" }.toTypedArray()
 
-    private fun List<String>.getResourceGroup(fileNames: Array<String>) = map { directory ->
-        ResourceGroup(
-            directory, *fileNames
-        )
-    }
-
     private val headerIconResourceGroups =
         drawableDirectories.getResourceGroup(headerIconResourceFileNames)
 

src/main/kotlin/app/revanced/util/ResourceUtils.kt

@@ -63,6 +63,12 @@ fun String.startsWithAny(vararg prefixes: String): Boolean {
     return false
 }
 
+fun List<String>.getResourceGroup(fileNames: Array<String>) = map { directory ->
+    ResourceGroup(
+        directory, *fileNames
+    )
+}
+
 fun ResourceContext.copyFile(
     resourceGroup: List<ResourceGroup>,
     path: String,
@@ -98,16 +104,25 @@ fun ResourceContext.copyFile(
  *
  * @param sourceResourceDirectory The source resource directory name.
  * @param resources The resources to copy.
+ * @param createDirectoryIfNotExist Whether to create a new directory if it does not exist.
  */
 fun ResourceContext.copyResources(
     sourceResourceDirectory: String,
     vararg resources: ResourceGroup,
+    createDirectoryIfNotExist: Boolean = false,
 ) {
     val targetResourceDirectory = this["res"]
 
     for (resourceGroup in resources) {
         resourceGroup.resources.forEach { resource ->
-            val resourceFile = "${resourceGroup.resourceDirectoryName}/$resource"
+            val resourceDirectoryName = resourceGroup.resourceDirectoryName
+
+            if (createDirectoryIfNotExist) {
+                val targetDirectory = targetResourceDirectory.resolve(resourceDirectoryName)
+                if (!targetDirectory.isDirectory) Files.createDirectories(targetDirectory.toPath())
+            }
+
+            val resourceFile = "$resourceDirectoryName/$resource"
 
             inputStreamFromBundledResource(
                 sourceResourceDirectory,