tinyvg_rs/
header.rs

1use crate::common::{read_size, read_variable_sized_unsigned_number};
2use crate::TinyVgParseError;
3use byteorder::ReadBytesExt;
4use std::io::{Cursor, Read};
5
6#[repr(u8)]
7#[derive(Debug, Copy, Clone, PartialEq)]
8pub enum ColorEncoding {
9    /// Each color is a 4-tuple (red, green, blue, alpha) of bytes with the color
10    /// channels encoded in sRGB and the alpha as linear alpha.
11    Rgba8888 = 0,
12
13    /// Each color is encoded as a 3-tuple (red, green, blue) with 16 bit per color.
14    /// While red and blue both use 5 bit, the green channel uses 6 bit. red uses
15    /// bit range 0...4, green bits 5...10 and blue bits 11...15. This color also uses
16    /// the sRGB color space.
17
18    Rgb565 = 1,
19    /// Each color is a 4-tuple (red, green ,blue, alpha) of binary32 IEEE 754
20    /// floating point value with the color channels encoded in scRGB and the
21    /// alpha as linear alpha. A color value of 1.0 is full intensity, while a value of
22    /// 0.0 is zero intensity.
23    RgbaF32 = 2,
24
25    /// The custom color encoding is defined undefined. The information how these
26    /// colors are encoded must be implemented via external means.
27    Custom = 3
28}
29
30impl ColorEncoding {
31    fn from_u8(value: u8) -> ColorEncoding {
32        match value {
33            0 => ColorEncoding::Rgba8888,
34            1 => ColorEncoding::Rgb565,
35            2 => ColorEncoding::RgbaF32,
36            3 => ColorEncoding::Custom,
37            _ => unreachable!("ColorEncoding::from_u8 must be a 2-bit value.")
38        }
39    }
40}
41
42#[repr(u8)]
43#[derive(Debug, Copy, Clone)]
44pub enum CoordinateRange {
45    /// Each Unit takes up 16 bit.
46    Default = 0,
47
48    /// Each Unit takes up 8 bit.
49    Reduced = 1,
50
51    /// Each Unit takes up 32 bit.
52    Enhanced = 2,
53}
54
55impl CoordinateRange {
56    fn from_u8(value: u8) -> CoordinateRange {
57        match value {
58            0 => CoordinateRange::Default,
59            1 => CoordinateRange::Reduced,
60            2 => CoordinateRange::Enhanced,
61            _ => unreachable!("CoordinateRange::from_u8 must be a 2-bit value.")
62        }
63    }
64}
65
66#[derive(Debug)]
67pub struct TinyVgHeader {
68    /// https://en.wikipedia.org/wiki/File_format#Magic_number
69    pub magic: [u8; 2],
70
71    /// The TinyVG version.
72    pub version: u8,
73
74    /// Defines the number of fraction bits in a Unit value.
75    pub scale: u8,
76
77    /// Defines the type of color information that is used in the color table.
78    pub color_encoding: ColorEncoding,
79
80    /// Defines the number of total bits in a Unit value and thus the overall
81    /// precision of the file.
82    pub coordinate_range: CoordinateRange,
83
84    /// Encodes the maximum width of the output file in display units.
85    /// A value of 0 indicates that the image has the maximum possible
86    /// width.
87    pub width: u32,
88
89    /// Encodes the maximum height of the output file in display units.
90    /// A value of 0 indicates that the image has the maximum possible
91    /// height.
92    pub height: u32,
93
94    /// The number of colors in the color table.
95    pub color_count: u64,
96}
97
98impl TinyVgHeader {
99    pub(crate) fn parse(cursor: &mut Cursor<&[u8]>) -> Result<Self, TinyVgParseError> {
100        let mut magic = [0u8; 2];
101        cursor.read_exact(&mut magic).map_err(|_| TinyVgParseError::InvalidHeader)?;
102        
103        // Must be { 0x72, 0x56 }
104        if magic[0] != 0x72 || magic[1] != 0x56 {
105            return Err(TinyVgParseError::InvalidHeader);
106        }
107        
108        let version = cursor.read_u8().map_err(|_| TinyVgParseError::InvalidHeader)?;
109
110        // The encoded scale, color encoding, and coordinate range data.
111        let scc = cursor.read_u8().map_err(|_| TinyVgParseError::InvalidHeader)?;
112
113        // bits 0–3 = scale
114        let scale: u8 = scc & 0x0F;
115
116        // bits 4–5 = color encoding
117        let color_encoding_raw = (scc & 0b00_11_00_00) >> 4;
118        let color_encoding = ColorEncoding::from_u8(color_encoding_raw);
119
120        // bits 6–7 = coordinate range
121        let coordinate_range_raw = (scc & 0b11_00_00_00) >> 6;
122        let coordinate_range = CoordinateRange::from_u8(coordinate_range_raw);
123
124        let width: u32 = read_size(&coordinate_range, cursor)?;
125        let height: u32 = read_size(&coordinate_range, cursor)?;
126
127        let color_count = read_variable_sized_unsigned_number(cursor)?;
128
129        let header = TinyVgHeader {
130            magic,
131            version,
132            scale,
133            color_encoding,
134            coordinate_range,
135            width,
136            height,
137            color_count,
138        };
139
140        Ok(header)
141    }   
142}
tinyvg_rs/header.rs

tinyvg_rs/
header.rs
