blenderskool / pigmnts Goto Github PK

View Code? Open in Web Editor NEW

66.0 3.0 3.0 336 KB

🎨 Color palette generator from an image using WebAssesmbly and Rust

Home Page: https://pigmnts.web.app

License: MIT License

Rust 100.00%

color-palette pigments rust kmeans web-assembly wasm color-quantization

pigmnts's Introduction

🎨 Pigmnts

Pigmnts is a color palette creator from an image built using Rust. It uses the K-means++ clustering algorithm to select the most commonly occurring colors from the image.

Pigmnts library is compiled to WebAssembly which allows for super-fast color palette extraction from an image on the web. The library can be found in the lib directory.

Pigmnts CLI

Pigmnts CLI is a tool designed to create color palettes from an image right on your terminal. It supports various image formats like JPEG, PNG, GIF, WebP, TIFF along with external HTTP(S) image URLs. It provides a beautiful terminal output to preview the colors in the palette.

Pigmnts CLI comes with various output modes and provides on-demand data of the palette generated while maintaining high speeds.

Installing the CLI

CLI can be installed using cargo and pigmnts-cli crate on crates.io

cargo install pigmnts-cli

Output modes

Default mode

The default mode displays the palette in a user-friendly way with a small preview and corresponding color codes in a tabular structure. This is meant for the common use of the CLI.

Quiet (or Silent) mode

This mode displays only the essential output without the intermediate logs. The output is in plain text format with each data item separated by :. This is meant for use in a pipeline where the output of the CLI is used as input for another process. It can be activated by the -q or --quiet flag.

Flags and options in the CLI

The following flags and options are supported by the latest release of the CLI.

FLAGS:
    -d, --dominance    Enable dominance percentage of colors
    -h, --help         Prints help information
    -x, --hex          Enable Hex code output of colors
    -s, --hsl          Enable HSL output of colors
    -l, --lab          Enable L*AB output of colors
    -q, --quiet        Suppress the normal output [aliases: silent]
    -r, --rgb          Enable RGB output of colors
    -n, --name         Nearest name for the color
    -V, --version      Prints version information

OPTIONS:
    -c, --count <COUNT>...    Number of colors in the palette

Examples of these flags

pigmnts pic-1.jpg -c 5 pic-2.jpg -c 8
Generate a palette of 5 colors from pic-1.jpg and 8 colors from pic-2.jpg.
pigmnts pic-1.jpg -rxdl
Generate a palette of 5 colors from pic-1.jpg and show the RGB code, hex code, dominance, LAB code for each color in the palette.
pigmnts pic-1.jpg --count 10 --name --hex
Generate a palette of 10 colors from pic-1.jpg and show the name, hex code for each color in the palette.
pigmnts pic-1.jpg pic-2.jpg -sxq
Generate a palette of 5 colors from pic-1.jpg and pic-2.jpg. For each color in the palette show the HSL code, hex code in quiet mode.

Contributing

This repository is a Cargo workspace that includes the development of both core Pigmnts library and the CLI.

Project Structure

Pigmnts Library - development of the core library is in the lib directory.
Pigmnts CLI - root project is Pigmnts CLI that uses the Pigmnts library.

License

Pigmnts is MIT Licensed
The dataset for color names used in Pigmnts CLI is taken from https://github.com/meodai/color-names

pigmnts's People

Contributors

Stargazers

Watchers

Forkers

khairulaffandy srujandeshpande vemilyus

pigmnts's Issues

Handle errors when unsupported file is chosen

Appropriate error handling when a file with an unsupported file format is encountered. This is mainly due to the limitations in the file formats supported by image-rs

Add multiple files support in CLI

CLI should support multiple files in a single command.

Add examples in README

Examples on how to use the package in WASM can be added to the README

CLI on Windows

CLI does not work on Windows since termion doesn't support Windows.

Improve README for contributors

README does not have info on how to go about contributing and setting up this project locally.

Publish pigmnts-cli on crates.io

Currently only the lib crate is available on crates.io can you please publish the cli to ?

Median cut algorithm

Experiment with the Median cut algorithm to extract the color palette.

Reference: https://spin.atomicobject.com/2016/12/07/pixels-and-palettes-extracting-color-palettes-from-images/

Output as HTML

CLI could output the palette as a HTML file. This would make it easy to preview the colors in the palette on terminals that don't support true colors.

Use conditional compilation

Conditional compilation using cfg can be used to separate the code specifically written for WebAssembly.

Pigmnts causes problems with Glowforge

When running the Pigmnts add-on, interactions on app.glowforge.com are negatively affected. Mouseover events on certain interface elements (such as the zoom in/out buttons) cause the entire screen to go white.

This may be a highly-specific problem, but it could also be an indication that the Pigmnts add-on causes issues on other sites.

Some of the errors from the console:

Saga Stack: undefined fs.js:3:18231

Add support for HTTP image URLs

CLI could allow usage of HTTP and HTTPS image URLs where the image is fetched in the memory and then the palette is created from it

Add validation so that only allow images

Currently one can upload any file type, I think it should be restricted to only images
If I upload a pdf (any other type) the loader didn't stop.

I would like to fix this.

Try L*ab color space

L*ab color space resembles humans' perception of colors. It may give better results compared to RGBA.

Implement a CLI

pigmnts library can be used to build a CLI tool that can extract a color palette from an image.

Add color names

Colors in the palette could provide the nearest name from a color dictionary. https://github.com/meodai/color-names seems like a great starting point

Segmentation Fault

Hey!

I'm getting a segmentation fault on a M1 Macbook Pro running Sonoma 14.0.

pigmnts test.png -xrd
Creating a palette of 5 colors from test.png
⠸
[1]    16785 segmentation fault  pigmnts test.png -xrd

Any logs I can check to see how to fix this?

Update README

Update the README with the updated return of pigments_pixels function

Isomorphic npm package

The library published on npm works only on the client-side. Support for the pigmnts library on server-side using Node.js can be implemented considering following points:

pigments_node() function can be implemented that is compatible with Node.js and does not depend on Browser APIs like canvas.
The existing pigments() function may depend on pigmnts_node() function making it easier to interact with the library on the client-side by abstracting canvas APIs.
Appropriate build system to create a single isomorphic package. wasm-pack supports multiple outputs targets, but combining them under a single package is a little messy. Hoping for this to be merged rustwasm/wasm-pack#705

Add flags for other color formats

The color palette in other color formats (currently RGB, HSL, L*AB) can be displayed on-demand by enabling appropriate flags.

Sort based on dominance

The generated colors could be sorted based on its dominance in the image. Or even better, return the colors along with their dominance as a percentage.

Update README to include CLI

README should include information related to the CLI

Add functionality for weighted means

Allow option to introduce weights during the calculation of new mean color during kmeans++

Use threads for data parallelism

K-means (and K-means++) involve a lot of synchronous tasks which makes it difficult to achieve task parallelism. However, data parallelism may be achieved to improve the performance of certain areas in the process. MapReduce technique can be applied as a starting point in the Assignment step of the algorithm.

For the time being, this could be implemented using native std::thread and WebAssembly support can be thought of a little later once any improvements using threads are observed.