decoder.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 GRAPHICS_IMAGES_DECODER_H
#define GRAPHICS_IMAGES_DECODER_H

#include <vector>

#include <boost/noncopyable.hpp>

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

#include "src/graphics/types.h"

#include "src/graphics/images/txi.h"

namespace Common {
    class SeekableReadStream;
    class UString;
}

namespace Graphics {

class ImageDecoder : boost::noncopyable {
public:
    struct MipMap {
        int    width;  
        int    height; 
        uint32 size;   

        Common::ScopedArray<byte> data; 

        const ImageDecoder *image; 

        MipMap(const ImageDecoder *i = 0);
        MipMap(const MipMap &mipMap, const ImageDecoder *i = 0);
        ~MipMap();

        void swap(MipMap &right);

        void getPixel(int x, int y, float &r, float &g, float &b, float &a) const;
        void getPixel(int n, float &r, float &g, float &b, float &a) const;

        void setPixel(int x, int y, float r, float g, float b, float a);
        void setPixel(int n, float r, float g, float b, float a);
    };

    ImageDecoder();
    ImageDecoder(const ImageDecoder &image);
    virtual ~ImageDecoder();

    ImageDecoder &operator=(const ImageDecoder &image);

    bool isCompressed() const;

    bool hasAlpha() const;

    PixelFormat    getFormat() const;
    PixelFormatRaw getFormatRaw() const;
    PixelDataType  getDataType() const;

    size_t getMipMapCount() const;
    size_t getLayerCount() const;

    bool isCubeMap() const;

    const MipMap &getMipMap(size_t mipMap, size_t layer = 0) const;

    void decompress();

    const TXI &getTXI() const;

    bool dumpTGA(const Common::UString &fileName) const;

protected:
    typedef Common::PtrVector<MipMap> MipMaps;

    bool _compressed;
    bool _hasAlpha;

    PixelFormat    _format;
    PixelFormatRaw _formatRaw;
    PixelDataType  _dataType;

    size_t _layerCount;
    bool _isCubeMap;

    MipMaps _mipMaps;

    TXI _txi;

    static void decompress(MipMap &out, const MipMap &in, PixelFormatRaw format);
};

} // End of namespace Graphics

#endif // GRAPHICS_IMAGES_DECODER_H