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
//! This library implements the LZX compression format as described in
//! [LZX DELTA Compression and Decompression], revision 9.0.
//!
//! Lempel-Ziv Extended (LZX) is an LZ77-based compression engine, as described in [UASDC],
//! that is a universal lossless data compression algorithm. It performs no analysis on the
//! data.
//!
//! Lempel-Ziv Extended Delta (LZXD) is a derivative of the Lempel-Ziv Extended (LZX) format with
//! some modifications to facilitate efficient delta compression.
//!
//! In order to use this module, refer to the main [`Lzxd`] type and its methods.
//!
//! [LZX DELTA Compression and Decompression]: https://docs.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-patch/cc78752a-b4af-4eee-88cb-01f4d8a4c2bf
//! [UASDC]: https://ieeexplore.ieee.org/document/1055714
//! [`Lzxd`]: struct.Lzxd.html
use std::{fmt, mem};
pub(crate) use bitstream::Bitstream;
pub(crate) use block::{Block, Decoded, Kind as BlockKind};
pub(crate) use tree::{CanonicalTree, Tree};
use window::Window;
pub use window::WindowSize;
mod bitstream;
mod block;
mod tree;
mod window;
/// A chunk represents exactly 32 KB of uncompressed data until the last chunk in the stream,
/// which can represent less than 32 KB.
pub const MAX_CHUNK_SIZE: usize = 32 * 1024;
/// Decoder state needed for new blocks.
// TODO not sure how much we want to keep in DecoderState and Lzxd respectively
pub(crate) struct DecoderState {
/// The window size we're working with.
window_size: WindowSize,
/// This tree cannot be used directly, it exists only to apply the delta of upcoming trees
/// to its path lengths.
main_tree: CanonicalTree,
/// This tree cannot be used directly, it exists only to apply the delta of upcoming trees
/// to its path lengths.
length_tree: CanonicalTree,
}
struct PostProcessState {
/// The pointer in the file at which to stop performing E8 translation.
e8_translation_size: i32,
/// A buffer that can be used to hold postprocessed chunks.
data_chunk: Box<[u8]>,
}
/// The main interface to perform LZXD decompression.
///
/// This structure stores the required state to process the compressed chunks of data in a
/// sequential order.
///
/// ```no_run
/// # fn get_compressed_chunk() -> Option<(Vec<u8>, usize)> { unimplemented!() }
/// # fn write_data(a: &[u8]) { unimplemented!() }
/// use ::lzxd::{Lzxd, WindowSize};
///
/// let mut lzxd = Lzxd::new(WindowSize::KB64);
///
/// while let Some((chunk, output_size)) = get_compressed_chunk() {
/// let decompressed = lzxd.decompress_next(&chunk, output_size);
/// write_data(decompressed.unwrap());
/// }
/// ```
pub struct Lzxd {
/// Sliding window into which data is decompressed.
window: Window,
/// Current decoder state.
state: DecoderState,
/// > The three most recent real match offsets are kept in a list.
r: [u32; 3],
/// The current offset into the decompressed data.
chunk_offset: usize,
/// Has the very first chunk been read yet? Unlike the rest, it has additional data.
first_chunk_read: bool,
/// Current block.
current_block: Block,
/// Information and data related to E8 postprocessing. This is populated after
/// the first chunk is read.
postprocess: Option<PostProcessState>,
}
/// Specific cause for decompression failure.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum DecodeFailed {
/// The chunk data caused a read of more items than the current block had in a single step.
OverreadBlock,
/// There was not enough data in the chunk to fully decode, and a premature end was found.
UnexpectedEof,
/// An invalid block type was found.
InvalidBlock(u8),
/// An invalid block size was found.
InvalidBlockSize(u32),
/// An invalid pretree element was found.
InvalidPretreeElement(u16),
/// Invalid pretree run-length encoding.
InvalidPretreeRle,
/// When attempting to construct a decode tree, we encountered an invalid path length tree.
InvalidPathLengths,
/// A required decode tree was empty (all path lengths were 0).
EmptyTree,
/// The given window size was too small.
WindowTooSmall,
/// Tried to read a chunk longer than [`MAX_CHUNK_SIZE`].
///
/// [`MAX_CHUNK_SIZE`]: constant.MAX_CHUNK_SIZE.html
ChunkTooLong,
}
impl fmt::Display for DecodeFailed {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
use DecodeFailed::*;
match self {
OverreadBlock => write!(
f,
"read more items than available in the block in a single step"
),
UnexpectedEof => write!(f, "reached end of chunk without fully decoding it"),
InvalidBlock(kind) => write!(f, "block type {} is invalid", kind),
InvalidBlockSize(size) => write!(f, "block size {} is invalid", size),
InvalidPretreeElement(elem) => write!(f, "found invalid pretree element {}", elem),
InvalidPretreeRle => write!(f, "found invalid pretree rle element"),
InvalidPathLengths => write!(f, "encountered invalid path lengths"),
EmptyTree => write!(f, "encountered empty decode tree"),
WindowTooSmall => write!(f, "decode window was too small"),
ChunkTooLong => write!(
f,
"tried reading a chunk longer than {} bytes",
MAX_CHUNK_SIZE
),
}
}
}
impl std::error::Error for DecodeFailed {}
/// The error type used when decompression fails.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct DecompressError(DecodeFailed);
impl fmt::Display for DecompressError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
}
}
impl std::error::Error for DecompressError {}
impl From<DecodeFailed> for DecompressError {
fn from(value: DecodeFailed) -> Self {
Self(value)
}
}
impl Lzxd {
/// Creates a new instance of the LZXD decoder state. The [`WindowSize`] must be obtained
/// from elsewhere (e.g. it may be predetermined to a certain value), and if it's wrong,
/// the decompressed values won't be those expected.
///
/// [`WindowSize`]: enum.WindowSize.html
pub fn new(window_size: WindowSize) -> Self {
// > The main tree comprises 256 elements that correspond to all possible 8-bit
// > characters, plus 8 * NUM_POSITION_SLOTS elements that correspond to matches.
let main_tree = CanonicalTree::new(256 + 8 * window_size.position_slots());
// > The length tree comprises 249 elements.
let length_tree = CanonicalTree::new(249);
Self {
window: window_size.create_buffer(),
// > Because trees are output several times during compression of large amounts of
// > data (multiple blocks), LZXD optimizes compression by encoding only the delta
// > path lengths lengths between the current and previous trees.
//
// Because it uses deltas, we need to store the previous value across blocks.
state: DecoderState {
window_size,
main_tree,
length_tree,
},
// > The initial state of R0, R1, R2 is (1, 1, 1).
r: [1, 1, 1],
first_chunk_read: false,
chunk_offset: 0,
postprocess: None,
// Start with some dummy value.
current_block: Block {
remaining: 0,
size: 0,
kind: BlockKind::Uncompressed { r: [1, 1, 1] },
},
}
}
/// Try reading the header for the first chunk.
fn try_read_first_chunk(&mut self, bitstream: &mut Bitstream) -> Result<(), DecodeFailed> {
// > The first bit in the first chunk in the LZXD bitstream (following the 2-byte,
// > chunk-size prefix described in section 2.2.1) indicates the presence or absence of
// > two 16-bit fields immediately following the single bit. If the bit is set, E8
// > translation is enabled.
if !self.first_chunk_read {
self.first_chunk_read = true;
let e8_translation = bitstream.read_bit()? != 0;
self.postprocess = if e8_translation {
Some(PostProcessState {
data_chunk: vec![0; MAX_CHUNK_SIZE].into_boxed_slice(),
e8_translation_size: bitstream.read_bits(32)? as i32,
})
} else {
None
};
}
Ok(())
}
/// Attempts to perform post-decompression E8 fixups on an output data buffer.
fn postprocess(
translation_size: i32,
chunk_offset: usize,
idata: &mut [u8],
) -> Result<&[u8], DecodeFailed> {
let mut processed = 0usize;
// Find the next E8 match, or finish once there are no more E8 matches.
while let Some(pos) = idata[processed..]
.iter()
.position(|&e| e == 0xE8)
.map(|pos| processed + pos)
{
// N.B: E8 fixups are only performed for up to 10 bytes before the end of a chunk.
if idata.len() - pos <= 10 {
break;
}
// This is the current file output pointer.
let current_pointer = chunk_offset + pos;
// Match. Fix up the following bytes.
let abs_val = i32::from_le_bytes([
idata[pos + 1],
idata[pos + 2],
idata[pos + 3],
idata[pos + 4],
]);
if (abs_val >= -(current_pointer as i32)) && abs_val < translation_size {
let rel_val = if abs_val.is_positive() {
abs_val.wrapping_sub(current_pointer as i32)
} else {
abs_val.wrapping_add(translation_size)
};
idata[pos + 1..pos + 5].copy_from_slice(&rel_val.to_le_bytes());
}
processed = pos + 5;
}
Ok(idata)
}
/// Decompresses the next compressed `chunk` from the LZXD data stream.
pub fn decompress_next(
&mut self,
chunk: &[u8],
output_len: usize,
) -> Result<&[u8], DecompressError> {
// > A chunk represents exactly 32 KB of uncompressed data until the last chunk in the
// > stream, which can represent less than 32 KB.
//
// > The LZXD engine encodes a compressed, chunk-size prefix field preceding each
// > compressed chunk in the compressed byte stream. The compressed, chunk-size prefix
// > field is a byte aligned, little-endian, 16-bit field.
//
// However, this doesn't seem to be part of LZXD itself? At least when testing with
// `.xnb` files, every chunk comes with a compressed chunk size unless it has the flag
// set to 0xff where it also includes the uncompressed chunk size.
//
// TODO maybe the docs could clarify whether this length is compressed or not
let mut bitstream = Bitstream::new(chunk);
self.try_read_first_chunk(&mut bitstream)?;
let mut decoded_len = 0;
while decoded_len != output_len {
if self.current_block.remaining == 0 {
// Re-align the bitstream to word
// Related: https://github.com/GNOME/gcab/blob/master/libgcab/decomp.c#L883.
// Related: https://github.com/kyz/libmspack/blob/master/libmspack/mspack/lzxd.c#L469
if matches!(self.current_block.kind, BlockKind::Uncompressed { .. })
&& self.current_block.size % 2 != 0
{
bitstream.read_byte();
}
self.current_block = Block::read(&mut bitstream, &mut self.state)?;
assert_ne!(self.current_block.remaining, 0);
}
let decoded = self
.current_block
.decode_element(&mut bitstream, &mut self.r)?;
let advance = match decoded {
Decoded::Single(value) => {
self.window.push(value);
1
}
Decoded::Match { offset, length } => {
self.window.copy_from_self(offset, length);
length
}
Decoded::Read(length) => {
// Read up to end of chunk, to allow for larger blocks.
let length = usize::min(bitstream.remaining_bytes(), length);
// Will re-align if needed, just as decompressed reads mandate.
self.window.copy_from_bitstream(&mut bitstream, length)?;
length
}
};
assert_ne!(advance, 0);
decoded_len += advance;
if let Some(value) = self.current_block.remaining.checked_sub(advance as u32) {
self.current_block.remaining = value;
} else {
return Err(DecodeFailed::OverreadBlock.into());
}
}
let chunk_offset = self.chunk_offset;
self.chunk_offset += decoded_len;
let view = self.window.past_view(decoded_len)?;
if let Some(postprocess) = self.postprocess.as_mut() {
// E8 fixups are disabled after 1GB of input data,
// or if the chunk size is too small.
if chunk_offset >= 0x4000_0000 || decoded_len <= 10 {
Ok(view)
} else {
let postprocess_buf = &mut postprocess.data_chunk[..decoded_len];
postprocess_buf.copy_from_slice(view);
// E8 fixups are enabled. Postprocess the output buffer.
let view = Self::postprocess(
postprocess.e8_translation_size,
chunk_offset,
postprocess_buf,
)?;
Ok(view)
}
} else {
Ok(view)
}
}
/// Resets the decoder state.
///
/// This is equivalent to calling [`Self::new`] with the same [`WindowSize`].
/// [`WindowSize`]: enum.WindowSize.html
pub fn reset(&mut self) {
let this = Self::new(self.state.window_size);
let _ = mem::replace(self, this);
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn check_uncompressed() {
let data = [
0x00, 0x30, 0x30, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x00,
0x00, 0x00, b'a', b'b', b'c', 0x00,
];
let mut lzxd = Lzxd::new(WindowSize::KB32); // size does not matter
let res = lzxd.decompress_next(&data, 3);
assert_eq!(res.unwrap(), [b'a', b'b', b'c']);
}
#[test]
fn reset() {
let data = [
0x00, 0x30, 0x30, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x00,
0x00, 0x00, b'a', b'b', b'c', 0x00,
];
let mut lzxd = Lzxd::new(WindowSize::KB32); // size does not matter
let res = lzxd.decompress_next(&data, 3);
assert_eq!(res.unwrap(), [b'a', b'b', b'c']);
lzxd.reset();
let res = lzxd.decompress_next(&data, 3);
assert_eq!(res.unwrap(), [b'a', b'b', b'c']);
}
#[test]
fn check_e8() {
let data = [
0x5B, 0x80, 0x80, 0x8D, 0x00, 0x30, 0x80, 0x0A, 0x18, 0x00, 0x00, 0x00, 0x01, 0x00,
0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0x54, 0x68, 0x69, 0x73, 0x20, 0x66, 0x69, 0x6C,
0x65, 0x20, 0x68, 0x61, 0x73, 0x20, 0x61, 0x6E, 0x20, 0x45, 0x38, 0x20, 0x62, 0x79,
0x74, 0x65, 0x20, 0x74, 0x6F, 0x20, 0x74, 0x65, 0x73, 0x74, 0x20, 0x45, 0x38, 0x20,
0x74, 0x72, 0x61, 0x6E, 0x73, 0x6C, 0x61, 0x74, 0x69, 0x6F, 0x6E, 0x2C, 0x20, 0x58,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64, 0xE8, 0x7B,
0x00, 0x00, 0x00, 0xE8, 0x7B, 0x00, 0x00, 0x00, 0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
0x64, 0x64, 0x64, 0x64, 0x64, 0x64,
];
let mut lzxd = Lzxd::new(WindowSize::KB32);
let res = lzxd.decompress_next(&data, 168);
assert_eq!(
res.unwrap(),
b"This file has an E8 byte to test E8 translation, Xdddddddddddddddd\
dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd\
dddddddddddddd\xE8\xE9\xFF\xFF\xFF\xE8\xE4\xFF\xFF\xFFdddddddddddd"
);
}
}