rifffile.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
/*
 * VGMTrans (c) 2002-2019
 * Licensed under the zlib license,
 * refer to the included VGMTrans_LICENSE.txt file
 */
#ifndef AUDIO_SOUNDFONT_RIFFFILE_H
#define AUDIO_SOUNDFONT_RIFFFILE_H

#include "common/scummsys.h"
#include "common/list.h"
#include "common/str.h"
#include "common/array.h"

// Chunk        - Riff format chunk
class Chunk {
public:
    char _id[4];     //  A chunk ID identifies the type of data within the chunk.
    uint32 _size;  //  The size of the chunk data in bytes, excluding any pad byte.
    uint8 *_data;  //  The actual data not including a possible pad byte to word align

public:
    Chunk(Common::String theId) : _data(NULL), _size(0) {
        assert(theId.size() == 4);
        memcpy(_id, theId.c_str(), 4);
    }

    virtual ~Chunk() {
        if (_data != NULL) {
            delete[] _data;
            _data = NULL;
        }
    }

    void SetData(const void *src, uint32 datasize);

    virtual uint32 GetSize();  //  Returns the size of the chunk in bytes, including any pad byte.
    virtual void Write(uint8 *buffer);

protected:
    static inline uint32 GetPaddedSize(uint32 originalSize) { return originalSize + (originalSize % 2); }
};

// ListTypeChunk    - Riff chunk type where the first 4 data bytes are a sig
//                    and the rest of the data is a collection of child chunks
class ListTypeChunk : public Chunk {
public:
    char _type[4];  // 4 byte sig that begins the data field, "LIST" or "sfbk" for ex
    Common::List<Chunk *> _childChunks;

public:
    ListTypeChunk(Common::String theId, Common::String theType) : Chunk(theId) {
        assert(theType.size() == 4);
        memcpy(_type, theType.c_str(), 4);
    }

    virtual ~ListTypeChunk() {
        _childChunks.erase(_childChunks.begin(), _childChunks.end());
    }

    Chunk *AddChildChunk(Chunk *ck);

    virtual uint32 GetSize();  //  Returns the size of the chunk in bytes, including any pad byte.
    virtual void Write(uint8 *buffer);
};

// RIFFChunk
class RIFFChunk : public ListTypeChunk {
public:
    RIFFChunk(Common::String form) : ListTypeChunk("RIFF", form) {}
};

// LISTChunk
class LISTChunk : public ListTypeChunk {
public:
    LISTChunk(Common::String theType) : ListTypeChunk("LIST", theType) {}
};

// RiffFile     -
class RiffFile : public RIFFChunk {
public:
    RiffFile(const Common::String &file_name, const Common::String &form);

    static void WriteLIST(Common::Array<uint8> &buf, uint32 listName, uint32 listSize) {
        //TODO
//        PushTypeOnVectBE<uint32>(buf, 0x4C495354);  // write "LIST"
//        PushTypeOnVect<uint32>(buf, listSize);
//        PushTypeOnVectBE<uint32>(buf, listName);
    }

    // Adds a null byte and ensures 16 bit alignment of a text string
    static void AlignName(Common::String &name) {
        name += (char) 0x00;
        if (name.size() % 2)     // if the size of the name string is odd
            name += (char) 0x00;  // add another null byte
    }

protected:
    Common::String _name;
};

#endif // AUDIO_SOUNDFONT_RIFFFILE_H