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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
use core::ops::{Index, IndexMut};

use std::mem;

use num_traits::identities::Zero;

use crate::core::iter::{PixelIter, PixelIterMut};
use crate::core::traits::{GenericImage, GenericImageView, Pixel};

macro_rules! impl_GenericImageView {
    ($id:ident) => {
        type T = T;

        fn width(&self) -> u32 {
            self.width
        }

        fn height(&self) -> u32 {
            self.height
        }

        fn pixel(&self, x: u32, y: u32) -> Option<Self::T> {
            if x >= self.width() || y >= self.height() {
                return None;
            }

            Some(self[y as usize][x as usize])
        }
    };
}

macro_rules! impl_GenericImage {
    ($id:ident) => {
        fn set_pixel(&mut self, x: u32, y: u32, pix: &Self::T) -> Result<(), ()> {
            if x >= self.width() || y >= self.height() {
                return Err(());
            }

            self[y as usize][x as usize] = *pix;
            Ok(())
        }
    };
}

macro_rules! impl_Index {
    ($id:ident) => {
        type Output = [T];

        fn index(&self, index: usize) -> &Self::Output {
            // determine the offset in the raw buffer
            let pixels_per_row = self.width() / T::subpixels() as u32;
            let stride_elems = self.stride() / mem::size_of::<T::T>();
            let off: usize = index * stride_elems;
            let slice = &self.raw[off..off + stride_elems];
            let (head, body, _tail) = unsafe { slice.align_to::<T>() };
            assert!(head.is_empty(), "raw data is not aligned");
            assert_eq!(
                body.len(),
                pixels_per_row as usize,
                "invalid number of row items"
            );

            body
        }
    };
}

macro_rules! impl_IndexMut {
    ($id:ident) => {
        fn index_mut(&mut self, index: usize) -> &mut Self::Output {
            // determine the offset in the raw buffer
            let pixels_per_row = self.width() / T::subpixels() as u32;
            let stride_elems = self.stride() / mem::size_of::<T::T>();
            let off: usize = index * stride_elems;
            let slice = &mut self.raw[off..off + stride_elems];
            let (head, body, _tail) = unsafe { slice.align_to_mut::<T>() };
            assert!(head.is_empty(), "raw data is not aligned");
            assert_eq!(
                body.len(),
                pixels_per_row as usize,
                "invalid number of row items"
            );

            body
        }
    };
}

macro_rules! impl_Iterator {
    ($id:ident) => {
        type Item = &'a T;

        fn next(&mut self) -> Option<Self::Item> {
            if self.x >= self.width {
                self.x = 0;
                self.y += 1;
            }

            if self.y >= self.height {
                return None;
            }

            let x = self.x;
            self.x += 1;

            Some(&self.img[self.y as usize][x as usize])
        }
    };
}

// iterators handing out mutable references are not allowed by safe rust as explained here:
// https://stackoverflow.com/a/27641876/11423991
macro_rules! impl_IteratorMut {
    ($id:ident) => {
        type Item = &'a mut T;

        fn next(&mut self) -> Option<Self::Item> {
            if self.x >= self.width {
                self.x = 0;
                self.y += 1;
            }

            if self.y >= self.height {
                return None;
            }

            let x = self.x;
            self.x += 1;

            // This is safe because...
            // (from http://stackoverflow.com/questions/25730586):
            // The Rust compiler does not know that when you ask a mutable iterator for the
            // next element, that you get a different reference every time and never the same
            // reference twice. Of course, we know that such an iterator won't give you the
            // same reference twice.
            unsafe { mem::transmute(&self.img[self.y as usize][x as usize]) }
        }
    };
}

/// Image view parametrized by its pixel type
pub struct ImageView<'a, T: Pixel> {
    raw: &'a [T::T],
    width: u32,
    height: u32,
    stride: usize,
}

impl<'a, T: Pixel> ImageView<'a, T> {
    /// Returns an image view with pixel accessors
    ///
    /// The backing memory storage must have the same element type as the underlying pixel type of
    /// the image.
    ///
    /// # Arguments
    ///
    /// * `raw` - Raw memory region to interpret as typed image
    /// * `width` - Width in pixels
    /// * `height` - Height in pixels
    ///
    /// # Example
    ///
    /// ```
    /// use ffimage::color::rgb::*;
    /// use ffimage::packed::generic::ImageView;
    ///
    /// let mem = vec![0; 3];
    /// let view = ImageView::<Rgb<u8>>::new(&mem, 1, 1).expect("Memory region too small");
    /// ```
    pub fn new(raw: &'a [T::T], width: u32, height: u32) -> Option<Self> {
        // require the same amount of elements per row
        if raw.len() % height as usize != 0 {
            return None;
        }

        // validate bytes per line
        let pixels_per_row = width / T::subpixels() as u32;
        let min_stride = pixels_per_row as usize * T::channels() as usize * mem::size_of::<T::T>();
        let stride = raw.len() * mem::size_of::<T::T>() / height as usize;
        if stride < min_stride {
            return None;
        }

        Some(ImageView {
            raw,
            width,
            height,
            stride,
        })
    }

