Merge pull request #1622 from tunjid/tj/media-config

Add media config composition local

Author: tunjid

ui/media/src/commonMain/kotlin/com/tunjid/heron/media/MediaConfig.kt

@@ -0,0 +1,22 @@
+package com.tunjid.heron.media
+
+import androidx.collection.IntList
+import androidx.collection.intListOf
+import androidx.compose.runtime.Stable
+import androidx.compose.runtime.staticCompositionLocalOf
+import androidx.compose.ui.unit.IntSize
+
+@Stable
+class MediaConfig(
+    val windowSize: () -> IntSize,
+    val autoPlayGifs: () -> Boolean,
+    val imageSizeBuckets: () -> IntList = ::DefaultImageSizeBuckets,
+)
+
+private val DefaultImageSizeBuckets = intListOf(
+    96, 128, 256, 320, 480, 640,
+    720, 1024, 1280, 1536, 1920,
+)
+val LocalMediaConfig = staticCompositionLocalOf<MediaConfig> {
+    throw IllegalArgumentException("MediaConfig has not been provided")
+}

ui/media/src/commonMain/kotlin/com/tunjid/heron/media/images/AsyncImage.kt

@@ -40,12 +40,13 @@ import androidx.compose.ui.layout.Measurable
 import androidx.compose.ui.layout.MeasureResult
 import androidx.compose.ui.layout.MeasureScope
 import androidx.compose.ui.layout.layout
-import androidx.compose.ui.platform.LocalWindowInfo
 import androidx.compose.ui.unit.Constraints
 import androidx.compose.ui.unit.IntSize
 import com.tunjid.composables.ui.animate
 import com.tunjid.heron.data.files.RestrictedFile
 import com.tunjid.heron.data.files.uiDisplayModel
+import com.tunjid.heron.media.LocalMediaConfig
+import com.tunjid.heron.media.MediaConfig
 import com.tunjid.heron.ui.shapes.RoundedPolygonShape
 import com.tunjid.heron.ui.shapes.animate
 import kotlin.math.min
