ditherlib 0.2.0

Non-destructive image effects and dithering for whole images and polygon selections
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use crate::{DitherError, ErrorKind, Result};

const SAMPLES_PER_AXIS: u32 = 4;
const SAMPLE_COUNT: u32 = SAMPLES_PER_AXIS * SAMPLES_PER_AXIS;

/// A point in image coordinates, with the origin at the top-left corner.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Point {
    /// The horizontal coordinate.
    pub x: f32,
    /// The vertical coordinate.
    pub y: f32,
}

impl Point {
    /// Creates a point at `(x, y)`.
    pub const fn new(x: f32, y: f32) -> Self {
        Self { x, y }
    }
}

/// A polygon selection boundary.
///
/// Polygons use the even-odd fill rule, so self-intersecting paths are valid.
/// Points on a polygon edge are considered inside.
#[derive(Clone, Debug, PartialEq)]
pub struct Polygon {
    vertices: Box<[Point]>,
}

impl Polygon {
    /// Creates a polygon from at least three finite, non-collinear vertices.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::InvalidPolygon`] when there are fewer than three
    /// vertices, a coordinate is non-finite, or all vertices are collinear.
    pub fn new(vertices: impl Into<Box<[Point]>>) -> Result<Self> {
        let vertices = vertices.into();

        if vertices.len() < 3 {
            return Err(DitherError::new(
                ErrorKind::InvalidPolygon,
                "a polygon requires at least three vertices",
            ));
        }

        if vertices
            .iter()
            .any(|point| !point.x.is_finite() || !point.y.is_finite())
        {
            return Err(DitherError::new(
                ErrorKind::InvalidPolygon,
                "polygon coordinates must be finite",
            ));
        }

        if vertices_are_collinear(&vertices) {
            return Err(DitherError::new(
                ErrorKind::InvalidPolygon,
                "polygon vertices must enclose an area",
            ));
        }

        Ok(Self { vertices })
    }

    /// Returns the polygon's vertices.
    pub fn vertices(&self) -> &[Point] {
        &self.vertices
    }
}

/// An area of an image to which an effect can be applied.
#[derive(Clone, Debug, PartialEq)]
pub enum Selection {
    /// Selects every pixel.
    All,
    /// Selects the area covered by a polygon.
    Polygon(Polygon),
}

impl Selection {
    /// Rasterises this selection into a mask with the requested dimensions.
    ///
    /// Polygon coverage uses a fixed 4 by 4 subpixel grid. Each mask value is
    /// `0` outside the selection, `255` inside it, or an intermediate coverage
    /// value along an anti-aliased edge.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::DimensionMismatch`] when the dimensions cannot be
    /// represented by a mask on the current platform.
    pub fn rasterise(&self, width: u32, height: u32) -> Result<Mask> {
        let length = mask_length(width, height)?;

        match self {
            Self::All => Ok(Mask {
                width,
                height,
                coverage: vec![u8::MAX; length].into_boxed_slice(),
                coverage_bounds: (length > 0).then_some((0, 0, width, height)),
            }),
            Self::Polygon(polygon) => {
                let mut coverage = vec![0; length];
                let coverage_bounds = rasterise_polygon(polygon, width, height, &mut coverage);

                Ok(Mask {
                    width,
                    height,
                    coverage: coverage.into_boxed_slice(),
                    coverage_bounds,
                })
            }
        }
    }
}

/// Per-pixel selection coverage for an image.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Mask {
    width: u32,
    height: u32,
    coverage: Box<[u8]>,
    coverage_bounds: Option<(u32, u32, u32, u32)>,
}

impl Mask {
    /// Creates a mask from row-major coverage values.
    ///
    /// # Errors
    ///
    /// Returns [`ErrorKind::DimensionMismatch`] when the number of values does
    /// not equal `width * height` or the dimensions exceed platform limits.
    pub fn new(width: u32, height: u32, coverage: Vec<u8>) -> Result<Self> {
        if coverage.len() != mask_length(width, height)? {
            return Err(DitherError::new(
                ErrorKind::DimensionMismatch,
                "mask dimensions do not match its coverage length",
            ));
        }

        let coverage_bounds = find_coverage_bounds(width, &coverage);

        Ok(Self {
            width,
            height,
            coverage: coverage.into_boxed_slice(),
            coverage_bounds,
        })
    }

    /// Returns the mask width in pixels.
    pub const fn width(&self) -> u32 {
        self.width
    }

    /// Returns the mask height in pixels.
    pub const fn height(&self) -> u32 {
        self.height
    }

    /// Returns the mask dimensions as `(width, height)`.
    pub const fn dimensions(&self) -> (u32, u32) {
        (self.width, self.height)
    }

    /// Returns the row-major coverage values.
    pub fn coverage_bytes(&self) -> &[u8] {
        &self.coverage
    }

