GARbro-mirror/ArcFormats/Unity/Texture2D.cs

//! \file       Texture2D.cs
//! \date       Fri Apr 14 08:20:08 2017
//! \brief      Unity engine texture deserialzer.
//
// Copyright (C) 2017 by morkt
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//

using System;
using System.Collections;
using System.IO;
using System.Windows.Media;
using GameRes.Formats.DirectDraw;
using GameRes.Utility;

namespace GameRes.Formats.Unity
{
    enum TextureFormat : int
    {
        Alpha8 = 1,
        ARGB4444 = 2,
        RGB24 = 3,
        RGBA32 = 4,
        ARGB32 = 5,
        R16 = 6, // A 16 bit color texture format that only has a red channel.
        RGB565 = 7,
        DXT1 = 10,
        DXT5 = 12,
        RGBA4444 = 13,
        BGRA32 = 14,
        BC7 = 25,
        DXT1Crunched = 28,
        DXT5Crunched = 29,
    }

    internal class Texture2D
    {
        public string   m_Name;
        public int      m_Width;
        public int      m_Height;
        public int      m_CompleteImageSize;
        public TextureFormat m_TextureFormat;
        public int      m_MipCount;
        public bool     m_IsReadable;
        public bool     m_ReadAllowed;
        public int      m_ImageCount;
        public int      m_TextureDimension;
        public int      m_FilterMode;
        public int      m_Aniso;
        public float    m_MipBias;
        public int      m_WrapMode;
        public int      m_LightFormat;
        public int      m_ColorSpace;
        public int      m_DataLength;
        public byte[]   m_Data;

        public void Load (AssetReader reader)
        {
            m_Name = reader.ReadString();
            reader.Align();
            m_Width = reader.ReadInt32();
            m_Height = reader.ReadInt32();
            m_CompleteImageSize = reader.ReadInt32();
            m_TextureFormat = (TextureFormat)reader.ReadInt32();
            m_MipCount = reader.ReadInt32();
            if (reader.Format > 9)
            {
                m_IsReadable = reader.ReadBool();
                m_ReadAllowed = reader.ReadBool();
                reader.Align();
            }
            m_ImageCount = reader.ReadInt32();
            m_TextureDimension = reader.ReadInt32();
            m_FilterMode = reader.ReadInt32();
            m_Aniso = reader.ReadInt32();
            m_MipBias = reader.ReadFloat();
            m_WrapMode = reader.ReadInt32();
            m_LightFormat = reader.ReadInt32();
            m_ColorSpace = reader.ReadInt32();
            m_DataLength = reader.ReadInt32();
        }

        public void Load (AssetReader reader, UnityTypeData type)
        {
            if ("2021.1.3f1" == type.Version) // type.Hashes[28] == [0D 08 41 4C FD 5B DB 0D 22 79 20 11 BD A9 AB 26]
            {
                Load2021 (reader);
                return;
            }
            if (type.Version != "2017.3.1f1" && type.Version != "2019.3.0f1" && type.Version != "2017.4.3f1")
            {
                Load (reader);
                if (0 == m_DataLength && type.Version.StartsWith ("2017.")) // "2017.2.0f3" || "2017.1.1p1"
                    reader.ReadInt64();
                return;
            }
            // type hash = [1E 87 D8 2D 4F D0 58 50 9A 3C 78 66 DB 0E 73 56]
            m_Name = reader.ReadString();
            reader.Align();
            reader.ReadInt32(); // m_ForcedFallbackFormat
            reader.ReadInt32(); // m_DownscaleFallback
            m_Width = reader.ReadInt32();
            m_Height = reader.ReadInt32();
            m_CompleteImageSize = reader.ReadInt32();
            m_TextureFormat = (TextureFormat)reader.ReadInt32();
            m_MipCount = reader.ReadInt32();
            m_IsReadable = reader.ReadBool();
            reader.Align();
            if ("2019.3.0f1" == type.Version) // type hash = [EE 6C 40 81 7D 29 51 92 9C DB 4F 5A 60 87 4F 5D]
                reader.ReadInt32(); // m_StreamingMipmapsPriority
            m_ImageCount = reader.ReadInt32();
            m_TextureDimension = reader.ReadInt32();
            m_FilterMode = reader.ReadInt32();
            m_Aniso = reader.ReadInt32();
            m_MipBias = reader.ReadFloat();
            m_WrapMode = reader.ReadInt32(); // m_WrapU
            reader.ReadInt32(); // m_WrapV
            reader.ReadInt32(); // m_WrapW
            reader.ReadInt32(); // m_LightmapFormat 
            m_ColorSpace = reader.ReadInt32();
            m_DataLength = reader.ReadInt32();
        }

