gifkt/com.shakster.gifkt/GifDecoder

GifDecoder

actual class GifDecoder(data: RandomAccessData, cacheFrameInterval: Int) : AutoCloseable(source)

A class for decoding GIF files. Other than cached frames, configured with cacheFrameInterval, all frames are decoded only when requested, minimizing memory usage.

Usage:

// Obtain a Path to read the GIF data from
val path: Path = ...
val data = path.asRandomAccess()
val decoder = GifDecoder(data)

// Read a single frame by index
val frame1 = decoder[0]

// Read a single frame by timestamp
val frame2 = decoder[2.seconds]

// Read all frames
decoder.asSequence().forEach { frame ->
    // Process each frame
}

decoder.close()

Parameters

data

The RandomAccessData to read the GIF data from.

cacheFrameInterval

The interval at which frames are cached. Setting this to a higher value can improve random access speed with get, but increases memory usage.

Set to 1 to cache every frame, making random access speed similar to that of Array. Warning: this can cause the decoder to use a large amount of memory.

Set to 0 to disable caching, which will decrease the initial load time and minimize memory usage. Disable caching if you only need to read frames sequentially using asSequence or get in increasing order of their index or timestamp.

Throws

InvalidGifException

If the GIF data is invalid and cannot be decoded.

IOException

If an I/O error occurs.

expect class GifDecoder(data: RandomAccessData, cacheFrameInterval: Int = DEFAULT_GIF_CACHE_FRAME_INTERVAL) : AutoCloseable(source)

A class for decoding GIF files. Other than cached frames, configured with cacheFrameInterval, all frames are decoded only when requested, minimizing memory usage.

Usage:

// Obtain a Path to read the GIF data from
val path: Path = ...
val data = path.asRandomAccess()
val decoder = GifDecoder(data)

// Read a single frame by index
val frame1 = decoder[0]

// Read a single frame by timestamp
val frame2 = decoder[2.seconds]

// Read all frames
decoder.asSequence().forEach { frame ->
    // Process each frame
}

decoder.close()

Parameters

data

The RandomAccessData to read the GIF data from.

cacheFrameInterval

The interval at which frames are cached. Setting this to a higher value can improve random access speed with get, but increases memory usage.

Set to 1 to cache every frame, making random access speed similar to that of Array. Warning: this can cause the decoder to use a large amount of memory.

Throws

InvalidGifException

If the GIF data is invalid and cannot be decoded.

IOException

If an I/O error occurs.

actual class GifDecoder(data: RandomAccessData, cacheFrameInterval: Int) : AutoCloseable(source)

A class for decoding GIF files. Other than cached frames, configured with cacheFrameInterval, all frames are decoded only when requested, minimizing memory usage.

Usage:

// Obtain a Path to read the GIF data from
val path: Path = ...
val data = path.asRandomAccess()
val decoder = GifDecoder(data)

// Read a single frame by index
val frame1 = decoder[0]

// Read a single frame by timestamp
val frame2 = decoder[2.seconds]

// Read all frames
decoder.asSequence().forEach { frame ->
    // Process each frame
}

decoder.close()

Parameters

data

The RandomAccessData to read the GIF data from.

cacheFrameInterval

The interval at which frames are cached. Setting this to a higher value can improve random access speed with get, but increases memory usage.

Set to 1 to cache every frame, making random access speed similar to that of Array. Warning: this can cause the decoder to use a large amount of memory.