2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "super-blur-view-impl.h"
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>
33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
34 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
36 namespace //Unnamed namespace
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;
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
59 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
60 gl_FragColor.a *= uAlpha;
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.
67 struct ActorOpacityConstraint
69 ActorOpacityConstraint(int totalImageNum, int currentImageIdx)
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 );
76 void operator()( float& current, const PropertyInputContainer& inputs )
78 float blurStrength = inputs[0]->GetFloat();
79 if(blurStrength < mRange.x)
83 else if(blurStrength > mRange.y)
89 current = ( blurStrength - mRange.x) / ( mRange.y - mRange.x );
110 const unsigned int DEFAULT_BLUR_LEVEL(5u); ///< The default blur level when creating SuperBlurView from the type registry
114 return Toolkit::SuperBlurView::New( DEFAULT_BLUR_LEVEL );
117 // Setup properties, signals and actions using the type-registry.
118 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::SuperBlurView, Toolkit::Control, Create )
120 DALI_PROPERTY_REGISTRATION( Toolkit, SuperBlurView, "image", MAP, IMAGE )
122 DALI_TYPE_REGISTRATION_END()
124 } // unnamed namespace
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 )
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() );
139 SuperBlurView::~SuperBlurView()
143 Toolkit::SuperBlurView SuperBlurView::New( unsigned int blurLevels )
145 //Create the implementation
146 IntrusivePtr<SuperBlurView> superBlurView( new SuperBlurView( blurLevels ) );
148 //Pass ownership to CustomActor via derived handle
149 Toolkit::SuperBlurView handle( *superBlurView );
151 // Second-phase init of the implementation
152 // This can only be done after the CustomActor connection has been made...
153 superBlurView->Initialize();
158 void SuperBlurView::OnInitialize()
160 mBlurStrengthPropertyIndex = Self().RegisterProperty( "blurStrength", 0.f );
163 void SuperBlurView::SetImage(Image inputImage)
165 mInputImage = inputImage;
166 if( mTargetSize == Vector2::ZERO )
173 Actor self( Self() );
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.
180 BlurImage( 0, inputImage);
181 for(unsigned int i=1; i<mBlurLevels;i++)
183 BlurImage( i, mBlurredImage[i-1]);
186 mResourcesCleared = false;
189 Image SuperBlurView::GetImage()
194 Property::Index SuperBlurView::GetBlurStrengthPropertyIndex() const
196 return mBlurStrengthPropertyIndex;
199 void SuperBlurView::SetBlurStrength( float blurStrength )
201 Self().SetProperty(mBlurStrengthPropertyIndex, blurStrength);
204 float SuperBlurView::GetCurrentBlurStrength() const
207 (Self().GetProperty( mBlurStrengthPropertyIndex )).Get(blurStrength);
212 Toolkit::SuperBlurView::SuperBlurViewSignal& SuperBlurView::BlurFinishedSignal()
214 return mBlurFinishedSignal;
217 Image SuperBlurView::GetBlurredImage( unsigned int level )
219 DALI_ASSERT_ALWAYS( level>0 && level<=mBlurLevels );
220 return mBlurredImage[level-1];
223 void SuperBlurView::BlurImage( unsigned int idx, Image image )
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 )
237 mGaussianBlurView[idx].FinishedSignal().Connect( this, &SuperBlurView::OnBlurViewFinished );
241 void SuperBlurView::OnBlurViewFinished( Toolkit::GaussianBlurView blurView )
244 Toolkit::SuperBlurView handle( GetOwner() );
245 mBlurFinishedSignal.Emit( handle );
248 void SuperBlurView::ClearBlurResource()
250 if( !mResourcesCleared )
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++)
255 Stage::GetCurrent().Remove( mGaussianBlurView[i] );
256 mGaussianBlurView[i].Deactivate();
258 mResourcesCleared = true;
261 void SuperBlurView::SetShaderEffect( Toolkit::Visual::Base& visual )
263 Property::Map shaderMap;
264 std::stringstream verterShaderString;
265 shaderMap[ "fragmentShader" ] = FRAGMENT_SHADER;
267 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
268 visualImpl.SetCustomShader( shaderMap );
271 void SuperBlurView::OnSizeSet( const Vector3& targetSize )
273 if( mTargetSize != Vector2(targetSize) )
275 mTargetSize = Vector2(targetSize);
278 for( unsigned int i = 1; i <= mBlurLevels; i++ )
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 );
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] );
292 SetImage( mInputImage );
296 Control::OnSizeSet( targetSize );
299 void SuperBlurView::OnStageConnection( int depth )
301 if( mTargetSize == Vector2::ZERO )
306 // Exception to the rule, chaining up first ensures visuals have SetOnStage called to create their renderers
307 Control::OnStageConnection( depth );
310 for(unsigned int i=0; i<=mBlurLevels;i++)
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);
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 ) );
328 Vector3 SuperBlurView::GetNaturalSize()
332 return Vector3( mInputImage.GetWidth(), mInputImage.GetHeight(), 0.f );
334 return Vector3::ZERO;
337 void SuperBlurView::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
339 Toolkit::SuperBlurView superBlurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
343 SuperBlurView& superBlurViewImpl( GetImpl( superBlurView ) );
345 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
347 Dali::Image image = Scripting::NewImage( value );
350 superBlurViewImpl.SetImage( image );
354 DALI_LOG_ERROR( "Cannot create image from property value\n" );
360 Property::Value SuperBlurView::GetProperty( BaseObject* object, Property::Index propertyIndex )
362 Property::Value value;
364 Toolkit::SuperBlurView blurView = Toolkit::SuperBlurView::DownCast( Dali::BaseHandle( object ) );
368 SuperBlurView& superBlurViewImpl( GetImpl( blurView ) );
370 if( propertyIndex == Toolkit::SuperBlurView::Property::IMAGE )
373 Image inputImage = superBlurViewImpl.GetImage();
376 Scripting::CreatePropertyMap( inputImage, map );
378 value = Property::Value( map );
385 } // namespace Internal
387 } // namespace Toolkit