loda-rust/rust_project/loda-rust-cli/src/arc/image.rs

use super::index_for_pixel::index_for_pixel;
use super::ImageSize;
use std::fmt;

/// Tiny 2D grid with 8 bits per pixel.
/// 
/// The max size is 255x255 pixels.
/// 
/// The smallest image size is 0x0 pixels.
#[derive(Clone, Hash, Eq, Ord, PartialEq, PartialOrd)]
pub struct Image {
    width: u8,
    height: u8,
    pixels: Vec<u8>,
}

impl Image {
    pub fn empty() -> Self {
        Self { width: 0, height: 0, pixels: vec!() }
    }

    /// Create an `Image` instance, filled with `color`
    pub fn color(width: u8, height: u8, color: u8) -> Self {
        let len: usize = (width as usize) * (height as usize);
        if len == 0 {
            return Self::empty();
        }
        let pixels: Vec<u8> = vec![color; len];
        Self { width, height, pixels }
    }

    /// Create an `Image` instance, filled with zeroes
    pub fn zero(width: u8, height: u8) -> Self {
        Self::color(width, height, 0)
    }

    /// Create an `Image` instance filled with a specific color.
    /// 
    /// Returns an `Image` with the same size as the current image.
    #[allow(dead_code)]
    pub fn clone_color(&self, color: u8) -> Self {
        Self::color(self.width, self.height, color)
    }

    /// Create an `Image` instance filled with zeroes.
    /// 
    /// Returns an `Image` with the same size as the current image.
    #[allow(dead_code)]
    pub fn clone_zero(&self) -> Self {
        self.clone_color(0)
    }

    /// Create an `Image` instance filled with ones.
    /// 
    /// Returns an `Image` with the same size as the current image.
    #[allow(dead_code)]
    pub fn clone_one(&self) -> Self {
        self.clone_color(1)
    }

    /// Create a `Image` instance without any checks of the data
    /// 
    /// It's up to the caller to ensure:
    /// - Make sure that the pixels.len() is the same as width x height.
    /// - Make sure that when width=0, that height is not greater than 0.
    /// - Make sure that when height=0, that width is not greater than 0.
    pub fn create_raw(width: u8, height: u8, pixels: Vec<u8>) -> Self {
        Self { width, height, pixels }
    }

    pub fn is_empty(&self) -> bool {
        self.width == 0 || self.height == 0
    }

    pub fn width(&self) -> u8 {
        self.width
    }

    pub fn height(&self) -> u8 {
        self.height
    }

    /// The size of the image
    pub fn size(&self) -> ImageSize {
        ImageSize {
            width: self.width,
            height: self.height,
        }
    }

    pub fn pixels(&self) -> &Vec<u8> {
        &self.pixels
    }

    pub fn index_for_pixel(&self, x: i32, y: i32) -> Option<usize> {
        index_for_pixel(x, y, self.width, self.height)
    }

    /// Get pixel value at coordinate (x, y). No wrap around.
    /// 
    /// Idea for simplification. I rarely act on the `None` value.
    /// 
    /// from this: `image.get(x as i32, y as i32).unwrap_or(255);`
    /// 
    /// to this: `image.get(x, y)` and use `Color::Invalid` when getting outside the image.
    pub fn get(&self, x: i32, y: i32) -> Option<u8> {
        let index: usize = self.index_for_pixel(x, y)?;
        if index >= self.pixels.len() {
            return None;
        }
        Some(self.pixels[index])
    }

    /// Get pixel value with coordinate (x, y) wrapped around.
    /// 
    /// Returns `None` when the image is empty.
    /// 
    /// When the coordinate is outside the image, it will wrap around.
    #[allow(dead_code)]
    pub fn get_wrap(&self, x: i32, y: i32) -> Option<u8> {
        if self.is_empty() {
            return None;
        }
        let mut x_wrap: i32 = x % (self.width as i32);
        if x_wrap < 0 {
            x_wrap += self.width as i32;
        }
        let mut y_wrap: i32 = y % (self.height as i32);
        if y_wrap < 0 {
            y_wrap += self.height as i32;
        }
        self.get(x_wrap, y_wrap)
    }

