calyp/lib/PlaYUVerFrame.h

/*    This file is a part of PlaYUVer project
 *    Copyright (C) 2014-2018  by Joao Carreira   (jfmcarreira@gmail.com)
 *                                Luis Lucas      (luisfrlucas@gmail.com)
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License along
 *   with this program; if not, write to the Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/**
 * \file     PlaYUVerFrame.h
 * \ingroup	 PlaYUVerLibFrame
 * \brief    Video Frame handling
 */

#ifndef __PLAYUVERFRAME_H__
#define __PLAYUVERFRAME_H__

#include "PlaYUVerDefs.h"

namespace cv
{
class Mat;
}

struct PlaYUVerPixFmtDescriptor;
struct PlaYUVerFramePrivate;

#define CHROMASHIFT( SIZE, SHIFT ) UInt( -( ( -( Int( SIZE ) ) ) >> ( SHIFT ) ) )

/**
 * \class    PlaYUVerPixel
 * \ingroup	 PlaYUVerLibFrame
 * \brief    Pixel handling class
 */
class PlaYUVerPixel
{
public:
  /** ColorSpace list
	 * List of supported color spaces
	 */
  enum ColorSpace
  {
    COLOR_INVALID = -1,  //!< Invalid
    COLOR_YUV = 0,       //!< YUV
    COLOR_RGB = 1,       //!< RGB
    COLOR_GRAY = 2,      //!< Grayscale
    COLOR_RGBA = 3,      //!< RGB + Alpha
    COLOR_MAX = 255,     //!< Accouunt for future formats
  };

  static Int getMaxNumberOfComponents();

  PlaYUVerPixel( const Int& ColorSpace = COLOR_INVALID );
  PlaYUVerPixel( const Int& ColorSpace, const Pel& c0 );
  PlaYUVerPixel( const Int& ColorSpace, const Pel& c0, const Pel& c1, const Pel& c2 );
  PlaYUVerPixel( const Int& ColorSpace, const Pel& c0, const Pel& c1, const Pel& c2, const Pel& c3 );
  PlaYUVerPixel( const PlaYUVerPixel& other );
  ~PlaYUVerPixel();

  Int colorSpace() const;

  Pel Y() const;
  Pel Cb() const;
  Pel Cr() const;
  Pel R() const;
  Pel G() const;
  Pel B() const;
  Pel A() const;

  Pel& Y();
  Pel& Cb();
  Pel& Cr();
  Pel& R();
  Pel& G();
  Pel& B();
  Pel& A();

  Pel operator[]( const Int& channel ) const;
  Pel& operator[]( const Int& channel );

  PlaYUVerPixel operator=( const PlaYUVerPixel& );
  PlaYUVerPixel operator+( const PlaYUVerPixel& );
  PlaYUVerPixel operator+=( const PlaYUVerPixel& );
  PlaYUVerPixel operator-( const PlaYUVerPixel& );
  PlaYUVerPixel operator-=( const PlaYUVerPixel& );
  PlaYUVerPixel operator*( const Double& );

  /**
	 * Convert a Pixel to a new color space
	 * @param inputPixel input pixel (PlaYUVerPixel)
	 * @param eOutputSpace output color space
	 * @return converted pixel
	 */
  PlaYUVerPixel ConvertPixel( ColorSpace eOutputSpace );

private:
  struct PlaYUVerPixelPrivate* d;
};

/**
 * \class    PlaYUVerFrame
 * \ingroup	 PlaYUVerLibFrame
 * \brief    Frame handling class
 */
class PlaYUVerFrame
{
public:
  /** ColorSpace Enum
	 * List of supported pixel formats
	 */
  enum PixelFormats
  {
    NO_FMT = -1,
    YUV420p = 0,
    YUV422p,
    YUV444p,
    YUYV422,
    GRAY,
    RGBp,
    RGB24,
    BGR24,
    RGBA,
    BGRA,
    PEL_FMT_MAX = 255,
  };

  /**
	 * Function that handles the supported color space
	 * of PlaYUVerFrame
	 * @return vector of strings with pixel formats names
	 */
  static std::vector<String> supportedColorSpacesListNames();

  /**
	 * Function that handles the supported pixel formats
	 * of PlaYUVerFrame
	 * @return vector of strings with pixel formats names
	 */
  static std::vector<String> supportedPixelFormatListNames();
  static std::vector<String> supportedPixelFormatListNames( Int colorSpace );
  static Int numberOfFormats();
  static Int findPixelFormat( const String& name );

  /**
	 * Creates a new frame using the following configuration
	 *
	 * @param width width of the frame
	 * @param height height of the frame
	 * @param pel_format pixel format index (always use PixelFormats enum)
	 *
	 * @note this function might misbehave if the pixel format enum is not correct
	 */
  PlaYUVerFrame( UInt width, UInt height, Int pelFormat, Int bitsPixel = 8 );

  /**
	 * Copy contructor
	 *
	 * @param other existing frame to copy from
	 */
  PlaYUVerFrame( const PlaYUVerFrame& other );
  PlaYUVerFrame( const PlaYUVerFrame* other );

  /**
	 * Creates and new frame with the configuration of an existing one and copy
	 * its contents. This function only copies a specific region from the existing
	 * frame
	 *
	 * @param other existing frame to copy from
	 * @param posX position X to crop from
	 * @param posY position Y to crop from
	 * @param areaWidth crop width
	 * @param areaHeight crop height
	 */
  PlaYUVerFrame( const PlaYUVerFrame& other, UInt x, UInt y, UInt width, UInt height );
  PlaYUVerFrame( const PlaYUVerFrame* other, UInt x, UInt y, UInt width, UInt height );

