/****************************************************************************
Copyright (c) 2011 Jirka Fajfr for cocos2d-x
Copyright (c) 2010 cocos2d-x.org

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#ifndef __CCPVRTEXTURE_H__
#define __CCPVRTEXTURE_H__

#include "CCStdC.h"
#include "CCGL.h"
#include "CCObject.h"
#include "CCArray.h"

NS_CC_BEGIN

//Forward definition for CCData
class CCData;

/**
 @brief Structure which can tell where mimap begins and how long is it
*/
struct CCPVRMipmap {
    unsigned char *address;
    unsigned int len;
};

/**
 @brief Detemine how many mipmaps can we have. 
 Its same as define but it respects namespaces
*/
enum {
    CC_PVRMIPMAP_MAX = 16,
};


/** CCTexturePVR
     
 Object that loads PVR images.

 Supported PVR formats:
    - RGBA8888
    - BGRA8888
    - RGBA4444
    - RGBA5551
    - RGB565
    - A8
    - I8
    - AI88
    - PVRTC 4BPP
    - PVRTC 2BPP
     
 Limitations:
    Pre-generated mipmaps, such as PVR textures with mipmap levels embedded in file,
    are only supported if all individual sprites are of _square_ size. 
    To use mipmaps with non-square textures, instead call CCTexture2D#generateMipmap on the sheet texture itself
    (and to save space, save the PVR sprite sheet without mip maps included).
*/
class CCTexturePVR : public CCObject
{
public:

    CCTexturePVR();
    virtual ~CCTexturePVR();

    /** initializes a CCTexturePVR with a path */
    bool initWithContentsOfFile(const char* path);

    /** creates and initializes a CCTexturePVR with a path */
    static CCTexturePVR * pvrTextureWithContentsOfFile(const char* path);

    CC_PROPERTY_READONLY(GLuint, m_uName, Name)
    CC_PROPERTY_READONLY(unsigned int, m_uWidth, Width)
    CC_PROPERTY_READONLY(unsigned int, m_uHeight, Height)
    CC_PROPERTY_READONLY(CCTexture2DPixelFormat, m_eFormat, Format)
    CC_PROPERTY_READONLY(bool, m_bHasAlpha, HasAlpha)

    // cocos2d integration
    CC_PROPERTY(bool, m_bRetainName, RetainName);

protected:

    /*
        Unpacks data (data of pvr texture file) and determine 
        how many mipmaps it uses (m_uNumberOfMipmaps). Adresses
        of mimaps (m_asMipmaps). And basic data like size, format
        and alpha presence
    */
    bool unpackPVRData(unsigned char* data, unsigned int len);

    /*
        Binds all mipmaps to the GL state machine as separate
        textures
    */
    bool createGLTexture();

    /*
        Index to the tableFormats array. Which tells us what exact 
        format is file which initializes this object. 
    */
    unsigned int m_uTableFormatIndex;

    /*
        How many mipmaps do we have. It must be at least one
        when proper initialization finishes
    */
    CC_SYNTHESIZE_READONLY(unsigned int, m_uNumberOfMipmaps, NumberOfMipmaps);

    /*
        Makrs for mipmaps. Each entry contains position in file
        and lenght of data which represents one mipmap.
    */
    struct CCPVRMipmap m_asMipmaps[CC_PVRMIPMAP_MAX];
};

NS_CC_END


#endif //__CCPVRTEXTURE_H__