BitmapFactoryDecoderTest.kt

package coil.decode

import android.content.Context
import android.graphics.Bitmap
import android.graphics.BitmapFactory
import android.graphics.drawable.BitmapDrawable
import android.os.Build.VERSION.SDK_INT
import androidx.test.core.app.ApplicationProvider
import coil.ImageLoader
import coil.fetch.SourceResult
import coil.request.Options
import coil.size.Dimension
import coil.size.Scale
import coil.size.Size
import coil.util.assertIsSimilarTo
import coil.util.assumeTrue
import coil.util.decodeBitmapAsset
import coil.util.isSimilarTo
import coil.util.size
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.test.runTest
import okio.buffer
import okio.source
import org.junit.Before
import org.junit.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertFalse
import kotlin.test.assertIs
import kotlin.test.assertTrue

@OptIn(ExperimentalCoroutinesApi::class)
class BitmapFactoryDecoderTest {

    private lateinit var context: Context
    private lateinit var decoderFactory: BitmapFactoryDecoder.Factory

    @Before
    fun before() {
        context = ApplicationProvider.getApplicationContext()
        decoderFactory = BitmapFactoryDecoder.Factory()
    }

    @Test
    fun basic() = runTest {
        val result = decode(
            assetName = "normal.jpg",
            size = Size(100, 100)
        )

        assertTrue(result.isSampled)
        val drawable = assertIs<BitmapDrawable>(result.drawable)
        assertEquals(Size(100, 125), drawable.bitmap.size)
        assertEquals(Bitmap.Config.ARGB_8888, drawable.bitmap.config)
    }

    @Test
    fun undefinedWidth() = runTest {
        val result = decode(
            assetName = "normal.jpg",
            size = Size(Dimension.Undefined, 100),
            scale = Scale.FIT
        )

        assertTrue(result.isSampled)
        val drawable = assertIs<BitmapDrawable>(result.drawable)
        assertEquals(Size(80, 100), drawable.bitmap.size)
        assertEquals(Bitmap.Config.ARGB_8888, drawable.bitmap.config)
    }

    @Test
    fun undefinedHeight() = runTest {
        val result = decode(
            assetName = "normal.jpg",
            size = Size(100, Dimension.Undefined),
            scale = Scale.FIT
        )

        assertTrue(result.isSampled)
        val drawable = assertIs<BitmapDrawable>(result.drawable)
        assertEquals(Size(100, 125), drawable.bitmap.size)
        assertEquals(Bitmap.Config.ARGB_8888, drawable.bitmap.config)
    }

    @Test
    fun malformedImageThrows() = runTest {
        assertFailsWith<IllegalStateException> {
            decode(
                assetName = "malformed.jpg",
                size = Size(100, 100)
            )
        }
    }

    @Test
    fun resultIsSampledIfGreaterThanHalfSize() = runTest {
        val result = decode(
            assetName = "normal.jpg",
            size = Size(600, 600)
        )

        assertTrue(result.isSampled)
        val drawable = assertIs<BitmapDrawable>(result.drawable)
        assertEquals(Size(600, 750), drawable.bitmap.size)
    }

    @Test
    fun originalSizeDimensionsAreResolvedCorrectly() = runTest {
        val size = Size.ORIGINAL
        val normal = decodeBitmap("normal.jpg", size)
        assertEquals(Size(1080, 1350), normal.size)
    }

    @Test
    fun largeExifMetadata() = runTest {
        val size = Size(500, 500)
        val expected = decodeBitmap("exif/large_metadata_normalized.jpg", size)
        val actual = decodeBitmap("exif/large_metadata.jpg", size)
        expected.assertIsSimilarTo(actual)
    }

    /** Regression test: https://github.com/coil-kt/coil/issues/619 */
    @Test
    fun heifExifMetadata() = runTest {
        // HEIF files are not supported before API 30.
        assumeTrue(SDK_INT >= 30)

        // Ensure this completes and doesn't end up in an infinite loop.
        val normal = context.decodeBitmapAsset("exif/basic.heif")
        val actual = decodeBitmap("exif/basic.heif", Size.ORIGINAL)
        normal.assertIsSimilarTo(actual)
    }

