o3de/Code/CryEngine/Cry3DEngine/CGF/ChunkFileReaders.cpp

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#include <platform.h>
#include <CryFile.h>
#include <CryHeaders.h>
#include "ChunkFileReaders.h"
#include "CryPath.h"

namespace ChunkFile
{
    //////////////////////////////////////////////////////////////////////////

    CryFileReader::CryFileReader()
    {
    }

    CryFileReader::~CryFileReader()
    {
        Close();
    }

    bool CryFileReader::Open(const char* filename)
    {
        Close();

        if (filename == 0 || filename[0] == 0)
        {
            return false;
        }

        if (!m_f.Open(filename, "rb"))
        {
            return false;
        }

        m_offset = 0;

        return true;
    }

    void CryFileReader::Close()
    {
        m_f.Close();
    }

    int32 CryFileReader::GetSize()
    {
        return m_f.GetLength();
    }

    bool CryFileReader::SetPos(int32 pos)
    {
        if (pos < 0)
        {
            return false;
        }
        m_offset = pos;
        return m_f.Seek(m_offset, SEEK_SET) == 0;
    }

    bool CryFileReader::Read(void* buffer, size_t size)
    {
        return m_f.ReadRaw(buffer, size) == size;
    }

    //////////////////////////////////////////////////////////////////////////

    MemoryReader::MemoryReader()
        : m_ptr(0)
        , m_size(0)
    {
    }

    MemoryReader::~MemoryReader()
    {
    }

    bool MemoryReader::Start(void* ptr, int32 size)
    {
        if (ptr == 0 || size <= 0)
        {
            return false;
        }

        m_ptr = (char*)ptr;
        m_size = size;
        m_offset = 0;

        return true;
    }

    void MemoryReader::Close()
    {
    }

    int32 MemoryReader::GetSize()
    {
        return m_size;
    }

    bool MemoryReader::SetPos(int32 pos)
    {
        if (pos < 0 || pos > m_size)
        {
            return false;
        }
        m_offset = pos;
        return true;
    }

    bool MemoryReader::Read(void* buffer, size_t size)
    {
        if (!m_ptr)
        {
            return false;
        }

        if (size <= 0)
        {
            return true;
        }

        if ((size_t)m_offset + size > (size_t)m_size)
        {
            return false;
        }

        memcpy(buffer, &m_ptr[m_offset], size);
        m_offset += size;

        return true;
    }

    //////////////////////////////////////////////////////////////////////////

    namespace
    {
        class ChunkListRef
        {
            std::vector<IChunkFile::ChunkDesc>& m_chunks;

        public:
            ChunkListRef(std::vector<IChunkFile::ChunkDesc>& chunks)
                : m_chunks(chunks)
            {
            }

            void Clear()
            {
                for (size_t i = 0; i < m_chunks.size(); ++i)
                {
                    if (m_chunks[i].data)
                    {
                        delete [] (char*)m_chunks[i].data;
                        m_chunks[i].data = 0;
                    }
                }
                m_chunks.clear();
            }

            void Create(size_t count)
            {
                Clear();
                m_chunks.resize(count);
                for (size_t i = 0; i < count; ++i)
                {
                    m_chunks[i].data = 0;
                    m_chunks[i].size = 0;
                }
            }

            void Sort()
            {
                std::sort(m_chunks.begin(), m_chunks.end(), IChunkFile::ChunkDesc::LessOffset);
            }

            size_t GetCount() const
            {
                return m_chunks.size();
            }

            IChunkFile::ChunkDesc& Get(size_t index)
            {
                return m_chunks[index];
            }
        };

        class ChunkPtrListRef
        {
            std::vector<IChunkFile::ChunkDesc*>& m_chunks;

        public:
            ChunkPtrListRef(std::vector<IChunkFile::ChunkDesc*>& chunks)
                : m_chunks(chunks)
            {
            }

            void Clear()
            {
                for (size_t i = 0; i < m_chunks.size(); ++i)
                {
                    if (m_chunks[i])
                    {
                        if (m_chunks[i]->data)
                        {
                            delete [] (char*)(m_chunks[i]->data);
                            m_chunks[i]->data = 0;
                        }
                        delete m_chunks[i];
                    }
                }
                m_chunks.clear();
            }

