gif.kt
0.3.3indexedEnables efficient decoding and encoding of static and animated GIFs, with features like parallel encoding, automatic compression, and support for various GIF options such as looping.
32
Stars
—
Used by
dependents
—
Health
/ 100
gif.kt
A Kotlin Multiplatform GIF decoding and encoding library.
Features
- Supports static and animated GIFs.
- Easy to use API.
- Memory-efficient decoding.
- Fast parallel encoding.
- Automatic lossless compression when encoding, as well as optional lossy compression.
- Automatic handling of GIF minimum frame duration when encoding.
- Supports several GIF options, such as looping and comments.
Installation
Requires JDK 8 or higher when targeting the JVM.
Gradle
repositories {
mavenCentral()
google()
}
dependencies {
implementation("com.shakster:gifkt:0.3.3")
}
Maven
Usage
API documentation is available here.
Decoding
Kotlin
// 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()
Java
// Obtain a Path to read the GIF data from
...;
RandomAccessData.of(path);
(data);
decoder.get();
decoder.get(Duration.ofSeconds());
(ImageFrame frame : decoder.asList()) {
}
decoder.close();
Encoding
Kotlin
// Obtain a Path to write the GIF data to
val path: Path = ...
val sink = SystemFileSystem.sink(path).buffered()
val encoder = GifEncoder(sink)
val argb: IntArray = ...
val width: Int = ...
val height: Int = ...
val duration: Duration = ...
encoder.writeFrame(argb, width, height, duration)
encoder.close()
Java
// Obtain a Path to write the GIF data to
Path path = ...;
OutputStream outputStream Files.newOutputStream(path);
GifEncoder.builder(outputStream);
builder.build();
[] argb = ...;
...;
...;
...;
encoder.writeFrame(argb, width, height, duration);
encoder.close();
Parallel Encoding
Not supported on JavaScript or Wasm.
Kotlin
// Obtain a Path to write the GIF data to
path: Path = ...
sink = SystemFileSystem.sink(path).buffered()
cpuCount: = ...
encoder = ParallelGifEncoder(
sink,
maxConcurrency = cpuCount,
ioContext = Dispatchers.IO,
)
argb1: IntArray = ...
width1: = ...
height1: = ...
duration1: Duration = ...
argb2: IntArray = ...
width2: = ...
height2: = ...
duration2: Duration = ...
encoder.writeFrame(argb1, width1, height1, duration1)
encoder.writeFrame(argb2, width2, height2, duration2)
encoder.close()
Java
Modules
Core
The core module contains the main library code.
Compose
The compose module contains Compose Multiplatform integration.
Requires JDK 11 or higher when targeting the JVM.
Gradle
dependencies {
implementation("com.shakster:gifkt-compose:0.3.3")
}
CLI
The cli module contains a command-line interface GIF encoder tool that uses the library to create GIFs from images, videos, and other GIFs.
Requires JDK 21 or higher to run.
Developing
JDK 21 or higher is required to build the project.
Run ./gradlew build to build the project.
Run ./gradlew cleanAllTests allTests to run all tests.
Run ./gradlew dokkaGenerate to generate API documentation. The output will be in core/build/dokka/html.
Snapshot Releases
A snapshot release is published with every push to the main branch.
To use a snapshot release, add the Maven snapshot repository and append -SNAPSHOT to the version.
Gradle
repositories {
mavenCentral()
google()
maven("https://central.sonatype.com/repository/maven-snapshots")
}
dependencies {
implementation("com.shakster:gifkt:0.3.3-SNAPSHOT")
}