nutexb 0.7.0

Library for working with Smash Ultimate's nutexb texture files
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

use std::{error::Error, fmt::Display};

use ddsfile::{
    AlphaMode, Caps2, D3D10ResourceDimension, D3DFormat, Dds, DxgiFormat, FourCC, NewDxgiParams,
};

use crate::{NutexbFile, NutexbFormat, Surface};

/// Errors while creating a nutexb file from a DDS file.
#[derive(Debug)]
pub enum ReadDdsError {
    /// The DDS format is not a recognized or supported nutexb format.
    UnrecognizedFormat,
    /// The DDS data could not be swizzled.
    /// This usually means the DDS header does not accurately describe the image data.
    SwizzleError(tegra_swizzle::SwizzleError),
}

impl Display for ReadDdsError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ReadDdsError::UnrecognizedFormat => write!(f, "unrecognized DDS format"),
            ReadDdsError::SwizzleError(e) => write!(f, "failed to swizzle surface: {e}"),
        }
    }
}

impl From<tegra_swizzle::SwizzleError> for ReadDdsError {
    fn from(value: tegra_swizzle::SwizzleError) -> Self {
        Self::SwizzleError(value)
    }
}

impl Error for ReadDdsError {}

pub fn create_surface(dds: &Dds) -> Result<Surface<&[u8]>, ReadDdsError> {
    Ok(Surface {
        width: dds.get_width(),
        height: dds.get_height(),
        depth: dds.get_depth(),
        image_data: &dds.data,
        mipmap_count: dds.get_num_mipmap_levels(),
        layer_count: layer_count(dds),
        image_format: dds_image_format(dds).ok_or(ReadDdsError::UnrecognizedFormat)?,
    })
}

fn layer_count(dds: &Dds) -> u32 {
    // Array layers for DDS are calculated differently for cube maps.
    if matches!(&dds.header10, Some(header10) if header10.misc_flag == ddsfile::MiscFlag::TEXTURECUBE)
    {
        dds.get_num_array_layers() * 6
    } else {
        dds.get_num_array_layers()
    }
}

fn dds_image_format(dds: &Dds) -> Option<NutexbFormat> {
    // The format can be DXGI, D3D, or specified in the FOURCC.
    let dxgi = dds.get_dxgi_format();
    let d3d = dds.get_d3d_format();
    let fourcc = dds.header.spf.fourcc.as_ref();

    dxgi.and_then(image_format_from_dxgi)
        .or_else(|| d3d.and_then(image_format_from_d3d))
        .or_else(|| fourcc.and_then(image_format_from_fourcc))
}

fn image_format_from_dxgi(format: DxgiFormat) -> Option<NutexbFormat> {
    match format {
        DxgiFormat::R8_UNorm => Some(NutexbFormat::R8Unorm),
        DxgiFormat::R8G8B8A8_UNorm => Some(NutexbFormat::R8G8B8A8Unorm),
        DxgiFormat::R8G8B8A8_UNorm_sRGB => Some(NutexbFormat::R8G8B8A8Srgb),
        DxgiFormat::R32G32B32A32_Float => Some(NutexbFormat::R32G32B32A32Float),
        DxgiFormat::B8G8R8A8_UNorm => Some(NutexbFormat::B8G8R8A8Unorm),
        DxgiFormat::B8G8R8A8_UNorm_sRGB => Some(NutexbFormat::B8G8R8A8Srgb),
        DxgiFormat::BC1_UNorm => Some(NutexbFormat::BC1Unorm),
        DxgiFormat::BC1_UNorm_sRGB => Some(NutexbFormat::BC1Srgb),
        DxgiFormat::BC2_UNorm => Some(NutexbFormat::BC2Unorm),
        DxgiFormat::BC2_UNorm_sRGB => Some(NutexbFormat::BC2Srgb),
        DxgiFormat::BC3_UNorm => Some(NutexbFormat::BC3Unorm),
        DxgiFormat::BC3_UNorm_sRGB => Some(NutexbFormat::BC3Srgb),
        DxgiFormat::BC4_UNorm => Some(NutexbFormat::BC4Unorm),
        DxgiFormat::BC4_SNorm => Some(NutexbFormat::BC4Snorm),
        DxgiFormat::BC5_UNorm => Some(NutexbFormat::BC5Unorm),
        DxgiFormat::BC5_SNorm => Some(NutexbFormat::BC5Snorm),
        DxgiFormat::BC6H_SF16 => Some(NutexbFormat::BC6Sfloat),
        DxgiFormat::BC6H_UF16 => Some(NutexbFormat::BC6Ufloat),
        DxgiFormat::BC7_UNorm => Some(NutexbFormat::BC7Unorm),
        DxgiFormat::BC7_UNorm_sRGB => Some(NutexbFormat::BC7Srgb),
        _ => None,
    }
}