    pub fn raw(&self) -> &[T::T] {
        &self.raw
    }

    /// Returns the length of one pixel row in bytes
    pub fn stride(&self) -> usize {
        self.stride
    }
}

impl<'a, T: Pixel + 'a> GenericImageView<'a> for ImageView<'a, T> {
    impl_GenericImageView!(ImageView);

    type SubImage = SubImageView<'a, Self>;

    fn view(&'a self, x: u32, y: u32, width: u32, height: u32) -> Option<Self::SubImage> {
        SubImageView::new(self, x, y, width, height)
    }
}

impl<'a, T: Pixel> Index<usize> for ImageView<'a, T> {
    impl_Index!(ImageView);
}

impl<'a, T: Pixel> Iterator for PixelIter<'a, ImageView<'a, T>> {
    impl_Iterator!(ImageView);
}

impl<'a, T: Pixel> IntoIterator for &'a ImageView<'a, T> {
    type Item = &'a T;
    type IntoIter = PixelIter<'a, ImageView<'a, T>>;

    fn into_iter(self) -> Self::IntoIter {
        PixelIter::new(self)
    }
}

pub struct ImageViewMut<'a, T: Pixel> {
    raw: &'a mut [T::T],
    width: u32,
    height: u32,
    stride: usize,
}

impl<'a, T: Pixel> ImageViewMut<'a, T> {
    /// Returns a flat image buffer with pixel accessors
    ///
    /// 'Flat' means that the backing memory of the image is not allocated by the struct.
    /// Thus, this struct allows for reusing existing (mutable) buffers and still having images
    /// defined by their pixel types.
    ///
    /// # Arguments
    ///
    /// * `raw` - Raw memory region
    /// * `width` - Width in pixels
    /// * `height` - Height in pixels
    ///
    /// # Example
    ///
    /// ```
    /// use ffimage::color::rgb::*;
    /// use ffimage::core::GenericImage;
    /// use ffimage::packed::generic::ImageViewMut;
    ///
    /// let mut mem = vec![0; 3];
    /// let mut buf = ImageViewMut::<Rgb<u8>>::new(&mut mem, 1, 1)
    ///     .expect("Memory region too small");
    /// let pix = Rgb::<u8>::new([255, 255, 255]);
    /// buf.set_pixel(0, 0, &pix).unwrap();
    /// ```
    pub fn new(raw: &'a mut [T::T], width: u32, height: u32) -> Option<Self> {
        // require the same amount of elements per row
        if raw.len() % height as usize != 0 {
            return None;
        }

        // validate bytes per line
        let pixels_per_row = width / T::subpixels() as u32;
        let min_stride = pixels_per_row as usize * T::channels() as usize * mem::size_of::<T::T>();
        let stride = raw.len() * mem::size_of::<T::T>() / height as usize;
        if stride < min_stride {
            return None;
        }

        Some(ImageViewMut {
            raw,
            width,
            height,
            stride,
        })
    }

    pub fn raw(&self) -> &[T::T] {
        &self.raw
    }

    pub fn raw_mut(&mut self) -> &mut [T::T] {
        &mut self.raw
    }

    /// Returns the length of one pixel row in bytes
    pub fn stride(&self) -> usize {
        self.stride
    }
}

impl<'a, T: Pixel + 'a> GenericImageView<'a> for ImageViewMut<'a, T> {
    impl_GenericImageView!(ImageViewMut);

    type SubImage = SubImageView<'a, Self>;

    fn view(&'a self, x: u32, y: u32, width: u32, height: u32) -> Option<Self::SubImage> {
        SubImageView::new(self, x, y, width, height)
    }
}

impl<'a, T: Pixel + 'a> GenericImage<'a> for ImageViewMut<'a, T> {
    impl_GenericImage!(ImageViewMut);
}

impl<'a, T: Pixel> Index<usize> for ImageViewMut<'a, T> {
    impl_Index!(ImageViewMut);
}

impl<'a, T: Pixel> IndexMut<usize> for ImageViewMut<'a, T> {
    impl_IndexMut!(ImageViewMut);
}

impl<'a, T: Pixel> Iterator for PixelIter<'a, ImageViewMut<'a, T>> {
    impl_Iterator!(ImageViewMut);
}

