physis/

mtrl.rs

// SPDX-FileCopyrightText: 2023 Joshua Goins <josh@redstrate.com>
// SPDX-License-Identifier: GPL-3.0-or-later

#![allow(clippy::unnecessary_fallible_conversions)] // This wrongly trips on binrw code

use std::io::Cursor;

use crate::common::Platform;
use crate::common_file_operations::{Half1, Half2, Half3, null_terminated_utf8};
use crate::mtrl::ColorDyeTable::{
    DawntrailColorDyeTable, LegacyColorDyeTable, OpaqueColorDyeTable,
};
use crate::mtrl::ColorTable::{DawntrailColorTable, LegacyColorTable, OpaqueColorTable};
use crate::{ByteBuffer, ByteSpan, ReadableFile, WritableFile};
use binrw::{BinRead, BinResult, BinWrite, binrw};

#[binrw]
#[derive(Debug)]
#[allow(dead_code)]
struct MaterialFileHeader {
    version: u32,
    file_size: u16,
    data_set_size: u16,
    string_table_size: u16,
    shader_package_name_offset: u16,
    texture_count: u8,
    uv_set_count: u8,
    color_set_count: u8,
    additional_data_size: u8,
}

#[binrw]
#[derive(Debug)]
struct MaterialHeader {
    shader_value_list_size: u16,
    shader_key_count: u16,
    constant_count: u16,
    sampler_count: u16,
    flags: u32,
}

#[binrw]
#[derive(Debug)]
#[allow(dead_code)]
struct ColorSet {
    name_offset: u16,
    index: u16,
}

#[binrw]
#[derive(Debug, Clone, Copy)]
#[repr(C)]
#[allow(dead_code)]
pub struct DawntrailColorTableRow {
    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub diffuse_color: [f32; 3],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown1: f32,

    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub specular_color: [f32; 3],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown2: f32,

    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub emissive_color: [f32; 3],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown3: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub sheen_rate: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub sheen_tint: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub sheen_aperture: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown4: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub roughness: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown5: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub metalness: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub anisotropy: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown6: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub sphere_mask: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown7: f32,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub unknown8: f32,

    pub shader_index: u16,

    pub tile_set: u16,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub tile_alpha: f32,

    pub sphere_index: u16,

    #[br(map = |x: Half2| { [x.x.to_f32(), x.y.to_f32()] })]
    pub material_repeat: [f32; 2],

    #[br(map = |x: Half2| { [x.x.to_f32(), x.y.to_f32()] })]
    pub material_skew: [f32; 2],
}

#[binrw]
#[derive(Debug, Clone, Copy)]
#[repr(C)]
#[allow(dead_code)]
pub struct LegacyColorTableRow {
    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub diffuse_color: [f32; 3],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub specular_strength: f32,

    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub specular_color: [f32; 3],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub gloss_strength: f32,

    #[br(map = |x: Half3| { [x.r.to_f32(), x.g.to_f32(), x.b.to_f32()] })]
    pub emissive_color: [f32; 3],

    pub tile_set: u16,

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub material_repeat_x: f32,

    #[br(map = |x: Half2| { [x.x.to_f32(), x.y.to_f32()] })]
    pub material_skew: [f32; 2],

    #[br(map = |x: Half1| { x.value.to_f32() })]
    pub material_repeat_y: f32,
}

#[binrw]
#[derive(Debug, Clone, Default)]
#[allow(dead_code)]
pub struct LegacyColorTableData {
    #[br(count = 16)]
    pub rows: Vec<LegacyColorTableRow>,
}

#[binrw]
#[derive(Debug, Clone, Default)]
#[allow(dead_code)]
pub struct DawntrailColorTableData {
    #[br(count = 32)]
    pub rows: Vec<DawntrailColorTableRow>,
}

