quantette 0.6.0

Fast and high quality image quantization and palette generation.
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

#[cfg(feature = "kmeans")]
use crate::kmeans::KmeansOptions;
use crate::{CreatePaletteBufError, PaletteBuf, PaletteInColorSpace};
use alloc::vec::Vec;
use palette::{Oklab, Srgb};

/// The set of supported color quantization methods.
///
/// If the `kmeans` feature is enabled, then support will be added for that method.
/// Otherwise, only Wu's color quantization method and custom palettes are supported.
///
/// See the descriptions on each enum variant for more information.
#[derive(Debug, Clone, PartialEq)]
pub enum QuantizeMethod {
    /// Quantize an image into a custom color palette.
    ///
    /// This method will simply map each pixel to its closest color in the palette.
    CustomPalette(PaletteInColorSpace),
    /// Wu's color quantizer (Greedy Orthogonal Bipartitioning).
    ///
    /// This method is quick and gives good or at least decent results.
    ///
    /// See the [`wu`](crate::wu) module for more details.
    Wu,
    #[cfg(feature = "kmeans")]
    /// Color quantization using k-means clustering.
    ///
    /// This method is slower than Wu's color quantizer but gives more accurate results.
    ///
    /// See the [`kmeans`](crate::kmeans) module for more details.
    Kmeans(KmeansOptions),
}

impl QuantizeMethod {
    #[cfg(feature = "kmeans")]
    /// Create a new [`QuantizeMethod::Kmeans`] with the default [`KmeansOptions`].
    #[must_use]
    pub const fn kmeans() -> Self {
        Self::Kmeans(KmeansOptions::new())
    }
}

impl From<PaletteInColorSpace> for QuantizeMethod {
    #[inline]
    fn from(palette: PaletteInColorSpace) -> Self {
        Self::CustomPalette(palette)
    }
}

impl From<PaletteBuf<Srgb<u8>>> for QuantizeMethod {
    #[inline]
    fn from(palette: PaletteBuf<Srgb<u8>>) -> Self {
        Self::CustomPalette(palette.into())
    }
}

impl From<PaletteBuf<Oklab>> for QuantizeMethod {
    #[inline]
    fn from(palette: PaletteBuf<Oklab>) -> Self {
        Self::CustomPalette(palette.into())
    }
}

#[cfg(feature = "kmeans")]
impl From<KmeansOptions> for QuantizeMethod {
    #[inline]
    fn from(options: KmeansOptions) -> Self {
        Self::Kmeans(options)
    }
}

impl TryFrom<Vec<Srgb<u8>>> for QuantizeMethod {
    type Error = CreatePaletteBufError<Srgb<u8>>;

    #[inline]
    fn try_from(colors: Vec<Srgb<u8>>) -> Result<Self, Self::Error> {
        PaletteBuf::try_from(colors).map(Into::into)
    }
}

impl TryFrom<Vec<Oklab>> for QuantizeMethod {
    type Error = CreatePaletteBufError<Oklab>;

    #[inline]
    fn try_from(colors: Vec<Oklab>) -> Result<Self, Self::Error> {
        PaletteBuf::try_from(colors).map(Into::into)
    }
}