impl<'a, T: Pixel> Iterator for PixelIterMut<'a, ImageViewMut<'a, T>> {
    impl_IteratorMut!(ImageViewMut);
}

impl<'a, T: Pixel> IntoIterator for &'a ImageViewMut<'a, T> {
    type Item = &'a T;
    type IntoIter = PixelIter<'a, ImageViewMut<'a, T>>;

    fn into_iter(self) -> Self::IntoIter {
        PixelIter::new(self)
    }
}

impl<'a, T: Pixel> IntoIterator for &'a mut ImageViewMut<'a, T> {
    type Item = &'a mut T;
    type IntoIter = PixelIterMut<'a, ImageViewMut<'a, T>>;

    fn into_iter(self) -> Self::IntoIter {
        PixelIterMut::new(self)
    }
}

pub struct ImageBuffer<T: Pixel> {
    raw: Vec<T::T>,
    width: u32,
    height: u32,
    stride: usize,
}

impl<T: Pixel> ImageBuffer<T> {
    /// Returns an image buffer with pixel accessors
    ///
    /// The backing memory is allocated by this struct. There is no padding added so only the
    /// minimum amount of memory is consumed. In contrast to flat image buffers, fat buffer
    /// structs own their data and can safely be moved between threads.
    ///
    /// # Arguments
    ///
    /// * `width` - Width in pixels
    /// * `height` - Height in pixels
    ///
    /// # Example
    ///
    /// ```
    /// use ffimage::color::rgb::*;
    /// use ffimage::core::GenericImage;
    /// use ffimage::packed::generic::ImageBuffer;
    ///
    /// let mut buf = ImageBuffer::<Rgb<u8>>::new(3, 3);
    /// let pix = Rgb::<u8>::new([255, 255, 255]);
    /// buf.set_pixel(0, 0, &pix).unwrap();
    /// ```
    pub fn new(width: u32, height: u32) -> Self {
        let pixels_per_row = width / T::subpixels() as u32;
        let stride = pixels_per_row as usize * T::channels() as usize * mem::size_of::<T::T>();

        ImageBuffer {
            raw: vec![T::T::zero(); height as usize * pixels_per_row as usize * T::len()],
            width,
            height,
            stride,
        }
    }

    /// Returns an image buffer with pixel accessors
    ///
    /// The pixel memory is copied into an allocated buffer owned by this struct.
    ///
    /// # Arguments
    ///
    /// * `width` - Width in pixels
    /// * `height` - Height in pixels
    /// * `raw` - Pixel memory storage owned by the instance
    ///
    /// # Example
    ///
    /// ```
    /// use ffimage::color::rgb::*;
    /// use ffimage::core::GenericImage;
    /// use ffimage::packed::generic::ImageBuffer;
    ///
    /// let mut mem = vec![0; 3];
    /// let mut buf = ImageBuffer::<Rgb<u8>>::from_raw(1, 1, mem)
    ///     .expect("Memory region too small");
    /// let pix = Rgb::<u8>::new([255, 255, 255]);
    /// buf.set_pixel(0, 0, &pix).unwrap();
    /// ```
    pub fn from_raw(width: u32, height: u32, raw: Vec<T::T>) -> Option<Self> {
        // require the same amount of elements per row
        if raw.len() % height as usize != 0 {
            return None;
        }

        // validate bytes per line
        let pixels_per_row = width / T::subpixels() as u32;
        let min_stride = pixels_per_row as usize * T::channels() as usize * mem::size_of::<T::T>();
        let stride = raw.len() * mem::size_of::<T::T>() / height as usize;
        if stride < min_stride {
            return None;
        }

        Some(ImageBuffer {
            raw,
            width,
            height,
            stride,
        })
    }

    pub fn raw(&self) -> &[T::T] {
        &self.raw
    }

    pub fn raw_mut(&mut self) -> &mut [T::T] {
        &mut self.raw
    }

    /// Returns the length of one pixel row in bytes
    pub fn stride(&self) -> usize {
        self.stride
    }
}

impl<'a, T: Pixel + 'a> GenericImageView<'a> for ImageBuffer<T> {
    impl_GenericImageView!(ImageBuffer);

    type SubImage = SubImageView<'a, Self>;

    fn view(&'a self, x: u32, y: u32, width: u32, height: u32) -> Option<Self::SubImage> {
        SubImageView::new(self, x, y, width, height)
    }
}

impl<'a, T: Pixel + 'a> GenericImage<'a> for ImageBuffer<T> {
    impl_GenericImage!(ImageBuffer);
}