            void Create(size_t count)
            {
                Clear();
                m_chunks.resize(count, 0);
                for (size_t i = 0; i < count; ++i)
                {
                    m_chunks[i] = new IChunkFile::ChunkDesc;
                    m_chunks[i]->data = 0;
                    m_chunks[i]->size = 0;
                }
            }

            void Sort()
            {
                std::sort(m_chunks.begin(), m_chunks.end(), IChunkFile::ChunkDesc::LessOffsetByPtr);
            }

            size_t GetCount() const
            {
                return m_chunks.size();
            }

            IChunkFile::ChunkDesc& Get(size_t index)
            {
                return *m_chunks[index];
            }
        };
    } // namespace


    //////////////////////////////////////////////////////////////////////////

    template <class TListRef>
    static const char* GetChunkTableEntries_0x744_0x745_Tpl(IReader* pReader, TListRef& chunks)
    {
        chunks.Clear();

        ChunkFile::FileHeader_0x744_0x745 header;

        if (!pReader->SetPos(0) ||
            !pReader->Read(&header, sizeof(header)))
        {
            return "Cannot read header of chunk file";
        }

        if (!header.HasValidSignature())
        {
            return "Unknown signature in chunk file";
        }

        if (SYSTEM_IS_BIG_ENDIAN)
        {
            header.SwapEndianness();
        }

        if (header.version != 0x744 && header.version != 0x745)
        {
            return "Version of chunk file is neither 0x744 nor 0x745";
        }

        if (header.fileType != header.eFileType_Geom && header.fileType != header.eFileType_Anim)
        {
            return "Type of chunk file is neither FileType_Geom nor FileType_Anim";
        }

        uint32 chunkCount = 0;
        {
            if (!pReader->SetPos(header.chunkTableOffset) ||
                !pReader->Read(&chunkCount, sizeof(chunkCount)))
            {
                return "Failed to read # of chunks";
            }

            if (SYSTEM_IS_BIG_ENDIAN)
            {
                SwapEndianBase(&chunkCount, 1);
            }

            if (chunkCount < 0 || chunkCount > 1000000)
            {
                return "Invalid # of chunks in file";
            }
        }

        if (chunkCount <= 0)
        {
            return 0;
        }

        chunks.Create(chunkCount);

        if (header.version == 0x744)
        {
            std::vector<ChunkFile::ChunkTableEntry_0x744> srcChunks;
            srcChunks.resize(chunkCount);

            if (!pReader->Read(&srcChunks[0], sizeof(srcChunks[0]) * srcChunks.size()))
            {
                return "Failed to read chunk entries from file";
            }

            if (SYSTEM_IS_BIG_ENDIAN)
            {
                for (uint32 i = 0; i < chunkCount; ++i)
                {
                    srcChunks[i].SwapEndianness();
                }
            }

            for (uint32 i = 0; i < chunkCount; ++i)
            {
                IChunkFile::ChunkDesc& cd = chunks.Get(i);

                cd.chunkType = (ChunkTypes)ConvertChunkTypeTo0x746(srcChunks[i].type);
                cd.chunkVersion = srcChunks[i].version & ~ChunkFile::ChunkHeader_0x744_0x745::kBigEndianVersionFlag;
                cd.chunkId = srcChunks[i].id;
                cd.fileOffset = srcChunks[i].offsetInFile;
                cd.bSwapEndian = (srcChunks[i].version & ChunkFile::ChunkHeader_0x744_0x745::kBigEndianVersionFlag) ? SYSTEM_IS_LITTLE_ENDIAN : SYSTEM_IS_BIG_ENDIAN;
            }

            chunks.Sort();

            const uint32 endOfChunkData = (header.chunkTableOffset < chunks.Get(0).fileOffset)
                ? (uint32)pReader->GetSize()
                : header.chunkTableOffset;

            for (uint32 i = 0; i < chunkCount; ++i)
            {
                // calculate chunk size based on the next (by offset in file) chunk or
                // on the end of the chunk data portion of the file

                const size_t nextOffsetInFile = (i + 1 < chunkCount)
                    ? chunks.Get(i + 1).fileOffset
                    : endOfChunkData;

                chunks.Get(i).size = nextOffsetInFile - chunks.Get(i).fileOffset;
            }
        }
        else // header.version == 0x745
        {
            std::vector<ChunkFile::ChunkTableEntry_0x745> srcChunks;
            srcChunks.resize(chunkCount);

            if (!pReader->Read(&srcChunks[0], sizeof(srcChunks[0]) * srcChunks.size()))
            {
                return "Failed to read chunk entries from file.";
            }

            if (SYSTEM_IS_BIG_ENDIAN)
            {
                for (uint32 i = 0; i < chunkCount; ++i)
                {
                    srcChunks[i].SwapEndianness();
                }
            }

            for (uint32 i = 0; i < chunkCount; ++i)
            {
                IChunkFile::ChunkDesc& cd = chunks.Get(i);

                cd.chunkType = (ChunkTypes)ConvertChunkTypeTo0x746(srcChunks[i].type);
                cd.chunkVersion = srcChunks[i].version & ~ChunkFile::ChunkHeader_0x744_0x745::kBigEndianVersionFlag;
                cd.chunkId = srcChunks[i].id;
                cd.fileOffset = srcChunks[i].offsetInFile;
                cd.size = srcChunks[i].size;
                cd.bSwapEndian = (srcChunks[i].version & ChunkFile::ChunkHeader_0x744_0x745::kBigEndianVersionFlag) ? SYSTEM_IS_LITTLE_ENDIAN : SYSTEM_IS_BIG_ENDIAN;
            }
        }

        const uint32 fileSize = (uint32)pReader->GetSize();

        for (uint32 i = 0; i < chunkCount; ++i)
        {
            const IChunkFile::ChunkDesc& cd = chunks.Get(i);

            if (cd.size + cd.fileOffset > fileSize)
            {
                return "Data in chunk file are corrupted";
            }
        }

        return 0;
    }


