nsbtxfile.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_NSBTXFILE_H
#define AURORA_NSBTXFILE_H

#include <vector>

#include "src/common/types.h"
#include "src/common/scopedptr.h"
#include "src/common/ustring.h"

#include "src/aurora/types.h"
#include "src/aurora/archive.h"
#include "src/aurora/nitrofile.h"

namespace Common {
    class WriteStream;
}

namespace Aurora {

class NSBTXFile : public Archive, public NitroFile {
public:
    NSBTXFile(Common::SeekableReadStream *nsbtx);
    ~NSBTXFile();

    const ResourceList &getResources() const;

    uint32 getResourceSize(uint32 index) const;

    Common::SeekableReadStream *getResource(uint32 index, bool tryNoCopy = false) const;

private:
    enum Format {
        kFormatNoTexture     = 0, 
        kFormatA3I5          = 1, 
        kFormat2bpp          = 2, 
        kFormat4bpp          = 3, 
        kFormat8bpp          = 4, 
        kFormat4x4Compressed = 5, 
        kFormatA5I3          = 6, 
        kFormat16bpp         = 7  
    };

    enum Transform {
        kTransformNone     = 0, 
        kTransformTexCoord = 1, 
        kTransformNormal   = 2, 
        kTransformVertex   = 3  
    };

    struct Texture {
        Common::UString name;
        uint32 offset;

        Format format;

        uint16 width;
        uint16 height;

        bool wrapX; 
        bool wrapY; 
        bool flipX; 
        bool flipY; 
        bool alpha; 

        Transform coordTransform;
    };

    struct Palette {
        Common::UString name;
        uint32 offset;
    };

    struct ReadContext {
        const Texture *texture;

        Common::ScopedArray<const byte> palette;

        Common::SeekableSubReadStreamEndian *nsbtx;
        Common::WriteStream *stream;

        ReadContext(Common::SeekableSubReadStreamEndian &n, const Texture &t, Common::WriteStream &s);
        ~ReadContext();
    };

    typedef std::vector<Texture> Textures;
    typedef std::vector<Palette> Palettes;


    Common::ScopedPtr<Common::SeekableSubReadStreamEndian> _nsbtx;

    ResourceList _resources;

    uint32 _textureOffset;

    uint32 _textureInfoOffset;
    uint32 _paletteInfoOffset;

    uint32 _textureDataOffset;
    uint32 _paletteDataOffset;

    Textures _textures;
    Palettes _palettes;


    void load(Common::SeekableSubReadStreamEndian &nsbtx);

    void readHeader    (Common::SeekableSubReadStreamEndian &nsbtx);
    void readFileHeader(Common::SeekableSubReadStreamEndian &nsbtx);
    void readInfoHeader(Common::SeekableSubReadStreamEndian &nsbtx);
    void readTextures  (Common::SeekableSubReadStreamEndian &nsbtx);
    void readPalettes  (Common::SeekableSubReadStreamEndian &nsbtx);

    void createResourceList();

    const Palette *findPalette(const Texture &texture) const;
    void getPalette(ReadContext &ctx) const;

    static uint32 getITEXSize(const Texture &texture);

    static void writeITEXHeader(const ReadContext &ctx);
    static void writePixel(const ReadContext &ctx, byte r, byte g, byte b, byte a);

    static void getTexture     (const ReadContext &ctx);
    static void getTexture2bpp (const ReadContext &ctx);
    static void getTexture4bpp (const ReadContext &ctx);
    static void getTexture8bpp (const ReadContext &ctx);
    static void getTexture16bpp(const ReadContext &ctx);
    static void getTextureA3I5 (const ReadContext &ctx);
    static void getTextureA5I3 (const ReadContext &ctx);
};

} // End of namespace Aurora

#endif // AURORA_NSBTXFILE_H