Closes mozilla-mobile#2043 - Add ColorProcessor from Fennec

Author: NotWoods

buildSrc/src/main/java/Dependencies.kt

@@ -44,6 +44,7 @@ object Versions {
         const val espresso = "3.1.1"
         const val room = "2.0.0"
         const val paging = "2.0.0"
+        const val palette = "1.0.0"
         const val lifecycle = "2.0.0"
         const val work = "2.0.1"
         const val arch_core_testing = "2.0.0"
@@ -82,6 +83,7 @@ object Dependencies {
     const val androidx_lifecycle_extensions = "androidx.lifecycle:lifecycle-extensions:${Versions.AndroidX.lifecycle}"
     const val androidx_lifecycle_compiler = "androidx.lifecycle:lifecycle-compiler:${Versions.AndroidX.lifecycle}"
     const val androidx_paging = "androidx.paging:paging-runtime:${Versions.AndroidX.paging}"
+    const val androidx_palette = "androidx.palette:palette-ktx:${Versions.AndroidX.palette}"
     const val androidx_recyclerview = "androidx.recyclerview:recyclerview:${Versions.AndroidX.recyclerview}"
     const val androidx_room_runtime = "androidx.room:room-runtime:${Versions.AndroidX.room}"
     const val androidx_room_compiler = "androidx.room:room-compiler:${Versions.AndroidX.room}"

components/browser/icons/build.gradle

@@ -42,6 +42,7 @@ dependencies {
     implementation Dependencies.kotlin_stdlib
     implementation Dependencies.kotlin_coroutines
     implementation Dependencies.androidx_annotation
+    implementation Dependencies.androidx_palette
     implementation Dependencies.thirdparty_disklrucache
 
     testImplementation project(':support-test')

components/browser/icons/src/main/java/mozilla/components/browser/icons/BrowserIcons.kt

@@ -112,7 +112,9 @@ class BrowserIcons(
         }
 
         // (3) Finally process the icon.
-        return process(context, processors, request, resource, icon)
+        return process(context, processors, request, resource, icon).run {
+            if (bitmap != null) this else generator.generate(context, request)
+        }
     }
 
     /**
@@ -135,16 +137,11 @@ class BrowserIcons(
     }
 }
 
-private fun prepare(context: Context, preparers: List<IconPreprarer>, request: IconRequest): IconRequest {
-    var preparedRequest: IconRequest = request
-
-    preparers.forEach { preparer ->
-        preparedRequest = preparer.prepare(context, preparedRequest)
+private fun prepare(context: Context, preparers: List<IconPreprarer>, request: IconRequest): IconRequest =
+    preparers.fold(request) { preparedRequest, preparer ->
+        preparer.prepare(context, preparedRequest)
     }
 
-    return preparedRequest
-}
-
 private fun load(
     context: Context,
     request: IconRequest,
@@ -192,12 +189,7 @@ private fun process(
     request: IconRequest,
     resource: IconRequest.Resource?,
     icon: Icon
-): Icon {
-    var processedIcon = icon
-
-    processors.forEach { processor ->
-        processedIcon = processor.process(context, request, resource, processedIcon)
+): Icon =
+    processors.fold(icon) { processedIcon, processor ->
+        processor.process(context, request, resource, processedIcon)
     }
-
-    return processedIcon
-}

components/browser/icons/src/main/java/mozilla/components/browser/icons/decoder/AndroidIconDecoder.kt

@@ -16,11 +16,11 @@ import mozilla.components.support.base.log.logger.Logger
 class AndroidIconDecoder : IconDecoder {
     private val logger = Logger("AndroidIconDecoder")
 
-    override fun decode(data: ByteArray, targetSize: Int, maxSize: Int, maxScaleFactor: Float): Bitmap? {
+    override fun decode(data: ByteArray, targetSize: Int, maxSize: Int, maxScaleFactor: Float): Bitmap? =
         try {
             val bitmap = decodeBitmap(data)
 
-            return when {
+            when {
                 bitmap == null -> null
 
                 bitmap.width <= 0 || bitmap.height <= 0 -> {
@@ -42,9 +42,8 @@ class AndroidIconDecoder : IconDecoder {
                 else -> bitmap
             }
         } catch (e: OutOfMemoryError) {
-            return null
+            null
         }
-    }
 
     @VisibleForTesting(otherwise = PRIVATE)
     internal fun decodeBitmap(data: ByteArray): Bitmap? {

components/browser/icons/src/main/java/mozilla/components/browser/icons/processor/ColorProcessor.kt

@@ -0,0 +1,23 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.icons.processor
+
+import android.content.Context
+import androidx.palette.graphics.Palette
+import mozilla.components.browser.icons.Icon
+import mozilla.components.browser.icons.IconRequest
+
+/**
+ * [IconProcessor] implementation to extract the dominant color from the icon.
+ */
+class ColorProcessor : IconProcessor {
+
+    override fun process(context: Context, request: IconRequest, resource: IconRequest.Resource?, icon: Icon): Icon {
+        if (icon.bitmap == null || icon.color != null) return icon
+
+        val swatch = Palette.from(icon.bitmap).generate().dominantSwatch
+        return swatch?.run { icon.copy(color = rgb) } ?: icon
+    }
+}

components/browser/icons/src/test/java/mozilla/components/browser/icons/processor/ColorProcessorTest.kt

@@ -0,0 +1,56 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.icons.processor
+
+import android.graphics.Bitmap
+import android.graphics.Color
+import mozilla.components.browser.icons.Icon
+import mozilla.components.support.test.any
+import mozilla.components.support.test.mock
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.mockito.Mockito.anyInt
+import org.mockito.Mockito.doAnswer
+import org.mockito.Mockito.doReturn
+import org.robolectric.RobolectricTestRunner
+
+@RunWith(RobolectricTestRunner::class)
+class ColorProcessorTest {
+    @Test
+    fun `test extracting color`() {
+        val icon = Icon(mockRedBitmap(1), source = Icon.Source.DISK)
+        val processed = ColorProcessor().process(mock(), mock(), mock(), icon)
+
+        assertEquals(icon.bitmap, processed.bitmap)
+        assertNotNull(processed.color)
+    }
+
+    @Test
+    fun `test extracting color from larger bitmap`() {
+        val icon = Icon(mockRedBitmap(3), source = Icon.Source.DISK)
+        val processed = ColorProcessor().process(mock(), mock(), mock(), icon)
+
+        assertEquals(icon.bitmap, processed.bitmap)
+        assertNotNull(processed.color)
+    }
+
+    private fun mockRedBitmap(size: Int): Bitmap {
+        val bitmap: Bitmap = mock()
+        doReturn(size).`when`(bitmap).height
+        doReturn(size).`when`(bitmap).width
+
+        doAnswer {
+            val pixels: IntArray = it.getArgument(0)
+            for (i in 0 until pixels.size) {
+                pixels[i] = Color.RED
+            }
+            null
+        }.`when`(bitmap).getPixels(any(), anyInt(), anyInt(), anyInt(), anyInt(), anyInt(), anyInt())
+
+        return bitmap
+    }
+}