https://github.com/aranadedoros/assetflow
A functional-oriented image processing toolkit written in Scala. Designed for web development workflows.
https://github.com/aranadedoros/assetflow
image-processing scala scala2 scrimage
Last synced: 5 months ago
JSON representation
A functional-oriented image processing toolkit written in Scala. Designed for web development workflows.
- Host: GitHub
- URL: https://github.com/aranadedoros/assetflow
- Owner: AranaDeDoros
- License: gpl-3.0
- Created: 2025-10-28T06:15:18.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2026-01-06T23:00:44.000Z (6 months ago)
- Last Synced: 2026-01-13T19:43:26.035Z (5 months ago)
- Topics: image-processing, scala, scala2, scrimage
- Language: Scala
- Homepage: https://aranadedoros.github.io/AssetFLOW/
- Size: 2.06 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AssetFLOW
A lightweight, functional-oriented image processing toolkit written in **Scala**, designed for **web development** workflows.
This library handles image transformations like conversion to WebP, thumbnail generation,
color manipulation, and OCR preprocessing; using a **functional approach**.
---
## Features
- [x] **Convert images to WebP**
- [x] **Generate thumbnails** for desktop and mobile
- [x] **Create blurred placeholders** for skeletons, templating, etc.
- [x] **Perform OCR preprocessing** (binarization, tilt, contrast, etc.)
- [x] **Manipulate and blend colors** functionally
- [x] **Follow common web image type guidelines**
---
## Stack
| Component | Description |
|----------------|----------------------------------------------|
| **Scala 2.13** | Host language. |
| **Scrimage** | Image manipulation library |
| **Java AWT** | For color handling and basic graphics |
| **ColorThief** | Aids in the palette extraction functionality |
---
### helpers
````scala
Pipe()
.from("in")
.to("out")
.inspect("after load") { img =>
println(img.width, img.height)
}
.step(TransformationStep("grayscale", OCR.grayscale))
.inspect("after grayscale") { img =>
println("ok")
}
.dryRun()
Batch()
.from("in")
.to("out")
.foreach("convert") { (file, out, in) =>
ImageTransforms.convertTo(file, out, ImageTransforms.Webp)
}.dryRun()
````
### image creation
````scala
//folders setup
val inputDir = new File("input")
val outputDir = new File("output")
outputDir.mkdirs()
//listing images
val images = ImageTransforms.listImages(inputDir)
println(s" ${images.size} found ${inputDir.getPath}:")
images.foreach(f => println(s" - ${f.getName}"))
//converting to webp
val webpResults = ImageTransforms.convertTo(images, outputDir, Webp)
webpResults.foreach {
case Right(f) => println(s"WebP at: ${f.getName}")
case Left(err) => println(s"Error: $err")
}
//making thumbnails
val thumbsDesktop = ImageTransforms.createThumbnail(images, outputDir, Desktop)
val thumbsMobile = ImageTransforms.createThumbnail(images, outputDir, Mobile)
println("Thumbnails desktop:")
thumbsDesktop.foreach {
case Right(f) => println(s" - ${f.getName}")
case Left(err) => println(s" - Error: $err")
}
println("Thumbnails mobile:")
thumbsMobile.foreach {
case Right(f) => println(s" - ${f.getName}")
case Left(err) => println(s" - Error: $err")
}
//now placeholders
val placeholders = ImageTransforms.generatePlaceholders(
number = 3,
width = 200,
height = 200,
fillColor = Some(Color.RED),
applyBlur = true,
outputDir = outputDir
)
placeholders.foreach {
case Right(f) => println(s"placeholder generated: ${f.getName}")
case Left(err) => println(s"Error: $err")
}
//test OCR preprocessing
images.headOption.foreach { imgFile =>
println("testing ocr processing...")
val image = ImmutableImage.loader().fromFile(imgFile)
val processed = OCR.optimize(
image,
tilt = 5.0,
contrastFactor = 1.3,
threshold = 128,
doBinarize = true
)
val (name, ext) = Common.getNameAndExtension(imgFile.getName)
val key = Common.timestamp
val outPath = new File(outputDir, s"${name}_$key${ext.getOrElse("")}").getPath
processed.output(WebpWriter.MAX_LOSSLESS_COMPRESSION, new File(outPath))
println(s"OCR processed stored at: $outPath")
}
````
### color examples
```scala
//create a color
val redColor = RGBColor(100, 50, 200)
println(s"initial color: $redColor, hex=${redColor.toHex}")
//increase channels
val brighter = redColor.increaseAll(50, 30, -100)
println(s"adjusted color: $brighter, hex=${brighter.toHex}")
//mix 'em up
val blueColor = RGBColor(0, 0, 255)
val mixed = redColor.mixWith(blueColor, 0.5)
println(s"50% mix: $mixed, hex=${mixed.toHex}")
//from hex
val fromHex = RGBColor.fromHex("#ff00cc")
println(s"from hex '#ff00cc': $fromHex")
//random color
val randomColor = RGBColor.random()
println(s"random color: $randomColor, hex=${randomColor.toHex}")
val cmyk = CMYKColor(20, 40, 60, 10)
val rgb = RGBColor(100, 150, 200)
//increase specific channel by 10 (using currying)
val brighterMagenta = cmyk.modifyChannel(Magenta)(_ + 10)
println(brighterMagenta)
//using the shortcut increaseChannel
val brighterRed = rgb.increaseChannel(Red, 20)
println(brighterRed)
//more complex HOF: halve yellow
val lessYellow = cmyk.modifyChannel(Yellow)(_ / 2)
println(lessYellow)
```
### output
```
initial color: RGBColor(100,50,200), hex=#6432C8
adjusted color: RGBColor(150,80,100), hex=#965064
50% mix: RGBColor(50,25,227), hex=#3219E3
from hex '#ff00cc': RGBColor(255,0,204)
random color: RGBColor(75,123,240), hex=#4B7BF0
```
### web guidelines examples
```scala
WebsiteImageType.summary()
WebsiteImageType.fromName("logo_square") match {
case Some(img) => println(s"square logo found guidelines for desktop: ${img.desktop} " +
s" for mobile: ${img.mobile}, ratio=${img.ratio}")
case None => println("square logo not found")
```
### output
```
Type Desktop (WxH) Mobile (WxH) Ratio
----------------------------------------------------------------------
background 2560x1400 360x640 64:35
hero 1280x720 360x200 16:9
banner 1200x400 360x120 3:1
blog 1200x800 360x240 3:2
logo_rectangle 400x100 160x40 4:1
logo_square 100x100 60x60 1:1
favicon 16x16 16x16 1:1
social_icon 32x32 48x48 1:1
lightbox 1920x1080 360x640 16:9
thumbnail 300x300 90x90 1:1
product_thumbnail 300x300 150x150 1:1
square logo found guidelines for desktop: 100x100 for mobile: 60x60, ratio=1:1
```
---
# TODO #
- [x] Create abstractions for creating Pipelines and Batches
- [x] Add a true Asset pipeline.
- [ ] Add resume and collection of results to Pipe and Batch.
- [ ] Extend image extensions support.
---
# Docs #
[AssetFLOW](https://aranadedoros.github.io/AssetFLOW/)