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
use std::io::Read;
use std::{error, fmt};
use byteorder::{LittleEndian, ReadBytesExt};
#[allow(deprecated)]
use crate::codecs::dxt::{DxtDecoder, DxtReader, DxtVariant};
use crate::color::ColorType;
use crate::error::{
DecodingError, ImageError, ImageFormatHint, ImageResult, UnsupportedError, UnsupportedErrorKind,
};
use crate::image::{ImageDecoder, ImageFormat};
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
enum DecoderError {
PixelFormatSizeInvalid(u32),
HeaderSizeInvalid(u32),
HeaderFlagsInvalid(u32),
DxgiFormatInvalid(u32),
ResourceDimensionInvalid(u32),
Dx10FlagsInvalid(u32),
Dx10ArraySizeInvalid(u32),
DdsSignatureInvalid,
}
impl fmt::Display for DecoderError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
DecoderError::PixelFormatSizeInvalid(s) => {
f.write_fmt(format_args!("Invalid DDS PixelFormat size: {}", s))
}
DecoderError::HeaderSizeInvalid(s) => {
f.write_fmt(format_args!("Invalid DDS header size: {}", s))
}
DecoderError::HeaderFlagsInvalid(fs) => {
f.write_fmt(format_args!("Invalid DDS header flags: {:#010X}", fs))
}
DecoderError::DxgiFormatInvalid(df) => {
f.write_fmt(format_args!("Invalid DDS DXGI format: {}", df))
}
DecoderError::ResourceDimensionInvalid(d) => {
f.write_fmt(format_args!("Invalid DDS resource dimension: {}", d))
}
DecoderError::Dx10FlagsInvalid(fs) => {
f.write_fmt(format_args!("Invalid DDS DX10 header flags: {:#010X}", fs))
}
DecoderError::Dx10ArraySizeInvalid(s) => {
f.write_fmt(format_args!("Invalid DDS DX10 array size: {}", s))
}
DecoderError::DdsSignatureInvalid => f.write_str("DDS signature not found"),
}
}
}
impl From<DecoderError> for ImageError {
fn from(e: DecoderError) -> ImageError {
ImageError::Decoding(DecodingError::new(ImageFormat::Dds.into(), e))
}
}
impl error::Error for DecoderError {}
#[derive(Debug)]
struct Header {
_flags: u32,
height: u32,
width: u32,
_pitch_or_linear_size: u32,
_depth: u32,
_mipmap_count: u32,
pixel_format: PixelFormat,
_caps: u32,
_caps2: u32,
}
#[derive(Debug)]
struct DX10Header {
dxgi_format: u32,
resource_dimension: u32,
misc_flag: u32,
array_size: u32,
misc_flags_2: u32,
}
#[derive(Debug)]
struct PixelFormat {
flags: u32,
fourcc: [u8; 4],
_rgb_bit_count: u32,
_r_bit_mask: u32,
_g_bit_mask: u32,
_b_bit_mask: u32,
_a_bit_mask: u32,
}
impl PixelFormat {
fn from_reader(r: &mut dyn Read) -> ImageResult<Self> {
let size = r.read_u32::<LittleEndian>()?;
if size != 32 {
return Err(DecoderError::PixelFormatSizeInvalid(size).into());
}
Ok(Self {
flags: r.read_u32::<LittleEndian>()?,
fourcc: {
let mut v = [0; 4];
r.read_exact(&mut v)?;
v
},
_rgb_bit_count: r.read_u32::<LittleEndian>()?,
_r_bit_mask: r.read_u32::<LittleEndian>()?,
_g_bit_mask: r.read_u32::<LittleEndian>()?,
_b_bit_mask: r.read_u32::<LittleEndian>()?,
_a_bit_mask: r.read_u32::<LittleEndian>()?,
})
}
}
impl Header {
fn from_reader(r: &mut dyn Read) -> ImageResult<Self> {
let size = r.read_u32::<LittleEndian>()?;
if size != 124 {
return Err(DecoderError::HeaderSizeInvalid(size).into());
}
const REQUIRED_FLAGS: u32 = 0x1 | 0x2 | 0x4 | 0x1000;
const VALID_FLAGS: u32 = 0x1 | 0x2 | 0x4 | 0x8 | 0x1000 | 0x20000 | 0x80000 | 0x800000;
let flags = r.read_u32::<LittleEndian>()?;
if flags & (REQUIRED_FLAGS | !VALID_FLAGS) != REQUIRED_FLAGS {
return Err(DecoderError::HeaderFlagsInvalid(flags).into());
}
let height = r.read_u32::<LittleEndian>()?;
let width = r.read_u32::<LittleEndian>()?;
let pitch_or_linear_size = r.read_u32::<LittleEndian>()?;
let depth = r.read_u32::<LittleEndian>()?;
let mipmap_count = r.read_u32::<LittleEndian>()?;
{
let mut skipped = [0; 4 * 11];
r.read_exact(&mut skipped)?;
}
let pixel_format = PixelFormat::from_reader(r)?;
let caps = r.read_u32::<LittleEndian>()?;
let caps2 = r.read_u32::<LittleEndian>()?;
{
let mut skipped = [0; 4 + 4 + 4];
r.read_exact(&mut skipped)?;
}
Ok(Self {
_flags: flags,
height,
width,
_pitch_or_linear_size: pitch_or_linear_size,
_depth: depth,
_mipmap_count: mipmap_count,
pixel_format,
_caps: caps,
_caps2: caps2,
})
}
}
impl DX10Header {
fn from_reader(r: &mut dyn Read) -> ImageResult<Self> {
let dxgi_format = r.read_u32::<LittleEndian>()?;
let resource_dimension = r.read_u32::<LittleEndian>()?;
let misc_flag = r.read_u32::<LittleEndian>()?;
let array_size = r.read_u32::<LittleEndian>()?;
let misc_flags_2 = r.read_u32::<LittleEndian>()?;
let dx10_header = Self {
dxgi_format,
resource_dimension,
misc_flag,
array_size,
misc_flags_2,
};
dx10_header.validate()?;
Ok(dx10_header)
}
fn validate(&self) -> Result<(), ImageError> {
if self.dxgi_format > 132 {
return Err(DecoderError::DxgiFormatInvalid(self.dxgi_format).into());
}
if self.resource_dimension < 2 || self.resource_dimension > 4 {
return Err(DecoderError::ResourceDimensionInvalid(self.resource_dimension).into());
}
if self.misc_flag != 0x0 && self.misc_flag != 0x4 {
return Err(DecoderError::Dx10FlagsInvalid(self.misc_flag).into());
}
if self.resource_dimension == 4 && self.array_size != 1 {
return Err(DecoderError::Dx10ArraySizeInvalid(self.array_size).into());
}
if self.misc_flags_2 > 0x4 {
return Err(DecoderError::Dx10FlagsInvalid(self.misc_flags_2).into());
}
Ok(())
}
}
pub struct DdsDecoder<R: Read> {
#[allow(deprecated)]
inner: DxtDecoder<R>,
}
impl<R: Read> DdsDecoder<R> {
pub fn new(mut r: R) -> ImageResult<Self> {
let mut magic = [0; 4];
r.read_exact(&mut magic)?;
if magic != b"DDS "[..] {
return Err(DecoderError::DdsSignatureInvalid.into());
}
let header = Header::from_reader(&mut r)?;
if header.pixel_format.flags & 0x4 != 0 {
#[allow(deprecated)]
let variant = match &header.pixel_format.fourcc {
b"DXT1" => DxtVariant::DXT1,
b"DXT3" => DxtVariant::DXT3,
b"DXT5" => DxtVariant::DXT5,
b"DX10" => {
let dx10_header = DX10Header::from_reader(&mut r)?;
match dx10_header.dxgi_format {
70 | 71 | 72 => DxtVariant::DXT1, 73 | 74 | 75 => DxtVariant::DXT3, 76 | 77 | 78 => DxtVariant::DXT5, _ => {
return Err(ImageError::Unsupported(
UnsupportedError::from_format_and_kind(
ImageFormat::Dds.into(),
UnsupportedErrorKind::GenericFeature(format!(
"DDS DXGI Format {}",
dx10_header.dxgi_format
)),
),
))
}
}
}
fourcc => {
return Err(ImageError::Unsupported(
UnsupportedError::from_format_and_kind(
ImageFormat::Dds.into(),
UnsupportedErrorKind::GenericFeature(format!(
"DDS FourCC {:?}",
fourcc
)),
),
))
}
};
#[allow(deprecated)]
let bytes_per_pixel = variant.color_type().bytes_per_pixel();
if crate::utils::check_dimension_overflow(header.width, header.height, bytes_per_pixel)
{
return Err(ImageError::Unsupported(
UnsupportedError::from_format_and_kind(
ImageFormat::Dds.into(),
UnsupportedErrorKind::GenericFeature(format!(
"Image dimensions ({}x{}) are too large",
header.width, header.height
)),
),
));
}
#[allow(deprecated)]
let inner = DxtDecoder::new(r, header.width, header.height, variant)?;
Ok(Self { inner })
} else {
Err(ImageError::Unsupported(
UnsupportedError::from_format_and_kind(
ImageFormat::Dds.into(),
UnsupportedErrorKind::Format(ImageFormatHint::Name("DDS".to_string())),
),
))
}
}
}
impl<'a, R: 'a + Read> ImageDecoder<'a> for DdsDecoder<R> {
#[allow(deprecated)]
type Reader = DxtReader<R>;
fn dimensions(&self) -> (u32, u32) {
self.inner.dimensions()
}
fn color_type(&self) -> ColorType {
self.inner.color_type()
}
fn scanline_bytes(&self) -> u64 {
self.inner.scanline_bytes()
}
fn into_reader(self) -> ImageResult<Self::Reader> {
self.inner.into_reader()
}
fn read_image(self, buf: &mut [u8]) -> ImageResult<()> {
self.inner.read_image(buf)
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn dimension_overflow() {
let header = vec![
0x44, 0x44, 0x53, 0x20, 0x7C, 0x0, 0x0, 0x0, 0x7, 0x10, 0x8, 0x0, 0xFC, 0xFF, 0xFF,
0xFF, 0xFC, 0xFF, 0xFF, 0xFF, 0x0, 0xC0, 0x12, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1, 0x0, 0x0,
0x0, 0x49, 0x4D, 0x41, 0x47, 0x45, 0x4D, 0x41, 0x47, 0x49, 0x43, 0x4B, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x20, 0x0, 0x0, 0x0,
0x4, 0x0, 0x0, 0x0, 0x44, 0x58, 0x54, 0x31, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x10, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
];
assert!(DdsDecoder::new(&header[..]).is_err());
}
}