    @Test
    fun allowInexactSize_true() = runTest {
        val result = decodeBitmap(
            assetName = "normal.jpg",
            options = Options(
                context = context,
                size = Size(1500, 1500),
                scale = Scale.FIT,
                allowInexactSize = true
            )
        )
        assertEquals(Size(1080, 1350), result.size)
    }

    @Test
    fun allowInexactSize_false() = runTest {
        val result = decodeBitmap(
            assetName = "normal.jpg",
            options = Options(
                context = context,
                size = Size(1500, 1500),
                scale = Scale.FIT,
                allowInexactSize = false
            )
        )
        assertEquals(Size(1200, 1500), result.size)
    }

    @Test
    fun allowRgb565_true() = runTest {
        val result = decodeBitmap(
            assetName = "normal.jpg",
            options = Options(
                context = context,
                size = Size(500, 500),
                scale = Scale.FILL,
                allowRgb565 = true
            )
        )
        assertEquals(Size(500, 625), result.size)
        assertEquals(Bitmap.Config.RGB_565, result.config)
    }

    @Test
    fun allowRgb565_false() = runTest {
        val result = decodeBitmap(
            assetName = "normal.jpg",
            options = Options(
                context = context,
                size = Size(500, 500),
                scale = Scale.FILL,
                allowRgb565 = false
            )
        )
        assertEquals(Size(500, 625), result.size)
        assertEquals(Bitmap.Config.ARGB_8888, result.config)
    }

    @Test
    fun premultipliedAlpha_true() = runTest {
        val result = decodeBitmap(
            assetName = "normal_alpha.png",
            options = Options(
                context = context,
                size = Size(400, 200),
                scale = Scale.FILL,
                premultipliedAlpha = true
            )
        )
        assertEquals(Size(400, 200), result.size)
        assertTrue(result.isPremultiplied)
    }

    @Test
    fun premultipliedAlpha_false() = runTest {
        val result = decodeBitmap(
            assetName = "normal_alpha.png",
            options = Options(
                context = context,
                size = Size(400, 200),
                scale = Scale.FILL,
                premultipliedAlpha = false
            )
        )
        assertEquals(Size(400, 200), result.size)
        assertFalse(result.isPremultiplied)
    }

    @Test
    fun exifOrientationPolicy_ignore() = runTest {
        val factory = BitmapFactoryDecoder.Factory(
            exifOrientationPolicy = ExifOrientationPolicy.IGNORE
        )

        // Test JPG
        for (index in 1..8) {
            val assetName = "exif/$index.jpg"
            val expected = BitmapFactory.decodeStream(context.assets.open(assetName))
            val actual = decodeBitmap(assetName, Size.ORIGINAL, factory = factory)
            assertTrue(expected.isSimilarTo(actual), "Image with index $index is incorrect.")
        }

        // Test PNG
        for (index in 1..8) {
            val assetName = "exif/$index.png"
            val expected = BitmapFactory.decodeStream(context.assets.open(assetName))
            val actual = decodeBitmap(assetName, Size.ORIGINAL, factory = factory)
            assertTrue(expected.isSimilarTo(actual), "Image with index $index is incorrect.")
        }
    }

    @Test
    fun exifOrientationPolicy_respectPerformance() = runTest {
        val factory = BitmapFactoryDecoder.Factory(
            exifOrientationPolicy = ExifOrientationPolicy.RESPECT_PERFORMANCE
        )

        // Test JPG
        val normalJpg = decodeBitmap("normal.jpg", Size.ORIGINAL, factory = factory)
        for (index in 1..8) {
            val actual = decodeBitmap("exif/$index.jpg", Size.ORIGINAL, factory = factory)
            assertTrue(normalJpg.isSimilarTo(actual), "Image with index $index is incorrect.")
        }

        // Test PNG
        for (index in 1..8) {
            val assetName = "exif/$index.png"
            val expected = BitmapFactory.decodeStream(context.assets.open(assetName))
            val actual = decodeBitmap(assetName, Size.ORIGINAL, factory = factory)
            assertTrue(expected.isSimilarTo(actual), "Image with index $index is incorrect.")
        }
    }

