opengl_es_examples/Utilities/PVRTexLib/CPVRTextureHeader.h

/******************************************************************************

 @File         CPVRTextureHeader.h

 @Title        Console Log

 @Version       @Version      

 @Copyright    Copyright (C)  Imagination Technologies Limited.

 @Platform     ANSI

 @Description  Class to represent header information of a pvr texture file.
               Typically associated with a CPVRTextureData instance or part of a
               CPVRTexture instance

******************************************************************************/

#ifndef CPVRTEXTUREHEADER_H
#define CPVRTEXTUREHEADER_H

#include <stdio.h>
#include "PVRTexLibGlobals.h"
struct PVR_Texture_Header;

namespace pvrtexlib
{
	
#ifdef __APPLE__
	/* The classes below are exported */
#pragma GCC visibility push(default)
#endif

class PVR_DLL PVRTextureUtilities;

class PVR_DLL CPVRTextureHeader
{
public:

	/*******************************************************************************
	* Constructor
	* Description		: Blank constructor that allows the creation of a 
	*						valid but blank CPVRHeader
	*******************************************************************************/
	CPVRTextureHeader();


	/*******************************************************************************
	* Constructor
	* In
	:	u32Width		:	width of topmost image in pixels
	:	u32Height		:	height of topmost image
	:	u32MipMapCount	:	count of MIP-map levels
	:	u32NumSurfaces	:	number of surfaces present in texture
	:	bBorder			:	does the texture have an added border (se PVRTC compression documentation)
	:	bTwiddled		:	is the texture twiddled (use morton order)
	:	bCubeMap		:	is the texture a cube map
	:	bVolume			:	is the texture a volume texture (little support right now)
	:	bFalseMips		:	are false-coloured MIP-map levels encoded
	:	ePixelType		:	which pixel format is used for the data
	:	fNormalMap		:	multiplier when used in normal map creation for this texture.
	:						0.0f implies that this is not a normal map texture
	* Description		: Manual constructor that allows the creation of a CPVRHeader
	*******************************************************************************/
	CPVRTextureHeader(
		const unsigned int u32Width,
		const unsigned int	u32Height,
		const unsigned int	u32MipMapCount,
		const unsigned int	u32NumSurfaces,
		const bool			bBorder,
		const bool			bTwiddled,
		const bool			bCubeMap,
		const bool			bVolume,
		const bool			bFalseMips,
		const bool			bAlpha,
		const bool			bFlipped,
		const PixelType		ePixelType,
		const float			fNormalMap);


		/*******************************************************************************
	* Constructor
	* In
	:	u32Width		:	width of topmost image in pixels
	:	u32Height		:	height of topmost image
	:	u32MipMapCount	:	count of MIP-map levels
	:	u32NumSurfaces	:	number of surfaces present in texture
	:	bBorder			:	does the texture have an added border (se PVRTC compression documentation)
	:	bTwiddled		:	is the texture twiddled (use morton order)
	:	bCubeMap		:	is the texture a cube map
	:	bVolume			:	is the texture a volume texture (little support right now)
	:	bFalseMips		:	are false-coloured MIP-map levels encoded
	:	ePixelType		:	which pixel format is used for the data
	:	fNormalMap		:	multiplier when used in normal map creation for this texture.
	:						0.0f implies that this is not a normal map texture
	* Description		: Manual constructor that allows the creation of a CPVRHeader, 
	:					: similar to previous constructor but sets default values for
	:					: tidier code!
	*******************************************************************************/
	CPVRTextureHeader(
		const unsigned int  u32Width,
		const unsigned int	u32Height,
		const unsigned int	u32MipMapCount=0,
		const unsigned int	u32NumSurfaces=1,
		const PixelType		ePixelType=DX10_R8G8B8A8_UNORM,
		const float			fNormalMap=0.0f,
		const bool			bBorder=false,
		const bool			bTwiddled=false,
		const bool			bCubeMap=false,
		const bool			bVolume=false,
		const bool			bFalseMips=false,
		const bool			bAlpha=false,
		const bool			bFlipped=false);
	/*******************************************************************************
	* Constructor
	* In
	:	fFile			:	open FILE pointer to PVR header data (beginning of a .pvr file)
	* Description		:	Reads a header from the passed FILE pointer leaving this
	*						at the beginning of any data following the header.
	*******************************************************************************/
	CPVRTextureHeader(FILE *const fFile);
	/*******************************************************************************
	* Constructor
	* In
	:	fFile			:	pointer to PVR header data (beginning of a .pvr file)
	* Description		:	Reads a header from the passed pointer.
	*******************************************************************************/
	CPVRTextureHeader(const uint8* const pPVRData);

	/*******************************************************************************
	* Accessor Methods for basic properties
	*******************************************************************************/
	unsigned int	getWidth() const;
	void			setWidth(unsigned int u32Width);
	unsigned int	getHeight() const;
	void			setHeight(unsigned int u32Height);
	unsigned int	getMipWidth(const unsigned int u32MIPLevel) const;
	unsigned int	getMipHeight(const unsigned int u32MIPLevel) const;
	void			getDimensions(unsigned int& width, unsigned int& height) const;
	void			setDimensions(const unsigned int u32Width, const unsigned int u32Height);
	unsigned int	getMipMapCount() const;
	void			setMipMapCount(unsigned int u32MipMapCount);
	PixelType		getPixelType() const;
	void			setPixelType(const PixelType ePixelType);
	unsigned int	getNumSurfaces() const;
	void			setNumSurfaces(unsigned int u32NumSurfaces);

	/*******************************************************************************
	* sets to the standard pixel type for the passed prcision mode
	*******************************************************************************/
	void			setPixelType(const E_PRECMODE ePrecMode);

