IImage.h

Go to the documentation of this file.

/********************************************************************
 *
 *  Project     Artec 3D Scanning SDK
 *
 *  Purpose:    Basic image 
 *
 *  Copyright:  Artec Group
 *
 ********************************************************************/

#ifndef _IIMAGE_H_
#define _IIMAGE_H_

#include <artec/sdk/base/BaseSdkDefines.h>
#include <artec/sdk/base/Errors.h>
#include <artec/sdk/base/IRef.h>
#include <artec/sdk/base/IBlob.h>

namespace artec { namespace sdk { namespace base
{

class IImage;
struct ImageHeader;

enum PixelFormat
{
    PixelFormat_Unknown,

    /// 8-bit format
    PixelFormat_Mono,

    PixelFormat_BGR,            //0xRRGGBB
    PixelFormat_BGRA,           //0xAAGGBBRR

    PixelFormat_RG,             //0xGGRR
    PixelFormat_RGB,            //0xBBGGRR
    PixelFormat_RGBA,           //0xAABBGGRR

    /// unsigned 16-bit format
    PixelFormat_Mono_USHORT,
    PixelFormat_RG_USHORT,
    PixelFormat_RGB_USHORT,
    PixelFormat_RGBA_USHORT,

    /// signed int 32-bit format
    PixelFormat_Mono_SINT,
    PixelFormat_RG_SINT,
    PixelFormat_RGB_SINT,
    PixelFormat_RGBA_SINT,

    /// float 32-bit format
    PixelFormat_Mono_FLOAT,
    PixelFormat_RG_FLOAT,
    PixelFormat_RGB_FLOAT,
    PixelFormat_RGBA_FLOAT,

    /// YUY formats 
    PixelFormat_YUY,

    /// bayer mask formats 
    PixelFormat_RawRGGB,
    PixelFormat_RawGRBG,
    PixelFormat_RawGBRG,
    PixelFormat_RawBGGR,

    PixelFormat_ForceDword = 0x7fffffff /* force 32-bit size enum */
};

extern "C"
{

/** Create image
*
* @param width, height 
*  Image width (x) and height (y)
* @param pixelFormat 
*  Image format. Value from PixelFormat enum.
* @param align 
*  Length of 1 image line will be multiply of align value.
*  Calculated based on width and number of channels
* @param initialData
*  If present than no new data is created and image will
*  store the reference to initialData
*
* @return 
*  new Image or NULL if creation unsuccessful.
*/
ErrorCode ABASESDK_LINK_SPEC
    createImage(IImage** image, int width, int height, PixelFormat pixelFormat, int align = 1, IBlob* initialData = 0);

/** Create image
*
* @param image created image
* @param header size, pitch and pixelFormat of new image
* @param initialData
*  If present than no new data is created and image will
*  store the reference to initialData
* @return error code
*/
ErrorCode ABASESDK_LINK_SPEC
    createImageByHeader(IImage** image, const ImageHeader& header, IBlob* initialData = 0);

}


struct ImageHeader
{
    int         width;
    int         height;
    int         pitch;
    int         nChannels;
    PixelFormat pixelFormat;
};

enum Mirror 
{ 
    Mirror_X, 
    Mirror_Y, 
    Mirror_ForceDword = 0x7fffffff /* force 32-bit size enum */
};

class IImage : public IRef
{
public:
    // Return image width
    virtual int getWidth() const = 0;
    // Return image height
    virtual int getHeight() const = 0;
    // Return image pitch
    virtual int getPitch() const = 0;
    // Return image number of channels
    virtual int getChannels() const = 0;
    // Return image pixel format
    virtual PixelFormat getPixelFormat() const = 0;
    // Return image header
    virtual ImageHeader getHeader() const = 0;
    
    /** Return size of image
    * 
    * @return 
    *  Data size in bytes
    */
    virtual int getSize() const = 0;

    /** Image bytes 
    * 
    * @return 
    *  Pointer on image data
    */
    virtual void* getPointer() = 0;

    /** Image bytes 
    * 
    * @return 
    *  const pointer on image data
    */
    virtual const void* getPointer() const = 0;

    /** Clone image
    *
    * @param dst new image that will contain copy of source image
    * @return error code
    */
    virtual ErrorCode clone(IImage** dst) const = 0;

    /** Fast in-place mirror operation
    * 
    * @param direction axis relative to which will be made mirroring
    * @return 
    *  ErrorCode_OperationInvalid if source image is not in Mono, BGR, RGB, BGRX or RGBX format.
    */
    virtual ErrorCode mirror(Mirror direction) = 0;

    /** Fast in-place channel swap
    *  Convert BRG/BGRX image to RGB/RGBX
    * @return 
    *  ErrorCode_OperationInvalid if source image is not in BGR or BGRX format.
    */
    virtual ErrorCode bgr2rgb() = 0;
    
    /** Fast in-place channel swap
    *  Convert RGB/RGBX image to BGR/BGRX
    * @return 
    *  ErrorCode_OperationInvalid if source image is not in RGB or RGBX format.
    */
    virtual ErrorCode rgb2bgr() = 0;
};

} } } // namespace artec::sdk::base

#endif // _IIMAGE_H_