    template <class TListRef>
    static const char* GetChunkTableEntries_0x746_Tpl(IReader* pReader, TListRef& chunks)
    {
        chunks.Clear();

        ChunkFile::FileHeader_0x746 header;

        if (!pReader->SetPos(0) ||
            !pReader->Read(&header, sizeof(header)))
        {
            return "Cannot read header from file.";
        }

        if (!header.HasValidSignature())
        {
            return "Unknown signature in chunk file";
        }

        if (SYSTEM_IS_BIG_ENDIAN)
        {
            header.SwapEndianness();
        }

        if (header.version != 0x746)
        {
            return "Version of chunk file is not 0x746";
        }

        if (header.chunkCount < 0 || header.chunkCount > 10000000)
        {
            return "Invalid # of chunks in file.";
        }

        if (header.chunkCount <= 0)
        {
            return 0;
        }

        chunks.Create(header.chunkCount);

        std::vector<ChunkFile::ChunkTableEntry_0x746> srcChunks;
        srcChunks.resize(header.chunkCount);

        if (!pReader->SetPos(header.chunkTableOffset) ||
            !pReader->Read(&srcChunks[0], sizeof(srcChunks[0]) * srcChunks.size()))
        {
            return "Failed to read chunk entries from file";
        }

        if (SYSTEM_IS_BIG_ENDIAN)
        {
            for (uint32 i = 0; i < header.chunkCount; ++i)
            {
                srcChunks[i].SwapEndianness();
            }
        }

        for (size_t i = 0, n = chunks.GetCount(); i < n; ++i)
        {
            IChunkFile::ChunkDesc& cd = chunks.Get(i);

            cd.chunkType = (ChunkTypes)srcChunks[i].type;
            cd.chunkVersion = srcChunks[i].version & ~ChunkFile::ChunkTableEntry_0x746::kBigEndianVersionFlag;
            cd.chunkId = srcChunks[i].id;
            cd.size = srcChunks[i].size;
            cd.fileOffset = srcChunks[i].offsetInFile;
            cd.bSwapEndian = (srcChunks[i].version & ChunkFile::ChunkTableEntry_0x746::kBigEndianVersionFlag) ? SYSTEM_IS_LITTLE_ENDIAN : SYSTEM_IS_BIG_ENDIAN;
        }

        return 0;
    }


