DtHdrDrawable.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2018 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
// This file is derived from the HDR NVIDIA gameworks SDK example
//----------------------------------------------------------------------------------
// Multiple Files in folder:        es3aep-kepler\HDR/
// SDK Version: v2.11 
// Email:       gameworks@nvidia.com
// Site:        http://developer.nvidia.com/
//
// Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * 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.
//  * Neither the name of NVIDIA CORPORATION 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 COPYRIGHT HOLDERS ``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 COPYRIGHT OWNER 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.
//
//----------------------------------------------------------------------------------

#pragma once



// Get proper local export symbol
#include <vrvPostProcessor/vrvPostProcessor.h>
#include <vrvPostProcessor/DtPostProcessorDrawable.h>

#include <GL/glew.h>

#include <osg/Drawable>
#include <osg/Program>
#include <osg/Texture>
#include <osg/Texture2D>

namespace osg
{
   class Object;
   class State;
   class RenderInfo;
   class CopyOp;
}

namespace makVrv { 

   class DtDe;
   class DtGlRenderTexture;

   class DT_DLL_VRVPOSTPROCESSOR DtHdrDrawable : public DtPostProcessorDrawable
   {
   public:

      enum HDR_PASS { //Program ID enum
         DOWNSAMPLE = 0,
         DOWNSAMPLE4X,
         BLURH4,
         BLURV4,
         BLURH6,
         BLURV6,
         BLURH10,
         BLURV10,
         BLURH12,
         BLURV12,
         TONEMAPPING,
         EXTRACTHL,
         GAUSCOMP,
         STARSTREAK,
         GLARECOMP,
         STARCOMP,
         GHOSTIMAGE,
         CALCADAPTEDLUM,
         PROGSIZE
      };

      enum BUFFER_PYRAMID {
         LEVEL_0 = 0, 
         LEVEL_1, 
         LEVEL_2,     
         LEVEL_3,
         LEVEL_4,
         LEVEL_5,
         LEVEL_TOTAL
      };

      struct DtHdrOptions
      {
         int chanWidth;
         int chanHeight;
         int hdrWidth;
         int hdrHeight;
         float lumThreshold;
         float lumScaler;
         BUFFER_PYRAMID starGenLevel;
         float blendAmount;
         float gamma;
         int numStreaks;
         float streakScale;
         float streakRotationOffset;
         float streakDec;
         float streakStride;
         float timeScale; //0.0 for instant
         bool adaptiveLuminance;
         bool enableBloom;
         bool enableStreaks;
         bool enableLensFlare;
         float adaptiveLumMaxDiff;
         float adaptiveLumMinDiff;
         osg::Vec4f ghostScalar1;
         osg::Vec4f ghostScalar2;
         osg::Vec4f cameraMixCoeff;
         osg::Vec4f gausCompCoeff;
         osg::Vec4f blurScalar;
         float adaptiveLumPreScale;
         float adaptiveLumPostScale;
         float luminanceMaxValue;
         float luminanceMinValue;
         float saturationScale;
      };

      DtHdrDrawable(DtDe &de, DtHdrOptions options, osg::Texture *lensFlareTexture);

      DtHdrDrawable(const DtHdrDrawable& orig, const osg::CopyOp& op);

      virtual ~DtHdrDrawable();

      virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new DtHdrDrawable(*this,copyop); }
      virtual osg::Object* cloneType() const { return NULL; }

      virtual void drawImplementation(osg::RenderInfo& renderInfo) const;


      virtual void setInputTexture(osg::Texture2D* inputTex);

      virtual void setEnabled( bool enabled );
      virtual bool enabled();

      virtual DtHdrOptions& options();

      virtual void setLumOverride(bool lumOverride);

      // should just pass through without applying any effects
      // used by SensorFX to turn off HDR on a per channel basis.
      virtual void setHdrPassthrough(bool enable);
      virtual bool hdrPassthrough();

      virtual void cleanupGpuMemory();
   protected:

      virtual void initRenderTextures() const;

      virtual void downsample(DtGlRenderTexture *src, DtGlRenderTexture *dest, osg::State *state) const;