fn image_format_from_d3d(format: D3DFormat) -> Option<NutexbFormat> {
    match format {
        D3DFormat::DXT1 => Some(NutexbFormat::BC1Unorm),
        D3DFormat::DXT2 => Some(NutexbFormat::BC2Unorm),
        D3DFormat::DXT3 => Some(NutexbFormat::BC2Unorm),
        D3DFormat::DXT4 => Some(NutexbFormat::BC3Unorm),
        D3DFormat::DXT5 => Some(NutexbFormat::BC3Unorm),
        _ => None,
    }
}

const BC5U: u32 = u32::from_le_bytes(*b"BC5U");
const ATI2: u32 = u32::from_le_bytes(*b"ATI2");

fn image_format_from_fourcc(fourcc: &FourCC) -> Option<NutexbFormat> {
    match fourcc.0 {
        FourCC::DXT1 => Some(NutexbFormat::BC1Unorm),
        FourCC::DXT2 => Some(NutexbFormat::BC2Unorm),
        FourCC::DXT3 => Some(NutexbFormat::BC2Unorm),
        FourCC::DXT4 => Some(NutexbFormat::BC3Unorm),
        FourCC::DXT5 => Some(NutexbFormat::BC3Unorm),
        FourCC::BC4_UNORM => Some(NutexbFormat::BC4Unorm),
        FourCC::BC4_SNORM => Some(NutexbFormat::BC4Snorm),
        ATI2 | BC5U => Some(NutexbFormat::BC5Unorm),
        FourCC::BC5_SNORM => Some(NutexbFormat::BC5Snorm),
        _ => None,
    }
}

impl From<NutexbFormat> for DxgiFormat {
    fn from(value: NutexbFormat) -> Self {
        match value {
            NutexbFormat::BC1Unorm => Self::BC1_UNorm,
            NutexbFormat::BC1Srgb => Self::BC1_UNorm_sRGB,
            NutexbFormat::BC2Unorm => Self::BC2_UNorm,
            NutexbFormat::BC2Srgb => Self::BC2_UNorm_sRGB,
            NutexbFormat::BC3Unorm => Self::BC3_UNorm,
            NutexbFormat::BC3Srgb => Self::BC3_UNorm_sRGB,
            NutexbFormat::BC4Unorm => Self::BC4_UNorm,
            NutexbFormat::BC4Snorm => Self::BC4_SNorm,
            NutexbFormat::BC5Unorm => Self::BC5_UNorm,
            NutexbFormat::BC5Snorm => Self::BC5_SNorm,
            NutexbFormat::BC6Ufloat => Self::BC6H_UF16,
            NutexbFormat::BC6Sfloat => Self::BC6H_SF16,
            NutexbFormat::BC7Unorm => Self::BC7_UNorm,
            NutexbFormat::BC7Srgb => Self::BC7_UNorm_sRGB,
            NutexbFormat::R8Unorm => Self::R8_UNorm,
            NutexbFormat::R8G8B8A8Unorm => Self::R8G8B8A8_UNorm,
            NutexbFormat::R8G8B8A8Srgb => Self::R8G8B8A8_UNorm_sRGB,
            NutexbFormat::R32G32B32A32Float => Self::R32G32B32A32_Float,
            NutexbFormat::B8G8R8A8Unorm => Self::B8G8R8A8_UNorm,
            NutexbFormat::B8G8R8A8Srgb => Self::B8G8R8A8_UNorm_sRGB,
        }
    }
}

pub fn create_dds(nutexb: &NutexbFile) -> Result<Dds, tegra_swizzle::SwizzleError> {
    let some_if_above_one = |x| if x > 0 { Some(x) } else { None };

    // TODO: Avoid unwrap.
    let mut dds = Dds::new_dxgi(NewDxgiParams {
        height: nutexb.footer.height,
        width: nutexb.footer.width,
        depth: some_if_above_one(nutexb.footer.depth),
        format: nutexb.footer.image_format.into(),
        mipmap_levels: some_if_above_one(nutexb.footer.mipmap_count),
        array_layers: some_if_above_one(nutexb.footer.layer_count),
        caps2: if nutexb.footer.depth > 1 {
            Some(Caps2::VOLUME)
        } else {
            None
        },
        is_cubemap: nutexb.footer.layer_count == 6,
        resource_dimension: if nutexb.footer.depth > 1 {
            D3D10ResourceDimension::Texture3D
        } else {
            D3D10ResourceDimension::Texture2D
        },
        alpha_mode: AlphaMode::Unknown, // TODO: Alpha mode?
    })
    .unwrap();

    // DDS stores mipmaps in a contiguous region of memory.
    dds.data = nutexb.deswizzled_data()?;

    Ok(dds)
}