
Ready-to-ship library template automating releases: converts README into homepage, deploys live wasm demo, publishes API docs, builds downloadable sample executables, and wires complete CI/CD.
Live Web Demo • API Reference • Download Sample Apps
A Kotlin Multiplatform image compression library for Android, iOS, Desktop (JVM), and Web (Wasm). It provides an in-process compression API with aspect-ratio-aware downscaling, target quality, and target file size constraints.
https://github.com/user-attachments/assets/fd74f21d-4aaf-44e6-b54c-4a7d4480eff9
0 to 100) or by target file size limit in kilobytes.Different platforms use different native encoders. The table below lists the underlying engine, output format, and transparency handling for each supported target:
| Platform | Output Format | Alpha Transparency | Engine |
|---|---|---|---|
| Android | image/webp |
Preserved | android.graphics.Bitmap |
| iOS |
image/heic, image/png, or image/jpeg
|
Preserved (via HEIC/PNG) | Apple ImageIO + CoreGraphics
|
| Desktop (JVM) | image/webp |
Preserved | JetBrains Skia (org.jetbrains.skia) |
| Web (Wasm) | image/webp |
Preserved | Browser Canvas API |
Apple's system ImageIO framework does not include an encoder for WebP. To prevent transparency loss, iOS selects formats dynamically:
image/heic) with lossy compression on iOS 11+. If HEIC is unavailable, it falls back to lossless PNG (image/png).image/jpeg) with lossy compression.Add the dependency to your project:
gradle/libs.versions.toml:[versions]
cmp-imgcompress = "0.0.4"
[libraries]
cmp-imgcompress = { module = "io.github.aryapreetam:cmp-imgcompress", version.ref = "cmp-imgcompress" }build.gradle.kts:kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.cmp.imgcompress)
}
}
}kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.aryapreetam:cmp-imgcompress:0.0.4")
}
}
}import io.github.aryapreetam.cmpimgcompress.CompressedImage
import io.github.aryapreetam.cmpimgcompress.CompressionConfig
import io.github.aryapreetam.cmpimgcompress.ImageData
import io.github.aryapreetam.cmpimgcompress.ImageCompressor
suspend fun compressSample(inputBytes: ByteArray) {
val input = ImageData(rawBytes = inputBytes, mimeType = "image/png")
val result: CompressedImage = ImageCompressor.compress(
input = input,
config = CompressionConfig.ByQuality(qualityPercent = 80f)
)
println("Original: ${result.originalSize} B, Compressed: ${result.compressedSize} B (${result.mimeType})")
val compressedBytes: ByteArray = result.bytes
}import io.github.aryapreetam.cmpimgcompress.CompressionConfig
import io.github.aryapreetam.cmpimgcompress.ImageData
import io.github.aryapreetam.cmpimgcompress.ImageCompressor
import io.github.aryapreetam.cmpimgcompress.ResizeOptions
suspend fun compressUnderBudget(inputBytes: ByteArray) {
val input = ImageData(rawBytes = inputBytes, mimeType = "image/jpeg")
// Attempts to produce an output within 100 KB
val result = ImageCompressor.compress(
input = input,
config = CompressionConfig.ByTargetSize(targetSizeKb = 100),
resize = ResizeOptions(maxLongEdgePx = 1920)
)
println("Size: ${result.compressedSize} B in ${result.metadata?.elapsedMillis} ms across ${result.metadata?.iterations} iterations")
}Download pre-built sample application binaries directly to verify library behavior on your platform without building from source:
For instructions on installing pre-built binaries or compiling the sample app from source, see the How to Run the Sample App guide.
MIT License. See LICENSE for details.
Live Web Demo • API Reference • Download Sample Apps
A Kotlin Multiplatform image compression library for Android, iOS, Desktop (JVM), and Web (Wasm). It provides an in-process compression API with aspect-ratio-aware downscaling, target quality, and target file size constraints.
https://github.com/user-attachments/assets/fd74f21d-4aaf-44e6-b54c-4a7d4480eff9
0 to 100) or by target file size limit in kilobytes.Different platforms use different native encoders. The table below lists the underlying engine, output format, and transparency handling for each supported target:
| Platform | Output Format | Alpha Transparency | Engine |
|---|---|---|---|
| Android | image/webp |
Preserved | android.graphics.Bitmap |
| iOS |
image/heic, image/png, or image/jpeg
|
Preserved (via HEIC/PNG) | Apple ImageIO + CoreGraphics
|
| Desktop (JVM) | image/webp |
Preserved | JetBrains Skia (org.jetbrains.skia) |
| Web (Wasm) | image/webp |
Preserved | Browser Canvas API |
Apple's system ImageIO framework does not include an encoder for WebP. To prevent transparency loss, iOS selects formats dynamically:
image/heic) with lossy compression on iOS 11+. If HEIC is unavailable, it falls back to lossless PNG (image/png).image/jpeg) with lossy compression.Add the dependency to your project:
gradle/libs.versions.toml:[versions]
cmp-imgcompress = "0.0.4"
[libraries]
cmp-imgcompress = { module = "io.github.aryapreetam:cmp-imgcompress", version.ref = "cmp-imgcompress" }build.gradle.kts:kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.cmp.imgcompress)
}
}
}kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.aryapreetam:cmp-imgcompress:0.0.4")
}
}
}import io.github.aryapreetam.cmpimgcompress.CompressedImage
import io.github.aryapreetam.cmpimgcompress.CompressionConfig
import io.github.aryapreetam.cmpimgcompress.ImageData
import io.github.aryapreetam.cmpimgcompress.ImageCompressor
suspend fun compressSample(inputBytes: ByteArray) {
val input = ImageData(rawBytes = inputBytes, mimeType = "image/png")
val result: CompressedImage = ImageCompressor.compress(
input = input,
config = CompressionConfig.ByQuality(qualityPercent = 80f)
)
println("Original: ${result.originalSize} B, Compressed: ${result.compressedSize} B (${result.mimeType})")
val compressedBytes: ByteArray = result.bytes
}import io.github.aryapreetam.cmpimgcompress.CompressionConfig
import io.github.aryapreetam.cmpimgcompress.ImageData
import io.github.aryapreetam.cmpimgcompress.ImageCompressor
import io.github.aryapreetam.cmpimgcompress.ResizeOptions
suspend fun compressUnderBudget(inputBytes: ByteArray) {
val input = ImageData(rawBytes = inputBytes, mimeType = "image/jpeg")
// Attempts to produce an output within 100 KB
val result = ImageCompressor.compress(
input = input,
config = CompressionConfig.ByTargetSize(targetSizeKb = 100),
resize = ResizeOptions(maxLongEdgePx = 1920)
)
println("Size: ${result.compressedSize} B in ${result.metadata?.elapsedMillis} ms across ${result.metadata?.iterations} iterations")
}Download pre-built sample application binaries directly to verify library behavior on your platform without building from source:
For instructions on installing pre-built binaries or compiling the sample app from source, see the How to Run the Sample App guide.
MIT License. See LICENSE for details.