dream_archive 0.1.3

Pure-Rust Bethesda BA2 and BSA archive reader, extractor, and writer
Documentation
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
461
462
463
464
465
466
467
468
469
470
471
472
use super::{ArchiveVersion, Error, FileHash, Result, TextureHeader, builder, hash_file};
use crate::{BString, ByteSlice as _};
use crate::{CompressionOverride, builder_fs, dds};
use flate2::Compression;
use std::{
    borrow::Cow,
    collections::HashSet,
    fs::{self, File},
    io::{BufWriter, Cursor, Seek, Write},
    path::Path,
};

const MAGIC: u32 = u32::from_le_bytes(*b"BTDX");
const DX10: u32 = u32::from_le_bytes(*b"DX10");
const FILE_HEADER_SIZE_DX10: u16 = 0x18;
const FILE_RECORD_BASE_SIZE_DX10: usize = 24;
const CHUNK_RECORD_SIZE_DX10: usize = 24;
const CHUNK_SENTINEL: u32 = 0xBAAD_F00D;

/// Builder for BA2 DX10 texture archives.
///
/// This can either take explicit BA2 texture metadata plus raw texture payload
/// bytes, or parse a supported DDS header and strip it before writing the BA2
/// texture payload. It does not transcode texture formats or generate mips.
#[derive(Clone, Debug)]
pub struct Dx10Builder {
    version: ArchiveVersion,
    compression: Option<super::Ba2CompressionFormat>,
    zlib_level: Compression,
    entries: Vec<TextureEntry>,
    names: HashSet<BString>,
}

#[derive(Clone, Debug)]
struct TextureEntry {
    name: BString,
    hash: FileHash,
    header: TextureHeader,
    compression: CompressionOverride,
    bytes: Vec<u8>,
}

struct PreparedTexture<'a> {
    entry: &'a TextureEntry,
    stored: Cow<'a, [u8]>,
}

impl Default for Dx10Builder {
    fn default() -> Self {
        Self {
            version: ArchiveVersion::v1,
            compression: None,
            zlib_level: Compression::default(),
            entries: Vec::new(),
            names: HashSet::new(),
        }
    }
}

impl Dx10Builder {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn version(&self) -> ArchiveVersion {
        self.version
    }

    pub fn set_version(&mut self, version: ArchiveVersion) -> &mut Self {
        self.version = version;
        self
    }

    #[must_use]
    pub fn compression(&self) -> Option<super::Ba2CompressionFormat> {
        self.compression
    }

    pub fn set_compression(
        &mut self,
        compression: Option<super::Ba2CompressionFormat>,
    ) -> &mut Self {
        self.compression = compression;
        self
    }

    #[must_use]
    pub fn zlib_level(&self) -> Compression {
        self.zlib_level
    }

    pub fn set_zlib_level(&mut self, level: Compression) -> &mut Self {
        self.zlib_level = level;
        self
    }

    #[must_use]
    pub fn len(&self) -> usize {
        self.entries.len()
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }

    /// Add one texture payload with explicit BA2 DX10 metadata.
    ///
    /// `bytes` must be the texture data stored after the DDS header, not a full
    /// DDS file. The archive reader reconstructs the DDS header from `header`
    /// during extraction.
    ///
    /// # Errors
    ///
    /// Returns an error if the path is invalid, the texture metadata can not be
    /// represented as a supported DDS header, the normalized path is duplicated,
    /// or allocation fails.
    pub fn add_texture_bytes(
        &mut self,
        path: impl AsRef<[u8]>,
        header: TextureHeader,
        bytes: impl AsRef<[u8]>,
    ) -> Result<()> {
        self.add_texture_bytes_with_compression(path, header, bytes, CompressionOverride::Inherit)
    }