#[binrw]
#[derive(Debug, Clone, Default)]
#[allow(dead_code)]
pub struct OpaqueColorTableData {
    // TODO: Support
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub enum ColorTable {
    LegacyColorTable(LegacyColorTableData),
    DawntrailColorTable(DawntrailColorTableData),
    OpaqueColorTable(OpaqueColorTableData),
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct LegacyColorDyeTableRow {
    #[br(temp)]
    #[bw(calc = 0)] // TODO: lol no
    data: u16,

    #[br(calc = data >> 5)]
    #[bw(ignore)]
    pub template: u16,

    #[br(calc = (data & 0x01) != 0)]
    #[bw(ignore)]
    pub diffuse: bool,

    #[br(calc = (data & 0x02) != 0)]
    #[bw(ignore)]
    pub specular: bool,

    #[br(calc = (data & 0x04) != 0)]
    #[bw(ignore)]
    pub emissive: bool,

    #[br(calc = (data & 0x08) != 0)]
    #[bw(ignore)]
    pub gloss: bool,

    #[br(calc = (data & 0x10) != 0)]
    #[bw(ignore)]
    pub specular_strength: bool,
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct DawntrailColorDyeTableRow {
    #[br(temp)]
    #[bw(calc = 0)] // TODO: lol no
    data: u32,

    #[br(calc = ((data >> 16) & 0x7FF) as u16)]
    #[bw(ignore)]
    pub template: u16,

    #[br(calc = ((data >> 27) & 0x3) as u8)]
    #[bw(ignore)]
    pub channel: u8,

    #[br(calc = (data & 0x0001) != 0)]
    #[bw(ignore)]
    pub diffuse: bool,

    #[br(calc = (data & 0x0002) != 0)]
    #[bw(ignore)]
    pub specular: bool,

    #[br(calc = (data & 0x0004) != 0)]
    #[bw(ignore)]
    pub emissive: bool,

    #[br(calc = (data & 0x0008) != 0)]
    #[bw(ignore)]
    pub scalar3: bool,

    #[br(calc = (data & 0x0010) != 0)]
    #[bw(ignore)]
    pub metalness: bool,

    #[br(calc = (data & 0x0020) != 0)]
    #[bw(ignore)]
    pub roughness: bool,

    #[br(calc = (data & 0x0040) != 0)]
    #[bw(ignore)]
    pub sheen_rate: bool,

    #[br(calc = (data & 0x0080) != 0)]
    #[bw(ignore)]
    pub sheen_tint_rate: bool,

    #[br(calc = (data & 0x0100) != 0)]
    #[bw(ignore)]
    pub sheen_aperture: bool,

    #[br(calc = (data & 0x0200) != 0)]
    #[bw(ignore)]
    pub anisotropy: bool,

    #[br(calc = (data & 0x0400) != 0)]
    #[bw(ignore)]
    pub sphere_map_index: bool,

    #[br(calc = (data & 0x0800) != 0)]
    #[bw(ignore)]
    pub sphere_map_mask: bool,
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct LegacyColorDyeTableData {
    #[br(count = 16)]
    pub rows: Vec<LegacyColorDyeTableRow>,
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct DawntrailColorDyeTableData {
    #[br(count = 32)]
    pub rows: Vec<DawntrailColorDyeTableRow>,
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub struct OpaqueColorDyeTableData {
    // TODO: implement
}

#[binrw]
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub enum ColorDyeTable {
    LegacyColorDyeTable(LegacyColorDyeTableData),
    DawntrailColorDyeTable(DawntrailColorDyeTableData),
    OpaqueColorDyeTable(OpaqueColorDyeTableData),
}

#[binrw]
#[derive(Debug, Clone, Copy)]
#[repr(C)]
#[allow(dead_code)]
pub struct ShaderKey {
    pub category: u32,
    pub value: u32,
}

#[binrw]
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub struct ConstantStruct {
    constant_id: u32,
    value_offset: u16,
    value_size: u16,
}

#[derive(Debug, Clone)]
#[repr(C)]
#[allow(dead_code)]
pub struct Constant {
    id: u32,
    num_values: u32,
    values: [f32; 4],
}

#[binrw]
#[derive(Debug, Clone, Copy)]
#[repr(C)]
#[allow(dead_code)]
pub struct Sampler {
    /// This is a CRC hash, it can be calculated via ShaderPackage::crc
    pub texture_usage: u32,
    flags: u32, // TODO: unknown
    #[brw(pad_after = 3)] // empty bytes/padding
    texture_index: u8,
}

#[binrw::parser(reader, endian)]
fn parse_color_table(table_dimension_logs: u8) -> BinResult<Option<ColorTable>> {
    // NOTE: the unwrap_or_default is intentional, as some materials (like `bg/ffxiv/fst_f1/fld/common/material/f1f0_treesdw04a.mtrl`) have a color table but its not actually written.
    Ok(Some(match table_dimension_logs {
        0 | 0x42 => LegacyColorTable(
            LegacyColorTableData::read_options(reader, endian, ()).unwrap_or_default(),
        ),
        0x53 => DawntrailColorTable(
            DawntrailColorTableData::read_options(reader, endian, ()).unwrap_or_default(),
        ),
        _ => OpaqueColorTable(
            OpaqueColorTableData::read_options(reader, endian, ()).unwrap_or_default(),
        ),
    }))
}

#[binrw::parser(reader, endian)]
fn parse_color_dye_table(table_dimension_logs: u8) -> BinResult<Option<ColorDyeTable>> {
    Ok(Some(match table_dimension_logs {
        0 => LegacyColorDyeTable(LegacyColorDyeTableData::read_options(reader, endian, ())?),
        0x50...0x5F => DawntrailColorDyeTable(DawntrailColorDyeTableData::read_options(
            reader,
            endian,
            (),
        )?),
        _ => OpaqueColorDyeTable(OpaqueColorDyeTableData::read_options(reader, endian, ())?),
    }))
}

#[binrw]
#[derive(Debug)]
#[allow(dead_code)]
struct MaterialData {
    file_header: MaterialFileHeader,

    #[br(count = file_header.texture_count)]
    offsets: Vec<u32>,

    #[br(count = file_header.uv_set_count)]
    uv_color_sets: Vec<ColorSet>,

    #[br(count = file_header.color_set_count)]
    color_sets: Vec<ColorSet>,

    #[br(count = file_header.string_table_size)]
    strings: Vec<u8>,

    #[br(count = file_header.additional_data_size)]
    additional_data: Vec<u8>,

    #[bw(ignore)]
    #[br(calc = if additional_data.len() >= 4 { u32::from_le_bytes(additional_data[0..4].try_into().unwrap()) } else { 0 })]
    table_flags: u32,

    #[br(calc = (table_flags & 0x4) != 0)]
    #[bw(ignore)]
    has_table: bool,

    #[br(calc = (table_flags & 0x8) != 0)]
    #[bw(ignore)]
    has_dye_table: bool,

    #[br(calc = ((table_flags >> 4) & 0xF) as u8)]
    #[bw(ignore)]
    table_width_log: u8,

    #[br(calc = ((table_flags >> 8) & 0xF) as u8)]
    #[bw(ignore)]
    table_height_log: u8,

    #[br(calc = (table_flags >> 4) as u8)]
    #[bw(ignore)]
    table_dimension_logs: u8,

    #[br(calc = !has_table || table_width_log != 0 && table_height_log != 0)]
    #[bw(ignore)]
    is_dawntrail: bool,

    #[br(if(has_table))]
    #[br(parse_with = parse_color_table)]
    #[br(args(table_dimension_logs))]
    #[bw(if(*has_table))]
    color_table: Option<ColorTable>,

    #[br(if(has_dye_table))]
    #[br(parse_with = parse_color_dye_table)]
    #[br(args(table_dimension_logs))]
    #[bw(if(*has_dye_table))]
    color_dye_table: Option<ColorDyeTable>,

    header: MaterialHeader,

    #[br(count = header.shader_key_count)]
    shader_keys: Vec<ShaderKey>,
    #[br(count = header.constant_count)]
    constants: Vec<ConstantStruct>,
    #[br(count = header.sampler_count)]
    samplers: Vec<Sampler>,
    #[br(count = header.shader_value_list_size as usize / std::mem::size_of::<f32>())]
    shader_values: Vec<f32>,
}

/// Material file, usually with the `.mtrl` file extension.
///
/// Contains general information about a material, such as which textures it uses.
#[derive(Debug)]
pub struct Material {
    mat_data: MaterialData,
    pub shader_package_name: String,
    pub texture_paths: Vec<String>,
    pub shader_keys: Vec<ShaderKey>,
    pub constants: Vec<Constant>,
    pub samplers: Vec<Sampler>,
    pub color_table: Option<ColorTable>,
    pub color_dye_table: Option<ColorDyeTable>,
}

impl ReadableFile for Material {
    fn from_existing(platform: Platform, buffer: ByteSpan) -> Option<Material> {
        let mut cursor = Cursor::new(buffer);
        let mat_data = MaterialData::read_options(&mut cursor, platform.endianness(), ()).ok()?;

        let mut texture_paths = vec![];

        // Right now lets consider an empty string buffer to be an indicator for an invalid MTRL file.
        if mat_data.strings.is_empty() {
            return None;
        }

        let mut offset = 0;
        for _ in 0..mat_data.file_header.texture_count {
            let (s, next) = null_terminated_utf8(&mat_data.strings, offset);
            texture_paths.push(s);
            offset = next;
        }

        let (shader_package_name, _) = null_terminated_utf8(
            &mat_data.strings,
            mat_data.file_header.shader_package_name_offset as usize,
        );

        // bg/ffxiv/wil_w1/evt/w1eb/material/w1eb_f1_vfog1a.mtrl has a shader value list of 9, which doesn't make sense in this system
        // eventually we need to un-hardcode it from vec4 or whatever
        let mut constants = Vec::new();
        const VALUE_SIZE: u16 = std::mem::size_of::<f32>() as u16;
        if mat_data.header.shader_value_list_size % VALUE_SIZE == 0 {
            for constant in &mat_data.constants {
                let mut values: [f32; 4] = [0.0; 4];

                // TODO: use mem::size_of
                let num_floats = constant.value_size / VALUE_SIZE;
                for (i, value) in values.iter_mut().enumerate().take(num_floats as usize) {
                    *value = mat_data.shader_values[(constant.value_offset as usize / 4) + i];
                }

                constants.push(Constant {
                    id: constant.constant_id,
                    num_values: num_floats as u32,
                    values,
                });
            }
        }

        let shader_keys = mat_data.shader_keys.clone();
        let samplers = mat_data.samplers.clone();
        let color_table = mat_data.color_table.clone();
        let color_dye_table = mat_data.color_dye_table.clone();

        Some(Material {
            mat_data,
            shader_package_name,
            texture_paths,
            shader_keys,
            constants,
            samplers,
            color_table,
            color_dye_table,
        })
    }
}

impl WritableFile for Material {
    fn write_to_buffer(&self, platform: Platform) -> Option<ByteBuffer> {
        let mut buffer = ByteBuffer::new();

        {
            let mut cursor = Cursor::new(&mut buffer);
            self.mat_data
                .write_options(&mut cursor, platform.endianness(), ())
                .ok()?;
        }

        Some(buffer)
    }
}

impl Material {
    /// Builds a material path for a specific gear
    pub fn gear_material_path(gear_id: i32, gear_version: i32, material_name: &str) -> String {
        format!("chara/equipment/e{gear_id:04}/material/v{gear_version:04}{material_name}")
    }

    /// Builds a skin material path for a character
    pub fn skin_material_path(race_code: i32, body_code: i32, material_name: &str) -> String {
        format!(
            "chara/human/c{race_code:04}/obj/body/b{body_code:04}/material/v0001{material_name}"
        )
    }

    /// Builds a face material path for a character
    pub fn face_material_path(race_code: i32, face_code: i32, material_name: &str) -> String {
        format!("chara/human/c{race_code:04}/obj/face/f{face_code:04}/material{material_name}")
    }

    /// Builds a hair material path for a character
    pub fn hair_material_path(race_code: i32, hair_code: i32, material_name: &str) -> String {
        format!(
            "chara/human/c{race_code:04}/obj/hair/h{hair_code:04}/material/v0001{material_name}"
        )
    }

    /// Builds a ear material path for a character
    pub fn ear_material_path(race_code: i32, ear_code: i32, material_name: &str) -> String {
        format!("chara/human/c{race_code:04}/obj/ear/e{ear_code:04}/material/v0001{material_name}")
    }

    /// Builds a tail material path for a character
    pub fn tail_material_path(race_code: i32, tail_code: i32, material_name: &str) -> String {
        format!(
            "chara/human/c{race_code:04}/obj/tail/t{tail_code:04}/material/v0001{material_name}"
        )
    }
}

#[cfg(test)]
mod tests {
    use crate::pass_random_invalid;

    use super::*;

    #[test]
    fn test_invalid() {
        pass_random_invalid::<Material>();
    }
}