use num_traits::Zero;
use std::fmt;
use std::marker::PhantomData;
use std::ops::{Deref, DerefMut, Index, IndexMut, Range};
use std::path::Path;
use std::slice::{ChunksExact, ChunksExactMut};
use crate::color::{FromColor, Luma, LumaA, Rgb, Rgba};
use crate::dynimage::{save_buffer, save_buffer_with_format, write_buffer_with_format};
use crate::error::ImageResult;
use crate::flat::{FlatSamples, SampleLayout};
use crate::image::{GenericImage, GenericImageView, ImageEncoder, ImageFormat};
use crate::math::Rect;
use crate::traits::{EncodableLayout, Pixel, PixelWithColorType};
use crate::utils::expand_packed;
use crate::DynamicImage;
pub struct Pixels<'a, P: Pixel + 'a>
where
P::Subpixel: 'a,
{
chunks: ChunksExact<'a, P::Subpixel>,
}
impl<'a, P: Pixel + 'a> Iterator for Pixels<'a, P>
where
P::Subpixel: 'a,
{
type Item = &'a P;
#[inline(always)]
fn next(&mut self) -> Option<&'a P> {
self.chunks.next().map(|v| <P as Pixel>::from_slice(v))
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for Pixels<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.chunks.len()
}
}
impl<'a, P: Pixel + 'a> DoubleEndedIterator for Pixels<'a, P>
where
P::Subpixel: 'a,
{
#[inline(always)]
fn next_back(&mut self) -> Option<&'a P> {
self.chunks.next_back().map(|v| <P as Pixel>::from_slice(v))
}
}
impl<P: Pixel> Clone for Pixels<'_, P> {
fn clone(&self) -> Self {
Pixels {
chunks: self.chunks.clone(),
}
}
}
impl<P: Pixel> fmt::Debug for Pixels<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Pixels")
.field("chunks", &self.chunks)
.finish()
}
}
pub struct PixelsMut<'a, P: Pixel + 'a>
where
P::Subpixel: 'a,
{
chunks: ChunksExactMut<'a, P::Subpixel>,
}
impl<'a, P: Pixel + 'a> Iterator for PixelsMut<'a, P>
where
P::Subpixel: 'a,
{
type Item = &'a mut P;
#[inline(always)]
fn next(&mut self) -> Option<&'a mut P> {
self.chunks.next().map(|v| <P as Pixel>::from_slice_mut(v))
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for PixelsMut<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.chunks.len()
}
}
impl<'a, P: Pixel + 'a> DoubleEndedIterator for PixelsMut<'a, P>
where
P::Subpixel: 'a,
{
#[inline(always)]
fn next_back(&mut self) -> Option<&'a mut P> {
self.chunks
.next_back()
.map(|v| <P as Pixel>::from_slice_mut(v))
}
}
impl<P: Pixel> fmt::Debug for PixelsMut<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("PixelsMut")
.field("chunks", &self.chunks)
.finish()
}
}
pub struct Rows<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
pixels: ChunksExact<'a, P::Subpixel>,
}
impl<'a, P: Pixel + 'a> Rows<'a, P> {
fn with_image(pixels: &'a [P::Subpixel], width: u32, height: u32) -> Self {
let row_len = (width as usize) * usize::from(<P as Pixel>::CHANNEL_COUNT);
if row_len == 0 {
Rows {
pixels: [].chunks_exact(1),
}
} else {
let pixels = pixels
.get(..row_len * height as usize)
.expect("Pixel buffer has too few subpixels");
Rows {
pixels: pixels.chunks_exact(row_len),
}
}
}
}
impl<'a, P: Pixel + 'a> Iterator for Rows<'a, P>
where
P::Subpixel: 'a,
{
type Item = Pixels<'a, P>;
#[inline(always)]
fn next(&mut self) -> Option<Pixels<'a, P>> {
let row = self.pixels.next()?;
Some(Pixels {
chunks: row.chunks_exact(<P as Pixel>::CHANNEL_COUNT as usize),
})
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for Rows<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.pixels.len()
}
}
impl<'a, P: Pixel + 'a> DoubleEndedIterator for Rows<'a, P>
where
P::Subpixel: 'a,
{
#[inline(always)]
fn next_back(&mut self) -> Option<Pixels<'a, P>> {
let row = self.pixels.next_back()?;
Some(Pixels {
chunks: row.chunks_exact(<P as Pixel>::CHANNEL_COUNT as usize),
})
}
}
impl<P: Pixel> Clone for Rows<'_, P> {
fn clone(&self) -> Self {
Rows {
pixels: self.pixels.clone(),
}
}
}
impl<P: Pixel> fmt::Debug for Rows<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Rows")
.field("pixels", &self.pixels)
.finish()
}
}
pub struct RowsMut<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
pixels: ChunksExactMut<'a, P::Subpixel>,
}
impl<'a, P: Pixel + 'a> RowsMut<'a, P> {
fn with_image(pixels: &'a mut [P::Subpixel], width: u32, height: u32) -> Self {
let row_len = (width as usize) * usize::from(<P as Pixel>::CHANNEL_COUNT);
if row_len == 0 {
RowsMut {
pixels: [].chunks_exact_mut(1),
}
} else {
let pixels = pixels
.get_mut(..row_len * height as usize)
.expect("Pixel buffer has too few subpixels");
RowsMut {
pixels: pixels.chunks_exact_mut(row_len),
}
}
}
}
impl<'a, P: Pixel + 'a> Iterator for RowsMut<'a, P>
where
P::Subpixel: 'a,
{
type Item = PixelsMut<'a, P>;
#[inline(always)]
fn next(&mut self) -> Option<PixelsMut<'a, P>> {
let row = self.pixels.next()?;
Some(PixelsMut {
chunks: row.chunks_exact_mut(<P as Pixel>::CHANNEL_COUNT as usize),
})
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for RowsMut<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.pixels.len()
}
}
impl<'a, P: Pixel + 'a> DoubleEndedIterator for RowsMut<'a, P>
where
P::Subpixel: 'a,
{
#[inline(always)]
fn next_back(&mut self) -> Option<PixelsMut<'a, P>> {
let row = self.pixels.next_back()?;
Some(PixelsMut {
chunks: row.chunks_exact_mut(<P as Pixel>::CHANNEL_COUNT as usize),
})
}
}
impl<P: Pixel> fmt::Debug for RowsMut<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("RowsMut")
.field("pixels", &self.pixels)
.finish()
}
}
pub struct EnumeratePixels<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
pixels: Pixels<'a, P>,
x: u32,
y: u32,
width: u32,
}
impl<'a, P: Pixel + 'a> Iterator for EnumeratePixels<'a, P>
where
P::Subpixel: 'a,
{
type Item = (u32, u32, &'a P);
#[inline(always)]
fn next(&mut self) -> Option<(u32, u32, &'a P)> {
if self.x >= self.width {
self.x = 0;
self.y += 1;
}
let (x, y) = (self.x, self.y);
self.x += 1;
self.pixels.next().map(|p| (x, y, p))
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for EnumeratePixels<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.pixels.len()
}
}
impl<P: Pixel> Clone for EnumeratePixels<'_, P> {
fn clone(&self) -> Self {
EnumeratePixels {
pixels: self.pixels.clone(),
..*self
}
}
}
impl<P: Pixel> fmt::Debug for EnumeratePixels<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("EnumeratePixels")
.field("pixels", &self.pixels)
.field("x", &self.x)
.field("y", &self.y)
.field("width", &self.width)
.finish()
}
}
pub struct EnumerateRows<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
rows: Rows<'a, P>,
y: u32,
width: u32,
}
impl<'a, P: Pixel + 'a> Iterator for EnumerateRows<'a, P>
where
P::Subpixel: 'a,
{
type Item = (u32, EnumeratePixels<'a, P>);
#[inline(always)]
fn next(&mut self) -> Option<(u32, EnumeratePixels<'a, P>)> {
let y = self.y;
self.y += 1;
self.rows.next().map(|r| {
(
y,
EnumeratePixels {
x: 0,
y,
width: self.width,
pixels: r,
},
)
})
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for EnumerateRows<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.rows.len()
}
}
impl<P: Pixel> Clone for EnumerateRows<'_, P> {
fn clone(&self) -> Self {
EnumerateRows {
rows: self.rows.clone(),
..*self
}
}
}
impl<P: Pixel> fmt::Debug for EnumerateRows<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("EnumerateRows")
.field("rows", &self.rows)
.field("y", &self.y)
.field("width", &self.width)
.finish()
}
}
pub struct EnumeratePixelsMut<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
pixels: PixelsMut<'a, P>,
x: u32,
y: u32,
width: u32,
}
impl<'a, P: Pixel + 'a> Iterator for EnumeratePixelsMut<'a, P>
where
P::Subpixel: 'a,
{
type Item = (u32, u32, &'a mut P);
#[inline(always)]
fn next(&mut self) -> Option<(u32, u32, &'a mut P)> {
if self.x >= self.width {
self.x = 0;
self.y += 1;
}
let (x, y) = (self.x, self.y);
self.x += 1;
self.pixels.next().map(|p| (x, y, p))
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for EnumeratePixelsMut<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.pixels.len()
}
}
impl<P: Pixel> fmt::Debug for EnumeratePixelsMut<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("EnumeratePixelsMut")
.field("pixels", &self.pixels)
.field("x", &self.x)
.field("y", &self.y)
.field("width", &self.width)
.finish()
}
}
pub struct EnumerateRowsMut<'a, P: Pixel + 'a>
where
<P as Pixel>::Subpixel: 'a,
{
rows: RowsMut<'a, P>,
y: u32,
width: u32,
}
impl<'a, P: Pixel + 'a> Iterator for EnumerateRowsMut<'a, P>
where
P::Subpixel: 'a,
{
type Item = (u32, EnumeratePixelsMut<'a, P>);
#[inline(always)]
fn next(&mut self) -> Option<(u32, EnumeratePixelsMut<'a, P>)> {
let y = self.y;
self.y += 1;
self.rows.next().map(|r| {
(
y,
EnumeratePixelsMut {
x: 0,
y,
width: self.width,
pixels: r,
},
)
})
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.len();
(len, Some(len))
}
}
impl<'a, P: Pixel + 'a> ExactSizeIterator for EnumerateRowsMut<'a, P>
where
P::Subpixel: 'a,
{
fn len(&self) -> usize {
self.rows.len()
}
}
impl<P: Pixel> fmt::Debug for EnumerateRowsMut<'_, P>
where
P::Subpixel: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("EnumerateRowsMut")
.field("rows", &self.rows)
.field("y", &self.y)
.field("width", &self.width)
.finish()
}
}
#[derive(Debug, Hash, PartialEq, Eq)]
pub struct ImageBuffer<P: Pixel, Container> {
width: u32,
height: u32,
_phantom: PhantomData<P>,
data: Container,
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]>,
{
pub fn from_raw(width: u32, height: u32, buf: Container) -> Option<ImageBuffer<P, Container>> {
if Self::check_image_fits(width, height, buf.len()) {
Some(ImageBuffer {
data: buf,
width,
height,
_phantom: PhantomData,
})
} else {
None
}
}
pub fn into_raw(self) -> Container {
self.data
}
pub fn as_raw(&self) -> &Container {
&self.data
}
pub fn dimensions(&self) -> (u32, u32) {
(self.width, self.height)
}
pub fn width(&self) -> u32 {
self.width
}
pub fn height(&self) -> u32 {
self.height
}
pub(crate) fn inner_pixels(&self) -> &[P::Subpixel] {
let len = Self::image_buffer_len(self.width, self.height).unwrap();
&self.data[..len]
}
pub fn pixels(&self) -> Pixels<P> {
Pixels {
chunks: self
.inner_pixels()
.chunks_exact(<P as Pixel>::CHANNEL_COUNT as usize),
}
}
pub fn rows(&self) -> Rows<P> {
Rows::with_image(&self.data, self.width, self.height)
}
pub fn enumerate_pixels(&self) -> EnumeratePixels<P> {
EnumeratePixels {
pixels: self.pixels(),
x: 0,
y: 0,
width: self.width,
}
}
pub fn enumerate_rows(&self) -> EnumerateRows<P> {
EnumerateRows {
rows: self.rows(),
y: 0,
width: self.width,
}
}
#[inline]
#[track_caller]
pub fn get_pixel(&self, x: u32, y: u32) -> &P {
match self.pixel_indices(x, y) {
None => panic!(
"Image index {:?} out of bounds {:?}",
(x, y),
(self.width, self.height)
),
Some(pixel_indices) => <P as Pixel>::from_slice(&self.data[pixel_indices]),
}
}
pub fn get_pixel_checked(&self, x: u32, y: u32) -> Option<&P> {
if x >= self.width {
return None;
}
let num_channels = <P as Pixel>::CHANNEL_COUNT as usize;
let i = (y as usize)
.saturating_mul(self.width as usize)
.saturating_add(x as usize)
.saturating_mul(num_channels);
self.data
.get(i..i.checked_add(num_channels)?)
.map(|pixel_indices| <P as Pixel>::from_slice(pixel_indices))
}
fn check_image_fits(width: u32, height: u32, len: usize) -> bool {
let checked_len = Self::image_buffer_len(width, height);
checked_len.map_or(false, |min_len| min_len <= len)
}
fn image_buffer_len(width: u32, height: u32) -> Option<usize> {
Some(<P as Pixel>::CHANNEL_COUNT as usize)
.and_then(|size| size.checked_mul(width as usize))
.and_then(|size| size.checked_mul(height as usize))
}
#[inline(always)]
fn pixel_indices(&self, x: u32, y: u32) -> Option<Range<usize>> {
if x >= self.width || y >= self.height {
return None;
}
Some(self.pixel_indices_unchecked(x, y))
}
#[inline(always)]
fn pixel_indices_unchecked(&self, x: u32, y: u32) -> Range<usize> {
let no_channels = <P as Pixel>::CHANNEL_COUNT as usize;
let min_index = (y as usize * self.width as usize + x as usize) * no_channels;
min_index..min_index + no_channels
}
pub fn sample_layout(&self) -> SampleLayout {
SampleLayout::row_major_packed(<P as Pixel>::CHANNEL_COUNT, self.width, self.height)
}
pub fn into_flat_samples(self) -> FlatSamples<Container>
where
Container: AsRef<[P::Subpixel]>,
{
let layout = self.sample_layout();
FlatSamples {
samples: self.data,
layout,
color_hint: None, }
}
pub fn as_flat_samples(&self) -> FlatSamples<&[P::Subpixel]>
where
Container: AsRef<[P::Subpixel]>,
{
let layout = self.sample_layout();
FlatSamples {
samples: self.data.as_ref(),
layout,
color_hint: None, }
}
pub fn as_flat_samples_mut(&mut self) -> FlatSamples<&mut [P::Subpixel]>
where
Container: AsMut<[P::Subpixel]>,
{
let layout = self.sample_layout();
FlatSamples {
samples: self.data.as_mut(),
layout,
color_hint: None, }
}
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + DerefMut,
{
pub(crate) fn inner_pixels_mut(&mut self) -> &mut [P::Subpixel] {
let len = Self::image_buffer_len(self.width, self.height).unwrap();
&mut self.data[..len]
}
pub fn pixels_mut(&mut self) -> PixelsMut<P> {
PixelsMut {
chunks: self
.inner_pixels_mut()
.chunks_exact_mut(<P as Pixel>::CHANNEL_COUNT as usize),
}
}
pub fn rows_mut(&mut self) -> RowsMut<P> {
RowsMut::with_image(&mut self.data, self.width, self.height)
}
pub fn enumerate_pixels_mut(&mut self) -> EnumeratePixelsMut<P> {
let width = self.width;
EnumeratePixelsMut {
pixels: self.pixels_mut(),
x: 0,
y: 0,
width,
}
}
pub fn enumerate_rows_mut(&mut self) -> EnumerateRowsMut<P> {
let width = self.width;
EnumerateRowsMut {
rows: self.rows_mut(),
y: 0,
width,
}
}
#[inline]
#[track_caller]
pub fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut P {
match self.pixel_indices(x, y) {
None => panic!(
"Image index {:?} out of bounds {:?}",
(x, y),
(self.width, self.height)
),
Some(pixel_indices) => <P as Pixel>::from_slice_mut(&mut self.data[pixel_indices]),
}
}
pub fn get_pixel_mut_checked(&mut self, x: u32, y: u32) -> Option<&mut P> {
if x >= self.width {
return None;
}
let num_channels = <P as Pixel>::CHANNEL_COUNT as usize;
let i = (y as usize)
.saturating_mul(self.width as usize)
.saturating_add(x as usize)
.saturating_mul(num_channels);
self.data
.get_mut(i..i.checked_add(num_channels)?)
.map(|pixel_indices| <P as Pixel>::from_slice_mut(pixel_indices))
}
#[inline]
#[track_caller]
pub fn put_pixel(&mut self, x: u32, y: u32, pixel: P) {
*self.get_pixel_mut(x, y) = pixel;
}
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
[P::Subpixel]: EncodableLayout,
Container: Deref<Target = [P::Subpixel]>,
{
pub fn save<Q>(&self, path: Q) -> ImageResult<()>
where
Q: AsRef<Path>,
P: PixelWithColorType,
{
save_buffer(
path,
self.inner_pixels().as_bytes(),
self.width(),
self.height(),
<P as PixelWithColorType>::COLOR_TYPE,
)
}
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
[P::Subpixel]: EncodableLayout,
Container: Deref<Target = [P::Subpixel]>,
{
pub fn save_with_format<Q>(&self, path: Q, format: ImageFormat) -> ImageResult<()>
where
Q: AsRef<Path>,
P: PixelWithColorType,
{
save_buffer_with_format(
path,
self.inner_pixels().as_bytes(),
self.width(),
self.height(),
<P as PixelWithColorType>::COLOR_TYPE,
format,
)
}
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
[P::Subpixel]: EncodableLayout,
Container: Deref<Target = [P::Subpixel]>,
{
pub fn write_to<W>(&self, writer: &mut W, format: ImageFormat) -> ImageResult<()>
where
W: std::io::Write + std::io::Seek,
P: PixelWithColorType,
{
write_buffer_with_format(
writer,
self.inner_pixels().as_bytes(),
self.width(),
self.height(),
<P as PixelWithColorType>::COLOR_TYPE,
format,
)
}
}
impl<P, Container> ImageBuffer<P, Container>
where
P: Pixel,
[P::Subpixel]: EncodableLayout,
Container: Deref<Target = [P::Subpixel]>,
{
pub fn write_with_encoder<E>(&self, encoder: E) -> ImageResult<()>
where
E: ImageEncoder,
P: PixelWithColorType,
{
encoder.write_image(
self.inner_pixels().as_bytes(),
self.width(),
self.height(),
<P as PixelWithColorType>::COLOR_TYPE,
)
}
}
impl<P, Container> Default for ImageBuffer<P, Container>
where
P: Pixel,
Container: Default,
{
fn default() -> Self {
Self {
width: 0,
height: 0,
_phantom: PhantomData,
data: Default::default(),
}
}
}
impl<P, Container> Deref for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]>,
{
type Target = [P::Subpixel];
fn deref(&self) -> &<Self as Deref>::Target {
&self.data
}
}
impl<P, Container> DerefMut for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + DerefMut,
{
fn deref_mut(&mut self) -> &mut <Self as Deref>::Target {
&mut self.data
}
}
impl<P, Container> Index<(u32, u32)> for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]>,
{
type Output = P;
fn index(&self, (x, y): (u32, u32)) -> &P {
self.get_pixel(x, y)
}
}
impl<P, Container> IndexMut<(u32, u32)> for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + DerefMut,
{
fn index_mut(&mut self, (x, y): (u32, u32)) -> &mut P {
self.get_pixel_mut(x, y)
}
}
impl<P, Container> Clone for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + Clone,
{
fn clone(&self) -> ImageBuffer<P, Container> {
ImageBuffer {
data: self.data.clone(),
width: self.width,
height: self.height,
_phantom: PhantomData,
}
}
fn clone_from(&mut self, source: &Self) {
self.data.clone_from(&source.data);
self.width = source.width;
self.height = source.height;
}
}
impl<P, Container> GenericImageView for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + Deref,
{
type Pixel = P;
fn dimensions(&self) -> (u32, u32) {
self.dimensions()
}
fn get_pixel(&self, x: u32, y: u32) -> P {
*self.get_pixel(x, y)
}
#[inline(always)]
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> P {
let indices = self.pixel_indices_unchecked(x, y);
*<P as Pixel>::from_slice(self.data.get_unchecked(indices))
}
}
impl<P, Container> GenericImage for ImageBuffer<P, Container>
where
P: Pixel,
Container: Deref<Target = [P::Subpixel]> + DerefMut,
{
fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut P {
self.get_pixel_mut(x, y)
}
fn put_pixel(&mut self, x: u32, y: u32, pixel: P) {
*self.get_pixel_mut(x, y) = pixel;
}
#[inline(always)]
unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: P) {
let indices = self.pixel_indices_unchecked(x, y);
let p = <P as Pixel>::from_slice_mut(self.data.get_unchecked_mut(indices));
*p = pixel;
}
fn blend_pixel(&mut self, x: u32, y: u32, p: P) {
self.get_pixel_mut(x, y).blend(&p);
}
fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool {
let Rect {
x: sx,
y: sy,
width,
height,
} = source;
let dx = x;
let dy = y;
assert!(sx < self.width() && dx < self.width());
assert!(sy < self.height() && dy < self.height());
if self.width() - dx.max(sx) < width || self.height() - dy.max(sy) < height {
return false;
}
if sy < dy {
for y in (0..height).rev() {
let sy = sy + y;
let dy = dy + y;
let Range { start, .. } = self.pixel_indices_unchecked(sx, sy);
let Range { end, .. } = self.pixel_indices_unchecked(sx + width - 1, sy);
let dst = self.pixel_indices_unchecked(dx, dy).start;
self.data.copy_within(start..end, dst);
}
} else {
for y in 0..height {
let sy = sy + y;
let dy = dy + y;
let Range { start, .. } = self.pixel_indices_unchecked(sx, sy);
let Range { end, .. } = self.pixel_indices_unchecked(sx + width - 1, sy);
let dst = self.pixel_indices_unchecked(dx, dy).start;
self.data.copy_within(start..end, dst);
}
}
true
}
}
impl<P: Pixel> ImageBuffer<P, Vec<P::Subpixel>> {
#[must_use]
pub fn new(width: u32, height: u32) -> ImageBuffer<P, Vec<P::Subpixel>> {
let size = Self::image_buffer_len(width, height)
.expect("Buffer length in `ImageBuffer::new` overflows usize");
ImageBuffer {
data: vec![Zero::zero(); size],
width,
height,
_phantom: PhantomData,
}
}
pub fn from_pixel(width: u32, height: u32, pixel: P) -> ImageBuffer<P, Vec<P::Subpixel>> {
let mut buf = ImageBuffer::new(width, height);
for p in buf.pixels_mut() {
*p = pixel;
}
buf
}
pub fn from_fn<F>(width: u32, height: u32, mut f: F) -> ImageBuffer<P, Vec<P::Subpixel>>
where
F: FnMut(u32, u32) -> P,
{
let mut buf = ImageBuffer::new(width, height);
for (x, y, p) in buf.enumerate_pixels_mut() {
*p = f(x, y);
}
buf
}
#[must_use]
pub fn from_vec(
width: u32,
height: u32,
buf: Vec<P::Subpixel>,
) -> Option<ImageBuffer<P, Vec<P::Subpixel>>> {
ImageBuffer::from_raw(width, height, buf)
}
#[must_use]
pub fn into_vec(self) -> Vec<P::Subpixel> {
self.into_raw()
}
}
pub trait ConvertBuffer<T> {
fn convert(&self) -> T;
}
impl GrayImage {
#[must_use]
pub fn expand_palette(
self,
palette: &[(u8, u8, u8)],
transparent_idx: Option<u8>,
) -> RgbaImage {
let (width, height) = self.dimensions();
let mut data = self.into_raw();
let entries = data.len();
data.resize(entries.checked_mul(4).unwrap(), 0);
let mut buffer = ImageBuffer::from_vec(width, height, data).unwrap();
expand_packed(&mut buffer, 4, 8, |idx, pixel| {
let (r, g, b) = palette[idx as usize];
let a = if let Some(t_idx) = transparent_idx {
if t_idx == idx {
0
} else {
255
}
} else {
255
};
pixel[0] = r;
pixel[1] = g;
pixel[2] = b;
pixel[3] = a;
});
buffer
}
}
impl<Container, FromType: Pixel, ToType: Pixel>
ConvertBuffer<ImageBuffer<ToType, Vec<ToType::Subpixel>>> for ImageBuffer<FromType, Container>
where
Container: Deref<Target = [FromType::Subpixel]>,
ToType: FromColor<FromType>,
{
fn convert(&self) -> ImageBuffer<ToType, Vec<ToType::Subpixel>> {
let mut buffer: ImageBuffer<ToType, Vec<ToType::Subpixel>> =
ImageBuffer::new(self.width, self.height);
for (to, from) in buffer.pixels_mut().zip(self.pixels()) {
to.from_color(from);
}
buffer
}
}
pub type RgbImage = ImageBuffer<Rgb<u8>, Vec<u8>>;
pub type RgbaImage = ImageBuffer<Rgba<u8>, Vec<u8>>;
pub type GrayImage = ImageBuffer<Luma<u8>, Vec<u8>>;
pub type GrayAlphaImage = ImageBuffer<LumaA<u8>, Vec<u8>>;
pub(crate) type Rgb16Image = ImageBuffer<Rgb<u16>, Vec<u16>>;
pub(crate) type Rgba16Image = ImageBuffer<Rgba<u16>, Vec<u16>>;
pub(crate) type Gray16Image = ImageBuffer<Luma<u16>, Vec<u16>>;
pub(crate) type GrayAlpha16Image = ImageBuffer<LumaA<u16>, Vec<u16>>;
pub type Rgb32FImage = ImageBuffer<Rgb<f32>, Vec<f32>>;
pub type Rgba32FImage = ImageBuffer<Rgba<f32>, Vec<f32>>;
impl From<DynamicImage> for RgbImage {
fn from(value: DynamicImage) -> Self {
value.into_rgb8()
}
}
impl From<DynamicImage> for RgbaImage {
fn from(value: DynamicImage) -> Self {
value.into_rgba8()
}
}
impl From<DynamicImage> for GrayImage {
fn from(value: DynamicImage) -> Self {
value.into_luma8()
}
}
impl From<DynamicImage> for GrayAlphaImage {
fn from(value: DynamicImage) -> Self {
value.into_luma_alpha8()
}
}
impl From<DynamicImage> for Rgb16Image {
fn from(value: DynamicImage) -> Self {
value.into_rgb16()
}
}
impl From<DynamicImage> for Rgba16Image {
fn from(value: DynamicImage) -> Self {
value.into_rgba16()
}
}
impl From<DynamicImage> for Gray16Image {
fn from(value: DynamicImage) -> Self {
value.into_luma16()
}
}
impl From<DynamicImage> for GrayAlpha16Image {
fn from(value: DynamicImage) -> Self {
value.into_luma_alpha16()
}
}
impl From<DynamicImage> for Rgba32FImage {
fn from(value: DynamicImage) -> Self {
value.into_rgba32f()
}
}
#[cfg(test)]
mod test {
use super::{GrayImage, ImageBuffer, RgbImage};
use crate::math::Rect;
use crate::GenericImage as _;
use crate::ImageFormat;
use crate::{Luma, LumaA, Pixel, Rgb, Rgba};
use num_traits::Zero;
#[test]
fn slice_buffer() {
let data = [0; 9];
let buf: ImageBuffer<Luma<u8>, _> = ImageBuffer::from_raw(3, 3, &data[..]).unwrap();
assert_eq!(&*buf, &data[..])
}
macro_rules! new_buffer_zero_test {
($test_name:ident, $pxt:ty) => {
#[test]
fn $test_name() {
let buffer = ImageBuffer::<$pxt, Vec<<$pxt as Pixel>::Subpixel>>::new(2, 2);
assert!(buffer
.iter()
.all(|p| *p == <$pxt as Pixel>::Subpixel::zero()));
}
};
}
new_buffer_zero_test!(luma_u8_zero_test, Luma<u8>);
new_buffer_zero_test!(luma_u16_zero_test, Luma<u16>);
new_buffer_zero_test!(luma_f32_zero_test, Luma<f32>);
new_buffer_zero_test!(luma_a_u8_zero_test, LumaA<u8>);
new_buffer_zero_test!(luma_a_u16_zero_test, LumaA<u16>);
new_buffer_zero_test!(luma_a_f32_zero_test, LumaA<f32>);
new_buffer_zero_test!(rgb_u8_zero_test, Rgb<u8>);
new_buffer_zero_test!(rgb_u16_zero_test, Rgb<u16>);
new_buffer_zero_test!(rgb_f32_zero_test, Rgb<f32>);
new_buffer_zero_test!(rgb_a_u8_zero_test, Rgba<u8>);
new_buffer_zero_test!(rgb_a_u16_zero_test, Rgba<u16>);
new_buffer_zero_test!(rgb_a_f32_zero_test, Rgba<f32>);
#[test]
fn get_pixel() {
let mut a: RgbImage = ImageBuffer::new(10, 10);
{
let b = a.get_mut(3 * 10).unwrap();
*b = 255;
}
assert_eq!(a.get_pixel(0, 1)[0], 255)
}
#[test]
fn get_pixel_checked() {
let mut a: RgbImage = ImageBuffer::new(10, 10);
a.get_pixel_mut_checked(0, 1).unwrap()[0] = 255;
assert_eq!(a.get_pixel_checked(0, 1), Some(&Rgb([255, 0, 0])));
assert_eq!(a.get_pixel_checked(0, 1).unwrap(), a.get_pixel(0, 1));
assert_eq!(a.get_pixel_checked(10, 0), None);
assert_eq!(a.get_pixel_checked(0, 10), None);
assert_eq!(a.get_pixel_mut_checked(10, 0), None);
assert_eq!(a.get_pixel_mut_checked(0, 10), None);
const WHITE: Rgb<u8> = Rgb([255_u8, 255, 255]);
let mut a = RgbImage::new(2, 1);
a.put_pixel(1, 0, WHITE);
assert_eq!(a.get_pixel_checked(1, 0), Some(&WHITE));
assert_eq!(a.get_pixel_checked(1, 0).unwrap(), a.get_pixel(1, 0));
}
#[test]
fn mut_iter() {
let mut a: RgbImage = ImageBuffer::new(10, 10);
{
let val = a.pixels_mut().next().unwrap();
*val = Rgb([42, 0, 0]);
}
assert_eq!(a.data[0], 42);
}
#[test]
fn zero_width_zero_height() {
let mut image = RgbImage::new(0, 0);
assert_eq!(image.rows_mut().count(), 0);
assert_eq!(image.pixels_mut().count(), 0);
assert_eq!(image.rows().count(), 0);
assert_eq!(image.pixels().count(), 0);
}
#[test]
fn zero_width_nonzero_height() {
let mut image = RgbImage::new(0, 2);
assert_eq!(image.rows_mut().count(), 0);
assert_eq!(image.pixels_mut().count(), 0);
assert_eq!(image.rows().count(), 0);
assert_eq!(image.pixels().count(), 0);
}
#[test]
fn nonzero_width_zero_height() {
let mut image = RgbImage::new(2, 0);
assert_eq!(image.rows_mut().count(), 0);
assert_eq!(image.pixels_mut().count(), 0);
assert_eq!(image.rows().count(), 0);
assert_eq!(image.pixels().count(), 0);
}
#[test]
fn pixels_on_large_buffer() {
let mut image = RgbImage::from_raw(1, 1, vec![0; 6]).unwrap();
assert_eq!(image.pixels().count(), 1);
assert_eq!(image.enumerate_pixels().count(), 1);
assert_eq!(image.pixels_mut().count(), 1);
assert_eq!(image.enumerate_pixels_mut().count(), 1);
assert_eq!(image.rows().count(), 1);
assert_eq!(image.rows_mut().count(), 1);
}
#[test]
fn default() {
let image = ImageBuffer::<Rgb<u8>, Vec<u8>>::default();
assert_eq!(image.dimensions(), (0, 0));
}
#[test]
#[rustfmt::skip]
fn test_image_buffer_copy_within_oob() {
let mut image: GrayImage = ImageBuffer::from_raw(4, 4, vec![0u8; 16]).unwrap();
assert!(!image.copy_within(Rect { x: 0, y: 0, width: 5, height: 4 }, 0, 0));
assert!(!image.copy_within(Rect { x: 0, y: 0, width: 4, height: 5 }, 0, 0));
assert!(!image.copy_within(Rect { x: 1, y: 0, width: 4, height: 4 }, 0, 0));
assert!(!image.copy_within(Rect { x: 0, y: 0, width: 4, height: 4 }, 1, 0));
assert!(!image.copy_within(Rect { x: 0, y: 1, width: 4, height: 4 }, 0, 0));
assert!(!image.copy_within(Rect { x: 0, y: 0, width: 4, height: 4 }, 0, 1));
assert!(!image.copy_within(Rect { x: 1, y: 1, width: 4, height: 4 }, 0, 0));
}
#[test]
fn test_image_buffer_copy_within_tl() {
let data = &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
let expected = [0, 1, 2, 3, 4, 0, 1, 2, 8, 4, 5, 6, 12, 8, 9, 10];
let mut image: GrayImage = ImageBuffer::from_raw(4, 4, Vec::from(&data[..])).unwrap();
assert!(image.copy_within(
Rect {
x: 0,
y: 0,
width: 3,
height: 3
},
1,
1
));
assert_eq!(&image.into_raw(), &expected);
}
#[test]
fn test_image_buffer_copy_within_tr() {
let data = &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
let expected = [0, 1, 2, 3, 1, 2, 3, 7, 5, 6, 7, 11, 9, 10, 11, 15];
let mut image: GrayImage = ImageBuffer::from_raw(4, 4, Vec::from(&data[..])).unwrap();
assert!(image.copy_within(
Rect {
x: 1,
y: 0,
width: 3,
height: 3
},
0,
1
));
assert_eq!(&image.into_raw(), &expected);
}
#[test]
fn test_image_buffer_copy_within_bl() {
let data = &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
let expected = [0, 4, 5, 6, 4, 8, 9, 10, 8, 12, 13, 14, 12, 13, 14, 15];
let mut image: GrayImage = ImageBuffer::from_raw(4, 4, Vec::from(&data[..])).unwrap();
assert!(image.copy_within(
Rect {
x: 0,
y: 1,
width: 3,
height: 3
},
1,
0
));
assert_eq!(&image.into_raw(), &expected);
}
#[test]
fn test_image_buffer_copy_within_br() {
let data = &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
let expected = [5, 6, 7, 3, 9, 10, 11, 7, 13, 14, 15, 11, 12, 13, 14, 15];
let mut image: GrayImage = ImageBuffer::from_raw(4, 4, Vec::from(&data[..])).unwrap();
assert!(image.copy_within(
Rect {
x: 1,
y: 1,
width: 3,
height: 3
},
0,
0
));
assert_eq!(&image.into_raw(), &expected);
}
#[test]
#[cfg(feature = "png")]
fn write_to_with_large_buffer() {
let img: GrayImage = ImageBuffer::from_raw(1, 1, vec![0u8; 4]).unwrap();
let mut buffer = std::io::Cursor::new(vec![]);
assert!(img.write_to(&mut buffer, ImageFormat::Png).is_ok());
}
#[test]
fn exact_size_iter_size_hint() {
const N: u32 = 10;
let mut image = RgbImage::from_raw(N, N, vec![0; (N * N * 3) as usize]).unwrap();
let iter = image.pixels();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.pixels_mut();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.rows();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.rows_mut();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.enumerate_pixels();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.enumerate_rows();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.enumerate_pixels_mut();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
let iter = image.enumerate_rows_mut();
let exact_len = ExactSizeIterator::len(&iter);
assert_eq!(iter.size_hint(), (exact_len, Some(exact_len)));
}
}
#[cfg(test)]
#[cfg(feature = "benchmarks")]
mod benchmarks {
use super::{ConvertBuffer, GrayImage, ImageBuffer, Pixel, RgbImage};
#[bench]
fn conversion(b: &mut test::Bencher) {
let mut a: RgbImage = ImageBuffer::new(1000, 1000);
for p in a.pixels_mut() {
let rgb = p.channels_mut();
rgb[0] = 255;
rgb[1] = 23;
rgb[2] = 42;
}
assert!(a.data[0] != 0);
b.iter(|| {
let b: GrayImage = a.convert();
assert!(0 != b.data[0]);
assert!(a.data[0] != b.data[0]);
test::black_box(b);
});
b.bytes = 1000 * 1000 * 3
}
#[bench]
fn image_access_row_by_row(b: &mut test::Bencher) {
let mut a: RgbImage = ImageBuffer::new(1000, 1000);
for p in a.pixels_mut() {
let rgb = p.channels_mut();
rgb[0] = 255;
rgb[1] = 23;
rgb[2] = 42;
}
b.iter(move || {
let image: &RgbImage = test::black_box(&a);
let mut sum: usize = 0;
for y in 0..1000 {
for x in 0..1000 {
let pixel = image.get_pixel(x, y);
sum = sum.wrapping_add(pixel[0] as usize);
sum = sum.wrapping_add(pixel[1] as usize);
sum = sum.wrapping_add(pixel[2] as usize);
}
}
test::black_box(sum)
});
b.bytes = 1000 * 1000 * 3;
}
#[bench]
fn image_access_col_by_col(b: &mut test::Bencher) {
let mut a: RgbImage = ImageBuffer::new(1000, 1000);
for p in a.pixels_mut() {
let rgb = p.channels_mut();
rgb[0] = 255;
rgb[1] = 23;
rgb[2] = 42;
}
b.iter(move || {
let image: &RgbImage = test::black_box(&a);
let mut sum: usize = 0;
for x in 0..1000 {
for y in 0..1000 {
let pixel = image.get_pixel(x, y);
sum = sum.wrapping_add(pixel[0] as usize);
sum = sum.wrapping_add(pixel[1] as usize);
sum = sum.wrapping_add(pixel[2] as usize);
}
}
test::black_box(sum)
});
b.bytes = 1000 * 1000 * 3;
}
}