      virtual void downsample4x(DtGlRenderTexture *src, DtGlRenderTexture *dest, osg::State *state) const;

      virtual void extractHL(DtGlRenderTexture *src, DtGlRenderTexture *dest, osg::State *state) const;

      virtual void runPass(HDR_PASS prog, DtGlRenderTexture *src, DtGlRenderTexture *dest, 
         osg::State *state) const;

      virtual void blur(DtGlRenderTexture *src, DtGlRenderTexture *dest, DtGlRenderTexture *temp, 
         int blurWidth, osg::State *state) const;

      virtual void getBufferPyramidSize(BUFFER_PYRAMID level, int* w, int* h) const;

      virtual void genStarStreak(int streak, float dir, float length, osg::State *state) const;

      virtual void genGhostImage(const float* ghost_modulation1st,const float* ghost_modulation2nd, osg::State *state) const;

      virtual void composeEffect(osg::State *state) const;

      virtual void toneMappingPass(osg::State *state) const;

      virtual void calculateLuminance(osg::State *state) const;

      virtual void initBlurCode();

      virtual void initShaders();

      //helper functions used for creating color constants
      virtual void colorModulationRedShift(float* color, float r, float g, float b, int num);
      virtual void colorModulation(float* color, float r, float g, float b, int num);
      virtual void modulateColor();
   protected:
      bool myEnabled;

      osg::ref_ptr<osg::Texture2D> myInputTex;

      //5 is the minimum required to avoid a draw time hit
      static const int theNumLumCapturePbos = 5;
      
      static double theLastHdrFrameTime;

      float myAspectRatio;

      osg::ref_ptr<osg::Program> myShaders[PROGSIZE];

      osg::ref_ptr<osg::Texture> myLensMask;

      DtHdrOptions myOptions;

      DtDe &myDe;
      bool myLumOverride;
      bool myEnableHdrPassthrough;

      float myStarModulation1st[16];
      float myStarModulation2nd[16];
      float myStarModulation3rd[16];

      float myFilmicGhostModulation1st[16];
      float myFilmicGhostModulation2nd[16];
      float myCameraGhostModulation1st[16];
      float myCameraGhostModulation2nd[16];

      float myHoriModulation1st[16];
      float myHoriModulation2nd[16];
      float myHoriModulation3rd[16];

      //mutables needed since osg drawable draw implementations are const functions.
      // This allows us to keep track of a bit of state that is needed between frames
      // Also these are protected instead of private because they may be needed by 
      // classes derived from this class

      //Render textures need to be initialized in draw implementation so 
      // they need to be mutable...
      mutable DtGlRenderTexture* myMutableComposebuffer[LEVEL_TOTAL];
      mutable DtGlRenderTexture* myMutableBlurbufferA[LEVEL_TOTAL];
      mutable DtGlRenderTexture* myMutableBlurbufferB[LEVEL_TOTAL];

      mutable DtGlRenderTexture* myMutableStreakbufferA[8];
      mutable DtGlRenderTexture* myMutableStreakbufferB[8];
      mutable DtGlRenderTexture* myMutableStreakbufferFinal;

      mutable DtGlRenderTexture* myMutableGhost1stBuffer;
      mutable DtGlRenderTexture* myMutableGhost2ndBuffer;

      mutable DtGlRenderTexture*  myMutableGlareBuffer;

      mutable DtGlRenderTexture* myMutableLumcurrent;
      mutable DtGlRenderTexture* myMutableLumPrev;
      mutable DtGlRenderTexture* myMutableLumNext;

      mutable DtGlRenderTexture* myMutableInitialBuffer;

      //PBO is initialized with the Render textures in draw implementation so it 
      // also has to be mutable. Also need to keep track of current PBO 
      // so that state is mutable as well.
      mutable GLuint myMutableLumPbos[theNumLumCapturePbos];
      mutable int myMutableCurLumBuffer;
      mutable int myMutableInitializedPboIndex;
      
      //need to keep track of the previous frame time in draw implementation
      // so this needs to be mutable.
      mutable double myMutableLastAdpativeLumFrameTime;

   };
}