    /// Set pixel value at coordinate (x, y).
    pub fn set(&mut self, x: i32, y: i32, value: u8) -> Option<()> {
        let index: usize = self.index_for_pixel(x, y)?;
        if index >= self.pixels.len() {
            return None;
        }
        self.pixels[index] = value;
        Some(())
    }

    /// Replace content
    pub fn set_image(&mut self, other: Image) {
        self.width = other.width;
        self.height = other.height;
        self.pixels = other.pixels;
    }

    /// Get the lowest and highest pixel values in the image.
    /// 
    /// If the image is empty, it returns `None`.
    pub fn minmax(&self) -> Option<(u8,u8)> {
        if self.is_empty() {
            return None;
        }
        let mut min_value: u8 = u8::MAX;
        let mut max_value: u8 = 0;
        for y in 0..self.height {
            for x in 0..self.width {
                let pixel_value: u8 = self.get(x as i32, y as i32).unwrap_or(255);
                min_value = min_value.min(pixel_value);
                max_value = max_value.max(pixel_value);
            }
        }
        Some((min_value, max_value))
    }

    /// Formatting of the pixels that is easy for a human to read.
    pub fn human_readable(&self) -> String {
        let mut s = String::new();
        for y in 0..self.height {
            if y > 0 {
                s += "\n";
            }
            for x in 0..self.width {
                let pixel_value: u8 = self.get(x as i32, y as i32).unwrap_or(255);
                if x > 0 {
                    s += " ";
                }
                s += &format!("{:X?}", pixel_value);
            }
        }
        s
    }
}

impl fmt::Debug for Image {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Image {}x{}\n{}", self.width, self.height, self.human_readable())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    #[test]
    fn test_10000_init_empty() {
        let bm = Image::empty();
        assert_eq!(bm.width(), 0);
        assert_eq!(bm.height(), 0);
        assert_eq!(bm.pixels().is_empty(), true);
        assert_eq!(bm.is_empty(), true);
    }

    #[test]
    fn test_10001_init_color() {
        let bm = Image::color(4, 3, 1);
        assert_eq!(bm.width(), 4);
        assert_eq!(bm.height(), 3);
        assert_eq!(bm.pixels().len(), 4 * 3);
        assert_eq!(bm.is_empty(), false);
        let mut sum: usize = 0;
        for pixel in bm.pixels() {
            sum += *pixel as usize;
        }
        assert_eq!(sum, 12);
    }

    #[test]
    fn test_10002_init_color_empty() {
        {
            let image = Image::color(0, 3, 1);
            assert_eq!(image, Image::empty());
        }
        {
            let image = Image::color(3, 0, 1);
            assert_eq!(image, Image::empty());
        }
    }

    #[test]
    fn test_10003_init_zero() {
        let bm = Image::zero(4, 3);
        assert_eq!(bm.width(), 4);
        assert_eq!(bm.height(), 3);
        assert_eq!(bm.pixels().len(), 4 * 3);
        assert_eq!(bm.is_empty(), false);
        let mut sum: usize = 0;
        for pixel in bm.pixels() {
            sum += *pixel as usize;
        }
        assert_eq!(sum, 0);
    }

    #[test]
    fn test_20000_get_set_pixel_value_ok() {
        let mut bm = Image::zero(3, 2);
        bm.set(0, 0, 1).expect("ok");
        bm.set(1, 0, 2).expect("ok");
        bm.set(2, 0, 3).expect("ok");
        bm.set(0, 1, 4).expect("ok");
        bm.set(1, 1, 5).expect("ok");
        bm.set(2, 1, 6).expect("ok");
        assert_eq!(bm.get(0, 0), Some(1));
        assert_eq!(bm.get(1, 0), Some(2));
        assert_eq!(bm.get(2, 0), Some(3));
        assert_eq!(bm.get(0, 1), Some(4));
        assert_eq!(bm.get(1, 1), Some(5));
        assert_eq!(bm.get(2, 1), Some(6));
    }

