imgfx 0.3.3

Image filtering and modulating with bitwise, arithmetic, and logical operations.
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
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
use crate::utils::{get_channel_by_name_rgb_color, get_channel_by_name_rgba_u8};
use image::{DynamicImage, GenericImageView, ImageBuffer, Rgb, Rgba, RgbaImage};
use rayon::prelude::*;

/// Add blend mode operation.
/// Adds the input color RGB to each pixel's RGB. Overflows.
/// RGB channels are remappable before operation.
/// * `img` - The image::DynamicImage input to perform the operation on.
/// * `lhs` - Optional vector of Strings to remap the order of the channels of the left-hand side.
/// * `rhs` - Optional vector of Strings to remap the order of the channels of the right-hand side.
/// * `color` - Temporarily based on the Clap RgbColor struct. The right-hand side of the operation.
/// * `raw` - bool, if true, allow for u8 overflow, else, clamp at 255.
pub fn add(
    img: DynamicImage,
    lhs: Option<Vec<String>>,
    rhs: Option<Vec<String>>,
    color: Rgb<u8>,
) -> RgbaImage {
    let r = color.0[0];
    let g = color.0[1];
    let b = color.0[2];

    let (width, height) = img.dimensions();

    let mut output: RgbaImage = ImageBuffer::new(width, height);

    let rhs = match rhs {
        Some(rhs) => (
            get_channel_by_name_rgb_color(&rhs[0], &color),
            get_channel_by_name_rgb_color(&rhs[1], &color),
            get_channel_by_name_rgb_color(&rhs[2], &color),
        ),
        None => (r, g, b),
    };

    output.par_enumerate_pixels_mut().for_each(|(x, y, pixel)| {
        let in_pixel = img.get_pixel(x, y);

        let lhs = match lhs {
            Some(ref lhs) => (
                get_channel_by_name_rgba_u8(&lhs[0], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[1], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[2], &in_pixel),
            ),
            None => (in_pixel[0], in_pixel[1], in_pixel[2]),
        };

        let (r, g, b) = {
            let r = (lhs.0 as i32 + rhs.0 as i32).min(255) as u8;
            let g = (lhs.1 as i32 + rhs.1 as i32).min(255) as u8;
            let b = (lhs.2 as i32 + rhs.2 as i32).min(255) as u8;

            (r, g, b)
        };

        let a = in_pixel[3];
        *pixel = Rgba([r, g, b, a]);
    });

    output
}

/// Subtraction blend mode operation.
/// Subtracts the input color RGB from each pixel's RGB.
/// RGB channels are remappable before operation.
/// * `img` - The image::DynamicImage input to perform the operation on.
/// * `lhs` - Optional vector of Strings to remap the order of the channels of the left-hand side.
/// * `rhs` - Optional vector of Strings to remap the order of the channels of the right-hand side.
/// * `color` - Temporarily based on the Clap RgbColor struct. The right-hand side of the operation.
/// * `raw` - bool, if true, allow for u8 underflow, else, get the absolute value of the operation.
pub fn sub(
    img: DynamicImage,
    lhs: Option<Vec<String>>,
    rhs: Option<Vec<String>>,
    color: Rgb<u8>,
    raw: bool,
) -> RgbaImage {
    let r = color.0[0];
    let g = color.0[1];
    let b = color.0[2];

    let (width, height) = img.dimensions();

    let mut output: RgbaImage = ImageBuffer::new(width, height);

    let rhs = match rhs {
        Some(rhs) => (
            get_channel_by_name_rgb_color(&rhs[0], &color),
            get_channel_by_name_rgb_color(&rhs[1], &color),
            get_channel_by_name_rgb_color(&rhs[2], &color),
        ),
        None => (r, g, b),
    };

    output.par_enumerate_pixels_mut().for_each(|(x, y, pixel)| {
        let in_pixel = img.get_pixel(x, y);

        let lhs = match lhs {
            Some(ref lhs) => (
                get_channel_by_name_rgba_u8(&lhs[0], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[1], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[2], &in_pixel),
            ),
            None => (in_pixel[0], in_pixel[1], in_pixel[2]),
        };

        let (r, g, b) = match raw {
            true => {
                let r = lhs.0 - rhs.0;
                let g = lhs.1 - rhs.1;
                let b = lhs.2 - rhs.2;

                (r, g, b)
            }
            false => {
                let r = (lhs.0 as i32 - rhs.0 as i32).abs() as u8;
                let g = (lhs.1 as i32 - rhs.1 as i32).abs() as u8;
                let b = (lhs.2 as i32 - rhs.2 as i32).abs() as u8;

                (r, g, b)
            }
        };

        let a = in_pixel[3];
        *pixel = Rgba([r, g, b, a]);
    });

    output
}