    /// Returns the coverage at `(x, y)`, or `None` when it is out of bounds.
    pub fn coverage(&self, x: u32, y: u32) -> Option<u8> {
        if x >= self.width || y >= self.height {
            return None;
        }

        Some(self.coverage[y as usize * self.width as usize + x as usize])
    }

    /// Returns the smallest exclusive pixel bounds containing non-zero coverage.
    pub(crate) fn coverage_bounds(&self) -> Option<(u32, u32, u32, u32)> {
        self.coverage_bounds
    }
}

/// Finds the smallest exclusive pixel bounds containing non-zero coverage.
fn find_coverage_bounds(width: u32, coverage: &[u8]) -> Option<(u32, u32, u32, u32)> {
    let mut bounds = None;

    for (index, &coverage) in coverage.iter().enumerate() {
        if coverage != 0 {
            let x = (index % width as usize) as u32;
            let y = (index / width as usize) as u32;
            include_pixel(&mut bounds, x, y);
        }
    }

    bounds
}

/// Calculates the number of coverage values required for a mask.
fn mask_length(width: u32, height: u32) -> Result<usize> {
    let length = u64::from(width) * u64::from(height);

    if length > isize::MAX as u64 {
        return Err(DitherError::new(
            ErrorKind::DimensionMismatch,
            "mask dimensions exceed platform limits",
        ));
    }

    Ok(length as usize)
}

/// Reports whether every vertex lies on a single straight line.
fn vertices_are_collinear(vertices: &[Point]) -> bool {
    let first = vertices[0];
    let Some(second) = vertices.iter().copied().find(|point| *point != first) else {
        return true;
    };

    vertices.iter().all(|point| {
        let cross = f64::from(second.x - first.x) * f64::from(point.y - first.y)
            - f64::from(second.y - first.y) * f64::from(point.x - first.x);
        cross == 0.0
    })
}

/// Rasterises a polygon and returns its non-zero exclusive coverage bounds.
fn rasterise_polygon(
    polygon: &Polygon,
    width: u32,
    height: u32,
    coverage: &mut [u8],
) -> Option<(u32, u32, u32, u32)> {
    let (min_x, min_y, max_x, max_y) = polygon_pixel_bounds(polygon, width, height);
    if min_x == max_x || min_y == max_y {
        return None;
    }
    let mut coverage_bounds = None;
    let mut crossings = Vec::with_capacity(polygon.vertices.len());
    let mut boundary_edges = Vec::with_capacity(polygon.vertices.len());

    for y in min_y..max_y {
        let row_start = y as usize * width as usize;
        let row = &mut coverage[row_start + min_x as usize..row_start + max_x as usize];

        for sample_y in 0..SAMPLES_PER_AXIS {
            let sample_y = y as f32 + (sample_y as f32 + 0.5) / SAMPLES_PER_AXIS as f32;
            // Every horizontal sample shares these crossings and possible boundary edges.
            crossings.clear();
            boundary_edges.clear();
            let mut previous = polygon.vertices[polygon.vertices.len() - 1];

            for &current in &polygon.vertices {
                if sample_y >= previous.y.min(current.y) && sample_y <= previous.y.max(current.y) {
                    boundary_edges.push((previous, current));
                }
                if (current.y > sample_y) != (previous.y > sample_y) {
                    crossings.push(
                        (previous.x - current.x) * (sample_y - current.y)
                            / (previous.y - current.y)
                            + current.x,
                    );
                }
                previous = current;
            }

            for (offset, covered_samples) in row.iter_mut().enumerate() {
                let x = min_x + offset as u32;
                for sample_x in 0..SAMPLES_PER_AXIS {
                    let point = Point {
                        x: x as f32 + (sample_x as f32 + 0.5) / SAMPLES_PER_AXIS as f32,
                        y: sample_y,
                    };

                    if boundary_edges
                        .iter()
                        .any(|&(start, end)| point_is_on_segment(point, start, end))
                        || crossings
                            .iter()
                            .fold(false, |inside, &crossing| inside ^ (point.x < crossing))
                    {
                        *covered_samples += 1;
                    }
                }
            }
        }

        for (offset, value) in row.iter_mut().enumerate() {
            *value =
                ((u32::from(*value) * u32::from(u8::MAX) + SAMPLE_COUNT / 2) / SAMPLE_COUNT) as u8;

            if *value != 0 {
                include_pixel(&mut coverage_bounds, min_x + offset as u32, y);
            }
        }
    }

    coverage_bounds
}

/// Expands exclusive bounds to contain a pixel.
fn include_pixel(bounds: &mut Option<(u32, u32, u32, u32)>, x: u32, y: u32) {
    *bounds = Some(match *bounds {
        Some((min_x, min_y, max_x, max_y)) => (
            min_x.min(x),
            min_y.min(y),
            max_x.max(x + 1),
            max_y.max(y + 1),
        ),
        None => (x, y, x + 1, y + 1),
    });
}