    #[test]
    fn test_20001_get_set_pixel_value_ok() {
        let mut bm = Image::zero(3, 1);
        bm.set(0, 0, 253).expect("ok");
        bm.set(1, 0, 254).expect("ok");
        bm.set(2, 0, 255).expect("ok");
        assert_eq!(bm.get(0, 0), Some(253));
        assert_eq!(bm.get(1, 0), Some(254));
        assert_eq!(bm.get(2, 0), Some(255));
    }

    #[test]
    fn test_20002_set_pixel_value_error() {
        let mut bm = Image::zero(3, 2);
        // negative coordinates
        assert_eq!(bm.set(-1, 0, 0), None);
        assert_eq!(bm.set(0, -1, 0), None);

        // beyond width or height
        assert_eq!(bm.set(3, 0, 0), None);
        assert_eq!(bm.set(0, 2, 0), None);
    }

    #[test]
    fn test_20003_get_wrap() {
        // Arrange
        let pixels: Vec<u8> = vec![
            11, 21, 31,
            12, 22, 32,
            13, 23, 33,
            14, 24, 34,
        ];
        let image: Image = Image::create_raw(3, 4, pixels);

        // Act & Assert
        {
            // negative x coordinate
            assert_eq!(image.get_wrap(-1, 0), Some(31));
            assert_eq!(image.get_wrap(-4, 0), Some(31));
            assert_eq!(image.get_wrap(-7, 0), Some(31));
        }
        {
            // negative y coordinate
            assert_eq!(image.get_wrap(0, -1), Some(14));
            assert_eq!(image.get_wrap(0, -5), Some(14));
            assert_eq!(image.get_wrap(0, -9), Some(14));
        }
        {
            // x coordinate beyond width
            assert_eq!(image.get_wrap(3, 0), Some(11));
            assert_eq!(image.get_wrap(6, 0), Some(11));
            assert_eq!(image.get_wrap(9, 0), Some(11));
        }
        {
            // y coordinate beyond height
            assert_eq!(image.get_wrap(0, 4), Some(11));
            assert_eq!(image.get_wrap(0, 8), Some(11));
            assert_eq!(image.get_wrap(0, 12), Some(11));
        }
    }

    #[test]
    fn test_30000_compare() {
        {
            let mut bm0 = Image::zero(3, 2);
            bm0.set(0, 0, 255).expect("ok");
            bm0.set(2, 1, 255).expect("ok");
            let bm1 = Image::create_raw(3, 2, vec![255, 0, 0, 0, 0, 255]);
            assert_eq!(bm0, bm1);
        }
        {
            let mut bm0 = Image::zero(3, 2);
            bm0.set(0, 0, 255).expect("ok");
            bm0.set(2, 1, 254).expect("ok");
            let bm1 = Image::create_raw(3, 2, vec![255, 0, 0, 0, 0, 255]);
            assert_ne!(bm0, bm1);
        }
        {
            let mut bm0 = Image::create_raw(3, 2, vec![255, 0, 0, 0, 0, 255]);
            bm0.set(0, 0, 0).expect("ok");
            bm0.set(2, 1, 0).expect("ok");
            let bm1 = Image::zero(3, 2);
            assert_eq!(bm0, bm1);
        }
    }

