colorspace 0.1.0

//! RGB color types

use super::math::*;
use std::fmt;
use std::{
    convert::TryInto,
    ops::{Index, IndexMut},
};

use float_cmp::{ApproxEq, F32Margin, F64Margin};

#[cfg(feature = "f16")]
use half::f16;

/// Floating-point RGB type
#[repr(C)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Default)]
pub struct RGBf<T> {
    pub r: T,
    pub g: T,
    pub b: T,
}

impl<T> RGBf<T>
where
    T: Real,
{
    pub fn new(r: T, g: T, b: T) -> RGBf<T> {
        RGBf::<T> { r, g, b }
    }

    pub fn from_scalar(s: T) -> RGBf<T> {
        RGBf::<T> { r: s, g: s, b: s }
    }

    pub fn powf(&self, x: T) -> RGBf<T> {
        RGBf::<T> {
            r: self.r.powf(x),
            g: self.g.powf(x),
            b: self.b.powf(x),
        }
    }

    pub fn abs(&self) -> RGBf<T> {
        RGBf::<T> {
            r: self.r.abs(),
            g: self.g.abs(),
            b: self.b.abs(),
        }
    }

    pub fn cast_slice(slice: &[T]) -> &[RGBf<T>] {
        if slice.len() % 3 != 0 {
            panic!("invalid slice cast");
        }

        unsafe {
            std::slice::from_raw_parts(
                slice.as_ptr() as *const RGBf<T>,
                slice.len() / 3,
            )
        }
    }
}

pub type RGBf32 = RGBf<f32>;
pub type RGBf64 = RGBf<f64>;

#[inline]
pub fn rgbf<T>(r: T, g: T, b: T) -> RGBf<T>
where
    T: Real,
{
    RGBf::<T>::new(r, g, b)
}

#[inline]
pub fn rgbf32(r: f32, g: f32, b: f32) -> RGBf32 {
    RGBf32::new(r, g, b)
}

#[inline]
pub fn rgbf64(r: f64, g: f64, b: f64) -> RGBf64 {
    RGBf64::new(r, g, b)
}

impl<T> Zero for RGBf<T>
where
    T: Real,
{
    fn zero() -> RGBf<T>
    where
        T: Real,
    {
        RGBf::<T>::from_scalar(T::zero())
    }
    fn is_zero(&self) -> bool
    where
        T: Scalar,
    {
        self.r.is_zero() && self.g.is_zero() && self.b.is_zero()
    }
}

impl<T> One for RGBf<T>
where
    T: Real,
{
    fn one() -> RGBf<T>
    where
        T: Real,
    {
        RGBf::<T>::from_scalar(T::one())
    }
}

impl<T> Bounded for RGBf<T>
where
    T: Scalar,
{
    fn min_value() -> RGBf<T> {
        RGBf::<T> {
            r: T::min_value(),
            g: T::min_value(),
            b: T::min_value(),
        }
    }
    fn max_value() -> RGBf<T> {
        RGBf::<T> {
            r: T::max_value(),
            g: T::max_value(),
            b: T::max_value(),
        }
    }
}

impl<T> Index<usize> for RGBf<T>
where
    T: Scalar,
{
    type Output = T;

    fn index(&self, i: usize) -> &T {
        match i {
            0 => &self.r,
            1 => &self.g,
            2 => &self.b,
            _ => panic!("Tried to access RGBf with index of {}", i),
        }
    }
}

impl<T> IndexMut<usize> for RGBf<T>
where
    T: Scalar,
{
    fn index_mut(&mut self, i: usize) -> &mut T {
        match i {
            0 => &mut self.r,
            1 => &mut self.g,
            2 => &mut self.b,
            _ => panic!("Tried to access RGBf with index of {}", i),
        }
    }
}

impl ApproxEq for RGBf32 {
    type Margin = F32Margin;
    fn approx_eq<T: Into<Self::Margin>>(self, other: Self, margin: T) -> bool {
        let margin = margin.into();
        self.r.approx_eq(other.r, margin)
            && self.g.approx_eq(other.g, margin)
            && self.b.approx_eq(other.b, margin)
    }
}