    /// Add one texture payload with an explicit per-file compression policy.
    ///
    /// # Errors
    ///
    /// Returns an error if the path or texture metadata is invalid, the
    /// normalized path is duplicated, or allocation fails.
    pub fn add_texture_bytes_with_compression(
        &mut self,
        path: impl AsRef<[u8]>,
        header: TextureHeader,
        bytes: impl AsRef<[u8]>,
        compression: CompressionOverride,
    ) -> Result<()> {
        validate_texture_header(header)?;
        dds::validate_texture_payload_size(header, bytes.as_ref().len())?;
        let name = builder::normalize_stored_path(path.as_ref())?;
        let (hash, normalized) = hash_file(name.as_bstr());
        debug_assert_eq!(name, normalized);
        if self.names.contains(name.as_bstr()) {
            return Err(Error::DuplicatePath);
        }

        let mut owned = Vec::new();
        owned.try_reserve_exact(bytes.as_ref().len())?;
        owned.extend_from_slice(bytes.as_ref());
        self.entries.try_reserve(1)?;
        self.names.try_reserve(1)?;
        self.names.insert(name.clone());
        self.entries.push(TextureEntry {
            name,
            hash,
            header,
            compression,
            bytes: owned,
        });
        Ok(())
    }

    /// Add one texture from a DDS file held in memory.
    ///
    /// The DDS header is parsed and stripped; only the texture payload is stored
    /// in the BA2. Supported formats are the same formats this crate can
    /// reconstruct when extracting DX10 BA2 archives.
    ///
    /// # Errors
    ///
    /// Returns an error if the DDS header or payload layout is unsupported, the
    /// path is invalid, the normalized path is duplicated, or allocation fails.
    pub fn add_dds_bytes(&mut self, path: impl AsRef<[u8]>, dds: impl AsRef<[u8]>) -> Result<()> {
        self.add_dds_bytes_with_compression(path, dds, CompressionOverride::Inherit)
    }

    /// Add one DDS texture with an explicit per-file compression policy.
    ///
    /// # Errors
    ///
    /// Returns an error if the DDS header or payload layout is unsupported, the
    /// path is invalid, the normalized path is duplicated, or allocation fails.
    pub fn add_dds_bytes_with_compression(
        &mut self,
        path: impl AsRef<[u8]>,
        dds: impl AsRef<[u8]>,
        compression: CompressionOverride,
    ) -> Result<()> {
        let texture = dds::parse_dds_for_dx10(dds.as_ref())?;
        self.add_texture_bytes_with_compression(path, texture.header, texture.payload, compression)
    }

    /// Read a filesystem texture payload and store it at `archive_path`.
    ///
    /// The file is treated as raw payload bytes. This method does not parse DDS.
    ///
    /// # Errors
    ///
    /// Returns an error if reading the file fails or adding the texture entry fails.
    pub fn add_texture_file(
        &mut self,
        archive_path: impl AsRef<[u8]>,
        header: TextureHeader,
        source: impl AsRef<Path>,
    ) -> Result<()> {
        self.add_texture_file_with_compression(
            archive_path,
            header,
            source,
            CompressionOverride::Inherit,
        )
    }

    /// Read a filesystem texture payload with a per-file compression policy.
    ///
    /// # Errors
    ///
    /// Returns an error if reading the file fails or adding the texture entry fails.
    pub fn add_texture_file_with_compression(
        &mut self,
        archive_path: impl AsRef<[u8]>,
        header: TextureHeader,
        source: impl AsRef<Path>,
        compression: CompressionOverride,
    ) -> Result<()> {
        let bytes = fs::read(source)?;
        self.add_texture_bytes_with_compression(archive_path, header, bytes, compression)
    }

    /// Read a DDS file, parse and strip its header, and store its texture payload.
    ///
    /// # Errors
    ///
    /// Returns an error if reading the file fails, the DDS is unsupported, or
    /// adding the archive entry fails.
    pub fn add_dds_file(
        &mut self,
        archive_path: impl AsRef<[u8]>,
        source: impl AsRef<Path>,
    ) -> Result<()> {
        self.add_dds_file_with_compression(archive_path, source, CompressionOverride::Inherit)
    }

