FasTC/Base/include/Image.h

/* FasTC
 * Copyright (c) 2012 University of North Carolina at Chapel Hill. All rights reserved.
 *
 * Permission to use, copy, modify, and distribute this software and its documentation for educational, 
 * research, and non-profit purposes, without fee, and without a written agreement is hereby granted, 
 * provided that the above copyright notice, this paragraph, and the following four paragraphs appear 
 * in all copies.
 *
 * Permission to incorporate this software into commercial products may be obtained by contacting the 
 * authors or the Office of Technology Development at the University of North Carolina at Chapel Hill <otd@unc.edu>.
 *
 * This software program and documentation are copyrighted by the University of North Carolina at Chapel Hill. 
 * The software program and documentation are supplied "as is," without any accompanying services from the 
 * University of North Carolina at Chapel Hill or the authors. The University of North Carolina at Chapel Hill 
 * and the authors do not warrant that the operation of the program will be uninterrupted or error-free. The 
 * end-user understands that the program was developed for research purposes and is advised not to rely 
 * exclusively on the program for any reason.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS BE LIABLE TO ANY PARTY FOR 
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE 
 * USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
 * AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING, 
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY 
 * STATUTORY WARRANTY OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY 
 * OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, 
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 * Please send all BUG REPORTS to <pavel@cs.unc.edu>.
 *
 * The authors may be contacted via:
 *
 * Pavel Krajcevski
 * Dept of Computer Science
 * 201 S Columbia St
 * Frederick P. Brooks, Jr. Computer Science Bldg
 * Chapel Hill, NC 27599-3175
 * USA
 * 
 * <http://gamma.cs.unc.edu/FasTC/>
 */

#ifndef __TEXCOMP_IMAGE_H__
#define __TEXCOMP_IMAGE_H__

#include "TexCompTypes.h"

class Image {

 public:
  Image(uint32 width, uint32 height,
        const uint32 *pixels,
        bool bBlockStreamOrder = false);
  Image(const Image &);
  Image &operator=(const Image &);
  virtual ~Image();

  virtual Image *Clone() const {
    return new Image(*this);
  };

  const uint8 *RawData() const { return m_Data; }

  uint32 GetWidth() const { return m_Width; }
  uint32 GetHeight() const { return m_Height; }

  void SetBlockStreamOrder(bool flag) {
    if(flag) {
      ConvertToBlockStreamOrder();
    } else {
      ConvertFromBlockStreamOrder();
    }
  }
  bool GetBlockStreamOrder() const { return m_bBlockStreamOrder; }

  double ComputePSNR(Image *other);

  virtual void ComputeRGBA() { }
  virtual const uint32 *GetRGBA() const {
    return reinterpret_cast<const uint32 *>(RawData());
  }

 private:
  uint32 m_Width;
  uint32 m_Height;

  bool m_bBlockStreamOrder;

 protected:
  uint8 *m_Data;

  void ConvertToBlockStreamOrder();
  void ConvertFromBlockStreamOrder();
};

#endif // __TEXCOMP_IMAGE_H__