text: /*****************************************************************************
  *                                                                            *
  *  OpenNI 2.x Alpha                                                          *
  *  Copyright (C) 2012 PrimeSense Ltd.                                        *
  *                                                                            *
  *  This file is part of OpenNI.                                              *
  *                                                                            *
  *  Licensed under the Apache License, Version 2.0 (the "License");           *
  *  you may not use this file except in compliance with the License.          *
  *  You may obtain a copy of the License at                                   *
  *                                                                            *
  *      http://www.apache.org/licenses/LICENSE-2.0                            *
  *                                                                            *
  *  Unless required by applicable law or agreed to in writing, software       *
  *  distributed under the License is distributed on an "AS IS" BASIS,         *
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  *
  *  See the License for the specific language governing permissions and       *
  *  limitations under the License.                                            *
  *                                                                            *
  *****************************************************************************/
  #ifndef __XN_SENSOR_IMAGE_STREAM_H__
  #define __XN_SENSOR_IMAGE_STREAM_H__
  
  //---------------------------------------------------------------------------
  // Includes
  //---------------------------------------------------------------------------
  #include <DDK/XnImageStream.h>
  #include "XnSensorStreamHelper.h"
  
  //---------------------------------------------------------------------------
  // Defines
  //---------------------------------------------------------------------------
  #define XN_IMAGE_STREAM_DEFAULT_FPS			30
  #define XN_IMAGE_STREAM_DEFAULT_RESOLUTION		XN_RESOLUTION_QVGA
  #if (XN_PLATFORM == XN_PLATFORM_WIN32)
  	#define XN_IMAGE_STREAM_DEFAULT_INPUT_FORMAT	XN_IO_IMAGE_FORMAT_UNCOMPRESSED_YUV422
  #else
  	//non win32 works with BULK, so it's better to compress the image
  	#define XN_IMAGE_STREAM_DEFAULT_INPUT_FORMAT	XN_IO_IMAGE_FORMAT_YUV422
  #endif
  #define XN_IMAGE_STREAM_DEFAULT_OUTPUT_FORMAT		ONI_PIXEL_FORMAT_RGB888
  #define XN_IMAGE_STREAM_DEFAULT_FLICKER			0
  #define XN_IMAGE_STREAM_DEFAULT_QUALITY			3
  #define XN_IMAGE_STREAM_DEFAULT_BRIGHTNESS		128
  #define XN_IMAGE_STREAM_DEFAULT_CONTRAST		32
  #define XN_IMAGE_STREAM_DEFAULT_SATURATION		128
  #define XN_IMAGE_STREAM_DEFAULT_SHARPNESS		32
  #define XN_IMAGE_STREAM_DEFAULT_AWB			TRUE
  #define XN_IMAGE_STREAM_DEFAULT_COLOR_TEMP		5000
  #define XN_IMAGE_STREAM_DEFAULT_BACKLIGHT_COMP		1
  #define XN_IMAGE_STREAM_DEFAULT_GAIN			128
  #define XN_IMAGE_STREAM_DEFAULT_ZOOM			100
  #define XN_IMAGE_STREAM_DEFAULT_AUTO_EXPOSURE		TRUE
  #define XN_IMAGE_STREAM_DEFAULT_EXPOSURE_BAR		100
  #define XN_IMAGE_STREAM_DEFAULT_PAN			0
  #define XN_IMAGE_STREAM_DEFAULT_TILT			0
  #define XN_IMAGE_STREAM_DEFAULT_LOW_LIGHT_COMP		TRUE
  
  //---------------------------------------------------------------------------
  // XnSensorImageStream class
  //---------------------------------------------------------------------------
  class XnSensorImageStream : public XnImageStream, public IXnSensorStream
  {
  public:
  	XnSensorImageStream(const XnChar* StreamName, XnSensorObjects* pObjects);
  	~XnSensorImageStream() { Free(); }
  
  	//---------------------------------------------------------------------------
  	// Overridden Methods
  	//---------------------------------------------------------------------------
  	XnStatus Init();
  	XnStatus Free();
  	XnStatus BatchConfig(const XnActualPropertiesHash& props) { return m_Helper.BatchConfig(props); }
  
  	XnUInt32 CalculateExpectedSize();
  
  	inline XnSensorStreamHelper* GetHelper() { return &m_Helper; }
  
  	friend class XnImageProcessor;
  
  protected:
  	inline XnSensorFirmwareParams* GetFirmwareParams() const { return m_Helper.GetFirmware()->GetParams(); }
  
  	//---------------------------------------------------------------------------
  	// Overridden Methods
  	//---------------------------------------------------------------------------
  	XnStatus Open() { return m_Helper.Open(); }
  	XnStatus Close() { return m_Helper.Close(); }
  	XnStatus ReallocTripleFrameBuffer();
  	XnStatus CropImpl(OniFrame* pFrame, const OniCropping* pCropping);
  	XnStatus Mirror(OniFrame* pFrame) const;
  	XnStatus ConfigureStreamImpl();
  	XnStatus OpenStreamImpl();
  	XnStatus CloseStreamImpl();
  	XnStatus CreateDataProcessor(XnDataProcessor** ppProcessor);
  	XnStatus MapPropertiesToFirmware();
  	void GetFirmwareStreamConfig(XnResolutions* pnRes, XnUInt32* pnFPS) { *pnRes = GetResolution(); *pnFPS = GetFPS(); }
  
  	//---------------------------------------------------------------------------
  	// Setters
  	//---------------------------------------------------------------------------
  	XnStatus SetOutputFormat(OniPixelFormat nOutputFormat);
  	XnStatus SetMirror(XnBool bIsMirrored);
  	XnStatus SetResolution(XnResolutions nResolution);
  	XnStatus SetFPS(XnUInt32 nFPS);
  	virtual XnStatus SetInputFormat(XnIOImageFormats nInputFormat);
  	virtual XnStatus SetAntiFlicker(XnUInt32 nFrequency);
  	virtual XnStatus SetImageQuality(XnUInt32 nQuality);
  	virtual XnStatus SetCropping(const OniCropping* pCropping);
  	virtual XnStatus SetCroppingMode(XnCroppingMode mode);
  	XnStatus SetActualRead(XnBool bRead);
  	virtual XnStatus SetAutoExposure(XnBool bAutoExposure);
  	virtual XnStatus SetAutoWhiteBalance(XnBool bAutoWhiteBalance);
  
  private:
  	XnStatus ValidateMode();
  	XnStatus SetCroppingImpl(const OniCropping* pCropping, XnCroppingMode mode);
  	XnStatus SetAutoExposureForOldFirmware(XnBool bAutoExposure);
  	XnStatus SetAutoWhiteBalanceForOldFirmware(XnBool bAutoWhiteBalance);
  
  	static XnStatus XN_CALLBACK_TYPE SetInputFormatCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetAntiFlickerCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetImageQualityCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetActualReadCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetCroppingModeCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetAutoExposureCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  	static XnStatus XN_CALLBACK_TYPE SetAutoWhiteBalanceCallback(XnActualIntProperty* pSender, XnUInt64 nValue, void* pCookie);
  
  	//---------------------------------------------------------------------------
  	// Members
  	//---------------------------------------------------------------------------
  	XnSensorStreamHelper m_Helper;
  	XnActualIntProperty m_InputFormat;
  	XnActualIntProperty m_AntiFlicker;
  	XnActualIntProperty m_ImageQuality;
  	XnActualIntProperty m_CroppingMode;
  
  	XnActualIntProperty m_FirmwareMirror;
  
  	XnActualIntProperty m_FirmwareCropSizeX;
  	XnActualIntProperty m_FirmwareCropSizeY;
  	XnActualIntProperty m_FirmwareCropOffsetX;
  	XnActualIntProperty m_FirmwareCropOffsetY;
  	XnActualIntProperty m_FirmwareCropMode;
  
  	XnActualIntProperty m_AutoExposure;
  	XnActualIntProperty m_AutoWhiteBalance;
  
  	XnActualIntProperty m_ActualRead;
  
  	XnActualRealProperty m_HorizontalFOV;
  	XnActualRealProperty m_VerticalFOV;
  };
  
  #endif //__XN_SENSOR_IMAGE_STREAM_H__
  