/// Finds the exclusive image bounds that can overlap a polygon.
fn polygon_pixel_bounds(polygon: &Polygon, width: u32, height: u32) -> (u32, u32, u32, u32) {
    let mut min_x = f32::INFINITY;
    let mut min_y = f32::INFINITY;
    let mut max_x = f32::NEG_INFINITY;
    let mut max_y = f32::NEG_INFINITY;

    for point in &polygon.vertices {
        min_x = min_x.min(point.x);
        min_y = min_y.min(point.y);
        max_x = max_x.max(point.x);
        max_y = max_y.max(point.y);
    }

    (
        min_x.floor().clamp(0.0, width as f32) as u32,
        min_y.floor().clamp(0.0, height as f32) as u32,
        max_x.ceil().clamp(0.0, width as f32) as u32,
        max_y.ceil().clamp(0.0, height as f32) as u32,
    )
}

/// Retains the original per-point calculation as an independent rasterisation oracle.
#[cfg(test)]
fn polygon_contains(polygon: &Polygon, point: Point) -> bool {
    let mut inside = false;
    let mut previous = polygon.vertices[polygon.vertices.len() - 1];

    for &current in &polygon.vertices {
        let cross = (point.y - previous.y) * (current.x - previous.x)
            - (point.x - previous.x) * (current.y - previous.y);
        if cross.abs() <= f32::EPSILON
            && point.x >= previous.x.min(current.x)
            && point.x <= previous.x.max(current.x)
            && point.y >= previous.y.min(current.y)
            && point.y <= previous.y.max(current.y)
        {
            return true;
        }

        if (current.y > point.y) != (previous.y > point.y)
            && point.x
                < (previous.x - current.x) * (point.y - current.y) / (previous.y - current.y)
                    + current.x
        {
            inside = !inside;
        }

        previous = current;
    }

    inside
}

/// Reports whether a point lies on the closed line segment from start to end.
fn point_is_on_segment(point: Point, start: Point, end: Point) -> bool {
    if point.x < start.x.min(end.x)
        || point.x > start.x.max(end.x)
        || point.y < start.y.min(end.y)
        || point.y > start.y.max(end.y)
    {
        return false;
    }
    let cross = (point.y - start.y) * (end.x - start.x) - (point.x - start.x) * (end.y - start.y);

    cross.abs() <= f32::EPSILON
}

#[cfg(test)]
mod tests {
    use super::{Mask, Point, Polygon, SAMPLE_COUNT, SAMPLES_PER_AXIS, Selection};
    use crate::ErrorKind;

    #[test]
    fn rasterises_the_whole_image() {
        let mask = Selection::All.rasterise(3, 2).unwrap();

        assert_eq!(mask.width(), 3);
        assert_eq!(mask.height(), 2);
        assert_eq!(mask.dimensions(), (3, 2));
        assert_eq!(mask.coverage_bytes(), &[255; 6]);
        assert_eq!(mask.coverage(2, 1), Some(255));
        assert_eq!(mask.coverage(3, 1), None);
    }

    #[test]
    fn rasterises_polygon_interiors_exteriors_and_edges() {
        let polygon = Polygon::new([
            Point::new(0.0, 0.0),
            Point::new(4.0, 0.0),
            Point::new(0.0, 4.0),
        ])
        .unwrap();
        let mask = Selection::Polygon(polygon).rasterise(4, 4).unwrap();

        assert_eq!(mask.dimensions(), (4, 4));
        assert_eq!(mask.coverage(0, 0), Some(255));
        assert!(
            mask.coverage(3, 0)
                .is_some_and(|coverage| coverage > 0 && coverage < 255)
        );
        assert_eq!(mask.coverage(3, 3), Some(0));
    }

    #[test]
    fn rejects_malformed_polygons() {
        let too_short = Polygon::new([Point::new(0.0, 0.0), Point::new(1.0, 1.0)])
            .expect_err("two vertices should be rejected");
        assert_eq!(too_short.kind(), ErrorKind::InvalidPolygon);

        let non_finite = Polygon::new([
            Point::new(0.0, 0.0),
            Point::new(1.0, f32::NAN),
            Point::new(0.0, 1.0),
        ])
        .expect_err("non-finite coordinates should be rejected");
        assert_eq!(non_finite.kind(), ErrorKind::InvalidPolygon);

        let collinear = Polygon::new([
            Point::new(0.0, 0.0),
            Point::new(1.0, 1.0),
            Point::new(2.0, 2.0),
        ])
        .expect_err("collinear vertices should be rejected");
        assert_eq!(collinear.kind(), ErrorKind::InvalidPolygon);
    }

