#image #hash #perceptual #difference

bin+lib img_hash

A simple library that provides perceptual hashing and difference calculation for images

8 stable releases (3 major)

Uses old Rust 2015

3.1.1 Mar 13, 2021
3.1.0 Feb 19, 2020
3.0.0 Oct 28, 2019
2.1.0 Jul 21, 2018
0.0.2 Nov 28, 2014

#13 in Profiling

Download history 855/week @ 2020-12-24 563/week @ 2020-12-31 738/week @ 2021-01-07 973/week @ 2021-01-14 623/week @ 2021-01-21 354/week @ 2021-01-28 342/week @ 2021-02-04 297/week @ 2021-02-11 640/week @ 2021-02-18 276/week @ 2021-02-25 297/week @ 2021-03-04 611/week @ 2021-03-11 263/week @ 2021-03-18 510/week @ 2021-03-25 171/week @ 2021-04-01 325/week @ 2021-04-08

2,330 downloads per month
Used in 7 crates (4 directly)

MIT/Apache

54KB
682 lines

img_hash Build Status Crates.io shield

Now builds on stable Rust! (But needs nightly to bench.)

A library for getting perceptual hash values of images.

Thanks to Dr. Neal Krawetz for the outlines of the Mean (aHash), Gradient (dHash), and DCT (pHash) perceptual hash algorithms:
http://www.hackerfactor.com/blog/?/archives/432-Looks-Like-It.html (Accessed August 2014)

Also provides an implementation of the Blockhash.io algorithm.

This crate can operate directly on buffers from the PistonDevelopers/image crate.

Usage

Documentation

Add img_hash to your Cargo.toml:

[dependencies.img_hash]
version = "3.0"

Example program:

 extern crate image;
 extern crate img_hash;
 
 use img_hash::{HasherConfig, HashAlg};

 fn main() {
     let image1 = image::open("image1.png").unwrap();
     let image2 = image::open("image2.png").unwrap();
     
     let hasher = HasherConfig::new().to_hasher();

     let hash1 = hasher.hash_image(&image1);
     let hash2 = hasher.hash_image(&image2);
     
     println!("Image1 hash: {}", hash1.to_base64());
     println!("Image2 hash: {}", hash2.to_base64());
     
     println!("Hamming Distance: {}", hash1.dist(&hash2));
 }

Benchmarking

In order to build and test on Rust stable, the benchmarks have to be placed behind a feature gate. If you have Rust nightly installed and want to run benchmarks, use the following command:

cargo bench --features bench

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~4.5MB
~92K SLoC