        public void Load2017 (AssetReader reader)
        {
            m_Name = reader.ReadString();
            reader.Align();
            reader.ReadInt32(); // m_ForcedFallbackFormat
            reader.ReadInt32(); // m_DownscaleFallback
            m_Width = reader.ReadInt32();
            m_Height = reader.ReadInt32();
            m_CompleteImageSize = reader.ReadInt32();
            m_TextureFormat = (TextureFormat)reader.ReadInt32();
            m_MipCount = reader.ReadInt32();
            m_IsReadable = reader.ReadBool();
            reader.Align();
            m_ImageCount = reader.ReadInt32();
            m_TextureDimension = reader.ReadInt32();
            m_FilterMode = reader.ReadInt32();
            m_Aniso = reader.ReadInt32();
            m_MipBias = reader.ReadFloat();
            m_WrapMode = reader.ReadInt32(); // m_WrapU
            reader.ReadInt32(); // m_WrapV
            reader.ReadInt32(); // m_WrapW
            reader.ReadInt32(); // m_LightmapFormat 
            m_ColorSpace = reader.ReadInt32();
            m_DataLength = reader.ReadInt32();
        }

        public void Load2021 (AssetReader reader)
        {
            m_Name = reader.ReadString();
            reader.Align();
            reader.ReadInt32(); // m_ForcedFallbackFormat
            reader.ReadInt32(); // m_DownscaleFallback
            m_Width = reader.ReadInt32();
            m_Height = reader.ReadInt32();
            m_CompleteImageSize = reader.ReadInt32();
            reader.ReadInt32(); // m_MipsStripped;
            m_TextureFormat = (TextureFormat)reader.ReadInt32();
            m_MipCount = reader.ReadInt32();
            m_IsReadable = reader.ReadBool();
            reader.Align();
            reader.ReadInt32(); // m_StreamingMipmapsPriority
            m_ImageCount = reader.ReadInt32();
            m_TextureDimension = reader.ReadInt32();
            m_FilterMode = reader.ReadInt32();
            m_Aniso = reader.ReadInt32();
            m_MipBias = reader.ReadFloat();
            m_WrapMode = reader.ReadInt32(); // m_WrapU
            reader.ReadInt32(); // m_WrapV
            reader.ReadInt32(); // m_WrapW
            reader.ReadInt32(); // m_LightmapFormat 
            m_ColorSpace = reader.ReadInt32();
            reader.ReadInt32();
            m_DataLength = reader.ReadInt32();
        }

        public void LoadData (AssetReader reader)
        {
            m_Data = reader.ReadBytes (m_DataLength);
        }

        public void Import (IDictionary fields)
        {
            m_Name = fields["m_Name"] as string ?? "";
            m_Width = (int)(fields["m_Width"] ?? 0);
            m_Height = (int)(fields["m_Height"] ?? 0);
            m_CompleteImageSize = (int)(fields["m_CompleteImageSize"] ?? 0);
            m_TextureFormat = (TextureFormat)(fields["m_TextureFormat"] ?? 0);
            m_MipCount = (int)(fields["m_MipCount"] ?? 0);
            m_ImageCount = (int)(fields["m_ImageCount"] ?? 0);
            m_TextureDimension = (int)(fields["m_TextureDimension"] ?? 0);
            m_IsReadable = (bool)(fields["m_IsReadable"] ?? false);
            m_Data = fields["image data"] as byte[] ?? Array.Empty<byte>();
        }
    }

    internal class Texture2DDecoder : IImageDecoder
    {
        AssetReader     m_reader;
        Texture2D       m_texture;
        ImageData       m_image;

        public Stream            Source { get { m_reader.Position = 0; return m_reader.Source; } }
        public ImageFormat SourceFormat { get { return null; } }
        public PixelFormat       Format { get; private set; }
        public ImageMetaData       Info { get; private set; }
        public ImageData          Image { get { return m_image ?? (m_image = Unpack()); } }

        public Texture2DDecoder (Texture2D texture, AssetReader input)
        {
            m_reader = input;
            m_texture = texture;
            Info = new ImageMetaData {
                Width   = (uint)m_texture.m_Width,
                Height  = (uint)m_texture.m_Height,
            };
            SetFormat (m_texture.m_TextureFormat);
        }

