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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
// hsv.rs HSV color model // // Copyright (c) 2019-2020 Jeron Aldaron Lau // Copyright (c) 2020 Douglas P Lau // //! [HSV] color model and types. //! //! [hsv]: https://en.wikipedia.org/wiki/HSL_and_HSV use crate::chan::{ Ch16, Ch32, Ch8, Channel, Linear, Premultiplied, Srgb, Straight, }; use crate::el::{Pix3, Pix4, PixRgba, Pixel}; use crate::hue::{rgb_to_hue_chroma_value, Hexcone}; use crate::ColorModel; use std::ops::Range; /// [HSV] hexcone [color model], also known as HSB. /// /// The components are *[hue]*, *[saturation]*, *[value]* (or *brightness*) and /// optional *[alpha]*. /// /// [alpha]: ../el/trait.Pixel.html#method.alpha /// [color model]: ../trait.ColorModel.html /// [hue]: #method.hue /// [hsv]: https://en.wikipedia.org/wiki/HSL_and_HSV /// [saturation]: #method.saturation /// [value]: #method.value #[derive(Clone, Copy, Debug, Default, PartialEq)] pub struct Hsv {} impl Hsv { /// Get the *hue* component. /// /// *Hue* is divided into 6 equal intervals arranged into a circle of /// degrees: /// /// * 0: Red /// * 60: Yellow /// * 120: Green /// * 180: Cyan /// * 240: Blue /// * 300: Magenta /// /// The degrees are mapped from [Channel::MIN] (0) to [Channel::MAX] (360) /// /// # Example: HSV Hue /// ``` /// use pix::chan::Ch32; /// use pix::hsv::{Hsv, Hsv32}; /// /// let p = Hsv32::new(0.25, 0.5, 1.0); /// assert_eq!(Hsv::hue(p), Ch32::new(0.25)); /// ``` /// [Channel::MIN]: ../chan/trait.Channel.html#associatedconstant.MIN /// [Channel::MAX]: ../chan/trait.Channel.html#associatedconstant.MAX pub fn hue<P: Pixel>(p: P) -> P::Chan where P: Pixel<Model = Self>, { p.one() } /// Get a mutable reference to the *hue* component. /// /// # Example: Modify HSV Hue /// ``` /// use pix::chan::{Ch32, Channel}; /// use pix::hsv::{Hsv, Hsv32}; /// /// let mut p = Hsv32::new(0.2, 0.75, 0.5); /// let mut h = Hsv::hue_mut(&mut p); /// *h = h.wrapping_sub(Ch32::new(0.4)); /// assert_eq!(Hsv::hue(p), Ch32::new(0.8)); /// ``` pub fn hue_mut<P: Pixel>(p: &mut P) -> &mut P::Chan where P: Pixel<Model = Self>, { p.one_mut() } /// Get the *saturation* component. /// /// Lower values are more gray (desaturated), while higher values are more /// colorful. NOTE: HSV saturation is slightly different from [HSL] /// saturation. /// /// # Example: HSV Saturation /// ``` /// use pix::chan::Ch16; /// use pix::hsv::{Hsv, Hsv16}; /// /// let p = Hsv16::new(0x2000, 0x1234, 0x8000); /// assert_eq!(Hsv::saturation(p), Ch16::new(0x1234)); /// ``` /// [hsl]: struct.Hsl.html pub fn saturation<P: Pixel>(p: P) -> P::Chan where P: Pixel<Model = Self>, { p.two() } /// Get a mutable reference to the *saturation* component. /// /// # Example: Modify HSV Saturation /// ``` /// use pix::chan::Ch16; /// use pix::hsv::{Hsv, Hsv16}; /// /// let mut p = Hsv16::new(0x2000, 0x1234, 0x8000); /// *Hsv::saturation_mut(&mut p) = Ch16::new(0x4321); /// assert_eq!(Hsv::saturation(p), Ch16::new(0x4321)); /// ``` pub fn saturation_mut<P: Pixel>(p: &mut P) -> &mut P::Chan where P: Pixel<Model = Self>, { p.two_mut() } /// Get the *value* (or *brightness*) component. /// /// Lower values are closer to *black*, while higher values are closer to /// fully bright colors. /// /// # Example: HSV Value /// ``` /// use pix::chan::Ch8; /// use pix::hsv::{Hsv, Hsv8}; /// /// let p = Hsv8::new(0x93, 0x80, 0xA0); /// assert_eq!(Hsv::value(p), Ch8::new(0xA0)); /// ``` pub fn value<P: Pixel>(p: P) -> P::Chan where P: Pixel<Model = Self>, { p.three() } /// Get a mutable reference to the *value* component. /// /// # Example: Modify HSV Value /// ``` /// use pix::chan::Ch8; /// use pix::hsv::{Hsv, Hsv8}; /// /// let mut p = Hsv8::new(0x93, 0x80, 0xA0); /// *Hsv::value_mut(&mut p) = Ch8::new(0xBB); /// assert_eq!(Hsv::value(p), Ch8::new(0xBB)); /// ``` pub fn value_mut<P: Pixel>(p: &mut P) -> &mut P::Chan where P: Pixel<Model = Self>, { p.three_mut() } } impl ColorModel for Hsv { const CIRCULAR: Range<usize> = 0..1; const LINEAR: Range<usize> = 1..3; const ALPHA: usize = 3; /// Convert into *red*, *green*, *blue* and *alpha* components fn into_rgba<P>(p: P) -> PixRgba<P> where P: Pixel<Model = Self>, { let v = Self::value(p); let chroma = v * Self::saturation(p); let hp = Self::hue(p).to_f32() * 6.0; // 0.0..=6.0 let hc = Hexcone::from_hue_prime(hp); let (red, green, blue) = hc.rgb(chroma); let m = v - chroma; PixRgba::<P>::new::<P::Chan>(red + m, green + m, blue + m, p.alpha()) } /// Convert from *red*, *green*, *blue* and *alpha* components fn from_rgba<P>(rgba: PixRgba<P>) -> P where P: Pixel<Model = Self>, { let chan = rgba.channels(); let red = chan[0]; let green = chan[1]; let blue = chan[2]; let alpha = chan[3]; let (hue, chroma, val) = rgb_to_hue_chroma_value(red, green, blue); let sat_v = chroma / val; P::from_channels(&[hue, sat_v, val, alpha]) } } /// [Hsv](struct.Hsv.html) 8-bit opaque (no *alpha* channel) /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsv8 = Pix3<Ch8, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 16-bit opaque (no *alpha* channel) /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsv16 = Pix3<Ch16, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 32-bit opaque (no *alpha* channel) /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsv32 = Pix3<Ch32, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 8-bit [straight](../chan/struct.Straight.html) /// alpha [linear](../chan/struct.Linear.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type Hsva8 = Pix4<Ch8, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 16-bit [straight](../chan/struct.Straight.html) /// alpha [linear](../chan/struct.Linear.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type Hsva16 = Pix4<Ch16, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 32-bit [straight](../chan/struct.Straight.html) /// alpha [linear](../chan/struct.Linear.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type Hsva32 = Pix4<Ch32, Hsv, Straight, Linear>; /// [Hsv](struct.Hsv.html) 8-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsva8p = Pix4<Ch8, Hsv, Premultiplied, Linear>; /// [Hsv](struct.Hsv.html) 16-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsva16p = Pix4<Ch16, Hsv, Premultiplied, Linear>; /// [Hsv](struct.Hsv.html) 32-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [linear](../chan/struct.Linear.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type Hsva32p = Pix4<Ch32, Hsv, Premultiplied, Linear>; /// [Hsv](struct.Hsv.html) 8-bit opaque (no *alpha* channel) /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsv8 = Pix3<Ch8, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 16-bit opaque (no *alpha* channel) /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsv16 = Pix3<Ch16, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 32-bit opaque (no *alpha* channel) /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsv32 = Pix3<Ch32, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 8-bit [straight](../chan/struct.Straight.html) /// alpha [sRGB](../chan/struct.Srgb.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type SHsva8 = Pix4<Ch8, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 16-bit [straight](../chan/struct.Straight.html) /// alpha [sRGB](../chan/struct.Srgb.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type SHsva16 = Pix4<Ch16, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 32-bit [straight](../chan/struct.Straight.html) /// alpha [sRGB](../chan/struct.Srgb.html) gamma /// [pixel](../el/trait.Pixel.html) format. pub type SHsva32 = Pix4<Ch32, Hsv, Straight, Srgb>; /// [Hsv](struct.Hsv.html) 8-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsva8p = Pix4<Ch8, Hsv, Premultiplied, Srgb>; /// [Hsv](struct.Hsv.html) 16-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsva16p = Pix4<Ch16, Hsv, Premultiplied, Srgb>; /// [Hsv](struct.Hsv.html) 32-bit /// [premultiplied](../chan/struct.Premultiplied.html) alpha /// [sRGB](../chan/struct.Srgb.html) gamma [pixel](../el/trait.Pixel.html) /// format. pub type SHsva32p = Pix4<Ch32, Hsv, Premultiplied, Srgb>; #[cfg(test)] mod test { use crate::el::Pixel; use crate::hsv::*; use crate::ops::*; use crate::rgb::*; #[test] fn hsv_to_rgb() { assert_eq!(Rgb8::new(255, 0, 0), Hsv8::new(0, 255, 255).convert()); assert_eq!( Rgb8::new(255, 255, 0), Hsv32::new(60.0 / 360.0, 1.0, 1.0).convert(), ); assert_eq!( Rgb8::new(0, 255, 0), Hsv16::new(21845, 65535, 65535).convert(), ); assert_eq!(Rgb8::new(0, 255, 255), Hsv32::new(0.5, 1.0, 1.0).convert()); assert_eq!( Rgb8::new(0, 0, 255), Hsv32::new(240.0 / 360.0, 1.0, 1.0).convert(), ); assert_eq!( Rgb8::new(255, 0, 255), Hsv32::new(300.0 / 360.0, 1.0, 1.0).convert(), ); } #[test] fn hsv_to_rgb_unsat() { assert_eq!(Rgb8::new(255, 127, 127), Hsv8::new(0, 128, 255).convert()); assert_eq!( Rgb8::new(255, 255, 128), Hsv32::new(60.0 / 360.0, 0.5, 1.0).convert(), ); assert_eq!( Rgb8::new(127, 255, 127), Hsv16::new(21845, 32768, 65535).convert(), ); assert_eq!( Rgb8::new(128, 255, 255), Hsv32::new(180.0 / 360.0, 0.5, 1.0).convert(), ); assert_eq!( Rgb8::new(128, 128, 255), Hsv32::new(240.0 / 360.0, 0.5, 1.0).convert(), ); assert_eq!( Rgb8::new(255, 128, 255), Hsv32::new(300.0 / 360.0, 0.5, 1.0).convert(), ); } #[test] fn hsv_to_rgb_dark() { assert_eq!(Rgb8::new(128, 0, 0), Hsv8::new(0, 255, 128).convert()); assert_eq!( Rgb8::new(128, 128, 0), Hsv32::new(60.0 / 360.0, 1.0, 0.5).convert(), ); assert_eq!( Rgb8::new(0, 128, 0), Hsv16::new(21845, 65535, 32768).convert(), ); assert_eq!( Rgb8::new(0, 128, 128), Hsv32::new(180.0 / 360.0, 1.0, 0.5).convert(), ); assert_eq!( Rgb8::new(0, 0, 128), Hsv32::new(240.0 / 360.0, 1.0, 0.5).convert(), ); assert_eq!( Rgb8::new(128, 0, 128), Hsv32::new(300.0 / 360.0, 1.0, 0.5).convert(), ); } #[test] fn hsv_to_rgb_hue() { assert_eq!(Rgb8::new(255, 192, 0), Hsv8::new(32, 255, 255).convert()); assert_eq!(Rgb8::new(126, 255, 0), Hsv8::new(64, 255, 255).convert()); assert_eq!(Rgb8::new(0, 255, 66), Hsv8::new(96, 255, 255).convert()); assert_eq!(Rgb8::new(0, 60, 255), Hsv8::new(160, 255, 255).convert()); assert_eq!(Rgb8::new(132, 0, 255), Hsv8::new(192, 255, 255).convert()); assert_eq!(Rgb8::new(255, 0, 186), Hsv8::new(224, 255, 255).convert()); } #[test] fn hsv_to_rgb_grays() { assert_eq!(Rgb8::new(255, 255, 255), Hsv8::new(0, 0, 255).convert()); assert_eq!(Rgb8::new(128, 128, 128), Hsv8::new(100, 0, 128).convert()); assert_eq!(Hsv8::new(0, 0, 255), Rgb8::new(255, 255, 255).convert()); assert_eq!(Hsv8::new(0, 0, 128), Rgb8::new(128, 128, 128).convert()); } #[test] fn rgb_to_hsv() { assert_eq!(Hsv8::new(0, 255, 255), Rgb8::new(255, 0, 0).convert()); assert_eq!( Hsv32::new(60.0 / 360.0, 1.0, 1.0), Rgb8::new(255, 255, 0).convert(), ); assert_eq!( Hsv16::new(21845, 65535, 65535), Rgb8::new(0, 255, 0).convert(), ); assert_eq!(Hsv32::new(0.5, 1.0, 1.0), Rgb8::new(0, 255, 255).convert()); assert_eq!( Hsv32::new(240.0 / 360.0, 1.0, 1.0), Rgb8::new(0, 0, 255).convert(), ); assert_eq!( Hsv32::new(300.0 / 360.0, 1.0, 1.0), Rgb8::new(255, 0, 255).convert(), ); } #[test] fn rgb_to_hsv_unsat() { assert_eq!(Hsv8::new(0, 128, 255), Rgb8::new(255, 127, 127).convert()); assert_eq!(Hsv8::new(42, 128, 255), Rgb8::new(255, 255, 127).convert()); assert_eq!(Hsv8::new(85, 127, 255), Rgb8::new(128, 255, 128).convert()); assert_eq!( Hsv8::new(128, 127, 255), Rgb8::new(128, 255, 255).convert() ); assert_eq!( Hsv8::new(170, 127, 255), Rgb8::new(128, 128, 255).convert(), ); assert_eq!( Hsv8::new(213, 127, 255), Rgb8::new(255, 128, 255).convert(), ); } #[test] fn composite_hsv() { let mut a = Hsva8p::new(0, 64, 64, 128); a.composite_channels(&Hsva8p::new(32, 128, 64, 128), SrcOver); assert_eq!(a, Hsva8p::new(16, 159, 95, 191)); } }