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

use core::slice::Chunks;
use tile::Tile;

/// An iterator over 4-bits-per-pixel bitplanes.
///
/// Accepts a slice of bytes encoded in bitplanes and decoded `u8`s.
/// The length of input bytes must be evenly divisible by 32. For every
/// 32 bytes consumed, this iterator yields 64 decoded bytes.
/// (Conceptually, it's an 8x8 tile.)
///
/// The 4 most significant bits of each decoded byte will always be 0.
#[derive(Debug)]
pub struct Bitplanes<'a> {
    chunks: Chunks<'a, u8>,
}

impl<'a> Iterator for Bitplanes<'a> {
    type Item = Tile;

    fn next(&mut self) -> Option<Self::Item> {
        self.chunks.next()
            .map(|chunk| {
                let (planes01, planes23) = chunk.split_at(16);
                let mut result = [0; 64];
                let mut cursor = 0;
                for (bytes01, bytes23) in planes01.chunks(2).zip(planes23.chunks(2)) {
                    for n in (0..8).rev() {
                        let mask = 1 << n;
                        let mut px = 0;

                        if bytes23[1] & mask > 0 {
                            px += 1;
                        }
                        px <<= 1;
                        if bytes23[0] & mask > 0 {
                            px += 1;
                        }
                        px <<= 1;
                        if bytes01[1] & mask > 0 {
                            px += 1;
                        }
                        px <<= 1;
                        if bytes01[0] & mask > 0 {
                            px += 1;
                        }
                        result[cursor] = px;
                        cursor += 1;
                    }
                }
                Tile(result)
            })
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.chunks.size_hint()
    }
}

impl<'a> Bitplanes<'a> {
    /// Constructs a new `Bitplanes` from a slice of bytes.
    ///
    /// # Examples
    ///
    /// ```
    /// # use snes_bitplanes::Bitplanes;
    /// # fn main() {
    ///
    /// let bytes = [0u8; 128];
    ///
    /// let tiles: Vec<_> = Bitplanes::new(&bytes[0..64]).collect();
    /// # }
    /// ```
    ///
    /// # Panics
    ///
    /// Panics if the length of the slice is not evenly divisible by 32.
    pub fn new(bytes: &'a [u8]) -> Bitplanes<'a> {
        assert!(bytes.len() % 32 == 0, "Byte slice doesn't fit into 32-byte tiles");
        Bitplanes {
            chunks: bytes.chunks(32),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{Bitplanes, Tile};

    #[test]
    fn snes_mode_4_4bpp() {
        let encoded: &[u8] = &[
            0b00101110, // Bitplane 0
            0b00100000, // Bitplane 1
            0b11101001, // Bitplane 0
            0b10010101, // Bitplane 1
            0b11111101, // ...
            0b10101011,
            0b01000111,
            0b00010101,
            0b00110000,
            0b01011100,
            0b10011111,
            0b00011101,
            0b10010110,
            0b01011010,
            0b00010101,
            0b00101110,

            0b01000000, // Bitplane 2
            0b00001111, // Bitplane 3
            0b00010001, // Bitplane 2
            0b11111011, // Bitplane 3
            0b01000001, // ...
            0b10011100,
            0b10000100,
            0b11110110,
            0b10110000,
            0b00011000,
            0b00100111,
            0b00001001,
            0b11101000,
            0b00101010,
            0b00010001,
            0b10000011,
        ];

        let expected = Tile([
            0b0000, 0b0100, 0b0011, 0b0000, 0b1001, 0b1001, 0b1001, 0b1000,
            0b1011, 0b1001, 0b1001, 0b1110, 0b1001, 0b0010, 0b1000, 0b1111,
            0b1011, 0b0101, 0b0011, 0b1001, 0b1011, 0b1001, 0b0010, 0b0111,
            0b1100, 0b1001, 0b1000, 0b1010, 0b0000, 0b1111, 0b1001, 0b0011,
            0b0100, 0b0010, 0b0101, 0b1111, 0b1010, 0b0010, 0b0000, 0b0000,
            0b0001, 0b0000, 0b0100, 0b0011, 0b1011, 0b0111, 0b0101, 0b1111,
            0b0101, 0b0110, 0b1100, 0b0011, 0b1110, 0b0001, 0b1011, 0b0000,
            0b1000, 0b0000, 0b0010, 0b0101, 0b0010, 0b0011, 0b1010, 0b1101,                                     
        ]);

        let mut decoded = Bitplanes::new(encoded);

        assert_eq!(decoded.next(), Some(expected));
        assert!(decoded.next().is_none());
    }
}