linux-wallpaperengine-kde/src/WallpaperEngine/Assets/CTexture.cpp

#include "CTexture.h"

#include <string>
#include <cstring>
#include <lz4.h>

using namespace WallpaperEngine::Assets;

CTexture::CTexture (void* fileData)
{
    // ensure the header is parsed
    this->parseHeader (static_cast <char*> (fileData));

    GLint internalFormat;

    if (this->m_header->freeImageFormat != FREE_IMAGE_FORMAT::FIF_UNKNOWN)
    {
        internalFormat = GL_RGBA8;
        // set some extra information too as it's used for image sizing
        // this ensures that a_TexCoord uses the full image instead of just part of it
        this->m_header->width = this->m_header->mipmaps [0]->width;
        this->m_header->height = this->m_header->mipmaps [0]->height;
        this->m_header->textureWidth = this->m_header->mipmaps [0]->width;
        this->m_header->textureHeight = this->m_header->mipmaps [0]->height;
        // TODO: MAYBE IT'S BETTER TO CREATE A TEXTURE OF THE GIVEN SIZE AND COPY OVER WHAT WE READ FROM THE FILE?
    }
    else
    {
        // detect the image format and hand it to openGL to be used
        switch (this->m_header->format)
        {
            case TextureFormat::DXT5:
                internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT5_EXT;
                break;
            case TextureFormat::DXT3:
                internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT3_EXT;
                break;
            case TextureFormat::DXT1:
                internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT1_EXT;
                break;
            case TextureFormat::ARGB8888:
                internalFormat = GL_RGBA8;
                break;
            case TextureFormat::R8:
                internalFormat = GL_R8;
                break;
            case TextureFormat::RG88:
                internalFormat = GL_RG8;
                break;
            default:
                delete this->m_header;
                throw std::runtime_error ("Cannot determine the texture format");
        }
    }

    // set the texture resolution
    // TODO: SUPPORT SPRITES
    this->m_resolution = {
        this->m_header->textureWidth, this->m_header->textureHeight,
        this->m_header->width, this->m_header->height
    };

    // reserve a texture
    glGenTextures (1, &this->m_textureID);

    // bind the texture to assign information to it
    glBindTexture (GL_TEXTURE_2D, this->m_textureID);
    // set mipmap levels
    glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_BASE_LEVEL, 0);
    glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAX_LEVEL, this->m_header->mipmapCount - 1);

    // TODO: ADD SUPPORT FOR .tex-json FILES AS THEY ALSO HAVE FLAGS LIKE THESE ONES
    // setup texture wrapping and filtering
    if (this->m_header->flags & TextureFlags::ClampUVs)
    {
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
    }
    else
    {
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
    }

    if (this->m_header->flags & TextureFlags::NoInterpolation)
    {
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
    }
    else
    {
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
        glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
    }

    // TODO: USE THIS ONE
    // uint32_t blockSize = (internalFormat == GL_COMPRESSED_RGBA_S3TC_DXT1_EXT) ? 8 : 16;

    auto cur = this->m_header->mipmaps.begin ();
    auto end = this->m_header->mipmaps.end ();

    for (int32_t level = 0; cur != end; cur ++, level ++)
    {
        FIBITMAP* bitmap = nullptr;
        FIBITMAP* converted = nullptr;
        FIMEMORY* memory = nullptr;
        void* dataptr = (*cur)->uncompressedData;
        uint32_t width = (*cur)->width;
        uint32_t height = (*cur)->height;
        GLenum textureFormat = GL_RGBA;

        if (this->m_header->freeImageFormat != FREE_IMAGE_FORMAT::FIF_UNKNOWN)
        {
            memory = FreeImage_OpenMemory (reinterpret_cast <BYTE *> ((*cur)->uncompressedData), (*cur)->uncompressedSize);

            // load the image and setup pointers so they can be used
            bitmap = FreeImage_LoadFromMemory (this->m_header->freeImageFormat, memory);
            // flip the image vertically
            FreeImage_FlipVertical (bitmap);
            // convert to a 32bits bytearray
            converted = FreeImage_ConvertTo32Bits (bitmap);

            dataptr = FreeImage_GetBits (converted);
            width = FreeImage_GetWidth (converted);
            height = FreeImage_GetHeight (converted);
            textureFormat = GL_BGRA;
        }
        else
        {
            if (this->m_header->format == TextureFormat::RG88)
                textureFormat = GL_RG;
            else if (this->m_header->format == TextureFormat::R8)
                textureFormat = GL_R;
        }

        switch (internalFormat)
        {
            case GL_RGBA8:
                glTexImage2D (GL_TEXTURE_2D, level, internalFormat,
                    width, height, 0,
                    textureFormat, GL_UNSIGNED_BYTE,
                    dataptr
                );
                break;
            case GL_COMPRESSED_RGBA_S3TC_DXT1_EXT:
            case GL_COMPRESSED_RGBA_S3TC_DXT3_EXT:
            case GL_COMPRESSED_RGBA_S3TC_DXT5_EXT:
                glCompressedTexImage2D (
                        GL_TEXTURE_2D, level, internalFormat,
                        (*cur)->width, (*cur)->height, 0,
                        (*cur)->uncompressedSize, dataptr
                );
                break;
        }

        // freeimage buffer won't be used anymore, so free memory
        if (this->m_header->freeImageFormat != FREE_IMAGE_FORMAT::FIF_UNKNOWN)
        {
            FreeImage_Unload (bitmap);
            FreeImage_Unload (converted);
            FreeImage_CloseMemory (memory);
        }
    }
}

CTexture::~CTexture ()
{
    if (this->getHeader () == nullptr)
        return;

    // free the header if it was allocated
    delete this->getHeader ();
}

