Added experimentation binary

Cargo.toml

@@ -1,7 +1,7 @@
 [workspace]
 resolver = "2"
 members = [
-    "cz",
+    "cz", "experimental",
     "luca_pak",
     "utils",
 ]

cz/src/binio.rs

@@ -1,8 +1,3 @@
-pub enum BitError {
-    InputLength
-}
-
-
 pub struct BitIo {
     data: Vec<u8>,
     byte_offset: usize,
@@ -40,7 +35,7 @@ impl BitIo {
     /// Read some bits from the buffer
     pub fn read_bit(&mut self, bit_len: usize) -> u64 {
         if bit_len > 8 * 8 {
-            panic!()
+            panic!("Cannot read more than 64 bits")
         }
 
         if bit_len % 8 == 0 && self.bit_offset == 0 {
@@ -66,7 +61,7 @@ impl BitIo {
     /// Read some bytes from the buffer
     pub fn read(&mut self, byte_len: usize) -> u64 {
         if byte_len > 8 {
-            panic!()
+            panic!("Cannot read more than 8 bytes")
         }
 
         let mut padded_slice = [0u8; 8];
@@ -79,7 +74,7 @@ impl BitIo {
     /// Write some bits to the buffer
     pub fn write_bit(&mut self, data: u64, bit_len: usize) {
         if bit_len > 8 * 8 {
-            panic!();
+            panic!("Cannot write more than 64 bits");
         }
 
         if bit_len % 8 == 0 && self.bit_offset == 0 {
@@ -104,9 +99,9 @@ impl BitIo {
         self.byte_size = self.byte_offset + (self.bit_offset + 7) / 8;
     }
 
-    pub fn write(&mut self, data: u64, byte_len: usize) -> Result<(), BitError> {
+    pub fn write(&mut self, data: u64, byte_len: usize) {
         if byte_len > 8 {
-            return Err(BitError::InputLength);
+            panic!("Cannot write more than 8 bytes")
         }
 
         let mut padded_slice = [0u8; 8];
@@ -117,7 +112,5 @@ impl BitIo {
         self.byte_offset += byte_len;
 
         self.byte_size = self.byte_offset + (self.bit_offset + 7) / 8;
-
-        Ok(())
     }
 }

cz/src/color.rs

@@ -107,13 +107,9 @@ pub fn indexed_gen_palette(
         .map(|c| Rgba([c.r, c.g, c.b, c.a]))
         .collect();
 
-    dbg!(gen_palette.len());
-
     let mut output_palette = vec![Rgba([0, 0, 0, 0]); 256];
     output_palette[0..gen_palette.len()].copy_from_slice(&gen_palette);
 
-    dbg!(output_palette.len());
-
     Ok((indicies, output_palette))
 }
 

cz/src/common.rs

@@ -16,6 +16,9 @@ pub enum CzError {
     #[error("Bitmap size does not match image size")]
     BitmapFormat,
 
+    #[error("CZ version is invalid: {}", 0)]
+    InvalidVersion(u32),
+
     #[error("File data is incorrect, it might be corrupt: {0}")]
     Corrupt(String),
 
@@ -156,10 +159,10 @@ impl CommonHeader {
         self.version
     }
 
-    pub fn set_version<I: TryInto<CzVersion>>(&mut self, version: I) -> Result<(), ()> {
-        self.version = match version.try_into() {
+    pub fn set_version<I: TryInto<CzVersion> + Into<u32> + Clone>(&mut self, version: I) -> Result<(), CzError> {
+        self.version = match version.clone().try_into() {
             Ok(val) => val,
-            Err(_) => return Err(()),
+            Err(_) => return Err(CzError::InvalidVersion(version.into())),
         };
 
         Ok(())

cz/src/compression.rs

@@ -27,7 +27,7 @@ pub struct CompressionInfo {
     pub total_size_compressed: usize,
 
     /// Total size of the original uncompressed data
-    pub total_size_raw: usize,
+    pub _total_size_raw: usize,
 
     /// The compression chunk information
     pub chunks: Vec<ChunkInfo>,
@@ -82,7 +82,7 @@ pub fn get_chunk_info<T: Seek + ReadBytesExt + Read>(
     Ok(CompressionInfo {
         chunk_count: parts_count as usize,
         total_size_compressed: total_size as usize,
-        total_size_raw: total_size_raw as usize,
+        _total_size_raw: total_size_raw as usize,
         chunks: part_sizes,
         length: bytes.stream_position()? as usize,
     })
@@ -93,70 +93,59 @@ pub fn decompress<T: Seek + ReadBytesExt + Read>(
     input: &mut T,
     chunk_info: &CompressionInfo,
 ) -> Result<Vec<u8>, CzError> {
-    let mut m_dst = 0;
-    let mut bitmap = vec![0; chunk_info.total_size_raw];
-    for chunk in &chunk_info.chunks {
-        let mut part = vec![0u8; chunk.size_compressed * 2];
-        input.read_exact(&mut part)?;
+    let mut output_buf: Vec<u8> = vec![];
 
-        for j in (0..part.len()).step_by(2) {
-            let ctl = part[j + 1];
+    for block in &chunk_info.chunks {
+        let mut buffer = vec![0u16; block.size_compressed];
 
-            if ctl == 0 {
-                bitmap[m_dst] = part[j];
-                m_dst += 1;
-            } else {
-                m_dst += copy_range(&mut bitmap, &part, get_offset(&part, j), m_dst);
-            }
+        for word in buffer.iter_mut() {
+            *word = input.read_u16::<LittleEndian>().unwrap();
         }
+
+        let raw_buf = decompress_lzw(&buffer, block.size_raw);
+
+        output_buf.write_all(&raw_buf)?;
     }
 
-    bitmap.truncate(chunk_info.total_size_raw);
-
-    Ok(bitmap)
+    Ok(output_buf)
 }
 
-fn get_offset(input: &[u8], src: usize) -> usize {
-    (((input[src] as usize) | (input[src + 1] as usize) << 8) - 0x101) * 2
-}
-
-fn copy_range(bitmap: &mut Vec<u8>, input: &[u8], src: usize, dst: usize) -> usize {
-    let mut dst = dst;
-    let start_pos = dst;
-
-    if input[src + 1] == 0 {
-        bitmap[dst] = input[src];
-        dst += 1;
-    } else if get_offset(input, src) == src {
-        bitmap[dst] = 0;
-        dst += 1;
-    } else {
-        dst += copy_range(bitmap, input, get_offset(input, src), dst);
+fn decompress_lzw(
+    input_data: &[u16],
+    size: usize
+) -> Vec<u8> {
+    let mut dictionary: HashMap<u16, Vec<u8>> = HashMap::new();
+    for i in 0..256 {
+        dictionary.insert(i as u16, vec![i as u8]);
     }
+    let mut dictionary_count = dictionary.len() as u16;
 
-    if input[src + 3] == 0 {
-        bitmap[dst] = input[src + 2];
-        dst += 1;
-    } else if get_offset(input, src + 2) == src {
-        bitmap[dst] = bitmap[start_pos];
-        dst += 1;
-    } else {
-        bitmap[dst] = copy_one(input, get_offset(input, src + 2));
-        dst += 1;
-    }
+    let mut w = vec![0];
+    let mut result = Vec::with_capacity(size);
 
-    dst - start_pos
+    input_data.iter().for_each(|element| {
+        let mut entry;
+        if let Some(x) = dictionary.get(element) {
+            entry = x.clone();
+        } else if *element == dictionary_count {
+            entry = w.clone();
+            entry.push(w[0]);
+        } else {
+            panic!("Bad compressed element: {}", element)
+        }
+
+        result.write_all(&entry).unwrap();
+        w.push(entry[0]);
+
+        dictionary.insert(dictionary_count, w.clone());
+        dictionary_count += 1;
+
+        w = entry;
+    });
+
+    result
 }
 
-fn copy_one(input: &[u8], src: usize) -> u8 {
-    if input[src + 1] == 0 {
-        input[src]
-    } else if get_offset(input, src) == src {
-        0
-    } else {
-        copy_one(input, get_offset(input, src))
-    }
-}
 
 /// Decompress an LZW compressed stream like CZ2
 pub fn decompress2<T: Seek + ReadBytesExt + Read>(
@@ -177,7 +166,10 @@ pub fn decompress2<T: Seek + ReadBytesExt + Read>(
     Ok(output_buf)
 }
 
-fn decompress_lzw2(input_data: &[u8], size: usize) -> Vec<u8> {
+fn decompress_lzw2(
+    input_data: &[u8],
+    size: usize
+) -> Vec<u8> {
     let mut data = input_data.to_vec();
     data[0] = 0;
     let mut dictionary = HashMap::new();
@@ -244,7 +236,7 @@ pub fn compress(
 
     let mut output_buf: Vec<u8> = vec![];
     let mut output_info = CompressionInfo {
-        total_size_raw: data.len(),
+        _total_size_raw: data.len(),
         ..Default::default()
     };
 
@@ -279,7 +271,11 @@ pub fn compress(
     (output_buf, output_info)
 }
 
-fn compress_lzw(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u16>, Vec<u8>) {
+fn compress_lzw(
+    data: &[u8],
+    size: usize,
+    last: Vec<u8>
+) -> (usize, Vec<u16>, Vec<u8>) {
     let mut count = 0;
     let mut dictionary = HashMap::new();
     for i in 0..=255 {
@@ -331,7 +327,10 @@ fn compress_lzw(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u16>, Ve
     (count, compressed, last_element)
 }
 
-pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
+pub fn compress2(
+    data: &[u8],
+    size: usize
+) -> (Vec<u8>, CompressionInfo) {
     let size = if size == 0 { 0x87BDF } else { size };
 
     let mut part_data;
@@ -342,7 +341,7 @@ pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
 
     let mut output_buf: Vec<u8> = Vec::new();
     let mut output_info = CompressionInfo {
-        total_size_raw: data.len(),
+        _total_size_raw: data.len(),
         ..Default::default()
     };
 
@@ -374,7 +373,11 @@ pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
     (output_buf, output_info)
 }
 
-fn compress_lzw2(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u8>, Vec<u8>) {
+fn compress_lzw2(
+    data: &[u8],
+    size: usize,
+    last: Vec<u8>
+) -> (usize, Vec<u8>, Vec<u8>) {
     let mut data = data.to_vec();
     if !data.is_empty() {
         data[0] = 0;

cz/src/dynamic.rs

@@ -113,7 +113,7 @@ impl DynamicCz {
     /// to change the CZ# version.
     pub fn save_as_cz<T: Into<std::path::PathBuf>>(&self, path: T) -> Result<(), CzError> {
         let mut out_file = BufWriter::new(File::create(path.into())?);
-        let mut header = self.header().clone();
+        let mut header = *self.header();
 
         if header.version() == CzVersion::CZ2 {
             header.set_length(0x12)

cz/src/formats/cz3.rs

@@ -55,9 +55,9 @@ fn line_diff(header: &CommonHeader, data: &[u8]) -> Vec<u8> {
     let mut curr_line;
     let mut prev_line = Vec::with_capacity(line_byte_count);
 
-    let mut i = 0;
+    let mut index = 0;
     for y in 0..height {
-        curr_line = data[i..i + line_byte_count].to_vec();
+        curr_line = data[index..index + line_byte_count].to_vec();
 
         if y % block_height as u32 != 0 {
             curr_line.iter_mut().zip(&prev_line).for_each(|(curr_p, prev_p)| {
@@ -67,7 +67,7 @@ fn line_diff(header: &CommonHeader, data: &[u8]) -> Vec<u8> {
 
         prev_line.clone_from(&curr_line);
         if pixel_byte_count == 4 {
-            output_buf[i..i + line_byte_count].copy_from_slice(&curr_line);
+            output_buf[index..index + line_byte_count].copy_from_slice(&curr_line);
         } else if pixel_byte_count == 3 {
             for x in (0..line_byte_count).step_by(3) {
                 let loc = (y * 3 * width) as usize + x;
@@ -86,7 +86,7 @@ fn line_diff(header: &CommonHeader, data: &[u8]) -> Vec<u8> {
             }
         }
 
-        i += line_byte_count;
+        index += line_byte_count;
     }
 
     output_buf

cz/src/formats/cz4.rs

@@ -68,18 +68,23 @@ fn line_diff(header: &CommonHeader, data: &[u8]) -> Vec<u8> {
             });
         }
 
-        for x in 0..width as usize {
-            let pos = x * 3;
-            output_buf.extend_from_slice(&[
-                curr_line[pos],
-                curr_line[pos + 1],
-                curr_line[pos + 2],
-                curr_alpha[x],
-            ]);
-        }
+        // Write the decoded RGBA data to the final buffer
+        curr_line
+            .windows(3)
+            .step_by(3)
+            .zip(&curr_alpha)
+            .for_each(|(curr_p, alpha_p)| {
+                output_buf.extend_from_slice(&[
+                    curr_p[0],
+                    curr_p[1],
+                    curr_p[2],
+                    *alpha_p,
+                ]);
+            });
 
         prev_line.clone_from(&curr_line);
         prev_alpha.clone_from(&curr_alpha);
+
         rgb_index += width as usize * 3;
         alpha_index += width as usize;
     }

experimental/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "experimental"
+description = """
+A package for experimentation, not for publishing
+"""
+version = "0.1.0"
+edition = "2021"
+authors.workspace = true
+publish = false
+
+[dependencies]
+cz = { path = "../cz/", features = ["png"] }
+
+[lints]
+workspace = true

experimental/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

luca_pak/src/lib.rs

@@ -134,6 +134,7 @@ impl Pak {
                 length: offsets[i].1,
                 data,
                 name: Some(file_names[i].clone()),
+                unknown1: todo!(),
                 id: header.id_start + i as u32,
                 replace: false,
             };

luca_pak/src/main.rs

@@ -6,6 +6,5 @@ fn main() {
 
     for entry in pak.entries() {
         println!("{}", entry.name().as_ref().unwrap());
-        println!("{}", entry);
     }
 }

utils/Cargo.toml

@@ -8,6 +8,6 @@ edition = "2021"
 [dependencies]
 byteorder = "1.5.0"
 clap = { version = "4.5.4", features = ["derive", "unicode"] }
-cz = { path = "../cz" }
-image = { version = "0.25.1", default-features = false, features = ["png"] }
+cz = { path = "../cz", features = ["png"] }
+image = { version = "0.25", default-features = false, features = ["png"] }
 walkdir = "2.5.0"

utils/src/main.rs

@@ -1,7 +1,5 @@
 use cz::DynamicCz;
-
-use std::path::PathBuf;
-
+use std::path::{Path, PathBuf};
 use clap::{error::ErrorKind, Error, Parser, Subcommand};
 
 #[derive(Parser)]
@@ -54,7 +52,7 @@ enum Commands {
 
         /// Output CZ file bit depth
         #[arg(short, long, value_name = "BIT DEPTH")]
-        depth: Option<u8>,
+        depth: Option<u16>,
     }
 }
 
@@ -65,25 +63,16 @@ fn main() {
     match &cli.command {
         Commands::Decode { input, output, batch } => {
             if !input.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    format!("The input file/folder provided does not exist\n")
-                ).exit()
+                Error::raw(ErrorKind::ValueValidation, "The input file/folder provided does not exist\n").exit()
             }
 
             if *batch {
                 if input.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        format!("Batch input must be a directory\n")
-                    ).exit()
+                    Error::raw(ErrorKind::ValueValidation, "Batch input must be a directory\n").exit()
                 }
 
                 if output.is_none() || output.as_ref().unwrap().is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        format!("Batch output must be a directory\n")
-                    ).exit()
+                    Error::raw(ErrorKind::ValueValidation, "Batch output must be a directory\n").exit()
                 }
 
                 for entry in walkdir::WalkDir::new(input).max_depth(1) {
@@ -124,154 +113,120 @@ fn main() {
         }
         Commands::Replace { batch, input, replacement, output, version, depth } => {
             if !input.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    format!("The original file provided does not exist\n")
-                ).exit()
+                Error::raw(ErrorKind::ValueValidation, "The original file provided does not exist\n").exit()
             }
 
             if !replacement.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    format!("The replacement file provided does not exist\n")
-                ).exit()
+                Error::raw(ErrorKind::ValueValidation, "The replacement file provided does not exist\n").exit()
             }
 
+            // If it's a batch replacement, we want directories to search
             if *batch {
-                if input.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        format!("Batch input must be a directory\n")
-                    ).exit()
+                if !input.is_dir() {
+                    Error::raw(ErrorKind::ValueValidation, "Batch input location must be a directory\n").exit()
                 }
 
-                if replacement.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        format!("Batch replacement location must be a directory\n")
-                    ).exit()
+                if !replacement.is_dir() {
+                    Error::raw(ErrorKind::ValueValidation, "Batch replacement location must be a directory\n").exit()
                 }
 
-                if output.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        format!("Batch output must be a directory\n")
-                    ).exit()
+                if !output.is_dir() {
+                    Error::raw(ErrorKind::ValueValidation, "Batch output location must be a directory\n").exit()
                 }
 
-                for entry in walkdir::WalkDir::new(input).max_depth(1) {
+                // Replace all the files within the directory and print errors for them
+                for entry in walkdir::WalkDir::new(input)
+                    .max_depth(1)
+                    .same_file_system(true)
+                {
                     let path = entry.unwrap().into_path();
                     if !path.is_file() {
-                        continue;
+                        continue
                     }
 
-                    let filename = PathBuf::from(path.file_name().unwrap());
+                    // Set the replacement image to the same name as the original file
+                    let mut final_replacement = replacement.to_path_buf();
+                    final_replacement.push(PathBuf::from(path.file_name().unwrap()).with_extension("png"));
 
-                    let mut final_path = output.clone();
-                    final_path.push(&filename);
+                    // Set the replacement image to the same name as the original file
+                    let mut final_output = output.to_path_buf();
+                    final_output.push(path.file_name().unwrap());
 
-                    let mut final_replacement = replacement.clone();
-                    final_replacement.push(filename.with_extension("png"));
-
-                    let repl_img = match image::open(&final_replacement) {
-                        Ok(img) => img,
-                        Err(_) => {
-                            Error::raw(
-                                ErrorKind::ValueValidation,
-                                format!("Could not open replacement file as an image: {}\n", final_replacement.into_os_string().to_str().unwrap())
-                            ).print().unwrap();
-                            continue;
-                        },
-                    };
-                    let repl_img = repl_img.to_rgba8();
-
-                    let mut cz = match DynamicCz::open(&path) {
-                        Ok(cz) => cz,
-                        Err(_) => {
-                            Error::raw(
-                                ErrorKind::ValueValidation,
-                                format!("Could not open input as a CZ file: {}\n", path.into_os_string().to_str().unwrap())
-                            ).print().unwrap();
-                            continue;
-                        },
-                    };
-
-                    cz.header_mut().set_width(repl_img.width() as u16);
-                    cz.header_mut().set_height(repl_img.height() as u16);
-                    cz.set_bitmap(repl_img.into_raw());
-                    cz.remove_palette();
-
-                    if let Some(depth) = depth {
-                        cz.header_mut().set_depth(*depth as u16)
+                    if let Err(error) = replace_cz(
+                        &path,
+                        &final_output,
+                        &final_replacement,
+                        version,
+                        depth
+                    ) {
+                        Error::raw(ErrorKind::ValueValidation, format!("{:?} - {}\n", path, error)).print().unwrap();
                     }
-
-                    if let Some(ver) = version {
-                        match cz.header_mut().set_version(*ver) {
-                            Ok(_) => (),
-                            Err(_) => {
-                                Error::raw(
-                                    ErrorKind::ValueValidation,
-                                    format!("Invalid CZ Version {}; expected 0, 1, 2, 3, or 4\n", ver)
-                                ).exit()
-                            },
-                        };
-                    }
-
-                    cz.save_as_cz(&final_path).unwrap();
                 }
             } else {
-                let mut cz = match DynamicCz::open(input) {
-                    Ok(cz) => cz,
-                    Err(err) => {
-                        Error::raw(
-                            ErrorKind::ValueValidation,
-                            format!("Could not open input as a CZ file: {}\n", err)
-                        ).exit()
-                    },
-                };
-
-                let repl_img = match image::open(replacement) {
-                    Ok(img) => img,
-                    Err(err) => {
-                        Error::raw(
-                            ErrorKind::ValueValidation,
-                            format!("Could not open replacement file as an image: {}\n", err)
-                        ).exit()
-                    },
-                };
-                let repl_img = repl_img.to_rgba8();
-
-                cz.header_mut().set_width(repl_img.width() as u16);
-                cz.header_mut().set_height(repl_img.height() as u16);
-                cz.set_bitmap(repl_img.into_raw());
-                cz.remove_palette();
-
-                if let Some(depth) = depth {
-                    cz.header_mut().set_depth(*depth as u16)
+                if !input.is_file() {
+                    Error::raw(ErrorKind::ValueValidation, "Input must be a file\n").exit()
                 }
 
-                if let Some(ver) = version {
-                    match cz.header_mut().set_version(*ver) {
-                        Ok(_) => (),
-                        Err(_) => {
-                            Error::raw(
-                                ErrorKind::ValueValidation,
-                                format!("Invalid CZ Version {}; expected 0, 1, 2, 3, or 4\n", ver)
-                            ).exit()
-                        },
-                    };
+                if !replacement.is_file() {
+                    Error::raw(ErrorKind::ValueValidation, "Replacement must be a file\n").exit()
                 }
 
-                match cz.save_as_cz(output) {
-                    Ok(_) => (),
-                    Err(err) => {
-                        Error::raw(
-                            ErrorKind::ValueValidation,
-                            format!("Failed to save CZ file: {}\n", err)
-                        ).exit()
-                    },
+                if !output.is_file() {
+                    Error::raw(ErrorKind::ValueValidation, "Replacement output must be a file\n").exit()
                 }
+
+                // Replace the input file with the new image
+                replace_cz(
+                    &input,
+                    &output,
+                    &replacement,
+                    version,
+                    depth
+                ).unwrap();
             }
         },
     }
 }
+
+/// Replace a CZ file with the bitmap of a PNG file
+fn replace_cz<P: ?Sized + AsRef<Path>>(
+    input_path: &P,
+    output_path: &P,
+    replacement_path: &P,
+    version: &Option<u8>,
+    depth: &Option<u16>,
+) -> Result<(), Box<dyn std::error::Error>> {
+    let path = input_path.as_ref();
+    if !path.is_file() {
+        return Err("Input path is not a file".into())
+    }
+
+    if !replacement_path.as_ref().exists() || !replacement_path.as_ref().is_file() {
+        return Err("Replacement path does not exist or is not a file".into())
+    }
+
+    // Open the replacement image and convert it to RGBA8
+    let repl_img = image::open(&replacement_path)?.to_rgba8();
+
+    // Open the original CZ file
+    let mut cz = DynamicCz::open(&path)?;
+
+    // Set CZ header parameters and the new bitmap
+    cz.header_mut().set_width(repl_img.width() as u16);
+    cz.header_mut().set_height(repl_img.height() as u16);
+    cz.set_bitmap(repl_img.into_raw());
+    cz.remove_palette();
+
+    if let Some(depth) = depth {
+        cz.header_mut().set_depth(*depth)
+    }
+
+    if let Some(ver) = version {
+        cz.header_mut().set_version(*ver)?;
+    }
+
+    // Save the file to the proper output location
+    cz.save_as_cz(&output_path.as_ref()).unwrap();
+
+    Ok(())
+}