/// Multiplication blend mode operation.
/// Multiplies each pixel's RGB by the RGB of the color param. Overflows.
///
/// This operation often results in images with very extreme color noise and as such will
/// take up significantly more storage than the inputted image. Sometimes up to 36 times larger
/// outputs. It doesn't matter what encoder is used.
///
/// RGB channels are remappable before operation.
/// * `img` - The image::DynamicImage input to perform the operation on.
/// * `lhs` - Optional vector of Strings to remap the order of the channels of the left-hand side.
/// * `rhs` - Optional vector of Strings to remap the order of the channels of the right-hand side.
/// * `color` - Temporarily based on the Clap RgbColor struct. The right-hand side of the operation.
pub fn mult(
    img: DynamicImage,
    lhs: Option<Vec<String>>,
    rhs: Option<Vec<String>>,
    color: Rgb<u8>,
) -> RgbaImage {
    let r = color.0[0];
    let g = color.0[1];
    let b = color.0[2];

    let (width, height) = img.dimensions();

    let mut output: RgbaImage = ImageBuffer::new(width, height);

    let rhs = match rhs {
        Some(rhs) => (
            get_channel_by_name_rgb_color(&rhs[0], &color),
            get_channel_by_name_rgb_color(&rhs[1], &color),
            get_channel_by_name_rgb_color(&rhs[2], &color),
        ),
        None => (r, g, b),
    };

    output.par_enumerate_pixels_mut().for_each(|(x, y, pixel)| {
        let in_pixel = img.get_pixel(x, y);

        let lhs = match lhs {
            Some(ref lhs) => (
                get_channel_by_name_rgba_u8(&lhs[0], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[1], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[2], &in_pixel),
            ),
            None => (in_pixel[0], in_pixel[1], in_pixel[2]),
        };

        let r = lhs.0.wrapping_mul(rhs.0);
        let g = lhs.1.wrapping_mul(rhs.1);
        let b = lhs.2.wrapping_mul(rhs.2);
        let a = in_pixel[3];

        *pixel = Rgba([r, g, b, a]);
    });

    output
}

/// Exponential blend mode operation.
/// Calculates the power of each channel where the image pixel RGB is the base and the color param
/// RGB is the exponent. Overflows.
///
/// This operation often results in images with very extreme color noise and as such will
/// take up significantly more storage than the inputted image. Sometimes up to 36 times larger
/// outputs. It doesn't matter what encoder is used.
///
/// RGB channels are remappable before operation.
/// * `img` - The image::DynamicImage input to perform the operation on.
/// * `lhs` - Optional vector of Strings to remap the order of the channels of the left-hand side.
/// * `rhs` - Optional vector of Strings to remap the order of the channels of the right-hand side.
/// * `color` - Temporarily based on the Clap RgbColor struct. The right-hand side of the operation.
pub fn pow(
    img: DynamicImage,
    lhs: Option<Vec<String>>,
    rhs: Option<Vec<String>>,
    color: Rgb<u8>,
) -> RgbaImage {
    let r = color.0[0];
    let g = color.0[1];
    let b = color.0[2];

    let (width, height) = img.dimensions();

    let mut output: RgbaImage = ImageBuffer::new(width, height);

    let rhs = match rhs {
        Some(rhs) => (
            get_channel_by_name_rgb_color(&rhs[0], &color),
            get_channel_by_name_rgb_color(&rhs[1], &color),
            get_channel_by_name_rgb_color(&rhs[2], &color),
        ),
        None => (r, g, b),
    };

    output.par_enumerate_pixels_mut().for_each(|(x, y, pixel)| {
        let in_pixel = img.get_pixel(x, y);

        let lhs = match lhs {
            Some(ref lhs) => (
                get_channel_by_name_rgba_u8(&lhs[0], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[1], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[2], &in_pixel),
            ),
            None => (in_pixel[0], in_pixel[1], in_pixel[2]),
        };

        let r = lhs.0.wrapping_pow(rhs.0 as u32) as u8;
        let g = lhs.1.wrapping_pow(rhs.1 as u32) as u8;
        let b = lhs.2.wrapping_pow(rhs.2 as u32) as u8;

        let a = in_pixel[3];

        *pixel = Rgba([r, g, b, a]);
    });

    output
}