    /// Read a DDS file with a per-file compression policy.
    ///
    /// # Errors
    ///
    /// Returns an error if reading the file fails, the DDS is unsupported, or
    /// adding the archive entry fails.
    pub fn add_dds_file_with_compression(
        &mut self,
        archive_path: impl AsRef<[u8]>,
        source: impl AsRef<Path>,
        compression: CompressionOverride,
    ) -> Result<()> {
        let bytes = fs::read(source)?;
        self.add_dds_bytes_with_compression(archive_path, bytes, compression)
    }

    /// Recursively add all files below `root` with the same texture metadata.
    ///
    /// This is mostly useful for synthetic archives and tests. Real texture
    /// directories generally need per-file dimensions and formats; pretending
    /// otherwise would be, technically, garbage.
    ///
    /// # Errors
    ///
    /// Returns an error if traversal, file reading, or adding an entry fails.
    pub fn add_dir_with_texture_header(
        &mut self,
        root: impl AsRef<Path>,
        header: TextureHeader,
    ) -> Result<()> {
        let root = root.as_ref();
        for path in builder_fs::collect_files(root)? {
            let relative = path
                .strip_prefix(root)
                .map_err(|_| Error::InvalidArchivePath)?;
            let archive_path =
                builder_fs::path_to_archive_bytes(relative).ok_or(Error::InvalidArchivePath)?;
            self.add_texture_file(archive_path, header, &path)?;
        }
        Ok(())
    }

    /// Write the archive to a filesystem path.
    ///
    /// # Errors
    ///
    /// Returns an error if creating/writing the file fails or archive integer
    /// fields overflow their BA2 on-disk sizes.
    pub fn write_path(&self, path: impl AsRef<Path>) -> Result<()> {
        let file = File::create(path)?;
        self.write_seek(BufWriter::new(file))
    }

    /// Write the archive to a byte vector.
    ///
    /// # Errors
    ///
    /// Returns an error if archive integer fields overflow their BA2 on-disk
    /// sizes or output allocation fails.
    pub fn to_vec(&self) -> Result<Vec<u8>> {
        let mut out = Cursor::new(Vec::new());
        self.write_seek(&mut out)?;
        Ok(out.into_inner())
    }

    /// Write the archive to `out`.
    ///
    /// # Errors
    ///
    /// Returns an error if writing fails or archive integer fields overflow
    /// their BA2 on-disk sizes.
    pub fn write_seek<W: Write + Seek>(&self, mut out: W) -> Result<()> {
        let entries = self.sorted_entries();
        let prepared = self.prepare_entries(&entries)?;
        let payload_offset = payload_offset(entries.len(), self.version)?;
        let string_table_offset = prepared.iter().try_fold(payload_offset, |offset, entry| {
            offset
                .checked_add(entry.stored.len())
                .ok_or(Error::OutOfBounds)
        })?;

        builder::write_u32(&mut out, MAGIC)?;
        builder::write_u32(&mut out, self.version as u32)?;
        builder::write_u32(&mut out, DX10)?;
        builder::write_u32(&mut out, entries.len().try_into()?)?;
        builder::write_u64(&mut out, string_table_offset.try_into()?)?;
        if matches!(self.version, ArchiveVersion::v2 | ArchiveVersion::v3) {
            builder::write_u64(&mut out, 1)?;
        }
        if self.version == ArchiveVersion::v3 {
            builder::write_u32(
                &mut out,
                if self.compression == Some(super::Ba2CompressionFormat::LZ4) {
                    3
                } else {
                    0
                },
            )?;
        }

        let mut next_payload_offset: u64 = payload_offset.try_into()?;
        for entry in &prepared {
            write_texture_record(&mut out, entry, next_payload_offset, self.compression)?;
            next_payload_offset = next_payload_offset
                .checked_add(entry.stored.len().try_into()?)
                .ok_or(Error::OutOfBounds)?;
        }

        for entry in &prepared {
            out.write_all(&entry.stored)?;
        }
        for entry in &entries {
            builder::write_u16(&mut out, entry.name.len().try_into()?)?;
            out.write_all(&entry.name)?;
        }
        Ok(())
    }

