image 0.25.8

Imaging library. Provides basic image processing and encoders/decoders for common image formats.
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

//! Decoding and Encoding of PCX Images
//!
//! PCX (PiCture eXchange) Format is an obsolete image format from the 1980s.
//!
//! # Related Links
//! * <https://en.wikipedia.org/wiki/PCX> - The PCX format on Wikipedia

extern crate pcx;

use std::io::{self, BufRead, Cursor, Read, Seek};
use std::iter;
use std::marker::PhantomData;
use std::mem;

use crate::color::{ColorType, ExtendedColorType};
use crate::error::{ImageError, ImageResult};
use crate::image::ImageDecoder;

/// Decoder for PCX images.
pub struct PCXDecoder<R>
where
    R: BufRead + Seek,
{
    dimensions: (u32, u32),
    inner: pcx::Reader<R>,
}

impl<R> PCXDecoder<R>
where
    R: BufRead + Seek,
{
    /// Create a new `PCXDecoder`.
    pub fn new(r: R) -> Result<PCXDecoder<R>, ImageError> {
        let inner = pcx::Reader::new(r).map_err(ImageError::from_pcx_decode)?;
        let dimensions = (u32::from(inner.width()), u32::from(inner.height()));

        Ok(PCXDecoder { dimensions, inner })
    }
}

impl ImageError {
    fn from_pcx_decode(err: io::Error) -> ImageError {
        ImageError::IoError(err)
    }
}

/// Wrapper struct around a `Cursor<Vec<u8>>`
#[allow(dead_code)]
#[deprecated]
pub struct PCXReader<R>(Cursor<Vec<u8>>, PhantomData<R>);
#[allow(deprecated)]
impl<R> Read for PCXReader<R> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.0.read(buf)
    }

    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
        if self.0.position() == 0 && buf.is_empty() {
            mem::swap(buf, self.0.get_mut());
            Ok(buf.len())
        } else {
            self.0.read_to_end(buf)
        }
    }
}

impl<R: BufRead + Seek> ImageDecoder for PCXDecoder<R> {
    fn dimensions(&self) -> (u32, u32) {
        self.dimensions
    }

    fn color_type(&self) -> ColorType {
        ColorType::Rgb8
    }

    fn original_color_type(&self) -> ExtendedColorType {
        if self.inner.is_paletted() {
            return ExtendedColorType::Unknown(self.inner.header.bit_depth);
        }

        match (
            self.inner.header.number_of_color_planes,
            self.inner.header.bit_depth,
        ) {
            (1, 1) => ExtendedColorType::L1,
            (1, 2) => ExtendedColorType::L2,
            (1, 4) => ExtendedColorType::L4,
            (1, 8) => ExtendedColorType::L8,
            (3, 1) => ExtendedColorType::Rgb1,
            (3, 2) => ExtendedColorType::Rgb2,
            (3, 4) => ExtendedColorType::Rgb4,
            (3, 8) => ExtendedColorType::Rgb8,
            (4, 1) => ExtendedColorType::Rgba1,
            (4, 2) => ExtendedColorType::Rgba2,
            (4, 4) => ExtendedColorType::Rgba4,
            (4, 8) => ExtendedColorType::Rgba8,
            (_, _) => unreachable!(),
        }
    }

    fn read_image(mut self, buf: &mut [u8]) -> ImageResult<()> {
        assert_eq!(u64::try_from(buf.len()), Ok(self.total_bytes()));

        let height = self.inner.height() as usize;
        let width = self.inner.width() as usize;

        match self.inner.palette_length() {
            // No palette to interpret, so we can just write directly to buf
            None => {
                for i in 0..height {
                    let offset = i * 3 * width;
                    self.inner
                        .next_row_rgb(&mut buf[offset..offset + (width * 3)])
                        .map_err(ImageError::from_pcx_decode)?;
                }
            }

            // We need to convert from the palette colours to RGB values inline,
            // but the pcx crate can't give us the palette first. Work around it
            // by taking the paletted image into a buffer, then converting it to
            // RGB8 after.
            Some(palette_length) => {
                let mut pal_buf: Vec<u8> = iter::repeat(0).take(height * width).collect();

                for i in 0..height {
                    let offset = i * width;
                    self.inner
                        .next_row_paletted(&mut pal_buf[offset..offset + width])
                        .map_err(ImageError::from_pcx_decode)?;
                }

                let mut palette: Vec<u8> =
                    iter::repeat(0).take(3 * palette_length as usize).collect();
                self.inner
                    .read_palette(&mut palette[..])
                    .map_err(ImageError::from_pcx_decode)?;

                for i in 0..height {
                    for j in 0..width {
                        let pixel = pal_buf[i * width + j] as usize;
                        let offset = i * width * 3 + j * 3;

                        buf[offset] = palette[pixel * 3];
                        buf[offset + 1] = palette[pixel * 3 + 1];
                        buf[offset + 2] = palette[pixel * 3 + 2];
                    }
                }
            }
        }

        Ok(())
    }

    fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()> {
        (*self).read_image(buf)
    }
}