/// Division blend mode operation.
/// Divides the image pixel RGB by the color param RGB.
///
/// This operation is quite useful for isolating or removing particular colors when used with the
/// lhs remapping.
///
/// RGB channels are remappable before operation.
/// * `img` - The image::DynamicImage input to perform the operation on.
/// * `lhs` - Optional vector of Strings to remap the order of the channels of the left-hand side.
/// * `rhs` - Optional vector of Strings to remap the order of the channels of the right-hand side.
/// * `color` - Temporarily based on the Clap RgbColor struct. The right-hand side of the operation.
pub fn div(
    img: DynamicImage,
    lhs: Option<Vec<String>>,
    rhs: Option<Vec<String>>,
    color: Rgb<u8>,
) -> RgbaImage {
    let r = color.0[0];
    let g = color.0[1];
    let b = color.0[2];

    let (width, height) = img.dimensions();

    let mut output: RgbaImage = ImageBuffer::new(width, height);

    let rhs = match rhs {
        Some(rhs) => (
            get_channel_by_name_rgb_color(&rhs[0], &color),
            get_channel_by_name_rgb_color(&rhs[1], &color),
            get_channel_by_name_rgb_color(&rhs[2], &color),
        ),
        None => (r, g, b),
    };

    output.par_enumerate_pixels_mut().for_each(|(x, y, pixel)| {
        let in_pixel = img.get_pixel(x, y);

        let lhs = match lhs {
            Some(ref lhs) => (
                get_channel_by_name_rgba_u8(&lhs[0], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[1], &in_pixel),
                get_channel_by_name_rgba_u8(&lhs[2], &in_pixel),
            ),
            None => (in_pixel[0], in_pixel[1], in_pixel[2]),
        };

        let r = lhs.0 / rhs.0.max(1);
        let g = lhs.1 / rhs.1.max(1);
        let b = lhs.2 / rhs.2.max(1);
        let a = in_pixel[3];

        *pixel = Rgba([r, g, b, a]);
    });

    output
}

#[cfg(test)]
mod tests {
    use super::*;
    use image::{Pixel, Rgb};
    use std::env;
    use std::path::PathBuf;

    fn get_file_path(file_name: String) -> PathBuf {
        let mut path = env::current_dir().expect("Failed to get current directory");
        path.push("assets/control-images/");
        path.push(file_name);
        path
    }

    fn load_image(file_name: String) -> DynamicImage {
        let path = get_file_path(file_name);
        let img = image::open(path).expect("Failed to open image.");

        img
    }

    fn get_color_from_control(img: DynamicImage) -> Rgb<u8> {
        let pixel = img.get_pixel(0, 0);
        return pixel.to_rgb();
    }

    #[test]
    fn test_add() {
        let red = load_image("ff0000.png".to_string());
        let control_color = get_color_from_control(red.clone());

        let out = add(red.clone(), None, None, Rgb([0, 0, 255]));

        println!(
            "{:?} == {:?}",
            control_color,
            out.get_pixel(0, 0).to_rgb().0
        );

        const EXPECTED: Rgb<u8> = Rgb([255, 0, 255]);

        assert_eq!(out.get_pixel(0, 0).to_rgb(), EXPECTED)
    }

    #[test]
    fn test_sub() {
        let red = load_image("ff0000.png".to_string());
        let control_color = get_color_from_control(red.clone());

        let out = sub(red.clone(), None, None, Rgb([0, 0, 255]), false);

        println!(
            "{:?} == {:?}",
            control_color,
            out.get_pixel(0, 0).to_rgb().0
        );

        const EXPECTED: Rgb<u8> = Rgb([255, 0, 255]);

        assert_eq!(out.get_pixel(0, 0).to_rgb(), EXPECTED)
    }

    #[test]
    fn test_mult() {
        let red = load_image("ff0000.png".to_string());
        let control_color = get_color_from_control(red.clone());

        let out = mult(red.clone(), None, None, Rgb([0, 0, 255]));

        println!(
            "{:?} == {:?}",
            control_color,
            out.get_pixel(0, 0).to_rgb().0
        );

        const EXPECTED: Rgb<u8> = Rgb([0, 0, 0]);

        assert_eq!(out.get_pixel(0, 0).to_rgb(), EXPECTED)
    }

    #[test]
    fn test_div() {
        let red = load_image("ff0000.png".to_string());
        let control_color = get_color_from_control(red.clone());

        let out = div(red.clone(), None, None, Rgb([0, 0, 255]));

        println!(
            "{:?} == {:?}",
            control_color,
            out.get_pixel(0, 0).to_rgb().0
        );

        const EXPECTED: Rgb<u8> = Rgb([255, 0, 0]);

        assert_eq!(out.get_pixel(0, 0).to_rgb(), EXPECTED)
    }
}