impl ApproxEq for RGBf64 {
    type Margin = F64Margin;
    fn approx_eq<T: Into<Self::Margin>>(self, other: Self, margin: T) -> bool {
        let margin = margin.into();
        self.r.approx_eq(other.r, margin)
            && self.g.approx_eq(other.g, margin)
            && self.b.approx_eq(other.b, margin)
    }
}

impl std::iter::Sum for RGBf32 {
    fn sum<I>(iter: I) -> RGBf32
    where
        I: Iterator<Item = RGBf32>,
    {
        let mut xyz = RGBf32::from_scalar(0.0);
        for i in iter {
            xyz += i;
        }

        xyz
    }
}

impl std::iter::Sum for RGBf64 {
    fn sum<I>(iter: I) -> RGBf64
    where
        I: Iterator<Item = RGBf64>,
    {
        let mut xyz = RGBf64::from_scalar(0.0);
        for i in iter {
            xyz += i;
        }

        xyz
    }
}

impl<T> fmt::Display for RGBf<T>
where
    T: Scalar + fmt::Display,
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "({}, {}, {})", self.r, self.g, self.b)
    }
}

/// Addition operator
impl<T> Add for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn add(self, rhs: RGBf<T>) -> RGBf<T> {
        RGBf::<T> {
            r: self.r + rhs.r,
            g: self.g + rhs.g,
            b: self.b + rhs.b,
        }
    }
}

/// Addition operator
impl<T> AddAssign for RGBf<T>
where
    T: Scalar,
{
    fn add_assign(&mut self, rhs: RGBf<T>) {
        self.r += rhs.r;
        self.g += rhs.g;
        self.b += rhs.b
    }
}

/// Subtraction operator
impl<T> Sub for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn sub(self, rhs: RGBf<T>) -> RGBf<T> {
        RGBf::<T> {
            r: self.r - rhs.r,
            g: self.g - rhs.g,
            b: self.b - rhs.b,
        }
    }
}

/// Multiplication operator
impl<T> Mul for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn mul(self, rhs: RGBf<T>) -> RGBf<T> {
        RGBf::<T> {
            r: self.r * rhs.r,
            g: self.g * rhs.g,
            b: self.b * rhs.b,
        }
    }
}

/// Division operator
impl<T> Div for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn div(self, rhs: RGBf<T>) -> RGBf<T> {
        RGBf::<T> {
            r: self.r / rhs.r,
            g: self.g / rhs.g,
            b: self.b / rhs.b,
        }
    }
}

/// Unary negation
impl<T> Neg for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn neg(self) -> RGBf<T> {
        RGBf::<T> {
            r: -self.r,
            g: -self.g,
            b: -self.b,
        }
    }
}

/// Multiplication by a T
impl<T> Mul<T> for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn mul(self, rhs: T) -> RGBf<T> {
        RGBf::<T> {
            r: self.r * rhs,
            g: self.g * rhs,
            b: self.b * rhs,
        }
    }
}

/// Division by a T
impl<T> Div<T> for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn div(self, rhs: T) -> RGBf<T> {
        RGBf::<T> {
            r: self.r / rhs,
            g: self.g / rhs,
            b: self.b / rhs,
        }
    }
}

/// Addition by a T
impl<T> Add<T> for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn add(self, rhs: T) -> RGBf<T> {
        RGBf::<T> {
            r: self.r + rhs,
            g: self.g + rhs,
            b: self.b + rhs,
        }
    }
}

/// Subtraction by a T
impl<T> Sub<T> for RGBf<T>
where
    T: Scalar,
{
    type Output = RGBf<T>;

    fn sub(self, rhs: T) -> RGBf<T> {
        RGBf::<T> {
            r: self.r - rhs,
            g: self.g - rhs,
            b: self.b - rhs,
        }
    }
}

/// Macro to implement right-side multiplication: T * RGBf<T>
macro_rules! rgbf_impl_rhs_mul {
    ($($t:ty)*) => ($(
        impl Mul<RGBf<$t>> for $t {
            type Output = RGBf<$t>;
            fn mul(self, rhs: RGBf<$t>) -> RGBf<$t> {
                RGBf {
                    r: self * rhs.r,
                    g: self * rhs.g,
                    b: self * rhs.b,
                }
            }
        }
    )*)
}