        void SetFormat (TextureFormat format)
        {
            switch (format)
            {
            case TextureFormat.Alpha8:
                Format = PixelFormats.Gray8;
                Info.BPP = 8;
                break;

            case TextureFormat.R16:
                Format = PixelFormats.Gray16;
                Info.BPP = 16;
                break;

            case TextureFormat.RGB24:
                Format = PixelFormats.Rgb24;
                Info.BPP = 24;
                break;

            case TextureFormat.RGB565:
                Format = PixelFormats.Bgr565;
                Info.BPP = 16;
                break;

            default:
                Format = PixelFormats.Bgra32;
                Info.BPP = 32;
                break;
            }
        }

        ImageData Unpack ()
        {
            if (null == m_texture.m_Data || 0 == m_texture.m_Data.Length)
                m_texture.LoadData (m_reader);
            byte[] pixels;
            switch (m_texture.m_TextureFormat)
            {
            case TextureFormat.DXT1:
                {
                    var decoder = new DxtDecoder (m_texture.m_Data, Info);
                    pixels = decoder.UnpackDXT1();
                    break;
                }
            case TextureFormat.DXT5:
                {
                    var decoder = new DxtDecoder (m_texture.m_Data, Info);
                    pixels = decoder.UnpackDXT5();
                    break;
                }
            case TextureFormat.Alpha8:
            case TextureFormat.R16:
            case TextureFormat.RGB24:
            case TextureFormat.BGRA32:
            case TextureFormat.RGB565:
                pixels = m_texture.m_Data;
                break;

            case TextureFormat.ARGB32:
                pixels = ConvertArgb (m_texture.m_Data);
                break;

            case TextureFormat.RGBA32:
                pixels = ConvertRgba (m_texture.m_Data);
                break;

            case TextureFormat.ARGB4444:
                pixels = ConvertArgb16 (m_texture.m_Data);
                break;

            case TextureFormat.BC7:
                {
                    var decoder = new Bc7Decoder (m_texture.m_Data, Info);
                    pixels = decoder.Unpack();
                    break;
                }
            default:
                throw new NotImplementedException (string.Format ("Not supported Unity Texture2D format '{0}'.", m_texture.m_TextureFormat));
            }
            return ImageData.CreateFlipped (Info, Format, null, pixels, (int)Info.Width*((Format.BitsPerPixel+7)/8));
        }

        byte[] ConvertArgb (byte[] data)
        {
            // XXX conversion performed in-place.
            for (int i = 0; i < data.Length; i += 4)
            {
                uint x = BigEndian.ToUInt32 (data, i);
                LittleEndian.Pack (x, data, i);
            }
            return data;
        }

        byte[] ConvertArgb16 (byte[] data)
        {
            var output = new byte[data.Length * 2];
            int dst = 0;
            for (int i = 0; i < data.Length; i += 2)
            {
                ushort p = LittleEndian.ToUInt16 (data, i);
                output[dst++] = (byte)( (p        & 0xF) * 0x11);
                output[dst++] = (byte)(((p >>  4) & 0xF) * 0x11);
                output[dst++] = (byte)(((p >>  8) & 0xF) * 0x11);
                output[dst++] = (byte)(((p >> 12) & 0xF) * 0x11);
            }
            return output;
        }

        byte[] ConvertRgba (byte[] data)
        {
            for (int i = 0; i < data.Length; i += 4)
            {
                byte r = data[i];
                data[i] = data[i+2];
                data[i+2] = r;
            }
            return data;
        }

        bool m_disposed = false;
        public void Dispose ()
        {
            if (!m_disposed)
            {
                m_reader.Dispose();
                m_disposed = true;
            }
        }
    }
    /*
--- Texture2D --- 2017.3.1f1 ---
    string  m_Name
    int     m_ForcedFallbackFormat
    int     m_DownscaleFallback
    int     m_Width
    int     m_Height
    int     m_CompleteImageSize
    int     m_TextureFormat
    int     m_MipCount
    bool    m_IsReadable
    int     m_ImageCount
    int     m_TextureDimension
    GLTextureSettings   m_TextureSettings // sizeof = 0x18
        int     m_FilterMode
        int     m_Aniso
        float   m_MipBias
        int     m_WrapU
        int     m_WrapV
        int     m_WrapW
    int     m_LightmapFormat
    int     m_ColorSpace
    byte[]      image data // int + byte[]
    StreamingInfo   m_StreamData
        uint    offset
        uint    size
        string  path
    */
}