2025-05-13 10:13:05 +02:00

6.3 KiB

Raw Blame History

obj	repo
application	https://github.com/t28hub/auto-palette

auto-palette

🎨 auto-palette is a library that automatically extracts prominent color palettes from images, available as Rust library, WebAssembly and CLI tool.

Overview

auto-palette is a Rust project that offers color palette extraction from images. It consists of the following components:

auto-palette: Core library for programmatic usage.
auto-palette-cli: Command-line interface for easy usage.
auto-palette-wasm: WebAssembly version for browser usage.

Perfect for developers, designers and anyone needing efficient color palette extraction.

Features

Automatically extracts prominent color palettes from images.
Provides detailed color swatch information (color, position, population)
Supports multiple extraction algorithms: DBSCAN, DBSCAN++, and KMeans++.
Supports numerous color spaces: RGB, HSL, LAB, LCHuv, ANSI256 and more.
Theme-based swatch selection: Colorful, Vivid, Muted, Light, and Dark.
Available as a Rust library, Wasm, and a CLI tool.

Installation

Rust Library

To use auto-palette in your Rust project, add it to your Cargo.toml.

[dependencies]
auto-palette = "0.8.0"

CLI Tool

To use command-line interface, install the auto-palette-cli crate.

cargo install auto-palette-cli

Usage

Rust Example

Here is an example of extracting the color palette from an image using the Rust library.

use auto_palette::{ImageData, Palette};

fn main() {
  // Load the image data from the file
  let image_data = ImageData::load("tests/assets/holly-booth-hLZWGXy5akM-unsplash.jpg").unwrap();

  // Extract the color palette from the image data
  let palette: Palette<f64> = Palette::extract(&image_data).unwrap();
  println!("Extracted {} swatches", palette.len());

  // Find the 5 dominant colors in the palette and print their information
  let swatches = palette.find_swatches(5).unwrap();
  for swatch in swatches {
    println!("Color: {}", swatch.color().to_hex_string());
    println!("Position: {:?}", swatch.position());
    println!("Population: {}", swatch.population());
    println!("Ratio: {}", swatch.ratio());
  }
}

CLI Example

Here is an example of extracting the color palette from an image using the CLI tool.

# Usage: auto-palette [OPTIONS] [PATH]
$ auto-palette path/to/your_image.jpg -n 6 -c rgb -o table
+---+--------------------+------------+------------+
| # | Color              | Position   | Population |
+---+--------------------+------------+------------+
| 1 | RGB(221, 226, 222) | (104, 96)  |       6778 |
| 2 | RGB(3, 144, 149)   | (114, 201) |       5476 |
| 3 | RGB(23, 37, 36)    | (120, 300) |       4300 |
| 4 | RGB(36, 88, 131)   | (183, 145) |       1348 |
| 5 | RGB(254, 29, 44)   | (183, 190) |        779 |
| 6 | RGB(253, 213, 116) | (25, 158)  |        567 |
+---+--------------------+------------+------------+

Options

Option	Description
`-a, --algorithm <name>`	Algorithm for extracting the color palette. Default: `dbscan` Possible values: - `dbscan`: High accuracy but slower speed. Ideal for precision over performance. - `dbscan++`: A balanced algorithm with faster speed and good accuracy. - `kmeans`: Fast speed but potentially less accurate. Ideal for performance over precision.
`-t, --theme <name>`	Theme for selecting the swatches. Possible values: - `colorful`: Prioritize colorful colors. - `vivid`: Prioritize saturated colors. - `muted`: Prioritize desaturated colors. - `light`: Prioritize light colors. - `dark`: Prioritize dark colors.
`-n, --count <number>`	Number of colors to extract. Default: `5`
`-c, --color <name>`	Output color format. Default: `hex` Possible values: - `hex`, `rgb`, `cmyk`, `hsl`, `hsv`, `lab`, `luv`, `lchab`, `lchuv`, `oklab`, `oklch`, `xyz`
`-o, --output <name>`	Output format. Default: `text` Possible values: - `json`, `text`, `table`
`--no-resize`	Disable image resizing before extracting the color palette. May improve accuracy by preserving original image resolution.
`--clipboard`	Get image from system clipboard.

6.3 KiB Raw Blame History