rgbf_impl_rhs_mul! {
    f32
}

/// Macro to implement right-side addition: T + Vec2<T>
macro_rules! rgbf_impl_rhs_add {
    ($($t:ty)*) => ($(
        impl Add<RGBf<$t>> for $t {
            type Output = RGBf<$t>;
            fn add(self, rhs: RGBf<$t>) -> RGBf<$t> {
                RGBf {
                    r: rhs.r + self,
                    g: rhs.g + self,
                    b: rhs.b + self,
                }
            }
        }
    )*)
}

rgbf_impl_rhs_add! {
    f32
}

/// Macro to implement right-side subtraction: T - Vec2<T>
macro_rules! rgbf_impl_rhs_sub {
    ($($t:ty)*) => ($(
        impl Sub<RGBf<$t>> for $t {
            type Output = RGBf<$t>;
            fn sub(self, rhs: RGBf<$t>) -> RGBf<$t> {
                RGBf {
                    r: self - rhs.r,
                    g: self - rhs.g,
                    b: self - rhs.b,
                }
            }
        }
    )*)
}

rgbf_impl_rhs_sub! {
    f32
}

/// Macro to implement right-side division: T / Vec2<T>
macro_rules! rgbf_impl_rhs_div {
    ($($t:ty)*) => ($(
        impl Div<RGBf<$t>> for $t {
            type Output = RGBf<$t>;
            fn div(self, rhs: RGBf<$t>) -> RGBf<$t> {
                RGBf {
                    r: self / rhs.r,
                    g: self / rhs.g,
                    b: self / rhs.b,
                }
            }
        }
    )*)
}

rgbf_impl_rhs_div! {
    f32
}

/// Returns the value of the largest component of `c`
pub fn hmax<T>(c: RGBf<T>) -> T
where
    T: Real,
{
    c.r.max(c.g.max(c.b))
}

/// Returns a colour whose values are a normalized version of `c`, such that
/// the largest component in the return value will be 1.0
pub fn normalize<T>(c: RGBf<T>) -> RGBf<T>
where
    T: Real,
{
    c / hmax(c)
}

/// Clamp `c` such that each component is at least `a` and at most `b`
pub fn clamprgb<T>(c: RGBf<T>, a: T, b: T) -> RGBf<T>
where
    T: Real,
{
    RGBf::<T>::new(clamp(c.r, a, b), clamp(c.g, a, b), clamp(c.b, a, b))
}

#[repr(C)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Default)]
pub struct RGBu8 {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

impl RGBu8 {
    pub fn cast_slice(slice: &[u8]) -> &[RGBu8] {
        if slice.len() % 3 != 0 {
            panic!("invalid slice cast");
        }

        // This is safe as long as the length of `slice` is a multiple of 3,
        // which we guarantee with the panic!, above
        unsafe {
            std::slice::from_raw_parts(
                slice.as_ptr() as *const RGBu8,
                slice.len() / 3,
            )
        }
    }
}

#[repr(C)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Default)]
pub struct RGBu16 {
    pub r: u16,
    pub g: u16,
    pub b: u16,
}

#[cfg(feature = "f16")]
#[repr(C)]
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Default)]
pub struct RGBf16 {
    pub r: f16,
    pub g: f16,
    pub b: f16,
}

#[repr(C)]
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Default)]
pub struct RGBAf32 {
    pub r: f32,
    pub g: f32,
    pub b: f32,
    pub a: f32,
}

#[cfg(feature = "f16")]
#[repr(C)]
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Default)]
pub struct RGBAf16 {
    pub r: f16,
    pub g: f16,
    pub b: f16,
    pub a: f16,
}

#[inline]
pub fn rgbu8(r: u8, g: u8, b: u8) -> RGBu8 {
    RGBu8 { r, g, b }
}

#[inline]
pub fn rgbu16(r: u16, g: u16, b: u16) -> RGBu16 {
    RGBu16 { r, g, b }
}