    template <class TListRef>
    static const char* StripChunkHeaders_0x744_0x745_Tpl(IReader* pReader, TListRef& chunks)
    {
        for (size_t i = 0, n = chunks.GetCount(); i < n; ++i)
        {
            IChunkFile::ChunkDesc& ct = chunks.Get(i);

            if (ChunkFile::ChunkContainsHeader_0x744_0x745(ct.chunkType, ct.chunkVersion))
            {
                ChunkFile::ChunkHeader_0x744_0x745 ch;
                if (ct.size < sizeof(ch))
                {
                    return "Damaged data: reported size of chunk data is less that size of the chunk header";
                }

                // Validation
                {
                    if (!pReader->SetPos(ct.fileOffset) ||
                        !pReader->Read(&ch, sizeof(ch)))
                    {
                        return "Failed to read chunk header from file";
                    }

                    if (SYSTEM_IS_BIG_ENDIAN)
                    {
                        ch.SwapEndianness();
                    }

                    ch.version &= ~ChunkFile::ChunkHeader_0x744_0x745::kBigEndianVersionFlag;

                    if (ConvertChunkTypeTo0x746(ch.type) != ct.chunkType ||
                        ch.version != ct.chunkVersion ||
                        ch.id != ct.chunkId)
                    {
                        return "Data in a chunk header don't match data in the chunk table";
                    }

                    // The following check is commented out because we have (on 2013/11/25)
                    // big number of .cgf files in Crysis 3 that fail to pass the check.
                    //if (ch.offsetInFile != ct.fileOffset)
                    //{
                    //  return "File offset data in a chunk header don't match data in the chunk table";
                    //}
                }

                ct.fileOffset += sizeof(ch);
                ct.size -= sizeof(ch);

                if (ct.data)
                {
                    ct.data = ((char*)ct.data) + sizeof(ch);
                }
            }

            if (ct.size < 0)
            {
                return "A negative-length chunk found in file";
            }
        }

        return 0;
    }


    const char* GetChunkTableEntries_0x744_0x745(IReader* pReader, std::vector<IChunkFile::ChunkDesc>& chunks)
    {
        ChunkListRef c(chunks);
        return GetChunkTableEntries_0x744_0x745_Tpl(pReader, c);
    }

    const char* GetChunkTableEntries_0x744_0x745(IReader* pReader, std::vector<IChunkFile::ChunkDesc*>& chunks)
    {
        ChunkPtrListRef c(chunks);
        return GetChunkTableEntries_0x744_0x745_Tpl(pReader, c);
    }


    const char* GetChunkTableEntries_0x746(IReader* pReader, std::vector<IChunkFile::ChunkDesc>& chunks)
    {
        ChunkListRef c(chunks);
        return GetChunkTableEntries_0x746_Tpl(pReader, c);
    }

    const char* GetChunkTableEntries_0x746(IReader* pReader, std::vector<IChunkFile::ChunkDesc*>& chunks)
    {
        ChunkPtrListRef c(chunks);
        return GetChunkTableEntries_0x746_Tpl(pReader, c);
    }


    const char* StripChunkHeaders_0x744_0x745(IReader* pReader, std::vector<IChunkFile::ChunkDesc>& chunks)
    {
        ChunkListRef c(chunks);
        return StripChunkHeaders_0x744_0x745_Tpl(pReader, c);
    }

    const char* StripChunkHeaders_0x744_0x745(IReader* pReader, std::vector<IChunkFile::ChunkDesc*>& chunks)
    {
        ChunkPtrListRef c(chunks);
        return StripChunkHeaders_0x744_0x745_Tpl(pReader, c);
    }
}  // namespace ChunkFile