prisma 0.1.1

//! Traits and structs to perform encoding and decoding
//!
//! See the [`encoding`](../index.html) module level documentation for more information

use super::EncodableColor;
use crate::alpha::Rgba;
use crate::channel::{ChannelFormatCast, PosNormalChannelScalar};
use crate::color::Color;
use crate::rgb::Rgb;
use num_traits;
use std::fmt;

/// An object that can encode a color from a linear encoding to a different encoding
///
/// This is a low level trait that is unlikely to be used directly
pub trait ChannelEncoder {
    /// Encode a linearly-encoded channel
    fn encode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float;
}
/// An object that can decode a color from some encoding to a linear encoding
///
/// This is a low level trait that is unlikely to be used directly
pub trait ChannelDecoder {
    /// Decode a channel into a linear-encoding
    fn decode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float;
}

/// A color that can have its encoding changed
///
/// Because of the non-linear nature of encodings, only Rgb can have its encoding changed. The other
/// device-dependent colors can come from an encoding, and may be stored in `EncodedColor`, but
/// they must go through Rgb for that encoding to change.
pub trait TranscodableColor: Color + EncodableColor {
    /// The color type used internally to do conversions. This will always have floating-point channels
    type IntermediateColor;
    /// Encode `self` using the encoder `enc`
    fn encode_color<Encoder>(self, enc: &Encoder) -> Self
    where
        Encoder: ChannelEncoder;
    /// Decode `self` using the decoder `dec`
    fn decode_color<Decoder>(self, dec: &Decoder) -> Self
    where
        Decoder: ChannelDecoder;
}

/// An object able to encode and decode a color
pub trait ColorEncoding: ChannelEncoder + ChannelDecoder + Sized + Clone {}

/// An encoding scheme used by the sRGB color space.
///
/// sRGB features a small linear region at the lowest values, and then transitions to
/// a $`\gamma`$ of 2.4.
#[derive(Clone, Debug, PartialEq)]
pub struct SrgbEncoding;
/// A linear encoding scheme
#[derive(Clone, Debug, PartialEq)]
pub struct LinearEncoding;
/// A gamma encoding scheme with a given value for $`\gamma`$
#[derive(Clone, Debug, PartialEq)]
pub struct GammaEncoding<T>(pub T);

impl SrgbEncoding {
    /// Construct a new SrgbEncoding
    pub fn new() -> Self {
        SrgbEncoding {}
    }
}

impl ChannelDecoder for SrgbEncoding {
    fn decode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float,
    {
        let one: T = num_traits::cast(1.0).unwrap();
        let a: T = num_traits::cast(0.055).unwrap();
        let k: T = num_traits::cast(12.92).unwrap();
        let gamma: T = num_traits::cast(2.4).unwrap();
        let linear_threshold: T = num_traits::cast(0.04045).unwrap();

        if val.abs() < linear_threshold {
            val / k
        } else {
            let operand = (val.abs() + a) / (one + a);
            val.signum() * operand.powf(gamma)
        }
    }
}

impl ChannelEncoder for SrgbEncoding {
    fn encode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float,
    {
        let one: T = num_traits::cast(1.0).unwrap();
        let a: T = num_traits::cast(0.055).unwrap();
        let k: T = num_traits::cast(12.92).unwrap();
        let gamma: T = num_traits::cast(2.4).unwrap();
        let linear_threshold: T = num_traits::cast(0.0031308).unwrap();

        if val.abs() < linear_threshold {
            k * val
        } else {
            val.signum() * ((one + a) * val.abs().powf(one / gamma) - a)
        }
    }
}

impl ColorEncoding for SrgbEncoding {}

impl Default for SrgbEncoding {
    fn default() -> Self {
        SrgbEncoding {}
    }
}

impl fmt::Display for SrgbEncoding {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "sRgb")
    }
}

impl LinearEncoding {
    /// Construct a new `LinearEncoding`
    pub fn new() -> Self {
        LinearEncoding {}
    }
}

impl ChannelDecoder for LinearEncoding {
    fn decode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float,
    {
        val
    }
}