	/*******************************************************************************
	* Accessor Methods for preprocessing properties etc.
	*******************************************************************************/
	bool			isBordered() const;
	void			setBorder(bool bBorder);
	bool			isTwiddled() const;
	void			setTwiddled(bool bTwiddled);
	bool			isCubeMap() const;
	void			setCubeMap(bool bCubeMap);
	bool			isVolume() const;
	void			setVolume(const bool bVolume);
	float			getNormalMap() const;
	void			setNormalMap(const float fNormalMap);
	bool			isNormalMap() const;
	bool			hasMips() const;
	bool			hasFalseMips() const;
	void			setFalseMips(const bool bFalseMips);
	bool			hasAlpha() const;
	void			setAlpha(const bool bAlpha);
	void			setFlipped(const bool bFlipped);
	bool			isFlipped() const;


	/*******************************************************************************
	* Other Accessor Methods
	*******************************************************************************/
	unsigned int	getOriginalVersionNumber();	// only relevant for files loaded from disk
	unsigned int	getCurrentVersionNumber();
	/*******************************************************************************
	* Function Name  : getSurfaceSize
	* Returns        : size of an individual surface (including MIP-map levels)
	*					described by the header in bytes
	*******************************************************************************/
	size_t			getSurfaceSize() const;
	/*******************************************************************************
	* Function Name  : getMIPSize
	* Returns        : size of an individual surface (top level MIP-map only)
	*					described by the header in bytes
	*******************************************************************************/
	size_t			getMIPSize(unsigned int mipNumber) const;	
	/*******************************************************************************
	* Function Name  : getMIPSizeInPixels
	* Returns        : size of an individual surface (top level MIP-map only)
	*					described by the header in bytes
	*******************************************************************************/
	size_t			getMIPSizeInPixels(unsigned int mipNumber) const;
	/*******************************************************************************
	* Function Name  : getSurfaceSizeInPixels
	* Returns        : the number of pixels described by a surface in this texture
	*******************************************************************************/
	unsigned int	getSurfaceSizeInPixels() const;
	/*******************************************************************************
	* Function Name  : getTotalTextureSize
	* Returns        : sum of the size of all individual surfaces (including MIP-map
	*					levels) described by the header
	*******************************************************************************/
	size_t			getTotalTextureSize() const;
	/*******************************************************************************
	* Function Name  : getFileHeaderSize
	* Returns        : returns file size from original header version
	*******************************************************************************/
	size_t			getFileHeaderSize();
	/*******************************************************************************
	* Function Name  : getPrecMode
	* Returns        : returns the precision mode of the pixel type of this header
	*******************************************************************************/
	E_PRECMODE		getPrecMode() const;
	/*******************************************************************************
	* Function Name  : isStandardFormat
	* Returns        : returns the precision mode of the pixel type of this header
	*******************************************************************************/
	bool			isStandardPixelType() const;
	/*******************************************************************************
	* Function Name  : getBitsPerPixel
	* Returns        : returns the number of bits of data per pixel required by the
	*					pixel type of this header
	*******************************************************************************/
	unsigned int	getBitsPerPixel() const;
	/*******************************************************************************
	* Function Name  : hasSurfaceCompatibleWith
	* Returns        : returns whether this header describes a texture with surfaces
						that are compatible for appending etc with the ones described
						in the passed header.
	*******************************************************************************/
	bool			hasSurfaceCompatibleWith(const CPVRTextureHeader & sHeader) const;
	/*******************************************************************************
	* Function Name  : writeToFile
	* Returns        : writes this pvr header to the FILE* passed leaving the FILE
						pointer at the end of the header data. Returns the size 
						of data written
	*******************************************************************************/
	size_t			writeToFile(FILE* const fFile)const;
	/*******************************************************************************
	* Function Name  : writeToPointer
	* Returns        : writes this pvr header to the pointer passed. Returns the size
						of the data written
	*******************************************************************************/
	size_t			writeToPointer(uint8 * const pPointer)const;
	/*******************************************************************************
	* Function Name  : writeToIncludeFile
	* Returns        :  writes this pvr header to the FILE* passed leaving the FILE
						pointer at the end of the header data. Writes this as the
						beginning of a c++ compatible header file. Returns the size 
						of data written
	*******************************************************************************/
	size_t			writeToIncludeFile(FILE* const fFile)const;

	/* static utility functions */

	/*******************************************************************************
	* Function Name  : getFileHeaderSize
	* Returns        : returns file size from passed header version (if possible)
	*					otherwise PVRTHROWs
	*******************************************************************************/
	static size_t			getFileHeaderSize(int u32HeaderVersion);

	const static unsigned int	u32CURRENT_VERSION	= 2;	// currentlt v2 of .pvr files is used

private:
	unsigned int				m_u32Height, m_u32Width, m_u32MipMapCount,m_u32NumSurfaces;
	unsigned int				m_u32OriginalVersionNumber;	// the file header version on the disk from which this class was constructed
	bool						m_bTwiddled, m_bCubeMap, m_bVolume, m_bFalseMips, m_bBorder, m_bAlpha, m_bFlipped;
	PixelType					m_ePixelType;
	float						m_fNormalMap;

	void InitBlank();
	void InitFromPointer(const uint8* const pData);

	void DoBitMasks(PVR_Texture_Header *phPVR, bool bAlpha) const;

};

#ifdef __APPLE__
#pragma GCC visibility pop
#endif
	
}

#endif // CPVRTEXTUREHEADER_H

/*****************************************************************************
 End of file (PVRTexture.h)
*****************************************************************************/