//! Various utilities for working with Cairo image surfaces.

use std::alloc;

use std::slice;

pub mod iterators;

pub mod shared_surface;

pub mod srgb;

// These two are for Cairo's platform-endian 0xaarrggbb pixels

#[cfg(target_endian = "little")]

use rgb::alt::BGRA8;

#[cfg(target_endian = "little")]

#[allow(clippy::upper_case_acronyms)]

pub type CairoARGB = BGRA8;

#[cfg(target_endian = "big")]

use rgb::alt::ARGB8;

#[cfg(target_endian = "big")]

#[allow(clippy::upper_case_acronyms)]

pub type CairoARGB = ARGB8;

use rgb::ColorComponentMap;

/// Analogous to `rgb::FromSlice`, to convert from `[T]` to `[CairoARGB]`

#[allow(clippy::upper_case_acronyms)]

pub trait AsCairoARGB {

    /// Reinterpret slice as `CairoARGB` pixels.

    fn as_cairo_argb(&self) -> &[CairoARGB];

    /// Reinterpret mutable slice as `CairoARGB` pixels.

    fn as_cairo_argb_mut(&mut self) -> &mut [CairoARGB];

}

// SAFETY: transmuting from u32 to CairoRGB is based on the following assumptions:

//  * there are no invalid bit representations for ARGB

//  * u32 and ARGB are the same size

//  * u32 is sufficiently aligned

impl AsCairoARGB for [u32] {

        const LAYOUT_U32: alloc::Layout = alloc::Layout::new::<u32>();

        const LAYOUT_ARGB: alloc::Layout = alloc::Layout::new::<CairoARGB>();

}

/// Modes which specify how the values of out of bounds pixels are computed.

///

/// <https://www.w3.org/TR/filter-effects/#element-attrdef-fegaussianblur-edgemode>

#[derive(Debug, Clone, Copy, Eq, PartialEq)]

pub enum EdgeMode {

    /// The nearest inbounds pixel value is returned.

    Duplicate,

    /// The image is extended by taking the color values from the opposite of the image.

    ///

    /// Imagine the image being tiled infinitely, with the original image at the origin.

    Wrap,

    /// Zero RGBA values are returned.

    None,

}

/// Trait to convert pixels in various formats to our own Pixel layout.

pub trait ToPixel {

    fn to_pixel(&self) -> Pixel;

}

/// Trait to convert pixels in various formats to Cairo's endian-dependent 0xaarrggbb.

pub trait ToCairoARGB {

    fn to_cairo_argb(&self) -> CairoARGB;

}

impl ToPixel for CairoARGB {

    #[inline]

}

impl ToPixel for image::Rgba<u8> {

    #[inline]

}

impl ToCairoARGB for Pixel {

    #[inline]

}

/// Extension methods for `cairo::ImageSurfaceData`.

pub trait ImageSurfaceDataExt {

    /// Sets the pixel at the given coordinates. Assumes the `ARgb32` format.

    fn set_pixel(&mut self, stride: usize, pixel: Pixel, x: u32, y: u32);

}

/// A pixel consisting of R, G, B and A values.

pub type Pixel = rgb::RGBA8;

/// Various operations on pixel values.

///

/// This is done as a trait so that we can implement additional methods on [rgb::RGBA8],

/// which is aliased to the [Pixel] type.

pub trait PixelOps {

    fn premultiply(self) -> Self;

    fn unpremultiply(self) -> Self;

    fn diff(&self, other: &Self) -> Self;

    fn to_luminance_mask(&self) -> Self;

    fn to_u32(&self) -> u32;

    fn from_u32(x: u32) -> Self;

}

impl PixelOps for Pixel {

    /// Returns an unpremultiplied value of this pixel.

    ///

    /// For a fully transparent pixel, a transparent black pixel will be returned.

    #[inline]

        } else {

        }

    /// Returns a premultiplied value of this pixel.

    #[inline]

    #[inline]

    /// Returns a 'mask' pixel with only the alpha channel

    ///

    /// Assuming, the pixel is linear RGB (not sRGB)

    /// y = luminance

    /// Y = 0.2126 R + 0.7152 G + 0.0722 B

    /// 1.0 opacity = 255

    ///

    /// When Y = 1.0, pixel for mask should be 0xFFFFFFFF

    /// (you get 1.0 luminance from 255 from R, G and B)

    ///

    /// r_mult = 0xFFFFFFFF / (255.0 * 255.0) * .2126 = 14042.45  ~= 14042

    /// g_mult = 0xFFFFFFFF / (255.0 * 255.0) * .7152 = 47239.69  ~= 47240

    /// b_mult = 0xFFFFFFFF / (255.0 * 255.0) * .0722 =  4768.88  ~= 4769

    ///

    /// This allows for the following expected behaviour:

    ///    (we only care about the most significant byte)

    /// if pixel = 0x00FFFFFF, pixel' = 0xFF......

    /// if pixel = 0x00020202, pixel' = 0x02......

    ///

    /// if pixel = 0x00000000, pixel' = 0x00......

    #[inline]

    /// Returns the pixel value as a `u32`, in the same format as `cairo::Format::ARgb32`.

    #[inline]

    /// Converts a `u32` in the same format as `cairo::Format::ARgb32` into a `Pixel`.

    #[inline]

}

impl<'a> ImageSurfaceDataExt for cairo::ImageSurfaceData<'a> {

    #[inline]

        // SAFETY: this code assumes that cairo image surface data is correctly

        // aligned for u32. This assumption is justified by the Cairo docs,

        // which say this:

        //

        // https://cairographics.org/manual/cairo-Image-Surfaces.html#cairo-image-surface-create-for-data

        //

        // > This pointer must be suitably aligned for any kind of variable,

        // > (for example, a pointer returned by malloc).

        #[allow(clippy::cast_ptr_alignment)]

}

impl ImageSurfaceDataExt for [u8] {

    #[inline]

}

impl ImageSurfaceDataExt for [u32] {

    #[inline]

}

#[cfg(test)]

mod tests {

    use super::*;

    use proptest::prelude::*;

    #[test]

    // Floating-point reference implementation

    prop_compose! {

        fn arbitrary_pixel()(a: u8, r: u8, g: u8, b: u8) -> Pixel {

            Pixel { r, g, b, a }

        }

    }

    proptest! {

        #[test]

        fn pixel_premultiply(pixel in arbitrary_pixel()) {

            prop_assert_eq!(pixel.premultiply(), premultiply_float(pixel));

        }

        #[test]

        fn pixel_unpremultiply(pixel in arbitrary_pixel()) {

            let roundtrip = pixel.premultiply().unpremultiply();

            if pixel.a == 0 {

                prop_assert_eq!(roundtrip, Pixel::default());

            } else {

                // roundtrip can't be perfect, the accepted error depends on alpha

                let tolerance = 0xff / pixel.a;

                let diff = roundtrip.diff(&pixel);

                prop_assert!(diff.r <= tolerance, "red component value differs by more than {}: {:?}", tolerance, roundtrip);

                prop_assert!(diff.g <= tolerance, "green component value differs by more than {}: {:?}", tolerance, roundtrip);

                prop_assert!(diff.b <= tolerance, "blue component value differs by more than {}: {:?}", tolerance, roundtrip);

                prop_assert_eq!(pixel.a, roundtrip.a);

            }

       }

    }

}