dali-toolkit/internal/controls/super-blur-view/super-blur-view-impl.cpp

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "super-blur-view-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <cmath>
  23 #include <dali/public-api/animation/constraint.h>
  24 #include <dali/public-api/common/stage.h>
  25 #include <dali/public-api/object/property-map.h>
  26 #include <dali/public-api/object/type-registry.h>
  27 #include <dali/public-api/object/type-registry-helper.h>
  28 #include <dali/public-api/rendering/renderer.h>
  29 #include <dali/devel-api/scripting/scripting.h>
  30 #include <dali/integration-api/debug.h>
  31
  32 // INTERNAL_INCLUDES
  33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  34 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  35
  36 namespace //Unnamed namespace
  37 {
  38
  39 using namespace Dali;
  40
  41 //Todo: make these properties instead of constants
  42 const unsigned int GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES = 11;
  43 const unsigned int GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION = 10;
  44 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH = 4.5f;
  45 const float GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION = 5.f;
  46 const Pixel::Format GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT = Pixel::RGBA8888;
  47 const float GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE = 0.5f;
  48 const float GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE = 0.5f;
  49
  50 const char* ALPHA_UNIFORM_NAME( "uAlpha" );
  51 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
  52   varying mediump vec2 vTexCoord;\n
  53   uniform sampler2D sTexture;\n
  54   uniform lowp vec4 uColor;\n
  55   uniform lowp float uAlpha;\n
  56   \n
  57   void main()\n
  58   {\n
  59     gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
  60     gl_FragColor.a *= uAlpha;
  61   }\n
  62 );
  63
  64 /**
  65  * The constraint is used to blend the group of blurred images continuously with a unified blur strength property value which ranges from zero to one.
  66  */
  67 struct ActorOpacityConstraint
  68 {
  69   ActorOpacityConstraint(int totalImageNum, int currentImageIdx)
  70   {
  71     float rangeLength = 1.f / static_cast<float>( totalImageNum );
  72     float index = static_cast<float>( currentImageIdx );
  73     mRange = Vector2( index*rangeLength, (index+1.f)*rangeLength );
  74   }
  75
  76   void operator()( float& current, const PropertyInputContainer& inputs )
  77   {
  78     float blurStrength = inputs[0]->GetFloat();
  79     if(blurStrength < mRange.x)
  80     {
  81       current = 0.f;
  82     }
  83     else if(blurStrength > mRange.y)
  84     {
  85       current = 1.f;
  86     }
  87     else
  88     {
  89       current = ( blurStrength - mRange.x) / ( mRange.y - mRange.x );
  90     }
  91   }
  92
  93   Vector2 mRange;
  94 };
  95
  96 } // namespace
  97
  98 namespace Dali
  99 {
 100
 101 namespace Toolkit
 102 {
 103
 104 namespace Internal
 105 {
 106
 107 namespace
 108 {
 109
 110 const unsigned int DEFAULT_BLUR_LEVEL(5u); ///< The default blur level when creating SuperBlurView from the type registry
 111
 112 BaseHandle Create()
 113 {
 114   return Toolkit::SuperBlurView::New( DEFAULT_BLUR_LEVEL );
 115 }
 116
 117 // Setup properties, signals and actions using the type-registry.
 118 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::SuperBlurView, Toolkit::Control, Create )
 119
 120 DALI_PROPERTY_REGISTRATION( Toolkit, SuperBlurView, "image", MAP, IMAGE )
 121
 122 DALI_TYPE_REGISTRATION_END()
 123
 124 } // unnamed namespace
 125
 126 SuperBlurView::SuperBlurView( unsigned int blurLevels )
 127 : Control( ControlBehaviour( DISABLE_SIZE_NEGOTIATION | DISABLE_STYLE_CHANGE_SIGNALS ) ),
 128   mTargetSize( Vector2::ZERO ),
 129   mBlurStrengthPropertyIndex(Property::INVALID_INDEX),
 130   mBlurLevels( blurLevels ),
 131   mResourcesCleared( true )
 132 {
 133   DALI_ASSERT_ALWAYS( mBlurLevels > 0 && " Minimal blur level is one, otherwise no blur is needed" );
 134   mGaussianBlurView.assign( blurLevels, Toolkit::GaussianBlurView() );
 135   mBlurredImage.assign( blurLevels, FrameBufferImage() );
 136   mVisuals.assign( blurLevels+1, Toolkit::Visual::Base() );
 137 }
 138
 139 SuperBlurView::~SuperBlurView()
 140 {
 141 }
 142
 143 Toolkit::SuperBlurView SuperBlurView::New( unsigned int blurLevels )
 144 {
 145   //Create the implementation
 146   IntrusivePtr<SuperBlurView> superBlurView( new SuperBlurView( blurLevels ) );
 147
 148   //Pass ownership to CustomActor via derived handle
 149   Toolkit::SuperBlurView handle( *superBlurView );
 150
 151   // Second-phase init of the implementation
 152   // This can only be done after the CustomActor connection has been made...
 153   superBlurView->Initialize();
 154
 155   return handle;
 156 }
 157
 158 void SuperBlurView::OnInitialize()
 159 {
 160   mBlurStrengthPropertyIndex = Self().RegisterProperty( "blurStrength", 0.f );
 161 }
 162
 163 void SuperBlurView::SetImage(Image inputImage)
 164 {
 165   mInputImage = inputImage;
 166   if( mTargetSize == Vector2::ZERO )
 167   {
 168     return;
 169   }
 170
 171   ClearBlurResource();
 172
 173   Actor self( Self() );
 174
 175   mVisuals[0] = Toolkit::VisualFactory::Get().CreateVisual( mInputImage );
 176   RegisterVisual( 0, mVisuals[0] ); // Will clean up previously registered visuals for this index.
 177   mVisuals[0].SetDepthIndex(0);
 178   // custom shader is not applied on the original image.
 179
 180   BlurImage( 0,  inputImage);
 181   for(unsigned int i=1; i<mBlurLevels;i++)
 182   {
 183     BlurImage( i, mBlurredImage[i-1]);
 184   }
 185
 186   mResourcesCleared = false;
 187 }
 188
 189 Image SuperBlurView::GetImage()
 190 {
 191   return mInputImage;
 192 }
 193
 194 Property::Index SuperBlurView::GetBlurStrengthPropertyIndex() const
 195 {
 196   return mBlurStrengthPropertyIndex;
 197 }
 198
 199 void SuperBlurView::SetBlurStrength( float blurStrength )
 200 {
 201   Self().SetProperty(mBlurStrengthPropertyIndex, blurStrength);
 202 }
 203
 204 float SuperBlurView::GetCurrentBlurStrength() const
 205 {
 206   float blurStrength;
 207   (Self().GetProperty( mBlurStrengthPropertyIndex )).Get(blurStrength);
 208
 209   return blurStrength;
 210 }
 211
 212 Toolkit::SuperBlurView::SuperBlurViewSignal& SuperBlurView::BlurFinishedSignal()
 213 {
 214   return mBlurFinishedSignal;
 215 }
 216
 217 Image SuperBlurView::GetBlurredImage( unsigned int level )
 218 {
 219   DALI_ASSERT_ALWAYS( level>0 && level<=mBlurLevels );
 220   return mBlurredImage[level-1];
 221 }
 222
 223 void SuperBlurView::BlurImage( unsigned int idx, Image image )
 224 {
 225   DALI_ASSERT_ALWAYS( mGaussianBlurView.size()>idx );
 226   mGaussianBlurView[idx] = Toolkit::GaussianBlurView::New( GAUSSIAN_BLUR_DEFAULT_NUM_SAMPLES+GAUSSIAN_BLUR_NUM_SAMPLES_INCREMENTATION*idx,
 227                                                            GAUSSIAN_BLUR_BELL_CURVE_WIDTH + GAUSSIAN_BLUR_BELL_CURVE_WIDTH_INCREMENTATION*static_cast<float>(idx),
 228                                                            GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT,
 229                                                            GAUSSIAN_BLUR_DOWNSAMPLE_WIDTH_SCALE, GAUSSIAN_BLUR_DOWNSAMPLE_HEIGHT_SCALE, true );
 230   mGaussianBlurView[idx].SetParentOrigin(ParentOrigin::CENTER);
 231   mGaussianBlurView[idx].SetSize(mTargetSize);
 232   Stage::GetCurrent().Add( mGaussianBlurView[idx] );
 233   mGaussianBlurView[idx].SetUserImageAndOutputRenderTarget( image, mBlurredImage[idx] );
 234   mGaussianBlurView[idx].ActivateOnce();
 235   if( idx == mBlurLevels-1 )
 236   {
 237     mGaussianBlurView[idx].FinishedSignal().Connect( this, &SuperBlurView::OnBlurViewFinished );
 238   }
 239 }
 240
 241 void SuperBlurView::OnBlurViewFinished( Toolkit::GaussianBlurView blurView )
 242 {
 243   ClearBlurResource();
 244   Toolkit::SuperBlurView handle( GetOwner() );
 245   mBlurFinishedSignal.Emit( handle );
 246 }
 247
 248 void SuperBlurView::ClearBlurResource()
 249 {
 250   if( !mResourcesCleared )
 251   {
 252     DALI_ASSERT_ALWAYS( mGaussianBlurView.size() == mBlurLevels && "must synchronize the GaussianBlurView group if blur levels got changed " );
 253     for(unsigned int i=0; i<mBlurLevels;i++)
 254     {
 255       Stage::GetCurrent().Remove( mGaussianBlurView[i] );
 256       mGaussianBlurView[i].Deactivate();
 257     }
 258     mResourcesCleared = true;
 259   }
 260 }
 261 void SuperBlurView::SetShaderEffect( Toolkit::Visual::Base& visual )
 262 {
 263   Property::Map shaderMap;
 264   std::stringstream verterShaderString;
 265   shaderMap[ "fragmentShader" ] = FRAGMENT_SHADER;
 266
 267   Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 268   visualImpl.SetCustomShader( shaderMap );
 269 }
 270
 271 void SuperBlurView::OnSizeSet( const Vector3& targetSize )
 272 {
 273   if( mTargetSize != Vector2(targetSize) )
 274   {
 275     mTargetSize = Vector2(targetSize);
 276
 277     Actor self = Self();
 278     for( unsigned int i = 1; i <= mBlurLevels; i++ )
 279     {
 280       float exponent = static_cast<float>(i);
 281       mBlurredImage[i-1] = FrameBufferImage::New( mTargetSize.width/std::pow(2.f,exponent) , mTargetSize.height/std::pow(2.f,exponent),
 282                                                 GAUSSIAN_BLUR_RENDER_TARGET_PIXEL_FORMAT );
 283
 284       mVisuals[i] = Toolkit::VisualFactory::Get().CreateVisual( mBlurredImage[i - 1] );
 285       RegisterVisual( i, mVisuals[i] ); // Will clean up existing visual with same index.
 286       mVisuals[i].SetDepthIndex( i );
 287       SetShaderEffect( mVisuals[i] );
 288     }
 289
 290     if( mInputImage )
 291     {
 292       SetImage( mInputImage );
 293     }
 294   }
 295
 296   Control::OnSizeSet( targetSize );
 297 }
 298
 299 void SuperBlurView::OnStageConnection( int depth )
 300 {
 301   if( mTargetSize == Vector2::ZERO )
 302   {
 303     return;
 304   }
 305
 306   // Exception to the rule, chaining up first ensures visuals have SetOnStage called to create their renderers
 307   Control::OnStageConnection( depth );
 308
 309   Actor self = Self();
 310   for(unsigned int i=0; i<=mBlurLevels;i++)
 311   {
 312     // Note that the renderer indices are depending on the order they been added to the actor
 313     // which might be different from the blur level of its texture.
 314     // We can check the depth index of the renderer to know which blurred image it renders.
 315     // All visuals WILL have renderers at this point as we are simply creating visuals with an Image handle.
 316     Renderer renderer = self.GetRendererAt( i );
 317     int depthIndex = renderer.GetProperty<int>(Renderer::Property::DEPTH_INDEX);
 318     if( depthIndex > 0 )
 319     {
 320       Property::Index index = renderer.RegisterProperty( ALPHA_UNIFORM_NAME, 0.f );
 321       Constraint constraint = Constraint::New<float>( renderer, index, ActorOpacityConstraint(mBlurLevels, depthIndex-1) );
 322       constraint.AddSource( Source( self, mBlurStrengthPropertyIndex ) );
 323       constraint.Apply();
 324     }
 325   }
 326 }
 327
 328 Vector3 SuperBlurView::GetNaturalSize()
 329 {
 330   if( mInputImage )
 331   {
 332     return Vector3( mInputImage.GetWidth(), mInputImage.GetHeight(), 0.f );
 333   }
 334   return Vector3::ZERO;
 335 }
 336
 337 void SuperBlurView::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
 338 {
 339   Toolkit::SuperBlurView superBlurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
 340
 341   if( superBlurView )
 342   {
 343     SuperBlurView& superBlurViewImpl( GetImpl( superBlurView ) );
 344
 345     if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
 346     {
 347       Dali::Image image = Scripting::NewImage( value );
 348       if ( image )
 349       {
 350         superBlurViewImpl.SetImage( image );
 351       }
 352       else
 353       {
 354         DALI_LOG_ERROR( "Cannot create image from property value\n" );
 355       }
 356     }
 357   }
 358 }
 359
 360 Property::Value SuperBlurView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 361 {
 362   Property::Value value;
 363
 364   Toolkit::SuperBlurView blurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
 365
 366   if( blurView )
 367   {
 368     SuperBlurView& superBlurViewImpl( GetImpl( blurView ) );
 369
 370     if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
 371     {
 372       Property::Map map;
 373       Image inputImage = superBlurViewImpl.GetImage();
 374       if( inputImage )
 375       {
 376         Scripting::CreatePropertyMap( inputImage, map );
 377       }
 378       value = Property::Value( map );
 379     }
 380   }
 381
 382   return value;
 383 }
 384
 385 } // namespace Internal
 386
 387 } // namespace Toolkit
 388
 389 } // namespace Dali