pihash 0.5.0

A simple library for generating perceptual hashes for images and comparing images based on their perceptual hashes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

// Copyright 2016 Drew Short <drew@sothr.com>.
//
// Licensed under the MIT license<LICENSE-MIT or http://opensource.org/licenses/MIT>.
// This file may not be copied, modified, or distributed except according to those terms.

extern crate image;

use std::path::Path;

use cache::Cache;

use super::prepare_image;
use super::{HashType, PerceptualHash, Precision, PreparedImage};

use self::image::{GenericImage, GenericImageView};

pub struct AHash<'a> {
    prepared_image: Box<PreparedImage<'a>>,
}

impl<'a> AHash<'a> {
    pub fn new(path: &'a Path, precision: &Precision, cache: &Option<Cache>) -> Self {
        AHash {
            prepared_image: Box::new(prepare_image(&path, &HashType::AHash, &precision, cache)),
        }
    }
}

impl<'a> PerceptualHash for AHash<'a> {
    /**
     * Calculate the ahash of the provided prepared image.
     *
     * # Returns
     *
     * A u64 representing the value of the hash
     */
    fn get_hash(&self, _: &Option<Cache>) -> u64 {
        match self.prepared_image.image {
            Some(ref image) => {
                let (width, height) = image.dimensions();

                // calculating the average pixel value
                let mut total = 0u64;
                for (_, _, pixel) in image.pixels() {
                    total += pixel.0[0] as u64;
                }
                let mean = total / (height * width) as u64;
                // println!("Mean for {} is {}", prepared_image.orig_path, mean);

                // Calculating a hash based on the mean
                let mut hash = 0u64;
                for (_, _, pixel) in image.pixels() {
                    if pixel.0[0] as u64 >= mean {
                        hash |= 1;
                    // println!("Pixel {} is >= {} therefore {:b}", pixel_sum, mean, hash);
                    } else {
                        hash |= 0;
                        // println!("Pixel {} is < {} therefore {:b}", pixel_sum, mean, hash);
                    }
                    hash <<= 1;
                }
                // println!("Hash for {} is {}", prepared_image.orig_path, hash);
                hash
            }
            None => 0u64,
        }
    }
}