    @Test
    fun exifOrientationPolicy_respectAll() = runTest {
        val factory = BitmapFactoryDecoder.Factory(
            exifOrientationPolicy = ExifOrientationPolicy.RESPECT_ALL
        )

        // Test JPG
        val normalJpg = decodeBitmap("normal.jpg", Size.ORIGINAL, factory = factory)
        for (index in 1..8) {
            val actual = decodeBitmap("exif/$index.jpg", Size.ORIGINAL, factory = factory)
            assertTrue(normalJpg.isSimilarTo(actual), "Image with index $index is incorrect.")
        }

        // Test PNG
        val normalPng = decodeBitmap("normal.png", Size.ORIGINAL, factory = factory)
        for (index in 1..8) {
            val actual = decodeBitmap("exif/$index.png", Size.ORIGINAL, factory = factory)
            assertTrue(normalPng.isSimilarTo(actual), "Image with index $index is incorrect.")
        }
    }

    @Test
    fun lossyWebP() = runTest {
        val expected = decodeBitmap("normal.jpg", Size(450, 675))
        decodeBitmap("lossy.webp", Size(450, 675)).assertIsSimilarTo(expected)
    }

    @Test
    fun png_16bit() = runTest {
        // The emulator runs out of memory on pre-23.
        assumeTrue(SDK_INT >= 23)

        val result = decode("16_bit.png", Size(250, 250))

        assertTrue(result.isSampled)
        val drawable = assertIs<BitmapDrawable>(result.drawable)
        assertEquals(Size(250, 250), drawable.bitmap.size)

        val expectedConfig = if (SDK_INT >= 26) Bitmap.Config.RGBA_F16 else Bitmap.Config.ARGB_8888
        assertEquals(expectedConfig, drawable.bitmap.config)
    }

    @Test
    fun largeJpeg() = runTest {
        decodeBitmap("large.jpg", Size(1080, 1920))
    }

    /** Regression test: https://github.com/coil-kt/coil/issues/368 */
    @Test
    fun largePng() = runTest {
        // Ensure that this doesn't cause an OOM exception - particularly on API 23 and below.
        decodeBitmap("large.png", Size(1080, 1920))
    }

    @Test
    fun largeWebP() = runTest {
        decodeBitmap("large.webp", Size(1080, 1920))
    }

    @Test
    fun largeHeif() = runTest {
        // HEIF files are not supported before API 30.
        assumeTrue(SDK_INT >= 30)

        decodeBitmap("large.heif", Size(1080, 1920))
    }

    private suspend fun decodeBitmap(
        assetName: String,
        size: Size,
        scale: Scale = Scale.FILL,
        factory: BitmapFactoryDecoder.Factory = decoderFactory
    ): Bitmap = assertIs<BitmapDrawable>(decode(assetName, size, scale, factory).drawable).bitmap

    private suspend fun decodeBitmap(
        assetName: String,
        options: Options,
        factory: BitmapFactoryDecoder.Factory = decoderFactory
    ): Bitmap = assertIs<BitmapDrawable>(decode(assetName, options, factory).drawable).bitmap

    private suspend fun decode(
        assetName: String,
        size: Size,
        scale: Scale = Scale.FILL,
        factory: BitmapFactoryDecoder.Factory = decoderFactory
    ): DecodeResult = decode(assetName, Options(context, size = size, scale = scale), factory)

    private suspend fun decode(
        assetName: String,
        options: Options,
        factory: BitmapFactoryDecoder.Factory
    ): DecodeResult {
        val source = context.assets.open(assetName).source().buffer()
        val decoder = factory.create(
            result = SourceResult(
                source = ImageSource(source, context),
                mimeType = null,
                dataSource = DataSource.DISK
            ),
            options = options,
            imageLoader = ImageLoader(context)
        )
        val result = checkNotNull(decoder.decode())

        // Assert that the source has been closed.
        val exception = assertFailsWith<IllegalStateException> { source.exhausted() }
        assertEquals("closed", exception.message)

        return result
    }
}