#format #image #metadata

imageformat

Quick probing of image format without loading the entire file

9 releases

new 0.2.1 Dec 9, 2024
0.2.0 Dec 6, 2024
0.1.6 Dec 6, 2024

#369 in Images

Download history 789/week @ 2024-12-06

789 downloads per month

MIT/Apache

14KB
271 lines

imageformat

Quickly probe the format of various image formats without reading the entire file.

The goal of this crate is to be able to detect format of a supported image without loading unnecessary data, and without pulling in more dependencies. Most reads only require 16 bytes or less.

Usage

use image_format_detector::prelude::*;

fn main() {
    // Example: Read the first few bytes of a file
    let file = std::fs::File::open("/Somepath/example.webp")?;
    let mut cursor = std::io::Cursor::new(file);
    let format = detect_image_format(&mut cursor);

    // Or: pass in the file path
    let format = detect_image_format_path("/Somepath/example.png").unwrap();

    match format {
        ImageFormat::Jpeg => println!("It's a JPEG image."),
        ImageFormat::JpegXl => println!("It's a JPEG XL image."),
        ImageFormat::Png => println!("It's a PNG image."),
        ImageFormat::Webp => println!("It's a WEBP image."),
        ...
    }
}

Supported Image Formats

  • Aseprite
  • Avif
  • BMP
  • DDS
  • EXR
  • Farbfeld
  • GIF
  • HDR
  • HEIC / HEIF
  • ICO*
  • ILBM (IFF)
  • JPEG
  • JPEG XL
  • KTX2
  • PNG
  • PNM (PBM, PGM, PPM)
  • PSD / PSB
  • QOI
  • TGA
  • TIFF
  • VTF
  • WEBP

If you have a format you think should be added, feel free to create an issue.

Dependencies

~275–740KB
~17K SLoC