commonMain.com.github.panpf.sketch.decode.GifDecoder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sketch-animated-gif-desktop Show documentation

Sketch is an image loading library specially designed for Compose Multiplatform and Android View

There is a newer version: 4.0.0

Show newest version

/*
 * Copyright (C) 2024 panpf 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.panpf.sketch.decode

import com.github.panpf.sketch.ComponentRegistry
import com.github.panpf.sketch.fetch.FetchResult
import com.github.panpf.sketch.request.RequestContext

/**
 * Adds gif animated image support
 *
 * @see com.github.panpf.sketch.animated.gif.common.test.decode.GifDecoderTest.testSupportGif
 */
fun ComponentRegistry.Builder.supportGif(): ComponentRegistry.Builder = apply {
    addDecoder(GifDecoder.Factory())
}

/**
 * Decode gif animated image files
 *
 * @see com.github.panpf.sketch.animated.gif.common.test.decode.GifDecoderTest
 */
class GifDecoder(val decoder: Decoder) : Decoder by decoder {

    class Factory : Decoder.Factory {

        private val decoderFactory = defaultGifDecoderFactory()

        override val key: String = "GifDecoder(${decoderFactory.key})"

        override fun create(
            requestContext: RequestContext,
            fetchResult: FetchResult
        ): Decoder? {
            val decoder = decoderFactory.create(requestContext, fetchResult) ?: return null
            return GifDecoder(decoder)
        }

        override fun equals(other: Any?): Boolean {
            if (this === other) return true
            return other != null && this::class == other::class
        }

        override fun hashCode(): Int {
            return this::class.hashCode()
        }

        override fun toString(): String = "GifDecoder(decoderFactory=$decoderFactory)"
    }
}

/**
 * Get the default GIF decoder factory
 *
 * @see com.github.panpf.sketch.animated.gif.android.test.decode.GifDecoderAndroidTest.testDefaultGifDecoderFactory
 * @see com.github.panpf.sketch.animated.gif.nonandroid.test.decode.GifDecoderNonAndroidTest.testDefaultGifDecoderFactory
 */
expect fun defaultGifDecoderFactory(): Decoder.Factory