impl ChannelEncoder for LinearEncoding {
    fn encode_channel<T>(&self, val: T) -> T
    where
        T: num_traits::Float,
    {
        val
    }
}

impl ColorEncoding for LinearEncoding {}

impl Default for LinearEncoding {
    fn default() -> Self {
        LinearEncoding {}
    }
}

impl fmt::Display for LinearEncoding {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Linear")
    }
}

impl<T> GammaEncoding<T>
where
    T: num_traits::Float,
{
    /// Construct a new `GammaEncoding`
    pub fn new(val: T) -> Self {
        GammaEncoding(val)
    }
    /// Return the gamma exponent value
    pub fn exponent(&self) -> T {
        self.0
    }
}

impl<T> ChannelDecoder for GammaEncoding<T>
where
    T: num_traits::Float,
{
    fn decode_channel<U>(&self, val: U) -> U
    where
        U: num_traits::Float,
    {
        val.signum() * val.abs().powf(num_traits::cast(self.0).unwrap())
    }
}
impl<T> ChannelEncoder for GammaEncoding<T>
where
    T: num_traits::Float,
{
    fn encode_channel<U>(&self, val: U) -> U
    where
        U: num_traits::Float,
    {
        let one: T = num_traits::cast(1.0).unwrap();
        val.signum() * val.abs().powf(num_traits::cast(one / self.0).unwrap())
    }
}

impl<T: num_traits::Float> ColorEncoding for GammaEncoding<T> {}

impl<T: num_traits::Float> Default for GammaEncoding<T> {
    fn default() -> Self {
        GammaEncoding::new(num_traits::cast(2.2).unwrap())
    }
}

impl<T> fmt::Display for GammaEncoding<T>
where
    T: num_traits::Float + fmt::Display,
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "γ={}", self.0)
    }
}

impl<T> TranscodableColor for Rgb<T>
where
    T: PosNormalChannelScalar + ChannelFormatCast<f64>,
    f64: ChannelFormatCast<T>,
{
    type IntermediateColor = Rgb<f64>;
    fn encode_color<Encoder>(self, enc: &Encoder) -> Self
    where
        Encoder: ChannelEncoder,
    {
        let flt_color: Self::IntermediateColor = self.color_cast();

        let enc_r = enc.encode_channel(flt_color.red());
        let enc_g = enc.encode_channel(flt_color.green());
        let enc_b = enc.encode_channel(flt_color.blue());

        let out_color: Rgb<T> = Rgb::new(enc_r, enc_g, enc_b).color_cast();

        out_color
    }

    fn decode_color<Decoder>(self, dec: &Decoder) -> Self
    where
        Decoder: ChannelDecoder,
    {
        let flt_color: Self::IntermediateColor = self.color_cast();

        let linear_r = dec.decode_channel(flt_color.red());
        let linear_g = dec.decode_channel(flt_color.green());
        let linear_b = dec.decode_channel(flt_color.blue());

        let out_color: Rgb<T> = Rgb::new(linear_r, linear_g, linear_b).color_cast();

        out_color
    }
}

