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 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
// The MIT License (MIT)
//
// Copyright (c) 2018 Michael Dilger
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
use crate::error::*;
use crate::{D3DFormat, DataFormat, DxgiFormat, PixelFormat};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use std::fmt;
use std::io::{Read, Write};
#[derive(Clone)]
pub struct Header {
// Size of this structure in bytes; set to 124
// technically not required, we could take this out
size: u32,
// Flags indicating which members contain valid data
flags: HeaderFlags,
/// Surface height (in pixels)
pub height: u32,
/// Surface width (in pixels)
pub width: u32,
/// The pitch or number of bytes per scan line in an uncompressed texture;
pub pitch: Option<u32>,
/// The total number of bytes in a top level texture for a compressed texture
pub linear_size: Option<u32>,
/// Depth of a volume texture (in pixels)
pub depth: Option<u32>,
/// Number of mipmap levels
pub mip_map_count: Option<u32>,
// Unused (reserved)
// technically not required, but we write back what we read
reserved1: [u32; 11],
/// The pixel format
pub spf: PixelFormat,
/// Specifies the complexity of the surfaces stored.
pub caps: Caps,
/// Additional detail about the surfaces stored
pub caps2: Caps2,
// Unused
// technically not required, but we write back what we read
caps3: u32,
// Unused
// technically not required, but we write back what we read
caps4: u32,
// Unused
// technically not required, but we write back what we read
reserved2: u32,
}
impl Default for Header {
fn default() -> Header {
Header {
size: 124, // must be 124
flags: HeaderFlags::CAPS
| HeaderFlags::HEIGHT
| HeaderFlags::WIDTH
| HeaderFlags::PIXELFORMAT,
height: 0,
width: 0,
pitch: None,
linear_size: None,
depth: None,
mip_map_count: None,
reserved1: [0; 11],
spf: Default::default(),
caps: Caps::TEXTURE,
caps2: Caps2::empty(),
caps3: 0,
caps4: 0,
reserved2: 0,
}
}
}
impl Header {
pub fn new_d3d(
height: u32,
width: u32,
depth: Option<u32>,
format: D3DFormat,
mipmap_levels: Option<u32>,
caps2: Option<Caps2>,
) -> Result<Header, Error> {
let mut header: Header = Header {
height,
width,
mip_map_count: mipmap_levels,
depth,
spf: From::from(format),
..Default::default()
};
if let Some(mml) = mipmap_levels {
if mml > 1 {
header.flags.insert(HeaderFlags::MIPMAPCOUNT);
header.caps.insert(Caps::COMPLEX | Caps::MIPMAP);
}
}
if let Some(d) = depth {
if d > 1 {
header.caps.insert(Caps::COMPLEX);
header.flags |= HeaderFlags::DEPTH;
}
}
// Let the caller handle caps2.
if let Some(c2) = caps2 {
header.caps2 = c2;
}
let compressed: bool = format.get_block_size().is_some();
let pitch: u32 = match format.get_pitch(width) {
Some(pitch) => pitch,
None => return Err(Error::UnsupportedFormat),
};
let depth = depth.unwrap_or(1);
if compressed {
header.flags |= HeaderFlags::LINEARSIZE;
let pitch_height = format.get_pitch_height();
let raw_height = (height + (pitch_height - 1)) / pitch_height;
header.linear_size = Some(pitch * raw_height * depth);
} else {
header.flags |= HeaderFlags::PITCH;
header.pitch = Some(pitch);
}
Ok(header)
}
pub fn new_dxgi(
height: u32,
width: u32,
depth: Option<u32>,
format: DxgiFormat,
mipmap_levels: Option<u32>,
array_layers: Option<u32>,
caps2: Option<Caps2>,
) -> Result<Header, Error> {
let mut header: Header = Header {
height,
width,
mip_map_count: mipmap_levels,
depth,
spf: From::from(format),
..Default::default()
};
if let Some(mml) = mipmap_levels {
if mml > 1 {
header.flags.insert(HeaderFlags::MIPMAPCOUNT);
header.caps.insert(Caps::COMPLEX | Caps::MIPMAP);
}
}
if let Some(d) = depth {
if d > 1 {
header.caps.insert(Caps::COMPLEX);
header.flags |= HeaderFlags::DEPTH;
}
}
if let Some(al) = array_layers {
if al > 1 {
header.caps.insert(Caps::COMPLEX);
}
}
// Let the caller handle caps2.
if let Some(c2) = caps2 {
header.caps2 = c2;
}
let compressed: bool = format.get_block_size().is_some();
let pitch: u32 = match format.get_pitch(width) {
Some(pitch) => pitch,
None => return Err(Error::UnsupportedFormat),
};
let depth = depth.unwrap_or(1);
if compressed {
header.flags |= HeaderFlags::LINEARSIZE;
let pitch_height = format.get_pitch_height();
let raw_height = (height + (pitch_height - 1)) / pitch_height;
header.linear_size = Some(pitch * raw_height * depth);
} else {
header.flags |= HeaderFlags::PITCH;
header.pitch = Some(pitch);
}
Ok(header)
}
pub fn read<R: Read>(mut r: R) -> Result<Header, Error> {
let size = r.read_u32::<LittleEndian>()?;
if size != 124 {
return Err(Error::InvalidField("Header struct size".to_owned()));
}
let flags = HeaderFlags::from_bits_truncate(r.read_u32::<LittleEndian>()?);
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 mip_map_count = r.read_u32::<LittleEndian>()?;
let mut reserved1 = [0_u32; 11];
r.read_u32_into::<LittleEndian>(&mut reserved1)?;
let spf = PixelFormat::read(&mut r)?;
let caps = r.read_u32::<LittleEndian>()?;
let caps2 = r.read_u32::<LittleEndian>()?;
let caps3 = r.read_u32::<LittleEndian>()?;
let caps4 = r.read_u32::<LittleEndian>()?;
let reserved2 = r.read_u32::<LittleEndian>()?;
Ok(Header {
size,
flags,
height,
width,
pitch: if flags.contains(HeaderFlags::PITCH) {
Some(pitch_or_linear_size)
} else {
None
},
linear_size: if flags.contains(HeaderFlags::LINEARSIZE) {
Some(pitch_or_linear_size)
} else {
None
},
depth: if flags.contains(HeaderFlags::DEPTH) {
Some(depth)
} else {
None
},
mip_map_count: if flags.contains(HeaderFlags::MIPMAPCOUNT) {
Some(mip_map_count)
} else {
None
},
reserved1,
spf,
caps: Caps::from_bits_truncate(caps),
caps2: Caps2::from_bits_truncate(caps2),
caps3,
caps4,
reserved2,
})
}
pub fn write<W: Write>(&self, w: &mut W) -> Result<(), Error> {
w.write_u32::<LittleEndian>(self.size)?;
w.write_u32::<LittleEndian>(self.flags.bits())?;
w.write_u32::<LittleEndian>(self.height)?;
w.write_u32::<LittleEndian>(self.width)?;
if let Some(pitch) = self.pitch {
w.write_u32::<LittleEndian>(pitch)?;
} else if let Some(ls) = self.linear_size {
w.write_u32::<LittleEndian>(ls)?;
} else {
w.write_u32::<LittleEndian>(0)?;
}
w.write_u32::<LittleEndian>(self.depth.unwrap_or(0))?;
w.write_u32::<LittleEndian>(self.mip_map_count.unwrap_or(0))?;
for u in &self.reserved1 {
w.write_u32::<LittleEndian>(*u)?;
}
self.spf.write(w)?;
w.write_u32::<LittleEndian>(self.caps.bits())?;
w.write_u32::<LittleEndian>(self.caps2.bits())?;
w.write_u32::<LittleEndian>(self.caps3)?;
w.write_u32::<LittleEndian>(self.caps4)?;
w.write_u32::<LittleEndian>(self.reserved2)?;
Ok(())
}
}
impl fmt::Debug for Header {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
writeln!(f, " Header:")?;
writeln!(f, " flags: {:?}", self.flags)?;
writeln!(
f,
" height: {:?}, width: {:?}, depth: {:?}",
self.height, self.width, self.depth
)?;
writeln!(
f,
" pitch: {:?} linear_size: {:?}",
self.pitch, self.linear_size
)?;
writeln!(f, " mipmap_count: {:?}", self.mip_map_count)?;
writeln!(f, " caps: {:?}, caps2 {:?}", self.caps, self.caps2)?;
write!(f, "{:?}", self.spf)?;
Ok(())
}
}
bitflags! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct HeaderFlags: u32 {
/// Required in every DDS file
const CAPS = 0x1;
/// Required in every DDS file
const HEIGHT = 0x2;
/// Required in every DDS file
const WIDTH = 0x4;
/// Required when pitch is provided for an uncompressed texture
const PITCH = 0x8;
/// Required in every DDS file
const PIXELFORMAT = 0x1000;
/// Required in a mipmapped texture
const MIPMAPCOUNT = 0x20000;
/// Required when pitch is provided for a compressed texture
const LINEARSIZE = 0x80000;
/// Required in a depth texture
const DEPTH = 0x800000;
}
}
bitflags! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Caps: u32 {
/// Optional; Must be used on any file that contains more than one surface
/// (a mipmap, a cubic environment, or a mipmapped volume texture)
const COMPLEX = 0x8;
/// Optional; should be used for a mipmap
const MIPMAP = 0x400000;
/// Required
const TEXTURE = 0x1000;
}
}
bitflags! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Caps2: u32 {
/// Required for a cube map
const CUBEMAP = 0x200;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_POSITIVEX = 0x400;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_NEGATIVEX = 0x800;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_POSITIVEY = 0x1000;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_NEGATIVEY = 0x2000;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_POSITIVEZ = 0x4000;
/// Required when these surfaces are stored in a cubemap
const CUBEMAP_NEGATIVEZ = 0x8000;
/// Required for a volume texture
const VOLUME = 0x200000;
/// Identical to setting all cubemap direction flags
const CUBEMAP_ALLFACES = Self::CUBEMAP_POSITIVEX.bits()
| Self::CUBEMAP_NEGATIVEX.bits()
| Self::CUBEMAP_POSITIVEY.bits()
| Self::CUBEMAP_NEGATIVEY.bits()
| Self::CUBEMAP_POSITIVEZ.bits()
| Self::CUBEMAP_NEGATIVEZ.bits();
}
}