    #[test]
    fn rejects_mask_dimension_mismatches() {
        let error = Mask::new(2, 2, vec![0; 3]).expect_err("three values cannot fill a 2x2 mask");
        assert_eq!(error.kind(), ErrorKind::DimensionMismatch);

        let oversized = Mask::new(u32::MAX, u32::MAX, Vec::new())
            .expect_err("oversized dimensions should be rejected");
        assert_eq!(oversized.kind(), ErrorKind::DimensionMismatch);
    }

    #[test]
    fn finds_covered_pixel_bounds() {
        let mask = Mask::new(3, 2, vec![0, 1, 0, 0, 0, 2]).unwrap();

        assert_eq!(mask.coverage_bounds(), Some((1, 0, 3, 2)));
        assert_eq!(Mask::new(2, 2, vec![0; 4]).unwrap().coverage_bounds(), None);
    }

    #[test]
    fn clips_polygon_rasterisation_to_the_image() {
        let polygon = Polygon::new([
            Point::new(-4.0, -4.0),
            Point::new(-2.0, -4.0),
            Point::new(-4.0, -2.0),
        ])
        .unwrap();
        let mask = Selection::Polygon(polygon).rasterise(4, 4).unwrap();

        assert_eq!(mask.coverage_bytes(), &[0; 16]);
    }

    #[test]
    fn scanline_rasterisation_matches_per_sample_reference() {
        let check = |vertices: Vec<Point>, width, height| {
            let Ok(polygon) = Polygon::new(vertices) else {
                return;
            };
            let mut expected = vec![0; width as usize * height as usize];
            let (min_x, min_y, max_x, max_y) = super::polygon_pixel_bounds(&polygon, width, height);
            for y in min_y..max_y {
                for x in min_x..max_x {
                    let mut samples = 0;
                    for sample_y in 0..SAMPLES_PER_AXIS {
                        for sample_x in 0..SAMPLES_PER_AXIS {
                            let point = Point::new(
                                x as f32 + (sample_x as f32 + 0.5) / SAMPLES_PER_AXIS as f32,
                                y as f32 + (sample_y as f32 + 0.5) / SAMPLES_PER_AXIS as f32,
                            );
                            samples += u32::from(super::polygon_contains(&polygon, point));
                        }
                    }
                    expected[y as usize * width as usize + x as usize] =
                        ((samples * 255 + SAMPLE_COUNT / 2) / SAMPLE_COUNT) as u8;
                }
            }
            let actual = Selection::Polygon(polygon.clone())
                .rasterise(width, height)
                .unwrap();
            assert_eq!(
                actual,
                Mask::new(width, height, expected).unwrap(),
                "vertices: {:?}",
                polygon.vertices()
            );
        };

        for vertices in [
            vec![
                (0.125, 0.125),
                (20.875, 0.125),
                (20.875, 18.875),
                (0.125, 18.875),
            ],
            vec![(0.0, 0.0), (21.0, 19.0), (0.0, 19.0), (21.0, 0.0)],
            vec![
                (0.125, 0.125),
                (0.125, 0.125),
                (20.875, 0.125),
                (0.125, 18.875),
            ],
            vec![(-10.0, -10.0), (-1.0, -10.0), (-10.0, -1.0)],
            vec![
                (0.125, 0.125),
                (20.875, 0.125 + f32::EPSILON),
                (0.125, 18.875),
            ],
            vec![
                (-f32::MAX, -f32::MAX),
                (f32::MAX, f32::MAX),
                (0.125, 18.875),
            ],
            vec![(-f32::MAX, 0.125), (f32::MAX, 18.875), (0.125, -f32::MAX)],
            vec![
                (-0.0, f32::from_bits(1)),
                (f32::MIN_POSITIVE, 18.875),
                (20.875, 0.125),
            ],
        ] {
            check(
                vertices
                    .into_iter()
                    .map(|(x, y)| Point::new(x, y))
                    .collect(),
                23,
                21,
            );
        }

        let mut state = 0x6d61_736b_u32;
        let mut next = || {
            state = state.wrapping_mul(1_664_525).wrapping_add(1_013_904_223);
            state
        };
        for index in 0..128 {
            let vertices = (0..3 + index % 8)
                .map(|_| {
                    let mut coordinate = || {
                        let bits = next();
                        if index % 4 == 0 {
                            f32::from_bits(bits & 0xff7f_ffff)
                        } else {
                            (bits % 320) as f32 / 8.0 - 8.0
                        }
                    };
                    Point::new(coordinate(), coordinate())
                })
                .collect();
            check(vertices, 23, 21);
        }
        check(
            vec![
                Point::new(0.0, 0.0),
                Point::new(2.0, 0.0),
                Point::new(0.0, 2.0),
            ],
            0,
            2,
        );
    }
}