impl<T> TranscodableColor for Rgba<T>
where
    T: PosNormalChannelScalar + ChannelFormatCast<f64>,
    f64: ChannelFormatCast<T>,
{
    type IntermediateColor = Rgba<f64>;

    fn encode_color<Encoder>(self, enc: &Encoder) -> Self
    where
        Encoder: ChannelEncoder,
    {
        let (color, alpha) = self.decompose();
        let inner_color = color.encode_color(enc);
        Rgba::new(inner_color, alpha)
    }

    fn decode_color<Decoder>(self, dec: &Decoder) -> Self
    where
        Decoder: ChannelDecoder,
    {
        let (color, alpha) = self.decompose();
        let inner_color = color.decode_color(dec);
        Rgba::new(inner_color, alpha)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::color::*;
    use crate::encoding::EncodableColor;
    use crate::rgb::Rgb;
    use approx::*;

    #[test]
    fn test_gamma_encoding() {
        let c1 = Rgb::new(0.0, 0.0, 0.0).encoded_as(LinearEncoding::new());
        let t1 = c1.clone().encode(GammaEncoding::new(2.0));
        assert_relative_eq!(t1.color(), c1.color(), epsilon = 1e-6);

        let c2 = Rgb::new(1.0, 1.0, 1.0).encoded_as(LinearEncoding::new());
        let t2 = c2.clone().encode(GammaEncoding::new(2.2));
        assert_relative_eq!(t2.color(), c2.color(), epsilon = 1e-6);

        let c3 = Rgb::new(0.5, 0.5, 0.5).encoded_as(LinearEncoding::new());
        let t3 = c3.clone().encode(GammaEncoding::new(2.2));
        assert_relative_eq!(*t3.color(), Rgb::broadcast(0.72974005), epsilon = 1e-6);
        assert_relative_eq!(t3.decode(), c3, epsilon = 1e-6);

        let c4 = Rgb::new(0.2, 0.8, 0.66).encoded_as(LinearEncoding::new());
        let t4 = c4.clone().encode(GammaEncoding::new(1.8));
        assert_relative_eq!(
            *t4.color(),
            Rgb::new(0.4089623, 0.88340754, 0.793864955),
            epsilon = 1e-6
        );
        assert_relative_eq!(t4.decode(), c4, epsilon = 1e-6);

        let c5 = Rgb::new(0.5, 0.5, 0.5).encoded_as(GammaEncoding::new(2.4));
        let t5 = c5.clone().decode();
        assert_relative_eq!(*t5.color(), Rgb::broadcast(0.18946457), epsilon = 1e-6);

        let c6 = Rgb::new(-0.3, 0.0, -1.0).encoded_as(GammaEncoding::new(2.2));
        let t6 = c6.clone().decode();
        assert_relative_eq!(*t6.color(), Rgb::new(-0.0707403, 0.0, -1.0), epsilon = 1e-6);
        assert_relative_eq!(t6.encode(GammaEncoding::new(2.2)), c6, epsilon = 1e-6);
    }

    #[test]
    fn test_srgb_encoding() {
        let c1 = Rgb::new(0.0, 0.0, 0.0).encoded_as(LinearEncoding::new());
        let t1 = c1.clone().encode(SrgbEncoding::new());
        assert_relative_eq!(t1.color(), c1.color(), epsilon = 1e-6);

        let c2 = Rgb::new(1.0, 1.0, 1.0).encoded_as(LinearEncoding::new());
        let t2 = c2.clone().encode(SrgbEncoding::new());
        assert_relative_eq!(t2.color(), c2.color(), epsilon = 1e-6);

        let c3 = Rgb::new(0.5, 0.5, 0.5).encoded_as(LinearEncoding::new());
        let t3 = c3.clone().encode(SrgbEncoding::new());
        assert_relative_eq!(*t3.color(), Rgb::broadcast(0.735356983052), epsilon = 1e-6);
        assert_relative_eq!(t3.decode(), c3, epsilon = 1e-6);

        let c4 = Rgb::new(0.2, 0.8, 0.66).encoded_as(LinearEncoding::new());
        let t4 = c4.clone().encode(SrgbEncoding::new());
        assert_relative_eq!(
            *t4.color(),
            Rgb::new(0.4845292044, 0.90633175, 0.83228355590),
            epsilon = 1e-6
        );
        assert_relative_eq!(t4.decode(), c4, epsilon = 1e-6);

        let c5 = Rgb::new(0.5, 0.5, 0.5).encoded_as(SrgbEncoding::new());
        let t5 = c5.clone().decode();
        assert_relative_eq!(*t5.color(), Rgb::broadcast(0.21404114048), epsilon = 1e-6);

        let c6 = Rgb::new(-0.25, -0.74, -1.00).encoded_as(LinearEncoding::new());
        let t6 = c6.clone().encode(SrgbEncoding::new());
        assert_relative_eq!(
            *t6.color(),
            Rgb::new(-0.5370987, -0.8756056, -1.00),
            epsilon = 1e-6
        );
        assert_relative_eq!(t6.decode(), c6, epsilon = 1e-6);
    }
}