    #[test]
    fn test_40000_equal() {
        {
            let image0 = Image::create_raw(2, 2, vec![1, 2, 3, 4]);
            let image1 = Image::create_raw(2, 2, vec![1, 2, 3, 4]);
            assert_eq!(image0, image1);
        }
        {
            let image0 = Image::empty();
            let image1 = Image::empty();
            assert_eq!(image0, image1);
        }
        {
            let image0 = Image::create_raw(1, 4, vec![1, 2, 3, 4]);
            let image1 = Image::create_raw(4, 1, vec![1, 2, 3, 4]);
            assert_ne!(image0, image1);
        }
        {
            let image0 = Image::empty();
            let image1 = Image::create_raw(4, 1, vec![1, 2, 3, 4]);
            assert_ne!(image0, image1);
        }
    }

    fn mock_hashset() -> HashSet<Image> {
        let mut images: HashSet<Image> = HashSet::<Image>::new();
        {
            let image = Image::create_raw(2, 2, vec![1, 2, 3, 4]);
            images.insert(image);
        }
        {
            let image = Image::create_raw(1, 1, vec![9]);
            images.insert(image);
        }
        images
    }

    #[test]
    fn test_50000_hash() {
        let images: HashSet<Image> = mock_hashset();
        assert_eq!(images.len(), 2);
    }

    #[test]
    fn test_50001_hash_insert_identical_image_does_not_affect_size() {
        let mut images: HashSet<Image> = mock_hashset();
        {
            let image = Image::create_raw(1, 1, vec![9]);
            images.insert(image);
        }
        assert_eq!(images.len(), 2);
    }

    #[test]
    fn test_50002_hash_remove_image() {
        let mut images: HashSet<Image> = mock_hashset();
        {
            let image = Image::create_raw(1, 1, vec![9]);
            images.remove(&image);
        }
        assert_eq!(images.len(), 1);
    }

    #[test]
    fn test_60000_set_image() {
        // Arrange
        let mut image = Image::empty();
        let new_image = Image::color(3, 2, 9);

        // Act
        image.set_image(new_image);

        // Assert
        assert_eq!(image.width(), 3);
        assert_eq!(image.height(), 2);
        let expected_pixels: Vec<u8> = vec![9, 9, 9, 9, 9, 9];
        assert_eq!(*image.pixels(), expected_pixels);
    }

    #[test]
    fn test_70000_sort_same_sizes_different_colors() {
        // Arrange
        let image0 = Image::color(1, 1, 0);
        let image1 = Image::color(1, 1, 1);
        let image2 = Image::color(1, 1, 2);
        let image3 = Image::color(1, 1, 3);
        let mut shuffled_images: Vec<Image> = vec![image3.clone(), image1.clone(), image0.clone(), image2.clone()];

        // Act
        shuffled_images.sort();

        // Assert
        let expected_images: Vec<Image> = vec![image0, image1, image2, image3];
        assert_eq!(expected_images, shuffled_images);
    }

    #[test]
    fn test_70001_sort_different_sizes_same_color() {
        // Arrange
        let image0 = Image::color(1, 1, 0);
        let image1 = Image::color(1, 2, 0);
        let image2 = Image::color(2, 1, 0);
        let image3 = Image::color(2, 2, 0);
        let mut shuffled_images: Vec<Image> = vec![image3.clone(), image1.clone(), image0.clone(), image2.clone()];

        // Act
        shuffled_images.sort();

        // Assert
        let expected_images: Vec<Image> = vec![image0, image1, image2, image3];
        assert_eq!(expected_images, shuffled_images);
    }

    #[test]
    fn test_80000_clone_color() {
        // Arrange
        let mut input = Image::zero(5, 3);
        _ = input.set(2, 1, 1);

        // Act
        let actual: Image = input.clone_color(1);

        // Assert
        let expected = Image::color(5, 3, 1);
        assert_eq!(expected, actual);
    }

    #[test]
    fn test_90000_minmax() {
        {
            let image = Image::create_raw(2, 3, vec![5, 4, 9, 5, 42, 9]);
            assert_eq!(image.minmax(), Some((4, 42)));
        }
        {
            let image = Image::empty();
            assert_eq!(image.minmax(), None);
        }
    }
}