impl<T: Pixel> Index<usize> for ImageBuffer<T> {
    impl_Index!(ImageBuffer);
}

impl<T: Pixel> IndexMut<usize> for ImageBuffer<T> {
    impl_IndexMut!(ImageBuffer);
}

impl<'a, T: Pixel> Iterator for PixelIter<'a, ImageBuffer<T>> {
    impl_Iterator!(ImageBuffer);
}

impl<'a, T: Pixel> Iterator for PixelIterMut<'a, ImageBuffer<T>> {
    impl_IteratorMut!(ImageBuffer);
}

impl<'a, T: Pixel> IntoIterator for &'a ImageBuffer<T> {
    type Item = &'a T;
    type IntoIter = PixelIter<'a, ImageBuffer<T>>;

    fn into_iter(self) -> Self::IntoIter {
        PixelIter::new(self)
    }
}

impl<'a, T: Pixel> IntoIterator for &'a mut ImageBuffer<T> {
    type Item = &'a mut T;
    type IntoIter = PixelIterMut<'a, ImageBuffer<T>>;

    fn into_iter(self) -> Self::IntoIter {
        PixelIterMut::new(self)
    }
}

impl<T: Pixel> Into<Vec<T::T>> for ImageBuffer<T> {
    fn into(self) -> Vec<T::T> {
        self.raw
    }
}

impl<'a, T: Pixel> From<&ImageView<'a, T>> for ImageBuffer<T> {
    fn from(view: &ImageView<'a, T>) -> Self {
        // unwrap() is safe here because the view itself was checked when it was created
        ImageBuffer::from_raw(view.width(), view.height(), view.raw().to_vec()).unwrap()
    }
}

impl<'a, T: Pixel> From<&ImageViewMut<'a, T>> for ImageBuffer<T> {
    fn from(view: &ImageViewMut<'a, T>) -> Self {
        // unwrap() is safe here because the view itself was checked when it was created
        ImageBuffer::from_raw(view.width(), view.height(), view.raw().to_vec()).unwrap()
    }
}

/// Sub image view into another image
pub struct SubImageView<'a, I: GenericImageView<'a>> {
    parent: &'a I,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
}

impl<'a, I: GenericImageView<'a>> SubImageView<'a, I> {
    /// Returns a new read-only view into another image.
    ///
    /// # Arguments
    ///
    /// * `parent` - Parent image backing the sub image
    /// * `x` - X offset
    /// * `y` - Y offset
    /// * `width` - Width in pixels
    /// * `height` - Height in pixels
    ///
    /// # Example
    ///
    /// ```
    /// use ffimage::color::rgb::*;
    /// use ffimage::core::GenericImageView;
    /// use ffimage::packed::generic::ImageBuffer;
    ///
    /// let mut buf = ImageBuffer::<Rgb<u8>>::new(3, 3);
    /// let sub = buf.view(1, 1, 2, 2);
    /// ```
    pub fn new(parent: &'a I, x: u32, y: u32, width: u32, height: u32) -> Option<Self> {
        if x + width > parent.width() || y + height > parent.height() {
            return None;
        }

        Some(SubImageView {
            parent,
            x,
            y,
            width,
            height,
        })
    }
}

impl<'a, I: GenericImageView<'a>> GenericImageView<'a> for SubImageView<'a, I> {
    type T = I::T;
    type SubImage = Self;

    fn width(&self) -> u32 {
        self.width
    }

    fn height(&self) -> u32 {
        self.height
    }

    fn pixel(&self, x: u32, y: u32) -> Option<Self::T> {
        self.parent.pixel(x + self.x, y + self.y)
    }

    fn view(&'a self, x: u32, y: u32, width: u32, height: u32) -> Option<Self::SubImage> {
        SubImageView::new(self.parent, x + self.x, y + self.y, width, height)
    }
}

impl<'a, T: Pixel> Index<usize> for SubImageView<'a, ImageView<'a, T>> {
    type Output = [T];

    fn index(&self, index: usize) -> &Self::Output {
        let row = &self.parent[index + self.y as usize];
        &row[self.x as usize..]
    }
}

impl<'a, T: Pixel> Index<usize> for SubImageView<'a, ImageViewMut<'a, T>> {
    type Output = [T];

    fn index(&self, index: usize) -> &Self::Output {
        let row = &self.parent[index + self.y as usize];
        &row[self.x as usize..]
    }
}

impl<'a, T: Pixel> Index<usize> for SubImageView<'a, ImageBuffer<T>> {
    type Output = [T];

    fn index(&self, index: usize) -> &Self::Output {
        let row = &self.parent[index + self.y as usize];
        &row[self.x as usize..]
    }
}