    fn prepare_entries<'a>(
        &self,
        entries: &[&'a TextureEntry],
    ) -> Result<Vec<PreparedTexture<'a>>> {
        if self.compression == Some(super::Ba2CompressionFormat::LZ4)
            && self.version != ArchiveVersion::v3
            && entries
                .iter()
                .any(|entry| entry.is_compressed(self.compression))
        {
            return Err(Error::NotImplemented("BA2 LZ4 writer requires version 3"));
        }
        let mut prepared = Vec::new();
        prepared.try_reserve_exact(entries.len())?;
        for entry in entries {
            let stored = if entry.is_compressed(self.compression) {
                match self.compression.unwrap_or(super::Ba2CompressionFormat::Zip) {
                    super::Ba2CompressionFormat::Zip => {
                        Cow::Owned(builder::zlib_compress(&entry.bytes, self.zlib_level)?)
                    }
                    super::Ba2CompressionFormat::LZ4 => {
                        Cow::Owned(lz4_flex::block::compress(&entry.bytes))
                    }
                }
            } else {
                Cow::Borrowed(entry.bytes.as_slice())
            };
            prepared.push(PreparedTexture { entry, stored });
        }
        Ok(prepared)
    }

    fn sorted_entries(&self) -> Vec<&TextureEntry> {
        let mut entries: Vec<_> = self.entries.iter().collect();
        entries.sort_by(|left, right| {
            left.hash
                .cmp(&right.hash)
                .then_with(|| left.name.cmp(&right.name))
        });
        entries
    }
}

impl TextureEntry {
    fn is_compressed(&self, default: Option<super::Ba2CompressionFormat>) -> bool {
        match self.compression {
            CompressionOverride::Inherit => default.is_some(),
            CompressionOverride::Store => false,
            CompressionOverride::Compress => true,
        }
    }
}

fn validate_texture_header(header: TextureHeader) -> Result<()> {
    if header.mip_count == 0 {
        return Err(Error::Dds("zero mip count"));
    }
    dds::validate_texture_header(header)
}

fn payload_offset(file_count: usize, version: ArchiveVersion) -> Result<usize> {
    builder::header_size(version)?
        .checked_add(
            file_count
                .checked_mul(file_record_size()?)
                .ok_or(Error::OutOfBounds)?,
        )
        .ok_or(Error::OutOfBounds)
}

fn file_record_size() -> Result<usize> {
    FILE_RECORD_BASE_SIZE_DX10
        .checked_add(CHUNK_RECORD_SIZE_DX10)
        .ok_or(Error::OutOfBounds)
}

fn write_texture_record(
    out: &mut impl Write,
    prepared: &PreparedTexture<'_>,
    payload_offset: u64,
    default_compression: Option<super::Ba2CompressionFormat>,
) -> Result<()> {
    let entry = prepared.entry;
    builder::write_hash(out, entry.hash)?;
    out.write_all(&[0])?;
    out.write_all(&[1])?;
    builder::write_u16(out, FILE_HEADER_SIZE_DX10)?;
    builder::write_u16(out, entry.header.height)?;
    builder::write_u16(out, entry.header.width)?;
    out.write_all(&[entry.header.mip_count])?;
    out.write_all(&[entry.header.format])?;
    out.write_all(&[entry.header.flags])?;
    out.write_all(&[entry.header.tile_mode])?;
    builder::write_u64(out, payload_offset)?;
    builder::write_u32(
        out,
        if entry.is_compressed(default_compression) {
            prepared.stored.len().try_into()?
        } else {
            0
        },
    )?;
    builder::write_u32(out, entry.bytes.len().try_into()?)?;
    builder::write_u16(out, 0)?;
    builder::write_u16(out, u16::from(entry.header.mip_count) - 1)?;
    builder::write_u32(out, CHUNK_SENTINEL)
}