RIFF.h

/***************************************************************************
 *                                                                         *
 *   libgig - C++ cross-platform Gigasampler format file access library    *
 *                                                                         *
 *   Copyright (C) 2003-2025 by Christian Schoenebeck                      *
 *                              <cuse@users.sourceforge.net>               *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __RIFF_H__
#define __RIFF_H__

#if __cplusplus < 201103L
# warning C++11 or higher required for libgig
#endif

#include <string>
#include <list>
#include <map>
#include <set>
#include <vector>
#include <iostream>
#include <stdarg.h>
#include <thread>
#include <mutex>
#include <stdio.h>

#include "sysdef.h"

#if WORDS_BIGENDIAN
# define CHUNK_ID_RIFF  0x52494646
# define CHUNK_ID_RIFX  0x52494658
# define CHUNK_ID_LIST  0x4C495354

# define LIST_TYPE_INFO 0x494E464F
# define CHUNK_ID_ICMT  0x49434D54
# define CHUNK_ID_ICOP  0x49434F50
# define CHUNK_ID_ICRD  0x49435244
# define CHUNK_ID_IENG  0x49454E47
# define CHUNK_ID_INAM  0x494E414D
# define CHUNK_ID_IPRD  0x49505244
# define CHUNK_ID_ISFT  0x49534654

# define CHUNK_ID_SMPL  0x736D706C

#else  // little endian
# define CHUNK_ID_RIFF  0x46464952
# define CHUNK_ID_RIFX  0x58464952
# define CHUNK_ID_LIST  0x5453494C

# define LIST_TYPE_INFO 0x4F464E49
# define CHUNK_ID_ICMT  0x544D4349
# define CHUNK_ID_ICOP  0x504F4349
# define CHUNK_ID_ICRD  0x44524349
# define CHUNK_ID_IENG  0x474E4549
# define CHUNK_ID_INAM  0x4D414E49
# define CHUNK_ID_IPRD  0x44525049
# define CHUNK_ID_ISFT  0x54465349

# define CHUNK_ID_SMPL  0x6C706D73

#endif // WORDS_BIGENDIAN

#define CHUNK_HEADER_SIZE(fileOffsetSize)   (4 + fileOffsetSize)
#define LIST_HEADER_SIZE(fileOffsetSize)    (8 + fileOffsetSize)
#define RIFF_HEADER_SIZE(fileOffsetSize)    (8 + fileOffsetSize)

namespace RIFF {

    /* just symbol prototyping */
    class Chunk;
    class List;
    class File;

    typedef std::string String;

    typedef uint64_t file_offset_t;

    enum stream_mode_t {
        stream_mode_read       = 0,
        stream_mode_read_write = 1,
        stream_mode_closed     = 2
    };

    enum stream_state_t {
        stream_ready       = 0,
        stream_end_reached = 1,
        stream_closed      = 2
    };

    enum stream_whence_t {
        stream_start    = 0,
        stream_curpos   = 1,
        stream_backward = 2,
        stream_end      = 3
    };

    enum endian_t {
        endian_little = 0,
        endian_big    = 1,
        endian_native = 2
    };

    enum layout_t {
        layout_standard = 0, 
        layout_flat     = 1  
    };

    enum offset_size_t {
        offset_size_auto  = 0, 
        offset_size_32bit = 4, 
        offset_size_64bit = 8  
    };

    struct progress_t {
        void (*callback)(progress_t*); 
        float factor;                  
        void* custom;                  
        const char* activity;          
        float __range_min;             
        float __range_max;             
        void* __private;               
        progress_t();
        virtual ~progress_t();
        std::vector<progress_t> subdivide(int iSubtasks) const;
        std::vector<progress_t> subdivide(std::vector<float> vSubTaskPortions) const;
    };

    class Chunk {
        public:
            Chunk(File* pFile, file_offset_t StartPos, List* Parent);
            String         GetChunkIDString() const;
            uint32_t       GetChunkID() const { return ChunkID; }       
            File*          GetFile() const    { return pFile;   }       
            List*          GetParent() const  { return pParent; }       
            file_offset_t  GetSize() const { return ullCurrentChunkSize; } 
            file_offset_t  GetNewSize() const { return ullNewChunkSize; } 
            file_offset_t  GetPos() const;
            file_offset_t  GetFilePos() const;
            file_offset_t  SetPos(file_offset_t Where, stream_whence_t Whence = stream_start);
            file_offset_t  RemainingBytes() const;
            stream_state_t GetState() const;
            file_offset_t  Read(void* pData, file_offset_t WordCount, file_offset_t WordSize);
            file_offset_t  ReadInt8(int8_t* pData,     file_offset_t WordCount = 1);
            file_offset_t  ReadUint8(uint8_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  ReadInt16(int16_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  ReadUint16(uint16_t* pData, file_offset_t WordCount = 1);
            file_offset_t  ReadInt32(int32_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  ReadUint32(uint32_t* pData, file_offset_t WordCount = 1);
            int8_t         ReadInt8();
            uint8_t        ReadUint8();
            int16_t        ReadInt16();
            uint16_t       ReadUint16();
            int32_t        ReadInt32();
            uint32_t       ReadUint32();
            void           ReadString(String& s, int size);
            file_offset_t  Write(void* pData, file_offset_t WordCount, file_offset_t WordSize);
            file_offset_t  WriteInt8(int8_t* pData,     file_offset_t WordCount = 1);
            file_offset_t  WriteUint8(uint8_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  WriteInt16(int16_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  WriteUint16(uint16_t* pData, file_offset_t WordCount = 1);
            file_offset_t  WriteInt32(int32_t* pData,   file_offset_t WordCount = 1);
            file_offset_t  WriteUint32(uint32_t* pData, file_offset_t WordCount = 1);
            void*          LoadChunkData();
            void           ReleaseChunkData();
            void           Resize(file_offset_t NewSize);
            virtual ~Chunk();
        protected:
            uint32_t      ChunkID;
            file_offset_t ullCurrentChunkSize;          /* in bytes */
            file_offset_t ullNewChunkSize;                      /* in bytes (if chunk was scheduled to be resized) */
            List*         pParent;
            File*         pFile;
            file_offset_t ullStartPos;  /* actual position in file where chunk data (without header) starts */
            uint8_t*      pChunkData;
            file_offset_t ullChunkDataSize;
            struct ChunkPos { /* current read/write position as # of bytes from ulStartPos */
                file_offset_t ullPos; /* used if File::IsIOPerThread() is false (default) */
                mutable std::map<std::thread::id,file_offset_t> byThread; /* used if File::IsIOPerThread() is true */
                mutable std::mutex mutex; /* for protecting concurrent changes on byThread map itself */
            } chunkPos;

            Chunk(File* pFile);
            Chunk(File* pFile, List* pParent, uint32_t uiChunkID, file_offset_t ullBodySize);
            void ReadHeader(file_offset_t filePos);
            void WriteHeader(file_offset_t filePos);
            file_offset_t ReadSceptical(void* pData, file_offset_t WordCount, file_offset_t WordSize);
            inline static String convertToString(uint32_t word) {
                return String((const char*)&word, sizeof(word));
            }
            virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
            virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
            virtual void __resetPos(); 

            friend class List;
        private:
            file_offset_t& GetPosUnsafeRef();
    };

    class List : public Chunk {
        public:
            List(File* pFile, file_offset_t StartPos, List* Parent);
            String       GetListTypeString() const;
            uint32_t     GetListType() const { return ListType; } 
            Chunk*       GetSubChunkAt(size_t pos);
            Chunk*       GetSubChunk(uint32_t ChunkID);
            List*        GetSubListAt(size_t pos);
            List*        GetSubList(uint32_t ListType);
            Chunk*       GetFirstSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead.");
            Chunk*       GetNextSubChunk() LIBGIG_DEPRECATED_API("Use GetSubChunkAt() instead.");
            List*        GetFirstSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead.");
            List*        GetNextSubList() LIBGIG_DEPRECATED_API("Use GetSubListAt() instead.");
            size_t       CountSubChunks();
            size_t       CountSubChunks(uint32_t ChunkID);
            size_t       CountSubLists();
            size_t       CountSubLists(uint32_t ListType);
            Chunk*       AddSubChunk(uint32_t uiChunkID, file_offset_t ullBodySize);
            List*        AddSubList(uint32_t uiListType);
            void         DeleteSubChunk(Chunk* pSubChunk);
            void         MoveSubChunk(Chunk* pSrc, Chunk* pDst); // read API doc comments !!!
            void         MoveSubChunk(Chunk* pSrc, List* pNewParent);
            virtual ~List();
        protected:
            typedef std::map<uint32_t, RIFF::Chunk*>  ChunkMap;
            typedef std::vector<Chunk*>               ChunkList;
            typedef std::set<Chunk*>                  ChunkSet;

            uint32_t   ListType;
            ChunkList* pSubChunks;
            ChunkMap*  pSubChunksMap;
            ChunkList::iterator ChunksIterator;
            ChunkList::iterator ListIterator;

            List(File* pFile);
            List(File* pFile, List* pParent, uint32_t uiListID);
            void ReadHeader(file_offset_t filePos);
            void WriteHeader(file_offset_t filePos);
            void LoadSubChunks(progress_t* pProgress = NULL);
            void LoadSubChunksRecursively(progress_t* pProgress = NULL);
            virtual file_offset_t RequiredPhysicalSize(int fileOffsetSize);
            virtual file_offset_t WriteChunk(file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, progress_t* pProgress = NULL);
            virtual void __resetPos(); 
            void DeleteChunkList();
    };

    class File : public List {
        public:
            #if POSIX
            typedef int Handle;
            #elif defined(WIN32)
            typedef HANDLE Handle;
            #else
            typedef FILE* Handle;
            #endif

            File(uint32_t FileType);
            File(const String& path);
            File(const String& path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize = offset_size_auto);
            stream_mode_t GetMode() const;
            bool          SetMode(stream_mode_t NewMode);
            void SetByteOrder(endian_t Endian);
            String GetFileName() const;
            void SetFileName(const String& path);
            Handle FileHandle() const;
            bool IsNew() const;
            layout_t GetLayout() const;
            file_offset_t GetCurrentFileSize() const;
            file_offset_t GetRequiredFileSize();
            file_offset_t GetRequiredFileSize(offset_size_t fileOffsetSize);
            int GetFileOffsetSize() const;
            int GetRequiredFileOffsetSize();
            bool IsIOPerThread() const;
            void SetIOPerThread(bool enable);
            size_t totalDataChunkCount() const;
            size_t totalListChunkCount() const;
            size_t totalChunkCount() const;

            virtual void Save(progress_t* pProgress = NULL);
            virtual void Save(const String& path, progress_t* pProgress = NULL);
            virtual ~File();
        protected:
            struct HandlePair {
                Handle hRead;  
                Handle hWrite; 
                stream_mode_t Mode; 
            };
            struct IO : HandlePair {
                bool isPerThread; 
                mutable std::map<std::thread::id,HandlePair> byThread; 
                mutable std::mutex mutex; 
            } io;
            String Filename;
            bool   bEndianNative;
            bool   bIsNewFile;
            layout_t Layout; 
            offset_size_t FileOffsetPreference;
            int FileOffsetSize; 
            size_t nDataChunkCount;
            size_t nListChunkCount;

            Handle FileWriteHandle() const;
            HandlePair FileHandlePair() const;

            friend class Chunk;
            friend class List;
        private:
            void __openExistingFile(const String& path, uint32_t* FileType = NULL);
            void ResizeFile(file_offset_t ullNewSize);
            #if POSIX
            file_offset_t __GetFileSize(int hFile) const;
            #elif defined(WIN32)
            file_offset_t __GetFileSize(HANDLE hFile) const;
            #else
            file_offset_t __GetFileSize(FILE* hFile) const;
            #endif
            int FileOffsetSizeFor(file_offset_t fileSize) const;
            void Cleanup();
            HandlePair& FileHandlePairUnsafeRef();
            bool SetModeInternal(stream_mode_t NewMode, bool* pResetPos);
    };

    class Exception {
        public:
            String Message;

            Exception(String format, ...);
            Exception(String format, va_list arg);
            void PrintMessage() const;
            virtual ~Exception();

        protected:
            Exception();
            static String assemble(String format, va_list arg);
    };

    String libraryName();
    String libraryVersion();

} // namespace RIFF
#endif // __RIFF_H__