@@ -107,12 +108,10 @@ data class ImageArgs(
 
 @Stable
 class ImageState internal constructor(
-    args: ImageArgs,
-    private val imageLoader: ImageLoader,
-    private val windowSize: () -> IntSize,
+    internal val args: () -> ImageArgs,
+    internal val mediaConfig: () -> MediaConfig,
+    private val imageLoader: () -> ImageLoader,
 ) {
-    var args by mutableStateOf(args)
-
     internal var image by mutableStateOf<Image?>(null)
     private var layoutSize by mutableStateOf(IntSize.Zero)
 
@@ -152,7 +151,7 @@ class ImageState internal constructor(
         )
             .distinctUntilChanged()
             .collectLatest { (request, size) ->
-                imageLoader.fetchImage(
+                imageLoader().fetchImage(
                     request = request,
                     size = size,
                 )
@@ -161,7 +160,7 @@ class ImageState internal constructor(
     }
 
     private fun requests(): Flow<ImageRequest> =
-        snapshotFlow { args.request }
+        snapshotFlow { args().request }
 
     private fun fetchSizes(): Flow<IntSize> =
         snapshotFlow { layoutSize }
@@ -171,23 +170,23 @@ class ImageState internal constructor(
                 if (index == 0) 0.milliseconds
                 else ImageLayoutSizeRefetchDebounce.milliseconds
             }
-            .map { (_, size) -> size.bucketedFetchSize(windowSize()) }
+            .map { (_, size) -> mediaConfig().bucketedFetchSize(size) }
 }
 
 @Composable
 fun rememberUpdatedImageState(
     args: ImageArgs,
 ): ImageState {
-    val imageLoader = LocalImageLoader.current
-    val windowSize = rememberUpdatedState(LocalWindowInfo.current.containerSize)
-    return remember(imageLoader) {
+    val updatedArgs = rememberUpdatedState(args)
+    val imageLoader = rememberUpdatedState(LocalImageLoader.current)
+    val mediaConfig = rememberUpdatedState(LocalMediaConfig.current)
+    return remember {
         ImageState(
-            args = args,
-            imageLoader = imageLoader,
-            windowSize = windowSize::value,
+            mediaConfig = mediaConfig::value,
+            imageLoader = imageLoader::value,
+            args = updatedArgs::value,
         )
     }
-        .also { it.args = args }
 }
 
 fun ImageArgs(
@@ -248,14 +247,14 @@ fun AsyncImage(
         """.trimIndent()
     }
 
-    val contentDescription = state.args.contentDescription
+    val contentDescription = state.args().contentDescription
     val contentScaleState = rememberUpdatedState(
-        state.args.contentScale.animate(ImageInterpolationSpec),
+        state.args().contentScale.animate(ImageInterpolationSpec),
     )
     val alignmentState = rememberUpdatedState(
-        state.args.alignment.animate(ImageInterpolationSpec),
+        state.args().alignment.animate(ImageInterpolationSpec),
     )
-    val shape = state.args.shape.animate(ImageInterpolationSpec)
+    val shape = state.args().shape.animate(ImageInterpolationSpec)
 
     Box(
         modifier = modifier
@@ -279,7 +278,9 @@ fun AsyncImage(
             contentScale = contentScaleState.value,
         )
 
-        state.image?.AnimationEffect()
+        if (state.mediaConfig().autoPlayGifs()) {
+            state.image?.AnimationEffect()
+        }
     }
 
     val scope = rememberCoroutineScope(
@@ -307,46 +308,31 @@ private val IntSize.isUsable: Boolean
         height > IntSize.Zero.height &&
         height < Int.MAX_VALUE
 
-private fun IntSize.bucketedFetchSize(
-    windowSize: IntSize,
+private fun MediaConfig.bucketedFetchSize(
+    size: IntSize,
 ): IntSize {
-    val maxWidth = windowSize.width.takeIf { it > 0 } ?: width
-    val maxHeight = windowSize.height.takeIf { it > 0 } ?: height
+    val windowSize = windowSize()
+    val maxWidth = if (windowSize.width > 0) windowSize.width else size.width
+    val maxHeight = if (windowSize.height > 0) windowSize.height else size.height
     return IntSize(
-        width = min(width, maxWidth)
-            .roundedUpToDecodeBucket()
+        width = roundedUpToDecodeBucket(min(size.width, maxWidth))
             .coerceAtMost(maxWidth),
-        height = min(height, maxHeight)
-            .roundedUpToDecodeBucket()
+        height = roundedUpToDecodeBucket(min(size.height, maxHeight))
             .coerceAtMost(maxHeight),
     )
 }
 
-private fun Int.roundedUpToDecodeBucket(): Int {
-    DecodeBucketsPx
-    // Smallest bucket >= this, via a lower-bound binary search over the ascending buckets. If this is
-    // larger than every bucket, keep the requested size (never upscale); the window cap still applies.
-    var low = 0
-    var high = DecodeBucketsPx.size - 1
-    var ceiling = this
-    while (low <= high) {
-        val mid = (low + high) ushr 1
-        val bucket = DecodeBucketsPx[mid]
-        if (bucket >= this) {
-            ceiling = bucket
-            high = mid - 1
-        } else {
-            low = mid + 1
-        }
-    }
-    return ceiling
+private fun MediaConfig.roundedUpToDecodeBucket(
+    dimension: Int,
+): Int {
+    val currentBuckets = imageSizeBuckets()
+    val search = currentBuckets.binarySearch(dimension)
+    val index = if (search >= 0) search else search.inv()
+    return currentBuckets[
+        minOf(index, currentBuckets.size - 1),
+    ]
 }
 
-private val DecodeBucketsPx = intArrayOf(
-    96, 128, 256, 320, 480, 640,
-    720, 1024, 1280, 1536, 1920,
-)
-
 private val ImageInterpolationSpec = spring<Float>(
     stiffness = Spring.StiffnessLow,
 )

ui/scaffold/src/commonMain/kotlin/com/tunjid/heron/ui/scaffold/scaffold/App.kt

@@ -24,6 +24,7 @@ import androidx.compose.material3.Surface
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.State
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
@@ -34,13 +35,17 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.layout.layout
 import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.platform.LocalWindowInfo
+import androidx.compose.ui.unit.Dp
+import androidx.compose.ui.unit.IntSize
 import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator
 import androidx.navigation3.runtime.NavEntryDecorator
 import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
 import androidx.navigationevent.NavigationEvent
 import androidx.navigationevent.NavigationEventTransitionState
 import androidx.navigationevent.compose.LocalNavigationEventDispatcherOwner
 import com.tunjid.composables.splitlayout.SplitLayout
+import com.tunjid.heron.media.LocalMediaConfig
+import com.tunjid.heron.media.MediaConfig
 import com.tunjid.heron.media.images.LocalImageLoader
 import com.tunjid.heron.media.video.LocalVideoPlayerController
 import com.tunjid.heron.ui.UiTokens
@@ -109,11 +114,8 @@ fun AppScaffold(
                         sharedTransitionScope = this,
                     )
                 }
-                val windowWidth = rememberUpdatedState(
-                    with(density) {
-                        LocalWindowInfo.current.containerSize.width.toDp()
-                    },
-                )
+                val windowSizeState = windowSizeAsState()
+                val windowWidthDpState = windowWidthDpAsState(windowSizeState)
                 if (!sharedElementsCoordinatesSet()) return@SharedTransitionLayout
 
                 val saveableStateHolderNavEntryDecorator =
@@ -133,7 +135,7 @@ fun AppScaffold(
                                 tertiaryPaneBreakPoint = mutableStateOf(
                                     UiTokens.TertiaryPaneMinWidthBreakpoint,
                                 ),
-                                windowWidthState = windowWidth,
+                                windowWidthState = windowWidthDpState,
                             ),
                             threePaneMovableSharedElementDecorator(
                                 movableSharedElementHostState,
@@ -165,16 +167,29 @@ fun AppScaffold(
                         AppScaffoldState(
                             paneNavigationState = { displayScope.paneNavigationState },
                             density = density,
-                            windowWidth = windowWidth,
+                            windowWidth = windowWidthDpState,
                             staticStates = staticStates,
                         )
                     }.also {
                         it.update(
                             density = density,
                         )
                     }
+                    val localMediaConfig = remember {
+                        MediaConfig(
+                            windowSize = windowSizeState::value,
+                            autoPlayGifs = {
+                                // Make sure the static object is captured and read in the lambda
+                                staticStates.identityState
+                                    .preferences
+                                    ?.local
+                                    ?.autoPlayTimelineGifs ?: true
+                            },
+                        )
+                    }
                     CompositionLocalProvider(
                         LocalAppScaffoldState provides appScaffoldState,
+                        LocalMediaConfig provides localMediaConfig,
                         LocalImageLoader provides staticStates.imageLoader,
                         LocalVideoPlayerController provides staticStates.videoPlayerController,
                     ) {
@@ -241,6 +256,24 @@ fun AppScaffold(
     }
 }
 
+@Composable
+private fun windowSizeAsState(): State<IntSize> =
+    rememberUpdatedState(
+        LocalWindowInfo.current.containerSize,
+    )
+
+@Composable
+private fun windowWidthDpAsState(
+    sizeState: State<IntSize>,
+): State<Dp> {
+    val density = LocalDensity.current
+    return rememberUpdatedState(
+        with(density) {
+            sizeState.value.width.toDp()
+        },
+    )
+}
+
 @Composable
 private fun sharedElementsCoordinatesSet(): Boolean {
     var coordinatesSet by remember {