maclarian 0.1.3

Larian file format library for Baldur's Gate 3 - PAK, LSF, LSX, GR2, DDS, and more
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

//! LSJ to LSF conversion (via LSX intermediate)

use crate::error::Result;
use crate::formats::{lsf, lsj, lsx};
use std::path::Path;

/// Convert LSJ file to LSF format
/// This goes through LSX as an intermediate step: LSJ → LSX → LSF
///
/// # Errors
/// Returns an error if reading or conversion fails.
pub fn convert_lsj_to_lsf<P: AsRef<Path>>(source: P, dest: P) -> Result<()> {
    convert_lsj_to_lsf_with_progress(source, dest, &|_| {})
}

/// Convert LSJ file to LSF format with progress callback
/// This goes through LSX as an intermediate step: LSJ → LSX → LSF
///
/// # Errors
/// Returns an error if reading or conversion fails.
pub fn convert_lsj_to_lsf_with_progress<P: AsRef<Path>>(
    source: P,
    dest: P,
    progress: crate::converter::ConvertProgressCallback,
) -> Result<()> {
    use crate::converter::{ConvertPhase, ConvertProgress};
    tracing::info!(
        "Converting LSJ→LSF: {:?} → {:?}",
        source.as_ref(),
        dest.as_ref()
    );

    // Step 1: Read LSJ
    progress(&ConvertProgress::with_file(
        ConvertPhase::ReadingSource,
        1,
        5,
        "Reading LSJ file...",
    ));
    let lsj_doc = lsj::read_lsj(&source)?;

    // Step 2: Convert to LSX document structure
    let region_count = lsj_doc.save.regions.len();
    progress(&ConvertProgress::with_file(
        ConvertPhase::Converting,
        2,
        5,
        format!("Converting {region_count} regions to XML..."),
    ));
    let lsx_doc = super::lsj_to_lsx::to_lsx(&lsj_doc)?;

    // Step 3: Serialize LSX to XML string
    progress(&ConvertProgress::with_file(
        ConvertPhase::Converting,
        3,
        5,
        "Serializing XML...",
    ));
    let lsx_xml = lsx::serialize_lsx(&lsx_doc)?;

    // Step 4: Parse XML and convert to LSF
    progress(&ConvertProgress::with_file(
        ConvertPhase::Converting,
        4,
        5,
        "Converting to LSF binary...",
    ));
    let lsf_doc = super::lsx_to_lsf::from_lsx(&lsx_xml)?;

    // Step 5: Write LSF
    let node_count = lsf_doc.nodes.len();
    progress(&ConvertProgress::with_file(
        ConvertPhase::WritingOutput,
        5,
        5,
        format!("Writing LSF binary ({node_count} nodes)..."),
    ));
    lsf::write_lsf(&lsf_doc, dest)?;

    tracing::info!("Conversion complete");
    Ok(())
}