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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
use crate::block_hash::BlockChecksum;
use crate::compression::CompressionCodec;
use crate::error::{Error, Result};
use crate::header::Header;
use crate::map::{
CompressedEntryProof, CompressionTypeLegacy, CompressionTypeV5, Map, MapEntry,
UncompressedEntryProof,
};
#[cfg(feature = "unstable_lending_iterators")]
use crate::iter::{Hunks, MetadataEntries};
use crate::metadata::MetadataRefs;
use byteorder::{BigEndian, WriteBytesExt};
use crc::Crc;
use num_traits::ToPrimitive;
use std::io::{Cursor, Read, Seek, SeekFrom};
use std::panic::AssertUnwindSafe;
/// A CHD (MAME Compressed Hunks of Data) file.
pub struct Chd<F: Read + Seek> {
file: F,
header: Header,
parent: Option<Box<Chd<F>>>,
map: Map,
// codecs contain Box<dyn CompressionCodec> which are all UnwindSafe.
codecs: AssertUnwindSafe<Codecs>,
}
impl<F: Read + Seek> Chd<F> {
/// Open a CHD file from a `Read + Seek` stream. Optionally provide a parent of the same stream
/// type.
///
/// The CHD header and hunk map are read and validated immediately.
///
/// If the CHD file requires a parent, and a parent is provided, the parent hash is
/// validated. If hash validation fails, returns [`Error::InvalidParent`](crate::Error::InvalidParent).
///
/// If the CHD file does not require a parent, and a parent is provided, returns
/// [`Error::InvalidParameter`](crate::Error::InvalidParameter).
/// If no parent CHD is provided and the file requires a parent, then the presence of the parent
/// will not be immediately validated. However, calls to [`read_hunk_in`](crate::Hunk::read_hunk_in)
/// will fail with [`Error::RequiresParent`](crate::Error::RequiresParent) when a hunk is read that
/// refers to the parent CHD.
pub fn open(mut file: F, parent: Option<Box<Chd<F>>>) -> Result<Chd<F>> {
let header = Header::try_read_header(&mut file)?;
// No point in checking writable because traits are read only.
// In the future if we want to support a Write feature, will need to ensure writable.
if let Some(p) = parent.as_ref() {
if !header.has_parent() {
return Err(Error::InvalidParameter);
}
if p.header().sha1() != header.parent_sha1() {
return Err(Error::InvalidParent);
}
// should be None for V4+
if p.header().md5() != header.parent_md5() {
return Err(Error::InvalidParent);
}
}
let map = Map::try_read_map(&header, &mut file)?;
let codecs = AssertUnwindSafe(header.create_compression_codecs()?);
Ok(Chd {
file,
header,
parent,
map,
codecs,
})
}
/// Returns a reference to the CHD header for this CHD file.
pub fn header(&self) -> &Header {
&self.header
}
/// Returns an iterator over references to metadata entries for this CHD file.
///
/// The contents of each metadata entry are lazily read.
pub fn metadata_refs(&mut self) -> MetadataRefs<F> {
let offset = self.header().meta_offset();
if let Some(offset) = offset {
MetadataRefs::from_stream(&mut self.file, offset)
} else {
MetadataRefs::dead(&mut self.file)
}
}
#[cfg(feature = "unstable_lending_iterators")]
#[cfg_attr(docsrs, doc(cfg(unstable_lending_iterators)))]
/// Returns an iterator over metadata entries for this CHD file.
///
/// The contents of each metadata entry are lazily read.
pub fn metadata(&mut self) -> MetadataEntries<F> {
MetadataEntries::new(self.metadata_refs())
}
/// Returns the hunk map of this CHD File.
pub fn map(&self) -> &Map {
&self.map
}
/// Returns a reference to the given hunk in this CHD file.
///
/// If the requested hunk is larger than the number of hunks in the CHD file,
/// returns `Error::HunkOutOfRange`.
pub fn hunk(&mut self, hunk_num: u32) -> Result<Hunk<F>> {
if hunk_num >= self.header.hunk_count() {
return Err(Error::HunkOutOfRange);
}
Ok(Hunk {
inner: self,
hunk_num,
})
}
/// Allocates a buffer with the same length as the hunk size of this CHD file.
pub fn get_hunksized_buffer(&self) -> Vec<u8> {
let hunk_size = self.header.hunk_size() as usize;
vec![0u8; hunk_size]
}
#[cfg_attr(docsrs, doc(cfg(unstable_lending_iterators)))]
#[cfg(feature = "unstable_lending_iterators")]
/// Returns an iterator over the hunks of this CHD file.
pub fn hunks(&mut self) -> Hunks<F> {
Hunks::new(self)
}
/// Consumes the `Chd` and returns the underlying reader and parent if present.
pub fn into_inner(self) -> (F, Option<Box<Chd<F>>>) {
(self.file, self.parent)
}
/// Returns a mutable reference to the inner stream.
pub fn inner(&mut self) -> &mut F {
&mut self.file
}
/// Returns a mutable reference to the inner parent stream if present.
pub fn inner_parent(&mut self) -> Option<&mut F> {
self.parent.as_deref_mut().map(|f| f.inner())
}
}
/// A reference to a compressed Hunk in a CHD file.
pub struct Hunk<'a, F: Read + Seek> {
inner: &'a mut Chd<F>,
hunk_num: u32,
}
impl<'a, F: Read + Seek> Hunk<'a, F> {
/// Buffer the compressed bytes into the hunk buffer.
fn read_compressed_in(
&mut self,
map_entry: CompressedEntryProof,
comp_buf: &mut Vec<u8>,
) -> Result<()> {
let offset = map_entry.block_offset();
let length = map_entry.block_size();
comp_buf.resize(length as usize, 0);
self.inner.file.seek(SeekFrom::Start(offset))?;
let read = self.inner.file.read(comp_buf)?;
if read != length as usize {
return Err(Error::ReadError);
}
Ok(())
}
fn read_uncompressed(
&mut self,
map_entry: UncompressedEntryProof,
dest: &mut [u8],
) -> Result<usize> {
let offset = map_entry.block_offset();
let length = map_entry.block_size();
if dest.len() != length as usize {
return Err(Error::InvalidParameter);
}
self.inner.file.seek(SeekFrom::Start(offset))?;
let read = self.inner.file.read(dest)?;
Ok(read)
}
fn read_hunk_legacy(&mut self, comp_buf: &mut Vec<u8>, dest: &mut [u8]) -> Result<usize> {
let map_entry = self
.inner
.map()
.get_entry(self.hunk_num as usize)
.ok_or(Error::HunkOutOfRange)?;
match map_entry {
MapEntry::LegacyEntry(entry) => {
let block_len = entry.block_size() as usize;
let block_crc = entry.hunk_crc();
let block_off = entry.block_offset();
match entry.hunk_type()? {
CompressionTypeLegacy::Compressed => {
// buffer the compressed data
let proof = entry.prove_compressed()?;
self.read_compressed_in(proof, comp_buf)?;
let res = &self
.inner
.codecs
.first_mut()
.decompress(&comp_buf[..block_len], dest)?;
Crc::<u32>::verify_block_checksum(block_crc, dest, res.total_out())
}
CompressionTypeLegacy::Uncompressed => {
let proof = entry.prove_uncompressed()?;
let res = self.read_uncompressed(proof, dest)?;
Crc::<u32>::verify_block_checksum(block_crc, dest, res)
}
CompressionTypeLegacy::Mini => {
let mut cursor = Cursor::new(dest);
cursor.write_u64::<BigEndian>(entry.block_offset())?;
let dest = cursor.into_inner();
let mut bytes_read_into = std::mem::size_of::<u64>();
// todo: optimize this operation
for off in
std::mem::size_of::<u64>()..self.inner.header().hunk_size() as usize
{
dest[off] = dest[off - 8];
bytes_read_into += 1;
}
Crc::<u32>::verify_block_checksum(block_crc, dest, bytes_read_into)
}
CompressionTypeLegacy::SelfHunk => {
let mut self_hunk = self.inner.hunk(block_off as u32)?;
let res = self_hunk.read_hunk_in(comp_buf, dest)?;
Ok(res)
}
CompressionTypeLegacy::ParentHunk => match self.inner.parent.as_deref_mut() {
None => Err(Error::RequiresParent),
Some(parent) => {
let mut parent = parent.hunk(block_off as u32)?;
let res = parent.read_hunk_in(comp_buf, dest)?;
Ok(res)
}
},
CompressionTypeLegacy::ExternalCompressed => Err(Error::UnsupportedFormat),
CompressionTypeLegacy::Invalid => Err(Error::InvalidData),
}
}
_ => Err(Error::InvalidParameter),
}
}
fn read_hunk_v5(&mut self, comp_buf: &mut Vec<u8>, dest: &mut [u8]) -> Result<usize> {
let map_entry = self
.inner
.map()
.get_entry(self.hunk_num as usize)
.ok_or(Error::HunkOutOfRange)?;
let has_parent = self.inner.header.has_parent();
match map_entry {
MapEntry::V5Compressed(entry) => {
let block_off = entry.block_offset()?;
let block_crc = Some(entry.hunk_crc()?);
match entry.hunk_type()? {
comptype @ CompressionTypeV5::CompressionType0
| comptype @ CompressionTypeV5::CompressionType1
| comptype @ CompressionTypeV5::CompressionType2
| comptype @ CompressionTypeV5::CompressionType3 => {
// buffer the compressed data
let proof = entry.prove_compressed()?;
self.read_compressed_in(proof, comp_buf)?;
if let Some(codec) = self.inner.codecs.get_mut(comptype.to_usize().unwrap())
{
let res = codec.decompress(comp_buf, dest)?;
Crc::<u16>::verify_block_checksum(block_crc, dest, res.total_out())
} else {
Err(Error::UnsupportedFormat)
}
}
CompressionTypeV5::CompressionNone => {
let proof = entry.prove_uncompressed()?;
let res = self.read_uncompressed(proof, dest)?;
Crc::<u16>::verify_block_checksum(block_crc, dest, res)
}
CompressionTypeV5::CompressionSelf => {
let mut self_hunk = self.inner.hunk(block_off as u32)?;
let res = self_hunk.read_hunk_in(comp_buf, dest)?;
Ok(res)
}
CompressionTypeV5::CompressionParent => {
let hunk_bytes = self.inner.header().hunk_size();
let unit_bytes = self.inner.header().unit_bytes();
let units_in_hunk = hunk_bytes / unit_bytes;
match self.inner.parent.as_deref_mut() {
None => Err(Error::RequiresParent),
Some(parent) => {
let mut buf = vec![0u8; hunk_bytes as usize];
let mut parent_hunk =
parent.hunk(block_off as u32 / units_in_hunk)?;
let res_1 = parent_hunk.read_hunk_in(comp_buf, &mut buf)?;
if block_off % units_in_hunk as u64 == 0 {
dest.copy_from_slice(&buf);
return Ok(res_1);
}
let remainder_in_hunk = block_off as usize % units_in_hunk as usize;
let hunk_split = (units_in_hunk as usize - remainder_in_hunk)
* unit_bytes as usize;
dest[..hunk_split].copy_from_slice(
&buf[remainder_in_hunk * unit_bytes as usize..][..hunk_split],
);
let mut parent_hunk =
parent.hunk((block_off as u32 / units_in_hunk) + 1)?;
let _res_2 = parent_hunk.read_hunk_in(comp_buf, &mut buf)?;
dest[hunk_split..].copy_from_slice(
&buf[..remainder_in_hunk
* self.inner.header().unit_bytes() as usize],
);
Crc::<u16>::verify_block_checksum(
block_crc,
dest,
hunk_split + remainder_in_hunk * unit_bytes as usize,
)
}
}
}
_ => Err(Error::UnsupportedFormat),
}
}
MapEntry::V5Uncompressed(entry) => {
match (entry.block_offset()?, has_parent) {
(0, false) => {
dest.fill(0);
Ok(dest.len())
}
(0, true) => {
if let Some(parent) = self.inner.parent.as_deref_mut() {
let mut parent = parent.hunk(self.hunk_num)?;
let res = parent.read_hunk_in(comp_buf, dest)?;
Ok(res)
} else {
Err(Error::RequiresParent)
}
}
(_offset, _) => {
// read_uncompressed will handle the proper offset for us automatically.
let proof = entry.prove_uncompressed()?;
let res = self.read_uncompressed(proof, dest)?;
Ok(res)
}
}
}
MapEntry::LegacyEntry(_) => Err(Error::InvalidParameter),
}
}
/// Decompresses the hunk into output, using the provided temporary buffer to hold the
/// compressed hunk. The size of the output buffer must be equal to the hunk size of the
/// CHD file.
///
/// Returns the number of bytes decompressed on success, which should be the length of
/// the output buffer.
///
/// If the hunk refers to a parent CHD that was not provided, this will return
/// [`Error::RequiresParent`](crate::Error::RequiresParent).
///
/// If the provided output buffer is the wrong length, this will return
/// If the hunk refers to a parent CHD that was not provided, this will return
/// [`Error::OutOfMemory`](crate::Error::OutOfMemory).
pub fn read_hunk_in(
&mut self,
compressed_buffer: &mut Vec<u8>,
output: &mut [u8],
) -> Result<usize> {
if output.len() != self.inner.header.hunk_size() as usize {
return Err(Error::OutOfMemory);
}
match self.inner.map() {
Map::V5(_) => self.read_hunk_v5(compressed_buffer, output),
Map::Legacy(_) => self.read_hunk_legacy(compressed_buffer, output),
}
}
/// Read the raw, compressed contents of the hunk into the provided buffer.
///
/// Returns the number of bytes read on success.
pub fn read_raw_in(&mut self, output: &mut Vec<u8>) -> Result<usize> {
let map_entry = self
.inner
.map()
.get_entry(self.hunk_num as usize)
.ok_or(Error::HunkOutOfRange)?;
let (offset, size) = match map_entry {
MapEntry::V5Compressed(map_entry) => {
(map_entry.block_offset()?, map_entry.block_size()?)
}
MapEntry::V5Uncompressed(map_entry) => {
(map_entry.block_offset()?, map_entry.block_size())
}
MapEntry::LegacyEntry(map_entry) => (map_entry.block_offset(), map_entry.block_size()),
};
output.resize(size as usize, 0);
self.inner.file.seek(SeekFrom::Start(offset))?;
let read = self.inner.file.read(output)?;
Ok(read)
}
#[allow(clippy::len_without_is_empty)]
/// Returns the length of this hunk in bytes.
pub fn len(&self) -> usize {
self.inner.header.hunk_size() as usize
}
}
pub(crate) enum Codecs {
Single(Box<dyn CompressionCodec>),
Four([Box<dyn CompressionCodec>; 4]),
}
impl Codecs {
pub fn first_mut(&mut self) -> &mut Box<dyn CompressionCodec> {
match self {
Codecs::Single(c) => c,
Codecs::Four([c, ..]) => c,
}
}
pub fn get_mut(&mut self, index: usize) -> Option<&mut Box<dyn CompressionCodec>> {
if index == 0 {
match self {
Codecs::Single(c) => Some(c),
Codecs::Four([c, ..]) => Some(c),
}
} else {
match self {
Codecs::Four(a) => Some(&mut a[index]),
_ => None,
}
}
}
}