  ~PlaYUVerFrame();

  /** Format match opts
	 */
  enum FormatMatching
  {
    MATCH_COLOR_SPACE = 1,
    MATCH_RESOLUTION = 2,
    MATCH_PEL_FMT = 4,
    MATCH_BITS = 8,
    MATCH_COLOR_SPACE_IGNORE_GRAY = 16,
    MATCH_ALL = 0xFFFF,
  };

  /**
	 * Check if two PlaYUVerFrames have the same fmt
	 * @param other frame to compare with
	 * @param match matching conditions (use enum FormatMatching)
	 * @return true if format matches
	 */
  Bool haveSameFmt( const PlaYUVerFrame& other, UInt match = MATCH_ALL ) const;
  Bool haveSameFmt( const PlaYUVerFrame* other, UInt match = MATCH_ALL ) const;

  /**
	 * Get pixel format information
	 * @return pixel format index
	 */
  Int getPelFormat() const;

  /**
	 * Get pixel format information
	 * @return pixel format name
	 */
  String getPelFmtName();

  /**
	 * Get color space information
	 * @return get color space index
	 */
  Int getColorSpace() const;

  /**
	 * Get the number of channels
	 * @return number of channels
	 */
  UInt getNumberChannels() const;

  /**
	 * Get width of the frame
	 * @param channel/component
	 * @return number of pixels
	 */
  UInt getWidth( Int channel = 0 ) const;

  /**
	 * Get height of the frame
	 * @param channel/component
	 * @return number of pixels
	 */
  UInt getHeight( Int channel = 0 ) const;

  /**
	 * Get number of pixels of the frame
	 * @param channel/component
	 * @return number of pixels
	 */
  UInt getPixels( Int channel = 0 ) const;

  UInt8 getChromaWidthRatio() const;
  UInt8 getChromaHeightRatio() const;
  UInt getChromaWidth() const;
  UInt getChromaHeight() const;
  UInt getChromaLength() const;
  UInt getChromaSize() const;

  /**
	 * Get number of bits per pixel
	 * @return number of bits
	 */
  UInt getBitsPel() const;

  /**
	 * Get number of bytes per frame of an existing frame
	 * @return number of bytes per frame
	 */
  UInt64 getBytesPerFrame();

  /**
	 * Get number of bytes per frame of a specific pixel format
	 * @return number of bytes per frame
	 */
  static UInt64 getBytesPerFrame( UInt uiWidth, UInt uiHeight, Int iPixelFormat, UInt bitsPixel );

  /**
	 * Reset frame pixels to zero
	 */
  Void clear();

  Pel*** getPelBufferYUV() const;
  Pel*** getPelBufferYUV();
  UChar* getRGBBuffer() const;
  UChar* getRGBBuffer();

  PlaYUVerPixel getPixel( Int xPos, Int yPos );
  PlaYUVerPixel getPixel( Int xPos, Int yPos, PlaYUVerPixel::ColorSpace eColorSpace );
  Void setPixel( Int xPos, Int yPos, PlaYUVerPixel pixel );

  Void copyFrom( const PlaYUVerFrame& );
  Void copyFrom( const PlaYUVerFrame* );
  Void copyFrom( const PlaYUVerFrame&, UInt, UInt );
  Void copyFrom( const PlaYUVerFrame*, UInt, UInt );

  Void frameFromBuffer( Byte*, Int, UInt64 );
  Void frameFromBuffer( Byte*, Int );
  Void frameToBuffer( Byte*, Int );

  Void fillRGBBuffer();

  /**
	 * Histogram
	 */

  enum HistogramChannels
  {
    HIST_CHAN_ONE = 0,
    HIST_CHAN_TWO,
    HIST_CHAN_THREE,
    HIST_CHAN_FOUR,
    HIST_LUMA = 10,
    HIST_CHROMA_U,
    HIST_CHROMA_V,
    HIST_COLOR_R = 20,
    HIST_COLOR_G,
    HIST_COLOR_B,
    HIST_COLOR_A,
    HIST_ALL_CHANNELS = 254,
    HISTOGRAM_MAX = 255,
  };
  Void calcHistogram();

  UInt getMinimumPelValue( Int channel );
  UInt getMaximumPelValue( Int channel );

  UInt getMaximum( Int channel );
  UInt getNumPixelsRange( Int channel, UInt start, UInt end );
  Double getMean( Int channel, UInt start, UInt end );
  Int getMedian( Int channel, UInt start, UInt end );
  Double getStdDev( Int channel, UInt start, UInt end );
  Double getHistogramValue( Int channel, UInt bin );
  Int getNumHistogramSegment();

  /**
	 * Interface with OpenCV lib
	 */
  Bool toMat( cv::Mat& cvMat, Bool convertToGray = false );
  Bool fromMat( cv::Mat& cvMat );

  /**
	 * \ingroup	 PlaYUVerLibFrame
	 * @defgroup PlaYUVerLibFrameQualityMetrics Quality Metrics Interface
	 * @{
	 * Quality metrics interface
	 *
	 */

  enum QualityMetrics
  {
    NO_METRIC = -1,
    PSNR_METRIC = 0,
    MSE_METRIC,
    SSIM_METRIC,
    NUMBER_METRICS,
  };

  static std::vector<String> supportedQualityMetricsList();
  Double getQuality( Int Metric, PlaYUVerFrame* Org, Int component );
  Double getMSE( PlaYUVerFrame* Org, Int component );
  Double getPSNR( PlaYUVerFrame* Org, Int component );
  Double getSSIM( PlaYUVerFrame* Org, Int component );

  /** @} */

private:
  PlaYUVerFramePrivate* d;
};

#endif  // __PLAYUVERFRAME_H__