const GLuint CTexture::getTextureID () const
{
    return this->m_textureID;
}

const uint32_t CTexture::getTextureWidth () const
{
    return this->getHeader ()->textureWidth;
}

const uint32_t CTexture::getTextureHeight () const
{
    return this->getHeader ()->textureHeight;
}

const uint32_t CTexture::getRealWidth () const
{
    return this->getHeader ()->width;
}

const uint32_t CTexture::getRealHeight () const
{
    return this->getHeader ()->height;
}

const ITexture::TextureFormat CTexture::getFormat () const
{
    return this->getHeader ()->format;
}

const CTexture::TextureHeader* CTexture::getHeader () const
{
    return this->m_header;
}

const glm::vec4* CTexture::getResolution () const
{
    return &this->m_resolution;
}

CTexture::TextureMipmap::TextureMipmap ()
{
}

CTexture::TextureMipmap::~TextureMipmap ()
{
    if (this->compression == 1)
        delete this->compressedData;

    delete this->uncompressedData;
}

void CTexture::TextureMipmap::decompressData ()
{
    if (this->compression == 1)
    {
        this->uncompressedData = new char [this->uncompressedSize];

        int result = LZ4_decompress_safe (
            this->compressedData, this->uncompressedData,
            this->compressedSize, this->uncompressedSize
        );

        if (!result)
            throw std::runtime_error ("Cannot decompress texture data");
    }
}

CTexture::TextureHeader::TextureHeader ()
{
}

CTexture::TextureHeader::~TextureHeader ()
{
    auto cur = this->mipmaps.begin ();
    auto end = this->mipmaps.end ();

    for (; cur != end; cur ++)
        delete *cur;
}

void CTexture::parseHeader (char* fileData)
{
    // check the magic value on the header first
    if (memcmp (fileData, "TEXV0005", 9) != 0)
        throw std::runtime_error ("unexpected texture container type");
    // jump to the next value
    fileData += 9;
    // check the sub-magic value on the header
    if (memcmp (fileData, "TEXI0001", 9) != 0)
        throw std::runtime_error ("unexpected texture sub-container type");
    // jump through the string again
    fileData += 9;

    this->m_header = new TextureHeader;

    uint32_t* pointer = reinterpret_cast <uint32_t*> (fileData);

    this->m_header->format = static_cast <TextureFormat>(*pointer ++);
    this->m_header->flags = static_cast <TextureFlags> (*pointer ++);
    this->m_header->textureWidth = *pointer ++;
    this->m_header->textureHeight = *pointer ++;
    this->m_header->width = *pointer ++;
    this->m_header->height = *pointer ++;
    pointer ++; // ignore some more bytes

    // now we're going to parse some more data that is string
    // so get the current position back as string
    fileData = reinterpret_cast <char*> (pointer);
    // get the position of what comes after the texture data
    pointer = reinterpret_cast <uint32_t*> (fileData + 9);

    if (memcmp (fileData, "TEXB0003", 9) == 0)
    {
        this->m_header->containerVersion = ContainerVersion::TEXB0003;

        // get back the pointer and use it
        pointer ++;
        this->m_header->freeImageFormat = static_cast <FREE_IMAGE_FORMAT> (*pointer++);
    }
    else if(memcmp (fileData, "TEXB0002", 9) == 0)
    {
        this->m_header->containerVersion = ContainerVersion::TEXB0002;

        // skip 4 bytes
        pointer ++;
    }
    else if (memcmp (fileData, "TEXB0001", 9) == 0)
    {
        this->m_header->containerVersion = ContainerVersion::TEXB0001;

        // skip 4 bytes
        pointer ++;
    }
    else
    {
        delete this->m_header;
        this->m_header = nullptr;
        throw std::runtime_error ("unknown texture format type");
    }

    // read the number of mipmaps available
    this->m_header->mipmapCount = *pointer ++;

    fileData = reinterpret_cast <char*> (pointer);

    for (uint32_t i = 0; i < this->m_header->mipmapCount; i ++)
        this->m_header->mipmaps.emplace_back (this->parseMipmap (this->m_header, &fileData));
}


CTexture::TextureMipmap* CTexture::parseMipmap (TextureHeader* header, char** originalFileData)
{
    TextureMipmap* mipmap = new TextureMipmap ();

    // get the current position
    char* fileData = *originalFileData;

    // get an integer pointer
    uint32_t* pointer = reinterpret_cast <uint32_t*> (fileData);

    mipmap->width = *pointer++;
    mipmap->height = *pointer++;

    if (header->containerVersion == ContainerVersion::TEXB0002 ||
        header->containerVersion == ContainerVersion::TEXB0003)
    {
        mipmap->compression = *pointer++;
        mipmap->uncompressedSize = *pointer++;
    }

    mipmap->compressedSize = *pointer++;

    // get back a normal char pointer
    fileData = reinterpret_cast <char*> (pointer);

    if (mipmap->compression == 0)
    {
        // this might be better named as mipmap_bytes_size instead of compressedSize
        // as in uncompressed files this variable actually holds the file length
        mipmap->uncompressedSize = mipmap->compressedSize;
    }

    mipmap->uncompressedData = new char [mipmap->uncompressedSize];

    if (mipmap->compression == 1)
    {
        mipmap->compressedData = new char [mipmap->compressedSize];

        memcpy (mipmap->compressedData, fileData, mipmap->compressedSize);

        mipmap->decompressData ();
        // advance to the end of the mipmap
        fileData += mipmap->compressedSize;
    }
    else
    {
        memcpy (mipmap->uncompressedData, fileData, mipmap->uncompressedSize);
        // advance to the end of the mipmap
        fileData += mipmap->uncompressedSize;
    }

    // ensure the pointer is updated with the latest position when reading the data
    *originalFileData = fileData;

    return mipmap;
}