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
use std::ops::DerefMut;
use image::{ColorType, DynamicImage, ImageBuffer, Pixel};
use crate::{BufferBlend, BufferGetAlpha, BufferSetAlpha, BufferStripAlpha, Error};
pub trait DynamicChops {
/**
Blend `other` into `self` using the function `op`, where arg 0 is self and 1 is other.
Handles type conversion and alpha channel detection and placement automatically.
If `other` has an alpha channel, it will be used to weight the blending of the color channels. If there is no alpha channel, the blending will be unweighted.
You may blend a luma image into an rgba image (in which case the luma image will be treated as a grayscale rgb image), but you cannot blend an rgba image into a luma image.
If `other` has an alpha channel, the output is weighted by this alpha channel (so if alpha for `other` for this pixel is 0.5, the blend effect will be 0.5 as strong)
# Arguments
Use `apply_to_color` and `apply_to_alpha` to control which channels are affected.
If `apply_to_alpha` is true but `self` or `other` does not have an alpha channel, nothing will happen.
`op` is a function that takes two f64 values and returns a f64 value. (e.g. `|self, other| self + other`)
Standard blend modes such as those found in photoshop are provided as functions (e.g. `pixel_add`, `pixel_mult`, etc.).
The values are normalized to the range 0.0..1.0 before blending, and then scaled back to the input type's range.
The output from `op` is automatically clamped from 0.0..1.0 before being converted back to the input type so you don't need to worry about overflow/underflow.
# Errors
`DimensionMismatch`: `self` and `other` have different dimensions
`UnsupportedBlend`: `self` is a luma image and `other` is an rgb image
# Examples
## Example 1:
Using the `pixel_mult` function to blend two images together:
```
use image::open;
use image_blend::DynamicChops;
use image_blend::pixelops::pixel_mult;
// Load an image
let mut img1_dynamic = open("test_data/1.png").unwrap();
// Load another image
let img2_dynamic = open("test_data/2.png").unwrap();
// Blend the images using the pixel_mult function
img1_dynamic.blend(&img2_dynamic, pixel_mult, true, false).unwrap();
img1_dynamic.save("tests_out/doctest_dynamic_blend_result.png").unwrap();
```
## Example 2:
Using a custom function to blend two images together:
```
use image::open;
use image_blend::DynamicChops;
let closest_to_gray = |a: f64, b: f64| {
let a_diff = (a - 0.5).abs();
let b_diff = (b - 0.5).abs();
if a_diff < b_diff {
a
} else {
b
}
};
// Load an image
let mut img1_dynamic = open("test_data/1.png").unwrap();
// Load another image
let img2_dynamic = open("test_data/2.png").unwrap();
// Blend the images using our custom function
img1_dynamic.blend(&img2_dynamic, closest_to_gray, true, false).unwrap();
img1_dynamic.save("tests_out/doctest_dynamic_custom_result.png").unwrap();
```
*/
fn blend (
&mut self,
other: &Self,
op: fn(f64, f64) -> f64,
apply_to_color: bool,
apply_to_alpha: bool,
) -> Result<(), Error>;
/**
Get the alpha channel of this image as a grayscale with the same number of channels as the input image. (i.e a 4 channel rgba image will return a 3 channel rgba grayscale image)
The alpha channel of the returned image is set to the maximum value of the input type.
If the image does not have an alpha channel, return None.
# Examples
```
use image::open;
use image_blend::DynamicChops;
// Load an image and get its alpha channel
let img1_dynamic = open("test_data/1.png").unwrap();
let img1_alpha = img1_dynamic.get_alpha().unwrap();
img1_alpha.clone().save("tests_out/doctest_dynamic_getalpha_alpha.png").unwrap();
// Load another image and set its alpha channel to the first image's alpha channel, using the copied alpha channel
let mut img2_dynamic = open("test_data/2.png").unwrap();
img2_dynamic.set_alpha(&img1_alpha).unwrap();
img2_dynamic.save("tests_out/doctest_dynamic_getalpha_result.png").unwrap();
```
*/
fn get_alpha(
&self,
) -> Option<Self> where Self: std::marker::Sized;
/**
Set an image's alpha channel from another images alpha channel.
Handles type conversion and alpha channel placement automatically.
# Errors
`NoAlphaChannel`: `self` or `other` does not have an alpha channel
`DimensionMismatch`: `self` and `other` have different dimensions
# Examples
```
use image::open;
use image_blend::DynamicChops;
// Load an image and get its alpha channel
let img1_dynamic = open("test_data/1.png").unwrap();
// Load another image and set its alpha channel to a copy of the first image's alpha channel.
let mut img2_dynamic = open("test_data/2.png").unwrap();
img2_dynamic.transplant_alpha(&img1_dynamic).unwrap();
img2_dynamic.save("tests_out/doctest_dynamic_transplantalpha_result.png").unwrap();
```
*/
fn transplant_alpha(
&mut self,
other: &Self
) -> Result<(), Error>;
/**
Set an image's alpha channel using the grascale color of another image.
Handles type conversion and alpha channel detection and placement automatically.
WARNING: `other` can be of any type, but only the first channel will be used to set the alpha channel.
# Errors
`NoAlphaChannel`: `self` does not have an alpha channel
`DimensionMismatch`: `self` and `other` have different dimensions
# Examples
```
use image::open;
use image_blend::DynamicChops;
// Load an image and get its alpha channel
let img1_dynamic = open("test_data/1.png").unwrap();
let img1_alpha = img1_dynamic.get_alpha().unwrap();
img1_alpha.clone().save("tests_out/doctest_dynamic_setalpha_alpha.png").unwrap();
// Load another image and set its alpha channel to the first image's alpha channel, using the copied alpha channel
let mut img2_dynamic = open("test_data/2.png").unwrap();
img2_dynamic.set_alpha(&img1_alpha).unwrap();
img2_dynamic.save("tests_out/doctest_dynamic_setalpha_result.png").unwrap();
```
*/
fn set_alpha(
&mut self,
other: &Self
) -> Result<(), Error> where Self: std::marker::Sized;
/**
Remove this images alpha channel by setting it to the maximum value for every pixel.
Does not modify the underlying type.
# Errors
`NoAlphaChannel`: `self` or `other` does not have an alpha channel
# Examples
```
use image::open;
use image_blend::{DynamicChops};
// Load an image and remove its alpha channel
let mut img2_dynamic = open("test_data/2.png").unwrap();
img2_dynamic.strip_alpha().unwrap();
img2_dynamic.save("tests_out/doctest_dynamic_stripalpha_result.png").unwrap();
```
*/
fn strip_alpha(
&mut self
) -> Result<(), Error> where Self: std::marker::Sized;
}
impl DynamicChops for DynamicImage {
fn blend (
&mut self,
other: &Self,
op: fn(f64, f64) -> f64,
apply_to_color: bool,
apply_to_alpha: bool,
) -> Result<(), Error> {
match self.color() {
ColorType::L8 => blend_step_a(self.as_mut_luma8().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::La8 => blend_step_a(self.as_mut_luma_alpha8().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgb8 => blend_step_a(self.as_mut_rgb8().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgba8 => blend_step_a(self.as_mut_rgba8().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::L16 => blend_step_a(self.as_mut_luma16().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::La16 => blend_step_a(self.as_mut_luma_alpha16().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgb16 => blend_step_a(self.as_mut_rgb16().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgba16 => blend_step_a(self.as_mut_rgba16().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgb32F => blend_step_a(self.as_mut_rgb32f().unwrap(), other, op, apply_to_color, apply_to_alpha),
ColorType::Rgba32F => blend_step_a(self.as_mut_rgba32f().unwrap(), other, op, apply_to_color, apply_to_alpha),
_ => Err(Error::UnsupportedType),
}
}
fn get_alpha(
&self,
) -> Option<DynamicImage> {
let color = self.color();
let mut copy = self.clone();
match color {
ColorType::L8 => get_alpha_step_a(copy.as_mut_luma8().unwrap()),
ColorType::La8 => get_alpha_step_a(copy.as_mut_luma_alpha8().unwrap()),
ColorType::Rgb8 => get_alpha_step_a(copy.as_mut_rgb8().unwrap()),
ColorType::Rgba8 => get_alpha_step_a(copy.as_mut_rgba8().unwrap()),
ColorType::L16 => get_alpha_step_a(copy.as_mut_luma16().unwrap()),
ColorType::La16 => get_alpha_step_a(copy.as_mut_luma_alpha16().unwrap()),
ColorType::Rgb16 => get_alpha_step_a(copy.as_mut_rgb16().unwrap()),
ColorType::Rgba16 => get_alpha_step_a(copy.as_mut_rgba16().unwrap()),
ColorType::Rgb32F => get_alpha_step_a(copy.as_mut_rgb32f().unwrap()),
ColorType::Rgba32F => get_alpha_step_a(copy.as_mut_rgba32f().unwrap()),
_ => Err(Error::UnsupportedType),
}.ok()?;
Some(copy)
}
fn transplant_alpha(
&mut self,
other: &Self
) -> Result<(), Error> {
match self.color() {
ColorType::L8 => transplant_alpha_step_a(self.as_mut_luma8().unwrap(), other),
ColorType::La8 => transplant_alpha_step_a(self.as_mut_luma_alpha8().unwrap(), other),
ColorType::Rgb8 => transplant_alpha_step_a(self.as_mut_rgb8().unwrap(), other),
ColorType::Rgba8 => transplant_alpha_step_a(self.as_mut_rgba8().unwrap(), other),
ColorType::L16 => transplant_alpha_step_a(self.as_mut_luma16().unwrap(), other),
ColorType::La16 => transplant_alpha_step_a(self.as_mut_luma_alpha16().unwrap(), other),
ColorType::Rgb16 => transplant_alpha_step_a(self.as_mut_rgb16().unwrap(), other),
ColorType::Rgba16 => transplant_alpha_step_a(self.as_mut_rgba16().unwrap(), other),
ColorType::Rgb32F => transplant_alpha_step_a(self.as_mut_rgb32f().unwrap(), other),
ColorType::Rgba32F => transplant_alpha_step_a(self.as_mut_rgba32f().unwrap(), other),
_ => Err(Error::UnsupportedType),
}?;
Ok(())
}
fn set_alpha(
&mut self,
other: &Self
) -> Result<(), Error> {
match self.color() {
ColorType::L8 => set_alpha_step_a(self.as_mut_luma8().unwrap(), other),
ColorType::La8 => set_alpha_step_a(self.as_mut_luma_alpha8().unwrap(), other),
ColorType::Rgb8 => set_alpha_step_a(self.as_mut_rgb8().unwrap(), other),
ColorType::Rgba8 => set_alpha_step_a(self.as_mut_rgba8().unwrap(), other),
ColorType::L16 => set_alpha_step_a(self.as_mut_luma16().unwrap(), other),
ColorType::La16 => set_alpha_step_a(self.as_mut_luma_alpha16().unwrap(), other),
ColorType::Rgb16 => set_alpha_step_a(self.as_mut_rgb16().unwrap(), other),
ColorType::Rgba16 => set_alpha_step_a(self.as_mut_rgba16().unwrap(), other),
ColorType::Rgb32F => set_alpha_step_a(self.as_mut_rgb32f().unwrap(), other),
ColorType::Rgba32F => set_alpha_step_a(self.as_mut_rgba32f().unwrap(), other),
_ => Err(Error::UnsupportedType),
}?;
Ok(())
}
fn strip_alpha(
&mut self
) -> Result<(), Error> where Self: std::marker::Sized {
match self.color() {
ColorType::L8 => self.as_mut_luma8().unwrap().strip_alpha(),
ColorType::La8 => self.as_mut_luma_alpha8().unwrap().strip_alpha(),
ColorType::Rgb8 => self.as_mut_rgb8().unwrap().strip_alpha(),
ColorType::Rgba8 => self.as_mut_rgba8().unwrap().strip_alpha(),
ColorType::L16 => self.as_mut_luma16().unwrap().strip_alpha(),
ColorType::La16 => self.as_mut_luma_alpha16().unwrap().strip_alpha(),
ColorType::Rgb16 => self.as_mut_rgb16().unwrap().strip_alpha(),
ColorType::Rgba16 => self.as_mut_rgba16().unwrap().strip_alpha(),
ColorType::Rgb32F => self.as_mut_rgb32f().unwrap().strip_alpha(),
ColorType::Rgba32F => self.as_mut_rgba32f().unwrap().strip_alpha(),
_ => Err(Error::UnsupportedType),
}?;
Ok(())
}
}
fn blend_step_a<Pmut, ContainerMut>(subject: &mut ImageBuffer<Pmut, ContainerMut>, other: &DynamicImage, op: fn(f64, f64) -> f64, apply_to_color: bool, apply_to_alpha: bool) -> Result<(), Error>
where
Pmut: Pixel,
ContainerMut: DerefMut<Target = [Pmut::Subpixel]>
+ DerefMut<Target = [Pmut::Subpixel]>
+ AsMut<[<Pmut as Pixel>::Subpixel]>
{
match other.color() {
ColorType::L8 => subject.blend(other.as_luma8().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::La8 => subject.blend(other.as_luma_alpha8().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgb8 => subject.blend(other.as_rgb8().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgba8 => subject.blend(other.as_rgba8().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::L16 => subject.blend(other.as_luma16().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::La16 => subject.blend(other.as_luma_alpha16().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgb16 => subject.blend(other.as_rgb16().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgba16 => subject.blend(other.as_rgba16().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgb32F => subject.blend(other.as_rgb32f().unwrap(), op, apply_to_color, apply_to_alpha),
ColorType::Rgba32F => subject.blend(other.as_rgba32f().unwrap(), op, apply_to_color, apply_to_alpha),
_ => Err(Error::UnsupportedType),
}
}
fn get_alpha_step_a<P, Container>(subject: &mut ImageBuffer<P, Container>) -> Result<(), Error>
where
P: Pixel,
Container: DerefMut<Target = [P::Subpixel]> + AsRef<[<P as image::Pixel>::Subpixel]> + Clone,
{
let alpha = subject.get_alpha().ok_or(Error::NoAlphaChannel)?;
*subject = alpha;
Ok(())
}
fn set_alpha_step_a<Pmut, ContainerMut>(subject: &mut ImageBuffer<Pmut, ContainerMut>, other: &DynamicImage) -> Result<(), Error>
where
Pmut: Pixel,
ContainerMut: DerefMut<Target = [Pmut::Subpixel]>
+ DerefMut<Target = [Pmut::Subpixel]>
+ AsMut<[<Pmut as Pixel>::Subpixel]>
{
match other.color() {
ColorType::L8 => subject.set_alpha(other.as_luma8().unwrap()),
ColorType::La8 => subject.set_alpha(other.as_luma_alpha8().unwrap()),
ColorType::Rgb8 => subject.set_alpha(other.as_rgb8().unwrap()),
ColorType::Rgba8 => subject.set_alpha(other.as_rgba8().unwrap()),
ColorType::L16 => subject.set_alpha(other.as_luma16().unwrap()),
ColorType::La16 => subject.set_alpha(other.as_luma_alpha16().unwrap()),
ColorType::Rgb16 => subject.set_alpha(other.as_rgb16().unwrap()),
ColorType::Rgba16 => subject.set_alpha(other.as_rgba16().unwrap()),
ColorType::Rgb32F => subject.set_alpha(other.as_rgb32f().unwrap()),
ColorType::Rgba32F => subject.set_alpha(other.as_rgba32f().unwrap()),
_ => Err(Error::UnsupportedType),
}
}
fn transplant_alpha_step_a<Pmut, ContainerMut>(subject: &mut ImageBuffer<Pmut, ContainerMut>, other: &DynamicImage) -> Result<(), Error>
where
Pmut: Pixel,
ContainerMut: DerefMut<Target = [Pmut::Subpixel]>
+ DerefMut<Target = [Pmut::Subpixel]>
+ AsMut<[<Pmut as Pixel>::Subpixel]>,
{
match other.color() {
ColorType::L8 => subject.transplant_alpha(other.as_luma8().unwrap()),
ColorType::La8 => subject.transplant_alpha(other.as_luma_alpha8().unwrap()),
ColorType::Rgb8 => subject.transplant_alpha(other.as_rgb8().unwrap()),
ColorType::Rgba8 => subject.transplant_alpha(other.as_rgba8().unwrap()),
ColorType::L16 => subject.transplant_alpha(other.as_luma16().unwrap()),
ColorType::La16 => subject.transplant_alpha(other.as_luma_alpha16().unwrap()),
ColorType::Rgb16 => subject.transplant_alpha(other.as_rgb16().unwrap()),
ColorType::Rgba16 => subject.transplant_alpha(other.as_rgba16().unwrap()),
ColorType::Rgb32F => subject.transplant_alpha(other.as_rgb32f().unwrap()),
ColorType::Rgba32F => subject.transplant_alpha(other.as_rgba32f().unwrap()),
_ => Err(Error::UnsupportedType),
}
}