Merge pull request #391 from skydoves/kmp/landscapist-palette

Support landscapist-palette for KMP

app/build.gradle.kts

@@ -29,7 +29,7 @@ android {
   compileSdk = Configuration.compileSdk
   defaultConfig {
     applicationId = "com.github.skydoves.landscapistdemo"
-    minSdk = Configuration.minSdk
+    minSdk = Configuration.minSdk24
     targetSdk = Configuration.targetSdk
     versionCode = Configuration.versionCode
     versionName = Configuration.versionName

benchmark-landscapist-app/build.gradle.kts

@@ -27,7 +27,7 @@ android {
   compileSdk = Configuration.compileSdk
   defaultConfig {
     applicationId = "com.skydoves.benchmark.landscapist.app"
-    minSdk = 24
+    minSdk = Configuration.minSdk24
     targetSdk = Configuration.targetSdk
     versionCode = Configuration.versionCode
     versionName = Configuration.versionName

benchmark-landscapist/build.gradle.kts

@@ -29,7 +29,7 @@ android {
   compileSdk = Configuration.compileSdk
 
   defaultConfig {
-    minSdk = 24
+    minSdk = Configuration.minSdk24
     targetSdk = Configuration.targetSdk
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
   }

buildSrc/src/main/kotlin/com/github/skydoves/landscapist/Configuration.kt

@@ -20,6 +20,7 @@ object Configuration {
   const val compileSdk = 34
   const val targetSdk = 34
   const val minSdk = 21
+  const val minSdk24 = 24
   const val majorVersion = 2
   const val minorVersion = 2
   const val patchVersion = 13

gradle/libs.versions.toml

@@ -53,7 +53,7 @@ kotlinx-coroutines-android = { group = "org.jetbrains.kotlinx", name = "kotlinx-
 kotlinx-coroutines-test = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-test", version.ref = "kotlinxCoroutines" }
 hilt-android = { group = "com.google.dagger", name = "hilt-android", version.ref = "hilt" }
 hilt-compiler = { group = "com.google.dagger", name = "hilt-android-compiler", version.ref = "hilt" }
-palette = { group = "androidx.palette", name = "palette-ktx", version.ref = "palette" }
+palette = { group = "com.kmpalette", name = "kmpalette-core", version.ref = "palette" }
 glide = { group = "com.github.bumptech.glide", name = "glide", version.ref = "glide" }
 fresco = { group = "com.facebook.fresco", name = "fresco", version.ref = "fresco" }
 fresco-okhttp3 = { group = "com.facebook.fresco", name = "imagepipeline-okhttp3", version.ref = "fresco" }

landscapist-palette/api/android/landscapist-palette.api

@@ -0,0 +1,25 @@
+public abstract interface class com/skydoves/landscapist/palette/PaletteBuilderInterceptor {
+	public abstract fun intercept (Landroidx/palette/graphics/Palette$Builder;)Landroidx/palette/graphics/Palette$Builder;
+}
+
+public abstract interface class com/skydoves/landscapist/palette/PaletteLoadedListener {
+	public abstract fun onPaletteLoaded (Landroidx/palette/graphics/Palette;)V
+}
+
+public final class com/skydoves/landscapist/palette/PalettePlugin : com/skydoves/landscapist/plugins/ImagePlugin$SuccessStatePlugin {
+	public static final field $stable I
+	public fun <init> ()V
+	public fun <init> (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;)V
+	public synthetic fun <init> (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun compose (Landroidx/compose/ui/Modifier;Ljava/lang/Object;Lcom/skydoves/landscapist/ImageOptions;Landroidx/compose/ui/graphics/ImageBitmap;Landroidx/compose/runtime/Composer;I)Lcom/skydoves/landscapist/plugins/ImagePlugin;
+	public final fun copy (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;)Lcom/skydoves/landscapist/palette/PalettePlugin;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/palette/PalettePlugin;Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;ILjava/lang/Object;)Lcom/skydoves/landscapist/palette/PalettePlugin;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/palette/RememberPaletteStateKt {
+	public static final fun rememberPaletteState (Landroidx/palette/graphics/Palette;Landroidx/compose/runtime/SnapshotMutationPolicy;Landroidx/compose/runtime/Composer;II)Landroidx/compose/runtime/MutableState;
+}
+

landscapist-palette/api/desktop/landscapist-palette.api

@@ -0,0 +1,25 @@
+public abstract interface class com/skydoves/landscapist/palette/PaletteBuilderInterceptor {
+	public abstract fun intercept (Landroidx/palette/graphics/Palette$Builder;)Landroidx/palette/graphics/Palette$Builder;
+}
+
+public abstract interface class com/skydoves/landscapist/palette/PaletteLoadedListener {
+	public abstract fun onPaletteLoaded (Landroidx/palette/graphics/Palette;)V
+}
+
+public final class com/skydoves/landscapist/palette/PalettePlugin : com/skydoves/landscapist/plugins/ImagePlugin$SuccessStatePlugin {
+	public static final field $stable I
+	public fun <init> ()V
+	public fun <init> (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;)V
+	public synthetic fun <init> (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun compose (Landroidx/compose/ui/Modifier;Ljava/lang/Object;Lcom/skydoves/landscapist/ImageOptions;Landroidx/compose/ui/graphics/ImageBitmap;Landroidx/compose/runtime/Composer;I)Lcom/skydoves/landscapist/plugins/ImagePlugin;
+	public final fun copy (Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;)Lcom/skydoves/landscapist/palette/PalettePlugin;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/palette/PalettePlugin;Ljava/lang/Object;ZLcom/skydoves/landscapist/palette/PaletteBuilderInterceptor;Lcom/skydoves/landscapist/palette/PaletteLoadedListener;ILjava/lang/Object;)Lcom/skydoves/landscapist/palette/PalettePlugin;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/palette/RememberPaletteStateKt {
+	public static final fun rememberPaletteState (Landroidx/palette/graphics/Palette;Landroidx/compose/runtime/SnapshotMutationPolicy;Landroidx/compose/runtime/Composer;II)Landroidx/compose/runtime/MutableState;
+}
+

landscapist-palette/build.gradle.kts

@@ -16,7 +16,7 @@
 import com.github.skydoves.landscapist.Configuration
 
 plugins {
-  id("landscapist.library.compose")
+  id("landscapist.library.compose.multiplatform")
   id("landscapist.spotless")
 }
 
@@ -35,12 +35,32 @@ mavenPublishing {
   }
 }
 
+kotlin {
+  sourceSets {
+    all {
+      languageSettings.optIn("kotlin.RequiresOptIn")
+      languageSettings.optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
+      languageSettings.optIn("com.skydoves.landscapist.InternalLandscapistApi")
+    }
+    val commonMain by getting {
+      dependencies {
+        api(project(":landscapist"))
+        api(libs.palette)
+
+        implementation(compose.ui)
+        implementation(compose.runtime)
+        implementation(compose.foundation)
+      }
+    }
+  }
+}
+
 android {
   namespace = "com.skydoves.landscapist.palette"
   compileSdk = Configuration.compileSdk
 
   defaultConfig {
-    minSdk = Configuration.minSdk
+    minSdk = Configuration.minSdk24
     testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
   }
 }
@@ -52,18 +72,14 @@ baselineProfile {
   }
 }
 
-dependencies {
-  api(project(":landscapist"))
-  api(libs.palette)
-
-  implementation(libs.androidx.core.ktx)
-  implementation(libs.androidx.compose.ui)
-  implementation(libs.androidx.compose.runtime)
-  implementation(libs.androidx.compose.foundation)
-
-  androidTestImplementation(libs.androidx.test.rules)
-  androidTestImplementation(libs.androidx.test.runner)
-  androidTestImplementation(libs.androidx.test.junit)
-  androidTestImplementation(libs.androidx.compose.ui)
-  androidTestImplementation(libs.androidx.compose.ui.test)
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+  kotlinOptions {
+    jvmTarget = "1.8"
+    freeCompilerArgs += listOf(
+      "-Xexplicit-api=strict",
+      "-opt-in=kotlin.RequiresOptIn",
+      "-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
+      "-opt-in=com.skydoves.landscapist.InternalLandscapistApi",
+    )
+  }
 }

landscapist-palette/src/main/kotlin/com/skydoves/landscapist/palette/BitmapPalette.kt → landscapist-palette/src/commonMain/kotlin/com/skydoves/landscapist/palette/BitmapPalette.kt

@@ -15,9 +15,11 @@
  */
 package com.skydoves.landscapist.palette
 
-import android.graphics.Bitmap
-import android.util.LruCache
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.ui.graphics.ImageBitmap
 import androidx.palette.graphics.Palette
+import com.kmpalette.rememberPaletteState
 
 /**
  * BitmapPalette is a [Palette] generator for extracting major (theme) colors
@@ -28,7 +30,7 @@ import androidx.palette.graphics.Palette
  * @param interceptor A custom interceptor before generating colors.
  * @param paletteLoadedListener A listener for listening to the loaded palette.
  */
-internal class BitmapPalette constructor(
+internal class BitmapPalette(
   private var imageModel: Any? = null,
   private val useCache: Boolean = true,
   private val interceptor: PaletteBuilderInterceptor? = null,
@@ -39,29 +41,17 @@ internal class BitmapPalette constructor(
     this.imageModel = imageModel
   }
 
-  fun generate(bitmap: Bitmap?) {
-    val target = bitmap ?: return
-    val model = imageModel ?: return
-    if (useCache) {
-      val palette = cache.get(model)
+  @Composable
+  fun generate(bitmap: ImageBitmap) {
+    val cacheSize = if (useCache) 5 else 0
+    val paletteState = rememberPaletteState(cacheSize = cacheSize)
+    LaunchedEffect(bitmap) {
+      paletteState.generate(bitmap)
+      val palette = paletteState.palette
+
       if (palette != null) {
         paletteLoadedListener?.onPaletteLoaded(palette)
-        return
-      }
-    }
-    val builder = interceptor?.intercept(Palette.Builder(target))
-      ?: Palette.Builder(target)
-    builder.generate async@{
-      val palette: Palette = it ?: return@async
-      if (useCache) {
-        cache.put(model, palette)
       }
-      paletteLoadedListener?.onPaletteLoaded(palette)
     }
   }
-
-  internal companion object {
-    internal val cache: LruCache<Any, Palette?>
-      by lazy(LazyThreadSafetyMode.NONE) { LruCache(20) }
-  }
 }

landscapist-palette/src/main/kotlin/com/skydoves/landscapist/palette/PalettePlugin.kt → landscapist-palette/src/commonMain/kotlin/com/skydoves/landscapist/palette/PalettePlugin.kt

@@ -19,7 +19,6 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.Immutable
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.ImageBitmap
-import androidx.compose.ui.graphics.asAndroidBitmap
 import com.skydoves.landscapist.ImageOptions
 import com.skydoves.landscapist.plugins.ImagePlugin
 
@@ -56,7 +55,7 @@ public data class PalettePlugin(
     apply {
       imageBitmap?.let {
         bitmapPalette.applyImageModel(this.imageModel ?: imageModel)
-        bitmapPalette.generate(it.asAndroidBitmap())
+        bitmapPalette.generate(it)
       }
     }
 }