#[cfg(feature = "f16")]
#[inline]
pub fn rgbf16(r: f16, g: f16, b: f16) -> RGBf16 {
    RGBf16 { r, g, b }
}

#[cfg(feature = "f16")]
#[inline]
pub fn rgbaf16(r: f16, g: f16, b: f16, a: f16) -> RGBAf16 {
    RGBAf16 { r, g, b, a }
}

#[inline]
pub fn rgbaf32(r: f32, g: f32, b: f32, a: f32) -> RGBAf32 {
    RGBAf32 { r, g, b, a }
}

impl From<RGBf64> for RGBf32 {
    fn from(c: RGBf64) -> RGBf32 {
        RGBf32 {
            r: c.r as f32,
            g: c.g as f32,
            b: c.b as f32,
        }
    }
}

impl From<RGBf32> for RGBu8 {
    fn from(c: RGBf32) -> RGBu8 {
        RGBu8 {
            r: (clamp(c.r, 0.0, 1.0) * 255.0).round() as u8,
            g: (clamp(c.g, 0.0, 1.0) * 255.0).round() as u8,
            b: (clamp(c.b, 0.0, 1.0) * 255.0).round() as u8,
        }
    }
}

impl From<RGBf32> for RGBu16 {
    fn from(c: RGBf32) -> RGBu16 {
        RGBu16 {
            r: (clamp(c.r, 0.0, 1.0) * 65535.0).round() as u16,
            g: (clamp(c.g, 0.0, 1.0) * 65535.0).round() as u16,
            b: (clamp(c.b, 0.0, 1.0) * 65535.0).round() as u16,
        }
    }
}

impl From<RGBf64> for RGBu8 {
    fn from(c: RGBf64) -> RGBu8 {
        RGBu8 {
            r: (clamp(c.r, 0.0, 1.0) * 255.0).round() as u8,
            g: (clamp(c.g, 0.0, 1.0) * 255.0).round() as u8,
            b: (clamp(c.b, 0.0, 1.0) * 255.0).round() as u8,
        }
    }
}

impl From<RGBf64> for RGBu16 {
    fn from(c: RGBf64) -> RGBu16 {
        RGBu16 {
            r: (clamp(c.r, 0.0, 1.0) * 65535.0).round() as u16,
            g: (clamp(c.g, 0.0, 1.0) * 65535.0).round() as u16,
            b: (clamp(c.b, 0.0, 1.0) * 65535.0).round() as u16,
        }
    }
}

impl From<RGBu8> for RGBf32 {
    fn from(c: RGBu8) -> RGBf32 {
        RGBf32 {
            r: f32::from(c.r) / 255.0,
            g: f32::from(c.g) / 255.0,
            b: f32::from(c.b) / 255.0,
        }
    }
}

impl From<RGBu16> for RGBf32 {
    fn from(c: RGBu16) -> RGBf32 {
        RGBf32 {
            r: f32::from(c.r) / 65535.0,
            g: f32::from(c.g) / 65535.0,
            b: f32::from(c.b) / 65535.0,
        }
    }
}

impl From<RGBu8> for RGBf64 {
    fn from(c: RGBu8) -> RGBf64 {
        RGBf64 {
            r: f64::from(c.r) / 255.0,
            g: f64::from(c.g) / 255.0,
            b: f64::from(c.b) / 255.0,
        }
    }
}

impl From<RGBu16> for RGBf64 {
    fn from(c: RGBu16) -> RGBf64 {
        RGBf64 {
            r: f64::from(c.r) / 65535.0,
            g: f64::from(c.g) / 65535.0,
            b: f64::from(c.b) / 65535.0,
        }
    }
}

impl fmt::Display for RGBu8 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "({}, {}, {})", self.r, self.g, self.b)
    }
}

impl fmt::Display for RGBu16 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "({}, {}, {})", self.r, self.g, self.b)
    }
}

#[cfg(feature = "f16")]
impl fmt::Display for RGBf16 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "({}, {}, {})", self.r, self.g, self.b)
    }
}