ByteImage.h

Go to the documentation of this file.

// ****************************************************************************
// This file is part of the Integrating Vision Toolkit (IVT).
//
// The IVT is maintained by the Karlsruhe Institute of Technology (KIT)
// (www.kit.edu) in cooperation with the company Keyetech (www.keyetech.de).
//
// Copyright (C) 2014 Karlsruhe Institute of Technology (KIT).
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the KIT nor the names of its contributors may be
//    used to endorse or promote products derived from this software
//    without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE KIT AND CONTRIBUTORS “AS IS” AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE KIT OR CONTRIBUTORS BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ****************************************************************************
// ****************************************************************************
// Filename:  ByteImage.h
// Author:    Pedram Azad
// Date:      2004
// ****************************************************************************
// Changes:   24.07.2008, Miguel Bernal Marin
//            * Added methods LoadFromFilePNM and SaveToFilePNM
// ****************************************************************************
#ifndef __BYTE_IMAGE_H__
#define __BYTE_IMAGE_H__



// ****************************************************************************
// CByteImage
// ****************************************************************************

class CByteImage
{
public:
        enum ImageType
        {
                eGrayScale,
                eRGB24,
                eRGB24Split
        };

        
        CByteImage();
        
        CByteImage(int nImageWidth, int nImageHeight, ImageType imageType, bool bHeaderOnly = false);
        
        CByteImage(const CByteImage *pImage, bool bHeaderOnly = false);

        CByteImage(const CByteImage &image, bool bHeaderOnly = false);
        
        ~CByteImage();
        

        // public methods

        void Set(int nImageWidth, int nImageHeight, ImageType imageType, bool bHeaderOnly = false);

        bool IsCompatible(const CByteImage *pImage) const;
        
        bool LoadFromFile(const char *pFileName);

        bool SaveToFile(const char *pFileName) const;



private:
        // private structs
        struct myBITMAPFILEHEADER
        { 
                unsigned short bfType;
                unsigned int bfSize;
                unsigned short bfReserved1;
                unsigned short bfReserved2;
                unsigned int bfOffBits;
        };
        
        struct myBITMAPINFOHEADER
        {
                unsigned int biSize;
                unsigned int biWidth;
                int biHeight;
                unsigned short biPlanes;
                unsigned short biBitCount;
                unsigned int biCompression;
                unsigned int biSizeImage;
                unsigned int biXPelsPerMeter;
                unsigned int biYPelsPerMeter;
                unsigned int biClrUsed;
                unsigned int biClrImportant;
        };
        
        // private methods
        void FreeMemory();
        
        bool LoadFromFilePNM(const char *pFileName);
        bool SaveToFilePNM(const char *pFileName) const;
        
        bool LoadFromFileBMP(const char *pFileName);
        bool SaveToFileBMP(const char *pFileName) const;


public:
        // public attributes - not clean OOP design but easy access

        int width;

        int height;

        int bytesPerPixel;

        unsigned char *pixels;
 
        ImageType type;

        bool m_bOwnMemory;
};



#endif /* __BYTE_IMAGE_H__ */