Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.07 KB

README.md

File metadata and controls

100 lines (69 loc) · 3.07 KB
Raw

⚡ Thumbp: A Lightweight & Fast WebP Thumbnail Image Generator

Hex.pm Hexdocs.pm Hex.pm License

Thumbp is a highly efficient thumbnail creation library for Elixir, designed to output with the WebP image format for optimal speed and performance.

No need for ImageMagick, FFmpeg, libvips, or any other external libraries.

Usage

Read an image file and create a thumbnail:

iex> content = File.read!("./test/assets/images/sample.jpg")
iex> Thumbp.create(content, 320, 240)
{:ok, <<82, 73, 70, 70, 195, 152, 14, 0, 0, 87, 69, ...>>}

The width and height parameters represent the potential maximum sizes, so they do not precisely define the actual dimensions of the image. This implies that the aspect ratio of the image will remain unchanged.

Adjust the quality with an optional parameter ranging from 0 to 100 (default is 75):

iex> Thumbp.create(content, 160, 120, quality: 50)

You can also define a target size, although which may increase the processing time by approximately 20-80%.

iex> Thumbp.create(content, 160, 120, target_size: 4_096)    # set to 4KB

Note: The quality and target_size options are exclusive.

Installation

The package can be installed by adding thumbp to your list of dependencies in mix.exs:

def deps do
  [
    {:thumbp, "~> 0.1.0"}
  ]
end

Then, run mix deps.get.

Benchmark

  • Input: 1280x960 JPEG (85% quality), 171.5KB
  • Output: 320x240 WebP (50% quality), ~2.4KB
mix run benchmark/benchmark.exs
Name                      ips        average  deviation         median         99th %
thumbp                  86.98       11.50 ms     ±7.53%       11.25 ms       15.64 ms
image (libvips)         73.95       13.52 ms    ±13.13%       12.99 ms       21.96 ms

Comparison:
thumbp                  86.98
image (libvips)         73.95 - 1.18x slower +2.03 ms

Development

Prerequisites

Note: This library requires the Rust Toolchain for compilation.

Follow the instructions at www.rust-lang.org/tools/install to install Rust.

Verify the installation by checking the cargo command version:

cargo --version
# Should output something like: cargo 1.82.0 (8f40fc59f 2024-08-21)

Then, set the RUSTLER_PRECOMPILATION_EXAMPLE_BUILD environment variable to ensure that local sources are compiled instead of downloading a precompiled library file.

RUSTLER_PRECOMPILATION_EXAMPLE_BUILD=1 mix compile

License

The MIT License